community.vmware.vmware_dvs_portgroup_info module – Gathers info DVS portgroup configurations

Note

This module is part of the community.vmware collection (version 4.8.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_dvs_portgroup_info.

Synopsis

  • This module can be used to gather information about DVS portgroup configurations.

Parameters

Parameter

Comments

datacenter

string / required

Name of the datacenter.

dvswitch

string

Name of a dvswitch to look for.

hostname

string

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.

password

aliases: pass, pwd

string

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.

port

integer

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.

Default: 443

proxy_host

string

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 VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

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 VMWARE_PROXY_PORT will be used instead.

show_mac_learning

boolean

Show or hide MAC learning information of the DVS portgroup.

Choices:

  • false

  • true ← (default)

show_network_policy

boolean

Show or hide network policies of DVS portgroup.

Choices:

  • false

  • true ← (default)

show_port_policy

boolean

Show or hide port policies of DVS portgroup.

Choices:

  • false

  • true ← (default)

show_teaming_policy

boolean

Show or hide teaming policies of DVS portgroup.

Choices:

  • false

  • true ← (default)

boolean

Show or hide uplinks of DVS portgroup.

Choices:

  • false

  • true ← (default)

show_vlan_info

boolean

Show or hide vlan information of the DVS portgroup.

Choices:

  • false ← (default)

  • true

username

aliases: admin, user

string

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.

validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

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: Get info about DVPG
  community.vmware.vmware_dvs_portgroup_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
  register: dvpg_info

- name: Get number of ports for portgroup 'dvpg_001' in 'dvs_001'
  debug:
    msg: "{{ item.num_ports }}"
  with_items:
    - "{{ dvpg_info.dvs_portgroup_info['dvs_001'] | json_query(query) }}"
  vars:
    query: "[?portgroup_name=='dvpg_001']"

Return Values

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

Key

Description

dvs_portgroup_info

dictionary

metadata about DVS portgroup configuration

Returned: on success

Sample: {"dvs_0": [{"active_uplinks": ["uplink 1"], "description": null, "dvswitch_name": "dvs_001", "key": "dvportgroup-1014", "mac_learning": {"allow_unicast_flooding": null, "enabled": false, "limit": null, "limit_policy": null}, "moid": "dvportgroup-1014", "network_policy": {"forged_transmits": false, "mac_changes": false, "promiscuous": false}, "num_ports": 8, "port_allocation": "elastic", "port_binding": "static", "port_policy": {"block_override": true, "ipfix_override": false, "live_port_move": false, "network_rp_override": false, "port_config_reset_at_disconnect": true, "security_override": false, "shaping_override": false, "traffic_filter_override": false, "uplink_teaming_override": false, "vendor_config_override": false, "vlan_override": false}, "portgroup_name": "dvpg_001", "standby_uplinks": [], "teaming_policy": {"inbound_policy": true, "notify_switches": true, "policy": "loadbalance_srcid", "rolling_order": false}, "type": "earlyBinding", "vlan_info": {"pvlan": false, "trunk": false, "vlan_id": 0}}]}

Authors

  • Abhijeet Kasurde (@Akasurde)