ansible.builtin.ios_vlan (v2.8.13) — module

Install Ansible via pip

Install with pip install ansible==2.8.13

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create vlan
  ios_vlan:
    vlan_id: 100
    name: test-vlan
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete vlan
  ios_vlan:
    vlan_id: 100
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add vlan using aggregate
  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

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - Name of the VLAN.

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

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.

vlan_id:
    description:
    - ID of the VLAN. Range 1-4094.
    required: true

aggregate:
    description: List of VLANs definitions.

interfaces:
    description:
    - List of interfaces that should be associated to the VLAN.
    required: true

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.
    version_added: '2.5'
    version_added_collection: ansible.builtin

Outputs

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