The arista.eos-interfaces role creates an abstraction for EOS interface configuration. This means that you do not need to write any ansible tasks. Simply create an object that matches the requirements below and this role will ingest that object and perform the necessary configuration.
This role is used to configure the basics of an interface, for example it will simply create the interface, enable or disable it and set the description. Also availabe are options for setting port channel-group number and mode, and the lacp port-priority and rate. It will do this for any valid interface in EOS. This role would be used prior to setting an IP Address on an interface or before setting more advanced Port-Channel configuration.
Note: Options for setting switchport vlan information are available in the
ansible-eos-bridging role, also available through Ansible Galaxy or GitHub.ansible-galaxy install arista.eos-interfacesRequires an SSH connection for connectivity to your Arista device. You can use
any of the built-in eos connection variables, or the convenience provider
dictionary.
The tasks in this role are driven by the interfaces object described below:
interfaces (list) each entry contains the following keys:
| Key | Type | Notes |
|---|---|---|
| name | string (required) | The unique interface identifier name. The interface name must use the full interface name (no abbreviated names). For example, interfaces should be specified as Ethernet1 not Et1 |
| description | string | Configures a one line ASCII description for the interface. |
| enable | boolean: true*, false | Configures the administrative state for the interface. Setting the value to true will administrative enable the interface and setting the value to false will administratively disable the interface. |
| state | choices: present*, absent | Set the state for the interface configuration. |
| channel_group | dictionary | Configure the interface in a Port Channel. If not present, or number sub key is missing, the Port Channel with be defaulted to be removed |
| channel_group.mode | choices: on, active*, passive | Set the mode of the the Port Channel group. |
| channel_group.number | integer | Set the number the Port Channel group. |
| lacp_port_priority | integer | Set the lacp port-priority. Will be set to the default value of 32768 if not specified. |
| lacp_rate | choices: normal*, fast | Set the lacp rate. Will be set to the default value if not specified. |
| speed_forced | choices: string, false, unset* | Force speed of an Ethernet interface. The default if speed_forced is not set is that no action will be taken. False will unset the interface speed. A speed string will attempt to set the command on the interface. If the string does not include a duplex the role assumes full duplex (Ex: 40g -> 40gfull). A full speed forced string can also be provided (Ex: 25gfull, 100gfull, 1000full, 1000half, etc...). |
Note: Asterisk (*) denotes the default value if none specified| Key | Choices | Description |
|---|---|---|
| eos_save_running_config | true*, false | Specifies whether to write any changes to the running-config resulting from the role execution to memory, copying the configuration to the startup-config. |
Note: Asterisk (*) denotes the default value if none specifiedAnsible EOS roles require the following connection information to establish communication with the nodes in your inventory. This information can exist in the Ansible group_vars or host_vars directories, or in the playbook itself.
| Key | Required | Choices | Description |
|---|---|---|---|
| host | yes | 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. | |
| port | no | Specifies the port to use when building the connection to the remote device. This value applies to either acceptable value of transport. The port value will default to the appropriate transport common port if none is provided in the task (cli=22, http=80, https=443). | |
| username | no | Configures the usename to use to authenticate the connection to the remote device. The value of username 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. | |
| password | no | Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either acceptable value of transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. | |
| ssh_keyfile | no | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used when transport=cli. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | |
| authorize | no | yes, no* | Instructs the module to enter priviledged mode on the remote device before sending any commands. If not specified, the device will attempt to excecute all commands in non-priviledged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead. |
| auth_pass | no | Specifies the password to use if required to enter privileged mode on the remote device. If authorize=no, 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. | |
| transport | yes | cli*, eapi | Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or eapi. |
| use_ssl | no | yes*, no | Configures the transport to use SSL if set to true only when transport=eapi. If transport=cli, this value is ignored. |
| provider | no | Convience method that allows all the above connection arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
Note: Asterisk (*) denotes the default value if none specified| Key | Choices | Description |
|---|---|---|
| no_log | true, false* | Prevents module arguments and output from being logged during the playbook execution. By default, no_log is set to true for tasks that gather and save EOS configuration information to reduce output size. Set to true to prevent all output other than task results. |
Note: Asterisk (*) denotes the default value if none specifiedThe eos-interfaces role is built on modules included in the core Ansible code. These modules were added in ansible version 2.1
The following example will use the arista.eos-interfaces role to setup
a few interfaces without writing any tasks. We'll create a
hosts file with our switch, then a corresponding host_vars file and
then a simple playbook which only references the eos-interfaces role.
By including the role, we automatically get access to all of the tasks
to configure interfaces. What's nice about this is that if you have a
host without interface configuration, the tasks will be skipped without any issue.
Sample hosts file:
[leafs]
leaf1.example.comSample host_vars/leaf1.example.com
provider:
host: "{{ inventory_hostname }}"
username: admin
password: admin
use_ssl: no
authorize: yes
transport: cli
interfaces:
- name: Ethernet1
description: Link to Peer1
- name: Ethernet2
description: Link to Peer1
- name: Loopback1000
description: Loopback for BGP
- name: Port-Channel50
description: Peer Channel-groupA simple playbook to configure BGP, leaf.yml
- hosts: leafs
roles:
- arista.eos-interfacesThen run with:
ansible-playbook -i hosts leaf.yml
Development contributions are welcome. Please see Arista Roles for Ansible - Development Guidelines (test/arista-ansible-role-test/README) for additional information, including how to develop and run test cases for role development.
Copyright (c) 2015, Arista Networks EOS+ All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Arista nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Please raise any issues using our GitHub repo or email us at ansible-dev@arista.com