W3cubDocs

/Ansible

net_vlan - Manage VLANs on network devices

New in version 2.4.

Synopsis

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

Options

parameter required default choices comments
aggregate
 no
List of VLANs definitions.
interfaces
 no
List of interfaces the VLAN should be configured on.
name
 no
Name of the VLAN.
purge
 no
Purge VLANs not defined in the aggregate parameter.
state
 no present
  • present
  • absent
  • active
  • suspend
State of the VLAN configuration.
vlan_id
 no
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 Return Values, the following are the fields unique to this module:

name description returned type sample
commands
The list of configuration mode commands to send to the device
 always, except for the platforms that use Netconf transport to manage the device. list ['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 Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/net_vlan_module.html