W3cubDocs

/Ansible 2.10

cisco.ucs.ucs_vlan_to_group – Add VLANs to a VLAN Group. Requires VLAN and VLAN Group to already be created on UCS prior to running module.

Note

This plugin is part of the cisco.ucs collection.

To install it use: ansible-galaxy collection install cisco.ucs.

To use it in a playbook, specify: cisco.ucs.ucs_vlan_to_group.

New in version 2.10: of cisco.ucs

Synopsis

  • Add VLANs to VLAN Groups on Cisco UCS Manager.

Requirements

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

  • ucsmsdk

Parameters

Parameter Choices/Defaults Comments
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.
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'
state
string
    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.
vlangroup
string / required
The name assigned to the VLAN Group.
The VLAN Group 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).
vlanname
string / 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).

Examples

- name: Configure VLAN
  cisco.ucs.ucs_vlan_to_group:
    hostname: 1.1.1.1
    username: admin
    password: password
    vlangroup: VLANGROUP
    vlanname: VLANNAME
    state: present
- name: Remove VLAN
  cisco.ucs.ucs_vlan_to_group:
    hostname: 1.1.1.1
    username: admin
    password: password
    vlangroup: VLANGROUP
    vlanname: VLANNAME
    state: absent

Authors

  • Derrick Johnson @derricktj

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/ucs/ucs_vlan_to_group_module.html