You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ansible.netcommon.net_vlan module – (deprecated, removed after 2022-06-01) Manage VLANs on network devices

Note

This module is part of the ansible.netcommon collection (version 2.6.1).

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 ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.net_vlan.

New in version 1.0.0: of ansible.netcommon

DEPRECATED

Removed in

major release after 2022-06-01

Why

Updated modules released with more functionality

Alternative

Use platform-specific “[netos]_vlans” module

Synopsis

• This module provides declarative management of VLANs on network devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter	Comments
aggregate string	List of VLANs definitions.
interfaces string	List of interfaces the VLAN should be configured on.
name string	Name of the VLAN.
purge string	Purge VLANs not defined in the aggregate parameter. Default: “no”
state string	State of the VLAN configuration. Choices: present ← (default) absent active suspend
vlan_id string	ID of the VLAN.

Notes

Note

• This module is supported on ansible_network_os network platforms. See the Network Platform Options for details.

Examples

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

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
commands list / elements=string	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”]

Status

• This module will be removed in a major release after 2022-06-01. [deprecated]

• For more information see DEPRECATED.

Authors

• Ricardo Carrillo Cruz (@rcarrillocruz)

Collection links

Issue Tracker Repository (Sources)