ansible / ansible.builtin / v2.9.24 / module / vmware_portgroup_info Gathers info about an ESXi host's Port Group configuration | "added in version" 2.9 of ansible.builtin" Authors: Abhijeet Kasurde (@Akasurde), Christian Kotte (@ckotte) preview | supported by communityansible.builtin.vmware_portgroup_info (v2.9.24) — module
pip
Install with pip install ansible==2.9.24
This module can be used to gather information about an ESXi host's Port Group configuration when ESXi hostname or Cluster name is given.
- name: Gather portgroup info about all ESXi Host in given Cluster vmware_portgroup_info: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' cluster_name: '{{ cluster_name }}' delegate_to: localhost
- name: Gather portgroup info about ESXi Host system vmware_portgroup_info: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: '{{ esxi_hostname }}' delegate_to: localhost
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 C(VMWARE_PORT) will be used instead. - Environment variable support added in Ansible 2.6. type: int 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 C(VMWARE_HOST) will be used instead. - Environment variable support added in Ansible 2.6. 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 C(VMWARE_PASSWORD) will be used instead. - Environment variable support added in Ansible 2.6. type: str policies: default: false description: - Gather information about Security, Traffic Shaping, as well as Teaming and failover. - The property C(ts) stands for Traffic Shaping and C(lb) for Load Balancing. type: bool 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 C(VMWARE_USER) will be used instead. - Environment variable support added in Ansible 2.6. type: str 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 C(VMWARE_PROXY_HOST) will be used instead. - This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 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 C(VMWARE_PROXY_PORT) will be used instead. required: false type: int cluster_name: description: - Name of the cluster. - Info will be returned for all hostsystem belonging to this cluster name. - If C(esxi_hostname) is not given, this parameter is required. type: str esxi_hostname: description: - ESXi hostname to gather information from. - If C(cluster_name) is not given, this parameter is required. type: str validate_certs: default: true description: - 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. - Environment variable support added in Ansible 2.6. - If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine. type: bool
hosts_portgroup_info: description: metadata about host's portgroup configuration returned: on success sample: esx01: - failback: true failover_active: - vmnic0 - vmnic1 failover_standby: [] failure_detection: link_status_only lb: loadbalance_srcid notify: true portgroup: Management Network security: - false - false - false ts: No override vlan_id: 0 vswitch: vSwitch0 - failback: true failover_active: - vmnic2 failover_standby: - vmnic3 failure_detection: No override lb: No override notify: true portgroup: vMotion security: - false - false - false ts: No override vlan_id: 33 vswitch: vSwitch1 type: dict