oxidized 0.30.1 → 0.32.0

data/lib/oxidized/model/riverbed.rb

@@ -0,0 +1,104 @@
+class Riverbed < Oxidized::Model
+  using Refinements
+
+  # Define the prompt
+  prompt /^.* *[\w-]+ *[#>] *$/
+
+  # Define comment character
+  comment '! '
+
+  # Remove sensitive information
+  cmd :secret do |cfg|
+    cfg.gsub! /^( *tacacs-server (.+ )?key) .+/, '\\1 <secret hidden>'
+    cfg.gsub! /^( *username .+ (password|secret) \d) .+/, '\\1 <secret hidden>'
+    cfg.gsub! /^( *ntp server .+ key) .+/, '\\1 <secret hidden>'
+    cfg.gsub! /^( *ntp peer .+ key) .+/, '\\1 <secret hidden>'
+    cfg.gsub! /^( *snmp-server community).*/, '\\1 <configuration removed>'
+    cfg.gsub! /^( *ip security shared secret).*/, '\\1 <secret hidden>'
+    cfg.gsub! /^( *service shared-secret secret client).*/, '\\1 <secret hidden>'
+    cfg.gsub! /^( *service shared-secret secret server).*/, '\\1 <secret hidden>'
+    cfg
+  end
+
+  # Get version information and output it as comments
+  cmd 'show version' do |cfg|
+    cfg = cfg.cut_both
+
+    output = ''
+    cfg.each_line do |line|
+      line.strip!
+      output << comment("Product name: #{Regexp.last_match(1)}\n") if line =~ /^Product name:\s+(.*)$/
+      output << comment("Product release: #{Regexp.last_match(1)}\n") if line =~ /^Product release:\s+(.*)$/
+      output << comment("Build ID: #{Regexp.last_match(1)}\n") if line =~ /^Build ID:\s+(.*)$/
+      output << comment("Build date: #{Regexp.last_match(1)}\n") if line =~ /^Build date:\s+(.*)$/
+      output << comment("Build arch: #{Regexp.last_match(1)}\n") if line =~ /^Build arch:\s+(.*)$/
+      output << comment("Built by: #{Regexp.last_match(1)}\n") if line =~ /^Built by:\s+(.*)$/
+      output << comment("Product model: #{Regexp.last_match(1)}\n") if line =~ /^Product model:\s+(.*)$/
+      output << comment("Number of CPUs: #{Regexp.last_match(1)}\n") if line =~ /^Number of CPUs:\s+(.*)$/
+    end
+    output + "\n"
+  end
+
+  # Get hardware information and output it as comments
+  cmd 'show hardware all' do |cfg|
+    cfg = cfg.cut_both
+
+    output = ''
+    cfg.each_line do |line|
+      line.strip!
+      output << comment("Hardware revision: #{Regexp.last_match(1)}\n") if line =~ /^Hardware revision:\s+(.*)$/
+      output << comment("Mainboard: #{Regexp.last_match(1)}\n") if line =~ /^Mainboard:\s+(.*)$/
+      if line =~ /^Slot (\d+):\s+\.*\s+(.*)$/
+        slot_number = Regexp.last_match(1)
+        slot_info = Regexp.last_match(2)
+        output << comment("Slot #{slot_number}: #{slot_info}\n")
+      end
+      output << comment("System led: #{Regexp.last_match(1)}\n") if line =~ /^System led:\s+(.*)$/
+    end
+    output + "\n"
+  end
+
+  # Get serial information and output it as comment
+  cmd 'show info' do |cfg|
+    cfg = cfg.cut_both
+
+    output = ''
+    cfg.each_line do |line|
+      line.strip!
+      output << comment("Serial: #{Regexp.last_match(1)}\n") if line =~ /^Serial:\s+(.*)$/
+    end
+    output + "\n"
+  end
+
+  # Get the running configuration
+  cmd 'show running-config' do |cfg|
+    cfg = cfg.cut_both
+
+    cfg = cfg.each_line.map do |line|
+      if line =~ /^(.*##.*?##)(.*)$/
+        comment_part = Regexp.last_match(1).strip
+        command_part = Regexp.last_match(2).strip
+        comment_line = comment(comment_part)
+        if command_part.empty?
+          comment_line + "\n"
+        else
+          comment_line + "\n" + command_part + "\n"
+        end
+      else
+        line
+      end
+    end.join
+
+    cfg
+  end
+
+  # SSH configuration
+  cfg :ssh do
+    post_login do
+      cmd 'enable'
+      cmd 'terminal length 0'
+      cmd 'terminal width 1024'
+    end
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/routeros.rb

@@ -14,8 +14,8 @@ class RouterOS < Oxidized::Model
     cfg
   end
 
-  cmd '/system routerboard print' do |cfg|
-    cfg = cfg.each_line.grep(/(model|firmware-type|current-firmware|serial-number):/).join
+  cmd '/system resource print' do |cfg|
+    cfg = cfg.each_line.grep(/(version|factory-software|total-memory|cpu|cpu-count|total-hdd-space|architecture-name|board-name|platform):/).join
     comment cfg
   end
 

data/lib/oxidized/model/saos.rb

@@ -4,12 +4,29 @@ class SAOS < Oxidized::Model
   # Ciena SAOS switch
   # used for 6.x devices
 
-  comment  '! '
+  comment '! '
+  prompt /^[\w-]+\*?>\s?/
 
   cmd :all do |cfg|
+    cfg.gsub! /(Waiting for )(accounting|authorization).*\n/, '' # Remove TACACS errors
     cfg.cut_both
   end
 
+  cmd 'chassis show device-id power' do |cfg|
+    comment cfg
+  end
+
+  cmd 'software show' do |cfg|
+    cfg.gsub! /^\| Bank status.*/, '| Bank status         : <removed>                                              |'
+    comment cfg
+  end
+
+  cmd 'port xcvr show' do |cfg|
+    cfg.gsub! /^SHELL PARSER FAILURE.*/, '' # Ignore command failure
+    cfg.gsub! /(\s\|.{10}\|)(Ena\s\s|\s\sDis|UCTF\s)(.*)/, '\1     \3' # Remove transient operational state
+    comment cfg
+  end
+
   cmd 'configuration show' do |cfg|
     cfg.gsub! /^! Created: [^\n]*\n/, ''
     cfg.gsub! /^! On terminal: [^\n]*\n/, ''

data/lib/oxidized/model/siklumhtg.rb

@@ -0,0 +1,22 @@
+class SikluMHTG < Oxidized::Model
+  using Refinements
+
+  # Siklu MultiHaul TG#
+  # Requires source to define the model as SikluMHTG #
+
+  prompt /^\r?MH-[TN]\d{3}[\@][\w]{2,8}>$/
+
+  expect /--More--/ do |data, re|
+    send ' '
+    data.sub re, ''
+  end
+
+  cmd 'show startup' do |cfg|
+    cfg.gsub! /[\b]|\e\[A|\e\[2K/, ''
+    cfg.cut_both
+  end
+
+  cfg :ssh do
+    pre_logout 'quit'
+  end
+end

data/lib/oxidized/model/sonicos.rb

@@ -3,8 +3,14 @@ class SonicOS < Oxidized::Model
 
   # Applies to Sonicwall NSA series firewalls
 
-  prompt /^\w+@\w+[>]\(?.+\)?\s?/
-  comment  '! '
+  prompt /^\w+@[\w\-]+[>]\(?.+\)?\s?/
+  comment '! '
+
+  # Accept policiy message (see Issue #3339). Tested on 6.5 and 7.1
+  expect /Accept The Policy Banner \(yes\)\?\r\nyes: $/ do |data, re|
+    send "yes\n"
+    data.sub re, ''
+  end
 
   cmd :all do |cfg|
     cfg.each_line.to_a[1..-2].join

data/lib/oxidized/model/tplink.rb

@@ -58,6 +58,7 @@ class TPLink < Oxidized::Model
       if vars(:enable) == true
         cmd "enable"
       elsif vars(:enable)
+        cmd "enable", /^[pP]assword:/
         cmd vars(:enable)
       end
     end

data/lib/oxidized/model/uplinkolt.rb

@@ -0,0 +1,46 @@
+class UPLINKOLT < Oxidized::Model
+  prompt /^([\w.@()-]+[#>]\s?)$/
+  comment  '! '
+
+  cmd :all do |cfg|
+    cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
+    cfg.gsub!(/^show running-config$/, '')
+    cfg.gsub!(/^.*\s*#\s*$/, '')
+    # Remove leading and trailing whitespace
+    cfg.strip!
+    # Remove empty lines
+    cfg.gsub!(/^\s*$/, '')
+    cfg
+  end
+
+  cmd 'configure terminal' do
+    # Enter configure terminal mode
+    cmd 'show version' do |cfg|
+      cfg.gsub! /^show version/, ''
+      comment cfg
+    end
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg.gsub! /^Current configuration:/, ''
+    cfg
+  end
+
+  cfg :telnet, :ssh do
+    username /^Login:/i
+    password /^Password:/i
+    # 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 'terminal length 0'
+    pre_logout 'exit'
+    pre_logout 'disable'
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/vyatta.rb

@@ -3,7 +3,7 @@ class Vyatta < Oxidized::Model
 
   # Brocade Vyatta / VyOS model #
 
-  prompt /@.*?:~\$\s/
+  prompt /@.*(:~\$|>)\s/
 
   cmd :all do |cfg|
     cfg.lines.to_a[1..-2].join
@@ -14,7 +14,7 @@ class Vyatta < Oxidized::Model
     cfg.gsub! /plaintext-password (\S+).*/, 'plaintext-password <secret removed>'
     cfg.gsub! /password (\S+).*/, 'password <secret removed>'
     cfg.gsub! /pre-shared-secret (\S+).*/, 'pre-shared-secret <secret removed>'
-    cfg.gsub! /community (\S+) {/, 'community <hidden> {'
+    cfg.gsub! /community (\S+)/, 'community <hidden>'
     cfg.gsub! /private-key (\S+).*/, 'private-key <secret removed>'
     cfg.gsub! /preshared-key (\S+).*/, 'preshared-key <secret removed>'
     cfg

data/lib/oxidized/model/xos.rb

@@ -12,6 +12,13 @@ class XOS < Oxidized::Model
     cfg.each_line.to_a[1..-2].map { |line| line.delete("\r").rstrip }.join("\n") + "\n"
   end
 
+  cmd :secret do |cfg|
+    cfg.gsub! /^(configure (radius|radius-accounting) (netlogin|mgmt-access) (primary|secondary) shared-secret encrypted).+/, '\\1 <secret hidden>'
+    cfg.gsub! /^(configure account admin encrypted).+/, '\\1 <secret hidden>'
+    cfg.gsub! /^(create account (admin|user) (.+) encrypted).+/, '\\1 <secret hidden>'
+    cfg
+  end
+
   cmd 'show version' do |cfg|
     comment cfg
   end

data/lib/oxidized/node.rb

@@ -80,6 +80,8 @@ module Oxidized
         @err_reason = err.message.to_s
         false
       rescue StandardError => e
+        # Send a message in debug mode in case we are not able to create a crashfile
+        Oxidized.logger.send(:debug, '%s raised %s with msg "%s", creating crashfile' % [ip, e.class, e.message])
         crashdir  = Oxidized.config.crash.directory
         crashfile = Oxidized.config.crash.hostnames? ? name : ip.to_s
         FileUtils.mkdir_p(crashdir) unless File.directory?(crashdir)
@@ -198,33 +200,43 @@ module Oxidized
     end
 
     def resolve_key(key, opt, global = nil)
-      # resolve key, first get global, then get group then get node config
+      # resolve key: the priority is as follows: node -> group specific model -> group -> model -> global passed -> global
+      # where node has the highest priority (= if defined, overwrites other values)
       key_sym = key.to_sym
       key_str = key.to_s
-      value   = global
-      Oxidized.logger.debug "node.rb: resolving node key '#{key}', with passed global value of '#{value}' and node value '#{opt[key_sym]}'"
+      model_name = @model.class.name.to_s.downcase
+      Oxidized.logger.debug "node.rb: resolving node key '#{key}', with passed global value of '#{global}' and node value '#{opt[key_sym]}'"
 
-      # global
-      if (not value) && Oxidized.config.has_key?(key_str)
-        value = Oxidized.config[key_str]
-        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from global"
-      end
+      # Node
+      if opt[key_sym]
+        value = opt[key_sym]
+        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from node"
 
-      # group
-      if Oxidized.config.groups.has_key?(@group) && Oxidized.config.groups[@group].has_key?(key_str)
+      # Group specific model
+      elsif Oxidized.config.groups.has_key?(@group) && Oxidized.config.groups[@group].models.has_key?(model_name) && Oxidized.config.groups[@group].models[model_name].has_key?(key_str)
+        value = Oxidized.config.groups[@group].models[model_name][key_str]
+        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from model in group"
+
+      # Group
+      elsif Oxidized.config.groups.has_key?(@group) && Oxidized.config.groups[@group].has_key?(key_str)
         value = Oxidized.config.groups[@group][key_str]
         Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from group"
-      end
 
-      # model
-      if Oxidized.config.models.has_key?(@model.class.name.to_s.downcase) && Oxidized.config.models[@model.class.name.to_s.downcase].has_key?(key_str)
-        value = Oxidized.config.models[@model.class.name.to_s.downcase][key_str]
+      # Model
+      elsif Oxidized.config.models.has_key?(model_name) && Oxidized.config.models[model_name].has_key?(key_str)
+        value = Oxidized.config.models[model_name][key_str]
         Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from model"
-      end
 
-      # node
-      value = opt[key_sym] || value
-      Oxidized.logger.debug "node.rb: returning node key '#{key}' with value '#{value}'"
+      # Global passed
+      elsif global
+        value = global
+        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from passed global value"
+
+      # Global
+      elsif Oxidized.config.has_key?(key_str)
+        value = Oxidized.config[key_str]
+        Oxidized.logger.debug "node.rb: setting node key '#{key}' to value '#{value}' from global"
+      end
       value
     end
 

data/lib/oxidized/nodes.rb

@@ -61,6 +61,9 @@ module Oxidized
       end
     end
 
+    # Returns the configuration of group/node_name
+    #
+    # #fetch is called by oxidzed-web
     def fetch(node_name, group)
       yield_node_output(node_name) do |node, output|
         output.fetch node, group
@@ -69,7 +72,7 @@ module Oxidized
 
     # @param node [String] name of the node moved into the head of array
     def next(node, opt = {})
-      return unless waiting.find_node_index(node)
+      return if running.find_index(node)
 
       with_lock do
         n = del node
@@ -98,6 +101,9 @@ module Oxidized
       find_index(node) || raise(NodeNotFound, "unable to find '#{node}'")
     end
 
+    # Returns all stored versions of group/node_name
+    #
+    # Called by oxidized-web
     def version(node_name, group)
       yield_node_output(node_name) do |node, output|
         output.version node, group
@@ -116,6 +122,10 @@ module Oxidized
       end
     end
 
+    def find_index(node)
+      index { |e| [e.name, e.ip].include? node }
+    end
+
     private
 
     def initialize(opts = {})
@@ -133,10 +143,6 @@ module Oxidized
       @mutex.synchronize(...)
     end
 
-    def find_index(node)
-      index { |e| [e.name, e.ip].include? node }
-    end
-
     # @param node node which is removed from nodes list
     # @return [Node] deleted node
     def del(node)
@@ -179,6 +185,8 @@ module Oxidized
     def yield_node_output(node_name)
       with_lock do
         node = find { |n| n.name == node_name }
+        raise(NodeNotFound, "unable to find '#{node_name}'") if node.nil?
+
         output = node.output.new
         raise NotSupported unless output.respond_to? :fetch
 

data/lib/oxidized/output/file.rb

@@ -1,55 +1,58 @@
 module Oxidized
-  class OxidizedFile < Output
-    require 'fileutils'
+  module Output
+    # ruby's File class must be accessed with ::File to avoid name conflicts
+    class File < Output
+      require 'fileutils'
 
-    attr_reader :commitref
+      attr_reader :commitref
 
-    def initialize
-      super
-      @cfg = Oxidized.config.output.file
-    end
+      def initialize
+        super
+        @cfg = Oxidized.config.output.file
+      end
 
-    def setup
-      return unless @cfg.empty?
+      def setup
+        return unless @cfg.empty?
 
-      Oxidized.asetus.user.output.file.directory = File.join(Config::ROOT, 'configs')
-      Oxidized.asetus.save :user
-      raise NoConfig, 'no output file config, edit ~/.config/oxidized/config'
-    end
+        Oxidized.asetus.user.output.file.directory = ::File.join(Config::ROOT, 'configs')
+        Oxidized.asetus.save :user
+        raise NoConfig, "no output file config, edit #{Oxidized::Config.configfile}"
+      end
 
-    def store(node, outputs, opt = {})
-      file = File.expand_path @cfg.directory
-      file = File.join File.dirname(file), opt[:group] if opt[:group]
-      FileUtils.mkdir_p file
-      file = File.join file, node
-      File.write(file, outputs.to_cfg)
-      @commitref = file
-    end
+      def store(node, outputs, opt = {})
+        file = ::File.expand_path @cfg.directory
+        file = ::File.join ::File.dirname(file), opt[:group] if opt[:group]
+        FileUtils.mkdir_p file
+        file = ::File.join file, node
+        ::File.write(file, outputs.to_cfg)
+        @commitref = file
+      end
 
-    def fetch(node, group)
-      cfg_dir   = File.expand_path @cfg.directory
-      node_name = node.name
-
-      if group # group is explicitly defined by user
-        cfg_dir = File.join File.dirname(cfg_dir), group
-        File.read File.join(cfg_dir, node_name)
-      elsif File.exist? File.join(cfg_dir, node_name) # node configuration file is stored on base directory
-        File.read File.join(cfg_dir, node_name)
-      else
-        path = Dir.glob(File.join(File.dirname(cfg_dir), '**', node_name)).first # fetch node in all groups
-        File.read path
+      def fetch(node, group)
+        cfg_dir   = ::File.expand_path @cfg.directory
+        node_name = node.name
+
+        if group # group is explicitly defined by user
+          cfg_dir = ::File.join ::File.dirname(cfg_dir), group
+          ::File.read ::File.join(cfg_dir, node_name)
+        elsif ::File.exist? ::File.join(cfg_dir, node_name) # node configuration file is stored on base directory
+          ::File.read ::File.join(cfg_dir, node_name)
+        else
+          path = Dir.glob(::File.join(::File.dirname(cfg_dir), '**', node_name)).first # fetch node in all groups
+          ::File.read path
+        end
+      rescue Errno::ENOENT
+        nil
       end
-    rescue Errno::ENOENT
-      nil
-    end
 
-    def version(_node, _group)
-      # not supported
-      []
-    end
+      def version(_node, _group)
+        # not supported
+        []
+      end
 
-    def get_version(_node, _group, _oid)
-      'not supported'
+      def get_version(_node, _group, _oid)
+        'not supported'
+      end
     end
   end
 end