community / community.vmware / 4.2.0 / module / vmware_dvswitch_info Gathers info dvswitch configurations Authors: sky-joker (@sky-joker)community.vmware.vmware_dvswitch_info (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to gather information about dvswitch configurations.
- name: Gather all registered dvswitch community.vmware.vmware_dvswitch_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" delegate_to: localhost register: dvswitch_info
- name: Gather info about specific dvswitch community.vmware.vmware_dvswitch_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" switch_name: DVSwitch01 delegate_to: localhost register: dvswitch_info
- name: Gather info from folder about specific dvswitch community.vmware.vmware_dvswitch_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" folder: /datacenter1/network/F01 switch_name: DVSwitch02 delegate_to: localhost register: dvswitch_info
- name: Gather some info from a dvswitch using the vSphere API output schema community.vmware.vmware_dvswitch_info: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" schema: vsphere properties: - summary.name - summary.numPorts - config.maxMtu - overallStatus switch_name: DVSwitch01 register: dvswitch_info
port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int folder: description: - Specify a folder location of dvswitch to gather information from. - 'Examples:' - ' folder: /datacenter1/network' - ' folder: datacenter1/network' - ' folder: /datacenter1/network/folder1' - ' folder: datacenter1/network/folder1' - ' folder: /folder1/datacenter1/network' - ' folder: folder1/datacenter1/network' - ' folder: /folder1/datacenter1/network/folder2' required: false type: str schema: choices: - summary - vsphere default: summary description: - Specify the output schema desired. - The 'summary' output schema is the legacy output from the module - The 'vsphere' output schema is the vSphere API class definition which requires pyvmomi>6.7.1 type: str hostname: description: - The hostname or IP address of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str properties: description: - Specify the properties to retrieve. - If not specified, all properties are retrieved (deeply). - Results are returned in a structure identical to the vsphere API. - 'Example:' - ' properties: [' - ' "summary.name",' - ' "summary.numPorts",' - ' "config.maxMtu",' - ' "overallStatus"' - ' ]' - Only valid when O(schema=vsphere). elements: str required: false type: list proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int switch_name: aliases: - switch - dvswitch description: - Name of a dvswitch to look for. - If O(switch_name) not specified gather all dvswitch information. required: false type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool
distributed_virtual_switches: description: list of dictionary of dvswitch and their information returned: always sample: - configure: folder: network hosts: - esxi-test-02.local - esxi-test-01.local settings: healthCheck: TeamingHealthCheckConfig: false VlanMtuHealthCheckConfig: false netflow: activeFlowTimeout: 60 collectorIpAddress: '' collectorPort: 0 idleFlowTimeout: 15 internalFlowsOnly: false observationDomainId: 0 samplingRate: 0 switchIpAddress: null privateVlan: [] properties: administratorContact: contact: null name: null advanced: maxMtu: 1500 multicastFilteringMode: legacyFiltering discoveryProtocol: operation: listen protocol: cdp general: ioControl: true name: DVSwitch01 numPorts: 10 numUplinks: 1 vendor: VMware, Inc. version: 6.6.0 uuid: 50 30 99 9c a7 60 8a 4f-05 9f e7 b5 da df 8f 17 type: list