rbeapi 0.1.0

data/lib/rbeapi/api/switchports.rb

@@ -0,0 +1,272 @@
+#
+# 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
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Api
+    ##
+    # The Switchport class provides a base class instance for working with
+    # logical layer-2 interfaces.
+    #
+    class Switchports < Entity
+
+      ##
+      # Retrieves the properies for a logical switchport from the
+      # running-config using eAPI
+      #
+      # Example
+      #   {
+      #     "name": <String>,
+      #     "mode": [access, trunk],
+      #     "trunk_allowed_vlans": array<strings>
+      #     "trunk_native_vlan": <Integer>,
+      #     "access_vlan": <Integer>
+      #   }
+      #
+      # @param [String] name The full name of the interface to get.  The
+      #   interface name must be the full interface (ie Ethernet, not Et)
+      #
+      # @return [Hash] a hash that includes the switchport properties
+      def get(name)
+        config = get_block("interface #{name}")
+        return nil unless config
+        return nil if /no\sswitchport$/ =~ config
+
+        response = {}
+        response.merge!(parse_mode(config))
+        response.merge!(parse_access_vlan(config))
+        response.merge!(parse_trunk_native_vlan(config))
+        response.merge!(parse_trunk_allowed_vlans(config))
+        response
+      end
+
+      def parse_mode(config)
+        mdata = /(?<=\s{3}switchport\smode\s)(.+)$/.match(config)
+        { mode: mdata[1] }
+      end
+
+      def parse_access_vlan(config)
+        mdata = /(?<=access\svlan\s)(.+)$/.match(config)
+        { access_vlan: mdata[1] }
+      end
+
+      def parse_trunk_native_vlan(config)
+        mdata = /(?<=trunk\snative\svlan\s)(.+)$/.match(config)
+        { trunk_native_vlan: mdata[1] }
+      end
+
+      def parse_trunk_allowed_vlans(config)
+        mdata = /(?<=trunk\sallowed\svlan\s)(.+)$/.match(config)
+        return { trunk_allowed_vlans: [] } unless mdata[1] != 'none'
+        vlans = mdata[1].split(',')
+        values = vlans.each_with_object([]) do |vlan, arry|
+          if /-/ !~ vlan
+            arry << vlan.to_i
+          else
+            range_start, range_end = vlan.split('-')
+            arry.push(*Array(range_start.to_i..range_end.to_i))
+          end
+        end
+        { trunk_allowed_vlans: values }
+      end
+
+      ##
+      # Retrieves all switchport interfaces from the running-config
+      #
+      # @return [Array] an array of switchport hashes
+      def getall
+        interfaces = config.scan(/(?<=^interface\s)([Et|Po].+)$/)
+        interfaces.each_with_object({}) do |port, hsh|
+          cfg = get port.first
+          hsh[port.first] = cfg if cfg
+        end
+      end
+
+      ##
+      # Creates a new logical switchport interface in EOS
+      #
+      # @param [String] name The name of the logical interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def create(name)
+        configure ["interface #{name}", 'no ip address', 'switchport']
+      end
+
+      ##
+      # Deletes a logical switchport interface from the running-config
+      #
+      # @param [String] name The name of the logical interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def delete(name)
+        configure ["interface #{name}", 'no switchport']
+      end
+
+      ##
+      # Defaults a logical switchport interface in the running-config
+      #
+      # @param [String] name The name of the logical interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def default(name)
+        configure ["interface #{name}", 'default switchport']
+      end
+
+      ##
+      # Configures the switchport mode for the specified interafce.  Valid
+      # modes are access (default) or trunk
+      #
+      # @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] :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
+          cmds << (value.nil? ? 'no switchport mode' : \
+                                "switchport mode #{value}")
+        end
+        configure(cmds)
+      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
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   switchport trunk allowed vlan add <value>
+      #   no switchport trunk allowed vlan
+      #   default switchport trunk allowed vlan
+      #
+      # @option [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 [Boolean] :default Configures the switchport trunk allowed
+      #     vlans command using the default keyword
+      #
+      # @return [Boolean] returns true if the commands complete successfully
+      def set_trunk_allowed_vlans(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        unless value.is_a?(Array)
+          raise ArgumentError, 'value must be an Array'
+        end
+
+        value = value.map(&:inspect).join(',') if value
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default switchport trunk allowed vlan'
+        when false
+          if value.nil?
+            cmds << 'no switchport trunk allowed vlan'
+          else
+            cmds << 'switchport trunk allowed vlan none'
+            cmds << "switchport trunk allowed vlan add #{value}"
+          end
+        end
+        configure(cmds)
+      end
+
+      ##
+      # Configures the trunk port native vlan for the specified interface.
+      # This value is only valid if the switchport mode is configure as
+      # trunk.
+      #
+      # @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
+      #
+      # @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
+          cmds << (value.nil? ? 'no switchport trunk native vlan' : \
+                                "switchport trunk native vlan #{value}")
+        end
+        configure(cmds)
+      end
+
+      ##
+      # Configures the access port vlan for the specified interface.
+      # This value is only valid if the switchport mode is configure
+      # in access mode.
+      #
+      # @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] :default The value should be set to default
+      #
+      # @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
+          cmds << (value.nil? ? 'no switchport access vlan' : \
+                                "switchport access vlan #{value}")
+        end
+        configure(cmds)
+      end
+    end
+  end
+end

data/lib/rbeapi/api/system.rb

@@ -0,0 +1,87 @@
+#
+# 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 System class configures the node system services such as
+    # hostname and domain name
+    class System < Entity
+
+      ##
+      # Returns the system settings
+      #
+      # @example
+      #   {
+      #     hostname: <string>
+      #   }
+      #
+      # @return [Hash]  A Ruby hash objec that provides the system settings as
+      #   key/value pairs.
+      def get()
+        response = {}
+        response.merge!(parse_hostname(config))
+        response
+      end
+
+      def parse_hostname(config)
+        mdata = /(?<=^hostname\s)(.+)$/.match(config)
+        { hostname: mdata.nil? ? '' : mdata[1] }
+      end
+
+      ##
+      # Configures the system hostname value in the running-config
+      #
+      # @param [Hash] opts The configuration parameters
+      # @option opts [string] :value The value to set the hostname to
+      # @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)
+      end
+    end
+  end
+end

data/lib/rbeapi/api/tacacs.rb

@@ -0,0 +1,236 @@
+#
+# 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
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Api
+
+    ##
+    # Tacacs provides instance methods to retrieve and set tacacs configuration
+    # values.
+    class Tacacs < Entity
+
+      DEFAULT_KEY_FORMAT = 0
+      DEFAULT_KEY = nil
+
+      # 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.
+      SERVER_REGEXP = /tacacs-server[ ]host[ ]([^\s]+)
+                       (?:[ ](single-connection))?
+                       (?:[ ]vrf[ ]([^\s]+))?
+                       (?:[ ]port[ ](\d+))?
+                       (?:[ ]timeout[ ](\d+))?
+                       (?:[ ]key[ ](\d+)[ ](\w+))?\s/x
+
+      # Default Tacacs TCP port
+      DEFAULT_PORT = 49
+
+      ##
+      # getall Returns an Array with a single resource Hash describing the
+      # current state of the global tacacs configuration on the target device.
+      # This method is intended to be used by a provider's instances class
+      # method.
+      #
+      # The resource hash returned contains the following information:
+      #  * 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_format: (Integer) e.g. 0 or 7
+      #  * timeout: (Integer) seconds before the timeout period ends
+      #
+      # @api public
+      #
+      # @return [Array<Hash>] Single element Array of resource hashes
+      def get
+        global = {}
+        global.merge!(parse_global_timeout)
+        global.merge!(parse_global_key)
+        resource = { global: global, servers: servers }
+        resource
+      end
+
+      ##
+      # parse_global_key takes a running configuration as a string and
+      # parses out the radius global key and global key format if it exists in
+      # the configuration.  An empty Hash is returned if there is no global key
+      # configured.  The intent of the Hash is to be merged into a property
+      # hash.
+      #
+      # @param [String] config The running configuration as a single string.
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol,Object>] resource hash attributes
+      def parse_global_key
+        rsrc_hsh = {}
+        (key_format, key) = config.scan(/tacacs-server key (\d+) (\w+)/).first
+        rsrc_hsh[:key_format] = key_format.to_i || DEFAULT_KEY_FORMAT
+        rsrc_hsh[:key] = key || DEFAULT_KEY
+        { key: key, key_format: key_format }
+      end
+      private :parse_global_key
+
+      ##
+      # parse_global_timeout takes a running configuration as a string
+      # and parses out the tacacs global timeout if it exists in the
+      # configuration.  An empty Hash is returned if there is no global timeout
+      # value configured.  The intent of the Hash is to be merged into a
+      # property hash.
+      #
+      # @param [String] config The running configuration as a single string.
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol,Object>] resource hash attributes
+      def parse_global_timeout
+        timeout = config.scan(/tacacs-server timeout (\d+)/).first
+        { timeout: timeout.first.to_i }
+      end
+      private :parse_global_timeout
+
+      ##
+      # servers returns an Array of tacacs server resource hashes.  Each hash
+      # describes the current state of the tacacs server and is suitable for
+      # use in initializing a tacacs_server provider.
+      #
+      # The resource hash returned contains the following information:
+      #
+      #  * 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_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
+      #    single connection
+      #
+      # @api public
+      #
+      # @return [Array<Hash<Symbol,Object>>] Array of resource hashes
+      def servers
+        tuples = config.scan(SERVER_REGEXP)
+        tuples.map do |(host, mplex, vrf, port, tout, keyfm, key)|
+          hsh = {}
+          hsh[:hostname]         = host
+          hsh[:vrf]              = vrf
+          hsh[:port]             = port.to_i
+          hsh[:timeout]          = tout.to_i
+          hsh[:key_format]       = keyfm.to_i
+          hsh[:key]              = key
+          hsh[:multiplex]        = mplex ? true : false
+          hsh
+        end
+      end
+
+      ##
+      # set_global_key configures the tacacs default key.  This method maps to
+      # the `tacacs-server key` EOS configuration command, e.g. `tacacs-server
+      # key 7 070E234F1F5B4A`.
+      #
+      # @option opts [String] :key ('070E234F1F5B4A') The key value
+      #
+      # @option opts [Fixnum] :key_format (7) The key format, 0 for plaintext
+      #   and 7 for a hashed value.  7 will be assumed if this option is not
+      #   provided.
+      #
+      # @api public
+      #
+      # @return [Boolean] true if no errors
+      def set_global_key(opts = {})
+        format = opts[:key_format]
+        key = opts[:key]
+        fail ArgumentError, 'key option is required' unless key
+        result = api.config("tacacs-server key #{format} #{key}")
+        result == [{}]
+      end
+
+      ##
+      # 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.
+      #
+      # @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
+            cmds = value ? "tacacs-server timeout #{value}" :
+                           'no tacacs-server timeout'
+        end
+        configure cmds
+      end
+
+      ##
+      # update_server configures a tacacs server resource on the target device.
+      # This API method maps to the `tacacs server host` command, e.g.
+      # `tacacs-server host 1.2.3.4 single-connection port 4949 timeout 6 key 7
+      # 06070D221D1C5A`
+      #
+      # @api public
+      #
+      # @return [Boolean] true if there are no errors
+      def update_server(opts = {})
+        key_format = opts[:key_format] || 7
+        cmd = "tacacs-server host #{opts[:hostname]}"
+        cmd << ' single-connection'               if opts[:multiplex]
+        cmd << " port #{opts[:port]}"             if opts[:port]
+        cmd << " timeout #{opts[:timeout]}"       if opts[:timeout]
+        cmd << " key #{key_format} #{opts[:key]}" if opts[:key]
+        configure cmd
+      end
+
+      ##
+      # remove_server removes the tacacs server identified by the hostname,
+      # and port attributes.
+      #
+      # @api public
+      #
+      # @return [Boolean] true if no errors
+      def remove_server(opts = {})
+        cmd = "no tacacs-server host #{opts[:hostname]}"
+        cmd << " port #{opts[:port]}" if opts[:port]
+        configure cmd
+      end
+    end
+  end
+end