/ home / ansible / ansible.netcommon / 3.1.3 / module / net_vlan

Deprecated

Removed in None

ansible.netcommon.net_vlan (3.1.3) — module

(deprecated, removed after 2022-06-01) Manage VLANs on network devices

| "added in version" 1.0.0 of ansible.netcommon"

Authors: Ricardo Carrillo Cruz (@rcarrillocruz)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install ansible.netcommon:==3.1.3

Add to requirements.yml

  collections:
    - name: ansible.netcommon
      version: 3.1.3

Description

This module provides declarative management of VLANs on network devices.

Usage examples

Scanned by Steampunk Spotter

- name: configure VLAN ID and name
  ansible.netcommon.net_vlan:
    vlan_id: 20
    name: test-vlan

Scanned by Steampunk Spotter

- name: remove configuration
  ansible.netcommon.net_vlan:
    state: absent

Scanned by Steampunk Spotter

- name: configure VLAN state
  ansible.netcommon.net_vlan:
    vlan_id:
    state: suspend

Inputs

    
name:
    description:
    - Name of the VLAN.

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

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

vlan_id:
    description:
    - ID of the VLAN.

aggregate:
    description: List of VLANs definitions.

interfaces:
    description:
    - List of interfaces the VLAN should be configured on.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always, except for the platforms that use Netconf transport to manage
    the device.
  sample:
  - vlan 20
  - name test-vlan
  type: list