rbeapi 0.5.1 → 1.0

data/guide/installation.rst

@@ -3,18 +3,37 @@ Installation
 
 .. contents:: :local:
 
-The source code for rbeapi is provided on Github at http://github.com/arista-eosplus/rbeapi. All current development is done in the develop branch. Stable released versions are tagged in the master branch and uploaded to RubyGems.
+The source code for rbeapi is provided on Github at
+http://github.com/arista-eosplus/rbeapi. All current development is done in the
+develop branch. Stable released versions are tagged in the master branch and
+uploaded to RubyGems.
 
-    To install the latest stable version of rbeapi, simply run gem install rbeapi
+To install the latest stable version of rbeapi, simply run ``gem install
+rbeapi``
 
-    To install the latest development version from Github, simply clone the develop branch and run
+To install the latest development version from Github, simply clone the develop
+branch and run
+
+.. code-block:: console
 
     $ rake build
     $ rake install
 
-    To create an RPM, run rake rpm
+    To create an RPM, run ``rake rpm``
+
+    To generate a SWIX file for EOS with necessary dependencies, run ``rake
+    all_rpms`` then follow the swix create instructions, provided by the build.
+    NOTE: Puppet provides a puppet agent SWIX which includes Ruby 1.9.3 in
+    /opt/puppetlabs/bin/ which is different from where you might otherwise
+    install Ruby. If you have installed the puppet-enterprise 3.x SWIX, then
+    you should build and use the rbeapi-puppet3 swix, below. If you have
+    installed the puppet-enterprise 2015.x SWIX, then you should build and use
+    the rbeapi-puppet-aio swix, below. The Chef client omnibus install also
+    includes its own version of Ruby in /opt/chef/bin/, thus the rbeapi-chef
+    swix should be used.  Otherwise, if you have installed at least Ruby
+    1.9.3 in the standard system location, then the rbeapi SWIX may be used.
 
-    To generate a SWIX file for EOS with necessary dependencies, run rake all_rpms then follow the swix create instructions, provided by the build. NOTE: PuppetLabs provides a puppet agent SWIX which includes Ruby 1.9.3 in /opt/puppet/bin/ which is different from where you might otherwise install Ruby. If you have installed the puppet-enterprise 3.x SWIX, then you should build and use the rbeapi-puppet3 swix, below. If you have installed the puppet-enterprise 2015.x SWIX, then you should build and use the rbeapi-puppet-aio swix, below. Otherwise, if you have installed at least Ruby 1.9.3 in the standard system location, then the rbeapi SWIX may be used.
+.. code-block:: console
 
     $ bundle install --path .bundle/gems/
     $ bundle exec rake all_rpms
@@ -43,7 +62,9 @@ The source code for rbeapi is provided on Github at http://github.com/arista-eos
         rubygem-netaddr-puppet-aio-1.5.0-2.eos4.noarch.rpm \
         rubygem-net_http_unix-puppet-aio-0.2.1-3.eos4.noarch.rpm
 
-    On EOS:
+On EOS:
+
+.. code-block:: console
 
     Arista# copy <URI-to-RPMs> flash:
     Arista# bash

data/guide/release-notes.rst

@@ -3,4 +3,8 @@ Release Notes
 
 .. toctree::
     :maxdepth: 2
-    :titlesonly:
+    :titlesonly:
+
+For the most up-to-date release notes, see the `GitHub release
+<https://github.com/arista-eosplus/rbeapi/releases>`_ pages or the `CHANGELOG
+<https://github.com/arista-eosplus/rbeapi/blob/develop/CHANGELOG.md>`_.

data/guide/testing.rst

@@ -3,6 +3,9 @@ Testing Modules
 
 .. contents:: :local:
 
-The rbeapi library provides spec tests. To run the spec tests, you will need to update the dut.conf file found in spec/fixtures. The switch used for testing should have at least interfaces Ethernet1-7.
+The rbeapi library provides spec tests. To run the spec tests, you will need to
+update the ``spec/fixtures/dut.conf`` file. The switch used for testing
+must have at least interfaces Ethernet1-7.
 
-    To run the spec tests, run bundle exec rspec spec from the root of the rbeapi source folder.
+To run the spec tests, run ``bundle exec rspec spec`` from the root of the
+rbeapi source folder.

data/guide/upgrading.rst

@@ -5,6 +5,8 @@ Upgrading
 
 On EOS:
 
+.. code-block:: console
+
   Arista# no extension pe-rbeapi-0.3.0-1.swix
   Arista# extension rbeapi-puppet3-0.4.0-1.swix
   Arista# copy installed-extensions boot-extensions

data/lib/rbeapi/api/dns.rb

@@ -198,19 +198,24 @@ module Rbeapi
       #   no ip domain-list
       #   default ip domain-list
       #
-      # @option value [Array] The set of domain names to configure on the
+      # @option opts value [Array] The set of domain names to configure on the
       #   node. The list of domain names will be replace in the nodes running
       #   configuration by the list provided in value.
       #
-      # @option default [Boolean] Configures the ip domain-list using the
+      # @option opts default [Boolean] Configures the ip domain-list using the
       #   default keyword argument.
       #
       # @return [Boolean] Returns true if the commands completed successfully.
+      # rubocop:disable Metrics/MethodLength
       def set_domain_list(opts = {})
         value = opts[:value]
         enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
+        if value
+          fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+        end
+
         cmds = []
         case default
         when true
@@ -229,6 +234,7 @@ module Rbeapi
         end
         configure cmds
       end
+      # rubocop:enable Metrics/MethodLength
 
       ##
       # add_domain_list adds an ip domain-list.

data/lib/rbeapi/api/interfaces.rb

@@ -144,6 +144,7 @@ module Rbeapi
     # that is common to all interfaces configured in EOS.
     class BaseInterface < Entity
       DEFAULT_INTF_DESCRIPTION = ''
+      DEFAULT_LOAD_INTERVAL = ''
 
       ##
       # get returns the specified interface resource hash that represents the
@@ -157,6 +158,7 @@ module Rbeapi
       #     type: 'generic'
       #     description: <string>
       #     shutdown: [true, false]
+      #     load_interval: <string>
       #   }
       #
       # @param name [String] The name of the interface to return from the
@@ -172,6 +174,7 @@ module Rbeapi
         response = { name: name, type: 'generic' }
         response.merge!(parse_description(config))
         response.merge!(parse_shutdown(config))
+        response.merge!(parse_load_interval(config))
         response
       end
 
@@ -213,6 +216,24 @@ module Rbeapi
       end
       private :parse_shutdown
 
+      ##
+      # parse_load_interval scans the provided configuration block and
+      # parse the load-interval value. If the interface load-interval
+      # value is not configured, then this method will return the value of
+      # DEFAULT_LOAD_INTERVAL. The hash returned is intended to be merged into
+      # the interface resource hash.
+      #
+      # @api private
+      #
+      # @param config [String] The configuration block to parse.
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_load_interval(config)
+        mdata = /load-interval (\w+)$/.match(config)
+        { load_interval: mdata.nil? ? DEFAULT_LOAD_INTERVAL : mdata[1] }
+      end
+      private :parse_load_interval
+
       ##
       # create will create a new interface resource in the node's current
       # configuration with the specified interface name. If the create
@@ -326,6 +347,27 @@ module Rbeapi
         commands = command_builder('shutdown', opts)
         configure_interface(name, commands)
       end
+
+      ##
+      # set_load_interval is a convenience function for configuring the
+      # value of interface load-interval
+      #
+      # @param name [String] The interface name to apply the configuration
+      # values to. The name must be the full interface identifier.
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts value [String] Specifies the value to configure the
+      # load-interval setting for. Valid values are between 5 and 600.
+      #
+      # @option opts default [Boolean] Configures the load-interval value on
+      # the interface using the default keyword.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_load_interval(name, opts = {})
+        commands = command_builder('load-interval', opts)
+        configure_interface(name, commands)
+      end
     end
 
     ##
@@ -334,8 +376,8 @@ module Rbeapi
     class EthernetInterface < BaseInterface
       DEFAULT_ETH_FLOWC_TX = 'off'
       DEFAULT_ETH_FLOWC_RX = 'off'
-      DEFAULT_SPEED = 'auto'
-      DEFAULT_FORCED = false
+      DEFAULT_SPEED = 'default'
+      DEFAULT_LACP_PRIORITY = 32_768
 
       ##
       # get returns the specified Ethernet interface resource hash that
@@ -347,11 +389,12 @@ module Rbeapi
       #     type: <string>,
       #     description: <string>,
       #     shutdown: <boolean>,
+      #     load_interval: <string>
       #     speed: <string>,
-      #     forced: <boolean>,
       #     sflow: <boolean>,
       #     flowcontrol_send: <string>,
       #     flowcontrol_receive: <string>
+      #     lacp_priority: <integer>
       #   }
       #
       # @param name [String] The interface name to return a resource hash
@@ -371,6 +414,7 @@ module Rbeapi
         response.merge!(parse_sflow(config))
         response.merge!(parse_flowcontrol_send(config))
         response.merge!(parse_flowcontrol_receive(config))
+        response.merge!(parse_lacp_priority(config))
         response
       end
 
@@ -386,10 +430,8 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
       def parse_speed(config)
-        value = config.scan(/speed (forced)?[ ]?(\w+)/).first
-        return { speed: DEFAULT_SPEED, forced: DEFAULT_FORCED } unless value
-        (forced, value) = value.first
-        { speed: value, forced: !forced.nil? }
+        value = config.scan(/speed (.*)/).first
+        { speed: value.nil? ? DEFAULT_SPEED : value.first }
       end
       private :parse_speed
 
@@ -446,6 +488,24 @@ module Rbeapi
       end
       private :parse_flowcontrol_receive
 
+      ##
+      # parse_lacp_priority scans the provided configuration block and parse
+      # the lacp port-priority value. If the interface lacp port-priority value
+      # is not configured, then this method will return the value of
+      # DEFAULT_LACP_PRIORITY. The hash returned is intended to be merged into
+      # the interface resource hash.
+      #
+      # @api private
+      #
+      # @param config [String] The configuration block to parse.
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_lacp_priority(config)
+        mdata = /lacp port-priority (\d+)$/.match(config)
+        { lacp_priority: mdata.nil? ? DEFAULT_LACP_PRIORITY : mdata[1] }
+      end
+      private :parse_lacp_priority
+
       ##
       # create overrides the create method from the BaseInterface and raises
       # an exception because Ethernet interface creation is not supported.
@@ -494,29 +554,21 @@ module Rbeapi
       # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option opts forced [Boolean] Specifies if auto negotiation should be
-      #   enabled (true) or disabled (false).
-      #
-      # @option opts default [Boolean] Configures the sflow value on the
-      #   interface using the default keyword.
-      #
       # @return [Boolean] Returns true if the command completed successfully.
       def set_speed(name, opts = {})
         value = opts[:value]
-        forced = opts.fetch(:forced, false)
         enable = opts.fetch(:enable, true)
-        default = opts.fetch(:default, false)
-
-        forced = 'forced' if forced
-        forced = '' if value == 'auto'
+        default = (value == :default)
 
         cmds = ["interface #{name}"]
         case default
         when true
           cmds << 'default speed'
         when false
-          cmds << enable ? "speed #{forced} #{value}" : 'no speed'
+          cmd = enable ? "speed #{value}" : 'no speed'
+          cmds << cmd
         end
+
         configure cmds
       end
 
@@ -633,6 +685,35 @@ module Rbeapi
       def set_flowcontrol_receive(name, opts = {})
         set_flowcontrol(name, 'receive', opts)
       end
+
+      ##
+      # set_lacp_priority configures the lacp port-priority on the interface.
+      # Setting the enable keyword to true enables the lacp port-priority on
+      # the interface and setting enable to false disables the lacp
+      # port-priority on the interface.
+      # If the default keyword is set to true, then the lacp port-priority
+      # value is defaulted using the default keyword. The default keyword takes
+      # precedence over the enable keyword
+      #
+      # @since eos_version 4.13.7M
+      #
+      # @param name [String] The interface name to apply the configuration
+      #   values to. The name must be the full interface identifier.
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] Enables sflow if the value is true or
+      #   disables the lacp port-priority on the interface if false. Default is
+      #   true.
+      #
+      # @option opts default [Boolean] Configures the lacp port-priority value
+      #   on the interface using the default keyword.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_lacp_priority(name, opts = {})
+        commands = command_builder('lacp port-priority', opts)
+        configure_interface(name, commands)
+      end
     end
 
     ##
@@ -654,6 +735,7 @@ module Rbeapi
       #     type: 'portchannel'
       #     description: <string>
       #     shutdown: [true, false]
+      #     load_interval: <string>
       #     members: array[<strings>]
       #     lacp_mode: [active, passive, on]
       #     minimum_links: <string>
@@ -700,7 +782,7 @@ module Rbeapi
         grpid = name.scan(/(?<=Port-Channel)\d+/)[0]
         command = "show port-channel #{grpid} all-ports"
         config = node.enable(command, encoding: 'text')
-        values = config.first[:result]['output'].scan(/\bEthernet[^\s]+/)
+        values = config.first[:result]['output'].scan(/\bEthernet[^\s]+/).sort
         { members: values }
       end
       private :parse_members
@@ -843,6 +925,9 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def set_members(name, members, mode = nil)
+        fail ArgumentError, 'members must be an Array' unless
+        members.is_a?(Array)
+
         current_members = Set.new parse_members(name)[:members]
         members = Set.new members
 
@@ -1021,6 +1106,7 @@ module Rbeapi
       #     type: <string>,
       #     description: <string>,
       #     shutdown: <boolean>,
+      #     load_interval: <string>
       #     source_interface: <string>,
       #     multicast_group: <string>,
       #     udp_port: <fixnum>,
@@ -1079,7 +1165,7 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>]
       def parse_multicast_group(config)
-        mdata = /multicast-group ([^\s]+)$/.match(config)
+        mdata = /^\s*vxlan multicast-group ([^\s]+)$/.match(config)
         { multicast_group: mdata ? mdata[1] : DEFAULT_MCAST_GRP }
       end
       private :parse_multicast_group

data/lib/rbeapi/api/ipinterfaces.rb

@@ -42,6 +42,7 @@ module Rbeapi
     # IP interfaces configured using eAPI.
     class Ipinterfaces < Entity
       DEFAULT_ADDRESS = ''
+      DEFAULT_LOAD_INTERVAL = ''
 
       ##
       # get returns a resource hash that represents the configuration of the IP
@@ -52,6 +53,7 @@ module Rbeapi
       #     address: <string>,
       #     mtu: <string>,
       #     helper_addresses: array<strings>
+      #     load_interval: <string>
       #   }
       #
       # @param name [String] The full interface identifier of the interface to
@@ -70,6 +72,7 @@ module Rbeapi
         response.merge!(parse_address(config))
         response.merge!(parse_mtu(config))
         response.merge!(parse_helper_addresses(config))
+        response.merge!(parse_load_interval(config))
         response
       end
 
@@ -83,11 +86,13 @@ module Rbeapi
       #       address: <string>,
       #       mtu: <string>,
       #       helper_addresses: array<strings>
+      #       load_interval: <string>
       #     },
       #     <name>: {
       #       address: <string>,
       #       mtu: <string>,
       #       helper_addresses: array<strings>
+      #       load_interval: <string>
       #     },
       #     ...
       #   }
@@ -162,6 +167,24 @@ module Rbeapi
       end
       private :parse_helper_addresses
 
+      ##
+      # parse_load_interval scans the provided configuration block and
+      # parse the load-interval value. If the interface load-interval
+      # value is not configured, then this method will return the value of
+      # DEFAULT_LOAD_INTERVAL. The hash returned is intended to be merged into
+      # the interface resource hash.
+      #
+      # @api private
+      #
+      # @param config [String] The configuration block to parse.
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_load_interval(config)
+        mdata = /load-interval (\w+)$/.match(config)
+        { load_interval: mdata.nil? ? DEFAULT_LOAD_INTERVAL : mdata[1] }
+      end
+      private :parse_load_interval
+
       ##
       # create will create a new IP interface on the node. If the ip interface
       # already exists in the configuration, this method will still return
@@ -312,6 +335,10 @@ module Rbeapi
         enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
+        if value
+          fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+        end
+
         case default
         when true
           cmds = 'default ip helper-address'
@@ -321,6 +348,27 @@ module Rbeapi
         end
         configure_interface(name, cmds)
       end
+
+      ##
+      # set_load_interval is a convenience function for configuring the
+      # value of interface load-interval
+      #
+      # @param name [String] The interface name to apply the configuration
+      # values to. The name must be the full interface identifier.
+      #
+      # @param opts [Hash] Optional keyword arguments.
+      #
+      # @option opts value [String] Specifies the value to configure the
+      # load-interval setting for. Valid values are between 5 and 600.
+      #
+      # @option opts default [Boolean] Configures the load-interval value on
+      # the interface using the default keyword.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_load_interval(name, opts = {})
+        cmds = command_builder('load-interval', opts)
+        configure_interface(name, cmds)
+      end
     end
   end
 end