eos_vlan - Manage VLANs on Arista EOS network devices
New in version 2.4.
Synopsis
- This module provides declarative management of VLANs on Arista EOS network devices.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| aggregate |
no |
List of VLANs definitions.
|
||
| delay |
no | 10 |
Delay the play should wait to check for declarative intent params values.
|
|
| interfaces |
no |
List of interfaces that should be associated to the VLAN.
|
||
| name |
no |
Name of the VLAN.
|
||
| purge |
no |
Purge VLANs not defined in the aggregate parameter.
|
||
| state |
no | present |
|
State of the VLAN configuration.
|
| vlan_id |
yes |
ID of the VLAN.
|
Examples
- name: Create vlan
eos_vlan:
vlan_id: 4000
name: vlan-4000
state: present
- name: Add interfaces to vlan
eos_vlan:
vlan_id: 4000
state: present
interfaces:
- Ethernet1
- Ethernet2
- name: Suspend vlan
eos_vlan:
vlan_id: 4000
state: suspend
- name: Unsuspend vlan
eos_vlan:
vlan_id: 4000
state: active
- name: Create aggregate of vlans
eos_vlan:
aggregate:
- vlan_id: 4000
- {vlan_id: 4001, name: vlan-4001}
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 | list | ['vlan 20', 'name test-vlan'] |
Notes
Note
- Tested against EOS 4.15
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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/eos_vlan_module.html