community.vmware.vmware_dvswitch_info module – Gathers info dvswitch configurations
Note
This module is part of the community.vmware collection (version 5.1.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.vmware.
To use it in a playbook, specify: community.vmware.vmware_dvswitch_info.
Synopsis
This module can be used to gather information about dvswitch configurations.
Parameters
Parameter |
Comments |
|---|---|
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 |
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
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 |
|
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 Choices:
|
|
Name of a dvswitch to look for. If |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
list of dictionary of dvswitch and their information Returned: always Sample: |