puppet_x_eos_eapi 0.2.0

data/lib/puppet_x/eos/module_base.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module PuppetX
+  module Eos
+    ##
+    # ModuleBase provides a base class for other modules to inherit from.
+    # Methods common to all modules should be placed here.
+    class ModuleBase
+      attr_reader :api
+
+      ##
+      # Initialize instance of Module.  The Module class provides instance
+      # methods to configure module related resources on the target device.
+      #
+      # @param [PuppetX::Eos::Eapi] api An instance of Eapi
+      #
+      # @return [PuppetX::Eos::ModuleBase]
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # running_configuration returns the current running configuration as a
+      # string.  This method is intended to be used by subclasses.  The running
+      # configuration is returned as a single string object to faciliate the
+      # use of String#scan
+      #
+      # @api private
+      #
+      # @return [String]
+      def running_configuration
+        result = api.enable('show running-config', format: 'text')
+        result.last['output']
+      end
+    end
+  end
+end

data/lib/puppet_x/eos/modules/daemon.rb

@@ -0,0 +1,109 @@
+#
+# 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.
+#
+
+##
+# PuppetX is the toplevel namespace for working with Arista EOS nodes
+module PuppetX
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Eos
+    ##
+    # The Daemon class provides management of daemons using EOS CLI
+    # commands over eAPI.  This class provides method for creating and
+    # deleting daemons
+    #
+    class Daemon
+      ##
+      # Initializes a new instance of Daemon.
+      #
+      # @param [PuppetX::Eos::Eapi] api An instance of Eapi
+      #
+      # @return [PuppetX::Eos::Daemon] instance
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # Returns a hash of configured daemons from the running config
+      #
+      # Example
+      #   {
+      #     "agent": "command"
+      #   }
+      #
+      # @return [Hash<String, String>] Hash of configured agents
+      def getall
+        result = @api.enable('show running-config section daemon',
+                             format: 'text')
+        response = {}
+        key = nil
+        result.first['output'].split("\n").each do |entry|
+          token = entry.strip.match(/^daemon\s(?<name>.*)$/)
+          unless token.nil?
+            key = token['name']
+            response[key] = nil
+          end
+          token = entry.strip.match(/^command\s(?<command>.*)$/)
+          unless token.nil?
+            value = token['command']
+            response[key] = value
+          end
+        end
+        response
+      end
+
+      ##
+      # Configures a new daemon agent in EOS using eAPI
+      #
+      # @param [String] name The name of the daemon agent
+      # @param [String] command The path to the daemon executable
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def create(name, command)
+        return false unless File.executable?(command)
+        @api.config(["daemon #{name}", "command #{command}"]) == [{}, {}]
+      end
+
+      ##
+      # Deletes a previously configured daemon from the running-configuration
+      # in EOS using eAPI
+      #
+      # @param [String] name The name of the agent to delete
+      #
+      # @return [Boolean] True if the operation was successful otherwise
+      #   False
+      def delete(name)
+        @api.config("no daemon #{name}") == [{}]
+      end
+    end
+  end
+end

data/lib/puppet_x/eos/modules/extension.rb

@@ -0,0 +1,167 @@
+#
+# 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.
+#
+
+##
+# Eos is the toplevel namespace for working with Arista EOS nodes
+module PuppetX
+  ##
+  # Eapi is module namesapce for working with the EOS command API
+  module Eos
+    ##
+    # The Extensio class provides management of extensions in EOS. Extensions
+    # are simply RPM packages that can loaded onto the switch.  This class
+    # allows installing, deleting and configuring extensions
+    #
+    class Extension
+      BOOTEXT = '/mnt/flash/boot-extensions'
+
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # Retrieves all of the extenions loaded in EOS and returns an array
+      # of hashes using the 'show extensions' command over eAPI.
+      #
+      # Example:
+      #   [{
+      #     "ruby-1.9.3-1.swix": {
+      #       "status": "installed",   # installed, forceInstalled
+      #       "version": "1.9.3.484",
+      #       "presence": "present",
+      #       "release": "32.eos4",
+      #       "numRpms": 10,
+      #       "error": false
+      #     }
+      #   }]
+      #
+      # @return [Hash<Hash<String, String>>] Nested hash describing
+      #   the extension details.  If there are no extensions then an
+      #   empty Hash is returned
+      def get
+        @api.enable('show extensions')
+      end
+
+      ##
+      # Returns if file is loaded on boot or not
+      #
+      # @param [String] name The name of the file
+      #
+      # @return [Boolean] True if it loades on boot otherwise False
+      def autoload?(name)
+        name = URI(name).to_s.split('/')[-1]
+        File.open(BOOTEXT).read.scan(/#{name}[\sforce\n|\n]/).size > 0
+      end
+
+      ##
+      # Copies and installs the extension from a remote server to the
+      # node running EOS using the eAPI coopy command.
+      #
+      # @param [String] url The full url to the RPM
+      # @param [String] force Specifies the use of the force keyword
+      #
+      # @return [Boolean] True if the installation succeeds and False if it
+      #   does not succeed
+      def install(url, force)
+        force = false if force.nil?
+        @api.enable("copy #{url} extension:")
+        load(url, force)
+      end
+
+      ##
+      # Loads an existing extension into EOS.  The extension must already
+      # be copied over to the node using #create
+      #
+      # @params [String] name The name of the extension to load
+      # @param [Hash] opt Options for loading the extions
+      # @option opts [Boolean] :force Appends force to the command
+      #
+      # @return [Boolean] True if the command succeeds or False if it does
+      #   not succeed
+      def load(name, force)
+        name = URI(name).to_s.split('/')[-1]
+        command = "extension #{name}"
+        command << ' force' if force
+        @api.enable(command) == [{}]
+      end
+
+      ##
+      # Uninstalls and removes and extension from an EOS node.  The extension
+      # will be unloaded and deleted from /mnt/flash
+      #
+      # @params [String] name The name of the extension to remove
+      #
+      # @return [Boolean] True if the command succeeds or False if it does
+      #   not succeed
+      def delete(name)
+        name = URI(name).to_s.split('/')[-1]
+        set_autoload(:false, name, false)
+        @api.enable("no extension #{name}")
+        @api.enable("delete extension:#{name}") == [{}]
+      end
+
+      ##
+      # Configures the extension to persistent on system restarts
+      #
+      # @param [String] enabled Whether or not the extension is enabled
+      # @param [String] name The name of the extension
+      # @param[Boolean] force Specifies if the force keyword should be used
+      #
+      # @return [Boolean] True if the extension was set to autoload or False
+      #   if it was not
+      def set_autoload(enabled, name, force)
+        enabled = :true if enabled.nil?
+        force = false if force.nil?
+
+        name = URI(name).to_s.split('/')[-1]
+        entry = "#{name}"
+        entry << ' force' if force
+
+        case enabled
+        when :true
+          if File.open(BOOTEXT).read.scan(/#{name}[\sforce\n|\n]/).size == 0
+            File.open(BOOTEXT, 'a') { |f| f << "#{entry}\n" }
+            return true
+          end
+        when :false
+          contents = File.readlines(BOOTEXT)
+          contents.delete("#{name}\n")
+          File.open(BOOTEXT, 'w') do |f|
+            f.puts(contents)
+          end
+          return true
+        end
+        false
+      end
+    end
+  end
+end

data/lib/puppet_x/eos/modules/interface.rb

@@ -0,0 +1,180 @@
+#
+# 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.
+#
+
+##
+# PuppetX is the toplevel namespace for working with Arista EOS nodes
+module PuppetX
+  ##
+  # Eos is module namesapce for working with the EOS command API
+  module Eos
+    ##
+    # The Interface class provides a base class instance for working with
+    # physical and logical interfaces.
+    #
+    class Interface
+      ##
+      # Initialize instance of Interface
+      #
+      # @param [PuppetX::Eos::Eapi] api An instance of Eapi
+      #
+      # @return [PuppetX::Eos::Interface]
+      def initialize(api)
+        @api = api
+      end
+
+      ##
+      # Returns the base interface hash representing physical and logical
+      # interfaces in EOS using eAPI
+      #
+      # Example
+      #   [{
+      #     "interfaces": {...},
+      #     "interfaceFlowControls": {...}
+      #   }]
+      #
+      # @return [Array<Hash>] returns an Array of Hashes
+      def getall
+        @api.enable(['show interfaces', 'show interfaces flowcontrol'])
+      end
+
+      ##
+      # Configures the interface object back to system wide defaults using
+      # the EOS command api
+      #
+      # @param [String] name The name of the interface
+      #
+      # @return [Boolean] True if it succeeds otherwise False
+      def default(name)
+        @api.config("default interface #{name}") == [{}]
+      end
+
+      ##
+      # Creates a new logical interface on the node.
+      #
+      # @param [String] name The name of the logical interface.  It must be
+      #   a full valid EOS interface name (ie Ethernet, not Et)
+      #
+      # @return [Boolean] True if the command succeeds or False if the command
+      #   fails or is not supported (for instance trying to create a physical
+      #   interface that already exists)
+      def create(name)
+        return false if name.match(/^[Et|Ma]/)
+        @api.config("interface #{name}") == [{}]
+      end
+
+      ##
+      # Deletes an existing logical interface.
+      #
+      # @param [String] name The name of the interface.  It must be a full
+      #   valid EOS interface name (ie Vlan, not Vl)
+      #
+      # @return [Boolean] True if the command succeeds or False if the command
+      #   fails or is not supported (for instance trying to delete a physical
+      #   interface)
+      def delete(name)
+        return false if name.match(/^[Et|Ma]/)
+        @api.config("no interface #{name}") == [{}]
+      end
+
+      ##
+      # Configures the interface shutdown state
+      #
+      # @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 state to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_shutdown(name, opts = {})
+        value = opts[:value] || false
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default shutdown'
+        when false
+          cmds << (value ? 'shutdown' : 'no shutdown')
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+
+      ##
+      # Configures the interface description
+      #
+      # @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 description to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_description(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default description'
+        when false
+          cmds << (value.nil? ? 'no description' : "description #{value}")
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+
+      ##
+      # Configures the interface flowcontrol
+      #
+      # @param [String] name The name of the interface to configure
+      # @param [String] direction One of tx or rx
+      # @param [Hash] opts The configuration parameters for the interface
+      # @option opts [string] :value The value to set the description to
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_flowcontrol(name, direction, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << "default flowcontrol #{direction}"
+        when false
+          cmds << (value.nil? ? "no flowcontrol #{direction}" :
+                                "flowcontrol #{direction} #{value}")
+        end
+        @api.config(cmds) == [{}, {}]
+      end
+    end
+  end
+end