net_vlan - Manage VLANs on network devices¶

New in version 2.4.

Synopsis
Parameters
Examples
Return Values
Status
Maintenance
- Support
- Author

Synopsis ¶

This module provides declarative management of VLANs on network devices.

Parameters ¶

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

Examples ¶

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

- name: remove configuration
  net_vlan:
    state: absent

- name: configure VLAN state
  net_vlan:
    vlan_id:
    state: suspend

Return Values ¶

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

Key	Returned	Description
commands list	always, except for the platforms that use Netconf transport to manage the device.	The list of configuration mode commands to send to the device Sample: ['vlan 20', 'name test-vlan']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Network Team, see here.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Ricardo Carrillo Cruz (@rcarrillocruz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.