community.network.cnos_vlan – Manage VLANs on CNOS network devices
community.network.cnos_vlan – Manage VLANs on CNOS network devices
Note
This plugin is part of the community.network collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.cnos_vlan
.
Synopsis
- This module provides declarative management of VLANs on Lenovo CNOS network devices.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate string |
List of VLANs definitions. | ||
associated_interfaces string |
This is a intent option and checks the operational state of the for given vlan | ||
delay string |
Default: 10 |
Delay the play should wait to check for declarative intent params values. | |
interfaces string / required |
List of interfaces that should be associated to the VLAN. | ||
name string |
Name of the VLAN. | ||
provider string |
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the CNOS Platform Options guide. A dict object containing connection details. | ||
auth_pass string |
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable | ||
authorize boolean |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable | |
host string / required |
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
password string |
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
port string |
Default: 22 |
Specifies the port to use when building the connection to the remote device. | |
ssh_keyfile string |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
timeout string |
Default: 10 |
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
username string |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
purge boolean |
|
Purge VLANs not defined in the aggregate parameter. | |
state string |
|
State of the VLAN configuration. | |
vlan_id string / required |
ID of the VLAN. Range 1-4094. |
Notes
Note
- Tested against CNOS 10.8.1
Examples
- name: Create vlan
community.network.cnos_vlan:
vlan_id: 100
name: test-vlan
state: present
- name: Add interfaces to VLAN
community.network.cnos_vlan:
vlan_id: 100
interfaces:
- Ethernet1/33
- Ethernet1/44
- name: Check if interfaces is assigned to VLAN
community.network.cnos_vlan:
vlan_id: 100
associated_interfaces:
- Ethernet1/33
- Ethernet1/44
- name: Delete vlan
community.network.cnos_vlan:
vlan_id: 100
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list / elements=string |
always |
The list of configuration mode commands to send to the device
Sample: ['vlan 100', 'name test-vlan'] |
Authors
- Anil Kumar Mureleedharan(@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/cnos_vlan_module.html