oxidized-fetch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0c4b2b86e5ad256c3ef70ec1282bb8becbb743d
+  data.tar.gz: 14e2787491aadda46d897fca3dd8e6dacac29c7b
+SHA512:
+  metadata.gz: 98c8073936a2ce62ce747a3ccb0dc44cd690351160b2ddbfb2791ee217bfdb042dacbc9f00def9ee9686ee0031871776c2b2aeeb00d9837b82a45ee026a67c1b
+  data.tar.gz: a7fec564b70acf8ee646c5c04b0c56eec499d95bb52006695590a3a92195f8b9b5d025ea5956f4c2d42a4d453fd571d9c27e0676445388c03291ad762db4fc89

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/README.md

@@ -0,0 +1 @@
+# oxidized-fetch

data/Rakefile

@@ -0,0 +1,46 @@
+begin
+  require 'rake/testtask'
+  require 'bundler'
+  # Bundler.setup
+rescue LoadError
+  warn 'bunler missing'
+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 -Es 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/oxf

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

data/lib/oxidized/fetch/cli.rb

@@ -0,0 +1,50 @@
+module Oxidized
+  require_relative 'fetch'
+  require 'slop'
+  class Fetch
+    class CLI
+      class CLIError < ScriptError; end
+      class NothingToDo < ScriptError; end
+
+      def run
+        connect
+      end
+
+      private
+
+      def initialize
+        @args, @opts = opts_parse
+        CFG.debug = true if @opts[:debug]
+        @host = @args.shift
+        @oxf  = nil
+        raise NothingToDo, 'no host given' if not @host
+      end
+
+      def opts_parse
+        slop = Slop.new(:help=>true)
+        slop.banner 'Usage: oxf [options] hostname'
+        slop.on 'm=', '--model',     'host model (ios, junos, etc), otherwise discovered from Oxidized source'
+        slop.on 'u=', '--username',  'username to use'
+        slop.on 'p=', '--password',  'password to use'
+        slop.on 't=', '--timeout',   'timeout value to use'
+        slop.on 'e=', '--enable',    'enable password to use'
+        slop.on 'c=', '--community', 'snmp community to use for discovery'
+        slop.on       '--protocols=','protocols to use, default "ssh, telnet"'
+        slop.on 'v',  '--verbose',   'verbose output, e.g. show commands sent'
+        slop.on 'd',  '--debug',     'turn on debugging'
+        slop.on :terse, 'display clean output'
+        slop.parse
+        [slop.parse!, slop]
+      end
+
+      def connect
+        opts = {}
+        opts[:host]     = @host
+        [:model, :username, :password, :timeout, :enable, :verbose, :community, :protocols].each do |key|
+          opts[key] = @opts[key] if @opts[key]
+        end
+        @oxf = Fetch.new opts
+      end
+    end
+  end
+end

data/lib/oxidized/fetch/fetch.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+module Oxidized
+  require 'oxidized'
+  class Fetch
+    attr_reader :model
+
+    class ScriptError   < OxidizedError; end
+    class NoNode        < ScriptError;   end
+    class InvalidOption < ScriptError;   end
+    class NoConnection  < ScriptError
+      attr_accessor :node_error
+    end
+
+    private
+
+    # @param [Hash] opts options for Oxidized::Fetch
+    # @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
+    # @option opts [String]  :community community to use for discovery
+    # @option opts [String]  :protocols protocols to use to connect, default "ssh ,telnet"
+    # @option opts [boolean] :verbose   extra output, e.g. show command given in output
+    # @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
+      community   = opts.delete :community
+      @verbose    = opts.delete :verbose
+      CFG.input.default = opts.delete :protocols if opts[:protocols]
+      raise InvalidOption, "#{opts} not recognized" unless opts.empty?
+
+      @@oxi ||= false
+      if not @@oxi
+        Oxidized.mgr = Manager.new
+        @@oxi = true
+      end
+
+      @node = if model
+        Node.new(:name=>host, :model=>model)
+      else
+        Nodes.new(:node=>host).first
+      end
+      if not @node
+        begin
+          require 'corona'
+          community ||= Corona::CFG.community
+        rescue LoadError
+          raise NoNode, 'node not found'
+        end
+        node = Corona.poll :host=>host, :community=>community
+        raise NoNode, 'node not found' unless node
+        @node = Node.new :name=>host, :model=>node[:model]
+      end
+      @node.auth[:username] = username if username
+      @node.auth[:password] = password if password
+      CFG.vars.enable = enable if enable
+      CFG.timeout = timeout if timeout
+
+      status, config = @node.run
+      if status == :success
+        msg = "update #{@node.name}"
+        msg += " from #{@node.from}" if @node.from
+        msg += " with message '#{@node.msg}'" if @node.msg
+        if @node.output.new.store @node.name, config, :msg => msg, :user => @node.user, :group => @node.group
+          STDERR.write "Configuration updated for #{@node.group}/#{@node.name}\n" if @verbose
+          exit 1
+        end
+        STDERR.write "Configuration NOT updated for #{@node.group}/#{@node.name}\n" if @verbose
+        exit 0
+      else
+        STDERR.write "An unexpected error occurred\n" if @verbose
+        exit -1
+      end
+    end
+  end
+end

data/lib/oxidized/fetch.rb

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

data/oxidized-fetch.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name              = 'oxidized-fetch'
+  s.version           = '0.1.0'
+  s.licenses          = %w( Apache-2.0 )
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = [ 'Giovanni Lovato', 'Alex Tomasello' ]
+  s.email             = %w( heruan@aldu.net )
+  s.homepage          = 'http://github.com/heruan/oxidized-fetch'
+  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( oxf )
+  s.require_path      = 'lib'
+
+  s.add_runtime_dependency 'oxidized', '~> 0.2'
+  s.add_runtime_dependency 'slop',     '~> 3.5'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: oxidized-fetch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Giovanni Lovato
+- Alex Tomasello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oxidized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: rancid clogin-like script to push configs to devices + library interface
+  to do same
+email:
+- heruan@aldu.net
+executables:
+- oxf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/oxf
+- lib/oxidized/fetch.rb
+- lib/oxidized/fetch/cli.rb
+- lib/oxidized/fetch/fetch.rb
+- oxidized-fetch.gemspec
+homepage: http://github.com/heruan/oxidized-fetch
+licenses:
+- Apache-2.0
+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-fetch
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: cli + library for scripting network devices
+test_files: []