Steampunk Ansible Documentation - cisco.ios.ios_vlan (3.3.2) - module - (deprecated, removed after 2022-06-01) Manage VLANs on IOS network devices

Install collection

Install with ansible-galaxy collection install cisco.ios:==3.3.2

Add to requirements.yml

  collections:
    - name: cisco.ios
      version: 3.3.2

Description

This module provides declarative management of VLANs on Cisco IOS network devices.

Usage examples

Scanned by Steampunk Spotter

- name: Create vlan
  cisco.ios.ios_vlan:
    vlan_id: 100
    name: test-vlan
    state: present

Scanned by Steampunk Spotter

- name: Add interfaces to VLAN
  cisco.ios.ios_vlan:
    vlan_id: 100
    interfaces:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

Scanned by Steampunk Spotter

- name: Check if interfaces is assigned to VLAN
  cisco.ios.ios_vlan:
    vlan_id: 100
    associated_interfaces:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

Scanned by Steampunk Spotter

- name: Delete vlan
  cisco.ios.ios_vlan:
    vlan_id: 100
    state: absent

Scanned by Steampunk Spotter

- 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}

Scanned by Steampunk Spotter

- name: Move interfaces to a different VLAN
  cisco.ios.ios_vlan:
    vlan_id: 102
    interfaces:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

Inputs

name:
description:
- Name of the VLAN.
type: str

delay:
default: 10
description:
- Delay the play should wait to check for declarative intent params values.
type: int

purge:
default: false
description:
- Purge VLANs not defined in the I(aggregate) parameter.
type: bool

state:
choices:
- present
- absent
- active
- suspend
default: present
description:
- State of the VLAN configuration.
type: str

vlan_id:
description:
- ID of the VLAN. Range 1-4094.
type: int

provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- 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 C(ANSIBLE_NET_PASSWORD) will
be used instead.
type: str
port:
description:
- Specifies the port to use when building the connection to the remote device.
type: int
ssh_keyfile:
description:
- 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 C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead.
type: path
timeout:
description:
- 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.
type: int
username:
description:
- 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 C(ANSIBLE_NET_USERNAME)
will be used instead.
type: str
type: dict

aggregate:
description: List of VLANs definitions.
elements: dict
suboptions:
associated_interfaces:
description:
- This is a intent option and checks the operational state of the for given vlan
C(name) for associated interfaces. If the value in the C(associated_interfaces)
does not match with the operational state of vlan interfaces on device it will
result in failure.
elements: str
type: list
delay:
description:
- Delay the play should wait to check for declarative intent params values.
type: int
interfaces:
description:
- List of interfaces that should be associated to the VLAN.
elements: str
type: list
name:
description:
- Name of the VLAN.
type: str
state:
choices:
- present
- absent
- active
- suspend
description:
- State of the VLAN configuration.
type: str
vlan_id:
description:
- ID of the VLAN. Range 1-4094.
required: true
type: str
type: list

interfaces:
description:
- List of interfaces that should be associated to the VLAN.
elements: str
type: list

associated_interfaces:
description:
- This is a intent option and checks the operational state of the for given vlan C(name)
for associated interfaces. If the value in the C(associated_interfaces) does not
match with the operational state of vlan interfaces on device it will result in
failure.
elements: str
type: list

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - vlan 100
  - name test-vlan
  type: list