oxidized-script 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea2afb0bc4bb68667bc29704bde3f1a70cb591f4
+  data.tar.gz: 0121bfb120faa8af163da27cb0e302324df8811d
+SHA512:
+  metadata.gz: d850980e48c31ba44f5618906219ab8b5618e4002aa6d8bf1e240b02f1c8aee4d6bd41c7247e1fb1659d26133d32acf71e3a6d37e628d0adc7be75a7089701c1
+  data.tar.gz: ea183301f772e8035bbbe49b38473ccc5a2a4b80994a50273f8c0fa9df0b924cad986b07a289d0b1868069514d2de3bee8660c4361c99817a3aff4db93db8d7c

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+gems

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+# Oxidized Script
+CLI and Library to interface with network devices in Oxidized
+
+## Install
+ % gem install oxidized-script
+
+## Use
+
+### CLI
+```
+[fisakytt@lan-login1 ~]% oxs S-2250220 'sh ver'
+                Jan 29 2010 12:18:24
+                K.14.54
+                79
+[fisakytt@lan-login1 ~]% cat > cmds
+show ip route
+[fisakytt@lan-login1 ~]% oxs -x cmds 62.236.123.199
+Default gateway is 62.236.123.198
+
+Host               Gateway           Last Use    Total Uses  Interface
+ICMP redirect cache is empty
+[fisakytt@lan-login1 ~]% cat >> cmds
+sh ip cef
+[fisakytt@lan-login1 ~]% cat cmds|oxs -x- 62.236.123.199
+Default gateway is 62.236.123.198
+
+Host               Gateway           Last Use    Total Uses  Interface
+ICMP redirect cache is empty
+%IPv4 CEF not running
+[fisakytt@lan-login1 ~]% oxs --help
+Usage: oxs [options] hostname [command]
+    -m, --model         host model (ios, junos, etc), otherwise discovered from Oxidized source
+    -x, --commands      commands file to be sent
+    -u, --username      username to use
+    -p, --password      password to use
+    -t, --timeout       timeout value to use
+    -e, --enable        enable password to use
+    -d, --debug         turn on debugging
+    -h, --help          Display this help message.
+[fisakytt@lan-login1 ~]% 
+```
+
+### Library
+```
+[fisakytt@lan-login1 ~]% cat moi42.b 
+#!/usr/bin/env ruby
+
+require 'oxidized/script'
+
+Oxidized::Script.new(:host=>'62.236.123.199') do |oxs|
+  puts oxs.cmd 'show mac address-table dynamic vlan 101'
+end
+[fisakytt@lan-login1 ~]% ./moi42.b 
+          Mac Address Table
+-------------------------------------------
+
+Vlan    Mac Address       Type        Ports
+----    -----------       --------    -----
+ 101    44d3.ca4c.383e    DYNAMIC     Gi0/1
+[fisakytt@lan-login1 ~]% 
+```
+
+## TODO
+  * Interactive use?
+  * Tests+docs, as always :(

data/Rakefile

@@ -0,0 +1,47 @@
+begin
+  require 'rake/testtask'
+  require 'bundler'
+  Bundler.setup
+rescue LoadError
+  warn 'bunler missing'
+  exit 42
+end
+
+gemspec = eval(File.read(Dir['*.gemspec'].first))
+file    = [gemspec.name, gemspec.version].join('-') + '.gem'
+
+desc 'Validate gemspec'
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run minitest'
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs.push "lib"
+    t.test_files = FileList['spec/*_spec.rb']
+    t.verbose = true
+  end
+end
+
+desc 'Build gem'
+task :build do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p 'gems'
+  FileUtils.mv file, 'gems'
+end
+
+desc 'Install gem'
+task :install => :build do
+  system "sudo -E sh -c \'umask 022; gem install gems/#{file}\'"
+end
+
+desc 'Remove gems'
+task :clean do
+  FileUtils.rm_rf 'gems'
+end
+
+desc 'Push to rubygems'
+task :push do
+  system "gem push gems/#{file}"
+end

data/bin/oxs

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'oxidized/script/cli'
+  puts Oxidized::Script::CLI.new.run
+rescue => error
+  warn "#{error}"
+  raise if Oxidized::CFG.debug
+end

data/lib/oxidized/script.rb

@@ -0,0 +1 @@
+require_relative 'script/script'

data/lib/oxidized/script/cli.rb

@@ -0,0 +1,67 @@
+module Oxidized
+  require_relative 'script'
+  require 'slop'
+  class Script
+    class CLI
+      class CLIError < ScriptError; end
+      class NothingToDo < ScriptError; end
+
+      def run
+        connect
+        if @opts[:commands]
+          run_file @opts[:commands]
+        elsif @cmd
+          @oxs.cmd @cmd
+        end
+      end
+
+      private
+
+      def initialize
+        args, @opts = opts_parse
+        CFG.debug = true if @opts[:debug]
+        @host = args.shift
+        @cmd  = args.shift if args
+        @oxs  = nil
+        raise NothingToDo, 'no host given' if not @host
+        raise NothingToDo, 'nothing to do, give command or -x' if not @cmd and not @opts[:commands]
+      end
+
+      def opts_parse
+        slop = Slop.parse(:help=>true) do
+          banner 'Usage: oxs [options] hostname [command]'
+          on 'm=', '--model',    'host model (ios, junos, etc), otherwise discovered from Oxidized source'
+          on 'x=', '--commands', 'commands file to be sent'
+          on 'u=', '--username', 'username to use'
+          on 'p=', '--password', 'password to use'
+          on 't=', '--timeout',  'timeout value to use'
+          on 'e=', '--enable',   'enable password to use'
+          on 'd',  '--debug',    'turn on debugging'
+        end
+        [slop.parse!, slop]
+      end
+
+      def connect
+        opts = {}
+        opts[:host]     = @host
+        opts[:model]    = @opts[:model] if @opts[:model]
+        opts[:username] = @opts[:username] if @opts[:username]
+        opts[:password] = @opts[:password] if @opts[:password]
+        opts[:timeout]  = @opts[:timeout].to_i if @opts[:timeout]
+        opts[:enable]   = @opts[:enable] if @opts[:enable]
+        @oxs = Script.new opts
+      end
+
+      def run_file file
+        out = ''
+        file = file == '-' ? $stdin : File.read(file)
+        file.each_line do |line|
+          line.sub!(/\\n/, "\n") # tread escaped newline as newline
+          out += @oxs.cmd line
+        end
+        out
+      end
+
+    end
+  end
+end

data/lib/oxidized/script/script.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+module Oxidized
+  require 'oxidized'
+  class Script
+    class ScriptError   < OxidizedError; end
+    class NoConnection  < ScriptError;   end
+    class NoNode        < ScriptError;   end
+    class InvalidOption < ScriptError;   end
+
+    # @param [String] command command to be sent
+    # @return [String] output for command
+    def cmd command
+      @model.cmd command
+    end
+
+    # disconnects from ssh/telnet session
+    # @return [void]
+    def disconnect
+      @input.disconnect_cli
+    end
+    alias_method :close, :disconnect
+
+    private
+
+    # @param [Hash] opts options for Oxidized::Script
+    # @option opts [String] :host      hostname or ip address for Oxidized::Node
+    # @option opts [String] :model     node model (ios, junos etc) if defined, nodes are not loaded from source
+    # @option opts [Fixnum] :timeout   oxidized timeout
+    # @option opts [String  :username  username for login
+    # @option opts [String  :passsword password for login
+    # @option opts [String  :enable    enable password to use
+    # @yieldreturn [self] if called in block, returns self and disconnnects session after exiting block
+    # @return [void]
+    def initialize opts, &block
+      host     = opts.delete :host
+      model    = opts.delete :model
+      timeout  = opts.delete :timeout
+      username = opts.delete :username
+      password = opts.delete :password
+      enable  =  opts.delete :enable
+      raise InvalidOption, "#{opts} not recognized" unless opts.empty?
+      Oxidized.mgr = Manager.new
+      @node = if model
+        Node.new(:name=>host, :model=>model)
+      else
+        Nodes.new(:node=>host).first
+      end
+      raise NoNode, 'node not found' unless @node
+      @node.auth[:username] = username if username
+      @node.auth[:password] = password if password
+      CFG.vars[:enable] = enable if enable
+      CFG.timeout = timeout if timeout
+      @model = @node.model
+      @input = nil
+      connect
+      if block_given?
+        yield self
+        disconnect
+      end
+    end
+
+    def connect
+      @node.input.each do |input|
+        begin
+          @node.model.input = input.new
+          @node.model.input.connect @node
+          break
+        rescue
+        end
+      end
+      @input = @node.model.input
+      raise NoConnection, 'unable to connect' unless @input.connected?
+      @input.connect_cli
+    end
+  end
+end

data/oxidized-script.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name              = 'oxidized-script'
+  s.version           = '0.0.1'
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = [ 'Saku Ytti' ]
+  s.email             = %w( saku@ytti.fi )
+  s.homepage          = 'http://github.com/ytti/oxidized-script'
+  s.summary           = 'cli + library for scripting network devices'
+  s.description       = 'rancid clogin-like script to push configs to devices + library interface to do same'
+  s.rubyforge_project = s.name
+  s.files             = `git ls-files`.split("\n")
+  s.executables       = %w( oxs )
+  s.require_path      = 'lib'
+
+  #s.add_dependency 'oxidized'
+  s.add_dependency 'slop'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: oxidized-script
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Saku Ytti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: rancid clogin-like script to push configs to devices + library interface
+  to do same
+email:
+- saku@ytti.fi
+executables:
+- oxs
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/oxs
+- lib/oxidized/script.rb
+- lib/oxidized/script/cli.rb
+- lib/oxidized/script/script.rb
+- oxidized-script.gemspec
+homepage: http://github.com/ytti/oxidized-script
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: oxidized-script
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: cli + library for scripting network devices
+test_files: []