ansible.builtin.ucs_vlan_find (v2.9.0) — module

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Find VLANs on Cisco UCS Manager based on different criteria.

Requirements

• ucsmsdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all vlans in fabric A
  ucs_vlan_find:
    hostname: 172.16.143.150
    username: admin
    password: password
    fabric: 'A'
    pattern: '.'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Confirm if vlan 15 is present
  ucs_vlan_find:
    hostname: 172.16.143.150
    username: admin
    password: password
    vlanid: '15'

Inputs

    
port:
    description:
    - Port number to be used during connection (by default uses 443 for https and 80 for
      http connection).
    type: int

proxy:
    description:
    - If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
    type: str

fabric:
    choices:
    - common
    - A
    - B
    default: common
    description:
    - '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 \u2014 The VLAN only applies to fabric A."
    - "B \u2014 The VLAN only applies to fabric B."
    type: str

vlanid:
    description:
    - 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 C(pattern) parameter is not supplied.
    type: str

pattern:
    description:
    - Regex pattern to find within the name property of the fabricVlan class.
    - This is required if C(vlanid) parameter is not supplied.
    type: str

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

hostname:
    description:
    - IP address or hostname of Cisco UCS Manager.
    - Modules can be used with the UCS Platform Emulator U(https://cs.co/ucspe)
    required: true
    type: str

password:
    description:
    - Password for Cisco UCS Manager authentication.
    required: true
    type: str

username:
    default: admin
    description:
    - Username for Cisco UCS Manager authentication.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), will not use the proxy as defined by system environment variable.
    type: bool

Outputs

vlan_list:
  description: basic details of vlans found
  returned: on success
  sample:
  - id: '0'
    name: vlcloud1
  type: list