oxidized 0.24.0 → 0.25.0

data/docs/Model-Notes/XGS4600-Zyxel.md

@@ -1,5 +1,4 @@
-ZynOS Configuration
-===================
+# ZynOS Configuration
 
 ## FTP
 

data/docs/Ruby-API.md

@@ -43,6 +43,8 @@ it at least once is required for a model to work.
 The block may contain commands to change some behaviour for the given methods
 (e.g. calling `post_login` to disable the pager).
 
+Supports [monkey patching](#monkey-patching).
+
 #### `cmd`
 
 Is used to specify commands that should be executed on a model in order to
@@ -75,6 +77,8 @@ string.
 Execution order is `:all`, `:secret`, and lastly the command specific block, if
 given.
 
+Supports [monkey patching](#monkey-patching).
+
 #### `comment`
 
 Called with a single string containing the string to prepend for comments in
@@ -99,6 +103,8 @@ The passed data is replaced by the return value of the block.
 `expect` can be used to, for example, strip escape sequences from output before
 it's further processed.
 
+Supports [monkey patching](#monkey-patching).
+
 ### At the second level
 
 The following methods are available:
@@ -119,7 +125,11 @@ Used inside `cfg` invocations to specify commands to run once Oxidized has
 logged in to the device. Takes one argument that is either a block (taking zero
 parameters) or a string containing a command to execute.
 
-This allows `post_login` to be used for any model-specific items prior to running the regular commands. This could include disabling the output pager or timestamp outputs that would cause constant differences.
+This allows `post_login` to be used for any model-specific items prior to
+running the regular commands. This could include disabling the output pager
+or timestamp outputs that would cause constant differences.
+
+Supports [monkey patching](#monkey-patching).
 
 #### `pre_logout`
 
@@ -127,9 +137,51 @@ Used to specify commands to run before Oxidized closes the connection to the
 device. Takes one argument that is either a block (taking zero parameters) or a
 string containing a command to execute.
 
-This allows `pre_logout` to be used to 'undo' any changes that may have been needed via `post_login` (restore pager output, etc.)
+This allows `pre_logout` to be used to 'undo' any changes that may have been
+needed via `post_login` (restore pager output, etc.)
+
+Supports [monkey patching](#monkey-patching).
 
 #### `send`
 
 Usually used inside `expect` or blocks passed to `post_login`/`pre_logout`.
 Takes a single parameter: a string to be sent to the device.
+
+### Monkey patching
+
+Several model blocks accept behavior-modifying arguments that make monkey
+patching existing blocks easier. This is primarily useful when a user-supplied
+model aims to override or extend existing behavior of a model included in Oxidized.
+
+This functionality is supported by `cfg`, `cmd`, `pre_*`, `post_*`, and `expect`
+blocks.
+
+#### `clear: true`
+
+Resets the existing block, allowing the user to completely override its contents.
+
+#### `prepend: true`
+
+Ensures that the contents of the block are prepended, rather than appended (the
+default) to an existing block.
+
+### `String` convenience methods
+
+Since configuration processing tasks are occasionally similar across models,
+Oxidized provides an extended [`String`](/lib/oxidized/string.rb) class with the
+intention of providing convenience methods and eliminating code duplication.
+
+#### `cut_tail`
+
+Returns a multi-line string without the last line, or an empty string if only a
+single line was present.
+
+#### `cut_head`
+
+Returns a multi-line string without the first line, or an empty string if only a
+single line was present.
+
+#### `cut_both`
+
+Returns a multi-line string without the first and last lines, or an empty string
+if fewer than three lines were present.

data/docs/Supported-OS-Types.md

@@ -6,6 +6,8 @@
   * [ACOS](/lib/oxidized/model/acos.rb)
 * Accedian Performance Elements (NIDs)
   * [AEN](/lib/oxidized/model/aen.rb)
+* Adtran
+  * [Total Access (AOS)](/lib/oxidized/model/adtran.rb)
 * Alcatel-Lucent
   * [AOS](/lib/oxidized/model/aos.rb)
   * [AOS7](/lib/oxidized/model/aos7.rb)
@@ -38,6 +40,8 @@
   * [Vyatta](/lib/oxidized/model/vyatta.rb)
   * [6910](/lib/oxidized/model/br6910.rb)
   * [SLX-OS](/lib/oxidized/model/slxos.rb)
+* Calix
+  * [AXOS](/lib/oxidized/model/axos.rb)
 * Casa
   * [Casa](/lib/oxidized/model/casa.rb)
 * Check Point
@@ -65,6 +69,8 @@
   * [Groove](/lib/oxidized/model/coriantgroove.rb)
 * ComNet
   * [ComNet Microsemi Switch](/lib/oxidized/model/comnetms.rb)
+* Comtrol
+  * [RocketLinx](/lib/oxidized/model/comtrol.rb)
 * Cumulus
   * [Linux](/lib/oxidized/model/cumulus.rb)
 * DataCom
@@ -74,8 +80,11 @@
 * DELL
   * [PowerConnect](/lib/oxidized/model/powerconnect.rb)
   * [AOSW](/lib/oxidized/model/aosw.rb)
+  * [DellX](/lib/oxidized/model/dellx.rb)
 * D-Link
   * [D-Link](/lib/oxidized/model/dlink.rb)
+* ECI Telecom
+  * [ECIapollo](/lib/oxidized/model/eciapollo.rb)
 * EdgeCore
   * [ES3528M](/lib/oxidized/model/edgecos.rb)
 * Ericsson/Redback
@@ -84,10 +93,13 @@
   * [Enterasys](/lib/oxidized/model/enterasys.rb)
   * [WM](/lib/oxidized/model/mtrlrfs.rb)
   * [XOS](/lib/oxidized/model/xos.rb)
+  * [ExtremeWare](/lib/oxidized/model/xos.rb)
 * F5
   * [TMOS](/lib/oxidized/model/tmos.rb)
 * Fiberstore
   * [S3800](/lib/oxidized/model/gcombnps.rb)
+* Firebrick
+  * [FBxxxx](/lib/oxidized/model/firebrick.rb)
 * Force10
   * [DNOS](/lib/oxidized/model/dnos.rb)
   * [FTOS](/lib/oxidized/model/ftos.rb)

data/extra/oxidized.service

@@ -1,4 +1,10 @@
 #For debian 8 put it in /lib/systemd/system/
+#To set OXIDIZED_HOME instead of the default:
+# ~${oxidized_user}/.config/oxidized in debian 8, then uncomment
+#(and modify as required) the "Environment" variable below so
+#systemd sets the correct environment. Tested only on Debian 8.8.
+#YMMV otherwise.
+#
 #For RHEL / CentOS 7 put it in /etc/systemd/system/
 #and call it with systemctl start oxidized.service
 
@@ -11,6 +17,7 @@ Wants=network-online.target
 ExecStart=/usr/local/bin/oxidized
 User=oxidized
 KillSignal=SIGKILL
+#Environment="OXIDIZED_HOME=/etc/oxidized"
 
 [Install]
 WantedBy=multi-user.target

data/lib/oxidized/cli.rb

@@ -43,6 +43,11 @@ module Oxidized
       opts = Slop.new(:help => true) do
         on 'd', 'debug', 'turn on debugging'
         on 'daemonize',  'Daemonize/fork the process'
+        on 'show-exhaustive-config', 'output entire configuration, including defaults' do
+          asetus = Config.load
+          puts asetus.to_yaml asetus.cfg
+          Kernel.exit
+        end
         on 'v', 'version', 'show version' do
           puts Oxidized::VERSION_FULL
           Kernel.exit
@@ -85,8 +90,10 @@ module Oxidized
 
     def pid_status(pidfile)
       return :exited unless File.exists?(pidfile)
+
       pid = ::File.read(pidfile).to_i
       return :dead if pid == 0
+
       Process.kill(0, pid)
       :running
     rescue Errno::ESRCH

data/lib/oxidized/config.rb

@@ -35,6 +35,9 @@ module Oxidized
       asetus.default.models        = {}               # model level configuration
       asetus.default.pid           = File.join(Oxidized::Config::Root, 'pid')
 
+      asetus.default.crash.directory = File.join(Oxidized::Config::Root, 'crashes')
+      asetus.default.crash.hostnames = false
+
       asetus.default.stats.history_size = 10
       asetus.default.input.default      = 'ssh, telnet'
       asetus.default.input.debug        = false # or String for session log file

data/lib/oxidized/core.rb

@@ -13,6 +13,7 @@ module Oxidized
       Oxidized.Hooks = HookManager.from_config(Oxidized.config)
       nodes = Nodes.new
       raise NoNodesFound, 'source returns no usable nodes' if nodes.size == 0
+
       @worker = Worker.new nodes
       trap('HUP') { nodes.load }
       if Oxidized.config.rest?

data/lib/oxidized/hook/ciscosparkdiff.rb

@@ -1,7 +1,7 @@
 require 'cisco_spark'
 
 # defaults to posting a diff, if messageformat is supplied them a message will be posted too
-# diffenable defaults to true
+# diff defaults to true
 # Modified from slackdiff
 
 class CiscoSparkDiff < Oxidized::Hook
@@ -13,37 +13,31 @@ class CiscoSparkDiff < Oxidized::Hook
   def run_hook(ctx)
     return unless ctx.node
     return unless ctx.event.to_s == "post_store"
+
     log "Connecting to Cisco Spark"
     CiscoSpark.configure do |config|
       config.api_key = cfg.accesskey
       config.proxy = cfg.proxy if cfg.has_key?('proxy')
     end
-    space = cfg.space
-    client = CiscoSpark::Room.new(id: space)
-    client.fetch
+    room = CiscoSpark::Room.new(id: cfg.space)
     log "Connected"
-    diffenable = true
-    if cfg.has_key?('diff') == true
-      if cfg.diff == false
-        diffenable = false
-      end
-    end
-    if diffenable == true
+
+    if cfg.has_key?("diff") ? cfg.diff : true
       gitoutput = ctx.node.output.new
       diff = gitoutput.get_diff ctx.node, ctx.node.group, ctx.commitref, nil
       title = ctx.node.name.to_s
       log "Posting diff as snippet to #{cfg.space}"
-      message = CiscoSpark::Message.new(text: 'Device ' + title + ' modified:' + "\n" + diff[:patch].lines.to_a[4..-1].join)
-      room = CiscoSpark::Room.new(id: space)
-      room.send_message(message)
+      room.send_message CiscoSpark::Message.new(text: 'Device ' + title + ' modified:' + "\n" + diff[:patch].lines.to_a[4..-1].join)
     end
-    if cfg.has_key?('message') == true
+
+    if cfg.message?
       log cfg.message
-      msg = cfg.message % { :node => ctx.node.name.to_s, :group => ctx.node.group.to_s, :commitref => ctx.commitref, :model => ctx.node.model.class.name.to_s.downcase }
+      msg = cfg.message % { node: ctx.node.name.to_s, group: ctx.node.group.to_s, commitref: ctx.commitref, model: ctx.node.model.class.name.to_s.downcase }
       log msg
       log "Posting message to #{cfg.space}"
-      client.chat_postMessage(channel: cfg.channel, text: msg, as_user: true)
+      room.send_message CiscoSpark::Message.new(text: msg)
     end
+
     log "Finished"
   end
 end

data/lib/oxidized/hook/slackdiff.rb

@@ -1,7 +1,7 @@
 require 'slack'
 
 # defaults to posting a diff, if messageformat is supplied them a message will be posted too
-# diffenable defaults to true
+# diff defaults to true
 
 class SlackDiff < Oxidized::Hook
   def validate_cfg!
@@ -12,6 +12,7 @@ class SlackDiff < Oxidized::Hook
   def run_hook(ctx)
     return unless ctx.node
     return unless ctx.event.to_s == "post_store"
+
     log "Connecting to slack"
     Slack.configure do |config|
       config.token = cfg.token
@@ -20,14 +21,7 @@ class SlackDiff < Oxidized::Hook
     client = Slack::Client.new
     client.auth_test
     log "Connected"
-    # diff snippet - default
-    diffenable = true
-    if cfg.has_key?('diff') == true
-      if cfg.diff == false
-        diffenable = false
-      end
-    end
-    if diffenable == true
+    if cfg.has_key?("diff") ? cfg.diff : true
       gitoutput = ctx.node.output.new
       diff = gitoutput.get_diff ctx.node, ctx.node.group, ctx.commitref, nil
       unless diff == "no diffs"
@@ -41,9 +35,9 @@ class SlackDiff < Oxidized::Hook
       end
     end
     # message custom formatted - optional
-    if cfg.has_key?('message') == true
+    if cfg.message?
       log cfg.message
-      msg = cfg.message % { :node => ctx.node.name.to_s, :group => ctx.node.group.to_s, :commitref => ctx.commitref, :model => ctx.node.model.class.name.to_s.downcase }
+      msg = cfg.message % { node: ctx.node.name.to_s, group: ctx.node.group.to_s, commitref: ctx.commitref, model: ctx.node.model.class.name.to_s.downcase }
       log msg
       log "Posting message to #{cfg.channel}"
       client.chat_postMessage(channel: cfg.channel, text: msg, as_user: true)

data/lib/oxidized/hook/xmppdiff.rb

@@ -12,6 +12,7 @@ class XMPPDiff < Oxidized::Hook
   def run_hook(ctx)
     return unless ctx.node
     return unless ctx.event.to_s == "post_store"
+
     begin
       Timeout.timeout(15) do
         gitoutput = ctx.node.output.new

data/lib/oxidized/input/ssh.rb

@@ -21,36 +21,10 @@ module Oxidized
       @output      = ''
       @pty_options = { term: "vt100" }
       @node.model.cfg['ssh'].each { |cb| instance_exec(&cb) }
-      secure = Oxidized.config.input.ssh.secure
       @log = File.open(Oxidized::Config::Log + "/#{@node.ip}-ssh", 'w') if Oxidized.config.input.debug?
-      port = vars(:ssh_port) || 22
-
-      ssh_opts = {
-        port:         port.to_i,
-        paranoid:     secure,
-        keepalive:    true,
-        password:     @node.auth[:password], :timeout => Oxidized.config.timeout,
-        number_of_password_prompts: 0,
-      }
-
-      auth_methods = vars(:auth_methods) || %w(none publickey password)
-      ssh_opts[:auth_methods] = auth_methods
-      Oxidized.logger.debug "AUTH METHODS::#{auth_methods}"
-
-      if proxy_host = vars(:ssh_proxy)
-        proxy_command =  "ssh "
-        proxy_command += "-o StrictHostKeyChecking=no " unless secure
-        proxy_command += "#{proxy_host} -W %h:%p"
-        proxy = Net::SSH::Proxy::Command.new(proxy_command)
-        ssh_opts[:proxy] = proxy
-      end
-
-      ssh_opts[:keys] = vars(:ssh_keys).is_a?(Array) ? vars(:ssh_keys) : [vars(:ssh_keys)] if vars(:ssh_keys)
-      ssh_opts[:kex]  = vars(:ssh_kex).split(/,\s*/) if vars(:ssh_kex)
-      ssh_opts[:encryption] = vars(:ssh_encryption).split(/,\s*/) if vars(:ssh_encryption)
 
       Oxidized.logger.debug "lib/oxidized/input/ssh.rb: Connecting to #{@node.name}"
-      @ssh = Net::SSH.start(@node.ip, @node.auth[:username], ssh_opts)
+      @ssh = Net::SSH.start(@node.ip, @node.auth[:username], make_ssh_opts)
       unless @exec
         shell_open @ssh
         begin
@@ -111,6 +85,7 @@ module Oxidized
         end
         ch.request_pty (@pty_options) do |_ch, success_pty|
           raise NoShell, "Can't get PTY" unless success_pty
+
           ch.send_channel_request 'shell' do |_ch, success_shell|
             raise NoShell, "Can't get shell" unless success_shell
           end
@@ -138,9 +113,50 @@ module Oxidized
           sleep 0.1
           match = regexps.find { |regexp| @output.match regexp }
           return match if match
+
           true
         end
       end
     end
+
+    def make_ssh_opts
+      secure = Oxidized.config.input.ssh.secure?
+      ssh_opts = {
+        port:         (vars(:ssh_port) || 22).to_i,
+        paranoid:     secure,
+        keepalive:    vars(:ssh_no_keepalive) ? false : true,
+        password:     @node.auth[:password],
+        timeout:      Oxidized.config.timeout,
+        number_of_password_prompts: 0
+      }
+
+      auth_methods = vars(:auth_methods) || %w(none publickey password)
+      ssh_opts[:auth_methods] = auth_methods
+      Oxidized.logger.debug "AUTH METHODS::#{auth_methods}"
+
+      if proxy_host = vars(:ssh_proxy)
+        proxy_command =  "ssh "
+        proxy_command += "-o StrictHostKeyChecking=no " unless secure
+        if proxy_port = vars(:ssh_proxy_port)
+          proxy_command += "-p #{proxy_port} "
+        end
+        proxy_command += "#{proxy_host} -W %h:%p"
+        proxy = Net::SSH::Proxy::Command.new(proxy_command)
+        ssh_opts[:proxy] = proxy
+      end
+
+      ssh_opts[:keys]       = [vars(:ssh_keys)].flatten if vars(:ssh_keys)
+      ssh_opts[:kex]        = vars(:ssh_kex).split(/,\s*/) if vars(:ssh_kex)
+      ssh_opts[:encryption] = vars(:ssh_encryption).split(/,\s*/) if vars(:ssh_encryption)
+      ssh_opts[:host_key]   = vars(:ssh_host_key).split(/,\s*/) if vars(:ssh_host_key)
+      ssh_opts[:hmac]       = vars(:ssh_hmac).split(/,\s*/) if vars(:ssh_hmac)
+
+      if Oxidized.config.input.debug?
+        ssh_opts[:logger]  = Oxidized.logger
+        ssh_opts[:verbose] = Logger::DEBUG
+      end
+
+      ssh_opts
+    end
   end
 end

data/lib/oxidized/input/telnet.rb

@@ -34,6 +34,7 @@ module Oxidized
 
     def cmd cmd_str, expect = @node.prompt
       return send(cmd_str + "\n") unless expect
+
       Oxidized.logger.debug "Telnet: #{cmd_str} @#{@node.name}"
       args = { 'String'  => cmd_str,
                'Match'   => expect,

data/lib/oxidized/model/acos.rb

@@ -4,7 +4,7 @@ class ACOS < Oxidized::Model
   comment  '! '
 
   # ACOS prompt changes depending on the state of the device
-  prompt /^([-\w.\/:?\[\]\(\)]+[#>]\s?)$/
+  prompt /^([-\w.\/:?\[\]()]+[#>]\s?)$/
 
   cmd :secret do |cfg|
     cfg.gsub!(/community read encrypted (\S+)/, 'community read encrypted <hidden>') # snmp
@@ -60,7 +60,7 @@ class ACOS < Oxidized::Model
 
   cmd :all do |cfg, cmdstring|
     new_cfg = comment "COMMAND: #{cmdstring}\n"
-    new_cfg << cfg.each_line.to_a[1..-2].join
+    new_cfg << cfg.cut_both
   end
 
   pre do

data/lib/oxidized/model/acsw.rb

@@ -4,7 +4,7 @@ class ACSW < Oxidized::Model
 
   cmd :all do |cfg|
     cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
-    cfg.each_line.to_a[1..-2].join
+    cfg.cut_both
   end
 
   cmd :secret do |cfg|
@@ -36,11 +36,11 @@ class ACSW < 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! /^\ tunnel\ mpls\ traffic-eng\ bandwidth[^\n]*\n*(
-                  (?:\ [^\n]*\n*)*
-                  tunnel\ mpls\ traffic-eng\ auto-bw)/mx, '\1'
-    cfg.gsub! /^([\s\t\!]*Last configuration change ).*/, ''
-    cfg.gsub! /^([\s\t\!]*NVRAM config last ).*/, ''
+    cfg.gsub! /^ tunnel mpls traffic-eng bandwidth[^\n]*\n*(
+                  (?: [^\n]*\n*)*
+                  tunnel mpls traffic-eng auto-bw)/mx, '\1'
+    cfg.gsub! /^([\s\t!]*Last configuration change ).*/, ''
+    cfg.gsub! /^([\s\t!]*NVRAM config last ).*/, ''
     cfg
   end