ansible.netcommon.net_vlan – (deprecated, removed after 2022-06-01) Manage VLANs on network devices¶
Note
This plugin is part of the ansible.netcommon collection (version 1.5.0).
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¶
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:
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)