community.vmware.vmware_vswitch_facts – Gathers facts about an ESXi host’s vswitch configurations
Note
This plugin is part of the community.vmware collection (version 1.17.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_vswitch_facts
.
DEPRECATED
- Removed in
major release after 2021-12-01
- Why
Deprecated in favour of community.vmware.vmware_vswitch_info module.
- Alternative
Use community.vmware.vmware_vswitch_info instead.
Synopsis
This module can be used to gather facts about an ESXi host’s vswitch configurations when ESXi hostname or Cluster name is given.
The vSphere Client shows the value for the number of ports as elastic from vSphere 5.5 and above.
Other tools like esxcli might show the number of ports as 1536 or 5632.
See https://kb.vmware.com/s/article/2064511 for more details.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
Parameters
Parameter |
Comments |
---|---|
Name of the cluster. Facts about vswitch belonging to every ESXi host systems under this cluster will be returned. If |
|
ESXi hostname to gather facts from. If |
|
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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: 443 |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
Tested on vSphere 6.5
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Gather vswitch facts about all ESXi Host in given Cluster
community.vmware.vmware_vswitch_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
delegate_to: localhost
register: all_hosts_vswitch_facts
- name: Gather vswitch facts about ESXi Host
community.vmware.vmware_vswitch_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
delegate_to: localhost
register: all_vswitch_facts
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about host’s vswitch configuration Returned: on success Sample: {“10.76.33.218”: {“vSwitch0”: {“mtu”: 1500, “num_ports”: 128, “pnics”: [“vmnic0”]}, “vSwitch_0011”: {“mtu”: 1500, “num_ports”: 128, “pnics”: [“vmnic2”, “vmnic1”]}}} |
Status
This module will be removed in a major release after 2021-12-01. [deprecated]
For more information see DEPRECATED.
Authors
Abhijeet Kasurde (@Akasurde)