eos

Arista Networks types and providers for configuring EOS devices

Module Stats

32,917 downloads

23,916 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Dec 9th 2016

This version is compatible with:

Puppet Enterprise < 2018.1.0
Puppet >= 3.0.0 < 6.0.0

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'aristanetworks-eos', '1.5.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add aristanetworks-eos

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install aristanetworks-eos --version 1.5.0

Tags: network, eos, netdev, arista

Documentation

aristanetworks/eos — version 1.5.0 Dec 9th 2016

Puppet EOS Module

Overview
Module Description
Setup
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for getting started developing the module
Contributing - Contributing to this project
License
Release Notes

Build status

Style/Lint/build/docs:

System tests spec/coverage:

Overview

The Arista EOS module for Puppet provides a set of types and providers for automating Arista EOS node configuraitons. The module allows for configuration of EOS nodes using the Puppet agent running native in EOS.

The Puppet EOS modules are freely provided to the open source community for automating Arista EOS node configurations using Puppet. Support for the modules is provided on a best effort basis by the Arista EOS+ community. Please file any bugs, questions or enhancement requests using Github Issues

Module Description

This module provides network abstractions for configuring network services on Arista EOS nodes. The module provides a set of types and providers to serve as building blocks for automating the configuration of Arista EOS nodes. This module extends Puppet's capability to configure network devices including node system services, access services and trunk side services of EOS nodes running EOS 4.13 or later with the Puppet agent installed. The Puppet agent running on the node will use pluginsync to download the types and providers from the Puppet master and uses the Ruby Client for eAPI (rbeapi) to interface with the nodes configuration.

Setup

What Puppet EOS affects

The types and providers in this module provide native abstractions for configuring Arista EOS nodes.

Setup Requirements

This module requires pluginsync in order to synchronize the types and providers to the node. This module also requires the Ruby Client for eAPI to be installed on the master and nodes.

Beginning with eos

Install the module on the Puppet master
Install the rbeapi gem on the Puppet master See Ruby Client for eAPI
Install the rbeapi gem on the switch See Ruby Client for eAPI
Run the puppet agent on the switch to synchronize the types and providers
List the types by running bash sudo puppet resource --types | grep eos from the EOS CLI enable mode
Verify the providrs by running bash sudo puppet resource <resource> from the EOS CLI enable mode

Arista$ bash sudo puppet resource eos_vlan
eos_vlan { '1':
  ensure    => 'present',
  enable    => 'true',
  vlan_name => 'default',
}
eos_vlan { '100':
  ensure    => 'present',
  enable    => 'true',
  vlan_name => 'TEST_VLAN_100',
}

Usage

See the Documentation

Reference

See the Type reference in the documentation

Limitations

Puppet 3.6 or later
Ruby 1.9.3 or later
Arista EOS 4.13.7M or later
Ruby Client for eAPI 0.4.0 or later

Development

This module can be configured to run directly from source and configured to do local development, sending the commands to the node over HTTP. The following instructions explain how to configure your local development environment.

This module requires one dependency that must be checked out as a Git working copy in the context of ongoing development in addition to running Puppet from source.

rbeapi

The dependency is managed via the bundler Gemfile and the environment needs to be configured to use local Git copies:

cd /workspace
git clone https://github.com/arista-eosplus/rbeapi
export GEM_RBEAPI_VERSION=file:///workspace/rbeapi

Once the dependencies are installed and the environment configured, then install all of the dependencies:

git clone https://github.com/arista-eosplus/puppet-eos
cd puppet-eos
bundle install --path .bundle/gems

Once everything is installed, run the spec tests to make sure everything is working properly:

bundle exec rspec spec

Finally, configure the eapi.conf file for rbeapi See rbeapi for details and set the connection enviroment variable to run sanity tests using puppet resource:

export RBEAPI_CONNECTION=veos01

Contributing

Contributions to this project are gladly welcomed in the form of issues (bugs, questions, enhancement proposals) and pull requests. All pull requests must be accompanied by spec unit tests and up-to-date doc-strings, otherwise the pull request will be rejected.

License

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 Networks 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.

Release Notes

See the Release Notes in the official documentation.

Types in this module release

eos_user

Manage Arista EOS user accounts.

Example:

    $pub_key = 'ssh-rsa AAAAB3u...QHLzF9 admin@example.com'

    eos_user { 'admin':
      privilege  => 15,
      role       => 'network-admin',
      encryption => sha512,
      secret     => '$1$rnfsWaC6$ZFPdsxxLS4wvSCA9p1wGg/',
      sshkey     => $pub_key,
    }

Parameters
ensure
name	The switch CLI username.
provider

Properties
encryption	Defines the encryption format of the password provided in the corresponding secret key. Note that cleartext passwords are allowed via manual CLI user creation but are not supported in this module due to security concerns and idempotency.
nopassword	Create a user with no password assigned.
privilege	Configures the privilege level for the user. Permitted values are integers between 0 and 15. The EOS default privilege is 1.
role	Configures the role assigned to the user. The EOS default for this attribute is managed with aaa authorization policy local default-role; this is typically the network-operator role.
secret	This key is used in conjunction with encryption. The value should be a hashed password that was previously generated.
sshkey	Configures an sshkey for the CLI user. This sshkey will end up in /home/USER/.ssh/authorized_keys. Typically this is the public key from the client SSH node.

Providers
eos	Manage user accounts on Arista EOS. Requires rbeapi rubygem.

eos_switchconfig

Manage the complete EOS config as a file

Use files, templates, or concatenated files/template blocks to build
and manage the entire EOS configuration as a single object.  By default,
changes will be written to flash:puppet-config then the 'configure
replace' in EOS will safely overwrite the running-config.

Examples:

    eos_switchconfig { 'running-config':
      source  => template(),
    }

    eos_switchconfig { 'running-config':
      content => template(),
    }


    eos_switchconfig { 'running-config':
      source  => template(),
      file    => 'config-puppet',
    }

Parameters
ensure
name	The name of this resource should always be 'running-config'
provider

Properties
content	The content is a string or URI to a file to be used as the EOS running-config.
source	Source is a list of templates which will be concatenated to create the desired running-config. `Example configuration source => ['tg1', 'tg2'] The default configure is an empty list`
staging_file	The staging_file is the actual file which will be managed on flash: on the switch before running 'configure replace'. `The default value is 'puppet-config' stored on flash:.`

Providers
eos	Manage the entire running-config on Arista EOS. Requires rbeapi.

eos_vlan

Manage VLANs on Arista EOS.

Examples:

    eos_vlan { '1':
      vlan_name => 'default',
    }

    eos_vlan { '4094':
      enable       => true,
      vlan_name    => 'MLAG_control',
      trunk_groups => ['trunkpeer'],
    }

    # Remove all un-managed VLANs
    resources { 'eos_vlan': purge => true }

Parameters
ensure
provider
vlanid	The name parameter specifies the VLAN ID to manage on the node. The VLAN ID parameter must be in the valid VLAN ID range of 1 to 4094 expressed as a String.

Properties
enable	The enable property configures the administrative state of the VLAN ID. When enable is configured as true, the ports forward traffic configured with the specified VLAN and when enable is false, the specified VLAN ID is blocked. Valid VLAN ID values: `* true - Administratively enable (active) the VLAN * false - Administratively disable (suspend) the VLAN`
trunk_groups	The trunk_groups property assigns an array of trunk group names to the specified VLANs. A trunk group is the set of physical interfaces that comprise the trunk and the collection of VLANs whose traffic is carried only on ports that are members of the trunk gorups to which the VLAN belongs `Example configuration trunk_groups => ['group1', 'group2'] The default configure is an empty list`
vlan_name	The vlan_name property configures the alphanumber VLAN name setting in EOS. TThe name consists of up to 32 characters. The system will automatically truncate any value larger than 32 characters.

Providers
eos	Manage VLANs on Arista EOS. Requires rbeapi rubygem.

eos_acl_entry

Manage access-lists on Arista EOS.

Example:

    eos_acl_entry{ 'test1:10':
      ensure       => present,
      acltype      => standard,
      action       => permit,
      srcaddr      => '1.2.3.0',
      srcprefixlen => 8,
      log          => true,
    }

Parameters

ensure

name

The name parameter is a composite namevar that combines the access-list name and the sequence number delimited by the colon (:) character

  For example, if the access-list name is foo and the sequence
  number for this rule is 10 the namvar would be constructed as
  "foo:10"

  The composite namevar is required to uniquely identify the
  specific list and rule to configure

provider

Properties
acltype	The ACL type which is either standard and extended. Standard ACLs filter only on the source IP address. Extended ACLs allow specification of source and destination IP addresses.
action	The action for the rule can be either permit or deny. Deny is the default value. Packets filtered by a permit rule are accepted by interfaces to which the ACL is applied. Packets filtered by a deny rule are dropped by interfaces to which the ACL is applied.
log	When set to true, triggers an informational log message to the console about hte matching packet.
srcaddr	The source IP address. The following options are supported: `network_address - subnet address where srcprefixlen defines mask any - Packets from all addresses are filtered. host ip_addr - IP address (dotted decimal notation)`
srcprefixlen	The source address prefix len used when srcaddr is a network address to define the subnet. Values range from 0 to 32.

Providers
eos	Manage IP access-lists in Arista EOS. Requires rbeapi rubygem.

eos_ospf_network

Manage OSPF network statements.

Example:

    eos_ospf_network { '192.168.10.0/24':
      instance_id => 1,
      area        => 0.0.0.0,
    }

Parameters
ensure
name
provider

Properties
area	The area property configures the ospf area of the specified ospf network. The area property must be a valid area in the dotted decimal notation (ip address). `For example area => 0.0.0.0,`
instance_id

Providers
eos	Manage OSPF networks on EOS. Requires rbeapi rubygem.

eos_alias

Manage Arista EOS alias entries.

Example:

    eos_alias { 'ru':
      command  => 'show ru',
    }
    eos_alias { 'desc':
      command => '1 conf

2 int %1 3 description %2 4 end end', }

Parameters
ensure
name	The: alias entry name.
provider

Properties
command	The command to run when alias is used.

Providers
eos	Manage alias entries on Arista EOS. Requires rbeapi rubygem.

eos_stp_interface

Manage Spanning Tree Protocol interface configuration.

Example:

    eos_stp_interface { 'Ethernet16':
      portfast      => true,
      portfast_type => network,
      bpduguard     => false,
    }

Parameters
name
provider

Properties
bpduguard
portfast
portfast_type

Providers
eos	Manage interface spanning-tree settings on Arista EOS. Requires rbeapi

eos_bgp_neighbor

Manage BGP neighbor configuration on Arista EOS.

Example:

    eos_bgp_neighbor { 'Edge':
      ensure         => present,
      enable         => true,
      description    => 'some text',
      send_community => true,
      route_map_in   => 'in_map',
      route_map_out  => 'out_map',
      next_hop_self  => false,
    }

    eos_bgp_neighbor { '192.0.3.1':
      ensure         => present,
      enable         => true,
      peer_group     => 'Edge',
      remote_as      => 65004,
      send_community => true,
      next_hop_self  => true,
    }

Parameters
ensure
name	The name of the BGP neighbor to manage. This value can be either an IPv4 address or string (in the case of managing a peer group).
provider

Properties
description	Configures the BGP neighbors description value. The value specifies an arbitrary description to add to the neighbor statement in the nodes running-configuration.
enable	Configures the administrative state for the BGP neighbor process. If enable is True then the BGP neighbor process is administartively enabled and if enable is False then the BGP neighbor process is administratively disabled.
next_hop_self	Configures the BGP neighbors next-hop-self value. If enabled then the BGP next-hop-self value is enabled. If disabled, then the BGP next-hop-self community value is disabled
peer_group	The name of the peer-group value to associate with the neighbor. This argument is only valid if the neighbor is an IPv4 address.
remote_as	Configures the BGP neighbors remote-as value. Valid AS values are in the range of 1 to 65535. The value is an Integer.
route_map_in	Configures the BGP neigbhors route-map in value. The value specifies the name of the route-map.
route_map_out	Configures the BGP neigbhors route-map out value. The value specifies the name of the route-map.
send_community	Configures the BGP neighbors send-community value. If enabled then the BGP send-community value is enable. If disabled, then the BGP send-community value is disabled.

Providers
eos	Manage BGP neighbor configuration on Arista EOS. Requires rbeapi.

eos_vxlan

Manange VXLAN interface configuration on Arista EOS. Configure logical Vxlan interface instances and settings

Example:

    eos_vxlan { 'Vxlan1':
      source_interface => 'Loopback1',
      udp_port         => 5500,
    }

Parameters
ensure
name	The name parameter specifies the name of the Vxlan interface to configure. The value must be the full interface name identifier that corresponds to a valid interface name in EOS.
provider

Properties
description	The one line description to configure for the interface. The description can be any valid alphanumeric string including symbols and spaces. `The default value for description is ''`
enable	The enable value configures the administrative state of the specified interface. Valid values for enable are: `* true - Administratively enables the interface * false - Administratively disables the interface The default value for enable is :true`
multicast_group	The multicast group property specifies the multicast group address to use for VTEP communication. This value configures the vxlan multicast-group value in EOS. The configured value must be a valid multicast address in the range of 224/8. `The default value for multicast_group is ''`
source_interface	The source interface property specifies the interface address to use to source Vxlan packets from. This value configures the vxlan source-interface value in EOS `The default value for source_interface is ''`
udp_port	The udp_port property specifies the VXLAN UDP port associated with sending and receiveing VXLAN traffic. This value configures the vxlan udp-port value in EOS. The configured value must be an integer in the range of 1024 to 65535. `The default value for the udp_port setting is 4789`

Providers
eos	Manage global VxLAN settings on Arista EOS. Requires rbeapi

eos_logging_host

Manage logging destination hosts in Arista EOS to receive syslog messages.

Example:

    eos_logging_host { '10.0.0.150': }

Parameters
ensure
name	The parameter specifies the name for the logging host. It should be in either IP format or FQDN format.
provider

Providers
eos	Manage logging hosts on EOS. Requires rbeapi rubygem.

eos_ospf_instance

Manage OSPF instance configuration.

Example:

    eos_ospf_instance { '1':
      router_id                 => 192.168.1.1,
      max_lsa                   => 12000,
      maximum_paths             => 16,
      passive_interfaces        => [],
      active_interfaces         => ['Ethernet49', 'Ethernet50'],
      passive_interface_default => true,
    }

Parameters
ensure
name
provider

Properties
active_interfaces	The active_interface property configures all ospf enabled interfaces on the specified ospf instance. The active_interface property must be an array of EOS interfaces. `For example active_interfaces => ['Ethernet49', 'Ethernet50', 'Vlan4093'],`
max_lsa	The max_lsa property configures the LSA Overload on the specified ospf instance. The max_lsa property must have a value between 0 and 100000. The max_lsa property specifies the maximum number of LSAs allowed in an LSDB database and configures the switch behavior when the limit is approached or exceeded. `For example max_lsa => 12000,`
maximum_paths	The maximum_paths property configures the maximum-paths on the specified ospf instance. The maximum_paths property must have a value between 1 and N where N is the number of interfaces available per ECMP group. The maximum_paths command controls the number of parallel routes that OSPFv2 supports. The default maximum is 16 paths. `For example maximum_paths => 16,`
passive_interface_default	The passive_interface_default property configures all interfaces passive by default on the specified ospf instance. The switch advertises the passive interface as part of the router LSA. The passive_interface_default value must be true or false. When it is set to false, all interfaces are OSPFv2 active by default and passive interfaces must be specified in the passive_interfaces property. When passive_interface_default is set to true, all interfaces are OSPFv2 passive by default and active interfaces must be specified in the active_interfaces property. `For example passive_interface_default => false,`
passive_interfaces	The passive_interface property configures all ospf disabled interfaces on the specified ospf instance. The passive_interface property must be an array of EOS interfaces. `For example passive_interfaces => ['Loopback0'],`
router_id	The router_id property configures the router id on the specified ospf instance. The router_id value must be a valid IPv4 address. The router ID is a 32-bit number assigned to a router running OSPFv2. This number uniquely labels the router within an Autonomous System. Status commands identify the switch through the router ID. `For example router_id => 192.168.1.1`

Providers
eos	Manage OSPF instances on EOS. Requires rbeapi rubygem.

eos_mlag

Manage the global MLAG instance on Arista EOS. It provides configuration for global MLAG configuration parameters.

Example:

    eos_mlag { 'settings':
      enable          => true,
      domain_id       => 'SPINE-MLAG',
      local_interface => 'Vlan4094',
      peer_address    => '192.168.0.2',
      peer_link       => 'Port-Channel900',
    }

Parameters
name	The name parameter identifies the global MLAG instance for configuration and should be configured as 'settings'. All other values for name will be siliently ignored by the eos_mlag provider.
provider

Properties
domain_id	The domain_id property configures the MLAG domain-id value for the global MLAG configuration instance. The domain-id setting identifies the domain name for the MLAG domain. Valid values include alphanumeric characters
enable	The enable property configures the admininstrative state of the global MLAG configuration. Valid values for enable are: `* true - globally enables the MLAG configuration * false - glboally disables the MLAG configuration`
local_interface	The local_interface property configures the MLAG local-interface value for the global MLAG configuration instance. The local-interface setting specifies the VLAN SVI to send MLAG control traffic on. `Valid values must be a VLAN SVI identifier`
peer_address	The peer_address property configures the MLAG peer-address value for the global MLAG configuration instance. The peer-address setting specifieds the MLAG peer control endpoint IP address. `The specified value must be a valid IP address`
peer_link	The peer_link property configures the MLAG peer-link value for the glboal MLAG configuration instance. The peer-link setting specifies the interface used to communicate control traffic to the MLAG peer `The provided value must be a valid Ethernet or Port-Channel interface identifer`

Providers
eos	Manage MLAG configuration on EOS. Requires rbeapi rubygem.

eos_snmp

Manage global SNMP configuration on Arista EOS.

Example:

    eos_snmp { 'settings':
      contact          => 'DC02-ops@example.com',
      location         => 'DC02 POD12 Rack3'
      chassis_id       => 'JMB00000',
      source_interface => 'Loopback0',
    }

Parameters
name	The name parameter identifis the global SNMP instance for configuration and should be configured as 'settings'. All other values for name will be silently ignored by the eos_snmp provider.
provider

Properties
chassis_id	The chassis id propperty provides configuration management of the SNMP chassis-id value. This setting typically provides information to uniquely identify the SNMP agent host. `The default value for chassis_id is ''`
contact	The contact property provides configuration management of the SNMP contact value. This setting provides informative text that typically displays the name of a person or organization associated with the SNMP agent. `The default value for contact is ''`
location	The location property provides configuration management of the SNMP location value. This setting typcially provides information about the physical lcoation of the SNMP agent. `The default value for location is ''`
source_interface	The source interface property provides configuration management of the SNMP source-interface value. The source interface value configures the interface address to use as the source address when sending SNMP packets on the network. `The default value for source_interface is ''`

Providers
eos	Manage global SNMP configuration on EOS. Requires rbeapi rubygem.

eos_ipinterface

Manage logical IP (L3) interfaces in Arista EOS. Used for IPv4 physical interfaces and logical virtual interfaces.

Example:

    eos_ipinterface { 'Ethernet3':
      address => '192.0.3.2/24',
      mtu     => 1514,

    }
    eos_ipinterface { 'Vlan201':
      address          => '192.0.2.1/24',
      helper_addresses => ['192.168.10.254', '192.168.11.254'],
    }

Parameters
ensure
name	The name parameter specifies the full interface identifier of the Arista EOS interface to manage. This value must correspond to a valid interface identifier in EOS.
provider

Properties
address	The address property configures the IPv4 address on the specified interface. The address value is configured using address/mask format. `For example address => 192.168.10.16/24`
helper_addresses	The helper_addresses property configures the list of IP helper addresses on the specified interface. IP helper addresses configure a list of forwarding address to send send broadcast traffic to as unicast, typically used to assist DHCP relay. `Helper addresses are configured using dotted decimal notation. For example helper_addresses => ['192.168.10.254', '192.168.11.254']`
mtu	The mtu property configures the IP interface MTU value which specifies the largest IP datagram that can pass over the interface without fragementation. The MTU value is specified in bytes and accepts an integer in the range of 68 to 9214.

Providers
eos	Manage L3 interfaces on EOS. Requires rbeapi rubygem.

eos_vxlan_vtep

Manage the global Vxlan VTEP flood list on Arista EOS.

Example:

    eos_vxlan_vtep { '10.1.1.1': }

Parameters
ensure
name	The name property associates the IPv4 flood address on the specified VXLAN VNI interface. The address value is configured using address format. `Example name => 192.168.10.16`
provider

Providers
eos	Manage global VxLAN VTEP flood list on Arista EOS. Requires rbeapi.

eos_ntp_config

Manage global NTP configuration settings on Arista EOS.

Example:

    eos_ntp_config { 'settings':
      source_interface => 'Management1',
    }

Parameters
name	The name parameter identifies the global NTP instance for configuration and should be configured as 'settings'. All other values for name will be siliently ignored by the provider.
provider

Properties
source_interface	The source interface property provides configuration management of the NTP source-interface value. The source interface value configures the interface address to use as the source address when sending NTP packets on the network. `The default value for source_interface is ''`

Providers
eos	Manage global NTP configuration on EOS. Requires rbeapi rubygem.

eos_interface

Manage common attributes of all Arista EOS interfaces.

Example:

    eos_interface { 'Management1':
      enable      => true,
      description => 'OOB management to mgmt-sw1 Ethernet42',
      autostate   => true,
    }
    eos_interface { 'Ethernet1.10':
      enable        => true,
      encapsulation => '10',
    }

Parameters
ensure
name	The name parameter specifies the full interface identifier of the Arista EOS interface to manage. This value must correspond to a valid interface identifier in EOS.
provider

Properties
autostate	This option configures autostate on a VLAN interface. Valid values for enable are: `* true - Enable autostate (default setting on EOS) * false - Set no autostate`
description	The one line description to configure for the interface. The description can be any valid alphanumeric string including symbols and spaces.
enable	The enable value configures the administrative state of the specified interface. Valid values for enable are: `* true - Administratively enables the interface * false - Administratively disables the interface`
encapsulation	The vlan ID to use in encapsulation dot1q vlab configurations for sub interfaces.
load_interval	The load interval of an interface.

Providers
eos	Manage interfaces on EOS. Requires rbeapi rubygem.

eos_bgp_config

Manage the global BGP routing process on Arista EOS.

Example:

    eos_bgp_config { 65001:
      ensure             => present,
      enable             => true,
      router_id          => '192.0.2.4',
      maximum_paths      => 8,
      maximum_ecmp_paths => 8,
    }

Parameters
bgp_as	The BGP autonomous system number to be configured for the local BGP routing instance. The value must be in the valid BGP AS range of 1 to 65535. The value is a String.
ensure
provider

Properties
enable	Configures the administrative state for the global BGP routing process. If enable is True then the BGP routing process is administartively enabled and if enable is False then the BGP routing process is administratively disabled.
maximum_ecmp_paths	Maximum number of installed ECMP routes. This value should be greater than or equal to maximum_paths.
maximum_paths	Maximum number of equal cost paths. This value should be less than or equal to maximum_ecmp_paths.
router_id	Configures the BGP routing process router-id value. The router id must be in the form of A.B.C.D

Providers
eos	Manage global BGP routing process on Arista EOS. Requires rbeapi.

eos_ntp_server

Manage the list of NTP servers on Arista EOS.

Example:

    eos_ntp_server { '174.127.117.113':
      ensure => present,
    }

    # Remove all un-managed servers
    resources { 'eos_snmp': purge => true }

Parameters
ensure
name	The name parameter configures the NTP server list by adding or removing NTP server entries. The value can be configured as either the host IP address or the fully qualified domain name of the desired NTP server.
provider

Providers
eos	Manage NTP server definitions on EOS. Requires rbeapi rubygem.

eos_routemap

Manage route-maps on Arista EOS.

Examples:

    eos_routemap { 'my_routemap:10':
      description => 'test 10',
      action      => permit,
      match       => 'ip address prefix-list 8to24',
    }

    eos_routemap { 'bgp_map:10':
      action   => permit,
      match    => 'as 10',
      set      => 'local-preference 100',
      continue => 20,
    }

    eos_routemap { 'bgp_map:20':
      action => permit,
      match  => [' metric-type type-1', 'as 100'],
    }

Parameters
ensure
name	The name of the routemap namevar composite name:seqno.
provider

Properties
action	A description for the route-map.
continue	A route-map sequence number to continue on.
description	A description for the route-map.
match	Route map match rule.
set	Set route attribute.

Providers
eos	Manage routemaps on Arista EOS. Requires rbeapi rubygem

eos_switchport

Manage logical layer 2 switchports in EOS.

When creating a logical switchport interface, if the specified
physical interface was previously configured with an IP interface,
the logical IP interface will be removed.

Examples:

    eos_switchport { 'Ethernet14':
      mode        => access,
      access_vlan => 200,
    }

    eos_switchport { 'Ethernet15':
      mode                => trunk,
      trunk_allowed_vlans => ['1', '100-104', '110', '2000-2099'],
      trunk_native_vlan   => 10,
      trunk_groups        => [tg1, tg2],
    }

Parameters
ensure
name	The name parameter specifies the full interface identifier of the Arista EOS interface to manage. This value must correspond to a valid interface identifier in EOS. `Only Ethernet and Port-Channel interfaces can be configured as switchports.`
provider

Properties
access_vlan	The access_vlan property specifies the VLAN ID to be used for untagged traffic that enters the switchport when configured in access mode. If the switchport is configured for trunk mode, this value is configured but has no effect. The value must be an integer in the valid VLAN ID range of 1 to 4094. `The default value for the access_vlan is 1`
mode	The mode property configures the operating mode of the logical switchport. Suppport modes of operation include access port or trunk port. The default value for a new switchport is access `* access - Configures the switchport mode to access * trunk - Configures the switchport mode to trunk`
trunk_allowed_vlans	The trunk_allowed_vlans property configures the list of VLAN IDs that are allowed to pass on the switchport operting in trunk mode. If the switchport is configured for access mode, this property is configured but has no effect. `The list of allowed VLANs must be configured as an Array with each entry in the valid VLAN range of 1 to 4094. The default value for a new switchport is to allow all valid VLAN IDs (1-4094).`
trunk_groups	The trunk_groups property assigns an array of trunk group names to the specified switchport/portchannel. A trunk group is the set of interfaces that comprise the trunk and the collection of VLANs whose traffic is carried only on ports that are members of the trunk groups to which the VLAN belongs. `Example configuration trunk_groups => ['tg1', 'tg2'] The default configure is an empty list`
trunk_native_vlan	The trunk_native_vlan property specifies the VLAN ID to be used for untagged traffic that enters the switchport in trunk mode. If the switchport is configured for access mode, this value is configured but has no effect. The value must be an integer in the valid VLAN ID range of 1 to 4094. `The default value for the trunk_natve_vlan is 1`

Providers
eos	Manage L2 interface settings on Arista EOS. Requires rbeapi rubygem.

eos_bgp_network

Manage BGP network statements on Arista EOS.

Example:

    eos_bgp_network { '192.0.3.0/24':
      ensure    => present,
      route_map => 'neighbor3_map',
    }

Parameters
ensure
name	The name is a composite name that contains the IPv4_Prefix/Masklen. The IPv4 prefix to configure as part of the network statement. The value must be a valid IPv4 prefix. The IPv4 subnet mask length in bits. The value for the masklen must be in the valid range of 1 to 32.
provider

Properties
route_map	Configures the BGP route-map name to apply to the network statement when configured. Note this module does not create the route-map.

Providers
eos	Manage BGP network configuration on Arista EOS. Requires rbeapi.

eos_prefixlist

eos_varp

Manage global VARP settings on Arista EOS. Configure the Virtual-ARP mac address.

Example:

    eos_varp { 'settings':
        mac_address => '001c.7300.0099',
    }

Parameters
ensure
name	Resource name defaults to 'settings' and is not used to configure EOS. Returns an error if a name other than 'settings' is specified.
provider

Properties
mac_address	Assigns a virtual MAC address to the switch.

Providers
eos	Manage global VARP virtual MAC address on Arista EOS. Requires rbeapi.

eos_ethernet

Manage physical Ethernet interfaces on Arista EOS. Physical Ethernet interfaces include the physical characteristics of front panel data plane ports but does not include out-of-band Management interfaces.

Example:

    eos_ethernet { 'Ethernet3/17':
      enable              => true,
      description         => 'To switch2 Ethernet 1/3',
      flowcontrol_send    => on,
      flowcontrol_receive => on,
      speed               => 'forced 40gfull',
      lacp_priority       => 0,
    }

Parameters
name	The name of the physical interface to configure. The interface name must coorelate to the full physical interface identifier in EOS.
provider

Properties
description	The one line description to configure for the interface. The description can be any valid alphanumeric string including symbols and spaces.
enable	The enable value configures the administrative state of the physical Ethernet interfaces. Valid values for enable are: `* true - Administratively enables the Ethernet interface * false - Administratively disables the Ethernet interface`
flowcontrol_receive	This property configures the flowcontrol receive value for the specified Ethernet interface. Valid values for flowcontrol are: `* on - Configures flowcontrol receive on * off - Configures flowcontrol receive off`
flowcontrol_send	This property configures the flowcontrol send value for the specified Ethernet interface. Valid values for flowcontrol are: `* on - Configures flowcontrol send on * off - Configures flowcontrol send off`
lacp_priority	The lacp_priority property specifies the lacp port priority associated with the ethernet interface. The configured value must be an integer in the range of 0 to 65535. `The default value for the lacp_priority setting is 32768`
speed	This property configures the interface speed for the specified Ethernet interface. Valid values for speed are: `* 'default' * '100full' * '10full' * 'auto' * 'auto 100full' * 'auto 10full' * 'auto 40gfull' * 'forced 10000full' * 'forced 1000full' * 'forced 1000half' * 'forced 100full' * 'forced 100gfull' * 'forced 100half' * 'forced 10full' * 'forced 10half' * 'forced 25gfull' * 'forced 40gfull' * 'forced 50gfull' * 'sfp-1000baset auto 100full'`

Providers
eos	Manage ethernet interfaces on EOS. Requires rbeapi rubygem.

eos_vxlan_vlan

Manage VXLAN VLAN to VNI mappings in Arista EOS.

Examples:

    eos_vxlan_vlan { '100':
      vni => '100',
    }

    eos_vxlan_vlan { '200':
      vni => '10.10.200',
    }

Parameters
ensure
name	The VLAN ID that is associated with this mapping in the valid VLAN ID range of 1 to 4094. The VLAN ID is configured on the VXLAN VTI with a one-to-one mapping to VNI.
provider

Properties
vni	The VNI associate with the VLAN ID mapping on the VXLAN VTI interface. The VNI value is an integer value in the range of 1 to 16777215.

Providers
eos	Manage VxLAN VLANs on Arista EOS. Requires rbeapi

eos_mst_instance

Configure MST instance settings.

Example:

    eos_mst_instance { '0':
      priority => 8192,
    }

Parameters
ensure
name
provider

Properties
priority

Providers
eos	Manage MST instance configuration on EOS. Requires rbeapi rubygem.

eos_portchannel

Manage logical Port-Channel interfaces on Arista EOS.

Example:

    eos_portchannel { 'Port-Channel30':
      ensure        => present,
      description   => 'Host 39b',
      minimum_links => 2,
      lacp_mode     => active,
      lacp_fallback => individual,
      lacp_timeout  => 30,
    }

    eos_portchannel { 'Port-Channel31':
      ensure => absent,
    }

Parameters
ensure
name	The name parameter specifies the name of the Port-Channel interface to configure. The value must be the full interface name identifier that corresponds to a valid interface name in EOS.
provider

Properties
description	The one line description to configure for the interface. The description can be any valid alphanumeric string including symbols and spaces. `The default value for description is ''`
enable	The enable value configures the administrative state of the specified interface. Valid values for enable are: `* true - Administratively enables the interface * false - Administratively disables the interface The default value for enable is :true`
lacp_fallback	The lacp_fallback property configures the port-channel lacp fallback setting in EOS for the specified interface. This setting accepts the following values `* static - Fallback to static LAG mode * individual - Fallback to individual ports * disabled - Disable LACP fallback The default value for lacp_fallback is :disabled`
lacp_mode	The lacp_mode property configures the LACP operating mode of the Port-Channel interface. The LACP mode supports the following valid values `* active - Interface is an active LACP port that transmits and receives LACP negotiation packets. * passive - Interface is a passive LACP port that only responds to LACP negotiation packets. * on - Interface is a static port channel, LACP disabled. The default value for lacp_mode is :on`
lacp_timeout	The lacp_timeout property configures the port-channel lacp timeout value in EOS for the specified interface. The fallback timeout configures the period an interface in fallback mode remains in LACP mode without receiving a PDU. `The lacp_timeout value is configured in seconds.`
members	The members property manages the Array of physical interfaces that comprise the logical Port-Channel interface. Each entry in the members Array must be the full interface identifer of a physical interface name. `The default value for members is []`
minimum_links	The minimum links property configures the port-channel min-links value. This setting specifies the minimum number of physical interfaces that must be operationally up for the Port-Channel interface to be considered operationally up. `Valid range of values for the minimum_links property are from 0 to 16. The default value for minimum_links is 0`

Providers
eos	Manage port-channel interfaces on EOS. Requires rbeapi rubygem.

eos_managementdefaults

Configure the management defaults on Arista EOS. It allows to set the value for secret hash. Accepted values are: md5 and sha512

Example:

    eos_managementdefaults { 'settings':
      secret_hash     => 'sha512',
    }

Parameters
name	The name parameter identifies the global management defaults configuration and should be configured as 'settings'. All other values for name will be silently ignored by the eos_managementdefaults provider.
provider

Properties
secret_hash	The secret_hash property configures the hash algoritm to use to store secrets.

Providers
eos	Configure management defaults on EOS. Requires rbeapi rubygem.

eos_command

Execute arbitrary CLI commands on Arista EOS. Commands can be executed in priviledged mode (enable) or configuration commands.

Example:

    eos_command { 'Save running-config':
      mode     => 'enable',
      commands => 'copy running-config startup-config',
    }

Parameters
name	The resource name for the command instance.
provider

Properties
commands	Array of commands to execute on the node. Mutliple commands can be sent to the node as a comma delimited set of values.
mode	Specifies the command mode to execute the commands in. If this value is config then the command list is executed in config mode. If the value is enable, then the command list is executed in privileged (enable) mode. The default is enable mode.

Providers
eos	Exec commands on Arista EOS. Requires rbeapi rubygem.

Change Log

1.5.0 (2016-12-09)

Full Changelog

Implemented enhancements:

Cleanup style and ignore unnecessary files in release pkg #114 (jerearista)
Add CI build badges to README.md #73 (jerearista)

Fixed bugs:

Limit rubocop version when running ruby 1.9 #81 (jerearista)
Update docs WRT puppet 2015.x agents #76 (jerearista)

Closed issues:

Gems not Ruby 1.9.3 compatible #95
Wrong datatype ine trunk_groups #79

Merged pull requests:

Style updates #113 (jerearista)
Switchconfig type & provider #112 (jerearista)
add 25gfull and 50gfull for the allowed ethernet speeds #110 (mmailand)
add support for subinterfaces/loadinterval #109 (mmailand)
Added eos_alias type #108 (mmailand)
added support for setting the crypto in managementdefaults #107 (mmailand)
added support for autostate #106 (mmailand)
Add TestKitchen framework #105 (jerearista)
modify munge not to rely on netaddr gem #102 (mrvinti)
fix require statements to workaround autoload issues with puppet #100 (rknaus)
add prefixlist type and provider + spec tests #99 (mrvinti)
add logging host type and provider #98 (rknaus)
add ospf types and providers #97 (rknaus)
Limit version of json and listen gems when Ruby \< 2.0 #96 (jerearista)
add mst instance type and provider #94 (rknaus)
add switchport trunk allowed vlan list capability #92 (rknaus)
add ethernet speed and lacp port priority support #91 (rknaus)
Fix password change issue for md5 and sha512 passwords #87 (mmailand)
portchannel_convergence needs two puppet runs #85 (mmailand)
implemented trunk group support for the eos_switchport provider #83 (mmailand)
Fix issue with autoload of helper #82 (rknaus)
Back out change from PR 78 - use set_trunk_groups. #80 (devrobo)
Fixed Typo in the vlan provider in the trunk_groups function. #78 (mmailand)
Merge Release 1.4.0 back to develop #72 (jerearista)

v1.4.0 (2016-01-13)

Full Changelog

Implemented enhancements:

Update metadata to include requirements section #66
eos_stp_interface provider unit test is incomplete. #51
Add requirements section to metadata #67 (jerearista)

Fixed bugs:

eos_portchannel members not idempotent when interface order is not the same #46
eos_vlan provider does not properly set trunk_groups #38
Ensure order of array does not affect idempotency #70 (websitescenes)
Fixed trunk groups call in provider. #68 (devrobo)

Closed issues:

Providers only actually work in tests #60
All providers should have a description #55
Cleanup documentation #19

Merged pull requests:

Release 1.4.0 #71 (jerearista)
Add test cases for provider methods. #69 (devrobo)
Add / enhance descriptions with examples #64 (jerearista)

v1.3.0 (2015-11-21)

Full Changelog

Implemented enhancements:

Confine types to only run on AristaEOS #36
Confine providers to only run on AristaEOS and when rbeapi >= 0.3.0 is present #48 (jerearista)
Feature bgp update #41 (websitescenes)

Merged pull requests:

Merge develop with master for Release 1.3.0 #63 (jerearista)
Release 1.3.0 #62 (jerearista)
Confinement update #61 (jerearista)
Adjustments for idempotency in staticroute #59 (websitescenes)
Feature system update #58 (websitescenes)
Feature confine rbeapi #57 (jerearista)
Netaddr inconsistencies. #56 (websitescenes)
Created eos_vrrp type #53 (devrobo)
Adding routemap functionality #52 (websitescenes)
Add eos_config resource. #50 (devrobo)
Addressed Rubocop issues #49 (devrobo)
eos varp and varp interface functionality. #47 (websitescenes)
Fixed version typo from 4.15.5 --> 4.14.5 #45 (jerearista)
Fixes #44 (devrobo)
Remove unneeded information from bgp flush #43 (websitescenes)
Adding feature eos user type and provider. #42 (websitescenes)
Convert bgp flush #40 (devrobo)
Add 4.15 to the list of supported versions #39 (jerearista)

v1.2.0 (2015-08-26)

Full Changelog

Implemented enhancements:

Release 1.2.0 #34 (jerearista)
Pass in boolean value for enable option. #33 (devrobo)
BGP type and provider bug fix, enhancement, and updated tests #32 (devrobo)
Feature eos_staticroute #31 (jerearista)
Rubocop cleanup. #30 (devrobo)
Add unit test cases for yes/no and other boolean values. #28 (devrobo)
Added support for BGP types and providers along with unit tests. #25 (devrobo)

Fixed bugs:

mock not intercepting acl.getall call #14
BGP type and provider bug fix, enhancement, and updated tests #32 (devrobo)

Closed issues:

eos_bgp_neighbor not configuring #27
eos_interface not controlling shutdown/enable status properly #26

Merged pull requests:

Release 1.2.0 #37 (jerearista)
Verify results from get/getall call is not nil. #35 (devrobo)
Include release notes for the 1.1.0 release #24 (jerearista)

v1.1.0 (2015-07-07)

Full Changelog

Implemented enhancements:

Add tag metadata to enhance search-ability on Forge #11
Update metadata tags and operatingsystem_support #12 (jerearista)

Merged pull requests:

Include release notes for the 1.1.0 release #23 (jerearista)
Release 1.1.0 #22 (jerearista)
Prune unready types before release #21 (jerearista)
Merge 1.1.0 updates to develop #20 (jerearista)
Ci mods #18 (devrobo)
Added eos_command type, provider, and type unit test. #16 (devrobo)
Rubocop cleanup #13 (devrobo)
Added support for eos_stp_interface type and provider along with unit… #10 (devrobo)
Cleanup doc-related warnings and URLs #9 (jerearista)
Fixup release 1.0.0 merges #8 (jerearista)

v1.0.0 (2015-05-06)

Closed issues:

warning: already initialized constant IPADDR_REGEXP in mlag and ipinterface types #2

Merged pull requests:

Update guide/conf.py to get version from new metadata.json file #6 (jerearista)
Docs #5 (jerearista)
Release 1.0.0 #4 (devrobo)
Release prep #3 (jerearista)
adds type and provider support for vxlan vtep flood addresses #1 (devrobo)

* This Change Log was automatically generated by github_changelog_generator

Copyright (c) 2014-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 Networks 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.

Properties
action
eq
ge
le
masklen
prefix
prefix_list
seqno

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

eos

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

Puppet EOS Module

Table of Contents

Build status

Overview

Module Description

Setup

What Puppet EOS affects

Setup Requirements

Beginning with eos

Usage

Reference

Limitations

Development

Contributing

License

Release Notes

Types in this module release

eos_user

eos_switchconfig

eos_vlan

eos_acl_entry

eos_ospf_network

eos_alias

eos_stp_interface

eos_bgp_neighbor

eos_vxlan

eos_logging_host

eos_ospf_instance

eos_mlag

eos_snmp

eos_ipinterface

eos_vxlan_vtep

eos_ntp_config

eos_interface

eos_bgp_config

eos_ntp_server

eos_routemap

eos_switchport

eos_bgp_network

eos_prefixlist

eos_varp

eos_ethernet

eos_vxlan_vlan

eos_mst_instance

eos_portchannel

eos_managementdefaults

eos_command

Change Log

1.5.0 (2016-12-09)

v1.4.0 (2016-01-13)

v1.3.0 (2015-11-21)

v1.2.0 (2015-08-26)

v1.1.0 (2015-07-07)

v1.0.0 (2015-05-06)