rbeapi 0.5.0 → 0.5.1

data/guide/conf.py

@@ -61,11 +61,11 @@ copyright = u'2016, Arista Networks - EOS+ Consulting Services'
 # built documents.
 #
 import re
-p = re.compile("version\": \"(.*)\"")
-with open("../metadata.json") as f:
-    data = f.read()
-    ver = p.search(data)
-    if ver:
+p = re.compile("VERSION\s=\s'(.*)'")
+with open("../lib/rbeapi/version.rb") as f:
+     data = f.read()
+     ver = p.search(data)
+     if ver:
         version = ver.group(1)
 
 #print "Version: {}".format(version)

data/guide/contributing.rst

@@ -0,0 +1,6 @@
+Contributing
+============
+
+.. contents:: :local:
+
+Contributing pull requests are gladly welcomed for this repository. Please note that all contributions that modify the library behavior require corresponding test cases otherwise the pull request will be rejected. 

data/guide/getting-started.rst

@@ -0,0 +1,134 @@
+Getting Started
+===============
+
+.. contents:: :local:
+
+In order to use rbeapi, the EOS command API must be enabled using management api http-commands configuration mode. This library supports eAPI calls over both HTTP and UNIX Domain Sockets. Once the command API is enabled on the destination node, create a configuration file with the node properities.
+
+Note: The default search path for the conf file is ~/.eapi.conf followed by /mnt/flash/eapi.conf. This can be overridden by setting EAPI_CONF=<path file conf file> in your environment.
+
+Example eapi.conf File
+----------------------
+
+Below is an example of an eAPI conf file. The conf file can contain more than one node. Each node section must be prefaced by connection:<name> where <name> is the name of the connection.
+
+The following configuration options are available for defining node entries:
+
+    host - The IP address or FQDN of the remote device. If the host parameter is omitted then the connection name is used
+    username - The eAPI username to use for authentication (only required for http or https connections)
+    password - The eAPI password to use for authentication (only required for http or https connections)
+    enablepwd - The enable mode password if required by the destination node
+    transport - Configures the type of transport connection to use. The default value is https. Valid values are:
+        socket (available in EOS 4.14.5 or later)
+        http_local (available in EOS 4.14.5 or later)
+        http
+        https
+    port - Configures the port to use for the eAPI connection. A default port is used if this parameter is absent, based on the transport setting using the following values:
+        transport: http, default port: 80
+        transport: https, deafult port: 443
+        transport: https_local, default port: 8080
+        transport: socket, default port: n/a
+    open_timeout - The default number of seconds to wait for the eAPI connection to open. Any number may be used, including Floats for fractional seconds. Default value is 10 seconds.
+    read_timeout - The default number of seconds to wait for one block of eAPI results to be read (via one read(2) call). Any number may be used, including Floats for fractional seconds. Default value is 10 seconds.
+
+Note: See the EOS User Manual found at arista.com for more details on configuring eAPI values.
+
+All configuration values are optional.
+
+[connection:veos01]
+username: eapi
+password: password
+transport: http
+
+[connection:veos02]
+transport: http
+
+[connection:veos03]
+transport: socket
+
+[connection:veos04]
+host: 172.16.10.1
+username: eapi
+password: password
+enablepwd: itsasecret
+port: 1234
+transport: https
+
+[connection:localhost]
+transport: http_local
+
+The above example shows different ways to define EOS node connections. All configuration options will attempt to use default values if not explicitly defined. If the host parameter is not set for a given entry, then the connection name will be used as the host address.
+
+Configuring [connection:localhost]
+----------------------------------
+
+The rbeapi library automatically installs a single default configuration entry for connecting to localhost host using a transport of sockets. If using the rbeapi library locally on an EOS node, simply enable the command API to use sockets and no further configuration is needed for rbeapi to function. If you specify an entry in a conf file with the name [connection:localhost], the values in the conf file will overwrite the default.
+
+Using rbeapi
+------------
+
+The Ruby Client for eAPI was designed to be easy to use and implement for writing tools and applications that interface with the Arista EOS management plane.
+
+Creating a connection and sending commands
+------------------------------------------
+
+Once EOS is configured properly and the config file created, getting started with a connection to EOS is simple. Below demonstrates a basic connection using rbeapi. For more examples, please see the examples folder.
+
+# start by importing the library
+require 'rbeapi/client'
+
+# create a node object by specifying the node to work with
+node = Rbeapi::Client.connect_to('veos01')
+
+# send one or more commands to the node
+node.enable('show hostname')
+node.enable('show hostname')
+=> [{:command=>"show hostname", :result=>{"fqdn"=>"veos01.arista.com", "hostname"=>"veos01"}, :encoding=>"json"}]
+
+# use the config method to send configuration commands
+node.config('hostname veos01')
+=> [{}]
+
+# multiple commands can be sent by using a list (works for both enable or config)
+
+node.config(['interface Ethernet1', 'description foo'])
+=> [{}, {}]
+
+# return the running or startup configuration from the node (output omitted for brevity)
+
+node.running_config
+
+node.startup_config
+
+Using the API
+-------------
+
+The rbeapi library provides both a client for send and receiving commands over eAPI as well as an API for working directly with EOS resources. The API is designed to be easy and straightforward to use yet also extensible. Below is an example of working with the vlans API
+
+# create a connection to the node
+require 'rbeapi/client'
+node = Rbeapi::Client.connect_to('veos01')
+
+# get the instance of the API (in this case vlans)
+vlans = node.api('vlans')
+
+# return all vlans from the node
+vlans.getall
+=> {"1"=>{:name=>"tester", :state=>"active", :trunk_groups=>[]},
+ "4"=>{:name=>"VLAN0004", :state=>"active", :trunk_groups=>[]},
+ "100"=>{:name=>"TEST_VLAN_100", :state=>"active", :trunk_groups=>[]},
+ "300"=>{:name=>"VLAN0300", :state=>"active", :trunk_groups=>[]}}
+
+# return a specific vlan from the node
+vlans.get(1)
+=> {:name=>"tester", :state=>"active", :trunk_groups=>[]}
+
+# add a new vlan to the node
+vlans.create(400)
+=> true
+
+# set the new vlan name
+vlans.set_name(100, value: 'foo')
+=> true
+
+All API implementations developed by Arista EOS+ CS are found in the rbeapi/api folder. See the examples folder for additional examples.

data/guide/index.rst

@@ -12,12 +12,10 @@ Contents:
    :maxdepth: 2
 
    overview
-   quickstart
+   getting-started
    installation
-   cookbook
-   troubleshooting
-   developing
+   upgrading
    testing
-   faq
+   contributing
    release-notes
    license

data/guide/installation.rst

@@ -1,4 +1,59 @@
 Installation
 ============
 
-.. contents:: :local:
+.. contents:: :local:
+
+The source code for rbeapi is provided on Github at http://github.com/arista-eosplus/rbeapi. All current development is done in the develop branch. Stable released versions are tagged in the master branch and uploaded to RubyGems.
+
+    To install the latest stable version of rbeapi, simply run gem install rbeapi
+
+    To install the latest development version from Github, simply clone the develop branch and run
+
+    $ rake build
+    $ rake install
+
+    To create an RPM, run rake rpm
+
+    To generate a SWIX file for EOS with necessary dependencies, run rake all_rpms then follow the swix create instructions, provided by the build. NOTE: PuppetLabs provides a puppet agent SWIX which includes Ruby 1.9.3 in /opt/puppet/bin/ which is different from where you might otherwise install Ruby. If you have installed the puppet-enterprise 3.x SWIX, then you should build and use the rbeapi-puppet3 swix, below. If you have installed the puppet-enterprise 2015.x SWIX, then you should build and use the rbeapi-puppet-aio swix, below. Otherwise, if you have installed at least Ruby 1.9.3 in the standard system location, then the rbeapi SWIX may be used.
+
+    $ bundle install --path .bundle/gems/
+    $ bundle exec rake all_rpms
+    ...
+    RPMs are available in rpms/noarch/
+    Copy the RPMs to an EOS device then run the 'swix create' command.
+    Examples: 
+      Puppet Open Source: 
+        cd /mnt/flash; \
+        swix create rbeapi-0.4.0-1.swix \
+        rubygem-rbeapi-0.4.0-1.eos4.noarch.rpm \
+        rubygem-inifile-3.0.0-3.eos4.noarch.rpm \
+        rubygem-netaddr-1.5.0-2.eos4.noarch.rpm \
+        rubygem-net_http_unix-0.2.1-3.eos4.noarch.rpm
+      Puppet-enterprise agent (3.x): 
+        cd/mnt/flash; \
+        swix create rbeapi-puppet3-0.4.0-1.swix \
+        rubygem-rbeapi-puppet3-0.4.0-1.eos4.noarch.rpm \
+        rubygem-inifile-puppet3-3.0.0-3.eos4.noarch.rpm \
+        rubygem-netaddr-puppet3-1.5.0-2.eos4.noarch.rpm
+      Puppet-All-in-one agent (2015.x/4.x): 
+        cd/mnt/flash; \
+        swix create rbeapi-puppet-aio-0.4.0-1.swix \
+        rubygem-rbeapi-puppet-aio-0.4.0-1.eos4.noarch.rpm \
+        rubygem-inifile-puppet-aio-3.0.0-3.eos4.noarch.rpm \
+        rubygem-netaddr-puppet-aio-1.5.0-2.eos4.noarch.rpm \
+        rubygem-net_http_unix-puppet-aio-0.2.1-3.eos4.noarch.rpm
+
+    On EOS:
+
+    Arista# copy <URI-to-RPMs> flash:
+    Arista# bash
+    -bash-4.1# cd /mnt/flash/
+    -bash-4.1# swix create rbeapi-puppet3-0.4.0-1.swix \
+               rubygem-rbeapi-puppet3-0.4.0-1.eos4.noarch.rpm \
+               rubygem-inifile-puppet3-3.0.0-1.eos4.noarch.rpm \
+               rubygem-netaddr-puppet3-1.5.0-1.eos4.noarch.rpm
+    -bash-4.1# exit
+    Arista# copy flash:rbeapi-puppet3-0.4.0-1.swix extension:
+    Arista# extension rbeapi-puppet3-0.4.0-1.swix
+    Arista# copy installed-extensions boot-extensions
+

data/guide/license.rst

@@ -1,5 +1,16 @@
 License
 =======
 
-.. include:: ../LICENSE
-   :literal:
+.. contents:: :local:
+
+Copyright (c) 2015, 2016, 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.

data/guide/overview.rst

@@ -3,17 +3,14 @@ Overview
 
 .. contents:: :local:
 
-Introduction
-------------
-
 The Ruby Client for eAPI provides a native Ruby implementation for programming Arista EOS network devices using Ruby.  The Ruby client provides the ability to build native applications in Ruby that can communicate with EOS either locally via Unix domain sockets (on-box) or remotely over a HTTP/S transport (off-box).  It uses a standard INI-style configuration file to specifiy one or more connection profiles.
 
 The rbeapi implemenation also provides an API layer for building native Ruby objects that allow for configuration and state extraction of EOS nodes.  The API layer provides a consistent implementation for working with EOS configuration resources.  The implementation of the API layer is highly extensible and can be used as a foundation for building custom data models.
 
 The libray is freely provided to the open source community for building robust applications using Arista EOS eAPI.  Support is provided as best effort through Github iusses.
 
-Prerequisites
--------------
+Requirements
+------------
 
 * Arista EOS 4.12 or later
 * Arista eAPI enabled for at least one transport (see official EOS Config Guide at arista.com for details)

data/guide/testing.rst

@@ -1,4 +1,8 @@
 Testing Modules
 ===============
 
-.. contents:: :local:
+.. contents:: :local:
+
+The rbeapi library provides spec tests. To run the spec tests, you will need to update the dut.conf file found in spec/fixtures. The switch used for testing should have at least interfaces Ethernet1-7.
+
+    To run the spec tests, run bundle exec rspec spec from the root of the rbeapi source folder.

data/guide/upgrading.rst

@@ -0,0 +1,10 @@
+Upgrading
+=========
+
+.. contents:: :local:
+
+On EOS:
+
+  Arista# no extension pe-rbeapi-0.3.0-1.swix
+  Arista# extension rbeapi-puppet3-0.4.0-1.swix
+  Arista# copy installed-extensions boot-extensions

data/lib/rbeapi/api.rb

@@ -32,14 +32,14 @@
 require 'rbeapi/eapilib'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
   # Rbeapi::Api
   module Api
     ##
     # The Entity class provides a base class implementation for building
-    # API modules.  The Entity class is typically not instantiated directly
+    # API modules. The Entity class is typically not instantiated directly
     # but serves as a super class with convenience methods used to
     # work with the node.
     class Entity
@@ -50,56 +50,56 @@ module Rbeapi
       ##
       # Construct the node.
       #
-      # @param [Node] :node An instance of Rbeapi::Client::Node used to
-      #   send and receive eAPI messages
+      # @param node [Node] An instance of Rbeapi::Client::Node used to
+      #   send and receive eAPI messages.
       def self.instance(node)
         new(node)
       end
 
       ##
       # The Entity class provides a base class implementation for building
-      # API modules.  The Entity class is typically not instantiated directly
+      # API modules. The Entity class is typically not instantiated directly
       # but serves as a super class with convenience methods used to
       # work with the node.
       #
-      # @param [Node] :node This should be an instance of Rbeapi::Client::Node
-      #   that is used to send and receive eAPI messages
+      # @param node [Node] This should be an instance of Rbeapi::Client::Node
+      #   that is used to send and receive eAPI messages.
       #
       def initialize(node)
         @node = node
       end
 
       ##
-      # Returns the running configuration from the node instance.  This is
+      # Returns the running configuration from the node instance. This is
       # a convenience method to easily access the current running config
-      # from an API module
+      # from an API module.
       #
-      # @return [String] The current running-config from the node
+      # @return [String] The current running-config from the node.
       def config
         @node.running_config
       end
 
       ##
       # Provides a convenience method for access the connection error (if
-      # one exists) of the node's connection instance
+      # one exists) of the node's connection instance.
       #
       # @return [Rbeapi::Eapilib::CommandError] An instance of CommandError
-      #   that can be used to further evaluate the root cause of an error
+      #   that can be used to further evaluate the root cause of an error.
       def error
         @node.connection.error
       end
 
       ##
       # Returns a block of configuration from the current running config
-      # as a string.  The argument is used to search the config and return
+      # as a string. The argument is used to search the config and return
       # the text along with any child configuration statements.
       #
-      # @param [String] :text The text to be used to find the parent line
+      # @param text [String] The text to be used to find the parent line
       #   in the nodes configuration.
       #
-      # @returns [nil, String] Returns the block of configuration based on
-      #   the supplied argument.  If the argument is not found in the
-      #   configuration, nil is returned
+      # @return [nil, String] Returns the block of configuration based on
+      #   the supplied argument. If the argument is not found in the
+      #   configuration, nil is returned.
       def get_block(text)
         mdata = /^#{text}$/.match(config)
         return nil unless mdata
@@ -115,16 +115,16 @@ module Rbeapi
       end
 
       ##
-      # Method called to send configuration commands to the node.  This method
+      # Method called to send configuration commands to the node. This method
       # will send the commands to the node and rescue from CommandError or
       # ConnectionError.
       #
-      # @param [String, Array] :commands The commands to send to the node over
-      #   the API connection to configure the system
+      # @param commands [String, Array] The commands to send to the node over
+      #   the API connection to configure the system.
       #
       # @return [Boolean] Returns True if the commands were successful or
       #   returns False if there was an error issuing the commands on the
-      #   node.  Use error to further investigate the cause of any errors
+      #   node.  Use error to further investigate the cause of any errors.
       def configure(commands)
         @node.config(commands)
         return true
@@ -134,26 +134,27 @@ module Rbeapi
 
       ##
       # Method called to build the correct version of a command based on
-      # the modifier options.  If value option is set then it is appended
+      # the modifier options. If value option is set then it is appended
       # to the command. If the enable option is false then the 'no'
-      # keyword is prefixed to the command.  If the default value is
-      # provided and set to true, then the default keyword is used.  If
+      # keyword is prefixed to the command. If the default value is
+      # provided and set to true, then the default keyword is used. If
       # both options are provided, then default option takes precedence.
       #
-      # @param [String, Array] :commands The commands to send to the node
-      #   over the API connection to configure the system
-      # @param [Hash] :opts the options for the command
+      # @param cmd [String, Array] The commands to send to the node
+      #   over the API connection to configure the system.
       #
-      # @option :opts  [String] :value Optional value that is
+      # @param opts [Hash] The options for the command.
+      #
+      # @option opts value [String] Optional value that is
       #   appended to the command if set.
       #
-      # @option :opts  [Boolean] :enable Prefix the command with 'no'.
+      # @option opts enable [Boolean] Prefix the command with 'no'.
       #   Default is true.
       #
-      # @option :opts  [Boolean] :default Configure the command using
+      # @option opts default [Boolean] Configure the command using
       #   the default keyword. Default is false.
       #
-      # @return [String] Returns built command string
+      # @return [String] Returns built command string.
       def command_builder(cmd, opts = {})
         enable = opts.fetch(:enable, true)
         default = opts.fetch(:default, false)
@@ -167,13 +168,13 @@ module Rbeapi
       # configure_interface sends the commands over eAPI to the destination
       # node to configure a specific interface.
       #
-      # @param [String] :name The interface name to apply the configuration
-      #   to.  The name value must be the full interface identifier
+      # @param name [String] The interface name to apply the configuration
+      #   to. The name value must be the full interface identifier.
       #
-      # @param [Array] :commands The list of commands to configure the
-      #   interface
+      # @param commands [Array] The list of commands to configure the
+      #   interface.
       #
-      # @return [Boolean] Returns true if the commands complete successfully
+      # @return [Boolean] Returns true if the commands complete successfully.
       def configure_interface(name, commands)
         commands = [*commands]
         commands.insert(0, "interface #{name}")