- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ucs_vlans – Configures VLANs on Cisco UCS Manager

New in version 2.5.

- Synopsis
- Requirements
- Parameters
- Examples
- Status

## Synopsis

- Configures VLANs on Cisco UCS Manager.
- Examples can be used with the UCS Platform Emulator https://communities.cisco.com/ucspe.

## Requirements

The below requirements are needed on the host that executes this module.

- ucsmsdk

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
fabric - | Choices: common ← A B | 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. For upstream disjoint L2 networks, Cisco recommends that you choose common to create VLANs that apply to both fabrics.
hostname string / required |  | IP address or hostname of Cisco UCS Manager.
id - / required |  | 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.
multicast_policy - | Default: "" | The multicast policy associated with this VLAN. This option is only valid if the Sharing Type field is set to None or Primary.
name - / required |  | 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.
native - | Choices: yes no ← | Designates the VLAN as a native VLAN.
password string / required |  | Password for Cisco UCS Manager authentication.
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'
sharing - | Choices: none ← primary isolated community | 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.
state - | Choices: present ← absent | If `present`, will verify VLANs are present and will create if needed. If `absent`, will verify VLANs are absent and will delete if needed.
use_proxy boolean | Choices: no yes ← | If `no`, will not use the proxy as defined by system environment variable.
use_ssl boolean | Choices: no yes ← | If `no`, an HTTP connection will be used instead of the default HTTPS connection.
username string | Default: "admin" | Username for Cisco UCS Manager authentication.

## Examples

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

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- David Soper (@dsoper2)
- CiscoUcs (@CiscoUcs)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.