Documentation

vmware_portgroup_facts - Gathers facts about an ESXi host’s portgroup configuration

New in version 2.6.

Synopsis

  • This module can be used to gather facts about an ESXi host’s portgroup 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

Parameter Choices/Defaults Comments
cluster_name
Name of the cluster.
Facts will be returned for all hostsystem belonging to this cluster name.
If esxi_hostname is not given, this parameter is required.
esxi_hostname
ESXi hostname to gather facts from.
If cluster_name is not given, this parameter is required.
hostname
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 VMWARE_HOST will be used instead.
Environment variable supported added in version 2.6.
password
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable supported added in version 2.6.

aliases: pass, pwd
port
(added in 2.5)
 Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable supported added in version 2.6.
username
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable supported added in version 2.6.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
Environment variable supported added in version 2.6.

Notes

Note

  • Tested on vSphere 6.5

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

- name: Gather portgroup facts about ESXi Host system
  vmware_portgroup_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
hosts_firewall_facts
dict
 on success
metadata about host's portgroup configuration

Sample:
{'10.76.33.208': [{'name': 'VM Network', 'vswitch_name': 'vSwitch0', 'mac_changes': False, 'promiscuous_mode': False, 'vlan_id': 0, 'forged_transmits': False}, {'name': 'Management Network', 'vswitch_name': 'vSwitch0', 'mac_changes': False, 'promiscuous_mode': False, 'vlan_id': 0, 'forged_transmits': False}, {'name': 'pg0001', 'vswitch_name': 'vSwitch001', 'mac_changes': False, 'promiscuous_mode': False, 'vlan_id': 0, 'forged_transmits': False}]}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Abhijeet Kasurde (@akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.