community.vmware.vmware_dvs_portgroup_find – Find portgroup(s) in a VMware environment
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_find
.
Synopsis
Find portgroup(s) based on different criteria such as distributed vSwitch, VLAN id or a string in the name.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
PyVmomi
Parameters
Parameter |
Comments |
---|---|
Name of a distributed vSwitch 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. |
|
string to check inside the name of the portgroup. Basic containment check using python |
|
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 uplink portgroups. Only relevant when 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:
|
|
VLAN id can be any number between 1 and 4094. This search criteria will looks into VLAN ranges to find possible matches. |
Notes
Note
Tested on vSphere 6.5
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Get all portgroups in dvswitch vDS
community.vmware.vmware_dvs_portgroup_find:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
dvswitch: 'vDS'
delegate_to: localhost
- name: Confirm if vlan 15 is present
community.vmware.vmware_dvs_portgroup_find:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
vlanid: '15'
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
basic details of portgroups found Returned: on success Sample: [{“dvswitch”: “vDS”, “name”: “N-51”, “pvlan”: true, “trunk”: true, “vlan_id”: “0”}] |
Authors
David Martinez (@dx0xm)