rbeapi 0.1.0

data/lib/rbeapi/api/ntp.rb

@@ -0,0 +1,201 @@
+#
+# 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'
+
+##
+# Eos is the toplevel namespace for working with Arista EOS nodes
+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.
+    class Ntp < Entity
+
+      DEFAULT_SRC_INTF = ''
+
+      ##
+      # get returns the nodes current ntp configure as a resource hash
+      #
+      # @example
+      #   {
+      #     source_interface: <string>
+      #     servers: {
+      #       prefer: [true, false]
+      #     }
+      #   }
+      #
+      # @return [nil, Hash<Symbol, Object>] Returns the ntp resource as a
+      #   Hash.
+      def get
+        response = {}
+        response.merge!(parse_source_interface)
+        response.merge!(parse_servers)
+        response
+      end
+
+      ##
+      # parse_source_interface scans the nodes configurations and parses
+      # the ntp source interface if configured.  If the source interface
+      # is not configured, this method will return DEFAULT_SRC_INTF as the
+      # value. The return hash is intended to be merged into the resource hash
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_source_interface
+        mdata = /(?<=^ntp\ssource\s)(.+)$/.match(config)
+        { source_interface: mdata.nil? ? DEFAULT_SRC_INTF : mdata[1] }
+      end
+      private :parse_source_interface
+
+      ##
+      # 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
+      # the resource hash
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_servers
+        servers = config.scan(/(?:ntp server\s)([^\s]+)\s(prefer)?/)
+        values = servers.each_with_object({}) do |(srv, prefer), hsh|
+          hsh[srv] = { prefer: !prefer.nil? }
+        end
+        { servers: values }
+      end
+
+      ##
+      # set_source_interface configures the ntp source value in the nodes
+      # running configuration.  If no value is provided in the options, 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.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   ntp source <value>
+      #   no ntp source
+      #   deafult 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] :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)
+      end
+
+      ##
+      # add_server configures a new ntp server destination hostname or ip
+      # address to the list of ntp destinations.  The optional prefer argument
+      # configures the server as a preferred (true) or not (false) ntp
+      # destination.
+      #
+      # @param [String] :server The IP address or FQDN of the NTP server to
+      #   be removed from the configuration
+      #
+      # @param [Boolean] :prefer Appends the prefer keyword argument to the
+      #   command if this value is true
+      #
+      # @return [Boolean] returns true if the command completed successfully
+      def add_server(server, prefer = false)
+        cmd = "ntp server #{server}"
+        cmd << ' prefer' if prefer
+        configure cmd
+      end
+
+      ##
+      # remove_server deletes the provided server destination from the list of
+      # ntp server destinations.  If the ntp server does not exist in the list
+      # of servers, this method will return successful
+      #
+      # @param [String] :server The IP address or FQDN of the NTP server to
+      #   be removed from the configuration
+      #
+      # @return [Boolean] returns true if the command completed successfully
+      def remove_server(server)
+        configure("no ntp server #{server}")
+      end
+
+      ##
+      # set_prefer will set the prefer keyword for the specified ntp server.
+      # If the server does not already exist in the configuration, it will be
+      # added and the prefer keyword will be set.
+      #
+      # @eos_version 4.13.7M
+      #
+      # @commands
+      #   ntp server <srv> prefer
+      #   no ntp server <srv> prefer
+      #
+      # @param [String] :srv The IP address or hostname of the ntp server to
+      #   configure with the prefer value
+      #
+      # @param [Boolean] :value The value to configure for prefer.  If true
+      #   the prefer value is configured for the server.  If false, then the
+      #   prefer value is removed.
+      #
+      # @return [Boolean] returns true if the commands completed successfully
+      def set_prefer(srv, value)
+        case value
+        when true
+          cmds = "ntp server #{srv} prefer"
+        when false
+          cmds = ["no ntp server #{srv} prefer", "ntp server #{srv}"]
+        end
+        configure cmds
+      end
+    end
+  end
+end

data/lib/rbeapi/api/ospf.rb

@@ -0,0 +1,214 @@
+#
+# 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 Ospf class is a global class that provides an instance for working
+    # with the node's OSPF configuration
+    class Ospf < Entity
+
+      ##
+      # Returns the global OSPF configuration from the node
+      #
+      # @example
+      #   {
+      #     "router_id": <string>
+      #     "areas": {
+      #       <string>: array<string>
+      #     },
+      #     "resdistribute"
+      #   }
+      #
+      # @return [Hash]  A Ruby hash object that provides the OSPF settings as
+      #   key / value pairs.
+      def get(inst)
+        config = get_block("router ospf #{inst}")
+        return nil unless config
+
+        resp = {}
+        mdata = /(?<=^\s{3}router-id\s)(.+)$/.match(config)
+        resp['router_id'] = mdata.nil? ? '' : mdata[0]
+
+        mdata = /^\s{3}network\s(.+)\sarea\s(.+)$/.match(config)
+        networks = config.scan(/^\s{3}network\s(.+)\sarea\s(.+)$/)
+        areas = networks.each_with_object({}) do |cfg, hsh|
+          net, area = cfg
+          if hsh.include?(area)
+            hsh[area] << net
+          else
+            hsh[area] = [net]
+          end
+        end
+        resp['areas'] = areas
+
+        values = config.scan(/(?<=^\s{3}redistribute\s)(\w+)[\s|$]*(route-map\s(.+))?/)
+
+        resp['redistribute'] = values.each_with_object({}) do |value, hsh|
+          hsh[value[0]] = { 'route_map' => value[2] }
+        end
+        resp
+      end
+
+      ##
+      # Returns the OSPF configuration from the node as a Ruby hash
+      #
+      # @example
+      # {
+      #   <pid>: {...}
+      #   "interfaces": {...}
+      # }
+      def getall
+        response = {}
+
+        instances = config.scan(/(?<=^router\sospf\s)\d+$/)
+        response = instances.each_with_object({}) do |inst, hsh|
+          hsh[inst] = get inst
+        end
+        response['interfaces'] = interfaces.getall
+        response
+      end
+
+      def interfaces
+        @interfaces if @interfaces
+        @interfaces = OspfInterfaces.new(node)
+        @interfaces
+      end
+
+      def create(pid)
+        configure "router ospf #{pid}"
+      end
+
+      def delete(pid)
+        configure "no router ospf #{pid}"
+      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
+        configure cmds
+      end
+
+      def add_network(pid, net, area)
+        configure ["router ospf #{pid}", "network #{net} area #{area}"]
+      end
+
+      def remove_network(pid, net, area)
+        configure ["router ospf #{pid}", "no network #{net} area #{area}"]
+      end
+
+      def set_redistribute(pid, proto, opts = {})
+        routemap = opts[:routemap]
+        cmds = ["router ospf #{pid}", "redistribute #{proto}"]
+        cmds[1] << " route-map #{routemap}" if routemap
+        configure cmds
+      end
+    end
+
+    class OspfInterfaces < Entity
+
+      ##
+      # Returns a single MLAG interface configuration
+      #
+      # Example
+      #   {
+      #     "name": <string>,
+      #     "network_type": <string>
+      #   }
+      #
+      # @param [String] :name The interface name to return the configuration
+      #   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
+      #   specified interface is not configured
+      def get(name)
+        config = get_block("interface #{name}")
+        return nil unless config
+        return nil unless /no switchport$/ =~ config
+
+        response = {}
+        nettype = /ip ospf network point-to-point/ =~ config
+        response['network_type'] = nettype.nil? ? 'broadcast' : 'point-to-point'
+        response
+      end
+
+      ##
+      # Returns the collection of MLAG interfaces as a hash index by the
+      # interface name
+      #
+      # Example
+      #   {
+      #     <name>: {...},
+      #     <name>: {...}
+      #   }
+      #
+      # @return [nil, Hash<String, String>] A Ruby hash that represents the
+      #   MLAG interface confguration.  A nil object is returned if no
+      #   interfaces are configured.
+      def getall
+        interfaces = config.scan(/(?<=interface\s)[Et|Po|Lo|Vl].+/)
+        interfaces.each_with_object({}) do |intf, hsh|
+          values = get(intf)
+          hsh[intf] = values if values
+        end
+      end
+
+      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)
+      end
+    end
+  end
+end

data/lib/rbeapi/api/prefixlists.rb

@@ -0,0 +1,98 @@
+#
+# 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 Prefixlists class provides a configuration instance for working
+    # with static routes in EOS.
+    #
+    class Prefixlists < Entity
+
+      ##
+      # Returns the static routes configured on the node
+      #
+      # @example
+      #   {
+      #     <route>: {
+      #       "next_hop": <string>,
+      #       "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
+      #   there are no static routes configured, this method will return
+      #   an empty hash
+
+      def get(name)
+        config = get_block("ip prefix-list #{name}")
+        return nil unless config
+
+        entries = config.scan(/^\s{3}(?:seq\s)(\d+)\s(permit|deny)\s(.+)$/)
+        entries.each_with_object([]) do |entry, arry|
+          arry << { 'seq' => entry[0], 'action' => entry[1],
+                    'prefex' => entry[2] }
+        end
+      end
+
+      def getall
+        lists = config.scan(/(?<=^ip\sprefix-list\s).+/)
+        lists.each_with_object({}) do |name, hsh|
+          values = get name
+          hsh[name] = values if values
+        end
+      end
+
+      def create(name)
+        configure "ip prefix-list #{name}"
+      end
+
+      def add_rule(name, action, prefix, seq = nil)
+        cmd = "ip prefix-list #{name}"
+        cmd << " seq #{seq}" if seq
+        cmd << " #{action} #{prefix}"
+        configure cmd
+      end
+
+      def delete(name, seq = nil)
+        cmd = "no ip prefix-list #{name}"
+        cmd << " seq #{seq}" if seq
+        configure cmd
+      end
+
+    end
+  end
+end