oxidized 0.20.0 → 0.28.0

data/lib/oxidized/model/model.rb

@@ -6,43 +6,62 @@ module Oxidized
     include Oxidized::Config::Vars
 
     class << self
-      def inherited klass
-        klass.instance_variable_set '@cmd',   Hash.new { |h,k| h[k] = [] }
-        klass.instance_variable_set '@cfg',   Hash.new { |h,k| h[k] = [] }
-        klass.instance_variable_set '@procs', Hash.new { |h,k| h[k] = [] }
-        klass.instance_variable_set '@expect', []
-        klass.instance_variable_set '@comment', nil
-        klass.instance_variable_set '@prompt', nil
-      end
-      def comment _comment='# '
-        return @comment if @comment
-        @comment = block_given? ? yield : _comment
-      end
-      def prompt _prompt=nil
-        @prompt or @prompt = _prompt
-      end
-      def cfg *methods, &block
+      def inherited(klass)
+        if klass.superclass == Oxidized::Model
+          klass.instance_variable_set '@cmd',     (Hash.new { |h, k| h[k] = [] })
+          klass.instance_variable_set '@cfg',     (Hash.new { |h, k| h[k] = [] })
+          klass.instance_variable_set '@procs',   (Hash.new { |h, k| h[k] = [] })
+          klass.instance_variable_set '@expect',  []
+          klass.instance_variable_set '@comment', nil
+          klass.instance_variable_set '@prompt',  nil
+        else # we're subclassing some existing model, take its variables
+          instance_variables.each do |var|
+            klass.instance_variable_set var, instance_variable_get(var)
+          end
+        end
+      end
+
+      def comment(str = "# ")
+        @comment = if block_given?
+                     yield
+                   elsif not @comment
+                     str
+                   else
+                     @comment
+                   end
+      end
+
+      def prompt(regex = nil)
+        @prompt = regex || @prompt
+      end
+
+      def cfg(*methods, **args, &block)
         [methods].flatten.each do |method|
-          @cfg[method.to_s] << block
+          process_args_block(@cfg[method.to_s], args, block)
         end
       end
+
       def cfgs
         @cfg
       end
-      def cmd _cmd=nil, &block
-        if _cmd.class == Symbol
-          @cmd[_cmd] << block
+
+      def cmd(cmd_arg = nil, **args, &block)
+        if cmd_arg.class == Symbol
+          process_args_block(@cmd[cmd_arg], args, block)
         else
-          @cmd[:cmd] << [_cmd, block]
+          process_args_block(@cmd[:cmd], args, [cmd_arg, block])
         end
-        Oxidized.logger.debug "lib/oxidized/model/model.rb Added #{_cmd} to the commands list"
+        Oxidized.logger.debug "lib/oxidized/model/model.rb Added #{cmd_arg} to the commands list"
       end
+
       def cmds
         @cmd
       end
-      def expect re, &block
-        @expect << [re, block]
+
+      def expect(regex, **args, &block)
+        process_args_block(@expect, args, [regex, block])
       end
+
       def expects
         @expect
       end
@@ -54,8 +73,8 @@ module Oxidized
       # @since 0.0.39
       # @yield expects block which should return [String]
       # @return [void]
-      def pre &block
-        @procs[:pre] << block
+      def pre(**args, &block)
+        process_args_block(@procs[:pre], args, block)
       end
 
       # calls the block at the end of the model, adding the output of the block
@@ -65,24 +84,35 @@ module Oxidized
       # @since 0.0.39
       # @yield expects block which should return [String]
       # @return [void]
-      def post &block
-        @procs[:post] << block
+      def post(**args, &block)
+        process_args_block(@procs[:post], args, block)
       end
 
       # @author Saku Ytti <saku@ytti.fi>
       # @since 0.0.39
       # @return [Hash] hash proc procs :pre+:post to be prepended/postfixed to output
-      def procs
-        @procs
+      attr_reader :procs
+
+      private
+
+      def process_args_block(target, args, block)
+        if args[:clear]
+          target.replace([block])
+        else
+          method = args[:prepend] ? :unshift : :push
+          target.send(method, block)
+        end
       end
     end
 
     attr_accessor :input, :node
 
-    def cmd string, &block
+    def cmd(string, &block)
       Oxidized.logger.debug "lib/oxidized/model/model.rb Executing #{string}"
       out = @input.cmd(string)
       return false unless out
+
+      out = out.b unless Oxidized.config.input.utf8_encoded?
       self.class.cmds[:all].each do |all_block|
         out = instance_exec Oxidized::String.new(out), string, &all_block
       end
@@ -99,12 +129,12 @@ module Oxidized
       @input.output
     end
 
-    def send data
+    def send(data)
       @input.send data
     end
 
-    def expect re, &block
-      self.class.expect re, &block
+    def expect(regex, &block)
+      self.class.expect regex, &block
     end
 
     def cfg
@@ -115,14 +145,10 @@ module Oxidized
       self.class.prompt
     end
 
-    def expects data
+    def expects(data)
       self.class.expects.each do |re, cb|
         if data.match re
-          if cb.arity == 2
-            data = instance_exec [data, re], &cb
-          else
-            data = instance_exec data, &cb
-          end
+          data = cb.arity == 2 ? instance_exec([data, re], &cb) : instance_exec(data, &cb)
         end
       end
       data
@@ -135,6 +161,7 @@ module Oxidized
       self.class.cmds[:cmd].each do |command, block|
         out = cmd command, &block
         return false unless out
+
         outputs << out
       end
       procs[:pre].each do |pre_proc|
@@ -146,9 +173,9 @@ module Oxidized
       outputs
     end
 
-    def comment _comment
+    def comment(str)
       data = ''
-      _comment.each_line do |line|
+      str.each_line do |line|
         data << self.class.comment << line
       end
       data
@@ -160,12 +187,11 @@ module Oxidized
 
     private
 
-    def process_cmd_output output, name
-      output = Oxidized::String.new output if ::String === output
-      output = Oxidized::String.new '' unless Oxidized::String === output
+    def process_cmd_output(output, name)
+      output = Oxidized::String.new(output) if output.is_a?(::String)
+      output = Oxidized::String.new('') unless output.instance_of?(Oxidized::String)
       output.set_cmd(name)
       output
     end
-
   end
 end

data/lib/oxidized/model/mtrlrfs.rb

@@ -1,5 +1,4 @@
 class Mtrlrfs < Oxidized::Model
-
   # Motorola RFS/Extreme WM
 
   comment  '# '
@@ -7,7 +6,7 @@ class Mtrlrfs < Oxidized::Model
   cmd :all do |cfg|
     # xos inserts leading \r characters and other trailing white space.
     # this deletes extraneous \r and trailing white space.
-    cfg.each_line.to_a[1..-2].map{|line|line.delete("\r").rstrip}.join("\n") + "\n"
+    cfg.each_line.to_a[1..-2].map { |line| line.delete("\r").rstrip }.join("\n") + "\n"
   end
 
   cmd 'show version' do |cfg|
@@ -32,6 +31,4 @@ class Mtrlrfs < Oxidized::Model
       send "n\n"
     end
   end
-
 end
-

data/lib/oxidized/model/ndms.rb

@@ -0,0 +1,23 @@
+class NDMS < Oxidized::Model
+  # Pull config from Zyxel Keenetic devices from version NDMS >= 2.0
+
+  comment  '! '
+
+  prompt /^([\w.@()-]+[#>]\s?)/m
+
+  cmd 'show version' do |cfg|
+    cfg = cfg.each_line.to_a[1..-3].join
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg = cfg.cut_both.each_line.reject { |line| line.match /(clock date|checksum)/ }.join
+    cfg
+  end
+
+  cfg :telnet do
+    username /^Login:/
+    password /^Password:/
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/netgear.rb

@@ -1,32 +1,52 @@
 class Netgear < Oxidized::Model
-
   comment '!'
-  prompt /^(\([\w-]+\)\s[#>])$/
+  prompt /^(\([\w\s\-.]+\)\s[#>])$/
 
   cmd :secret do |cfg|
     cfg.gsub!(/password (\S+)/, 'password <hidden>')
+    cfg.gsub!(/encrypted (\S+)/, 'encrypted <hidden>')
+    cfg.gsub!(/snmp-server community (\S+)/, 'snmp-server community <hidden>') # snmp
     cfg
   end
 
+  cfg :telnet do
+    username /^(User:|Applying Interface configuration, please wait ...)/
+    password /^Password:/i
+  end
+
   cfg :telnet, :ssh do
-    if vars :enable
-      post_login do
-        cmd 'enable'
-        # Interpret enable: true as meaning we won't be prompted for a password
-        unless vars(:enable).is_a? TrueClass
-          expect /[pP]assword:\s?$/
-          cmd vars(:enable) + "\n"
-        end
-        expect /^.+[#]$/
+    post_login do
+      if vars(:enable) == true
+        cmd "enable"
+      elsif vars(:enable)
+        cmd "enable", /[pP]assword:\s?$/
+        cmd vars(:enable)
       end
     end
     post_login 'terminal length 0'
-    pre_logout 'exit'
-    pre_logout 'quit'
+    # quit / logout will sometimes prompt the user:
+    #
+    #     The system has unsaved changes.
+    #     Would you like to save them now? (y/n)
+    #
+    # So it is safer simply to disconnect and not issue a pre_logout command
   end
 
-  cmd 'show running-config' do |cfg|
-    cfg.gsub! /^(!.*Time).*$/, '\1'
+  cmd :all do |cfg, cmdstring|
+    new_cfg = comment "COMMAND: #{cmdstring}\n"
+    new_cfg << cfg.each_line.to_a[1..-2].join
   end
 
+  cmd 'show version' do |cfg|
+    cfg.gsub! /(Current Time\.+ ).*/, '\\1 <removed>'
+    comment cfg
+  end
+
+  cmd 'show bootvar' do |cfg|
+    comment cfg
+  end
+  cmd 'show running-config' do |cfg|
+    cfg.gsub! /(System Up Time\s+).*/, '\\1 <removed>'
+    cfg.gsub! /(Current SNTP Synchronized Time:).*/, '\\1 <removed>'
+  end
 end

data/lib/oxidized/model/netonix.rb

@@ -1,8 +1,8 @@
 class Netonix < Oxidized::Model
-  prompt /^[\w\s.@_\/:-]+#/
+  prompt /^[\w\s\(\).@_\/:-]+#/
 
   cmd :all do |cfg|
-    cfg.each_line.to_a[1..-2].join
+    cfg.cut_both
   end
 
   cmd 'cat config.json;echo'

data/lib/oxidized/model/netscaler.rb

@@ -1,6 +1,5 @@
 class NetScaler < Oxidized::Model
-
-  prompt /^\>\s*$/
+  prompt /^([\w\.-]*>\s?)$/
   comment '# '
 
   cmd :all do |cfg|
@@ -15,10 +14,14 @@ class NetScaler < Oxidized::Model
     comment cfg
   end
 
+  cmd :secret do |cfg|
+    cfg.gsub! /\w+\s(-encrypted)/, '<secret hidden> \\1'
+    cfg
+  end
+
   cmd 'show ns ns.conf'
 
   cfg :ssh do
     pre_logout 'exit'
   end
-
 end

data/lib/oxidized/model/nos.rb

@@ -1,16 +1,15 @@
 class NOS < Oxidized::Model
-
   # Brocade Network Operating System
 
   prompt /^(?:\e\[..h)?[\w.-]+# $/
   comment  '! '
 
   cmd :all do |cfg|
-    cfg.each_line.to_a[1..-2].join
+    cfg.cut_both
   end
 
   cmd 'show version' do |cfg|
-    comment cfg
+    comment cfg.each_line.reject { |line| line.match /([Ss]ystem [Uu]p\s?[Tt]ime|[Uu]p\s?[Tt]ime is \d)/ }.join
   end
 
   cmd 'show inventory' do |cfg|
@@ -22,11 +21,11 @@ class NOS < Oxidized::Model
   end
 
   cmd 'show chassis' do |cfg|
-    comment cfg.each_line.reject { |line| line.match /Time/ or line.match /Update/ }.join
+    comment cfg.each_line.reject { |line| line.match(/Time/) || line.match(/Update/) }.join
   end
 
   cfg 'show system' do |cfg|
-    comment cfg.each_line.reject { |line| line.match /Time/ or line.match /speed/ }
+    comment(cfg.each_line.reject { |line| line.match(/Time/) || line.match(/speed/) })
   end
 
   cmd 'show running-config | nomore'
@@ -38,8 +37,7 @@ class NOS < Oxidized::Model
 
   cfg :telnet, :ssh do
     post_login 'terminal length 0'
-    #post_login 'terminal width 0'
+    # post_login 'terminal width 0'
     pre_logout 'exit'
   end
-
 end

data/lib/oxidized/model/nsxconfig.rb

@@ -0,0 +1,22 @@
+require 'net/http'
+class NSXConfig < Oxidized::Model
+  cmd "/api/4.0/edges/" do |cfg|
+    edges = JSON.parse(cfg.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))["edgePage"]["data"]
+    data = []
+    edges.each do |edge|
+      firewall_config = cmd "/api/4.0/edges/#{edge['id']}"
+      json_config = JSON.parse(firewall_config.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))
+      json_config["edgeInfo"] = "#{edge['id']} #{edge['name']}"
+      data.push(json_config)
+    end
+    JSON.pretty_generate(data)
+  end
+
+  cfg :http do
+    @username = @node.auth[:username]
+    @password = @node.auth[:password]
+    @headers['Content-Type'] = 'application/json'
+    @headers['Accept'] = 'application/json'
+    @secure = true
+  end
+end

data/lib/oxidized/model/nsxfirewall.rb

@@ -0,0 +1,22 @@
+require 'net/http'
+class NSXFirewall < Oxidized::Model
+  cmd "/api/4.0/edges/" do |cfg|
+    edges = JSON.parse(cfg.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))["edgePage"]["data"]
+    data = []
+    edges.each do |edge|
+      firewall_config = cmd "/api/4.0/edges/#{edge['id']}/firewall/config"
+      json_config = {}
+      json_config["#{edge['id']} #{edge['name']}"] = JSON.parse(firewall_config.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))
+      data.push(json_config)
+    end
+    JSON.pretty_generate(data)
+  end
+
+  cfg :http do
+    @username = @node.auth[:username]
+    @password = @node.auth[:password]
+    @headers['Content-Type'] = 'application/json'
+    @headers['Accept'] = 'application/json'
+    @secure = true
+  end
+end

data/lib/oxidized/model/nxos.rb

@@ -1,8 +1,12 @@
 class NXOS < Oxidized::Model
-
   prompt /^(\r?[\w.@_()-]+[#]\s?)$/
   comment '! '
 
+  def filter(cfg)
+    cfg.gsub! /\r\n?/, "\n"
+    cfg.gsub! prompt, ''
+  end
+
   cmd :secret do |cfg|
     cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
     cfg.gsub! /^(snmp-server user (\S+) (\S+) auth (\S+)) (\S+) (priv) (\S+)/, '\\1 <configuration removed> '
@@ -10,18 +14,24 @@ class NXOS < Oxidized::Model
     cfg.gsub! /^(radius-server key).*/, '\\1 <secret hidden>'
     cfg
   end
-  
+
   cmd 'show version' do |cfg|
+    cfg = filter cfg
     cfg = cfg.each_line.take_while { |line| not line.match(/uptime/i) }
     comment cfg.join ""
   end
 
   cmd 'show inventory' do |cfg|
+    cfg = filter cfg
     comment cfg
-  end 
+  end
 
   cmd 'show running-config' do |cfg|
+    cfg = filter cfg
+    cfg.gsub! /^(show run.*)$/, '! \1'
     cfg.gsub! /^!Time:[^\n]*\n/, ''
+    cfg.gsub! /^[\w.@_()-]+[#].*$/, ''
+    cfg
   end
 
   cfg :ssh, :telnet do

data/lib/oxidized/model/oneos.rb

@@ -1,25 +1,24 @@
 class OneOS < Oxidized::Model
-
   prompt /^([\w.@()-]+#\s?)$/
   comment  '! '
 
   # example how to handle pager
-  #expect /^\s--More--\s+.*$/ do |data, re|
+  # expect /^\s--More--\s+.*$/ do |data, re|
   #  send ' '
   #  data.sub re, ''
-  #end
+  # end
 
   # non-preferred way to handle additional PW prompt
-  #expect /^[\w.]+>$/ do |data|
+  # expect /^[\w.]+>$/ do |data|
   #  send "enable\n"
   #  send vars(:enable) + "\n"
   #  data
-  #end
+  # end
 
   cmd :all do |cfg|
-    #cfg.gsub! /\cH+\s{8}/, ''         # example how to handle pager
-    #cfg.gsub! /\cH+/, ''              # example how to handle pager
-    cfg.each_line.to_a[1..-2].join
+    # cfg.gsub! /\cH+\s{8}/, ''         # example how to handle pager
+    # cfg.gsub! /\cH+/, ''              # example how to handle pager
+    cfg.cut_both
   end
 
   cmd :secret do |cfg|
@@ -31,6 +30,14 @@ class OneOS < Oxidized::Model
     comment cfg
   end
 
+  cmd 'show system hardware' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show product-info-area' do |cfg|
+    comment cfg
+  end
+
   cmd 'show running-config' do |cfg|
     cfg = cfg.each_line.to_a[0..-1].join
     cfg.gsub! /^Building configuration...\s*[^\n]*\n/, ''
@@ -54,5 +61,4 @@ class OneOS < Oxidized::Model
     post_login 'term len 0'
     pre_logout 'exit'
   end
-
 end

data/lib/oxidized/model/openbsd.rb

@@ -0,0 +1,63 @@
+class Openbsd < Oxidized::Model
+  # OpenBSD with custom promp, like user@hostname:~$
+  # you can edit the one that your user uses, with root would be /root/.profile using the next PS1 def
+  # export PS1="\033[32m\u@\h\033[00m:\033[36m\w\033[00m$ "
+
+  prompt /^.+@.+\:.+\$/
+  comment '# '
+
+  # Add a comment between files/configs
+  def add_comment(comment)
+    "\n+++++++++++++++++++++++++++++++++++++++++ #{comment} ++++++++++++++++++++++++++++++++++++++++++++++\n"
+  end
+
+  def add_small_comment(comment)
+    "\n=============== #{comment} ===============\n"
+  end
+
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-2].join
+  end
+
+  # Issue the show commands
+  pre do
+    cfg = add_comment('HOSTNAME FILE')
+    cfg += cmd('cat /etc/myname')
+
+    cfg += add_comment('RESOLV.CONF FILE')
+    cfg += cmd('cat /etc/resolv.conf')
+
+    cfg += add_comment('NTP.CONF FILE')
+    cfg += cmd('cat /etc/ntp.conf')
+
+    cfg += add_comment('PF FILE')
+    cfg += cmd('cat /etc/pf.conf')
+
+    cfg += add_comment('HOSTS FILE')
+    cfg += cmd('cat /etc/hosts')
+
+    cfg += add_comment('INTERFACE FILES')
+    cfg += cmd('tail -n +1 /etc/hostname.*')
+
+    cfg += add_comment('SNMP FILE')
+    cfg += cmd('cat /etc/snmpd.conf')
+
+    cfg += add_comment('MOTD FILE')
+    cfg += cmd('cat /etc/motd')
+
+    cfg += add_comment('PASSWD FILE')
+    cfg += cmd('cat /etc/passwd')
+
+    cfg += add_small_comment('END')
+    cfg
+  end
+
+  cfg :telnet do
+    username /^Username:/
+    password /^Password:/
+  end
+
+  cfg :telnet, :ssh do
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/opengear.rb

@@ -1,8 +1,7 @@
 class OpenGear < Oxidized::Model
+  comment '# '
 
-  comment  '# '
-  
-  prompt /^(\$\s)?$/
+  prompt /^(\$\s)$/
 
   cmd :secret do |cfg|
     cfg.gsub!(/password (\S+)/, 'password <secret removed>')
@@ -15,7 +14,6 @@ class OpenGear < Oxidized::Model
   cmd 'config -g config'
 
   cfg :ssh do
-    exec true  # don't run shell, run each command in exec channel
+    exec true # don't run shell, run each command in exec channel
   end
-
 end