rbeapi 0.1.0

data/lib/rbeapi/api/ipinterfaces.rb

@@ -0,0 +1,328 @@
+#
+# Copyright (c) 2014, 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'
+
+module Rbeapi
+
+  module Api
+    #
+    # The Ipinterface class provides an instance for managing logical
+    # IP interfaces configured using eAPI.
+    class Ipinterfaces < Entity
+
+      DEFAULT_ADDRESS = ''
+
+      ##
+      # get returns a resource hash that represents the configuration of the IP
+      # interface from the nodes running configuration.
+      #
+      # @example
+      #   {
+      #     address: <string>
+      #     mtu: <string>
+      #     helper_addresses: array<strings>
+      #   }
+      #
+      # @param [String] :name The full interface identifier of the interface to
+      #   return the resource configuration hash for.  The name must be the
+      #   full name (Ethernet, not Et)
+      #
+      # @return [nil, Hash<Symbol, Object>] returns the ip interface
+      #   configuration as a hash.  If the provided interface name is not a
+      #   configured ip address, nil is returned.
+      def get(name)
+        config = get_block("interface #{name}")
+        return nil unless config
+        return nil if /\s{3}switchport$/ =~ config
+
+        response = {}
+        response.merge!(parse_address(config))
+        response.merge!(parse_mtu(config))
+        response.merge!(parse_helper_addresses(config))
+        response
+      end
+
+      ##
+      # getall returns a hash object that represents all ip interfaces
+      # configured on the node from the current running configuration.
+      #
+      # @example
+      #   {
+      #     <name>: {...}
+      #   }
+      #
+      # @see get Ipaddress resource example
+      #
+      # @return [Hash<Symbol, Object>] returns a hash object that
+      #   represents all of the configured IP addresses found.  If no IP
+      #   addresses are configured, then an empty hash is returned
+      def getall
+        interfaces = config.scan(/(?<=^interface\s).+/)
+        interfaces.each_with_object({}) do |name, hsh|
+          values = get name
+          hsh[name] = values if values
+        end
+      end
+
+      ##
+      # parse_address scans the provided configuration block and extracts
+      # the interface address, if configured, and returns it.  If there is
+      # no IP address configured, then this method will return the
+      # DEFAULT_ADDRESS.  The return value is intended to be merged into the
+      # ipaddress resource hash.
+      #
+      # @api private
+      # @param [String] :config The IP interface configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_address(config)
+        mdata = /(?<=^\s{3}ip\saddress\s)(.+)$/.match(config)
+        { address: mdata.nil? ? DEFAULT_ADDRESS : mdata[1] }
+      end
+      private :parse_address
+
+      ##
+      # parse_mtu scans the provided configuration block and extracts the IP
+      # interface MTU value.  The MTU value is expected to always be present in
+      # the configuration blcok.  The return value is intended to be merged
+      # into the ipaddress resource hash
+      #
+      # @api private
+      #
+      # @param [String] :config The IP interface configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_mtu(config)
+        mdata = /(?<=mtu\s)(\d+)$/.match(config)
+        { mtu: mdata.nil? ? '': mdata[1] }
+      end
+      private :parse_mtu
+
+      ##
+      # parse_helper_addresses scans the provided configuraiton 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
+      # hash.  The return value is intended to be merged into the ipaddress
+      # resource hash
+      #
+      # @api private
+      #
+      # @param [String] :config The IP interface configuration block returned
+      #   from the node's running configuration
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_helper_addresses(config)
+        helpers = config.scan(/(?<=\s{3}ip\shelper-address\s).+$/)
+        { helper_addresses: helpers }
+      end
+      private :parse_helper_addresses
+
+      ##
+      # create will create a new IP interface on the node.  If the ip interface
+      # already exists in the configuration, this method will still return
+      # successful.  This method will cause an existing layer 2 interface
+      # (switchport) to be deleted if it exists in the node's configuration.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   interface <name>
+      #     no switchport
+      #
+      # @param [String] :name The full interface name of the port to create the
+      #   logical interface on.  The name must be the full interface
+      #   identifier
+      #
+      # @return [Boolean] returns true if the commands complete successfully
+      def create(name)
+        configure(["interface #{name}", 'no switchport'])
+      end
+
+      ##
+      # delete will delete an existing IP interface in the node's current
+      # configuration.  If the IP interface does not exist on the specified
+      # interface, this method will still return success.  This command will
+      # default the interface back to being a switchport.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   interface <name>
+      #     no ip address
+      #     switchport
+      #
+      # @param [String] :name The full interface name of the port to delete the
+      #   logical interface from.  The name must be the full interface name
+      #
+      # @return [Boolean] returns true if the commands complete successfully
+      def delete(name)
+        configure(["interface #{name}", 'no ip address', 'switchport'])
+      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
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   interface <name>
+      #     ip address <value>
+      #     no ip address
+      #     default ip address
+      #
+      # @param [String] :name The name of the interface to configure the
+      #   address in the node.  The name must be the full interface name.
+      #
+      # @param [Hash] :opts Optional keyword arguments
+      #
+      # @option :opts [String] :value The value to configure the address to
+      #   for the specified interface name.  The value must be in the form
+      #   of A.B.C.D/E
+      #
+      # @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
+      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
+      # provided and set to true then the ip mtu value is configured using the
+      # default keyword.  The default keyword has precedence over the value
+      # keyword if both options are specified.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   interface <name>
+      #     mtu <value>
+      #     no mtu
+      #     default mtu
+      #
+      # @param [String] :name The name of the interface to configure the
+      #   address in the node.  The name must be the full interface name.
+      #
+      # @param [Hash] :opts Optional keyword arguments
+      #
+      # @option :opts [String] :value The value to configure the IP MTU to in
+      #   the nodes configuration.  Valid values are in the range of 68 to 9214
+      #   bytes.  The default is 1500 bytes
+      #
+      # @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
+      end
+
+      ##
+      # set_helper_addresses configures the list of helper addresses on the ip
+      # interface.  An IP interface can have one or more helper addresses
+      # configured.  If no value is provided, the helper address configuration
+      # is set using the no keyword.  If the default option is specified and
+      # set to true, then the helper address values are defaulted using the
+      # default keyword.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   interface <name>
+      #     ip helper-address <value>
+      #     no ip helper-address
+      #     default ip helper-address
+      #
+      # @param [String] :name The name of the interface to configure the
+      #   address in the node.  The name must be the full interface name.
+      #
+      # @param [Hash] :opts Optional keyword arguments
+      #
+      # @option :opts [Array] :value The list of IP addresses to configure as
+      #   helper address on the interface.  The helper addresses must be valid
+      #   addresses in the main interface's subnet.
+      #
+      # @option :opts [Boolean] :default Configure the ip helper address values
+      #    using the default keyword
+      #
+      def set_helper_addresses(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          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
+        end
+        configure cmds
+      end
+    end
+  end
+end

data/lib/rbeapi/api/logging.rb

@@ -0,0 +1,157 @@
+#
+# Copyright (c) 2014, 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'
+
+module Rbeapi
+
+  module Api
+
+    class Logging < Entity
+
+      ##
+      # get returns the current logging configuration hash extracted from the
+      # nodes running configuration.
+      #
+      # @example
+      #   {
+      #     enable: [true, false]
+      #     hosts: array<strings>
+      #   }
+      #
+      # @return [Hash<Symbol, Object>] returns the logging resource as a hash
+      #   object from the nodes current configuration
+      def get
+        response = {}
+        response.merge!(parse_enable)
+        response.merge!(parse_hosts)
+        response
+      end
+
+      ##
+      # parse_enable scans the nodes current running configuration and extracts
+      # the current enabled state of the logging facility.  The logging enable
+      # command is expected to always be in the node's configuration.  This
+      # methods return value is intended to be merged into the logging resource
+      # hash.
+      def parse_enable
+        value = /no logging on/ !~ config
+        { enable: value }
+      end
+
+      ##
+      # parse_hosts scans the nodes current running configuration and extracts
+      # the configured logging host destinations if any are configured.  If no
+      # logging hosts are configured, then the value for hosts will be an empty
+      # array.  The return value is intended to be merged into the logging
+      # resource hash
+      def parse_hosts
+        hosts = config.scan(/(?<=^logging\shost\s)[^\s]+/)
+        { hosts: hosts }
+      end
+
+      ##
+      # 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.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   logging on
+      #   no logging on
+      #   default logging on
+      #
+      # @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] :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
+        configure cmd
+      end
+
+      ##
+      # add_host configures a new logging destination host address or hostname
+      # to the list of logging destinations.  If the host is already configured
+      # in the list of destinations, this method will return successfully.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   logging host <name>
+      #
+      # @param [String] :name The host name or ip address of the destination
+      #   node to send logging information to.
+      #
+      # @return [Boolean] returns true if the command completed successfully
+      def add_host(name)
+        configure "logging host #{name}"
+      end
+
+      ##
+      # remove_host deletes a logging destination host name or address form the
+      # list of logging destinations.   If the host is not in the list of
+      # configured hosts, this method will still return successfully.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   no logging host <name>
+      #
+      # @param [String] :name The host name or ip address of the destination
+      #   host to remove from the nodes current configuration
+      #
+      # @return [Boolean] returns true if the commands completed successfully
+      def remove_host(name)
+        configure "no logging host #{name}"
+      end
+    end
+  end
+end