cisco.ios.ios_vlan module – (deprecated, removed after 2022-06-01) Manage VLANs on IOS network devices
Note
This module is part of the cisco.ios collection (version 3.3.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.ios
.
To use it in a playbook, specify: cisco.ios.ios_vlan
.
New in cisco.ios 1.0.0
DEPRECATED
- Removed in:
major release after 2022-06-01
- Why:
Newer and updated modules released with more functionality in Ansible 2.9
- Alternative:
ios_vlans
Synopsis
This module provides declarative management of VLANs on Cisco IOS network devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
List of VLANs definitions. |
|
This is a intent option and checks the operational state of the for given vlan |
|
Delay the play should wait to check for declarative intent params values. |
|
List of interfaces that should be associated to the VLAN. |
|
Name of the VLAN. |
|
State of the VLAN configuration. Choices:
|
|
ID of the VLAN. Range 1-4094. |
|
This is a intent option and checks the operational state of the for given vlan |
|
Delay the play should wait to check for declarative intent params values. Default: |
|
List of interfaces that should be associated to the VLAN. |
|
Name of the VLAN. |
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
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. |
|
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 VLANs not defined in the aggregate parameter. Choices:
|
|
State of the VLAN configuration. Choices:
|
|
ID of the VLAN. Range 1-4094. |
Notes
Note
Tested against IOS 15.2
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: Create vlan
cisco.ios.ios_vlan:
vlan_id: 100
name: test-vlan
state: present
- name: Add interfaces to VLAN
cisco.ios.ios_vlan:
vlan_id: 100
interfaces:
- GigabitEthernet0/0
- GigabitEthernet0/1
- name: Check if interfaces is assigned to VLAN
cisco.ios.ios_vlan:
vlan_id: 100
associated_interfaces:
- GigabitEthernet0/0
- GigabitEthernet0/1
- name: Delete vlan
cisco.ios.ios_vlan:
vlan_id: 100
state: absent
- name: Add vlan using aggregate
cisco.ios.ios_vlan:
aggregate:
- {vlan_id: 100, name: test-vlan, interfaces: [GigabitEthernet0/1, GigabitEthernet0/2],
delay: 15, state: suspend}
- {vlan_id: 101, name: test-vlan, interfaces: GigabitEthernet0/3}
- name: Move interfaces to a different VLAN
cisco.ios.ios_vlan:
vlan_id: 102
interfaces:
- GigabitEthernet0/0
- GigabitEthernet0/1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.