arista-eapi 0.10.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env
+test.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arista-eapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Imbriaco
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Arista::EAPI
+
+This gem is designed to make it easy to interact with the Command API that
+was introduced by Arista Networks in EOS version 4.12.0.
+
+This is very much an early work in progress. Patches welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arista-eapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arista-eapi
+
+## Usage
+
+The primary method for interacting with the gem is via the ```Arista::EAPI::Switch#run``` method.
+
+```
+switch = Arista::EAPI::Switch.new(hostname, user, password)
+switch.version
+#=>
+{:model_name=>"DCS-7048T-A-R", :internal_version=>"4.12.0-1244071.EOS4120", :system_mac_address=>"00:1c:73:16:c2:c8", :serial_number=>"redacted", :mem_total=>4009152, :bootup_timestamp=>1368735672.690161, :mem_free=>1848284, :version=>"4.12.0", :architecture=>"i386", :internal_build_id=>"c25ec8ea-cb8f-40a8-af0b-d11eaa94d57c", :hardware_revision=>"01.04"}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/arista-eapi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arista/eapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arista-eapi"
+  spec.version       = Arista::EAPI::VERSION
+  spec.authors       = ["Mark Imbriaco"]
+  spec.email         = ["mark@imbriaco.com"]
+  spec.description   = %q{Client for Arista Networks eAPI}
+  spec.summary       = %q{Arista eAPI Client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency 'json', '~> 1.7.7'
+end

data/examples/save_config.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'arista/eapi'
+
+user = ENV['EAPI_USER']
+password = ENV['EAPI_PASSWORD']
+all = %w(switch1.example.com switch2.example.com)
+
+all.each do |hostname|
+  print "Saving configuration for #{hostname} ... "
+
+  outdir = File.join(File.dirname(__FILE__), hostname)
+  File.directory?(outdir) || FileUtils.mkdir(outdir)
+
+  sw = Arista::EAPI::Switch.new(hostname, user, password)
+  results = sw.run('enable', 'show running-config')
+
+  File.open(File.join(outdir, 'startup-config'), 'w') do |f|
+    results.each do |res|
+      next if res[:output] == ''
+      f.puts res[:output]
+    end
+  end
+
+  puts "done."
+end
+

data/lib/arista/eapi.rb

@@ -0,0 +1,32 @@
+
+require 'cgi'
+require 'json'
+require 'restclient'
+
+require 'arista/eapi/format'
+require 'arista/eapi/parser'
+require 'arista/eapi/parser/show'
+require 'arista/eapi/request'
+require 'arista/eapi/response'
+require 'arista/eapi/switch'
+require 'arista/eapi/version'
+
+module Arista
+  module EAPI
+    # Public: Determine the eAPI supported format based on the commands. 
+    #
+    # options - List of commands to check format options for.
+    #
+    # Examples
+    #
+    #   Arista::EAPI.format_for('show vlan') 
+    #   #=> 'json'
+    #   Arista::EAPI.format_for('show vlan', 'show lldp neighbors') 
+    #   #=> text
+    #
+    # Returns json if all commands support JSON output, otherwise returns text.
+    def self.format_for(*commands)
+      (commands.flatten - Arista::EAPI::Format::JSON_COMMANDS).size > 0 ? 'text' : 'json'
+    end
+  end
+end

data/lib/arista/eapi/format.rb

@@ -0,0 +1,27 @@
+class Arista::EAPI::Format
+  JSON_COMMANDS = [
+    'show aliases',
+    'show interfaces',
+    'show interfaces counters',
+    'show interfaces counters discards',
+    'show interfaces status',
+    'show interfaces switchport vlan mapping',
+    'show ip interface',
+    'show ipv6 interface',
+    'show mac address-table',
+    'show mac address-table aging-time',
+    'show management api http-commands',
+    'show management api http-commands certificate',
+    'show monitor server-failure history',
+    'show monitor server-failure servers',
+    'show monitor session',
+    'show privilege',
+    'show sflow',
+    'show sflow interfaces',
+    'show spanning-tree topology status',
+    'show version',
+    'show version license',
+    'show vlan',
+    'show vlan trunk group',
+  ]
+end

data/lib/arista/eapi/parser.rb

@@ -0,0 +1,16 @@
+class Arista::EAPI::Parser
+  def self.parse(command, body)
+    parser_class = command.split.first.downcase.capitalize
+    parser_method = command.gsub(/\s/, '_')
+
+    parser = self.const_get(parser_class)
+
+    if parser.respond_to?(parser_method.to_sym)
+      parser.send(parser_method, body)
+    else
+      body
+    end
+  rescue NameError
+    body
+  end
+end

data/lib/arista/eapi/parser/show.rb

@@ -0,0 +1,26 @@
+class Arista::EAPI::Parser::Show
+  class << self
+    def show_lldp_neighbors(body)
+      lldp = { 
+        :last_update => nil,
+        :ports => {}
+      }
+
+      lldp[:last_update] = body.match(/^Last table change time\s+:\s(?<last_update>.*?)$/m)[:last_update]
+      ports = body.match(/.*Neighbor Port ID\s*TTL\s(?<ports>.*)/m)[:ports]
+
+      unless ports.nil?
+        ports.split("\n").each do |line|
+          name, neighbor_device_id, neighbor_port_id, ttl = line.split
+          lldp[:ports][name] = {
+            :neighbor_device_id => neighbor_device_id,
+            :neighbor_port_id   => neighbor_port_id,
+            :ttl                => ttl
+          }
+        end
+      end
+
+      { :lldp_neighbors => lldp }
+    end
+  end
+end

data/lib/arista/eapi/request.rb

@@ -0,0 +1,30 @@
+class Arista::EAPI::Request
+  attr_accessor :switch, :commands
+
+  def initialize(switch, *commands)
+    self.switch = switch
+    self.commands = commands
+  end
+
+  def payload
+    @payload ||= JSON.generate({
+      :jsonrpc => '2.0',
+      :method  => 'runCmds',
+      :id      => 1,
+      :params  => {
+        :version => 1,
+        :cmds    => commands,
+        :format  => Arista::EAPI.format_for(commands)
+      },
+    })
+  end
+
+  def execute
+    Arista::EAPI::Response.new(commands, RestClient.post(switch.url, payload))
+  end
+
+  def self.execute!(switch, *commands)
+    req = self.new(switch, *commands)
+    req.execute
+  end
+end

data/lib/arista/eapi/response.rb

@@ -0,0 +1,75 @@
+module Arista
+  module EAPI
+    module Error
+      class GeneralError < Exception ; end
+      class InternalException < Exception ; end
+      class InvalidCommand < Exception; end
+      class TextOnly < Exception; end
+      class IncomptibleCommand < Exception; end
+      class AmbiguousCommand < Exception; end
+    end
+
+    class Response
+      ERROR_CODES = {
+        1000 => Arista::EAPI::Error::GeneralError,
+        1001 => Arista::EAPI::Error::InternalException,
+        1002 => Arista::EAPI::Error::InvalidCommand,
+        1003 => Arista::EAPI::Error::TextOnly,
+        1004 => Arista::EAPI::Error::IncomptibleCommand,
+        1005 => Arista::EAPI::Error::AmbiguousCommand
+      }
+
+      PARSERS = [ Arista::EAPI::Parser::Show ]
+
+      attr_accessor :code, :response, :results
+
+      def initialize(commands, body)
+        self.response = JSON.parse(body)
+        self.results = []
+
+        if response['error']
+          code = response['error']['code']
+          raise code < 0 ? Exception.new(response['message']) : ERROR_CODES[code]
+        end
+
+        commands.each_with_index do |cmd, idx|
+          results << process_result(cmd, response['result'][idx])
+        end
+
+        results
+      end
+
+      def process_result(cmd, result)
+        case Arista::EAPI.format_for(cmd)
+        when 'json' then
+          convert_hash_keys(result)
+        else
+          Arista::EAPI::Parser.parse(cmd, result['output'])
+        end
+      end
+
+      private
+
+      def symbolize(obj)
+        obj.is_a?(Symbol) ? obj :
+          obj.
+            gsub(/\//, '_').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            downcase.
+            to_sym
+      end
+
+      def convert_hash_keys(value)
+        case value
+          when Array
+            value.map { |v| convert_hash_keys(v) }
+          when Hash
+            Hash[value.map { |k, v| [symbolize(k), convert_hash_keys(v)] }]
+          else
+            value
+         end
+      end    
+    end
+  end
+end

data/lib/arista/eapi/switch.rb

@@ -0,0 +1,32 @@
+class Arista::EAPI::Switch
+  attr_accessor :hostname, :user, :password, :protocol, :url, :attributes
+
+  def initialize(hostname, user, password, protocol = 'https')
+    self.attributes = {}
+    self.hostname = hostname
+    self.user = user
+    self.password = password
+    self.protocol = protocol
+
+    userpass = [ CGI.escape(user), CGI.escape(password) ].join(':')
+    self.url = "#{protocol}://#{userpass}@#{hostname}/command-api"
+  end
+
+  def interfaces
+    run('show interfaces')
+    attributes[:interfaces]
+  end
+
+  def version
+    run('show version').first
+  end
+
+  def update_attributes!(results)
+    results.each { |result| attributes.merge!(result) if result.is_a?(Hash) }
+  end
+
+  def run(*commands)
+    request = Arista::EAPI::Request.new(self, *commands)
+    self.update_attributes!(request.execute.results)
+  end
+end

data/lib/arista/eapi/version.rb

@@ -0,0 +1,5 @@
+module Arista
+  module EAPI
+    VERSION = "0.10.0"
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: arista-eapi
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Imbriaco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: Client for Arista Networks eAPI
+email:
+- mark@imbriaco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arista-eapi.gemspec
+- examples/save_config.rb
+- lib/arista/eapi.rb
+- lib/arista/eapi/format.rb
+- lib/arista/eapi/parser.rb
+- lib/arista/eapi/parser/show.rb
+- lib/arista/eapi/request.rb
+- lib/arista/eapi/response.rb
+- lib/arista/eapi/switch.rb
+- lib/arista/eapi/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Arista eAPI Client
+test_files: []