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

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Configures VLANs on Cisco UCS Manager.

Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Requirements

• ucsmsdk

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure VLAN
  ucs_vlans:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: vlan2
    id: '2'
    native: 'yes'

Scanned by Steampunk Spotter

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

- name: Remove VLAN
  ucs_vlans:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: vlan2
    state: absent

Inputs

    
id:
    description:
    - The unique string identifier assigned to the VLAN.
    - A VLAN ID can be between '1' and '3967', or between '4048' and '4093'.
    - You cannot create VLANs with IDs from 4030 to 4047. This range of VLAN IDs is reserved.
    - The VLAN IDs you specify must also be supported on the switch that you are using.
    - VLANs in the LAN cloud and FCoE VLANs in the SAN cloud must have different IDs.
    - Optional if state is absent.
    required: true

name:
    description:
    - The name assigned to the VLAN.
    - The VLAN name is case sensitive.
    - This name can be between 1 and 32 alphanumeric characters.
    - 'You cannot use spaces or any special characters other than - (hyphen), "_" (underscore),
      : (colon), and . (period).'
    - You cannot change this name after the VLAN is created.
    required: true

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - If C(present), will verify VLANs are present and will create if needed.
    - If C(absent), will verify VLANs are absent and will delete if needed.

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."
    - For upstream disjoint L2 networks, Cisco recommends that you choose common to create
      VLANs that apply to both fabrics.

native:
    choices:
    - 'yes'
    - 'no'
    default: 'no'
    description:
    - Designates the VLAN as a native VLAN.

sharing:
    choices:
    - none
    - primary
    - isolated
    - community
    default: none
    description:
    - The Sharing Type field.
    - 'Whether this VLAN is subdivided into private or secondary VLANs. This can be one
      of the following:'
    - none - This VLAN does not have any secondary or private VLANs. This is a regular
      VLAN.
    - primary - This VLAN can have one or more secondary VLANs, as shown in the Secondary
      VLANs area. This VLAN is a primary VLAN in the private VLAN domain.
    - isolated - This is a private VLAN associated with a primary VLAN. This VLAN is an
      Isolated VLAN.
    - community - This VLAN can communicate with other ports on the same community VLAN
      as well as the promiscuous port. This VLAN is a Community VLAN.

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

multicast_policy:
    default: ''
    description:
    - The multicast policy associated with this VLAN.
    - This option is only valid if the Sharing Type field is set to None or Primary.