Note
This plugin is part of the cisco.ucs collection (version 1.6.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 cisco.ucs.
To use it in a playbook, specify: cisco.ucs.ucs_vlan_find.
New in version 2.9: of cisco.ucs
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| fabric string |
| The fabric configuration of the VLAN. This can be one of the following: common - The VLAN applies to both fabrics and uses the same configuration parameters in both cases. A — The VLAN only applies to fabric A. B — The VLAN only applies to fabric B. |
| hostname string / required | IP address or hostname of Cisco UCS Manager. Modules can be used with the UCS Platform Emulator https://cs.co/ucspe
| |
| password string / required | Password for Cisco UCS Manager authentication. | |
| pattern string | Regex pattern to find within the name property of the fabricVlan class. This is required if vlanid parameter is not supplied. | |
| port integer | Port number to be used during connection (by default uses 443 for https and 80 for http connection). | |
| proxy string | If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080' | |
| use_proxy boolean |
| If no, will not use the proxy as defined by system environment variable. |
| use_ssl boolean |
| If no, an HTTP connection will be used instead of the default HTTPS connection. |
| username string | Default: "admin" | Username for Cisco UCS Manager authentication. |
| vlanid string | The unique string identifier assigned to the VLAN. A VLAN ID can be between '1' and '3967', or between '4048' and '4093'. This is required if pattern parameter is not supplied. |
- name: Get all vlans in fabric A
cisco.ucs.ucs_vlan_find:
hostname: 172.16.143.150
username: admin
password: password
fabric: 'A'
pattern: '.'
- name: Confirm if vlan 15 is present
cisco.ucs.ucs_vlan_find:
hostname: 172.16.143.150
username: admin
password: password
vlanid: '15'
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| vlan_list list / elements=string | on success | basic details of vlans found Sample: [{'id': '0', 'name': 'vlcloud1'}] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ucs/ucs_vlan_find_module.html