eos_vlan – Manage VLANs on Arista EOS network devices¶
New in version 2.4.
DEPRECATED¶
- Removed in Ansible
version: 2.13
- Why
Updated modules released with more functionality
- Alternative
eos_vlans
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
-
|
List of VLANs definitions.
|
||
associated_interfaces
-
added in 2.5 |
This is a intent option and checks the operational state of the for given vlan
name for associated interfaces. The name of interface is case sensitive and should be in expanded format and not abbreviated. If the value in the associated_interfaces does not match with the operational state of vlan interfaces on device it will result in failure. |
||
auth_pass
string
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli and become: yes with become_pass .This option is only required if you are using eAPI.
For more information please see the EOS Platform Options guide.
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTH_PASS will be used instead. |
||
authorize
boolean
|
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli and become: yes .This option is only required if you are using eAPI.
For more information please see the EOS Platform Options guide.
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. |
|
delay
-
|
Default: 10
|
Delay the play should wait to check for declarative intent params values.
|
|
interfaces
-
|
List of interfaces that should be associated to the VLAN. The name of interface is case sensitive and should be in expanded format and not abbreviated.
|
||
name
-
|
Name of the VLAN.
|
||
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .This option is only required if you are using eAPI.
For more information please see the EOS Platform Options guide.
A dict object containing connection details.
|
||
auth_pass
string
|
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTH_PASS will be used instead. |
||
authorize
boolean
|
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. |
|
host
string
/ required
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
||
password
string
|
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
||
port
integer
|
Default: 0
|
Specifies the port to use when building the connection to the remote device. This value applies to either cli or eapi.
The port value will default to the appropriate transport common port if none is provided in the task (cli=22, http=80, https=443).
|
|
ssh_keyfile
path
|
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
timeout
integer
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
||
transport
string
/ required
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
use_proxy
boolean
added in 2.5 |
|
If
no , the environment variables http_proxy and https_proxy will be ignored. |
|
use_ssl
boolean
|
|
Configures the transport to use SSL if set to
yes only when the transport=eapi . If the transport argument is not eapi, this value is ignored. |
|
username
string
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
||
validate_certs
boolean
|
|
If
no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not eapi, this value is ignored. |
|
purge
boolean
|
|
Purge VLANs not defined in the aggregate parameter.
|
|
state
-
|
|
State of the VLAN configuration.
|
|
vlan_id
-
/ required
|
ID of the VLAN.
|
Notes¶
Note
Tested against EOS 4.15
For information on using CLI, eAPI and privileged mode see the EOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Arista EOS devices see the Arista integration page.
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: Check if interfaces is assigned to vlan
eos_vlan:
vlan_id: 4000
associated_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, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands
list
|
always |
The list of configuration mode commands to send to the device
Sample:
['vlan 20', 'name test-vlan']
|
Status¶
This module will be removed in version 2.13. [deprecated]
For more information see DEPRECATED.
Authors¶
Ricardo Carrillo Cruz (@rcarrillocruz)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.