rbeapi 0.2.0 → 0.3.0

data/lib/rbeapi/api/ipinterfaces.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
@@ -132,7 +132,7 @@ module Rbeapi
       private :parse_mtu
 
       ##
-      # parse_helper_addresses scans the provided configuraiton block and
+      # parse_helper_addresses scans the provided configuration block and
       # extracts any configured IP helper address values.  The interface could
       # be configured with one or more helper addresses.  If no helper
       # addresses are configured, then an empty array is set in the return
@@ -194,12 +194,13 @@ module Rbeapi
       end
 
       ##
-      # set_address configures a logical IP interface with an address.  The
-      # address value must be in the form of A.B.C.D/E.  If no value is
-      # provided, then the interface address is negated using the config no
-      # keyword.  If the default option is set to true, then the ip address
-      # value is defaulted using the default keyword.  The default keyword has
-      # precedence over the value keyword if both options are specified
+      # set_address configures a logical IP interface with an address.
+      # The address value must be in the form of A.B.C.D/E.  If the enable
+      # keyword is false, then the interface address is negated using the
+      # config no keyword.  If the default option is set to true, then the
+      # ip address # value is defaulted using the default keyword.  The
+      # default keyword has precedence over the enable keyword if both
+      # options are specified
       #
       # @eos_version 4.13.7M
       #
@@ -218,30 +219,24 @@ module Rbeapi
       #   for the specified interface name.  The value must be in the form
       #   of A.B.C.D/E
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the ip address value using
       #   the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_address(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default ip address'
-        when false
-          cmds << (value.nil? ? 'no ip address' : "ip address #{value}")
-        end
-        configure cmds
+        cmds = command_builder('ip address', opts)
+        configure_interface(name, cmds)
       end
 
       ##
       # set_mtu configures the IP mtu value of the ip interface in the nodes
-      # configuration.  If the value is not provided, then the ip mtu value is
-      # configured using the no keyword.  If the default keywork option is
+      # configuration.  If the enable option is false, then the ip mtu value is
+      # configured using the no keyword.  If the default keyword option is
       # provided and set to true then the ip mtu value is configured using the
-      # default keyword.  The default keyword has precedence over the value
+      # default keyword.  The default keyword has precedence over the enable
       # keyword if both options are specified.
       #
       # @eos_version 4.13.7M
@@ -261,22 +256,16 @@ module Rbeapi
       #   the nodes configuration.  Valid values are in the range of 68 to 9214
       #   bytes.  The default is 1500 bytes
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the ip mtu value using
       #   the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_mtu(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default mtu'
-        when false
-          cmds << (value.nil? ? 'no mtu' : "mtu #{value}")
-        end
-        configure cmds
+        cmds = command_builder('mtu', opts)
+        configure_interface(name, cmds)
       end
 
       ##
@@ -309,21 +298,17 @@ module Rbeapi
       #
       def set_helper_addresses(name, opts = {})
         value = opts[:value]
+        enable = opts.fetch(:enable, true)
         default = opts[:default] || false
 
-        cmds = ["interface #{name}"]
         case default
         when true
-          cmds << 'default ip helper-address'
+          cmds = 'default ip helper-address'
         when false
-          if value.nil?
-            cmds << 'no ip helper-address'
-          else
-            cmds << 'no ip helper-address'
-            value.each { |addr| cmds << "ip helper-address #{addr}" }
-          end
+          cmds = ['no ip helper-address']
+          value.each { |addr| cmds << "ip helper-address #{addr}" } if enable
         end
-        configure cmds
+        configure_interface(name, cmds)
       end
     end
   end

data/lib/rbeapi/api/logging.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
@@ -83,13 +83,11 @@ module Rbeapi
 
       ##
       # set_enable configures the global logging instance on the node as either
-      # enabled or disabled.  If the value is set to true then logging is
-      # globally enabled and if set to false, it is globally disabled.  If no
-      # value is specified, then the no keyword is used to configure the
-      # logging enable value.  If the default keyword is specified and set to
-      # true, then the configuration is defaulted using the default keyword.
-      # The default keyword option takes precedence over the value keyword if
-      # both options are specified.
+      # enabled or disabled.  If the enable keyword is set to true then logging
+      # is globally enabled and if set to false, it is globally disabled.  If
+      # the default keyword is specified and set to true, then the configuration
+      # is defaulted using the default keyword.  The default keyword option
+      # takes precedence over the enable keyword if both options are specified.
       #
       # @eos_version 4.13.7M
       #
@@ -100,23 +98,15 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [Boolean] :value Enables logging globally if value is true
-      #   or disabled logging glboally if value is false
+      # @option :opts [Boolean] :enable Enables logging globally if value is
+      #   true or disabled logging globally if value is false
       #
       # @option :opts [Boolean] :default Configure the ip address value using
       #   the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_enable(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        case default
-        when true
-          cmd = 'default logging on'
-        when false
-          cmd = value ? 'logging on' : 'no logging on'
-        end
+        cmd = command_builder('logging on', opts)
         configure cmd
       end
 

data/lib/rbeapi/api/mlag.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
@@ -48,7 +48,7 @@ module Rbeapi
 
       ##
       # get scans the current nodes configuration and returns the values as
-      # a Hash descriping the current state.
+      # a Hash describing the current state.
       #
       # The resource hash returned contains the following:
       #   * domain_id: (String) The MLAG domain-id value
@@ -169,7 +169,7 @@ module Rbeapi
       private :parse_shutdown
 
       ##
-      # parse_interfaces scans the global configuraiton and returns all of the
+      # parse_interfaces scans the global configuration and returns all of the
       # configured MLAG interfaces.  Each interface returns the configured MLAG
       # identifier for establishing a MLAG peer.  The return value is intended
       # to be merged into the resource Hash
@@ -193,10 +193,10 @@ module Rbeapi
 
       ##
       # set_domain_id configures the mlag domain-id value in the current nodes
-      # running configuration. If the value keyword is not provided, the
-      # domain-id is configured with the no keyword.  If the default keyword is
-      # provided, the configuration is defaulted using the default keyword.
-      # The default keyword takes precedence over the value keywork if both
+      # running configuration. If the enable keyword is false, the the
+      # domain-id is configured with the no keyword.  If the default keyword
+      # is provided, the configuration is defaulted using the default keyword.
+      # The default keyword takes precedence over the enable keyword if both
       # options are specified
       #
       # @eos_version 4.13.7M
@@ -209,34 +209,29 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [String] :value The value to configurue the mlag
+      # @option :opts [String] :value The value to configure the mlag
       #   domain-id to.
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the domain-id value using
       #   the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_domain_id(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ['mlag configuration']
-        case default
-        when true
-          cmds << 'default domain-id'
-        when false
-          cmds << (value ? "domain-id #{value}" : 'no domain-id')
-        end
+        cmd = command_builder('domain-id', opts)
+        cmds = ['mlag configuration', cmd]
         configure(cmds)
       end
 
       ##
       # set_local_interface configures the mlag local-interface value in the
-      # current nodes running configuration. If the value keyword is not
-      # provided, the local-interface is configured with the no keyword.  If
+      # current nodes running configuration. If the enable keyword is false,
+      # the local-interface is configured with the no keyword.  If
       # the default keyword is provided, the configuration is defaulted using
       # the default keyword.  The default keyword takes precedence over the
-      # value keywork if both options are specified
+      # enable keyword if both options are specified
       #
       # @eos_version 4.13.7M
       #
@@ -248,34 +243,29 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [String] :value The value to configurue the mlag
+      # @option :opts [String] :value The value to configure the mlag
       #   local-interface to.  The local-interface accepts full interface
       #   identifiers and expects a Vlan interface
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the local-interface value
       #   using the default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_local_interface(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ['mlag configuration']
-        case default
-        when true
-          cmds << 'default local-interface'
-        when false
-          cmds << (value ? "local-interface #{value}" : 'no local-interface')
-        end
+        cmd = command_builder('local-interface', opts)
+        cmds = ['mlag configuration', cmd]
         configure(cmds)
       end
 
       ##
       # set_peer_link configures the mlag peer-link value in the current nodes
-      # running configuration. If the value keyword is not provided, the
+      # running configuration. If enable keyword is false, then the
       # peer-link is configured with the no keyword.  If the default keyword
       # is provided, the configuration is defaulted using the default keyword.
-      # The default keyword takes precedence over the value keywork if both
+      # The default keyword takes precedence over the enable keyword if both
       # options are specified
       #
       # @eos_version 4.13.7M
@@ -288,34 +278,29 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [String] :value The value to configurue the mlag
+      # @option :opts [String] :value The value to configure the mlag
       #   peer-link to.  The peer-link accepts full interface identifiers
-      #   and expects an Ethernet or Port-Channel  interface
+      #   and expects an Ethernet or Port-Channel interface
+      #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
       #
       # @option :opts [Boolean] :default Configure the peer-link using the
       #   default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_peer_link(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ['mlag configuration']
-        case default
-        when true
-          cmds << 'default peer-link'
-        when false
-          cmds << (value ? "peer-link #{value}" : 'no peer-link')
-        end
+        cmd = command_builder('peer-link', opts)
+        cmds = ['mlag configuration', cmd]
         configure(cmds)
       end
 
       ##
       # set_peer_address configures the mlag peer-address value in the current
-      # nodes running configuration. If the value keyword is not provided, the
+      # nodes running configuration. If the enable keyword is false, then the
       # peer-address is configured with the no keyword.  If the default keyword
       # is provided, the configuration is defaulted using the default keyword.
-      # The default keyword takes precedence over the value keywork if both
+      # The default keyword takes precedence over the enable keyword if both
       # options are specified
       #
       # @eos_version 4.13.7M
@@ -328,36 +313,30 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [String] :value The value to configurue the mlag
+      # @option :opts [String] :value The value to configure the mlag
       #   peer-address to.  The peer-address accepts an IP address in the form
       #   of A.B.C.D/E
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the peer-address using the
       #   default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_peer_address(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ['mlag configuration']
-        case default
-        when true
-          cmds << 'default peer-address'
-        when false
-          cmds << (value ? "peer-address #{value}" : 'no peer-address')
-        end
+        cmd = command_builder('peer-address', opts)
+        cmds = ['mlag configuration', cmd]
         configure(cmds)
       end
 
       ##
       # set_shutdown configures the administrative state of the mlag process on
-      # the current node.  If the value is true, then mlag is enabled and if
-      # the value is false, then mlag is disabled.  If no value is provided,
-      # the shutdown command is configured using the no keyword argument. If
-      # the default keyword is provided, the configuration is defaulted using
+      # the current node.  If the enable keyword is true, then mlag is enabled
+      # and if the enable keyword is false, then mlag is disabled. If the
+      # default keyword is provided, the configuration is defaulted using
       # the default keyword. The default keyword takes precedence over the
-      # value keywork if both options are specified
+      # enable keyword if both options are specified
       #
       # @eos_version 4.13.7M
       #
@@ -369,34 +348,31 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [Boolean] :value Enables the mlag configuration if value
-      #   is true or disables the mlag configuration if value is false.
+      # @option :opts [Boolean] :enable True if the interface should be
+      #   administratively enabled or false if the interface should be
+      #   administratively disabled.
       #
       # @option :opts [Boolean] :default Configure the shutdown value using the
       #   default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_shutdown(opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ['mlag configuration']
-        case default
-        when true
-          cmds << 'default shutdown'
-        when false
-          cmds << (value ? 'shutdown' : 'no shutdown')
-        end
+        fail '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)
+        cmd = command_builder('shutdown', opts)
+        cmds = ['mlag configuration', cmd]
         configure(cmds)
       end
 
       ##
       # set_mlag_id configures the mlag id on the interface in the nodes
-      # current running configuration.  If the value is not specified, then the
+      # current running configuration.  If the enable keyword is false, then the
       # interface mlag id is configured using the no keyword.  If the default
       # keyword is provided and set to true, the interface mlag id is
       # configured using the default keyword.  The default keyword takes
-      # precedence over the value keyword if both options are specified
+      # precedence over the enable keyword if both options are specified
       #
       # @eos_version 4.13.7M
       #
@@ -407,7 +383,7 @@ module Rbeapi
       #     default mlag
       #
       # @param [String] :name The full interface identifier of the interface
-      #   to confgure th mlag id for.
+      #   to configure th mlag id for.
       #
       # @param [Hash] :opts Optional keyword arguments
       #
@@ -415,22 +391,16 @@ module Rbeapi
       #   interface mlag to.  The mlag id should be in the valid range of 1 to
       #   2000
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the mlag value using the
       #   default keyword
       #
       # @return [Boolean] returns true if the command completed successfully
       def set_mlag_id(name, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default mlag'
-        when false
-          cmds << (value ? "mlag #{value}" : 'no mlag')
-        end
-        configure(cmds)
+        cmd = command_builder('mlag', opts)
+        configure_interface(name, cmd)
       end
     end
   end

data/lib/rbeapi/api/ntp.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
@@ -38,8 +38,8 @@ module Rbeapi
   # Api is module namesapce for working with the EOS command API
   module Api
     ##
-    # The Ntp class provides an intstance for working with the nodes
-    # NTP configuraiton.
+    # The Ntp class provides an instance for working with the nodes
+    # NTP configuration.
     class Ntp < Entity
       DEFAULT_SRC_INTF = ''
 
@@ -82,7 +82,7 @@ module Rbeapi
       # parse_servers scans the nodes configuration and parses the configured
       # ntp server host names and/or addresses.  This method will also return
       # the value of prefer.  If no servers are configured, the value will be
-      # set to an empty array.  The return hash is inteded to be merged into
+      # set to an empty array.  The return hash is intended to be merged into
       # the resource hash
       #
       # @api private
@@ -98,39 +98,34 @@ module Rbeapi
 
       ##
       # set_source_interface configures the ntp source value in the nodes
-      # running configuration.  If no value is provided in the options, then
+      # running configuration.  If the enable keyword is false, then
       # the ntp source is configured with the no keyword argument.  If the
       # default keyword argument is provided and set to true, the value is
       # configured used the default keyword.  The default keyword takes
-      # precedence over the value keyword if both optiosn are specified.
+      # precedence over the enable keyword if both options are specified.
       #
       # @eos_version 4.13.7M
       #
       # @commands
       #   ntp source <value>
       #   no ntp source
-      #   deafult ntp source
+      #   default ntp source
       #
       # @param [Hash] :opts Optional keyword arguments
       #
       # @option :opts [String] :value The value to configure the ntp source
       #   in the nodes configuration
       #
+      # @option :opts [Boolean] :enable If false then the command is
+      #   negated. Default is true.
+      #
       # @option :opts [Boolean] :default Configure the ntp source 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 ntp source'
-        when false
-          cmds = (value ? "ntp source #{value}" : 'no ntp source')
-        end
-        configure(cmds)
+        cmd = command_builder('ntp source', opts)
+        configure(cmd)
       end
 
       ##

data/lib/rbeapi/api/ospf.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
@@ -52,7 +52,7 @@ module Rbeapi
       #     "areas": {
       #       <string>: array<string>
       #     },
-      #     "resdistribute"
+      #     "redistribute"
       #   }
       #
       # @return [Hash]  A Ruby hash object that provides the OSPF settings as
@@ -117,16 +117,8 @@ module Rbeapi
       end
 
       def set_router_id(pid, opts = {})
-        value = opts[:value]
-        default = opts[:default] || false
-
-        cmds = ["router ospf #{pid}"]
-        case default
-        when true
-          cmds << 'default router-id'
-        when false
-          cmds << (value ? "router-id #{value}" : 'no router-id')
-        end
+        cmd = command_builder('router-id', opts)
+        cmds = ["router ospf #{pid}", cmd]
         configure cmds
       end
 
@@ -163,7 +155,7 @@ module Rbeapi
       #   values for.  This must be the full interface identifier.
       #
       # @return [nil, Hash<String, String>] A Ruby hash that represents the
-      #   MLAG interface confguration.  A nil object is returned if the
+      #   MLAG interface configuration.  A nil object is returned if the
       #   specified interface is not configured
       def get(name)
         config = get_block("interface #{name}")
@@ -187,7 +179,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)[Et|Po|Lo|Vl].+/)
@@ -199,18 +191,9 @@ module Rbeapi
 
       def set_network_type(name, opts = {})
         value = opts[:value]
-        default = opts[:default] || false
-
-        return false unless %w(nil point-to-point).include?(value)
-
-        cmds = ["interface #{name}"]
-        case default
-        when true
-          cmds << 'default ip ospf network'
-        when false
-          cmds << (value ? "ip ospf network #{value}" : 'no ip ospf netework')
-        end
-        configure(cmds)
+        return false unless [nil, 'point-to-point'].include?(value)
+        cmd = command_builder('ip ospf network', opts)
+        configure_interface(name, cmd)
       end
     end
   end