vmware_portgroup_facts – Gathers facts about an ESXi host’s Port Group configuration¶
New in version 2.6.
DEPRECATED¶
Removed in Ansible: | |
---|---|
version: 2.13 | |
Why: | Deprecated in favour of _info module. |
Alternative: | Use vmware_portgroup_info instead. |
Synopsis¶
- This module can be used to gather facts about an ESXi host’s Port Group configuration when ESXi hostname or Cluster name is given.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters¶
Notes¶
Note
- Tested on vSphere 6.5
- The
vswitch_name
property is deprecated starting from Ansible v2.12
Examples¶
- name: Gather portgroup facts about all ESXi Host in given Cluster
vmware_portgroup_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
delegate_to: localhost
- name: Gather portgroup facts about ESXi Host system
vmware_portgroup_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.