oxidized 0.35.0 → 0.37.0

data/lib/oxidized/model/h3c.rb

@@ -3,7 +3,7 @@ class H3C < Oxidized::Model
 
   # H3C
 
-  prompt /^.*([<\[][\w.-]+[>\]])$/
+  prompt /^[<\[][\w.-]+[>\]]$/
   comment '# '
 
   cmd :secret do |cfg|

data/lib/oxidized/model/ios.rb

@@ -54,6 +54,13 @@ class IOS < Oxidized::Model
     cfg
   end
 
+  cmd :significant_changes do |cfg|
+    cfg.reject_lines [
+      /^! (Last|No) configuration change (at|since)/,
+      '! NVRAM config last updated at'
+    ]
+  end
+
   cmd 'show version' do |cfg|
     comments = []
     comments << cfg.lines.first
@@ -105,6 +112,8 @@ class IOS < Oxidized::Model
         comments << "CPU:#{slave} #{cpu}#{cpuxtra}#{slaveslot}"
       end
 
+      comments << line.chomp if line.start_with?('Motherboard')
+
       comments << "Image: #{Regexp.last_match(1)}" if line =~ /^System image file is "([^"]*)"$/
     end
     comments << "\n"
@@ -126,12 +135,17 @@ class IOS < Oxidized::Model
     cmd_line = 'show running-config'
     cmd_line += ' view full' if vars(:ios_rbac)
     cmd cmd_line do |cfg|
-      cfg = cfg.each_line.to_a[3..-1]
-      cfg = cfg.reject { |line| line.match /^ntp clock-period / }.join
-      cfg = cfg.each_line.reject do |line|
-        line.match /^! (Last|No) configuration change (at|since).*/ unless line =~ /\d+\sby\s\S+$/
-      end.join
-      cfg.gsub! /^Current configuration : [^\n]*\n/, ''
+      cfg = cfg.cut_head(3)
+      cfg = cfg.reject_lines [
+        /^ntp clock-period /,
+        /^Current configuration : \S+/
+      ]
+      unless vars("output_store_mode") == "on_significant"
+        cfg = cfg.reject_lines [
+          # Only store the line "configuration change" when a user is specified
+          /^! (Last|No) configuration change (at|since)(?!.*\d+ by \S+$)/
+        ]
+      end
       cfg.gsub! /^ tunnel mpls traffic-eng bandwidth[^\n]*\n*(
                     (?: [^\n]*\n*)*
                     tunnel mpls traffic-eng auto-bw)/mx, '\1'
@@ -147,17 +161,11 @@ class IOS < Oxidized::Model
   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 'terminal length 0'
     post_login 'terminal width 0'
     pre_logout 'exit'
   end
+
+  # preferred way to handle additional passwords (enable)
+  macro :enable
 end

data/lib/oxidized/model/ironware.rb

@@ -22,9 +22,11 @@ class IronWare < Oxidized::Model
   end
 
   cmd 'show version' do |cfg|
-    cfg.gsub! /(^((.*)[Ss]ystem uptime(.*))$)/, '' # remove unwanted line system uptime
-    cfg.gsub! /(^((.*)[Tt]he system started at(.*))$)/, ''
-    cfg.gsub! /[Uu]p\s?[Tt]ime is .*/, ''
+    cfg = cfg.reject_lines [
+      /(^((.*)[Ss]ystem uptime(.*))$)/,
+      /(^((.*)[Tt]he system started at(.*))$)/,
+      /[Uu]p\s?[Tt]ime is .*/
+    ]
 
     comment cfg
   end

data/lib/oxidized/model/ivanti.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class Ivanti < Oxidized::Model
+  BINARY_CONFIG_PATH = '/api/v1/system/binary-configuration'
+  REALM_AUTH_PATH    = '/api/v1/realm_auth'
+  DEFAULT_REALM      = 'Users'
+
+  cmd BINARY_CONFIG_PATH do |b64|
+    b64.to_s.lines.map(&:strip).join
+  end
+
+  cfg :http do
+    @secure = true
+    @port   = 443
+
+    @username = @node.auth[:username]
+    @password = @node.auth[:password]
+
+    realm   = vars(:realm) || DEFAULT_REALM
+    payload = { realm: realm }.to_json
+
+    response_body = post_http(
+      REALM_AUTH_PATH,
+      payload,
+      'Content-Type'  => 'application/json',
+      'Authorization' => basic_auth_header
+    )
+
+    begin
+      login_data = JSON.parse(response_body)
+    rescue JSON::ParserError => e
+      logger.error(
+        "Failed to parse realm_auth response: #{e.class}: #{e.message}, body=#{response_body.inspect}"
+      )
+      raise Oxidized::OxidizedError, 'Ivanti: realm_auth returned invalid JSON'
+    end
+
+    api_key = login_data['api_key']
+
+    if api_key.nil? || api_key.empty?
+      logger.error(
+        "Failed to obtain api_key from realm_auth, response=#{response_body.inspect}"
+      )
+      raise Oxidized::OxidizedError, 'Ivanti: realm_auth did not return valid api_key'
+    end
+
+    @username = api_key
+    @password = ''
+
+    logger.debug "Obtained api_key #{api_key[0, 4]}... (len=#{api_key.length})"
+  end
+end

data/lib/oxidized/model/junos.rb

@@ -44,8 +44,8 @@ class JunOS < Oxidized::Model
 
   cmd('show chassis hardware') { |cfg| comment cfg }
   cmd('show system license') do |cfg|
-    cfg.gsub!(/  fib-scale\s+(\d+)/, '  fib-scale                       <count>')
-    cfg.gsub!(/  rib-scale\s+(\d+)/, '  rib-scale                       <count>')
+    cfg.gsub!(/  fib[-\s]scale\s+(\d+)/i, '  fib-scale                       <count>')
+    cfg.gsub!(/  rib[-\s]scale\s+(\d+)/i, '  rib-scale                       <count>')
     comment cfg
   end
   cmd('show system license keys') { |cfg| comment cfg }

data/lib/oxidized/model/linuxgeneric.rb

@@ -1,8 +1,9 @@
 class LinuxGeneric < Oxidized::Model
   using Refinements
 
-  prompt /^(\w.*|\W.*)[:#$] /
+  prompt /^\S.*[#$] $/
   comment '# '
+  clean :escape_codes
 
   # add a comment in the final conf
   def add_comment(comment)
@@ -53,7 +54,7 @@ class LinuxGeneric < Oxidized::Model
   end
 
   cfg :telnet do
-    username /^Username:/
+    username /(Username|[Ll]ogin):/
     password /^Password:/
   end
 
@@ -63,6 +64,7 @@ class LinuxGeneric < Oxidized::Model
         cmd "sudo su -", /^\[sudo\] password/
         cmd @node.auth[:password]
       elsif vars(:enable)
+        # This will only work without localisation (de: "Passwort:", fr: "Mot de passe :"...)
         cmd "su -", /^Password:/
         cmd vars(:enable)
       end

data/lib/oxidized/model/macros.rb

@@ -0,0 +1,60 @@
+module Oxidized
+  class Model
+    module Macros
+      using Refinements
+      VERBS = %i[
+        macro
+        clean
+      ].freeze
+
+      VERBS.each do |verb|
+        define_method(verb) do |name, *args, **kwargs, &block|
+          send("#{verb}_#{name}", *args, **kwargs, &block)
+        end
+      end
+
+      private
+
+      def macro_enable(regex: /password/i, inputs: %i[telnet ssh], command: "enable")
+        inputs = [inputs].flatten.map(&:to_sym)
+        cfg(*inputs) do
+          post_login do
+            if vars(:enable) == true
+              cmd command
+            elsif vars(:enable)
+              cmd command, regex
+              cmd vars(:enable)
+            end
+          end
+        end
+      end
+
+      def clean_escape_codes
+        ansi_escape_regex = /
+          \r?        # Optional carriage return at start
+          \e         # ESC character - starts escape sequence
+          (?:        # Non-capturing group for different sequence types:
+            # Type 1: CSI (Control Sequence Introducer)
+            \[       # Literal '[' - starts CSI sequence
+            [0-?]*   # Parameter bytes: digits (0-9), semicolon, colon, etc.
+            [ -\/]*  # Intermediate bytes: space through slash characters
+            [@-~]    # Final byte: determines the actual command
+          |          # OR
+            # Type 2: Simple escape
+            [=>]     # Single character commands after ESC
+          )
+          \r?        # Optional carriage return at end
+        /x
+        expect ansi_escape_regex do |data, re|
+          data.gsub re, ''
+        end
+      end
+
+      def clean_cut(head: 1, tail: 1)
+        cmd :all do |cfg|
+          cfg.cut_both(head, tail)
+        end
+      end
+    end
+  end
+end

data/lib/oxidized/model/mlnxos.rb

@@ -15,10 +15,6 @@ class MLNXOS < Oxidized::Model
 
   cmd :all do |cfg|
     cfg.gsub! /.\x08/, '' # Remove Backspace char
-    cfg.gsub! /^CPU load averages:\s.+/, '' # Omit constantly changing CPU info
-    cfg.gsub! /^System memory:\s.+/, '' # Omit constantly changing memory info
-    cfg.gsub! /^Uptime:\s.+/, '' # Omit constantly changing uptime info
-    cfg.gsub! /.+Generated at\s\d+.+/, '' # Omit constantly changing generation time info
     cfg.lines.to_a[2..-3].join
   end
 
@@ -29,17 +25,25 @@ class MLNXOS < Oxidized::Model
   end
 
   cmd 'show version' do |cfg|
-    comment cfg
+    cfg = cfg.reject_lines [
+      /^CPU load averages:\s.+/, # Omit constantly changing CPU info
+      /^System memory:\s.+/,     # Omit constantly changing memory info
+      /^Uptime:\s.+/             # Omit constantly changing uptime info
+    ]
+    comment cfg + "\n"
   end
 
   cmd 'show inventory' do |cfg|
-    comment cfg
+    comment cfg + "\n"
   end
 
   cmd 'enable'
 
   cmd 'show running-config' do |cfg|
-    cfg
+    cfg.reject_lines [
+      # Omit constantly changing generation time info
+      /.+Generated at\s\d+.+/
+    ]
   end
 
   cfg :ssh do

data/lib/oxidized/model/model.rb

@@ -1,5 +1,8 @@
 require 'strscan'
 require_relative 'outputs'
+require_relative 'dslsetup'
+require_relative 'dslcommands'
+require_relative 'macros'
 
 module Oxidized
   class Model
@@ -7,6 +10,11 @@ module Oxidized
 
     using Refinements
 
+    # Domain Specific Language for models
+    extend Oxidized::Model::DSLSetup
+    extend Oxidized::Model::DSLCommands
+    extend Oxidized::Model::Macros
+
     include Oxidized::Config::Vars
 
     # rubocop:disable Style/FormatStringToken
@@ -25,6 +33,8 @@ module Oxidized
           klass.instance_variable_set '@comment', nil
           klass.instance_variable_set '@prompt',  nil
           klass.instance_variable_set '@metadata', {}
+          klass.instance_variable_set '@inputs', nil
+
         else # we're subclassing some existing model, take its variables
           instance_variables.each do |var|
             iv = instance_variable_get(var)
@@ -33,136 +43,20 @@ module Oxidized
           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|
-          process_args_block(@cfg[method.to_s], args, block)
-        end
-      end
-
-      def cfgs
-        @cfg
-      end
-
-      def cmd(cmd_arg = nil, **args, &block)
-        if cmd_arg.instance_of?(Symbol)
-          process_args_block(@cmd[cmd_arg], args, block)
-        else
-          # Normal command
-          process_args_block(@cmd[:cmd], args,
-                             { cmd: cmd_arg, args: args, block: block })
-        end
-        logger.debug "Added #{cmd_arg} to the commands list"
-      end
-
-      def metadata(position, value = nil, &block)
-        return unless %i[top bottom].include? position
-
-        if block_given?
-          @metadata[position] = block
-        else
-          @metadata[position] = value
-        end
-      end
-
-      def cmds
-        @cmd
-      end
-
-      def expect(regex, **args, &block)
-        process_args_block(@expect, args, [regex, block])
-      end
-
-      def expects
-        @expect
-      end
-
-      def clean(what)
-        case what
-        when :escape_codes
-          ansi_escape_regex = /
-            \r?        # Optional carriage return at start
-            \e         # ESC character - starts escape sequence
-            (?:        # Non-capturing group for different sequence types:
-              # Type 1: CSI (Control Sequence Introducer)
-              \[       # Literal '[' - starts CSI sequence
-              [0-?]*   # Parameter bytes: digits (0-9), semicolon, colon, etc.
-              [ -\/]*  # Intermediate bytes: space through slash characters
-              [@-~]    # Final byte: determines the actual command
-            |          # OR
-              # Type 2: Simple escape
-              [=>]     # Single character commands after ESC
-            )
-            \r?        # Optional carriage return at end
-          /x
-          expect ansi_escape_regex do |data, re|
-            data.gsub re, ''
-          end
-        end
-      end
-
-      # calls the block at the end of the model, prepending the output of the
-      # block to the output string
-      #
-      # @yield expects block which should return [String]
-      # @return [void]
-      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
-      # to the output string
-      #
-      # @yield expects block which should return [String]
-      # @return [void]
-      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
-      attr_reader :procs
-
-      private
-
-      def process_args_block(target, args, block)
-        if args[:clear]
-          if block.instance_of?(Array)
-            target.reject! { |k, _| k == block[0] }
-            target.push(block)
-          elsif block.instance_of?(Hash)
-            target.reject! { |item| item[:cmd] == block[:cmd] }
-            target.push(block)
-          else
-            target.replace([block])
-          end
-        else
-          method = args[:prepend] ? :unshift : :push
-          target.send(method, block)
-        end
-      end
     end
 
     attr_accessor :input, :node
 
-    def cmd(string, &block)
+    # input specifies to run this command only with this input type
+    # if input is not specified, always run the command
+    def cmd(string, input: nil, &block)
       logger.debug "Executing #{string}"
-      out = @input.cmd(string)
+      out = if input.nil? || input.include?(@input.to_sym)
+              out = @input.cmd(string)
+            else
+              # Do not run this command
+              return ''
+            end
       return false unless out
 
       out = out.b unless Oxidized.config.input.utf8_encoded?
@@ -245,6 +139,7 @@ module Oxidized
       data
     end
 
+    # Get the commands from the model
     def get
       logger.debug 'Collecting commands\' outputs'
       outputs = Outputs.new
@@ -255,7 +150,7 @@ module Oxidized
 
         next if args.include?(:if) && !instance_exec(&args[:if])
 
-        out = cmd command, &block
+        out = cmd command, input: args[:input], &block
         return false unless out
 
         outputs << out
@@ -306,6 +201,13 @@ module Oxidized
       @input.class.to_s.match(/Telnet/) || vars(:ssh_no_exec)
     end
 
+    def significant_changes(config)
+      self.class.cmds[:significant_changes].each do |block|
+        config = instance_exec config, &block
+      end
+      config
+    end
+
     private
 
     def process_cmd_output(output, name)

data/lib/oxidized/model/ndms.rb

@@ -22,4 +22,10 @@ class NDMS < Oxidized::Model
     password /^Password:/
     pre_logout 'exit'
   end
+
+  cmd :significant_changes do |cfg|
+    cfg.reject_lines [
+      'Last change:'
+    ]
+  end
 end

data/lib/oxidized/model/netgear.rb

@@ -6,7 +6,7 @@ class Netgear < Oxidized::Model
   clean :escape_codes
 
   # Handle pager for "show version" on old Netgear models: #2394
-  expect /^--More-- or \(q\)uit$/ do |data, re|
+  expect /^--More--(?: or \(q\)uit)?$/ do |data, re|
     send ' '
     data.sub re, ''
   end
@@ -20,7 +20,7 @@ class Netgear < Oxidized::Model
   end
 
   cfg :telnet do
-    username /^(User:|Applying Interface configuration, please wait ...)/
+    username /^(Username:|User:|Applying Interface configuration, please wait ...)/
     password /^Password:/i
   end
 
@@ -58,9 +58,11 @@ class Netgear < Oxidized::Model
     comment cfg
   end
   cmd 'show running-config' do |cfg|
-    cfg.gsub! /(System Up Time\s+).*/, '\\1 <removed>'
+    cfg.gsub! /(System Up Time:?\s+).*/, '\\1 <removed>'
     cfg.gsub! /(Current SNTP Synchronized Time:).*/, '\\1 <removed>'
     cfg.gsub! /(Current System Time:).*/, '\\1 <removed>'
+    # Remove standalone backspace lines
+    cfg.gsub!(/(?:\r?\n)?\x08(?:\r?\n)?/, "\n")
     cfg
   end
 end

data/lib/oxidized/model/nxos.rb

@@ -10,7 +10,10 @@ class NXOS < Oxidized::Model
 
   cmd :secret do |cfg|
     cfg.gsub! /^(snmp-server community).*/, '\\1 <secret hidden>'
-    cfg.gsub! /^(snmp-server user (\S+) (\S+) auth (\S+)) (\S+) (priv) (\S+)/, '\\1 <secret hidden> '
+    cfg.gsub!(
+      /^(snmp-server user \S+ \S+ auth \S+) \S+ (priv \S+) \S+ /,
+      '\\1 <secret hidden> \\2 <secret hidden> '
+    )
     cfg.gsub! /^(snmp-server host.*? )\S+( udp-port \d+)?$/, '\\1<secret hidden>\\2'
     cfg.gsub! /^(snmp-server mib community-map) \S+ ?(.*)/, '\\1 <secret hidden> \\2'
     cfg.gsub! /(password \d+) (\S+)/, '\\1 <secret hidden>'
@@ -25,8 +28,8 @@ class NXOS < Oxidized::Model
   end
 
   cmd 'show inventory all' do |cfg|
-    if cfg.include? "% Invalid parameter detected at '^' marker."
-      # 'show inventory all' isn't supported on older versions (See Issue #3657)
+    if cfg.match? /^% Invalid .* at '\^' marker\./
+      # 'show inventory all' isn't supported on older versions (See Issues #3657, #3779)
       cfg = cmd 'show inventory'
     end
     comment cfg

data/lib/oxidized/model/outputs.rb

@@ -31,6 +31,11 @@ module Oxidized
         @outputs.map { |out| out.type }.uniq.compact
       end
 
+      def merge!(other)
+        other.all.each { |o| @outputs << o }
+        self
+      end
+
       private
 
       def initialize

data/lib/oxidized/model/perle.rb

@@ -5,7 +5,8 @@ class Perle < Oxidized::Model
   comment '! '
 
   cmd :all do |cfg|
-    cfg.cut_both
+    cfg = cfg.cut_both
+    cfg.delete "\r"
   end
 
   cmd 'show version verbose' do |cfg|
@@ -17,17 +18,22 @@ class Perle < Oxidized::Model
   end
 
   cmd 'show interfaces transceiver' do |cfg|
-    out = []
-    cfg.each_line do |line|
-      out << line if line =~ /SFP Information/
-      out << line if line =~ /Vendor Name/
-      out << line if line =~ /Vendor Serial Number/
-    end
-    comment out.join + "\n"
+    cfg = cfg.keep_lines [
+      'SFP Information',
+      'Vendor Name',
+      'Vendor Serial Number'
+    ]
+    comment cfg + "\n"
   end
 
   cmd 'show running-config'
 
+  cmd :significant_changes do |cfg|
+    cfg.reject_lines [
+      /^tacacs-server key 7 \$0\$\S+==$/
+    ]
+  end
+
   cfg :ssh do
     post_login 'terminal length 0'
     pre_logout 'exit'

data/lib/oxidized/model/routeros.rb

@@ -29,6 +29,10 @@ class RouterOS < Oxidized::Model
     comment cfg
   end
 
+  cmd :significant_changes do |cfg|
+    cfg.gsub(/^(#\s+installed-version: [^\n]+\n).*?^(?=# software id)/m, '\1')
+  end
+
   post do
     logger.debug "Running /export for routeros version #{@ros_version}"
     run_cmd = if vars(:remove_secret)

data/lib/oxidized/model/smartbyte.rb

@@ -0,0 +1,48 @@
+class SmartByte < Oxidized::Model
+  using Refinements
+
+  comment '! '
+
+  cmd :secret do |cfg|
+    cfg.gsub!(/group (\S+) v2c/, 'group <hidden> v2c')
+    cfg.gsub!(/community (\S+)/, 'community <hidden>')
+    cfg
+  end
+
+  cmd :all do |cfg|
+    cfg = cfg.delete("\r")
+    cfg.cut_tail
+  end
+
+  cmd 'show running-config'
+
+  cmd 'show version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show interface optical-transceiver info' do |cfg|
+    cfg.gsub! /^\|Transceiver current alarm information:           \|\s+\+-------------------------------------------------\+.*?\s+\+-------------------------------------------------\+\s+/m, ''
+    comment cfg
+  end
+
+  cmd 'show power' do |cfg|
+    comment cfg
+  end
+
+  cfg :telnet do
+    username /^.*? login:/
+    password /^Password:/
+  end
+
+  cfg :telnet, :ssh do
+    post_login do
+      if vars(:enable)
+        cmd "enable", /^[pP]assword:/
+        cmd vars(:enable)
+      end
+    end
+
+    post_login 'terminal length 0'
+    pre_logout 'exit'
+  end
+end