oxidized-script 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f616aaf84a8c98cde89b1ca52104e3f810c4d7
-  data.tar.gz: fe960f7e73823e8edd1924c80de37b3728389aee
+  metadata.gz: 1a38be515ce13472269675c5686f022207c5f394
+  data.tar.gz: 8a08ffbdbe0aa0326d32aaa9c9b59435ca4af3a1
 SHA512:
-  metadata.gz: e68f12a94f56a3ad29ba5739696641bd31f1986929b680ff066121bc8cc9346edea4e1dfee878a84b385507dd547e6a0df41debc4d9cfc624d86343730608ba0
-  data.tar.gz: 8d2a39122c5a1003478e7cf10a544867cae6c130029e9b59b413f83e848aa109486a6844f85fc94a9d5cc0841572bf3d60df9c71c9e5b0e852ef361b27567ef0
+  metadata.gz: 8e0d9f0226991efd74bfb9a4896ed7b896f8f2b5ad86736047aa780c041dae5f77d343506720e975cac80e455fd22a7adf3aa6d7376dd18e64e057f53146c481
+  data.tar.gz: dff10d69c6fc2e601f8c030465541dff60a086fcd354a7054ea3570981d893abc7b9c667ba4af43f14373ba0b1441d89b20ca3ca97ead77599c8163eaf2633ff

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 gems
+*.swp

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.0
+- FEATURE on --regex to run commands on hosts matching a regex (by @nertwork)
+- FEATURE on -g to run commands on entire group (by @nertwork)
+- FEATURE on -r to thread commands run on entire group (by @nertwork)
+- BUGFIX: fix for replacing escaped newlines in config files (by @nertwork)
+
 # 0.2.0
 - FEATURE on -x disable ssh exec mode (by @nickhilliard)
 

data/README.md

@@ -27,17 +27,36 @@ Default gateway is 62.236.123.198
 Host               Gateway           Last Use    Total Uses  Interface
 ICMP redirect cache is empty
 %IPv4 CEF not running
+
+[nertwork@lan-login2 ~]% oxs --verbose --group ios --threads 4 --regex ^test 'show vrf'
+running list for hosts in group: ios and matching: ^test
+## HOST - test-node-1
+## OXS - show vrf
+Name                             Default RD          Protocols   Interfaces
+  mgmtVRF                          <not set>           ipv4,ipv6   Fa1
+
 [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.
+    -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
+    -c, --community        snmp community to use for discovery
+    -g, --group            group to run commands on (ios, junos, etc), specified in oxidized db
+    -r, --threads          specify ammount of threads to use for running group (default: 1)
+        --regex    	   run on all hosts that match the regexp
+        --protocols        protocols to use, default "ssh, telnet"
+    -v, --verbose          verbose output, e.g. show commands sent
+    -d, --debug            turn on debugging
+        --terse            display clean output
+        --list-models      list supported models
+        --list-nodes       list nodes in oxidized source
+    -h, --help             Display this help message.
 [fisakytt@lan-login1 ~]% 
+
+
 ```
 
 ### Library

data/bin/oxs

@@ -2,7 +2,7 @@
 
 begin
   require 'oxidized/script/cli'
-  puts Oxidized::Script::CLI.new.run
+  Oxidized::Script::CLI.new.run
 rescue => error
   warn "#{error}"
   raise if Oxidized.config.debug

data/lib/oxidized/script/cli.rb

@@ -1,6 +1,7 @@
 module Oxidized
   require_relative 'script'
   require 'slop'
+  require 'thread'
 
   class Script
     class CLI
@@ -9,11 +10,38 @@ module Oxidized
       class NothingToDo < ScriptError; end
 
       def run
-        connect
-        if @opts[:commands]
-          run_file @opts[:commands]
-        elsif @cmd
-          @oxs.cmd @cmd
+        if @group or @regex
+          nodes = get_hosts
+          work_q = Queue.new
+          nodes.each{|node| work_q.push node}
+          workers = (0...@threads.to_i).map do
+            Thread.new do
+              begin
+                while node = work_q.pop(true)
+                  begin
+                    @host = node
+                    connect
+                    if @opts[:commands]
+                      puts run_file @opts[:commands]
+                    elsif @cmd
+                      puts @oxs.cmd @cmd
+                    end
+                  rescue
+                    puts "Couldn't connect to: " + node
+                  end
+                end
+              rescue ThreadError
+              end
+            end
+          end
+          workers.map(&:join)
+        else
+          connect
+          if @opts[:commands]
+            puts run_file @opts[:commands]
+          elsif @cmd
+            puts @oxs.cmd @cmd
+          end
         end
       end
 
@@ -33,10 +61,14 @@ module Oxidized
           @cmd_class.run :args=>@args, :opts=>@opts, :host=>@host, :cmd=>@cmd
           exit 0
         else
-          @host = @args.shift
-          @cmd  = @args.shift if @args
+          if @group or @regex
+            @cmd = @args.shift
+          else
+            @host = @args.shift
+            @cmd  = @args.shift if @args
+          end
           @oxs  = nil
-          raise NothingToDo, 'no host given' if not @host
+          raise NothingToDo, 'no host given' if not @host and not @group and not @regex
           raise NothingToDo, 'nothing to do, give command or -x' if not @cmd and not @opts[:commands]
         end
       end
@@ -51,6 +83,9 @@ module Oxidized
         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 'g=', '--group',     'group to run commands on (ios, junos, etc), specified in oxidized db'
+        slop.on 'r=', '--threads',   'specify ammount of threads to use for running group', default: '1'
+        slop.on       '--regex=',    'run on all hosts that match the regexp'
         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'
@@ -65,6 +100,10 @@ module Oxidized
           end
         end
         slop.parse
+        @group = slop[:group]
+        @threads = slop[:threads]
+        @verbose = slop[:verbose]
+        @regex = slop[:regex]
         [slop.parse!, slop]
       end
 
@@ -82,7 +121,7 @@ module Oxidized
         file = file == '-' ? $stdin : File.read(file)
         file.each_line do |line|
           line.chomp!
-          line.sub!(/\\n/, "\n") # tread escaped newline as newline
+          # line.sub!(/\\n/, "\n") # treat escaped newline as newline
           out += @oxs.cmd line
         end
         out
@@ -104,6 +143,41 @@ module Oxidized
         cmds
       end
 
+      def get_hosts
+          if @group and @regex
+            puts "running list for hosts in group: #{@group} and matching: #{@regex}" if @verbose
+            nodes_group = run_group @group
+            nodes_regex = run_regex @regex
+            return nodes_group & nodes_regex
+          elsif @regex
+            puts 'running list for hosts matching: ' + @regex if @verbose
+            return run_regex @regex
+          else
+            puts 'running list for hosts in group: ' + @group if @verbose
+            return run_group @group
+          end
+      end
+
+      def run_group group
+        Oxidized.mgr = Manager.new
+        out = []
+        Nodes.new.each do |node|
+          next unless group == node.group
+          out << node.name
+        end
+        out
+      end
+
+      def run_regex regex
+        Oxidized.mgr = Manager.new
+        out = []
+        Nodes.new.each do |node|
+          next unless node.name =~ /#{regex}/
+          out << node.name
+        end
+        out
+      end
+
     end
   end
 end

data/lib/oxidized/script/script.rb

@@ -18,6 +18,7 @@ module Oxidized
     # @return [String] output for command
     def cmd command
       out = ''
+      out += "## HOST - #{@host}\n" if @verbose
       out += "## OXS - #{command}\n" if @verbose
       cmd_out = @model.cmd command
       out += cmd_out if cmd_out
@@ -34,7 +35,7 @@ module Oxidized
     private
 
     # @param [Hash] opts options for Oxidized::Script
-    # @option opts [String]  :host      hostname or ip address for Oxidized::Node
+    # @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
@@ -46,13 +47,14 @@ module Oxidized
     # @yieldreturn [self] if called in block, returns self and disconnnects session after exiting block
     # @return [void]
     def initialize opts, &block
-      host        = opts.delete :host
+      @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
+      group       = opts.delete :group
       @verbose    = opts.delete :verbose
       Oxidized.config.input.default = opts.delete :protocols if opts[:protocols]
       raise InvalidOption, "#{opts} not recognized" unless opts.empty?
@@ -64,10 +66,10 @@ module Oxidized
       end
 
       @node = if model
-        Node.new(:name=>host, :model=>model)
-      else
-        Nodes.new(:node=>host).first
-      end
+                Node.new(:name=>@host, :model=>model)
+              else
+                Nodes.new(:node=>@host).first
+              end
       if not @node
         begin
           require 'corona'
@@ -75,9 +77,9 @@ module Oxidized
         rescue LoadError
           raise NoNode, 'node not found'
         end
-        node = Corona.poll :host=>host, :community=>community
+        node = Corona.poll :host=>@host, :community=>community
         raise NoNode, 'node not found' unless node
-        @node = Node.new :name=>host, :model=>node[:model]
+        @node = Node.new :name=>@host, :model=>node[:model]
       end
       @node.auth[:username] = username if username
       @node.auth[:password] = password if password

data/oxidized-script.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'oxidized-script'
-  s.version           = '0.2.0'
+  s.version           = '0.3.0'
   s.licenses          = %w( Apache-2.0 )
   s.platform          = Gem::Platform::RUBY
   s.authors           = [ 'Saku Ytti' ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxidized-script
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Saku Ytti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oxidized