rbeapi 0.2.0 → 0.3.0

data/lib/rbeapi/api/stp.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
@@ -67,7 +67,7 @@ module Rbeapi
       ##
       # parse_mode scans the nodes running configuration and extracts the
       # value of the spanning-tree mode.  The spanning tree mode is
-      # expected to be always be avaliable in the running config.  The return
+      # expected to be always be available in the running config.  The return
       # value is intended to be merged into the stp resource hash
       #
       # @api private
@@ -90,7 +90,7 @@ module Rbeapi
       end
 
       ##
-      # interfaces rereturns a memoized instance of StpInterfaces for
+      # interfaces returns a memoized instance of StpInterfaces for
       # configuring individual stp interfaces
       #
       # @return [StpInterfaces] an instance of StpInterfaces class
@@ -102,10 +102,10 @@ module Rbeapi
 
       ##
       # set_mode configures the stp mode in the global nodes running
-      # configuration.  If the value option is not specified, then the stp
+      # configuration.  If the enable option is false, then the stp
       # mode is configured with the no keyword argument.  If the default option
       # is specified then the mode is configured with the default keyword
-      # argument.  The default keyword argument takes precedence over the value
+      # argument.  The default keyword argument takes precedence over the enable
       # option if both are provided
       #
       # @eos_version 4.13.7M
@@ -120,25 +120,16 @@ module Rbeapi
       # @option :opts [String] :value The value to configure the stp mode to
       #   in the nodes current running configuration
       #
-      # @option :opts [Boolean] :deafult Configure the stp mode value using
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
+      # @option :opts [Boolean] :default Configure the stp mode value using
       #   the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       #
       def set_mode(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmd = 'default spanning-tree mode'
-        when false
-          if value
-            cmd = "spanning-tree mode #{value}"
-          else
-            cmd = 'no spanning-tree mode'
-          end
-        end
+        cmd = command_builder('spanning-tree mode', opts)
         configure cmd
       end
     end
@@ -151,7 +142,7 @@ module Rbeapi
       DEFAULT_STP_PRIORITY = '32768'
 
       ##
-      # get returns the specified stp intstance config parsed from the nodes
+      # get returns the specified stp instance config parsed from the nodes
       # current running configuration.
       #
       # @example
@@ -207,7 +198,7 @@ module Rbeapi
       ##
       # parse_priority will scan the nodes current configuration and extract
       # the stp priority value for the given stp instance.  If the stp
-      # instance prioirity is not configured, the priority value will be set
+      # instance priority is not configured, the priority value will be set
       # using DEFAULT_STP_PRIORITY.  The returned hash is intended to be merged
       # into the resource hash
       #
@@ -238,18 +229,21 @@ module Rbeapi
       # @param [String] inst The MST instance to configure
       # @param [Hash] opts The configuration parameters for the priority
       # @option opts [string] :value The value to set the priority to
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_priority(inst, opts = {})
         value = opts[:value]
+        enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
         case default
         when true
           cmd = "default spanning-tree mst #{inst} priority"
         when false
-          if value
+          if enable
             cmd = "spanning-tree mst #{inst} priority #{value}"
           else
             cmd = "no spanning-tree mst #{inst} priority"
@@ -261,7 +255,7 @@ module Rbeapi
 
     ##
     # The StpInterfaces class provides a class instance for working with
-    # spanning-tree insterfaces in EOS
+    # spanning-tree interfaces in EOS
     #
     class StpInterfaces < Entity
       ##
@@ -365,25 +359,14 @@ module Rbeapi
       # @param [String] name The name of the interface to configure
       # @param [Hash] opts The configuration parameters for portfast
       # @option opts [Boolean] :value The value to set portfast
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_portfast(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default spanning-tree portfast'
-        when false
-          if value
-            cmds << 'spanning-tree portfast'
-          else
-            cmds << 'no spanning-tree portfast'
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('spanning-tree portfast', opts)
+        configure_interface(name, cmd)
       end
 
       ##
@@ -392,21 +375,29 @@ module Rbeapi
       # @param [String] name The name of the interface to configure
       # @param [Hash] opts The configuration parameters for portfast type
       # @option opts [String] :value The value to set portfast type to.
+      #   The value must be set for calls to this method.
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_portfast_type(name, opts = {})
         value = opts[:value]
+        fail ArgumentError, 'value must be set' unless value
+        enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
-        cmds = ["interface #{name}"]
         case default
         when true
-          cmds << 'default spanning-tree portfast normal'
+          cmds = "default spanning-tree portfast #{value}"
         when false
-          cmds << "spanning-tree portfast #{value}"
+          if enable
+            cmds = "spanning-tree portfast #{value}"
+          else
+            cmds = "no spanning-tree portfast #{value}"
+          end
         end
-        configure(cmds)
+        configure_interface(name, cmds)
       end
 
       ##
@@ -415,25 +406,26 @@ module Rbeapi
       # @param [String] name The name of the interface to configure
       # @param [Hash] opts The configuration parameters for bpduguard
       # @option opts [Boolean] :value The value to set bpduguard
+      # @option opts [Boolean] :enable If false then the bpduguard is
+      #   disabled. If true then the bpduguard is enabled. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_bpduguard(name, opts = {})
-        value = opts[:value]
+        enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
-        cmds = ["interface #{name}"]
         case default
         when true
-          cmds << 'default spanning-tree bpduguard'
+          cmds = 'default spanning-tree bpduguard'
         when false
-          if value
-            cmds << 'spanning-tree bpduguard enable'
+          if enable
+            cmds = 'spanning-tree bpduguard enable'
           else
-            cmds << 'spanning-tree bpduguard disable'
+            cmds = 'spanning-tree bpduguard disable'
           end
         end
-        configure(cmds)
+        configure_interface(name, cmds)
       end
     end
   end

data/lib/rbeapi/api/switchports.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
@@ -43,7 +43,7 @@ module Rbeapi
     #
     class Switchports < Entity
       ##
-      # Retrieves the properies for a logical switchport from the
+      # Retrieves the properties for a logical switchport from the
       # running-config using eAPI
       #
       # Example
@@ -145,40 +145,28 @@ module Rbeapi
       end
 
       ##
-      # Configures the switchport mode for the specified interafce.  Valid
-      # modes are access (default) or trunk
+      # Configures the switchport mode for the specified interface.
       #
       # @param [String] name The name of the interface to configure
       # @param [Hash] opts The configuration parameters for the interface
       # @option opts [string] :value The value to set the mode to
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_mode(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default switchport mode'
-        when false
-          if value.nil?
-            cmds << 'no switchport mode'
-          else
-            cmds << "switchport mode #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('switchport mode', opts)
+        configure_interface(name, cmd)
       end
 
       ##
       # set_trunk_allowed_vlans configures the list of vlan ids that are
-      # allowed on the specified trunk port.  If the value option is not
-      # provided, then the allowed trunks is configured using the no keyword.
-      # If the default keyword is provied then the allowed trunks is configured
-      # using the default keywork  The default optio takes precedence over the
-      # value option if both are specified
+      # allowed on the specified trunk port.  If the enable option is set to
+      # false, then the allowed trunks is configured using the no keyword.
+      # If the default keyword is provided then the allowed trunks is configured
+      # using the default keyword  The default option takes precedence over the
+      # enable option if both are specified
       #
       # @eos_version 4.13.7M
       #
@@ -187,35 +175,40 @@ module Rbeapi
       #   no switchport trunk allowed vlan
       #   default switchport trunk allowed vlan
       #
-      # @option [Array] :value The list of vlan ids to configure on the
+      # @param [String] name The name of the interface to configure
+      # @param [Hash] opts The configuration parameters for the interface
+      # @option pts [Array] :value The list of vlan ids to configure on the
       #   switchport to be allowed.  This value must be an array of valid vlan
       #   ids
-      #
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option [Boolean] :default Configures the switchport trunk allowed
-      #     vlans command using the default keyword
+      #     vlans command using the default keyword. Default takes precedence
+      #     over enable.
       #
       # @return [Boolean] returns true if the commands complete successfully
       def set_trunk_allowed_vlans(name, opts = {})
         value = opts[:value]
+        enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
-        fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
-
-        value = value.map(&:inspect).join(',') if value
+        if value
+          fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
+          value = value.map(&:inspect).join(',')
+        end
 
-        cmds = ["interface #{name}"]
         case default
         when true
-          cmds << 'default switchport trunk allowed vlan'
+          cmds = 'default switchport trunk allowed vlan'
         when false
-          if value.nil?
-            cmds << 'no switchport trunk allowed vlan'
+          if !enable
+            cmds = 'no switchport trunk allowed vlan'
           else
-            cmds << 'switchport trunk allowed vlan none'
-            cmds << "switchport trunk allowed vlan #{value}"
+            cmds = ['switchport trunk allowed vlan none',
+                    "switchport trunk allowed vlan #{value}"]
           end
         end
-        configure(cmds)
+        configure_interface(name, cmds)
       end
 
       ##
@@ -226,25 +219,15 @@ module Rbeapi
       # @param [String] name The name of the interface to configure
       # @param [Hash] opts The configuration parameters for the interface
       # @option opts [string] :value The value of the trunk native vlan
-      # @option opts [Boolean] :default The value should be set to default
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      # @option opts [Boolean] :default The value should be set to default.
+      #   Default takes precedence over enable.
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_trunk_native_vlan(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default switchport trunk native vlan'
-        when false
-          if value.nil?
-            cmds << 'no switchport trunk native vlan'
-          else
-            cmds << "switchport trunk native vlan #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('switchport trunk native vlan', opts)
+        configure_interface(name, cmd)
       end
 
       ##
@@ -255,25 +238,15 @@ module Rbeapi
       # @param [String] name The name of the interface to configure
       # @param [Hash] opts The configuration parameters for the interface
       # @option opts [string] :value The value of the access vlan
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
+      #   Default takes precedence over enable.
       #
       # @return [Boolean] True if the commands succeed otherwise False
       def set_access_vlan(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default switchport access vlan'
-        when false
-          if value.nil?
-            cmds << 'no switchport access vlan'
-          else
-            cmds << "switchport access vlan #{value}"
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('switchport access vlan', opts)
+        configure_interface(name, cmd)
       end
     end
   end

data/lib/rbeapi/api/system.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
@@ -49,7 +49,7 @@ module Rbeapi
       #     hostname: <string>
       #   }
       #
-      # @return [Hash]  A Ruby hash objec that provides the system settings as
+      # @return [Hash]  A Ruby hash object that provides the system settings as
       #   key/value pairs.
       def get
         response = {}
@@ -67,20 +67,14 @@ module Rbeapi
       #
       # @param [Hash] opts The configuration parameters
       # @option opts [string] :value The value to set the hostname to
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_hostname(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = ['default hostname']
-        when false
-          cmds = (value.nil? ? 'no hostname' : "hostname #{value}")
-        end
-        configure(cmds)
+        cmd = command_builder('hostname', opts)
+        configure(cmd)
       end
     end
   end

data/lib/rbeapi/api/tacacs.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 tacacs 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 = /tacacs-server[ ]host[ ]([^\s]+)
                        (?:[ ](single-connection))?
                        (?:[ ]vrf[ ]([^\s]+))?
@@ -67,7 +67,7 @@ module Rbeapi
       #  * name: ('settings')
       #  * enable: (true | false) if tacacs functionality is enabled.  This is
       #    always true for EOS.
-      #  * key: (String) the key either in plaintext or hashed format
+      #  * key: (String) the key either in plain text or hashed format
       #  * key_format: (Integer) e.g. 0 or 7
       #  * timeout: (Integer) seconds before the timeout period ends
       #
@@ -130,7 +130,7 @@ module Rbeapi
       #
       #  * hostname: hostname or ip address, part of the identifier
       #  * port: (Fixnum) TCP port of the server, part of the identifier
-      #  * 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
       #  * multiplex: (Boolean) true when configured to make requests through a
@@ -161,7 +161,7 @@ module Rbeapi
       #
       # @option opts [String] :key ('070E234F1F5B4A') The key value
       #
-      # @option opts [Fixnum] :key_format (7) The key format, 0 for plaintext
+      # @option opts [Fixnum] :key_format (7) The key format, 0 for plain text
       #   and 7 for a hashed value.  7 will be assumed if this option is not
       #   provided.
       #
@@ -180,27 +180,18 @@ module Rbeapi
       # set_timeout configures the tacacs default timeout.  This method maps to
       # the `tacacs-server timeout` setting.
       #
-      # @option opts [Fixnum] :timeout (50) The timeout in seconds to
-      #   configure.
+      # @param [Hash] opts The configuration parameters
+      # @option opts [string] :value The value to set the timeout to
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      # @option opts [Boolean] :default The value should be set to default
       #
       # @api public
       #
       # @return [Boolean] true if no errors
       def set_global_timeout(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = 'default tacacs-server timeout'
-        when false
-          if value
-            cmds = "tacacs-server timeout #{value}"
-          else
-            cmds = 'no tacacs-server timeout'
-          end
-        end
-        configure cmds
+        cmd = command_builder('tacacs-server timeout', opts)
+        configure cmd
       end
 
       ##

data/lib/rbeapi/api/varp.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
@@ -75,24 +75,14 @@ module Rbeapi
       #
       # @param [Hash] opts The configuration parameters
       # @option opts [string] :value The value to set the mac-address to
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_mac_address(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmds = ['default ip virtual-router mac-address']
-        when false
-          if value
-            cmds = "ip virtual-router mac-address #{value}"
-          else
-            cmds = 'no ip virtual-router mac-address'
-          end
-        end
-        configure(cmds)
+        cmd = command_builder('ip virtual-router mac-address', opts)
+        configure(cmd)
       end
     end
 
@@ -113,7 +103,7 @@ module Rbeapi
       #   values for.  This must be the full interface identifier.
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
-      #   VARP interface confguration.  A nil object is returned if the
+      #   VARP interface configuration.  A nil object is returned if the
       #   specified interface is not configured
       def get(name)
         config = get_block("^interface #{name}")
@@ -133,7 +123,7 @@ module Rbeapi
       #   }
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
-      #   MLAG interface confguration.  A nil object is returned if no
+      #   MLAG interface configuration.  A nil object is returned if no
       #   interfaces are configured.
       def getall
         interfaces = config.scan(/(?<=^interface\s)(Vl.+)$/)
@@ -144,30 +134,39 @@ module Rbeapi
       end
 
       ##
-      # Creates a new MLAG interface with the specified mlag id
+      # The set_addresses method assigns one or more virtual IPv4 address
+      # to the specified VLAN interface. All existing addresses are
+      # removed before the ones in value are added.
       #
-      # @param [String] :name The name of the interface to create.  The
+      # @param [String] :name The name of the interface.  The
       #   name argument must be the full interface name.  Valid interfaces
-      #   are restricted to Port-Channel interfaces
-      # @param [String] :id The MLAG ID to confgure for the specified
-      #   interface name
+      #   are restricted to VLAN interfaces
+      # @param [Hash] opts The configuration parameters
+      # @option opts [Array] :value Array of IPv4 addresses to add to
+      #   the virtual router.
+      # @option opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      # @option opts [Boolean] :default The value should be set to default
       #
       # @return [Boolean] True if the commands succeeds otherwise False
       def set_addresses(name, opts = {})
         value = opts[:value]
+        enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
         case default
         when true
-          return configure('default ip virtual-router address')
+          configure(["interface #{name}", 'default ip virtual-router address'])
         when false
           get(name)['addresses'].each do |addr|
             result = remove_address(name, addr)
             return result unless result
           end
-          value.each do |addr|
-            result = add_address(name, addr)
-            return result unless result
+          if enable
+            value.each do |addr|
+              result = add_address(name, addr)
+              return result unless result
+            end
           end
         end
         true