oxidized 0.26.3 → 0.27.0

data/lib/oxidized/model/fastiron.rb

@@ -0,0 +1,66 @@
+class FastIron < Oxidized::Model
+  prompt /^([\w.@()-]+[#>]\s?)$/
+  comment  '! '
+
+  cmd :all do |cfg|
+    # cfg.gsub! /\cH+\s{8}/, ''         # example how to handle pager
+    # cfg.gsub! /\cH+/, ''              # example how to handle pager
+    # get rid of errors for commands that don't work on some devices
+    cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
+    cfg.cut_both
+  end
+
+  cmd 'show version' do |cfg|
+    comments = []
+    comments << cfg.lines.first
+    lines = cfg.lines
+    lines.each_with_index do |line, _i|
+      comments << "Version: #{Regexp.last_match(1)}" if line =~ /^\s+SW: Version (.*)$/
+
+      comments << "Boot-Monitor Version: #{Regexp.last_match(1)}" if line =~ /^\s+Compressed Boot-Monitor Image size = \d+, Version:(.*)$/
+
+      comments << "Serial: #{Regexp.last_match(1)}" if line =~ /^\s+Serial  #:(.*)$/
+    end
+    comments << "\n"
+    comment comments.join "\n"
+  end
+
+  cmd 'show module' do |cfg|
+    cfg.gsub! /^$\n/, ''
+    cfg.gsub! /^/, 'Modules: ' unless cfg.empty?
+    comment "#{cfg}\n"
+  end
+
+  cmd 'show media | exclude EMPTY' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show hardware-info' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show stack' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config'
+
+  cfg :telnet do
+    username /^.* login: /
+    password /^Password:/
+  end
+
+  cfg :telnet, :ssh do
+    # preferred way to handle additional passwords
+    post_login do
+      if vars(:enable) == true
+        cmd "enable"
+      elsif vars(:enable)
+        cmd "enable", /^[pP]assword:/
+        cmd vars(:enable)
+      end
+    end
+    post_login 'skip-page-display'
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/firelinuxos.rb

@@ -0,0 +1,41 @@
+class FireLinuxOS < Oxidized::Model
+  # Fire Linux OS is what the new FTD (FirePOWER) series devices from Cisco run. At the backend, it's mostly identical to ASA's.
+
+  prompt /^[#>]\(?.+\)?\s?/
+  comment  '! '
+
+  cmd :all do |cfg|
+    cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
+    cfg.each_line.to_a[1..-2].join
+  end
+
+  cmd :secret do |cfg|
+    cfg.gsub! /enable password (\S+) (.*)/, 'enable password <secret hidden> \2'
+    cfg.gsub! /username (\S+) password (\S+) (.*)/, 'username \1 password <secret hidden> \3'
+    cfg.gsub! /(ikev[12] ((remote|local)-authentication )?pre-shared-key) (\S+)/, '\1 <secret hidden>'
+    cfg.gsub! /^(aaa-server TACACS\+? \(\S+\) host.*\n\skey) \S+$/mi, '\1 <secret hidden>'
+    cfg.gsub! /ldap-login-password (\S+)/, 'ldap-login-password <secret hidden>'
+    cfg.gsub! /^snmp-server host (.*) community (\S+)/, 'snmp-server host \1 community <secret hidden>'
+    cfg
+  end
+
+  cmd 'show version system' do |cfg|
+    cfg = cfg.each_line.reject { |line| line.match /(\s+up\s+\d+\s+)|(.*days.*)/ }
+    cfg = cfg.join
+    comment cfg
+  end
+
+  cmd 'show inventory' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config all' do |cfg|
+    cfg = cfg.each_line.to_a[3..-1].join
+    cfg.gsub! /^: [^\n]*\n/, ''
+    cfg
+  end
+
+  cfg :ssh do
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/fortios.rb

@@ -34,6 +34,11 @@ class FortiOS < Oxidized::Model
     comment cfg
   end
 
+  cmd 'get system ha status' do |cfg|
+    cfg = cfg.each_line.select { |line| line.match /^(HA Health Status|Mode|Model|Master|Slave\s+):/ }.join
+    comment cfg
+  end
+
   post do
     cfg = []
     cfg << cmd('config global') if @vdom_enabled

data/lib/oxidized/model/hpmsm.rb

@@ -0,0 +1,84 @@
+class HPMSM < Oxidized::Model
+  prompt /^CLI[>#] +$/
+
+  comment '! '
+
+  # replace next line control sequence with a new line
+  expect /(\e\[1M\e\[\??\d+(;\d+)*[A-Za-z]\e\[1L)|(\eE)/ do |data, re|
+    data.gsub re, "\n"
+  end
+
+  # replace all used vt100 control sequences
+  expect /\e\[\??\d+(;\d+)*[A-Za-z]/ do |data, re|
+    data.gsub re, ''
+  end
+
+  cmd :all do |cfg|
+    cfg = cfg.cut_both
+    cfg = cfg.gsub /^\r/, ''
+    cfg
+  end
+
+  cmd :secret do |cfg|
+    cfg.gsub! /^(snmp-server community) \S+(.*)/, '\\1 <secret hidden> \\2'
+    cfg.gsub! /^(snmp-server host \S+) \S+(.*)/, '\\1 <secret hidden> \\2'
+    cfg.gsub! /^(radius-server host \S+ key) \S+(.*)/, '\\1 <secret hidden> \\2'
+    cfg.gsub! /^(radius-server key).*/, '\\1 <configuration removed>'
+    cfg.gsub! /^(tacacs-server host \S+ key) \S+(.*)/, '\\1 <secret hidden> \\2'
+    cfg.gsub! /^(tacacs-server key).*/, '\\1 <secret hidden>'
+    cfg
+  end
+
+  cmd 'show system info' do |cfg|
+    sysinfo = ''
+    ram = cfg.match(/Total RAM:\s+(\S+)/)[1].to_i / 1024 / 1024
+    sysinfo << "Memory: #{ram}M\n"
+
+    serial = cfg.match(/Serial Number:\s+(\S+)/)[1]
+    sysinfo << "Serial Number: #{serial}\n"
+
+    firmware = cfg.match(/Firmware Version:\s+(\S+)/)[1]
+    sysinfo << "Firmware: #{firmware}\n"
+
+    comment sysinfo
+  end
+
+  cmd 'show ip' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show ip route' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show certificate' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show certificate binding' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show satellites' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show web content' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show all config' do |cfg|
+    cfg = cfg.each_line.reject { |line| line.match /^running configuration:/ }.join
+    # The who line contains SSH source port number, and the When line contains the timestamp of the run
+    cfg = cfg.each_line.reject { |line| line.match /(^#\s+Who:)|(^#\s+When:)/ }.join
+    # igmp proxy line keeps changing with weird characters every run, filter it out
+    cfg = cfg.each_line.reject { |line| line.match /^[ \t]*igmp proxy (upstream|downstream)/ }.join
+    cfg
+  end
+
+  cfg :ssh do
+    post_login "enable"
+    pre_logout "quit"
+    pty_options(chars_wide: 1000)
+  end
+end

data/lib/oxidized/model/icotera.rb

@@ -0,0 +1,27 @@
+class Icotera < Oxidized::Model
+  comment '## '
+
+  cmd :all do |cfg|
+    cfg.cut_both
+  end
+
+  cmd 'show management' do |cfg|
+    cfg.gsub! /^\s+System uptime.*\n/, ""
+    cfg.gsub! /^\s+Bytes in.*\n/, ""
+    cfg.gsub! /^\s+Pkts in.*\n/, ""
+    cfg.gsub! /^\s+Ucast in.*\n/, ""
+    cfg.gsub! /^\s+Bcast in.*\n/, ""
+    cfg.gsub! /^\s+Mcast in.*\n/, ""
+    cfg.gsub! /^\s+Ucast in pps.*\n/, ""
+    cfg.gsub! /^\s+Mcast in pps.*\n/, ""
+    cfg.gsub! /^\s+Total in bps.*\n/, ""
+
+    comment cfg
+  end
+
+  cmd 'copy progress screen'
+
+  cfg :ssh do
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/ios.rb

@@ -41,6 +41,7 @@ class IOS < Oxidized::Model
     cfg.gsub! /^(\s+standby \d+ authentication md5 key-string) .+?( timeout \d+)?$/, '\\1 <secret hidden> \\2'
     cfg.gsub! /^(\s+key-string) .+/, '\\1 <secret hidden>'
     cfg.gsub! /^((tacacs|radius) server [^\n]+\n(\s+[^\n]+\n)*\s+key) [^\n]+$/m, '\1 <secret hidden>'
+    cfg.gsub! /^(\s+ppp (chap|pap) password \d) .+/, '\\1 <secret hidden>'
     cfg
   end
 
@@ -95,6 +96,7 @@ class IOS < Oxidized::Model
 
   cmd 'show vtp status' do |cfg|
     cfg.gsub! /^$\n/, ''
+    cfg.gsub! /Configuration last modified by.*\n/, ''
     cfg.gsub! /^/, 'VTP: ' unless cfg.empty?
     comment "#{cfg}\n"
   end
@@ -107,6 +109,8 @@ class IOS < Oxidized::Model
     cfg = cfg.each_line.to_a[3..-1]
     cfg = cfg.reject { |line| line.match /^ntp clock-period / }.join
     cfg.gsub! /^Current configuration : [^\n]*\n/, ''
+    cfg.gsub! /^! (Last|No) configuration change (at|since).*\n/, ''
+    cfg.gsub! /^! NVRAM config last updated.*\n/, ''
     cfg.gsub! /^ tunnel mpls traffic-eng bandwidth[^\n]*\n*(
                   (?: [^\n]*\n*)*
                   tunnel mpls traffic-eng auto-bw)/mx, '\1'

data/lib/oxidized/model/ironware.rb

@@ -51,6 +51,7 @@ class IronWare < Oxidized::Model
 
   cmd 'show flash' do |cfg|
     cfg.gsub! /(\d+) bytes/, '' # Fix for ADX flash size
+    cfg.gsub! /(^((.*)Code Flash Free Space(.*))$)/, '' # Brocade
     comment cfg
   end
 

data/lib/oxidized/model/junos.rb

@@ -17,8 +17,6 @@ class JunOS < Oxidized::Model
     cfg
   end
 
-  cmd 'show configuration | display omit'
-
   cmd 'show version' do |cfg|
     @model = Regexp.last_match(1) if cfg =~ /^Model: (\S+)/
     comment cfg
@@ -39,6 +37,8 @@ class JunOS < Oxidized::Model
   cmd('show system license') { |cfg| comment cfg }
   cmd('show system license keys') { |cfg| comment cfg }
 
+  cmd 'show configuration | display omit'
+
   cfg :telnet do
     username(/^login:/)
     password(/^Password:/)

data/lib/oxidized/model/linuxgeneric.rb

@@ -0,0 +1,74 @@
+class LinuxGeneric < Oxidized::Model
+  prompt /^(\w.*|\W.*)(:|#) /
+  comment '# '
+
+  # add a comment in the final conf
+  def add_comment(comment)
+    "\n###### #{comment} ######\n"
+  end
+
+  cmd :all do |cfg|
+    cfg.gsub! /^(default (\S+).* (expires) ).*/, '\\1 <redacted>'
+    cfg.cut_both
+  end
+
+  # show the persistent configuration
+  pre do
+    cfg = add_comment 'THE HOSTNAME'
+    cfg += cmd 'cat /etc/hostname'
+
+    cfg += add_comment 'THE HOSTS'
+    cfg += cmd 'cat /etc/hosts'
+
+    cfg += add_comment 'THE INTERFACES'
+    cfg += cmd 'ip link'
+
+    cfg += add_comment 'RESOLV.CONF'
+    cfg += cmd 'cat /etc/resolv.conf'
+
+    cfg += add_comment 'IP Routes'
+    cfg += cmd 'ip route'
+
+    cfg += add_comment 'IPv6 Routes'
+    cfg += cmd 'ip -6 route'
+
+    cfg += add_comment 'MOTD'
+    cfg += cmd 'cat /etc/motd'
+
+    cfg += add_comment 'PASSWD'
+    cfg += cmd 'cat /etc/passwd'
+
+    cfg += add_comment 'GROUP'
+    cfg += cmd 'cat /etc/group'
+
+    cfg += add_comment 'nsswitch.conf'
+    cfg += cmd 'cat /etc/nsswitch.conf'
+
+    cfg += add_comment 'VERSION'
+    cfg += cmd 'cat /etc/issue'
+
+    cfg
+  end
+
+  cfg :telnet do
+    username /^Username:/
+    password /^Password:/
+  end
+
+  cfg :telnet, :ssh do
+    post_login do
+      if vars(:enable) == true
+        cmd "sudo su -", /^\[sudo\] password/
+        cmd @node.auth[:password]
+      elsif vars(:enable)
+        cmd "su -", /^Password:/
+        cmd vars(:enable)
+      end
+    end
+
+    pre_logout do
+      cmd "exit" if vars(:enable)
+    end
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/model.rb

@@ -7,22 +7,32 @@ module Oxidized
 
     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
+        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 = '# ')
-        return @comment if @comment
-
-        @comment = block_given? ? yield : str
+      def comment(str = "# ")
+        @comment = if block_given?
+                     yield
+                   elsif not @comment
+                     str
+                   else
+                     @comment
+                   end
       end
 
       def prompt(regex = nil)
-        @prompt || (@prompt = regex)
+        @prompt = regex || @prompt
       end
 
       def cfg(*methods, **args, &block)
@@ -178,8 +188,8 @@ module Oxidized
     private
 
     def process_cmd_output(output, name)
-      output = Oxidized::String.new output if ::String == output.class
-      output = Oxidized::String.new '' unless Oxidized::String == output.class
+      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

data/lib/oxidized/model/netgear.rb

@@ -5,6 +5,7 @@ class Netgear < Oxidized::Model
   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
 
@@ -31,7 +32,21 @@ class Netgear < Oxidized::Model
     # So it is safer simply to disconnect and not issue a pre_logout command
   end
 
+  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! /^(!.*Time).*$/, '\1'
+    cfg.gsub! /(System Up Time\s+).*/, '\\1 <removed>'
+    cfg.gsub! /(Current SNTP Synchronized Time:).*/, '\\1 <removed>'
   end
 end