oxidized 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25fe620dbb51b1d8dacb76a070dc15a94701276f
-  data.tar.gz: f652f415b1b70df26a440e2afc79f52a911cd113
+  metadata.gz: 4293285f8095f28f9f3d38dc2d606a03a58d163b
+  data.tar.gz: f108592ebdce488d10f06d7ee0e5545e3e117e32
 SHA512:
-  metadata.gz: 584f5467dc20399b3c81d906e7b8531970d75ae4a04c8d190e999218c78dbfc0b42f31cc3d0913ca10afbadd3f279ff91c702ec2364bf9763c09dceb88ad9e34
-  data.tar.gz: 974ed7ba183e5d91b067d993da98568ba708243df949b18a9c8de4913c0500151b8f4b0cae28720e5e21d56a5e578c0e1109c1a8c59cebb473cb08bb926edf97
+  metadata.gz: aed22b16c6223c5b27a6b68476e25aea4154fcafd104a8567f7f19c4de38c8dddcd3fe18e1fd0950bc6e01e927d6af2fed514dd8f966eb33670f2a3517c6285f
+  data.tar.gz: 62a21f8caa39a27c853d2d56b3b96d35f6320db5cf6743ea76dd0cb7c6562729a0b96b5cc9b83524ad6edaac960dfb07ab88c7bffa526b459248603ba0e71bfa

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 0 17.3
+- FEATURE: "nil", "false" and "true" in source (e.g. router.db) are interpeted as nil, false, true. Empty is now always considered empty string, instead of in some cases nil and some cases empty string.
+- FEATURE: support tftp as input model (@MajesticFalcon)
+- FEATURE: add alvarion model (@MajesticFalcon)
+- FEATURE: detect if ssh wants password terminal/CLI prompt or not
+- FEATURE: node (group, model, username, password) resolution refactoring, supports wider range of use-cases
+- BUGFIX: fetch for file output (@danilopopeye)
+- BUGFIX: net-ssh version specification
+- BUGFIX: routeros, catos, pfsense
+
+# 0.16.3
+- FEATURE: pfsense support (by @stokbaek)
+- BUGFIX: cumulus prompt not working with default switch configs (by @nertwork)
+- BUGFIX: disconnect ssh when prompt wasn't found (by @andir)
+- BUGFIX: saos, asa, acos, timos updates, cumulus
+
 # 0.16.2
 - BUGFIX: when not using git (by @danilopopeye)
 - BUGFIX: screenos update

data/Dockerfile

@@ -3,7 +3,7 @@ MAINTAINER Samer Abdel-Hafez <sam@arahant.net>
 
 RUN add-apt-repository ppa:brightbox/ruby-ng && \
 	apt-get update && \
-  apt-get install -y ruby2.1 ruby2.1-dev libsqlite3-dev libssl-dev pkg-config make cmake
+  apt-get install -y ruby2.3 ruby2.3-dev libsqlite3-dev libssl-dev pkg-config make cmake
 
 RUN gem install oxidized oxidized-web --no-ri --no-rdoc
 

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    oxidized (0.14.3)
+    oxidized (0.17.0)
       asetus (~> 0.1)
-      net-ssh (>= 3.0.0, < 3.1)
+      net-ssh (~> 3.0.2)
+      net-telnet
       rugged (~> 0.21, >= 0.21.4)
       slop (~> 3.5)
 
@@ -14,16 +15,17 @@ GEM
     coderay (1.1.0)
     metaclass (0.0.4)
     method_source (0.8.2)
-    minitest (5.8.3)
+    minitest (5.9.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     net-ssh (3.0.2)
+    net-telnet (0.1.1)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.4.2)
-    rugged (0.24.0)
+    rake (10.5.0)
+    rugged (0.23.3)
     slop (3.6.0)
 
 PLATFORMS
@@ -38,4 +40,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.12.4
+   1.11.2

data/README.md

@@ -1,6 +1,4 @@
-# Oxidized [![Build Status](https://travis-ci.org/Shopify/oxidized.svg)](https://travis-ci.org/Shopify/oxidized)
-
-[![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized)
+# Oxidized [![Build Status](https://travis-ci.org/Shopify/oxidized.svg)](https://travis-ci.org/Shopify/oxidized) [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized) [![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 
 
 Oxidized is a network device configuration backup tool. It's a RANCID replacement!
 
@@ -29,13 +27,16 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
     * [Privileged mode](#privileged-mode)
     * [Disabling SSH exec channels](#disabling-ssh-exec-channels)
     * [Source: CSV](#source-csv)
-    * [Source: SQLite](#source-sqlite)
+    * [Source: SQL](#source-sql)
+      * [Source: SQLite](#source-sqlite)
+      * [Source: Mysql](#source-mysql)
     * [Source: HTTP](#source-http)
     * [Output: GIT](#output-git)
     * [Output: HTTP](#output-http)
     * [Output: File](#output-file)
     * [Output types](#output-types)
     * [Advanced Configuration](#advanced-configuration)
+    * [Advanced Group Configuration](#advanced-group-configuration)
 7. [Ruby API](#ruby-api)
     * [Input](#input)
     * [Output](#output)
@@ -43,97 +44,103 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
     * [Model](#model)
 
 # Supported OS types
+ * Vendor
+   * OS - model_name
 
  * A10 Networks
-   * ACOS
+   * ACOS - acos
  * Alcatel-Lucent
-   * AOS
-   * AOS7
-   * ISAM
-   * TiMOS
+   * AOS - aos
+   * AOS7 - aos7
+   * ISAM - isam
    * Wireless
+ * Alvarion
+   * BreezeACCESS - alvarion
  * Arista
-   * EOS
+   * EOS - eos
  * Arris
-   * C4CMTS
+   * C4CMTS - c4cmts
  * Aruba
-   * AOSW
+   * AOSW - aosw
  * Brocade
-   * FabricOS
-   * Ironware
-   * NOS (Network Operating System)
-   * Vyatta
-   * 6910
+   * FabricOS - fabricos
+   * Ironware - ironware
+   * NOS (Network Operating System) - nos
+   * Vyatta - vyatta
+   * 6910 - br6910
  * Check Point
-   * GaiaOS
+   * GaiaOS - gaiaos
  * Ciena
-   * SOAS
+   * SOAS - saos
  * Cisco
-   * AireOS
-   * ASA
-   * CatOS
-   * IOS
-   * IOSXR
-   * NXOS
-   * SMB (Nikola series)
+   * AireOS - aireos
+   * ASA - asa
+   * CatOS - catos
+   * IOS - ios
+   * IOSXR - iosxr
+   * NXOS - nxos
+   * SMB (Nikola series) 
  * Citrix
-   * NetScaler (Virtual Applicance)
+   * NetScaler (Virtual Applicance) - netscaler
  * Coriant (former Tellabs)
-   * TMOS (8800)
-   * 8600
+   * TMOS (8800) - tmos
+   * 8600 - 
  * Cumulus
    * Linux
  * DataCom
    * DmSwitch 3000
  * DELL
-   * PowerConnect
-   * AOSW
+   * PowerConnect - powerconnect
+   * AOSW - aosw
  * Ericsson/Redback
-   * IPOS (former SEOS)
+   * IPOS (former SEOS) - ipos
  * Extreme Networks
-   * XOS
+   * XOS - xos
    * WM
  * F5
    * TMOS
  * Force10
-   * DNOS
-   * FTOS
+   * DNOS - dnos
+   * FTOS - ftos
  * FortiGate
-   * FortiOS
+   * FortiOS - fortios
  * HP
-   * Comware (HP A-series, H3C, 3Com)
-   * Procurve
+   * Comware (HP A-series, H3C, 3Com) - comware
+   * Procurve - procurve
  * Huawei
    * VRP
  * Juniper
    * JunOS
    * ScreenOS (Netscreen)
  * Mellanox
-   * MLNX-OS
+   * MLNX-OS - mlnxos
  * Mikrotik
-   * RouterOS
+   * RouterOS - routeros
  * Motorola
    * RFS
  * MRV
-   * MasterOS
+   * MasterOS - masteros
  * Netonix
-   * WISP Switch (As Netonix)
+   * WISP Switch (As Netonix) - netonix
+ * Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
+   * SR OS (TiMOS) - timos
  * Opengear
-   * Opengear
+   * Opengear - opengear
  * Palo Alto
-   * PANOS
+   * PANOS - panos
+ * pfSense - pfsense
  * Quanta
-   * Quanta / VxWorks 6.6 (1.1.0.8)
+   * Quanta / VxWorks 6.6 (1.1.0.8) - quantaos
  * Supermicro
-   * Supermicro
+   * Supermicro - supermicro
  * Ubiquiti
-   * AirOS
-   * Edgeos
-   * EdgeSwitch
+   * AirOS - airos
+   * Edgeos - edgeos
+   * EdgeSwitch - edgeswitch
  * Watchguard
-   * Fireware OS
+   * Fireware OS - firewareos
  * Zyxel
-   * ZyNOS
+   * ZyNOS - zynos
 
 
 # Installation
@@ -147,7 +154,7 @@ gem install oxidized-script oxidized-web # if you don't install oxidized-web, ma
 ```
 
 ## CentOS, Oracle Linux, Red Hat Linux
-On CentOS 6 / RHEL 6, install Ruby 1.9.3 or greater (for Ruby 2.1.2 installation instructions see "Installing Ruby 2.1.2 using RVM"), then install Oxidized dependencies
+On CentOS 6 / RHEL 6, install Ruby greater than 1.9.3 (for Ruby 2.1.2 installation instructions see "Installing Ruby 2.1.2 using RVM"), then install Oxidized dependencies
 ```shell
 yum install cmake sqlite-devel openssl-devel libssh2-devel
 ```
@@ -254,46 +261,54 @@ rvm use --default 2.1.2
 ```
 
 # Running with Docker
-1. clone git repo:
+
+clone git repo:
 
 ```
-    root@bla:~# git clone https://github.com/ytti/oxidized
-```
-2. build container locally:
+git clone https://github.com/ytti/oxidized
 ```
-    root@bla:~# docker build -q -t oxidized/oxidized:latest oxidized/
+
+build container locally:
+
 ```
-3. create config directory in main system:
+docker build -q -t oxidized/oxidized:latest oxidized/
 ```
-    root@bla~:# mkdir /etc/oxidized
+
+create config directory in main system:
+
 ```
-4. run container the first time:
+mkdir /etc/oxidized
 ```
-    root@bla:~# docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest oxidized
+
+run container the first time:
+_Note: this step in only needed for creating Oxidized's configuration file and can be skipped if you already have it
+
 ```
-5. add 'router.db' to /etc/oxidized:
+docker run --rm -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest oxidized
 ```
-    root@bla:~# vim /etc/oxidized/router.db
-    [ ... ]
-    root@bla:~#
+
+create the `/etc/oxidized/router.db`
+
 ```
-6. run container again:
+vim /etc/oxidized/router.db
 ```
-    root@bla:~# docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest
-    oxidized[1]: Oxidized starting, running as pid 1
-    oxidized[1]: Loaded 1 nodes
-    Puma 2.13.4 starting...
-    * Min threads: 0, max threads: 16
-    * Environment: development
-    * Listening on tcp://0.0.0.0:8888
-    ^C
 
-    root@bla:~#
+run container again:
+
+```
+docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest
+oxidized[1]: Oxidized starting, running as pid 1
+oxidized[1]: Loaded 1 nodes
+Puma 2.13.4 starting...
+* Min threads: 0, max threads: 16
+* Environment: development
+* Listening on tcp://0.0.0.0:8888
 ```
 
 If you want to have the config automatically reloaded (e.g. when using a http source that changes)
+
 ```
-    root@bla:~# docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest
+docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest
 ```
 
 ## Cookbook
@@ -386,6 +401,31 @@ vars_map:
   ssh_proxy: 3
 ...
 ```
+### Source: SQL
+ Oxidized uses the `sequel` ruby gem. You can use a variety of databases that aren't explicitly listed. For more information visit https://github.com/jeremyevans/sequel Make sure you have the correct adapter!
+### Source: MYSQL
+
+```sudo apt-get install libmysqlclient-dev```
+
+The values correspond to your fields in the DB such that ip, model, etc are field names in the DB
+
+```
+source:
+  default: sql
+  sql:
+    adapter: mysql2
+    database: oxidized
+    table: nodes
+    username: root 
+    password: rootpass
+    map:
+      name: ip 
+      model: model
+      username: username
+      password: password
+    vars_map:
+      enable: enable
+```
 
 ### Source: SQLite
 
@@ -420,6 +460,8 @@ source:
     url: https://url/api
     scheme: https
     delimiter: !ruby/regexp /:/
+    user: username
+    pass: password
     map:
       name: hostname
       model: os
@@ -510,7 +552,7 @@ output:
 
 ### Output types
 
-If you prefer to have different outputs in different files and/or directories, you can easily do this by modifying the corresponding model. To change the behaviour for IOS, you would edit `lib/oxidized/model/ios.rb`.
+If you prefer to have different outputs in different files and/or directories, you can easily do this by modifying the corresponding model. To change the behaviour for IOS, you would edit `lib/oxidized/model/ios.rb` (run `gem contents oxidized` to find out the full file path).
 
 For example, let's say you want to split out `show version` and `show inventory` into separate files in a directory called `nodiff` which your tools will not send automated diffstats for. You can apply a patch along the lines of
 
@@ -570,7 +612,7 @@ rest: 10.0.0.1:8000/oxidized
 
 ### Advanced Configuration
 
-Below is an advanced example configuration. You will be able to (optinally) override options per device. The router.db format used is ```hostname:model:username:password:enable_password```. Hostname and model will be the only required options, all others override the global configuration sections.
+Below is an advanced example configuration. You will be able to (optionally) override options per device. The router.db format used is ```hostname:model:username:password:enable_password```. Hostname and model will be the only required options, all others override the global configuration sections.
 
 ```
 ---
@@ -615,6 +657,28 @@ source:
 model_map:
   cisco: ios
   juniper: junos
+
+```
+
+### Advanced Group Configuration
+
+For group specific credentials
+
+```
+groups:
+  mikrotik:
+    username: admin
+    password: blank
+  ubiquiti:
+    username: ubnt
+    password: ubnt
+```
+and add group mapping
+```
+map:
+  model: 0
+  name: 1
+  group: 2
 ```
 
 # Hooks
@@ -714,7 +778,7 @@ The following objects exist in Oxidized.
 ## Input
  * gets config from nodes
  * must implement 'connect', 'get', 'cmd'
- * 'ssh' and 'telnet' implemented
+ * 'ssh', 'telnet, ftp, and tftp' implemented
 
 ## Output
  * stores config

data/Rakefile

@@ -19,10 +19,10 @@ task :test do
   end
 end
 
-desc 'Install gem'
-task :install => :build do
-  system "sudo -Es sh -c \'umask 022; gem install gems/#{file}\'"
-end
+## desc 'Install gem'
+## task :install => :build do
+##   system "sudo -Es sh -c \'umask 022; gem install gems/#{file}\'"
+## end
 
 desc 'Remove gems'
 task :clean do

data/bin/oxidized

@@ -9,5 +9,6 @@ begin
   Oxidized::CLI.new.run
 rescue => error
   warn "#{error}"
-  raise if Oxidized.config.debug
+  debug = Oxidied.config.debug rescue true
+  raise if debug
 end

data/extra/rest_client.rb

@@ -2,8 +2,30 @@ module Oxidized
   class RestClient
     require 'net/http'
     require 'json'
-    HOST = 'localhost'
-    PORT = 8888
+    require 'uri'
+    require 'asetus'
+
+    class Config
+      Root      = Root = ENV['OXIDIZED_HOME'] || File.join(ENV['HOME'], '.config', 'oxidized')
+    end
+
+    CFGS = Asetus.new :name=>'oxidized', :load=>false, :key_to_s=>true
+    CFGS.default.rest = '127.0.0.1:8888'
+
+    begin
+      CFGS.load
+    rescue => error
+      raise InvalidConfig, "Error loading config: #{error.message}"
+    end
+
+    restcfg = CFGS.cfg.rest
+    unless restcfg.match(/^http:\/\//)
+      restcfg.insert(0, 'http://')
+    end
+
+    HOST = URI(restcfg).host
+    PORT = URI(restcfg).port
+    PATH = URI(restcfg).path
 
     class << self
       def next opt={}, host=HOST, port=PORT
@@ -18,7 +40,7 @@ module Oxidized
 
     def next opt
       data = JSON.dump opt
-      @web.put '/node/next/' + opt[:name].to_s, data
+      @web.put PATH + '/node/next/' + opt[:name].to_s, data
     end
 
   end

data/lib/oxidized/input/cli.rb

@@ -14,6 +14,9 @@ module Oxidized
         d = node.model.get
         disconnect
         d
+      rescue PromptUndetect
+        disconnect
+        raise
       end
 
       def connect_cli

data/lib/oxidized/input/ssh.rb

@@ -42,7 +42,7 @@ module Oxidized
       unless @exec
         shell_open @ssh
         begin
-          @username ? shell_login : expect(@node.prompt)
+          login
         rescue Timeout::Error
           raise PromptUndetect, [ @output, 'not matching configured prompt', @node.prompt ].join(' ')
         end
@@ -102,13 +102,18 @@ module Oxidized
       end
     end
 
-    # Cisco WCS has extremely dubious SSH implementation, SSH auth is always
-    # success, it always opens shell and then run auth in shell. I guess
-    # they'll never support exec() :)
-    def shell_login
-      expect username
-      cmd @node.auth[:username], password
-      cmd @node.auth[:password]
+    # some models have SSH auth or terminal auth based on version of code
+    # if SSH is configured for terminal auth, we'll still try to detect prompt
+    def login
+      if @username
+        match = expect username, @node.prompt
+        if match == username
+          cmd @node.auth[:username], password
+          cmd @node.auth[:password]
+        end
+      else
+        expect @node.prompt
+      end
     end
 
     def exec state=nil
@@ -123,14 +128,18 @@ module Oxidized
       @output
     end
 
-    def expect regexp
-      Oxidized.logger.debug "lib/oxidized/input/ssh.rb: expecting #{regexp.inspect} at #{node.name}"
+    def expect *regexps
+      regexps = [regexps].flatten
+      Oxidized.logger.debug "lib/oxidized/input/ssh.rb: expecting #{regexps.inspect} at #{node.name}"
       Timeout::timeout(Oxidized.config.timeout) do
         @ssh.loop(0.1) do
           sleep 0.1
-          not @output.match regexp
+          match = regexps.find { |regexp| @output.match regexp }
+          return match if match
+          true
         end
       end
     end
+
   end
 end

data/lib/oxidized/input/tftp.rb

@@ -0,0 +1,41 @@
+module Oxidized
+  require 'stringio'
+  require_relative 'cli'
+  
+  begin
+    require 'net/tftp'
+  rescue LoadError
+    raise OxidizedError, 'net/tftp not found: sudo gem install net-tftp'
+  end
+  
+  class TFTP < Input
+    
+    include Input::CLI
+    
+    # TFTP utilizes UDP, there is not a connection. We simply specify an IP and send/receive data.
+    def connect node
+      @node       = node
+
+      @node.model.cfg['tftp'].each { |cb| instance_exec(&cb) }
+      @log = File.open(Oxidized::Config::Log + "/#{@node.ip}-tftp", 'w') if Oxidized.config.input.debug?
+      @tftp = Net::TFTP.new @node.ip
+    end
+
+    def cmd file
+      Oxidized.logger.debug "TFTP: #{file} @ #{@node.name}"
+      config = StringIO.new
+      @tftp.getbinary file, config
+      config.rewind
+      config.read
+    end
+    
+    private
+    
+    def disconnect
+      # TFTP uses UDP, there is no connection to close
+    ensure
+      @log.close if Oxidized.config.input.debug?
+    end
+
+  end
+end

data/lib/oxidized/model/acos.rb

@@ -6,6 +6,13 @@ class ACOS < Oxidized::Model
   ##ACOS prompt changes depending on the state of the device
   prompt /^([-\w.\/:?\[\]\(\)]+[#>]\s?)$/
 
+  cmd :secret do |cfg|
+    cfg.gsub!(/community read encrypted (\S+)/, 'community read encrypted <hidden>') # snmp
+    cfg.gsub!(/secret encrypted (\S+)/, 'secret encrypted <hidden>') # tacacs-server
+    cfg.gsub!(/password encrypted (\S+)/, 'password encrypted <hidden>') # user
+    cfg
+  end
+
   cmd 'show version' do |cfg|
     cfg.gsub! /\s(Last configuration saved at).*/, ' \\1 <removed>'
     cfg.gsub! /\s(Memory).*/, ' \\1 <removed>'
@@ -22,11 +29,20 @@ class ACOS < Oxidized::Model
     comment cfg
   end
 
+  cmd 'show partition-config all' do |cfg|
+     cfg.gsub! /(Current configuration).*/, '\\1 <removed>'
+     cfg.gsub! /(Configuration last updated at).*/, '\\1 <removed>'
+     cfg.gsub! /(Configuration last saved at).*/, '\\1 <removed>'
+     cfg.gsub! /(Configuration last synchronized at).*/, '\\1 <removed>'
+     cfg
+  end  
+
   cmd 'show running-config all-partitions' do |cfg|
      cfg.gsub! /(Current configuration).*/, '\\1 <removed>'
      cfg.gsub! /(Configuration last updated at).*/, '\\1 <removed>'
      cfg.gsub! /(Configuration last saved at).*/, '\\1 <removed>'
      cfg.gsub! /(Configuration last synchronized at).*/, '\\1 <removed>'
+     cfg
   end
 
   cmd 'show aflex all-partitions' do |cfg|

data/lib/oxidized/model/alvarion

@@ -0,0 +1,13 @@
+class Alvarion < Oxidized::Model
+
+  # Used in Alvarion wisp equipment
+
+  # Run this command as an instance of Model so we can access node
+  pre do
+    cmd "#{node.auth[:password]}.cfg"
+  end
+
+
+  cfg :tftp {}
+
+end

data/lib/oxidized/model/asa.rb

@@ -13,6 +13,9 @@ class ASA < Oxidized::Model
   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! /ikev2 pre-shared-key (\S+)/, 'ikev2 pre-shared-key <secret hidden>'
+    cfg.gsub! /ikev2 (remote|local)-authentication pre-shared-key (\S+)/, 'ikev2 \1-authentication pre-shared-key <secret hidden>'
+    cfg.gsub! /^(aaa-server TACACS\+? \(\S+\) host.*\n\skey) \S+$/mi, '\1 <secret hidden>'
     cfg
   end
 

data/lib/oxidized/model/catos.rb

@@ -1,6 +1,6 @@
 class Catos < Oxidized::Model
 
-  prompt /^[\w.@-]+> \(enable\) $/
+  prompt /^[\w.@-]+>\s?(\(enable\) )?$/
   comment '# '
 
   cmd :all do |cfg|
@@ -28,8 +28,15 @@ class Catos < Oxidized::Model
     password /^Password:/
   end
 
-  cfg :ssh, :telnet do
+  cfg :telnet, :ssh do
     post_login 'set length 0'
+    # preferred way to handle additional passwords
+    if vars :enable
+      post_login do
+        send "enable\n"
+        cmd vars(:enable)
+      end
+    end
     pre_logout 'exit'
   end
 

data/lib/oxidized/model/cumulus.rb

@@ -1,6 +1,6 @@
 class Cumulus < Oxidized::Model
   
-  prompt /^((\w*)@(.*)([>#]\s)+)$/
+  prompt /^((\w*)@(.*)):/
   comment  '# '
   
   
@@ -22,7 +22,7 @@ class Cumulus < Oxidized::Model
     cfg += cmd 'cat /etc/hosts'
     
     cfg += add_comment 'THE INTERFACES'
-    cfg += cmd 'cat /etc/network/interfaces'
+    cfg += cmd 'grep -r "" /etc/network/interface* | cut -d "/" -f 4-'
     
     cfg += add_comment 'RESOLV.CONF'
     cfg += cmd 'cat /etc/resolv.conf'
@@ -30,6 +30,9 @@ class Cumulus < Oxidized::Model
     cfg += add_comment 'NTP.CONF'
     cfg += cmd 'cat /etc/ntp.conf'
     
+    cfg += add_comment 'IP Routes'
+    cfg += cmd 'netstat -rn'
+
     cfg += add_comment 'QUAGGA DAEMONS'
     cfg += cmd 'cat /etc/quagga/daemons'
     
@@ -55,10 +58,13 @@ class Cumulus < Oxidized::Model
     cfg += cmd 'cat /etc/cumulus/switchd.conf'
     
     cfg += add_comment 'ACL'
-    cfg += cmd 'iptables -L'
+    cfg += cmd 'iptables -L -n'
     
     cfg += add_comment 'VERSION'
     cfg += cmd 'cat /etc/cumulus/etc.replace/os-release'
+
+    cfg += add_comment 'License'
+    cfg += cmd 'cl-license'
     
   end
   
@@ -73,4 +79,4 @@ class Cumulus < Oxidized::Model
   end
  
 
-end
+end

data/lib/oxidized/model/datacom.rb

@@ -24,7 +24,12 @@ class DataCom < Oxidized::Model
     cfg.cut_head
   end
 
-  cfg :telnet, :ssh do
+  cfg :ssh do
+    password /^Password:\s$/
+    pre_logout 'exit'
+  end
+
+  cfg :telnet do
     username /login:\s$/
     password /^Password:\s$/
     pre_logout 'exit'

data/lib/oxidized/model/pfsense.rb

@@ -0,0 +1,18 @@
+class PfSense < Oxidized::Model
+
+  # use other use than 'admin' user, 'admin' user cannot get ssh/exec. See issue #535
+  
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-2].join
+  end
+  
+  cmd 'cat /cf/conf/config.xml' do |cfg|
+    cfg.gsub! /\s<revision>\s*<time>\d*<\/time>\s*.*\s*.*\s*<\/revision>/, ''
+  end
+  
+  cfg :ssh do
+    exec true
+    pre_logout 'exit'
+  end
+ 
+end

data/lib/oxidized/model/routeros.rb

@@ -1,5 +1,5 @@
 class RouterOS < Oxidized::Model
-  prompt /\[\w+@\S+\]\s?>\s?$/
+  prompt /\[\w+@\S+(\s?\S+)*\]\s?>\s?$/
   comment "# "
 
   cmd '/system routerboard print' do |cfg|
@@ -8,6 +8,7 @@ class RouterOS < Oxidized::Model
 
   cmd '/export' do |cfg|
     cfg.gsub! /\x1B\[([0-9]{1,3}((;[0-9]{1,3})*)?)?[m|K]/, '' # strip ANSI colours
+    cfg.gsub! /\\\r\n\s+/, ''   # strip new line
     cfg = cfg.split("\n").select { |line| not line[/^\#\s\w{3}\/\d{2}\/\d{4}.*$/] }
     cfg.join("\n") + "\n"
   end

data/lib/oxidized/model/saos.rb

@@ -17,8 +17,10 @@ class SAOS < Oxidized::Model
     username /login:/
     password /assword:/
   end
-  cfg :telnet do
+
+  cfg :telnet, :ssh do
+    post_login 'system shell set more off'
     post_login 'system shell session set more off'
     pre_logout 'exit'
   end
-end
+end

data/lib/oxidized/model/timos.rb

@@ -1,8 +1,10 @@
 class TiMOS < Oxidized::Model
 
-  # Alcatel-Lucent TiMOS (Timetra)
-  # used in SR/ESS/SAS routers
- 
+  #
+  # Nokia SR OS (TiMOS) (formerly TiMetra, Alcatel, Alcatel-Lucent).
+  # Used in 7705 SAR, 7210 SAS, 7450 ESS, 7750 SR, 7950 XRS, and NSP.
+  #
+
   comment  '# '
 
   prompt /^([-\w\.:>\*]+\s?[#>]\s?)$/
@@ -12,26 +14,81 @@ class TiMOS < Oxidized::Model
     new_cfg << cfg.each_line.to_a[1..-2].join
   end
 
+  #
+  # Show the boot options file.
+  #
   cmd 'show bof' do |cfg|
     comment cfg
   end
 
+  #
+  # Show the system information.
+  #
   cmd 'show system information' do |cfg|
-    # strip uptime
+    #
+    # Strip uptime.
+    #
     cfg.sub! /^System Up Time.*\n/, ''
     comment cfg
   end
 
+  #
+  # Show the card state.
+  #
   cmd 'show card state' do |cfg|
     comment cfg
   end
 
-  cmd 'show boot-messages' do |cfg|
-    cfg.gsub! /\r/, ""
+  #
+  # Show the boot log.
+  #
+  cmd 'file type bootlog.txt' do |cfg|
+    #
+    # Strip carriage returns and backspaces.
+    #
+    cfg.gsub! /\r/, ''
+    cfg.gsub! /[\b][\b][\b]/, "\n"
+    comment cfg
+  end
+
+  #
+  # Show the running debug configuration.
+  #
+  cmd 'show debug' do |cfg|
     comment cfg
   end
 
-  cmd 'admin display-config'
+  #
+  # Show the saved debug configuration (admin debug-save).
+  #
+  cmd 'file type config.dbg' do |cfg|
+    #
+    # Strip carriage returns.
+    #
+    cfg.gsub! /\r/, ''
+    comment cfg
+  end
+
+  #
+  # Show the running persistent indices.
+  #
+  cmd 'admin display-config index' do |cfg|
+    #
+    # Strip carriage returns.
+    #
+    cfg.gsub! /\r/, ''
+    comment cfg
+  end
+
+  #
+  # Show the running configuration.
+  #
+  cmd 'admin display-config' do |cfg|
+    #
+    # Strip carriage returns.
+    #
+    cfg.gsub! /\r/, ''
+  end
 
   cfg :telnet do
     username /^Login: /

data/lib/oxidized/node.rb

@@ -128,24 +128,15 @@ module Oxidized
     end
 
     def resolve_auth opt
-      # Resolve configured username/password, give priority to group level configuration
-      # TODO: refactor to use revised behaviour of Asetus
-      cfg_username, cfg_password =
-        if Oxidized.config.groups.has_key?(@group) and ['username', 'password'].all? {|e| Oxidized.config.groups[@group].has_key?(e)}
-          [Oxidized.config.groups[@group].username, Oxidized.config.groups[@group].password]
-        elsif ['username', 'password'].all? {|e| Oxidized.config.has_key?(e)}
-          [Oxidized.config.username, Oxidized.config.password]
-        else
-          [nil, nil]
-        end
-      auth = {}
-      auth[:username] = (opt[:username] or cfg_username)
-      auth[:password] = (opt[:password] or cfg_password)
-      auth
+      # Resolve configured username/password
+      {
+        username: resolve_key(:username, opt),
+        password: resolve_key(:password, opt),
+      }
     end
 
     def resolve_input opt
-      inputs = (opt[:input]  or Oxidized.config.input.default)
+      inputs = resolve_key :input, opt, Oxidized.config.input.default
       inputs.split(/\s*,\s*/).map do |input|
         if not Oxidized.mgr.input[input]
           Oxidized.mgr.add_input input or raise MethodNotFound, "#{input} not found for node #{ip}"
@@ -155,7 +146,7 @@ module Oxidized
     end
 
     def resolve_output opt
-      output = (opt[:output] or Oxidized.config.output.default)
+      output = resolve_key :output, opt, Oxidized.config.output.default
       if not Oxidized.mgr.output[output]
         Oxidized.mgr.add_output output or raise MethodNotFound, "#{output} not found for node #{ip}"
       end
@@ -163,7 +154,7 @@ module Oxidized
     end
 
     def resolve_model opt
-      model = (opt[:model] or Oxidized.config.model)
+      model = resolve_key :model, opt
       if not Oxidized.mgr.model[model]
         Oxidized.logger.debug "lib/oxidized/node.rb: Loading model #{model.inspect}"
         Oxidized.mgr.add_model model or raise ModelNotFound, "#{model} not found for node #{ip}"
@@ -187,6 +178,33 @@ module Oxidized
       end
     end
 
+    def resolve_key key, opt, global=nil
+      # resolve key, first get global, then get group then get node config
+      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]}'"
+
+      #global
+      if not value and 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
+
+      #group
+      if Oxidized.config.groups.has_key?(@group)
+        if 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
+      end
+
+      #node
+      value = opt[key_sym] || value
+      Oxidized.logger.debug "node.rb: returning node key '#{key}' with value '#{value}'"
+      value
+    end
+
     def is_git? opt
       (opt[:output] || Oxidized.config.output.default) == 'git'
     end

data/lib/oxidized/output/file.rb

@@ -17,7 +17,7 @@ class OxidizedFile < Output
   end
 
   def store node, outputs, opt={}
-    file = @cfg.directory
+    file = File.expand_path @cfg.directory
     if opt[:group]
       file = File.join File.dirname(file), opt[:group]
     end
@@ -28,14 +28,16 @@ class OxidizedFile < Output
   end
 
   def fetch node, group
-    cfg_dir = @cfg.directory
+    cfg_dir = File.expand_path @cfg.directory
+    node_name = node.name
+
     if group # group is explicitly defined by user
-      IO.readlines File.join(cfg_dir, group, node)
+      IO.readlines File.join(cfg_dir, group, node_name)
     else
-      if File.exists? File.join(cfg_dir, node) # node configuration file is stored on base directory
-        IO.readlines File.join(cfg_dir, node)
+      if File.exists? File.join(cfg_dir, node_name) # node configuration file is stored on base directory
+        IO.readlines File.join(cfg_dir, node_name)
       else
-        path = Dir.glob File.join(cfg_dir, '**', node) # fetch node in all groups
+        path = Dir.glob File.join(cfg_dir, '**', node_name) # fetch node in all groups
         return nil if path[0].nil?
         open(path[0], 'r').readlines
       end

data/lib/oxidized/source/csv.rb

@@ -20,7 +20,7 @@ class CSV < Source
     nodes = []
     open(File.expand_path @cfg.file).each_line do |line|
       next if line.match(/^\s*#/)
-      data  = line.chomp.split @cfg.delimiter
+      data  = line.chomp.split(@cfg.delimiter, -1)
       next if data.empty?
       # map node parameters
       keys = {}
@@ -29,9 +29,11 @@ class CSV < Source
       end
       keys[:model] = map_model keys[:model] if keys.key? :model
 
-      # map node specific vars, empty value is considered as nil
+      # map node specific vars
       vars = {}
-      @cfg.vars_map.each { |key, position| vars[key.to_sym] = data[position].to_s.empty? ? nil : data[position] }
+      @cfg.vars_map.each do |key, position|
+        vars[key.to_sym] = node_var_interpolate data[position]
+      end
       keys[:vars] = vars unless vars.empty?
 
       nodes << keys

data/lib/oxidized/source/http.rb

@@ -43,9 +43,11 @@ class HTTP < Source
       end
       keys[:model] = map_model keys[:model] if keys.key? :model
 
-      # map node specific vars, empty value is considered as nil
+      # map node specific vars
       vars = {}
-      @cfg.vars_map.each { |key, position| vars[key.to_sym] = line[position].to_s.empty? ? nil : line[position] }
+      @cfg.vars_map.each do |key, position|
+        vars[key.to_sym] = node_var_interpolate line[position]
+      end
       keys[:vars] = vars unless vars.empty?
 
       nodes << keys

data/lib/oxidized/source/source.rb

@@ -1,11 +1,23 @@
 module Oxidized
   class Source
     class NoConfig < OxidizedError; end
+
     def initialize
       @map = (Oxidized.config.model_map or {})
     end
+
     def map_model model
       @map.has_key?(model) ? @map[model] : model
     end
+
+    def node_var_interpolate var
+       case var
+       when "nil"   then nil
+       when "false" then false
+       when "true"  then true
+       else var
+       end
+    end
+
   end
 end

data/lib/oxidized/source/sql.rb

@@ -31,7 +31,9 @@ class SQL < Source
 
       # map node specific vars
       vars = {}
-      @cfg.vars_map.each { |key, sql_column| vars[key.to_sym] = node[sql_column.to_sym] }
+      @cfg.vars_map.each do |key, sql_column|
+        vars[key.to_sym] = node_var_interpolate node[sql_column.to_sym]
+      end
       keys[:vars] = vars unless vars.empty?
 
       nodes << keys

data/lib/oxidized/version.rb

@@ -1,3 +1,3 @@
 module Oxidized
-  VERSION = '0.16.2'
+  VERSION = '0.17.0'
 end

data/lib/oxidized.rb

@@ -43,7 +43,7 @@ module Oxidized
                   else
                     require 'logger'
                     if config.has_key?('log')
-                      Logger.new(config.log)
+                      Logger.new(File.expand_path(config.log))
                     else
                       Logger.new(STDERR)
                     end

data/oxidized.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version =           '>= 2.0.0'
   s.add_runtime_dependency 'asetus',  '~> 0.1'
   s.add_runtime_dependency 'slop',    '~> 3.5'
-  s.add_runtime_dependency 'net-ssh', '>= 3.0.0', '<3.1'
+  s.add_runtime_dependency 'net-ssh', '~> 3.0.2'
   s.add_runtime_dependency 'rugged',  '~> 0.21',  '>= 0.21.4'
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '2.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxidized
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Saku Ytti
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asetus
@@ -44,22 +44,16 @@ dependencies:
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -211,12 +205,14 @@ files:
 - lib/oxidized/input/input.rb
 - lib/oxidized/input/ssh.rb
 - lib/oxidized/input/telnet.rb
+- lib/oxidized/input/tftp.rb
 - lib/oxidized/job.rb
 - lib/oxidized/jobs.rb
 - lib/oxidized/manager.rb
 - lib/oxidized/model/acos.rb
 - lib/oxidized/model/aireos.rb
 - lib/oxidized/model/airos.rb
+- lib/oxidized/model/alvarion
 - lib/oxidized/model/aos.rb
 - lib/oxidized/model/aos7.rb
 - lib/oxidized/model/aosw.rb
@@ -256,6 +252,7 @@ files:
 - lib/oxidized/model/opengear.rb
 - lib/oxidized/model/outputs.rb
 - lib/oxidized/model/panos.rb
+- lib/oxidized/model/pfsense.rb
 - lib/oxidized/model/powerconnect.rb
 - lib/oxidized/model/procurve.rb
 - lib/oxidized/model/quantaos.rb