vcenter_network_info
Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_network_info
Synopsis
Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the Network.FilterSpec
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. | ||||
| vcenter_rest_log_file | string | You can use this optional parameter to set the location of a log file. | ||
| This file will be used to record the HTTP REST interaction. | ||||
| The file will be stored on the host that runs the module. | ||||
| If the value is not specified in the task, the value of | ||||
| environment variable C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | Timeout settings for client session. | ||
| The maximal number of seconds for the whole operation including connection establishment, request sending and response. | ||||
| The default value is 300s. | ||||
| datacenters | list | Datacenters that must contain the network for the network to match the filter. | ||
| If unset or empty, networks in any datacenter match the filter. | ||||
| When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_datacenter_info). | ||||
| folders | list | Folders that must contain the network for the network to match the filter. | ||
| If unset or empty, networks in any folder match the filter. | ||||
| When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_folder_info). | ||||
| names | list | Names that networks must have to match the filter (see I(name)). | ||
| If unset or empty, networks with any name match the filter. | ||||
| networks | list | Identifiers of networks that can match the filter. | ||
| If unset or empty, networks with any identifier match the filter. | ||||
| When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_network_info). | ||||
| types | list | Types that networks must have to match the filter (see I(type)). | ||
| If unset, networks with any type match the filter. |
Example
yaml
- name: Get the dvswitch called my-portgroup
vmware.vmware_rest.vcenter_network_info:
filter_types: DISTRIBUTED_PORTGROUP
filter_names: my portrgoup
register: my_portgroup