rbeapi 1.0 → 1.1

data/lib/rbeapi/api/ipinterfaces.rb

@@ -41,8 +41,8 @@ module Rbeapi
     # The Ipinterface class provides an instance for managing logical
     # IP interfaces configured using eAPI.
     class Ipinterfaces < Entity
-      DEFAULT_ADDRESS = ''
-      DEFAULT_LOAD_INTERVAL = ''
+      DEFAULT_ADDRESS = ''.freeze
+      DEFAULT_LOAD_INTERVAL = ''.freeze
 
       ##
       # get returns a resource hash that represents the configuration of the IP
@@ -336,7 +336,9 @@ module Rbeapi
         default = opts[:default] || false
 
         if value
-          fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+          unless value.is_a?(Array)
+            raise ArgumentError, 'value must be an Array'
+          end
         end
 
         case default

data/lib/rbeapi/api/managementdefaults.rb

@@ -0,0 +1,119 @@
+#
+# Copyright (c) 2014,2015, Arista Networks, Inc.
+# 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 ARISTA NETWORKS
+# 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.
+#
+require 'rbeapi/api'
+
+##
+# Rbeapi toplevel namespace.
+module Rbeapi
+  ##
+  # Api is module namespace for working with the EOS command API.
+  module Api
+    ##
+    # The Managementdefaults class provides a configuration instance for
+    # configuring management defaults of the node.
+    class Managementdefaults < Entity
+      DEFAULT_SECRET_HASH = 'md5'.freeze
+
+      ##
+      # get scans the current nodes configuration and returns the values as
+      # a Hash describing the current state.
+      #
+      # @example
+      #   {
+      #     secret_hash: <string>
+      #   }
+      #
+      # @return [nil, Hash<Symbol, Object] returns the nodes current running
+      #   configuration as a Hash. If management defaults are not configured
+      #   on the node this method will return nil.
+      def get
+        config = get_block('management defaults')
+
+        settings = {}
+        settings.merge!(parse_secret_hash(config))
+      end
+
+      ##
+      # parse_secret_hash scans the current nodes running configuration and
+      # extracts the value of secret hash from the management defaults.
+      # If the parse_secret has not been configured, then this method will
+      # return DEFAULT_SECRET_HASH. The return
+      # value is intended to be merged into the resource hash.
+      #
+      # @api private
+      #
+      # @param config [String] The management defaults configuration block
+      #   retrieved from the nodes current running configuration.
+      #
+      # @return [Hash<Symbol, Object>] Returns the resource hash attribute.
+      def parse_secret_hash(config)
+        mdata = /(?<=\s{3}secret hash\s)(md5|sha512)$/.match(config)
+        { secret_hash: mdata.nil? ? DEFAULT_SECRET_HASH : mdata[1] }
+      end
+      private :parse_secret_hash
+
+      ##
+      # set_secret_hash configures the management defaults secret hash value
+      # in the current nodes running configuration.
+      # If the default keyword is provided, the configuration is defaulted
+      # using the default keyword.
+      #
+      # @since eos_version 4.13.7M
+      #
+      # ===Commands
+      #   management defaults
+      #     secret hash <value>
+      #     no secret hash
+      #     default secret hash
+      #
+      # @param opts [Hash] Optional keyword arguments
+      #
+      # @option opts value [String] The value to configure the secret hash to.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the secret hash value using
+      #   the default keyword.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_secret_hash(opts = {})
+        unless ['md5', 'sha512', nil].include?(opts[:value])
+          raise ArgumentError, 'secret hash must be md5 or sha512'
+        end
+        cmd = command_builder("secret hash #{opts[:value]}")
+        cmds = ['management defaults', cmd]
+        configure(cmds)
+      end
+    end
+  end
+end

data/lib/rbeapi/api/mlag.rb

@@ -41,10 +41,10 @@ module Rbeapi
     # The Mlag class provides a configuration instance for working with
     # the global MLAG configuration of the node.
     class Mlag < Entity
-      DEFAULT_DOMAIN_ID = ''
-      DEFAULT_LOCAL_INTF = ''
-      DEFAULT_PEER_ADDR = ''
-      DEFAULT_PEER_LINK = ''
+      DEFAULT_DOMAIN_ID = ''.freeze
+      DEFAULT_LOCAL_INTF = ''.freeze
+      DEFAULT_PEER_ADDR = ''.freeze
+      DEFAULT_PEER_LINK = ''.freeze
 
       ##
       # get scans the current nodes configuration and returns the values as
@@ -367,10 +367,10 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def set_shutdown(opts = {})
-        fail 'set_shutdown has the value option set' if opts[:value]
+        raise 'set_shutdown has the value option set' if opts[:value]
         # Shutdown semantics are opposite of enable semantics so invert enable
         value = !opts[:enable]
-        opts.merge!(enable: value)
+        opts[:enable] = value
         cmd = command_builder('shutdown', opts)
         cmds = ['mlag configuration', cmd]
         configure(cmds)

data/lib/rbeapi/api/ntp.rb

@@ -41,7 +41,7 @@ module Rbeapi
     # The Ntp class provides an instance for working with the nodes
     # NTP configuration.
     class Ntp < Entity
-      DEFAULT_SRC_INTF = ''
+      DEFAULT_SRC_INTF = ''.freeze
 
       ##
       # get returns the nodes current ntp configure as a resource hash.

data/lib/rbeapi/api/ospf.rb

@@ -48,11 +48,18 @@ module Rbeapi
       #
       # @example
       #   {
-      #     router_id: <string>
+      #     router_id: <string>,
+      #     max_lsa: <integer>,
+      #     maximum_paths: <integer>,
+      #     passive_interface_default <boolean>,
+      #     passive_interfaces: array<string>,
+      #     active_interfaces: array<string>,
       #     areas: {
       #       <string>: array<string>
       #     },
-      #     redistribute: {}
+      #     redistribute: {
+      #       <string>: {route_map: <string>}
+      #     }
       #   }
       #
       # @param inst [String] The ospf instance name.
@@ -65,7 +72,23 @@ module Rbeapi
 
         response = {}
         mdata = /(?<=^\s{3}router-id\s)(.+)$/.match(config)
-        response['router_id'] = mdata.nil? ? '' : mdata[0]
+        response[:router_id] = mdata.nil? ? '' : mdata[0]
+
+        mdata = /(?<=^\s{3}max-lsa\s)(\d+)(?=.*$)/.match(config)
+        response[:max_lsa] = mdata.nil? ? '' : mdata[0].to_i
+
+        mdata = /(?<=^\s{3}maximum-paths\s)(\d+)$/.match(config)
+        response[:maximum_paths] = mdata.nil? ? '' : mdata[0].to_i
+
+        mdata = /^\s{3}passive-interface default$/ =~ config
+        response[:passive_interface_default] = !mdata.nil?
+
+        response[:passive_interfaces] =
+          config.scan(/(?<=^\s{3}passive-interface\s)(?!default)(.*)$/)
+                .flatten!.to_a
+
+        response[:active_interfaces] =
+          config.scan(/(?<=^\s{3}no passive-interface\s)(.*)$/).flatten!.to_a
 
         networks = config.scan(/^\s{3}network\s(.+)\sarea\s(.+)$/)
         areas = networks.each_with_object({}) do |cfg, hsh|
@@ -76,13 +99,13 @@ module Rbeapi
             hsh[area] = [net]
           end
         end
-        response['areas'] = areas
+        response[:areas] = areas
 
         values = \
           config.scan(/(?<=^\s{3}redistribute\s)(\w+)[\s|$]*(route-map\s(.+))?/)
 
-        response['redistribute'] = values.each_with_object({}) do |value, hsh|
-          hsh[value[0]] = { 'route_map' => value[2] }
+        response[:redistribute] = values.each_with_object({}) do |value, hsh|
+          hsh[value[0]] = { route_map: value[2] }
         end
         response
       end
@@ -94,6 +117,11 @@ module Rbeapi
       #   {
       #     <pid>: {
       #       router_id: <string>,
+      #       max_lsa: <integer>,
+      #       maximum_paths: <integer>,
+      #       passive_interface_default <boolean>,
+      #       passive_interfaces: array<string>,
+      #       active_interfaces: array<string>,
       #       areas: {},
       #       redistribute: {}
       #     },
@@ -107,7 +135,7 @@ module Rbeapi
         response = instances.each_with_object({}) do |inst, hsh|
           hsh[inst] = get inst
         end
-        response['interfaces'] = interfaces.getall
+        response[:interfaces] = interfaces.getall
         response
       end
 
@@ -156,6 +184,133 @@ module Rbeapi
         configure cmds
       end
 
+      ##
+      # set_max_lsa sets router ospf max-lsa with pid and options.
+      #
+      # @param pid [String] The router ospf name.
+      #
+      # @param opts [hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the max-lsa to default.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_max_lsa(pid, opts = {})
+        cmd = command_builder('max-lsa', opts)
+        cmds = ["router ospf #{pid}", cmd]
+        configure cmds
+      end
+
+      ##
+      # set_maximum_paths sets router ospf maximum-paths with pid and options.
+      #
+      # @param pid [String] The router ospf name.
+      #
+      # @param opts [hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the maximum-paths to default.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_maximum_paths(pid, opts = {})
+        cmd = command_builder('maximum-paths', opts)
+        cmds = ["router ospf #{pid}", cmd]
+        configure cmds
+      end
+
+      ##
+      # set_passive_interface_default sets router ospf passive-interface
+      # default with pid and options. If the passive-interface default keyword
+      # is false, then the
+      # passive-interface default is disabled. If the enable keyword is true,
+      # then the passive-interface default is enabled. If the default keyword
+      # is set to true, then the passive-interface default is configured using
+      # the default keyword. The default keyword takes precedence ver the
+      # enable keyword if both are provided.
+      #
+      # @param pid [String] The router ospf name.
+      #
+      # @param opts [hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the passive-interface default
+      # to default.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_passive_interface_default(pid, opts = {})
+        opts[:enable] = opts[:value] | false
+        opts[:value] = nil
+        cmd = command_builder('passive-interface default', opts)
+        cmds = ["router ospf #{pid}", cmd]
+        configure cmds
+      end
+
+      ##
+      # set_active_interfaces sets router ospf no passive interface with pid
+      # and options, when passive interfaces default is configured.
+      #
+      # @param pid [String] The router ospf name.
+      #
+      # @param opts [hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the active interface to
+      # default.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_active_interfaces(pid, opts = {})
+        values = opts[:value]
+        current = get(pid)[:active_interfaces]
+        cmds = ["router ospf #{pid}"]
+        current.each do |name|
+          unless Array(values).include?(name)
+            cmds << "passive-interface #{name}"
+          end
+        end
+        Array(values).each do |name|
+          cmds << "no passive-interface #{name}"
+        end
+        configure cmds
+      end
+
+      ##
+      # set_passive_interfaces sets router ospf passive interface with pid
+      # and options.
+      #
+      # @param pid [String] The router ospf name.
+      #
+      # @param opts [hash] Optional keyword arguments.
+      #
+      # @option opts enable [Boolean] If false then the command is
+      #   negated. Default is true.
+      #
+      # @option opts default [Boolean] Configure the passive interface to
+      # default.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
+      def set_passive_interfaces(pid, opts = {})
+        values = opts[:value]
+        current = get(pid)[:passive_interfaces]
+        cmds = ["router ospf #{pid}"]
+        current.each do |name|
+          unless Array(values).include?(name)
+            cmds << "no passive-interface #{name}"
+          end
+        end
+        Array(values).each do |name|
+          cmds << "passive-interface #{name}"
+        end
+        configure cmds
+      end
+
       ##
       # add_network adds network settings for router ospf and network area.
       #
@@ -203,9 +358,11 @@ module Rbeapi
       #
       # @return [Boolean] Returns true if the command completed successfully.
       def set_redistribute(pid, proto, opts = {})
-        routemap = opts[:routemap]
-        cmds = ["router ospf #{pid}", "redistribute #{proto}"]
-        cmds[1] << " route-map #{routemap}" if routemap
+        routemap = opts[:route_map]
+        redistribute = "redistribute #{proto}"
+        redistribute << " route-map #{routemap}" if routemap
+        cmd = command_builder(redistribute, opts)
+        cmds = ["router ospf #{pid}", cmd]
         configure cmds
       end
     end
@@ -231,11 +388,13 @@ module Rbeapi
       def get(name)
         config = get_block("interface #{name}")
         return nil unless config
-        return nil unless /no switchport$/ =~ config
+        unless /no switchport$/ =~ config || /^interface (Lo|Vl)/ =~ config
+          return nil
+        end
 
         response = {}
         nettype = /ip ospf network point-to-point/ =~ config
-        response['network_type'] = nettype.nil? ? 'broadcast' : 'point-to-point'
+        response[:network_type] = nettype.nil? ? 'broadcast' : 'point-to-point'
         response
       end
 

data/lib/rbeapi/api/prefixlists.rb

@@ -67,12 +67,22 @@ module Rbeapi
       #   array of hashes, where each prefix is a hash object.
       #   If the prefix list is not found, a nil object is returned.
       def get(name)
-        config = get_block("ip prefix-list #{name}")
-        return nil unless config
+        return nil unless config =~ /ip prefix-list #{name}/
+
+        # single-line prefix list
+        if config =~ /ip prefix-list #{name}\sseq/
+          entries = config.scan(/^(?:ip\sprefix-list\s#{name}\sseq\s)(\d+)\s
+                                (permit|deny)\s(.+)$/x)
+        # or multi-line
+        else
+          prefix_list = get_block("ip prefix-list #{name}")
+          entries = prefix_list.scan(/^\s+(?:seq\s)(\d+)\s
+                                     (permit|deny)\s(.+)$/x)
+        end
 
-        entries = config.scan(/^\s{3}(?:seq\s)(\d+)\s(permit|deny)\s(.+)$/)
         entries.each_with_object([]) do |entry, arry|
-          arry << { 'seq' => entry[0], 'action' => entry[1],
+          arry << { 'seq' => entry[0],
+                    'action' => entry[1],
                     'prefix' => entry[2] }
         end
       end
@@ -116,15 +126,15 @@ module Rbeapi
       #   If there are no prefix lists configured, an empty hash will
       #   be returned.
       def getall
-        lists = config.scan(/(?<=^ip\sprefix-list\s).+/)
-        lists.each_with_object({}) do |name, hsh|
+        lists = config.scan(/(?<=^ip\sprefix-list\s)[^\s]+(?=\sseq.+)?/)
+        lists.uniq.each_with_object({}) do |name, hsh|
           values = get name
           hsh[name] = values if values
         end
       end
 
       ##
-      # create will create a new ip prefix-list with designated name.
+      # Creates a new ip prefix-list with the designated name.
       #
       # @param name [String] The name of the ip prefix-list.
       #
@@ -134,7 +144,7 @@ module Rbeapi
       end
 
       ##
-      # add_rule will create an ip prefix-list with the designated name,
+      # Creates an ip prefix-list with the designated name,
       #   seqno, action and prefix.
       #
       # @param name [String] The name of the ip prefix-list.
@@ -154,7 +164,7 @@ module Rbeapi
       end
 
       ##
-      # delete will remove the designated prefix-list.
+      # Removes the designated prefix-list.
       #
       # @param name [String] The name of the ip prefix-list.
       #