rbeapi 0.2.0 → 0.3.0

data/lib/rbeapi/api/radius.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014, Arista Networks, Inc.
+# Copyright (c) 2014,2015, Arista Networks, Inc.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -46,7 +46,7 @@ module Rbeapi
 
       # Regular expression to extract a radius server's attributes from the
       # running-configuration text.  The explicit [ ] spaces enable line
-      # wrappping and indentation with the /x flag.
+      # wrapping and indentation with the /x flag.
       SERVER_REGEXP = /radius-server[ ]host[ ](.*?)
                        (?:[ ]vrf[ ]([^\s]+))?
                        (?:[ ]auth-port[ ](\d+))?
@@ -62,7 +62,7 @@ module Rbeapi
       # method.
       #
       # The resource hash returned contains the following information:
-      #  * key: (String) the key either in plaintext or hashed format
+      #  * key: (String) the key either in plain text or hashed format
       #  * key_format: (Fixnum) e.g. 0 or 7
       #  * timeout: (Fixnum) seconds before the timeout period ends
       #  * retransmit: (Fixnum), e.g. 3, attempts after first timeout expiry.
@@ -81,7 +81,7 @@ module Rbeapi
       end
 
       ##
-      # parse_time scans the nodes current configuraiton and parse the
+      # parse_time scans the nodes current configuration and parse the
       # radius-server timeout value.  The timeout value is expected to always
       # be present in the config
       #
@@ -96,7 +96,7 @@ module Rbeapi
 
       ##
       # parse_retransmit scans the cnodes current configuration and parses the
-      # radius-server retransmit value.  the retransmist value is expected to
+      # radius-server retransmit value.  the retransmit value is expected to
       # always be present in the config
       #
       # @api private
@@ -134,7 +134,7 @@ module Rbeapi
       # The resource hash returned contains the following information:
       #  * hostname: hostname or ip address
       #  * vrf: (String) vrf name
-      #  * key: (String) the key either in plaintext or hashed format
+      #  * key: (String) the key either in plain text or hashed format
       #  * key_format: (Fixnum) e.g. 0 or 7
       #  * timeout: (Fixnum) seconds before the timeout period ends
       #  * retransmit: (Integer), e.g. 3, attempts after first timeout expiry.
@@ -164,8 +164,8 @@ module Rbeapi
       private :parse_servers
 
       ##
-      # set_global_key configures the global radius-server key.  If the value
-      # option is not specified, radius-server key is configured using the no
+      # set_global_key configures the global radius-server key.  If the enable
+      # option is false, radius-server key is configured using the no
       # keyword. If the default option is specified, radius-server key is
       # configured using the default keyword. If both options are specified,
       # the default keyword option takes precedence.
@@ -181,15 +181,19 @@ module Rbeapi
       #   in the nodes running configuration
       #
       # @option [Fixnum] :key_format The format of the key to be passed to the
-      #   nodes running configuration.  Valid values are 0 (cleartext) or 7
+      #   nodes running configuration.  Valid values are 0 (clear text) or 7
       #   (encrypted).  The default value is 0 if format is not provided.
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option [Boolean] :default Configures the radius-server key using the
       #   default keyword argument
       #
       # @return [Boolean] returns true if the commands complete successfully
       def set_global_key(opts = {})
         value = opts[:value]
+        enable = opts.fetch(:enable, true)
         key_format = opts[:key_format] || 0
         default = opts[:default] || false
 
@@ -197,7 +201,7 @@ module Rbeapi
         when true
           cmds = 'default radius-server key'
         when false
-          if value
+          if enable
             cmds = "radius-server key #{key_format} #{value}"
           else
             cmds = 'no radius-server key'
@@ -208,7 +212,7 @@ module Rbeapi
 
       ##
       # set_global_timeout configures the radius-server timeout value.  If the
-      # value # options is not specified, radius-server timeout is configured
+      # enable option is false, then radius-server timeout is configured
       # using the no keyword.  If the default option is specified, radius-server
       # timeout is configured using the default keyword.  If both options are
       # specified then the default keyword takes precedence.
@@ -224,30 +228,21 @@ module Rbeapi
       #   radius-server timeout value to.  This value should be in the range of
       #   1 to 1000
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option [Boolean] :default Configures the radius-server timeout value
       #   using the default keyword.
       #
       # @return [Boolean] returns true if the commands complete successfully
       def set_global_timeout(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = 'default radius-server timeout'
-        when false
-          if value
-            cmds = "radius-server timeout #{value}"
-          else
-            cmds = 'no radius-server timeout'
-          end
-        end
-        configure cmds
+        cmd = command_builder('radius-server timeout', opts)
+        configure cmd
       end
 
       ##
-      # set_global_retransmit configures the global radius-server restransmit
-      # value. If the value is not specified, the radius-server retransmist
+      # set_global_retransmit configures the global radius-server retransmit
+      # value. If the enable option  is false, then the radius-server retransmit
       # value is configured using the no keyword.  If the default option is
       # specified, the radius-server retransmit value is configured using the
       # default keyword. If both options are specified then the default keyword
@@ -258,31 +253,22 @@ module Rbeapi
       # @commands
       #   radius-server retransmit <value>
       #   no radius-server retransmit
-      #   default radius-server retrasmit
+      #   default radius-server retransmit
       #
-      # @option [String, Fixnum] :value The valu to set the global
+      # @option [String, Fixnum] :value The value to set the global
       #   radius-server retransmit value to.  This value should be in the range
       #   of 1 to 100
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option [Boolean] :default Configures the radius-server retransmit
       #   value using the default keyword
       #
       # @return [Boolean] returns true if the commands complete successfully
       def set_global_retransmit(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = 'default radius-server retransmit'
-        when false
-          if value
-            cmds = "radius-server retransmit #{value}"
-          else
-            cmds = 'no radius-server retransmit'
-          end
-        end
-        configure cmds
+        cmd = command_builder('radius-server retransmit', opts)
+        configure cmd
       end
 
       ##

data/lib/rbeapi/api/snmp.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014, Arista Networks, Inc.
+# Copyright (c) 2014,2015, Arista Networks, Inc.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -39,11 +39,9 @@ module Rbeapi
   module Api
     ##
     # The Snmp class provides a class implementation for working with the
-    # nodes SNMP conifguration entity.  This class presents an abstraction
+    # nodes SNMP configuration entity.  This class presents an abstraction
     # of the node's snmp configuration from the running config.
     #
-    # rubocop:disable Metrics/ClassLength
-    #
     # @eos_version 4.13.7M
     class Snmp < Entity
       DEFAULT_SNMP_LOCATION = ''
@@ -145,7 +143,7 @@ module Rbeapi
       ##
       # parse_communities scans the running config from the node and parses all
       # of the configure snmp community strings.  If there are no configured
-      # snmp community strings, the communitys value is set to an empty array.
+      # snmp community strings, the community value is set to an empty array.
       # The returned hash is intended to be merged into the global snmp
       # resource hash
       #
@@ -164,8 +162,8 @@ module Rbeapi
 
       ##
       # parse_notifications scans the running configuration and parses all of
-      # the snmp trap notificaitons configuration.  It is expected the trap
-      # configuration is in the running config.  The returned hash is intendd
+      # the snmp trap notifications configuration.  It is expected the trap
+      # configuration is in the running config.  The returned hash is intended
       # to be merged into the resource hash
       def parse_notifications
         traps = config.scan(/(default|no)?[ ]?snmp-server enable traps (.+)$/)
@@ -181,7 +179,7 @@ module Rbeapi
       private :parse_notifications
 
       ##
-      # set_notification configures the snmp trap notificaiton for the
+      # set_notification configures the snmp trap notification for the
       # specified trap.  The name option accepts the snmp trap name to
       # configure or the keyword all to globally enable or disable
       # notifications.  If the optional state argument is not provided then the
@@ -210,11 +208,10 @@ module Rbeapi
 
       ##
       # set_location updates the snmp location value in the nodes running
-      # configuration.  If the value is not provided in the opts Hash then
-      # the snmp location value is negated using the no keyword.  If the
-      # default keyword is set to true, then the snmp location value is
-      # defaulted using the default keyword.  The default parameter takes
-      # precedence over the value keyword.
+      # configuration.  If enable is false, then the snmp location value is
+      # negated using the no keyword.  If the default keyword is set to true,
+      # then the snmp location value is defaulted using the default keyword.
+      # The default parameter takes precedence over the enable keyword.
       #
       # @eos_version 4.13.7M
       #
@@ -227,34 +224,25 @@ module Rbeapi
       #
       # @option opts [string] :value The snmp location value to configure
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option opts [Boolean] :default Configure the snmp location value
       #   using the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_location(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = ['default snmp-server location']
-        when false
-          if value.nil?
-            cmds = 'no snmp-server location'
-          else
-            cmds = "snmp-server location #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('snmp-server location', opts)
+        configure(cmd)
       end
 
       ##
       # set_contact updates the snmp contact value in the nodes running
-      # configuration.  If the value is not provided in the opts Hash then
+      # configuration.  If enable is false in the opts Hash then
       # the snmp contact value is negated using the no keyword.  If the
       # default keyword is set to true, then the snmp contact value is
       # defaulted using the default keyword.  The default parameter takes
-      # precedence over the value keyword.
+      # precedence over the enable keyword.
       #
       # @eos_version 4.13.7M
       #
@@ -267,34 +255,25 @@ module Rbeapi
       #
       # @option opts [string] :value The snmp contact value to configure
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option opts [Boolean] :default Configures the snmp contact value
       #   using the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_contact(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = ['default snmp-server contact']
-        when false
-          if value.nil?
-            cmds = 'no snmp-server contact'
-          else
-            cmds = "snmp-server contact #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('snmp-server contact', opts)
+        configure(cmd)
       end
 
       ##
       # set_chassis_id updates the snmp chassis id value in the nodes
-      # running configuration.  If the value is not provided in the opts
+      # running configuration.  If enable is false in the opts
       # Hash then the snmp chassis id value is negated using the no
       # keyword.  If the default keyword is set to true, then the snmp
       # chassis id value is defaulted using the default keyword.  The default
-      # keyword takes precedence over the value keyword.
+      # keyword takes precedence over the enable keyword.
       #
       # @eos_version 4.13.7M
       #
@@ -307,34 +286,25 @@ module Rbeapi
       #
       # @option opts [string] :value The snmp chassis id value to configure
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option opts [Boolean] :default Configures the snmp chassis id value
       #   using the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_chassis_id(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = 'default snmp-server chassis-id'
-        when false
-          if value.nil?
-            cmds = 'no snmp-server chassis-id'
-          else
-            cmds = "snmp-server chassis-id #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('snmp-server chassis-id', opts)
+        configure(cmd)
       end
 
       ##
       # set_source_interface updates the snmp source interface value in the
-      # nodes running configuration.  If the value is not provided in the opts
+      # nodes running configuration.  If enable is false in the opts
       # Hash then the snmp source interface is negated using the no keyword.
-      # If the deafult keyword is set to true, then the snmp source interface
-      # value is defaulted using the default keyword.  The deafult keyword
-      # takes precedence over the value keyword.
+      # If the default keyword is set to true, then the snmp source interface
+      # value is defaulted using the default keyword.  The default keyword
+      # takes precedence over the enable keyword.
       #
       # @eos_version 4.13.7M
       #
@@ -348,25 +318,15 @@ module Rbeapi
       # @option opts [string] :value The snmp source interface value to
       #   configure.  This method will not ensure the interface is present
       #   in the configuration
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default Configures the snmp source interface
       #   value using the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_source_interface(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = ['default snmp-server source-interface']
-        when false
-          if value.nil?
-            cmds = 'no snmp-server source-interface'
-          else
-            cmds = "snmp-server source-interface #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('snmp-server source-interface', opts)
+        configure(cmd)
       end
 
       ##
@@ -407,8 +367,8 @@ module Rbeapi
 
       ##
       # set_community_acl configures the acl to apply to the specified
-      # community name.  If the value option is not specified, the acl is
-      # removed from the community name
+      # community name.  When enable is true, it will remove the
+      # the named community and then add the new acl entry.
       #
       # @eos_version 4.13.7M
       #
@@ -419,16 +379,27 @@ module Rbeapi
       # @param [String] :name The name of the snmp community to add to the
       #   nodes running configuration.
       #
-      # @option [String] :value The name of the acl to apply to the snmp
-      #   community in the nodes config
+      # @param [Hash] opts The configuration parameters
+      #
+      # @option opts [String] :value The name of the acl to apply to the snmp
+      #   community in the nodes config. If nil, then the community name
+      #   allows access to all objects.
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      # @option opts [Boolean] :default Configure the snmp community name
+      #   using the default keyword. Default takes precedence over enable.
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_community_acl(name, opts = {})
         value = opts[:value]
+        enable = opts.fetch(:enable, true)
+        default = opts.fetch(:default, false)
+        # Default is same as negate for this command
+        enable = default ? false : enable
         communities = parse_communities[:communities]
         access = communities[name][:access] if communities.include?(name)
-        cmds = ["no snmp-server community #{name}",
-                "snmp-server community #{name} #{access} #{value}"]
+        cmds = ["no snmp-server community #{name}"]
+        cmds << "snmp-server community #{name} #{access} #{value}" if enable
         configure cmds
       end
 

data/lib/rbeapi/api/staticroutes.rb

@@ -38,51 +38,98 @@ module Rbeapi
   # Rbeapi::Api
   module Api
     ##
-    # The Staticroute class provides a configuration instance for working
+    # The Staticroutes class provides a configuration instance for working
     # with static routes in EOS.
     #
-    class Staticroute < Entity
+    class Staticroutes < Entity
       ##
       # Returns the static routes configured on the node
       #
       # @example
       #   {
-      #     <route>: {
-      #       "next_hop": <string>,
-      #       "name": <string, nil>
-      #     }
+      #     [
+      #       {
+      #         destination: <route_dest/masklen>,
+      #         nexthop: next_hop>,
+      #         distance: <integer>,
+      #         tag: <integer, nil>,
+      #         name: <string, nil>
+      #       },
+      #       ...
+      #     ]
       #   }
       #
-      # @returns [Hash<String, String> The method will return all of the
-      #   configured static routes on the node as a Ruby hash object.  If
+      # @returns [Array<Hash, Hash>] The method will return all of the
+      #   configured static routes on the node as a Ruby array object
+      #   containing a list of hashes with each hash describing a route.  If
       #   there are no static routes configured, this method will return
-      #   an empty hash
+      #   an empty array.
       def getall
         regex = /
           (?<=^ip\sroute\s)
-          ([^\s]+)\s                # captures network
-          ([^\s$]+)                 # captures next hop
-          (?:\s\d+)                 # non-capture metric
-          (?:\stag\s\d+)            # non-catpure route tag
+          ([^\s]+)\s                # capture destination
+          ([^\s$]+)                 # capture next hop IP or egress interface
+          [\s|$](\d+)               # capture metric (distance)
+          [\s|$]{1}(?:tag\s(\d+))?  # catpure route tag
           [\s|$]{1}(?:name\s(.+))?  # capture route name
         /x
 
         routes = config.scan(regex)
 
-        routes.each_with_object({}) do |route, hsh|
-          hsh[route[0]] = { 'next_hop' => route[1],
-                            'name' => route[2] }
+        routes.each_with_object([]) do |route, arry|
+          arry << { destination: route[0],
+                    nexthop: route[1],
+                    distance: route[2],
+                    tag: route[3],
+                    name: route[4] }
         end
       end
 
-      def create(route, nexthop, opts = {})
-        cmd = "ip route #{route} #{nexthop}"
-        opts.each { |param, value| cmds << "#{param} #{value}" }
+      ##
+      # Creates a static route in EOS. May add or overwrite an existing route.
+      #
+      # @commands
+      #   ip route <destination> <nexthop> [router_ip] [distance] [tag <tag>]
+      #     [name <name>]
+      #
+      # @param [String] :destination The destination and prefix matching the
+      #   route(s). Ex '192.168.0.2/24'.
+      # @param [String] :nexthop The nexthop for this entry, which may an IP
+      #   address or interface name.
+      # @param [Hash] :opts Additional options for the route entry.
+      # @option :opts [String] :router_ip If nexthop is an egress interface,
+      #   router_ip specifies the router to which traffic will be forwarded
+      # @option :opts [String] :distance The administrative distance (metric)
+      # @option :opts [String] :tag The route tag
+      # @option :opts [String] :name A route name
+      #
+      # @return [Boolean] returns true on success
+      def create(destination, nexthop, opts = {})
+        cmd = "ip route #{destination} #{nexthop}"
+        cmd << " #{opts[:router_ip]}" if opts[:router_ip]
+        cmd << " #{opts[:distance]}" if opts[:distance]
+        cmd << " tag #{opts[:tag]}" if opts[:tag]
+        cmd << " name #{opts[:name]}" if opts[:name]
         configure cmd
       end
 
-      def delete(route)
-        configure "no ip route #{route}"
+      ##
+      # Removes a given route from EOS.  May remove multiple routes if nexthop
+      # is not specified.
+      #
+      # @commands
+      #   no ip route <destination> [nexthop]
+      #
+      # @param [String] :destination The destination and prefix matching the
+      #   route(s). Ex '192.168.0.2/24'.
+      # @param [String] :nexthop The nexthop for this entry, which may an IP
+      #   address or interface name.
+      #
+      # @return [Boolean] returns true on success
+      def delete(destination, nexthop = nil)
+        cmd = "no ip route #{destination}"
+        cmd << " #{nexthop}" if nexthop
+        configure cmd
       end
     end
   end