community.vmware.vmware_dvs_portgroup_info – Gathers info DVS portgroup 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_dvs_portgroup_info.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
Parameters
Parameter |
Comments |
|---|---|
Name of the datacenter. |
|
Name of a dvswitch to look for. |
|
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 |
|
Show or hide MAC learning information of the DVS portgroup. Choices:
|
|
Show or hide network policies of DVS portgroup. Choices:
|
|
Show or hide port policies of DVS portgroup. Choices:
|
|
Show or hide teaming policies of DVS portgroup. Choices:
|
|
Show or hide uplinks of DVS portgroup. Choices:
|
|
Show or hide vlan information of the DVS portgroup. Choices:
|
|
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 7.0
All modules requires API write access and hence is not supported on a free ESXi license.
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 |
|---|---|
metadata about DVS portgroup configuration Returned: on success Sample: {“dvs_0”: [{“description”: null, “dvswitch_name”: “dvs_001”, “network_policy”: {“forged_transmits”: false, “mac_changes”: false, “promiscuous”: false}, “num_ports”: 8, “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”, “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)