net_vlan – Manage VLANs on network devices
net_vlan – Manage VLANs on network devices
New in version 2.4.
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 - |
|
State of the VLAN configuration. |
vlan_id - |
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
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 not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Ricardo Carrillo Cruz (@rcarrillocruz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/net_vlan_module.html