From 81fc3a4b423d8ce9fe69def57007312a96db6f67 Mon Sep 17 00:00:00 2001
From: Torbjörn Lönnemark <ketl@nsc.liu.se>
Date: Tue, 19 Sep 2017 16:28:41 +0200
Subject: Add support for Supermicro SSE-G48-TG4

This model (and possibly others) runs an OS with a different set of
commands than the Supermicro model that already exists.
---
 docs/Supported-OS-Types.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index e600040..f5352de 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -128,7 +128,8 @@
  * Siklu
    * [EtherHaul](lib/oxidized/model/siklu.rb)
  * Supermicro
-   * [Supermicro](lib/oxidized/model/supermicro.rb)
+   * [Supermicro](lib/oxidized/model/supermicro.rb): Known to work with the Supermicro SSE-G2252.
+   * [Supermicro2](lib/oxidized/model/supermicro2.rb): Known to work with the Supermicro SSE-G48-TG4.
  * Symantec
    * [Blue Coat ProxySG / Security Gateway OS (SGOS)](lib/oxidized/model/sgos.rb)
  * Trango Systems
-- 
cgit v1.2.3


From 77e5c874896e8f17aa32fa40b96196a8d2932ff5 Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Sat, 18 Nov 2017 03:57:16 -0600
Subject: docs: Misc Doc updates (#1107)

* Move VRP-Huawei.md to new Model-Notes subdir

* Update Sources.md with a few improvements:

1. Sync the example table name between the MySQL and SQLite example configs for consistency.

2. Document the very useful custom SQL query parameter (query:) including a couple of examples.

* Basic README.md for Model-Notes directory with a simple table for notes/caveats

* Markdown quote the Huawei config blocks and link back to README.md

* Update Sources.md
---
 docs/Model-Notes/README.md     | 17 +++++++++++++++++
 docs/Model-Notes/VRP-Huawei.md | 34 ++++++++++++++++++++++++++++++++++
 docs/Sources.md                | 36 +++++++++++++++++++++++++++++++++---
 docs/VRP-Huawei.md             | 27 ---------------------------
 4 files changed, 84 insertions(+), 30 deletions(-)
 create mode 100644 docs/Model-Notes/README.md
 create mode 100644 docs/Model-Notes/VRP-Huawei.md
 delete mode 100644 docs/VRP-Huawei.md

(limited to 'docs')

diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
new file mode 100644
index 0000000..15ab445
--- /dev/null
+++ b/docs/Model-Notes/README.md
@@ -0,0 +1,17 @@
+
+
+Model Notes
+========================
+
+
+This directory contains implemention notes and caveats to assist you in your oxidized deployment.
+
+Use the table below for more information on the Vendor/Model caveats.
+
+
+Vendor          | Model           |Updated
+----------------|-----------------|----------------
+Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
+
+
+If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
diff --git a/docs/Model-Notes/VRP-Huawei.md b/docs/Model-Notes/VRP-Huawei.md
new file mode 100644
index 0000000..d03c752
--- /dev/null
+++ b/docs/Model-Notes/VRP-Huawei.md
@@ -0,0 +1,34 @@
+Huawei VRP Configuration
+========================
+
+Create a user with no privileges
+
+```
+    <HUAWEI> system-view
+    [~HUAWEI] aaa
+    [~HUAWEI-aaa] local-user oxidized password irreversible-cipher verysecret
+    [*HUAWEI-aaa] local-user oxidized level 1
+    [*HUAWEI-aaa] local-user oxidized service-type terminal ssh
+    [*HUAWEI-aaa] commit
+```
+
+The commands Oxidized executes are:
+
+1. screen-length 0 temporary
+2. display version
+3. display device
+4. display current-configuration all
+
+Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the priviledge-level for commands 1 and 4:
+
+```
+    <HUAWEI> system-view
+    [~HUAWEI] command-privilege level 1 view global display current-configuration all
+    [*HUAWEI] command-privilege level 1 view shell screen-length
+    [*HUAWEI] commit
+```
+
+Oxidized can now retrieve your configuration!
+
+
+Back to [Model-Notes](README.md)
diff --git a/docs/Sources.md b/docs/Sources.md
index 4121c89..0a6d1d7 100644
--- a/docs/Sources.md
+++ b/docs/Sources.md
@@ -61,8 +61,8 @@ source:
   default: sql
   sql:
     adapter: sqlite
-    database: "/var/lib/oxidized/devices.db"
-    table: devices
+    database: "/var/lib/oxidized/nodes.db"
+    table: nodes
     map:
       name: fqdn
       model: model
@@ -72,6 +72,36 @@ source:
       enable: enable
 ```
 
+### Custom SQL Query Support
+
+You may also implement a custom SQL query to retreive the nodelist using  SQL syntax with the `query:` configuration parameter under the `sql:` stanza.
+
+
+#### Custom SQL Query Examples
+
+You may have a table named `nodes` which contains a boolean to indicate if the nodes should be enabled (fetched via oxidized). This can be used in the custom SQL query to avoid fetching from known impacted nodes.
+
+In your configuration, you would add the `query:` parameter and specify the SQL query. Make sure to put this within the `sql:` configuration section.
+
+```sql
+query: "SELECT * FROM nodes WHERE enabled = True"
+```
+
+Since this is an SQL query, you can also provide a more advanced query to assist in more complicated oxidized deployments. The exact deployment is up to you on how you design your database and oxidized fetchers.
+
+In this example we limit the nodes to two "POPs" of `mypop1` and `mypop2`. We also require the nodes to have the `enabled` boolean set to `True`.
+
+```sql
+query: "SELECT * FROM nodes WHERE pop IN ('mypop1','mypop2') AND enabled = True"
+```
+The order of the nodes returned will influence the order that nodes are fetched by oxidized. You can use standard SQL `ORDER BY` clauses to influence the node order.
+
+You should always test your SQL query before using it in the oxidized configuration as there is no syntax or error checking performed before sending it to the database engine.
+
+Consult your database documentation for more information on query language and table optimization.
+
+
+
 ### Source: HTTP
 
 One object per device.
@@ -107,4 +137,4 @@ source:
     url: https://url/api
     scheme: https
     secure: false
-```
\ No newline at end of file
+```
diff --git a/docs/VRP-Huawei.md b/docs/VRP-Huawei.md
deleted file mode 100644
index 9e97b7d..0000000
--- a/docs/VRP-Huawei.md
+++ /dev/null
@@ -1,27 +0,0 @@
-Huawei VRP Configuration
-========================
-
-Create a user with no privileges
-
-    <HUAWEI> system-view
-    [~HUAWEI] aaa
-    [~HUAWEI-aaa] local-user oxidized password irreversible-cipher verysecret
-    [*HUAWEI-aaa] local-user oxidized level 1
-    [*HUAWEI-aaa] local-user oxidized service-type terminal ssh
-    [*HUAWEI-aaa] commit
-
-The commands Oxidized executes are:
-
-1. screen-length 0 temporary
-2. display version
-3. display device
-4. display current-configuration all
-
-Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the priviledge-level for commands 1 and 4:
-
-    <HUAWEI> system-view
-    [~HUAWEI] command-privilege level 1 view global display current-configuration all
-    [*HUAWEI] command-privilege level 1 view shell screen-length
-    [*HUAWEI] commit
-
-Oxidized can now retrieve your configuration!
\ No newline at end of file
-- 
cgit v1.2.3


From 115764f3b2d20b3732a8d81c38afaea19c11dad8 Mon Sep 17 00:00:00 2001
From: pv2b <pvz@pvz.pp.se>
Date: Mon, 20 Nov 2017 09:16:44 +0100
Subject: feature: Added model information to exec hook (#1105)

* Add OX_NODE_MODEL to exec hook

* Update docs to reflect added OX_NODE_MSG to hook
---
 docs/Hooks.md             | 1 +
 lib/oxidized/hook/exec.rb | 1 +
 2 files changed, 2 insertions(+)

(limited to 'docs')

diff --git a/docs/Hooks.md b/docs/Hooks.md
index 7d503a3..fab4025 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -26,6 +26,7 @@ OX_NODE_IP
 OX_NODE_FROM
 OX_NODE_MSG
 OX_NODE_GROUP
+OX_NODE_MODEL
 OX_JOB_STATUS
 OX_JOB_TIME
 OX_REPO_COMMITREF
diff --git a/lib/oxidized/hook/exec.rb b/lib/oxidized/hook/exec.rb
index a9a5950..3f984c2 100644
--- a/lib/oxidized/hook/exec.rb
+++ b/lib/oxidized/hook/exec.rb
@@ -71,6 +71,7 @@ class Exec < Oxidized::Hook
         "OX_NODE_FROM" => ctx.node.from.to_s,
         "OX_NODE_MSG" => ctx.node.msg.to_s,
         "OX_NODE_GROUP" => ctx.node.group.to_s,
+        "OX_NODE_MODEL" => ctx.node.model.class.name,
         "OX_REPO_COMMITREF" => ctx.commitref.to_s,
         "OX_REPO_NAME" => ctx.node.repo.to_s,
       )
-- 
cgit v1.2.3


From 99220b9947946d5ad1e53cba6a343e942ce0c498 Mon Sep 17 00:00:00 2001
From: pv2b <pvz@pvz.pp.se>
Date: Tue, 21 Nov 2017 09:03:48 +0100
Subject: model: Added support for Opnsense (#1111)

* Add OPNsense model

* Fix class name

* Mention support for OPNsense in Supported OS types
---
 docs/Supported-OS-Types.md     |  1 +
 lib/oxidized/model/opnsense.rb | 21 +++++++++++++++++++++
 2 files changed, 22 insertions(+)
 create mode 100644 lib/oxidized/model/opnsense.rb

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 9176f2e..99566c4 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -117,6 +117,7 @@
    * [OneOS](/lib/oxidized/model/oneos.rb)
  * Opengear
    * [Opengear](/lib/oxidized/model/opengear.rb)
+ * [OPNsense](/lib/oxidized/model/opnsense.rb)
  * Palo Alto
    * [PANOS](/lib/oxidized/model/panos.rb)
  * [PLANET SG/SGS Switches](/lib/oxidized/model/planet.rb)
diff --git a/lib/oxidized/model/opnsense.rb b/lib/oxidized/model/opnsense.rb
new file mode 100644
index 0000000..b874fca
--- /dev/null
+++ b/lib/oxidized/model/opnsense.rb
@@ -0,0 +1,21 @@
+class OpnSense < Oxidized::Model
+
+  # minimum required permissions: "System: Shell account access"
+  # must enable SSH and password-based SSH access
+  
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-1].join
+  end
+  
+  cmd 'cat /conf/config.xml' do |cfg|
+    cfg.gsub! /\s<revision>\s*<time>\d*<\/time>\s*.*\s*.*\s*<\/revision>/, ''
+    cfg.gsub! /\s<last_rule_upd_time>\d*<\/last_rule_upd_time>/, ''
+    cfg
+  end
+  
+  cfg :ssh do
+    exec true
+    pre_logout 'exit'
+  end
+ 
+end
-- 
cgit v1.2.3


From c81881d2cd42f02b30bd36740745a78e6106afa8 Mon Sep 17 00:00:00 2001
From: Neil Lathwood <neil@lathwood.co.uk>
Date: Tue, 21 Nov 2017 09:40:55 +0000
Subject: Update Sources.md

---
 docs/Sources.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/Sources.md b/docs/Sources.md
index 0a6d1d7..b04261c 100644
--- a/docs/Sources.md
+++ b/docs/Sources.md
@@ -23,7 +23,7 @@ source:
 Example csv `/var/lib/oxidized/router.db`:
 
 ```
-rtr01.local,192.168.1.1,ios,oxidized,5uP3R53cR3T,T0p53cR3t
+rtr01.local:192.168.1.1:ios:oxidized:5uP3R53cR3T:T0p53cR3t
 ```
 
 ### Source: SQL
-- 
cgit v1.2.3


From da8923512737f0d9383feaebaf43e781e914b71e Mon Sep 17 00:00:00 2001
From: Michael Baker <elmobp@users.noreply.github.com>
Date: Thu, 23 Nov 2017 06:18:41 +0800
Subject: fix: GPG bug fix when loading file (#1109)

* GPG bug fix

* Update Sources.md

* Update README.md
---
 README.md                  |  3 ---
 docs/Sources.md            | 25 +++++++++++++++++++++++++
 lib/oxidized/source/csv.rb |  4 ++--
 3 files changed, 27 insertions(+), 5 deletions(-)

(limited to 'docs')

diff --git a/README.md b/README.md
index 2262d79..d501cb5 100644
--- a/README.md
+++ b/README.md
@@ -246,15 +246,12 @@ oxidized
 
 Now tell Oxidized where it finds a list of network devices to backup configuration from. You can either use CSV or SQLite as source. To create a CSV source add the following snippet:
 
-Note: If gpg is set to anything other than false it will attempt to decrypt the file contents
 ```
 source:
   default: csv
   csv:
     file: ~/.config/oxidized/router.db
     delimiter: !ruby/regexp /:/
-    gpg: false
-    gpg_password: 'password'
     map:
       name: 0
       model: 1
diff --git a/docs/Sources.md b/docs/Sources.md
index b04261c..7029b72 100644
--- a/docs/Sources.md
+++ b/docs/Sources.md
@@ -26,6 +26,31 @@ Example csv `/var/lib/oxidized/router.db`:
 rtr01.local:192.168.1.1:ios:oxidized:5uP3R53cR3T:T0p53cR3t
 ```
 
+If you would like to use a GPG encrypted file as the source then you can use the following example:
+
+```yaml
+source:
+  default: csv
+  csv:
+    file: ~/.config/oxidized/router.db
+    delimiter: !ruby/regexp /:/
+    gpg: true
+    gpg_password: 'password'
+    map:
+      name: 0
+      model: 1
+```
+
+> Please note, if you are running GPG v2 then you will be prompted for your gpg password on start up, if you use GPG >= 2.1 then you can add the following config to stop that behaviour:
+
+> Within `~/.gnupg/gpg-agent.conf`
+
+> `allow-loopback-pinentry`
+
+> and within: `~/.gnupg/gpg.conf`
+
+> `pinentry-mode loopback`
+
 ### 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
diff --git a/lib/oxidized/source/csv.rb b/lib/oxidized/source/csv.rb
index c1e310a..27cb49e 100644
--- a/lib/oxidized/source/csv.rb
+++ b/lib/oxidized/source/csv.rb
@@ -21,9 +21,9 @@ class CSV < Source
   def load
     nodes = []
     file = File.expand_path(@cfg.file)
-    file = if @cfg.gpg?
+    if @cfg.gpg?
       crypto = GPGME::Crypto.new password: @cfg.gpg_password
-      crypto.decrypt(file).to_s
+      file = crypto.decrypt(File.open(file)).to_s
     else
       open(file)
     end  
-- 
cgit v1.2.3


From 2803e49ec9e10e97a0b28550f495eeb8e59b2c8d Mon Sep 17 00:00:00 2001
From: JBBR <jbbroguiere@outlook.com>
Date: Wed, 29 Nov 2017 10:00:09 +0100
Subject: docs: Create AireOS.md (#1116)

---
 docs/Model-Notes/AireOS.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 docs/Model-Notes/AireOS.md

(limited to 'docs')

diff --git a/docs/Model-Notes/AireOS.md b/docs/Model-Notes/AireOS.md
new file mode 100644
index 0000000..0da9b57
--- /dev/null
+++ b/docs/Model-Notes/AireOS.md
@@ -0,0 +1,12 @@
+Cisco WLC Configuration 
+========================
+
+Create a user with read-write privilege :
+
+```
+mgmtuser add oxidized **** read-write
+```
+
+Oxidized needs read-write privilege in order to execute 'config paging disable'. 
+
+Back to [Model-Notes](README.md)
-- 
cgit v1.2.3


From d2a9c75b02eb18f13121c9f653a443f58682505b Mon Sep 17 00:00:00 2001
From: Mikaël Mantel <mikaelmantel@users.noreply.github.com>
Date: Mon, 4 Dec 2017 21:18:27 +0100
Subject: model: Added support for SLX-OS (#1056)

* Add support for SLX-OS

* Remove commented code

* Add SLX-OS on the list of Supported OS Types

* Replace tabs with spaces

* Regex modification for remove the display of uptime
---
 docs/Supported-OS-Types.md  | 11 ++++----
 lib/oxidized/model/slxos.rb | 61 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 67 insertions(+), 5 deletions(-)
 create mode 100644 lib/oxidized/model/slxos.rb

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 99566c4..a6ee713 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -27,11 +27,12 @@
    * [VOSS (VSP Operating System Software)](/lib/oxidized/model/voss.rb)
    * [BOSS (Baystack Operating System Software)](/lib/oxidized/model/boss.rb)
  * Brocade
-   * [FabricOS](/lib/oxidized/model/fabricos.rb)
-   * [Ironware](/lib/oxidized/model/ironware.rb)
-   * [NOS (Network Operating System)](/lib/oxidized/model/nos.rb)
-   * [Vyatta](/lib/oxidized/model/vyatta.rb)
-   * [6910](/lib/oxidized/model/br6910.rb)
+   * [FabricOS](lib/oxidized/model/fabricos.rb)
+   * [Ironware](lib/oxidized/model/ironware.rb)
+   * [NOS (Network Operating System)](lib/oxidized/model/nos.rb)
+   * [Vyatta](lib/oxidized/model/vyatta.rb)
+   * [6910](lib/oxidized/model/br6910.rb)
+   * [SLX-OS](lib/oxidized/model/slxos.rb)
  * Casa
    * [Casa](/lib/oxidized/model/casa.rb)
  * Check Point
diff --git a/lib/oxidized/model/slxos.rb b/lib/oxidized/model/slxos.rb
new file mode 100644
index 0000000..934da5b
--- /dev/null
+++ b/lib/oxidized/model/slxos.rb
@@ -0,0 +1,61 @@
+class SLXOS < Oxidized::Model
+
+  prompt /^.*[>#]\s?$/i
+  comment  '! '
+
+  cmd 'show version' do |cfg|
+    cfg.gsub! /(^((.*)[Ss]ystem [Uu]ptime(.*))$)/, '' #remove unwanted line system uptime
+    cfg.gsub! /[Uu]p\s?[Tt]ime is .*/,''
+
+    comment cfg
+  end
+
+  cmd 'show chassis' do |cfg|
+    cfg.encode!("UTF-8", :invalid => :replace, :undef => :replace) #sometimes ironware returns broken encoding
+        cfg.gsub! /.*Power Usage.*/, '' #remove unwanted lines power usage
+        cfg.gsub! /Time A(live|wake).*/, '' #remove unwanted lines time alive/awake
+    cfg.gsub! /([\[]*)1([\]]*)<->([\[]*)2([\]]*)(<->([\[]*)3([\]]*))*/, ''
+
+    comment cfg
+  end
+
+  cmd 'show system' do |cfg|
+        cfg.gsub! /Up Time.*/, '' #removes uptime line
+        cfg.gsub! /Current Time.*/, '' #remove current time line
+        cfg.gsub! /.*speed is.*/, '' #removes fan speed lines
+
+    comment cfg
+  end
+
+  cmd 'show slots' do |cfg|
+    cfg.gsub! /^-*^$/, '' # some slx devices are fixed config
+        cfg.gsub! /syntax error: element does not exist/, '' # same as above
+
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    arr = cfg.each_line.to_a
+    arr[2..-1].join unless arr.length < 2
+  end
+
+  cfg :telnet do
+    # match expected prompts
+    username /^(Please Enter Login Name|Username):/
+    password /^(Please Enter Password ?|Password):/
+  end
+
+  #handle pager with enable
+  cfg :telnet, :ssh do
+    if vars :enable
+      post_login do
+        send "enable\n"
+        cmd vars(:enable)
+      end
+    end
+    post_login ''
+    post_login 'terminal length 0'
+        pre_logout 'exit'
+  end
+
+end
-- 
cgit v1.2.3


From 7e6dc8cce71d6e2753a4e865d8bfbcd347fe1f8a Mon Sep 17 00:00:00 2001
From: Frederik Kriewitz <frederik@kriewitz.eu>
Date: Sun, 10 Dec 2017 21:53:14 +0100
Subject: model: Add support for Broadband Network Platform Software from GCOM
 Technologies Co.,Ltd. (#1097)

* Add support for Broadband Network Platform Software from GCOM Technologies Co.,Ltd.

* requested changes
---
 docs/Supported-OS-Types.md     |  4 ++
 lib/oxidized/model/gcombnps.rb | 85 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 lib/oxidized/model/gcombnps.rb

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index a6ee713..c2035b0 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -77,6 +77,8 @@
    * [XOS](/lib/oxidized/model/xos.rb)
  * F5
    * [TMOS](/lib/oxidized/model/tmos.rb)
+ * Fiberstore
+   * [S3800](/lib/oxidized/model/gcombnps.rb)
  * Force10
    * [DNOS](/lib/oxidized/model/dnos.rb)
    * [FTOS](/lib/oxidized/model/ftos.rb)
@@ -84,6 +86,8 @@
    * [FortiOS](/lib/oxidized/model/fortios.rb)
  * Fujitsu
    * [PRIMERGY Blade switch 1/10Gbe](/lib/oxidized/model/fujitsupy.rb)
+ * GCOM Technologies
+   * [Broadband Network Platform Software](/lib/oxidized/model/gcombnps.rb)
  * Hatteras
    * [Hatteras](/lib/oxidized/model/hatteras.rb)
  * Hirschmann
diff --git a/lib/oxidized/model/gcombnps.rb b/lib/oxidized/model/gcombnps.rb
new file mode 100644
index 0000000..4a97162
--- /dev/null
+++ b/lib/oxidized/model/gcombnps.rb
@@ -0,0 +1,85 @@
+class GcomBNPS < Oxidized::Model
+  # For switches from GCOM Technologies Co.,Ltd. running the "Broadband Network Platform Software"
+  # Author: Frederik Kriewitz <frederik@kriewitz.eu>
+  #
+  # tested with:
+  #  - S5330 (aka Fiberstore S3800)
+
+  prompt /^\r?([\w.@()-]+?(\(1-16 chars\))?[#>:]\s?)$/ # also match SSH password promt (post_login commands are sent after the first prompt)
+  comment  '! '
+
+# alternative to handle the SSH login, but this breaks telnet
+#  expect /^Password\(1-16 chars\):/ do |data|
+#      send @node.auth[:password] + "\n"
+#      ''
+#  end
+
+  # handle pager (can't be disabled?)
+  expect /^\.\.\.\.press ENTER to next line, CTRL_C to quit, other key to next page\.\.\.\.$/ do |data, re|
+   send ' '
+   data.sub re, ''
+  end
+
+  cmd :all do |cfg|
+    cfg = cfg.gsub " \e[73D\e[K", '' # remove garbage remaining from the pager
+    cfg.each_line.to_a[1..-2].join
+  end
+
+  cmd :secret do |cfg|
+    cfg.gsub! /^(snmp-server community)\s+[^\s]+\s+(.*)/, '\\1 <community hidden> \\2'
+    cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg
+  end
+
+  cmd 'show interface sfp' do |cfg|
+    out = []
+    cfg.each_line do |line|
+      next if line.match /^  Temperature/
+      next if line.match /^  Voltage\(V\)/
+      next if line.match /^  Bias Current\(mA\)/
+      next if line.match /^  RX Power\(dBM\)/
+      next if line.match /^  TX Power\(dBM\)/
+      out << line
+    end
+
+    comment out.join
+  end
+
+
+  cmd 'show version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show system' do |cfg|
+    out = []
+    cfg.each_line do |line|
+      next if line.match /^system run time        :/
+      next if line.match /^switch temperature     :/
+      out << line
+    end
+
+    comment out.join
+  end
+
+  cfg :telnet do
+    username /^Username\(1-32 chars\):/
+    password /^Password\(1-16 chars\):/
+  end
+
+  cfg :ssh do
+    # the switch blindy accepts the SSH connection without password validation and then spawns a telnet login prompt
+    # first thing we've to send is the password
+    post_login do
+      send @node.auth[:password] + "\n"
+    end
+  end
+
+  cfg :telnet, :ssh do
+    pre_logout 'exit'
+  end
+
+end
+
-- 
cgit v1.2.3


From 38e1f4216df5751e856e11532fc894ccfbd4010d Mon Sep 17 00:00:00 2001
From: mattie47 <4696925+mattie47@users.noreply.github.com>
Date: Sun, 7 Jan 2018 10:32:52 +1300
Subject: model: Added Allied Telesis AW+ model (#936)

* Create awplus.rb

Added support for Allied Telesis AW+ switches and routers

* Add support for Allied Telesis Alliedware Plus products

* Add Allied Telesis to Supported Products

* Add Allied Telesis to supported models

Feature support included:

- Telnet and SSH
-- Enable/Secret Password
- Device info from "show system" command
-- Dynamic output e.g. Device Uptime is removed.
- Var: remove_secret
- User-defined terminal length
-- User is not required to "terminal no length" and can keep configured pager length.
---
 docs/Supported-OS-Types.md   |  2 ++
 lib/oxidized/model/awplus.rb | 85 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 87 insertions(+)
 create mode 100644 lib/oxidized/model/awplus.rb

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index c2035b0..a12f5ef 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -11,6 +11,8 @@
    * [ISAM](/lib/oxidized/model/isam.rb)
    * [SR OS (Formerly TiMOS)](/lib/oxidized/model/timos.rb)
    * Wireless
+ * Allied Telesis
+   * [Alliedware Plus](/lib/oxidized/model/awplus.rb)
  * Alvarion
    * [BreezeACCESS](/lib/oxidized/model/alvarion.rb)
  * APC
diff --git a/lib/oxidized/model/awplus.rb b/lib/oxidized/model/awplus.rb
new file mode 100644
index 0000000..1d8fbcd
--- /dev/null
+++ b/lib/oxidized/model/awplus.rb
@@ -0,0 +1,85 @@
+class AWPlus < Oxidized::Model
+
+  #Allied Telesis Alliedware Plus Model#
+  #https://www.alliedtelesis.com/products/software/AlliedWare-Plus
+  
+  prompt /^(\r?[\w.@:\/-]+[#>]\s?)$/
+  comment  '! '
+
+  #Avoids needing "term length 0" to display full config file. 
+    expect /--More--/ do |data, re|
+      send ' '
+      data.sub re, ''
+    end
+
+  #Removes gibberish pager output e.g. VT100 escape codes
+  cmd :all do |cfg|
+    cfg.gsub! /\e\[K/, ''         # example how to handle pager - cleareol EL0
+    cfg.gsub! /\e\[7m\e\[m/, ''   # example how to handle pager - Reverse SGR7
+    cfg.gsub! /\r/, ''  # Filters rogue ^M - see issue #415
+    cfg.each_line.to_a[1..-2].join
+  end
+
+  #Remove passwords from config file.
+  #Add vars "remove_secret: true" to global oxidized config file to enable. 
+
+  cmd :secret do |cfg|
+    cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
+    cfg.gsub! /^(username \S+ privilege \d+) (\S+).*/, '\\1 <secret hidden>'
+    cfg.gsub! /^(username \S+ password \d) (\S+)/, '\\1 <secret hidden>'
+    cfg.gsub! /^(username \S+ secret \d) (\S+)/, '\\1 <secret hidden>'
+    cfg.gsub! /^(enable (password|secret) \d) (\S+)/, '\\1 <secret hidden>'
+    cfg.gsub! /^(\s+(?:password|secret)) (?:\d )?\S+/, '\\1 <secret hidden>'
+    cfg.gsub! /^(tacacs-server key \d) (\S+)/, '\\1 <secret hidden>'
+    cfg
+  end
+
+  #Adds "Show system" output to start of config. 
+
+  cmd 'Show System' do |cfg|
+    comment cfg.insert(0,"--------------------------------------------------------------------------------! \n")
+    #Unhash below to write a comment in the config file.
+    cfg.insert(0,"Starting: Show system cmd \n")
+    cfg << "\n \nEnding: show system cmd"
+    comment cfg << "\n--------------------------------------------------------------------------------! \n \n"
+    #Removes the following lines from "show system" in output file. This ensures oxidized diffs are meaningful. 
+    comment cfg.each_line.reject { |line| 
+                                    line.match /^$\n/ or #Remove blank lines in "sh sys"
+                                    line.match /System Status\s*.*/ or
+                                    line.match /RAM\s*:.*/ or 
+                                    line.match /Uptime\s*:.*/ or 
+                                    line.match /Flash\s*:.*/ or 
+                                    line.match /Current software\s*:.*/ or 
+                                    line.match /Software version\s*:.*/ or 
+                                    line.match /Build date\s*:.*/ }.join
+  end
+     
+  #Actually get the devices running config#
+  cmd 'show running-config' do |cfg|
+    cfg
+  end
+  
+  #Config required for telnet to detect username prompt
+  cfg :telnet do
+    username /login:\s/
+    end
+
+  #Main login config
+    cfg :telnet, :ssh do
+    post_login do
+      if vars :enable
+        send "enable\n"
+        expect /^Password:\s/
+        cmd vars(:enable) + "\r\n"
+      else
+        cmd 'enable' # Required for Priv-Exec users without enable PW to be put into "enable mode". 
+      end
+#      cmd 'terminal length 0' #set so the entire config is output without intervention.
+    end
+    pre_logout do
+#      cmd 'terminal no length' #Sets term length back to default on exit. 
+      send  "exit\r\n"
+    end
+  end  
+
+end
-- 
cgit v1.2.3


From 6f46eeb2b5000d3f07377655d0bcfc7c2ef36cb3 Mon Sep 17 00:00:00 2001
From: KodApa85 <parsons151185@gmail.com>
Date: Thu, 18 Jan 2018 15:33:07 +0000
Subject: docs: Added documentation for setting up JunOS with Oxidized (#1155)

---
 docs/Model-Notes/JunOS.md  | 38 ++++++++++++++++++++++++++++++++++++++
 docs/Model-Notes/README.md |  1 +
 2 files changed, 39 insertions(+)
 create mode 100644 docs/Model-Notes/JunOS.md

(limited to 'docs')

diff --git a/docs/Model-Notes/JunOS.md b/docs/Model-Notes/JunOS.md
new file mode 100644
index 0000000..ed8dbca
--- /dev/null
+++ b/docs/Model-Notes/JunOS.md
@@ -0,0 +1,38 @@
+JunOS Configuration
+========================
+
+Create login class cfg-view
+
+```
+set system login class cfg-view permissions view-configuration
+set system login class cfg-view allow-commands "(show)|(set cli screen-length)|(set cli screen-width)"
+set system login class cfg-view deny-commands "(clear)|(file)|(file show)|(help)|(load)|(monitor)|(op)|(request)|(save)|(set)|(start)|(test)"
+set system login class cfg-view deny-configuration all
+```
+
+Create a user with cfg-view class
+
+```
+set system login user oxidized class cfg-view
+set system login user oxidized authentication plain-text-password "verysecret"
+```
+
+The commands Oxidized executes are:
+
+1. set cli screen-length 0
+2. set cli screen-width 0
+3. show configuration
+4. show version
+5. show chassis hardware
+6. show system license
+7. show system license keys
+ex22|ex33|ex4|ex8|qfx only
+8. show virtual-chassis
+MX960 only
+9. show chassis fabric reachability
+
+
+Oxidized can now retrieve your configuration!
+
+
+Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index 15ab445..d4b917c 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -12,6 +12,7 @@ Use the table below for more information on the Vendor/Model caveats.
 Vendor          | Model           |Updated
 ----------------|-----------------|----------------
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
+Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
 
 
 If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
-- 
cgit v1.2.3


From 4e59878052f0668f4dde2282e86882626936f6b4 Mon Sep 17 00:00:00 2001
From: KodApa85 <parsons151185@gmail.com>
Date: Thu, 25 Jan 2018 22:01:39 +0000
Subject: model: Fixed FTP Passive/Active modes & Xyzel XGS4600 series Docs
 (#1161)

* FTP Passive/Active mode added

* Documentation for Xyzel XGS4600 series
---
 docs/Configuration.md             |  9 +++++++++
 docs/Model-Notes/README.md        |  1 +
 docs/Model-Notes/XGS4600-Zyxel.md | 24 ++++++++++++++++++++++++
 lib/oxidized/config.rb            |  1 +
 lib/oxidized/input/ftp.rb         |  4 +++-
 5 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 docs/Model-Notes/XGS4600-Zyxel.md

(limited to 'docs')

diff --git a/docs/Configuration.md b/docs/Configuration.md
index db71bc7..e2db05e 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -74,6 +74,15 @@ vars_map:
 ...
 ```
 
+### FTP Passive Mode
+
+Oxidized uses ftp passive mode by default. Some devices require passive mode to be disabled. To do so, we can set `input.ftp.passive` to false
+```
+input:
+  ftp:
+    passive: false
+```
+
 ### Advanced Configuration
 
 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.
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index d4b917c..f51ed80 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -13,6 +13,7 @@ Vendor          | Model           |Updated
 ----------------|-----------------|----------------
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
+Xyzel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
 
 
 If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
diff --git a/docs/Model-Notes/XGS4600-Zyxel.md b/docs/Model-Notes/XGS4600-Zyxel.md
new file mode 100644
index 0000000..0ff2e7d
--- /dev/null
+++ b/docs/Model-Notes/XGS4600-Zyxel.md
@@ -0,0 +1,24 @@
+ZynOS Configuration
+========================
+
+## FTP
+FTP access is only possible as admin, other users can login but cannot pull the files.
+For the XGS4600 series the config file is _config_ and not _config-0_
+
+The following line in _oxidized/lib/oxidized/model/zynos.rb_ with need changing
+```
+  cmd 'config-0'
+
+```
+
+The inclusion of an extra ftp option is also require. Within _input_ add the following
+```
+input:
+  ftp:
+    passive: false
+```
+
+Oxidized can now retrieve your configuration!
+
+
+Back to [Model-Notes](README.md)
diff --git a/lib/oxidized/config.rb b/lib/oxidized/config.rb
index 23af9c2..47544fb 100644
--- a/lib/oxidized/config.rb
+++ b/lib/oxidized/config.rb
@@ -37,6 +37,7 @@ module Oxidized
       asetus.default.input.default    = 'ssh, telnet'
       asetus.default.input.debug      = false # or String for session log file
       asetus.default.input.ssh.secure = false # complain about changed certs
+      asetus.default.input.ftp.passive= true  # ftp passive mode
 
       asetus.default.output.default = 'file'  # file, git
       asetus.default.source.default = 'csv'   # csv, sql
diff --git a/lib/oxidized/input/ftp.rb b/lib/oxidized/input/ftp.rb
index 80de257..cdf3688 100644
--- a/lib/oxidized/input/ftp.rb
+++ b/lib/oxidized/input/ftp.rb
@@ -19,7 +19,9 @@ module Oxidized
       @node       = node
       @node.model.cfg['ftp'].each { |cb| instance_exec(&cb) }
       @log = File.open(Oxidized::Config::Log + "/#{@node.ip}-ftp", 'w') if Oxidized.config.input.debug?
-      @ftp = Net::FTP.new @node.ip, @node.auth[:username], @node.auth[:password]
+      @ftp = Net::FTP.new(@node.ip)
+      @ftp.passive = Oxidized.config.input.ftp.passive
+      @ftp.login  @node.auth[:username], @node.auth[:password]
       connected?
     end
 
-- 
cgit v1.2.3


From cc78c8143cc167a14f1d45755a83242fae0af1b2 Mon Sep 17 00:00:00 2001
From: Neil Lathwood <neil@lathwood.co.uk>
Date: Thu, 15 Feb 2018 19:40:26 +0000
Subject: docs: Added model note for 3com comware (#1186)

---
 docs/Model-Notes/Comware.md | 10 ++++++++++
 docs/Model-Notes/README.md  |  1 +
 2 files changed, 11 insertions(+)
 create mode 100644 docs/Model-Notes/Comware.md

(limited to 'docs')

diff --git a/docs/Model-Notes/Comware.md b/docs/Model-Notes/Comware.md
new file mode 100644
index 0000000..31eb002
--- /dev/null
+++ b/docs/Model-Notes/Comware.md
@@ -0,0 +1,10 @@
+Comware Configuration
+=====================
+
+If you find 3Com comware devices aren't being backed up this may be due to prompt detection not matching 
+because a previous login message is disabled after the first prompt. You can disable this on the devices 
+themselves by running this command:
+
+`info-center source default channel 1 log state off debug state off`
+
+[Reference](https://github.com/ytti/oxidized/issues/1171)
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index f51ed80..6a64058 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -11,6 +11,7 @@ Use the table below for more information on the Vendor/Model caveats.
 
 Vendor          | Model           |Updated
 ----------------|-----------------|----------------
+3COM|[Comware](Comware.md)|15 Feb 2018
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
 Xyzel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
-- 
cgit v1.2.3


From baee367bfec7ec5241ad7e893de7df8ea7eec1e7 Mon Sep 17 00:00:00 2001
From: Neil Lathwood <neil@lathwood.co.uk>
Date: Tue, 27 Feb 2018 14:10:14 +0000
Subject: Added model to Supported-OS-Types

---
 docs/Supported-OS-Types.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index c2035b0..683a022 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -133,6 +133,8 @@
    * [Quanta / VxWorks 6.6 (1.1.0.8)](/lib/oxidized/model/quantaos.rb)
  * Siklu
    * [EtherHaul](/lib/oxidized/model/siklu.rb)
+ * SNR
+   * [SNR](/lib/oxidized/model/snr.rb)
  * Supermicro
    * [Supermicro](/lib/oxidized/model/supermicro.rb)
  * Symantec
-- 
cgit v1.2.3


From 72397c4f344ab97fe3db1e381a3e5e1b1a935c62 Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 27 Feb 2018 08:58:59 -0600
Subject: model: Added support for ArbOS from Arbor Networks. (#1096)

* Basic support for ArbOS from Arbor Networks.

ArbOS is the generic name for Arbor Networks (https://www.arbornetworks.com/) OS that runs on some of their devices.

Found and imported from https://github.com/claranet/oxidized . Credit to Claranet for the creation.

Locally validated on Peakflow SP v8.2+

The module is quite simple as the command 'config show' automatically disables pagination. There is a pagination-enabled version of the command as well.

* Added model notes for ArbOS
---
 docs/Model-Notes/ArbOS.md   | 10 ++++++++++
 docs/Model-Notes/README.md  |  1 +
 docs/Supported-OS-Types.md  |  2 ++
 lib/oxidized/model/arbos.rb | 27 +++++++++++++++++++++++++++
 4 files changed, 40 insertions(+)
 create mode 100644 docs/Model-Notes/ArbOS.md
 create mode 100644 lib/oxidized/model/arbos.rb

(limited to 'docs')

diff --git a/docs/Model-Notes/ArbOS.md b/docs/Model-Notes/ArbOS.md
new file mode 100644
index 0000000..0f5b628
--- /dev/null
+++ b/docs/Model-Notes/ArbOS.md
@@ -0,0 +1,10 @@
+Arbor Networks ArbOS notes
+==========================
+
+If you are running ArbOS version 7 or lower then you may need to update the model to remove `exec true`:
+
+```
+  cfg :ssh do
+    pre_logout 'exit'
+  end
+```
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index 6a64058..9d7db32 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -12,6 +12,7 @@ Use the table below for more information on the Vendor/Model caveats.
 Vendor          | Model           |Updated
 ----------------|-----------------|----------------
 3COM|[Comware](Comware.md)|15 Feb 2018
+Arbor Networks|[ArbOS](ArbOS.md)|27 Feb 2018
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
 Xyzel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index a12f5ef..d6d718f 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -17,6 +17,8 @@
    * [BreezeACCESS](/lib/oxidized/model/alvarion.rb)
  * APC
    * [AOS](/lib/oxidized/model/apc_aos.rb)
+ * Arbor Networks
+   * [ArbOS](/lib/oxidized/model/arbos.rb)
  * Arista
    * [EOS](/lib/oxidized/model/eos.rb)
  * Arris
diff --git a/lib/oxidized/model/arbos.rb b/lib/oxidized/model/arbos.rb
new file mode 100644
index 0000000..389f3f6
--- /dev/null
+++ b/lib/oxidized/model/arbos.rb
@@ -0,0 +1,27 @@
+class ARBOS  < Oxidized::Model
+
+  # Arbor OS model #
+
+  prompt /^[\S\s]+\n([\w.@-]+[:\/#>]+)\s?$/
+  comment  '# '
+
+  cmd 'system hardware' do |cfg|
+    cfg.gsub! /^Boot\ time\:\s.+/, '' # Remove boot timer
+    cfg.gsub! /^Load\ averages\:\s.+/, '' # Remove CPU load info
+    cfg = cfg.each_line.to_a[2..-1].join
+    comment cfg
+  end
+
+  cmd 'system version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'config show' do |cfg|
+    cfg
+  end
+
+  cfg :ssh do
+    exec true
+    pre_logout 'exit'
+  end
+end
-- 
cgit v1.2.3


From ad2a0675edee605bda8fe460b3656857eb050129 Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Sun, 11 Mar 2018 23:11:13 +0100
Subject: Introduce support for OXIDIZED_SSH_PASSPHRASE

---
 docs/Hooks.md                   | 2 ++
 lib/oxidized/hook/githubrepo.rb | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/Hooks.md b/docs/Hooks.md
index fab4025..080d301 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -67,6 +67,8 @@ This hook configures the repository `remote` and _push_ the code when the specif
   * `publickey`: publickey for repository auth.
   * `privatekey`: privatekey for repository auth.
 
+It is also possible to set the environment variable `OXIDIZED_SSH_PASSPHRASE` to a passphrase if your keypair requires it.
+
 When using groups repositories, each group must have its own `remote` in the `remote_repo` config.
 
 ``` yaml
diff --git a/lib/oxidized/hook/githubrepo.rb b/lib/oxidized/hook/githubrepo.rb
index d33e54e..f74b22a 100644
--- a/lib/oxidized/hook/githubrepo.rb
+++ b/lib/oxidized/hook/githubrepo.rb
@@ -51,7 +51,7 @@ class GithubRepo < Oxidized::Hook
     else
       if cfg.has_key?('publickey') && cfg.has_key?('privatekey')
         log "Using ssh auth with key", :debug
-        Rugged::Credentials::SshKey.new(username: 'git', publickey: File.expand_path(cfg.publickey), privatekey: File.expand_path(cfg.privatekey))
+        Rugged::Credentials::SshKey.new(username: 'git', publickey: File.expand_path(cfg.publickey), privatekey: File.expand_path(cfg.privatekey), passphrase: ENV["OXIDIZED_SSH_PASSPHRASE"])
       else
         log "Using ssh auth with agentforwarding", :debug
         Rugged::Credentials::SshKeyFromAgent.new(username: 'git')
-- 
cgit v1.2.3


From 87600b1f5f12711afe29c408e02dbbd927e3f25d Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Mon, 12 Mar 2018 00:19:20 +0100
Subject: Lint and standardize markdown documentation

---
 CHANGELOG.md                      | 610 ++++++++++++++++++++------------------
 README.md                         |  83 +++---
 TODO.md                           |  52 ++--
 docs/Configuration.md             |  58 ++--
 docs/Hooks.md                     |  78 ++---
 docs/Model-Notes/AireOS.md        |   8 +-
 docs/Model-Notes/ArbOS.md         |   2 +-
 docs/Model-Notes/Comware.md       |  10 +-
 docs/Model-Notes/JunOS.md         |  14 +-
 docs/Model-Notes/README.md        |   8 +-
 docs/Model-Notes/VRP-Huawei.md    |   5 +-
 docs/Model-Notes/XGS4600-Zyxel.md |  13 +-
 docs/Outputs.md                   |  42 ++-
 docs/Ruby-API.md                  |  46 ++-
 docs/Sources.md                   |  48 +--
 docs/Supported-OS-Types.md        | 317 ++++++++++----------
 16 files changed, 736 insertions(+), 658 deletions(-)

(limited to 'docs')

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7e77026..0e03883 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,286 +1,324 @@
-# 0.21.0
-- FEATURE: routeros include system history (@InsaneSplash)
-- FEATURE: vrp added support for removing secrets (@bheum)
-- FEATURE: hirschmann model (@OCangrand)
-- FEATURE: asa added multiple context support (@marnovdm)
-- FEATURE: procurve added additional output (@davama)
-- FEATURE: Updated git commits to bare repo + drop need for temp dir during clone (@asenci)
-- FEATURE: asyncos model (@cd67-usrt)
-- FEATURE: ciscosma model (@cd67-usrt)
-- FEATURE: procurve added transceiver info (@davama)
-- FEATURE: routeros added remove_secret option (@spinza)
-- FEATURE: Updated net-ssh version (@Fauli83)
-- FEATURE: audiocodes model (@Fauli83)
-- FEATURE: Added docs for Huawei VRP devices (@tuxis-ie)
-- FEATURE: ciscosmb added radius key detection (@davama)
-- FEATURE: radware model (@sfini)
-- FEATURE: enterasys model (@koenvdheuvel)
-- FEATURE: weos model (@ignaqui)
-- FEATURE: hpemsa model (@aschaber1)
-- FEATURE: Added nodes_done hook (@danilopopeye)
-- FEATURE: ucs model (@WiXZlo)
-- FEATURE: acsw model (@sfini)
-- FEATURE: aen model (@ZacharyPuls)
-- FEATURE: coriantgroove model (@nickhilliard)
-- FEATURE: sgos model (@seekerOK)
-- FEATURE: powerconnect support password removal (@tobbez)
-- FEATURE: Added haproxy example for Ubuntu (@denvera)
-- BUGFIX: fiberdriver remove configuration generated on from diff (@emjemj)
-- BUGFIX: Fix email pass through (@ZacharyPuls) 
-- BUGFIX: iosxr suppress timestamp (@ja-frog)
-- BUGFIX: ios allow lowercase user/pass prompt (@deepseth)
-- BUGFIX: Use git show instead of git diff (@asenci)
-- BUGFIX: netgear fixed sending enable password and exit/quit (@candlerb)
-- BUGFIX: ironware removed space requirement from password prompt (@crami)
-- BUGFIX: dlink removed uptime from diff (@rfdrake)
-- BUGFIX: planet removed temp from diff (@flokli)
-- BUGFIX: ironware removed fan, temp and flash from diff (@Punicaa)
-- BUGFIX: panos changed exit to quit (@goebelmeier)
-- BUGFIX: fortios remove FDS address from diffs (@bheum)
-- BUGFIX: fortios remove additional secrets from diffs (@brunobritocarvalho)
-- BUGFIX: fortios remove IPS URL DB (@brunobritocarvalho)
-- BUGFIX: voss remove temperature, power and uptime from diff (@ospfbgp)
-
-# 0.20.0
-- FEATURE: gpg support for CSV source (@elmobp)
-- FEATURE: slackdiff (@natm)
-- FEATURE: gitcrypt output model (@clement-parisot)
-- FEATURE: model specific credentials (@davromaniak)
-- FEATURE: hierarchical json in http source model
-- FEATURE: next-adds-job config toggle (to add new job when ever /next is called)
-- FEATURE: netgear model (@aschaber1)
-- FEATURE: zhone model (@rfdrake)
-- FEATURE: tplink model (@mediumo)
-- FEATURE: oneos model (@crami)
-- FEATURE: cisco NGA model (@udhos)
-- FEATURE: voltaire model (@clement-parisot)
-- FEATURE: siklu model (@bdg-robert)
-- FEATURE: voss model (@ospfbgp)
-- BUGFIX: ios, cumulus, ironware, nxos, fiberdiver, aosw, fortios, comware, procurve, opengear, timos, routeros, junos, asa, aireos, mlnxos, pfsense, saos, powerconnect, firewareos, quantaos
-
-# 0.19.0
-- FEATURE: allow setting ssh_keys (not relying on openssh config) (@denvera)
-- FEATURE: fujitsupy model (@stokbaek)
-- FEATURE: fiberdriver model (@emjemj)
-- FEATURE: hpbladesystems model (@flokli)
-- FEATURE: planetsgs model (@flokli)
-- FEATURE: trango model (@rfdrake)
-- FEATURE: casa model (@rfdrake)
-- FEATURE: dlink model (@rfdrake)
-- FEATURE: hatteras model (@rfdrake)
-- FEATURE: ability to ignore SSL certs in http (@laf)
-- FEATURE: awsns hooks, publish messages to AWS SNS topics (@natm)
-- BUGFIX: pfsense, dnos, powerconnect, ciscosmb, eos, aosw
-
-# 0.18.0
-- FEATURE: APC model (by @davromaniak )
-- BUGFIX: ironware, aosw
-- BUGFIX: interpolate nil, false, true for node vars too
-
-# 0 17.0
-- 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
-
-# 0.16.1
-- BUGFIX: unnecessary puts statement removed from git.rb
-
-# 0.16.0
-- FEATURE: support Gaia OS devices (by @totosh)
-- BUGFIX: #fetch, #version fixes in nodes.rb (by @danilopopeye)
-- BUGFIX: procurve
-
-# 0.15.0
-- FEATURE: disable periodic collection, only on demand (by Adam Winberg)
-- FEATURE: allow disabling ssh exec mode always (mainly for oxidized-script) (by @nickhilliard)
-- FEATURE: support mellanox devices (by @ham5ter)
-- FEATURE: support firewireos devices (by @alexandre-io)
-- FEATURE: support quanta devices (by @f0o)
-- FEATURE: support tellabs coriant8800, coriant8600 (by @udhos)
-- FEATURE: support brocade6910 (by @cardboardpig)
-- BUGFIX: debugging, tests (by @ElvinEfendi)
-- BUGFIX: nos, panos, acos, procurve, eos, edgeswitch, aosw, fortios updates
-
-# 0.14.3
-- BUGFIX: fix git when using multiple groups without single_repo
-
-# 0.14.2
-- BUGFIX: git expand path for all groups
-- BUGFIX: git get_version, teletubbies do it again
-- BUGFIX: comware, acos, procurve models
-
-# 0.14.1
-- BUGFIX: git get_version when groups and single_repo are used
-
-# 0.14.0
-- FEATURE: support supermicro swithes (by @funzoneq)
-- FEATURE: support catos switches
-- BUGFIX: git+groups+singlerepo (by @PANZERBARON)
-- BUGFIX: asa, tmos, ironware, ios-xr
-- BUGFIX: mandate net-ssh 3.0.x, don't accept 3.1 (numerous issues)
-
-# 0.13.1
-- BUGFIX: file permissions (Sigh...)
-
-# 0.13.0
-- FEATURE: http post for configs (by @jgroom33)
-- FEATURE: support ericsson redbacks (by @roedie)
-- FEATURE: support motorola wireless controllers (by @roadie)
-- FEATURE: support citrix netscaler (by @roadie)
-- FEATURE: support datacom devices (by @danilopopeye)
-- FEATURE: support netonix devices
-- FEATURE: support specifying ssh cipher and kex (by @roadie)
-- FEATURE: rename proxy to ssh_proxy (by @roadie)
-- FEATURE: support ssh keys on ssh_proxy (by @awix)
-- BUGFIX: various (by @danilopopeye)
-- BUGFIX: Node#repo with groups (by @danilopopeye)
-- BUGFIX: githubrepohoook (by @danilopopeye)
-- BUGFIX: fortios, airos, junos, xos, edgeswitch, nos, tmos, procurve, ipos models
-
-# 0.12.2
-- BUGFIX: more MRV model fixes (by @natm)
-
-# 0.12.1
-- BUGFIX: set term to vty100
-- BUGFIX: MRV model fixes (by @natm)
-
-# 0.12.0
-- FEATURE: enhance AOSW (by @mikebryant)
-- FEATURE: F5 TMOS support (by @mikebryant)
-- FEATURE: Opengear support (by @mikebryant)
-- FEATURE: EdgeSwitch support (by @doogieconsulting)
-- BUGFIX: rename input debug log files
-- BUGFIX: powerconnect model fixes (by @Madpilot0)
-- BUGFIX: fortigate model fixes (by @ElvinEfendi)
-- BUGFIX: various (by @mikebryant)
-- BUGFIX: write SSH debug to file without buffering
-- BUGFIX: fix IOS XR prompt handling
-
-# 0.11.0
-- FEATURE: ssh proxycommand (by @ElvinEfendi)
-- FEATURE: basic auth in HTTP source (by @laf)
-- BUGFIX: do not inject string to output before model gets it
-- BUGFIX: store pidfile in oxidized root
-
-# 0.10.0
-- FEATURE: Various refactoring (by @ElvinEfendi)
-- FEATURE: Ciena SOAS support (by @jgroom33)
-- FEATURE: support group variables (by @supertylerc)
-- BUGFIX: various ((orly))  (by @marnovdm, @danbaugher, @MrRJ45, @asynet, @nickhilliard)
-
-# 0.9.0
-- FEATURE: input log now uses devices name as file, instead of string from config (by @skoef)
-- FEATURE: Dell Networkign OS (dnos) support (by @erefre)
-- BUGFIX: CiscoSMB, powerconnect, comware, xos, ironware, nos fixes
-
-# 0.8.1
-- BUGFIX: restore ruby 1.9.3 compatibility
-
-# 0.8.0
-- FEATURE: hooks (by @aakso)
-- FEATURE: MRV MasterOS support (by @kwibbly)
-- FEATURE: EdgeOS support (by @laf)
-- FEATURE: FTP input and Zyxel ZynOS support (by @ytti)
-- FEATURE: version and diffs API For oxidized-web (by @FlorianDoublet)
-- BUGFIX: aosw, ironware, routeros, xos models
-- BUGFIX: crash with 0 nodes
-- BUGFIX: ssh auth fail without keyboard-interactive
-- Full changelog https://github.com/ytti/oxidized/compare/0.7.1...HEAD
-
-# 0.7.0
-- FEATURE: support http source (by @laf)
-- FEATURE: support Palo Alto PANOS (by @rixxxx)
-- BUGFIX:  screenos fixes (by @rixxxx)
-- BUGFIX:  allow 'none' auth in ssh (spotted by @SaldoorMike, needed by ciscosmb+aireos)
-
-# 0.6.0
-- FEATURE: support cumulus linux (by @FlorianDoublet)
-- FEATURE: support HP Comware SMB siwtches (by @sid3windr)
-- FEATURE: remove secret additions (by @rodecker)
-- FEATURE: option to put all groups in single repo (by @ytti)
-- FEATURE: expand path in source: csv: (so that ~/foo/bar works) (by @ytti)
-- BUGFIX: screenos fixes (by @rixxxx)
-- BUGFIX: ironware fixes (by @FlorianDoublet)
-- BUGFIX: powerconnect fixes (by @sid3windr)
-- BUGFIX: don't ask interactive password in new net/ssh (by @ytti)
-
-# 0.5.0
-- FEATURE: Mikrotik RouterOS model (by @emjemj)
-- FEATURE: add support for Cisco VSS (by @MrRJ45)
-- BUGFIX: general fixes to powerconnect model (by @MrRJ45)
-- BUGFIX: fix initial commit issues with rugged (by @MrRJ45)
-- BUGFIX: pager error for old dell powerconnect switches (by @emjemj)
-- BUGFIX: logout error for old dell powerconnect switches (by @emjemj)
-
-# 0.4.1
-- BUGFIX: handle missing output file (by @brandt)
-- BUGFIX: fix passwordless enable on Arista EOS model (by @brandt)
-
-# 0.4.0
-- FEATURE: allow setting IP address in addition to name in source (SQL/CSV)
-- FEATURE: approximate how long it takes to get node from larger view than 1
-- FEATURE: unconditionally start new job if too long has passed since previous start
-- FEATURE: add enable to Arista EOS model
-- FEATURE: add rugged dependency in gemspec
-- FEATURE: log prompt detection failures
-- BUGFIX: xos while using telnet (by @fhibler)
-- BUGFIX: ironware logout on some models (by @fhibler)
-- BUGFIX: allow node to be removed while it is being collected
-- BUGFIX: if model returns non string value, return empty string
-- BUGFIX: better prompt for Arista EOS model (by @rodecker)
-- BUGFIX: improved configuration handling for Arista EOS model (by @rodecker)
-
-# 0.3.0
-- FEATURE: *FIXME* bunch of stuff I did for richih, docs needed
-- FEATURE: ComWare model (by erJasp)
-- FEATURE: Add comment support for router.db file
-- FEATURE: Add input debugging and related configuration options
-- BUGFIX: Fix ASA model prompt
-- BUGFIX: Fix Aruba model display
-- BUGFIX: Fix changing output in PowerConnect model
-
-# 0.2.4
-- FEATURE: Cisco SMB (Nikola series VxWorks) model by @thetamind
-- FEATURE: Extreme Networks XOS model (access by sjm)
-- FEATURE: Brocade NOS (Network Operating System) (access by sjm)
-- BUGFIX: Match exactly to node[:name] if node[name] is an ip address.
-
-# 0.2.3
-- BUGFIX: rescue @ssh.close when far end closes disgracefully (ALU ISAM)
-- BUGFIX: bugfixes to models
-- FEATURE: Alcatel-Lucent ISAM 7302/7330 model added by @jalmargyyk
-- FEATURE: Huawei VRP model added by @jalmargyyk
-- FEATURE: Ubiquiti AirOS added by @willglyn
-- FEATURE: Support 'input' debug in config, ssh/telnet use it to write session log
-
-# 0.2.2
-- BUGFIX: mark node as failure if unknown error is raised
-
-# 0.2.1
-- BUGFIX: vars variable resolving for main level vars
-
-# 0.2.0
-- FEATURE: Force10 model added by @lysiszegerman
-- FEATURE: ScreenOS model added by @lysiszegerman
-- FEATURE: FabricOS model added by @thakala
-- FEATURE: ASA model added by @thakala
-- FEATURE: Vyattamodel added by @thakala
-- BUGFIX: Oxidized::String convenience methods for models fixed
-
-# 0.1.1
-- BUGFIX: vars needs to return value of r, not value of evaluation
+# Changelog
+
+## 0.21.0
+
+* FEATURE: routeros include system history (@InsaneSplash)
+* FEATURE: vrp added support for removing secrets (@bheum)
+* FEATURE: hirschmann model (@OCangrand)
+* FEATURE: asa added multiple context support (@marnovdm)
+* FEATURE: procurve added additional output (@davama)
+* FEATURE: Updated git commits to bare repo + drop need for temp dir during clone (@asenci)
+* FEATURE: asyncos model (@cd67-usrt)
+* FEATURE: ciscosma model (@cd67-usrt)
+* FEATURE: procurve added transceiver info (@davama)
+* FEATURE: routeros added remove_secret option (@spinza)
+* FEATURE: Updated net-ssh version (@Fauli83)
+* FEATURE: audiocodes model (@Fauli83)
+* FEATURE: Added docs for Huawei VRP devices (@tuxis-ie)
+* FEATURE: ciscosmb added radius key detection (@davama)
+* FEATURE: radware model (@sfini)
+* FEATURE: enterasys model (@koenvdheuvel)
+* FEATURE: weos model (@ignaqui)
+* FEATURE: hpemsa model (@aschaber1)
+* FEATURE: Added nodes_done hook (@danilopopeye)
+* FEATURE: ucs model (@WiXZlo)
+* FEATURE: acsw model (@sfini)
+* FEATURE: aen model (@ZacharyPuls)
+* FEATURE: coriantgroove model (@nickhilliard)
+* FEATURE: sgos model (@seekerOK)
+* FEATURE: powerconnect support password removal (@tobbez)
+* FEATURE: Added haproxy example for Ubuntu (@denvera)
+* BUGFIX: fiberdriver remove configuration generated on from diff (@emjemj)
+* BUGFIX: Fix email pass through (@ZacharyPuls)
+* BUGFIX: iosxr suppress timestamp (@ja-frog)
+* BUGFIX: ios allow lowercase user/pass prompt (@deepseth)
+* BUGFIX: Use git show instead of git diff (@asenci)
+* BUGFIX: netgear fixed sending enable password and exit/quit (@candlerb)
+* BUGFIX: ironware removed space requirement from password prompt (@crami)
+* BUGFIX: dlink removed uptime from diff (@rfdrake)
+* BUGFIX: planet removed temp from diff (@flokli)
+* BUGFIX: ironware removed fan, temp and flash from diff (@Punicaa)
+* BUGFIX: panos changed exit to quit (@goebelmeier)
+* BUGFIX: fortios remove FDS address from diffs (@bheum)
+* BUGFIX: fortios remove additional secrets from diffs (@brunobritocarvalho)
+* BUGFIX: fortios remove IPS URL DB (@brunobritocarvalho)
+* BUGFIX: voss remove temperature, power and uptime from diff (@ospfbgp)
+
+## 0.20.0
+
+* FEATURE: gpg support for CSV source (@elmobp)
+* FEATURE: slackdiff (@natm)
+* FEATURE: gitcrypt output model (@clement-parisot)
+* FEATURE: model specific credentials (@davromaniak)
+* FEATURE: hierarchical json in http source model
+* FEATURE: next-adds-job config toggle (to add new job when ever /next is called)
+* FEATURE: netgear model (@aschaber1)
+* FEATURE: zhone model (@rfdrake)
+* FEATURE: tplink model (@mediumo)
+* FEATURE: oneos model (@crami)
+* FEATURE: cisco NGA model (@udhos)
+* FEATURE: voltaire model (@clement-parisot)
+* FEATURE: siklu model (@bdg-robert)
+* FEATURE: voss model (@ospfbgp)
+* BUGFIX: ios, cumulus, ironware, nxos, fiberdiver, aosw, fortios, comware, procurve, opengear, timos, routeros, junos, asa, aireos, mlnxos, pfsense, saos, powerconnect, firewareos, quantaos
+
+## 0.19.0
+
+* FEATURE: allow setting ssh_keys (not relying on openssh config) (@denvera)
+* FEATURE: fujitsupy model (@stokbaek)
+* FEATURE: fiberdriver model (@emjemj)
+* FEATURE: hpbladesystems model (@flokli)
+* FEATURE: planetsgs model (@flokli)
+* FEATURE: trango model (@rfdrake)
+* FEATURE: casa model (@rfdrake)
+* FEATURE: dlink model (@rfdrake)
+* FEATURE: hatteras model (@rfdrake)
+* FEATURE: ability to ignore SSL certs in http (@laf)
+* FEATURE: awsns hooks, publish messages to AWS SNS topics (@natm)
+* BUGFIX: pfsense, dnos, powerconnect, ciscosmb, eos, aosw
+
+## 0.18.0
+
+* FEATURE: APC model (by @davromaniak )
+* BUGFIX: ironware, aosw
+* BUGFIX: interpolate nil, false, true for node vars too
+
+## 0 17.0
+
+* 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
+
+## 0.16.1
+
+* BUGFIX: unnecessary puts statement removed from git.rb
+
+## 0.16.0
+
+* FEATURE: support Gaia OS devices (by @totosh)
+* BUGFIX: #fetch, #version fixes in nodes.rb (by @danilopopeye)
+* BUGFIX: procurve
+
+## 0.15.0
+
+* FEATURE: disable periodic collection, only on demand (by Adam Winberg)
+* FEATURE: allow disabling ssh exec mode always (mainly for oxidized-script) (by @nickhilliard)
+* FEATURE: support mellanox devices (by @ham5ter)
+* FEATURE: support firewireos devices (by @alexandre-io)
+* FEATURE: support quanta devices (by @f0o)
+* FEATURE: support tellabs coriant8800, coriant8600 (by @udhos)
+* FEATURE: support brocade6910 (by @cardboardpig)
+* BUGFIX: debugging, tests (by @ElvinEfendi)
+* BUGFIX: nos, panos, acos, procurve, eos, edgeswitch, aosw, fortios updates
+
+## 0.14.3
+
+* BUGFIX: fix git when using multiple groups without single_repo
+
+## 0.14.2
+
+* BUGFIX: git expand path for all groups
+* BUGFIX: git get_version, teletubbies do it again
+* BUGFIX: comware, acos, procurve models
+
+## 0.14.1
+
+* BUGFIX: git get_version when groups and single_repo are used
+
+## 0.14.0
+
+* FEATURE: support supermicro swithes (by @funzoneq)
+* FEATURE: support catos switches
+* BUGFIX: git+groups+singlerepo (by @PANZERBARON)
+* BUGFIX: asa, tmos, ironware, ios-xr
+* BUGFIX: mandate net-ssh 3.0.x, don't accept 3.1 (numerous issues)
+
+## 0.13.1
+
+* BUGFIX: file permissions (Sigh...)
+
+## 0.13.0
+
+* FEATURE: http post for configs (by @jgroom33)
+* FEATURE: support ericsson redbacks (by @roedie)
+* FEATURE: support motorola wireless controllers (by @roadie)
+* FEATURE: support citrix netscaler (by @roadie)
+* FEATURE: support datacom devices (by @danilopopeye)
+* FEATURE: support netonix devices
+* FEATURE: support specifying ssh cipher and kex (by @roadie)
+* FEATURE: rename proxy to ssh_proxy (by @roadie)
+* FEATURE: support ssh keys on ssh_proxy (by @awix)
+* BUGFIX: various (by @danilopopeye)
+* BUGFIX: Node#repo with groups (by @danilopopeye)
+* BUGFIX: githubrepohoook (by @danilopopeye)
+* BUGFIX: fortios, airos, junos, xos, edgeswitch, nos, tmos, procurve, ipos models
+
+## 0.12.2
+
+* BUGFIX: more MRV model fixes (by @natm)
+
+## 0.12.1
+
+* BUGFIX: set term to vty100
+* BUGFIX: MRV model fixes (by @natm)
+
+## 0.12.0
+
+* FEATURE: enhance AOSW (by @mikebryant)
+* FEATURE: F5 TMOS support (by @mikebryant)
+* FEATURE: Opengear support (by @mikebryant)
+* FEATURE: EdgeSwitch support (by @doogieconsulting)
+* BUGFIX: rename input debug log files
+* BUGFIX: powerconnect model fixes (by @Madpilot0)
+* BUGFIX: fortigate model fixes (by @ElvinEfendi)
+* BUGFIX: various (by @mikebryant)
+* BUGFIX: write SSH debug to file without buffering
+* BUGFIX: fix IOS XR prompt handling
+
+## 0.11.0
+
+* FEATURE: ssh proxycommand (by @ElvinEfendi)
+* FEATURE: basic auth in HTTP source (by @laf)
+* BUGFIX: do not inject string to output before model gets it
+* BUGFIX: store pidfile in oxidized root
+
+## 0.10.0
+
+* FEATURE: Various refactoring (by @ElvinEfendi)
+* FEATURE: Ciena SOAS support (by @jgroom33)
+* FEATURE: support group variables (by @supertylerc)
+* BUGFIX: various ((orly))  (by @marnovdm, @danbaugher, @MrRJ45, @asynet, @nickhilliard)
+
+## 0.9.0
+
+* FEATURE: input log now uses devices name as file, instead of string from config (by @skoef)
+* FEATURE: Dell Networkign OS (dnos) support (by @erefre)
+* BUGFIX: CiscoSMB, powerconnect, comware, xos, ironware, nos fixes
+
+## 0.8.1
+
+* BUGFIX: restore ruby 1.9.3 compatibility
+
+## 0.8.0
+
+* FEATURE: hooks (by @aakso)
+* FEATURE: MRV MasterOS support (by @kwibbly)
+* FEATURE: EdgeOS support (by @laf)
+* FEATURE: FTP input and Zyxel ZynOS support (by @ytti)
+* FEATURE: version and diffs API For oxidized-web (by @FlorianDoublet)
+* BUGFIX: aosw, ironware, routeros, xos models
+* BUGFIX: crash with 0 nodes
+* BUGFIX: ssh auth fail without keyboard-interactive
+* Full changelog https://github.com/ytti/oxidized/compare/0.7.1...HEAD
+
+## 0.7.0
+
+* FEATURE: support http source (by @laf)
+* FEATURE: support Palo Alto PANOS (by @rixxxx)
+* BUGFIX:  screenos fixes (by @rixxxx)
+* BUGFIX:  allow 'none' auth in ssh (spotted by @SaldoorMike, needed by ciscosmb+aireos)
+
+## 0.6.0
+
+* FEATURE: support cumulus linux (by @FlorianDoublet)
+* FEATURE: support HP Comware SMB siwtches (by @sid3windr)
+* FEATURE: remove secret additions (by @rodecker)
+* FEATURE: option to put all groups in single repo (by @ytti)
+* FEATURE: expand path in source: csv: (so that ~/foo/bar works) (by @ytti)
+* BUGFIX: screenos fixes (by @rixxxx)
+* BUGFIX: ironware fixes (by @FlorianDoublet)
+* BUGFIX: powerconnect fixes (by @sid3windr)
+* BUGFIX: don't ask interactive password in new net/ssh (by @ytti)
+
+## 0.5.0
+
+* FEATURE: Mikrotik RouterOS model (by @emjemj)
+* FEATURE: add support for Cisco VSS (by @MrRJ45)
+* BUGFIX: general fixes to powerconnect model (by @MrRJ45)
+* BUGFIX: fix initial commit issues with rugged (by @MrRJ45)
+* BUGFIX: pager error for old dell powerconnect switches (by @emjemj)
+* BUGFIX: logout error for old dell powerconnect switches (by @emjemj)
+
+## 0.4.1
+
+* BUGFIX: handle missing output file (by @brandt)
+* BUGFIX: fix passwordless enable on Arista EOS model (by @brandt)
+
+## 0.4.0
+
+* FEATURE: allow setting IP address in addition to name in source (SQL/CSV)
+* FEATURE: approximate how long it takes to get node from larger view than 1
+* FEATURE: unconditionally start new job if too long has passed since previous start
+* FEATURE: add enable to Arista EOS model
+* FEATURE: add rugged dependency in gemspec
+* FEATURE: log prompt detection failures
+* BUGFIX: xos while using telnet (by @fhibler)
+* BUGFIX: ironware logout on some models (by @fhibler)
+* BUGFIX: allow node to be removed while it is being collected
+* BUGFIX: if model returns non string value, return empty string
+* BUGFIX: better prompt for Arista EOS model (by @rodecker)
+* BUGFIX: improved configuration handling for Arista EOS model (by @rodecker)
+
+## 0.3.0
+
+* FEATURE: *FIXME* bunch of stuff I did for richih, docs needed
+* FEATURE: ComWare model (by erJasp)
+* FEATURE: Add comment support for router.db file
+* FEATURE: Add input debugging and related configuration options
+* BUGFIX: Fix ASA model prompt
+* BUGFIX: Fix Aruba model display
+* BUGFIX: Fix changing output in PowerConnect model
+
+## 0.2.4
+
+* FEATURE: Cisco SMB (Nikola series VxWorks) model by @thetamind
+* FEATURE: Extreme Networks XOS model (access by sjm)
+* FEATURE: Brocade NOS (Network Operating System) (access by sjm)
+* BUGFIX: Match exactly to node[:name] if node[name] is an ip address.
+
+## 0.2.3
+
+* BUGFIX: rescue @ssh.close when far end closes disgracefully (ALU ISAM)
+* BUGFIX: bugfixes to models
+* FEATURE: Alcatel-Lucent ISAM 7302/7330 model added by @jalmargyyk
+* FEATURE: Huawei VRP model added by @jalmargyyk
+* FEATURE: Ubiquiti AirOS added by @willglyn
+* FEATURE: Support 'input' debug in config, ssh/telnet use it to write session log
+
+## 0.2.2
+
+* BUGFIX: mark node as failure if unknown error is raised
+
+## 0.2.1
+
+* BUGFIX: vars variable resolving for main level vars
+
+## 0.2.0
+
+* FEATURE: Force10 model added by @lysiszegerman
+* FEATURE: ScreenOS model added by @lysiszegerman
+* FEATURE: FabricOS model added by @thakala
+* FEATURE: ASA model added by @thakala
+* FEATURE: Vyattamodel added by @thakala
+* BUGFIX: Oxidized::String convenience methods for models fixed
+
+## 0.1.1
+
+* BUGFIX: vars needs to return value of r, not value of evaluation
diff --git a/README.md b/README.md
index d501cb5..f733906 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
 
 [Youtube Video: Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h)
 
-#### Index
+## Index
+
 1. [Supported OS Types](docs/Supported-OS-Types.md)
 2. [Installation](#installation)
     * [Debian](#debian)
@@ -54,9 +55,10 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
     * [Source](docs/Ruby-API.md#source)
     * [Model](docs/Ruby-API.md#model)
 
-# Installation
+## Installation
+
+### Debian
 
-## Debian
 Install all required packages and gems.
 
 ```shell
@@ -65,7 +67,8 @@ gem install oxidized
 gem install oxidized-script oxidized-web # if you don't install oxidized-web, make sure you remove "rest" from your config
 ```
 
-## CentOS, Oracle Linux, Red Hat Linux
+### CentOS, Oracle Linux, Red Hat Linux
+
 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](#installing-ruby-212-using-rvm)), then install Oxidized dependencies
 
 ```shell
@@ -85,7 +88,8 @@ gem install oxidized
 gem install oxidized-script oxidized-web
 ```
 
-## FreeBSD
+### FreeBSD
+
 [Use RVM to install Ruby v2.1.2](#installing-ruby-2.1.2-using-rvm)
 
 Install all required packages and gems.
@@ -96,7 +100,8 @@ gem install oxidized
 gem install oxidized-script oxidized-web
 ```
 
-## Build from Git
+### Build from Git
+
 ```shell
 git clone https://github.com/ytti/oxidized.git
 cd oxidized/
@@ -104,38 +109,40 @@ gem build *.gemspec
 gem install pkg/*.gem
 ```
 
-# Running with Docker
+## Running with Docker
 
 clone git repo:
 
-```
+```shell
 git clone https://github.com/ytti/oxidized
 ```
 
 build container locally:
 
-```
+```shell
 docker build -q -t oxidized/oxidized:latest oxidized/
 ```
 
 create config directory in main system:
 
-```
+```shell
 mkdir /etc/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
 
-```
+```shell
 docker run --rm -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest oxidized
 ```
+
 If the RESTful API and Web Interface are enabled, on the docker host running the container
 edit /etc/oxidized/config and modify 'rest: 127.0.0.1:8888' by 'rest: 0.0.0.0:8888'
 this will bind port 8888 to all interfaces then expose port out. [Issue #445](https://github.com/ytti/oxidized/issues/445)
 
 You can also use docker-compose to launch oxidized container:
-```
+
+```yaml
 # docker-compose.yml
 # docker-compose file example for oxidized that will start along with docker daemon
 oxidized:
@@ -151,13 +158,13 @@ oxidized:
 
 create the `/etc/oxidized/router.db` [See CSV Source for further info](docs/Configuration.md#source-csv)
 
-```
+```shell
 vim /etc/oxidized/router.db
 ```
 
 run container again:
 
-```
+```shell
 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
@@ -169,43 +176,47 @@ Puma 2.13.4 starting...
 
 If you want to have the config automatically reloaded (e.g. when using a http source that changes)
 
-```
+```shell
 docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest
 ```
 
 If you need to use an internal CA (e.g. to connect to an private github instance)
 
-```
+```shell
 docker run -v /etc/oxidized:/root/.config/oxidized -v /path/to/MY-CA.crt:/usr/local/share/ca-certificates/MY-CA.crt -p 8888:8888/tcp -e UPDATE_CA_CERTIFICATES=true -t oxidized/oxidized:latest
 ```
 
-# Installing Ruby 2.1.2 using RVM
+## Installing Ruby 2.1.2 using RVM
 
 Install Ruby 2.1.2 build dependencies
-```
+
+```shell
 yum install curl gcc-c++ patch readline readline-devel zlib zlib-devel
 yum install libyaml-devel libffi-devel openssl-devel make cmake
 yum install bzip2 autoconf automake libtool bison iconv-devel libssh2-devel
 ```
 
 Install RVM
-```
+
+```shell
 curl -L get.rvm.io | bash -s stable
 ```
 
 Setup RVM environment and compile and install Ruby 2.1.2 and set it as default
-```
+
+```shell
 source /etc/profile.d/rvm.sh
 rvm install 2.1.2
 rvm use --default 2.1.2
 ```
 
-# Configuration
+## Configuration
+
 Oxidized configuration is in YAML format. Configuration files are subsequently sourced from `/etc/oxidized/config` then `~/.config/oxidized/config`. The hashes will be merged, this might be useful for storing source information in a system wide file and  user specific configuration in the home directory (to only include a staff specific username and password). Eg. if many users are using `oxs`, see [Oxidized::Script](https://github.com/ytti/oxidized-script).
 
 It is recommended practice to run Oxidized using its own username.  This username can be added using standard command-line tools:
 
-```
+```shell
 useradd oxidized
 ```
 
@@ -215,7 +226,7 @@ To initialize a default configuration in your home directory `~/.config/oxidized
 
 You can set the env variable `OXIDIZED_HOME` to change its home directory.
 
-```
+```shell
 OXIDIZED_HOME=/etc/oxidized
 
 $ tree -L 1 /etc/oxidized
@@ -239,14 +250,15 @@ Possible outputs are either [File](docs/Configuration.md#output-file), [GIT](doc
 Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog`(requires Ruby >= 2.0) is set to `true`.
 
 First create the directory where the CSV `output` is going to store device configs and start Oxidized once.
-```
+
+```shell
 mkdir -p ~/.config/oxidized/configs
 oxidized
 ```
 
 Now tell Oxidized where it finds a list of network devices to backup configuration from. You can either use CSV or SQLite as source. To create a CSV source add the following snippet:
 
-```
+```yaml
 source:
   default: csv
   csv:
@@ -267,9 +279,9 @@ router02.example.com:ios
 
 Run `oxidized` again to take the first backups.
 
-# Extra
+## Extra
 
-## Ubuntu SystemV init setup
+### Ubuntu SystemV init setup
 
 The init script assumes that you have a used named 'oxidized' and that oxidized is in one of the following paths:
 
@@ -284,26 +296,26 @@ The init script assumes that you have a used named 'oxidized' and that oxidized
 1. Copy init script from extra/ folder to /etc/init.d/oxidized
 2. Setup /var/run/
 
-```
+```shell
 mkdir /var/run/oxidized
 chown oxidized:oxidized /var/run/oxidized
 ```
 
 3. Make oxidized start on boot
 
-```
+```shell
 update-rc.d oxidized defaults
 ```
 
-# Help
+## Help
 
 If you need help with Oxidized then we have a few methods you can use to get in touch.
 
-  - [Gitter](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - You can join the Lobby on gitter to chat to other Oxidized users.
-  - [GitHub](https://github.com/ytti/oxidized/) - For help and requests for code changes / updates.
-  - [Forum](https://community.librenms.org/c/help/oxidized) - A user forum run by [LibreNMS](https://github.com/librenms/librenms) where you can ask for help and support.
+* [Gitter](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - You can join the Lobby on gitter to chat to other Oxidized users.
+* [GitHub](https://github.com/ytti/oxidized/) - For help and requests for code changes / updates.
+* [Forum](https://community.librenms.org/c/help/oxidized) - A user forum run by [LibreNMS](https://github.com/librenms/librenms) where you can ask for help and support.
 
-# Help Needed
+## Help Needed
 
 As things stand right now, `oxidized` is maintained by a single person. A great
 many [contributors](https://github.com/ytti/oxidized/graphs/contributors) have
@@ -338,13 +350,12 @@ Brian Anderson (from Rust fame) wrote an [excellent
 post](http://brson.github.io/2017/04/05/minimally-nice-maintainer) on what it
 means to be a maintainer.
 
-# License and Copyright
+## License and Copyright
 
           Copyright
           2013-2015 Saku Ytti <saku@ytti.fi>
           2013-2015 Samer Abdel-Hafez <sam@arahant.net>
 
-
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
diff --git a/TODO.md b/TODO.md
index 337639e..d1af9d0 100644
--- a/TODO.md
+++ b/TODO.md
@@ -1,23 +1,29 @@
-# refactor core
-  * move state from memory to disk, sqlite probably
-  * allows us to retain stats etc over restart
-  * simplifies code
-  * keep only running nodes in memory
-  * negligible I/O cost, as majority is I/O wait getting config
-
-# separate login to owon package
-  * oxidized-script is not only use-case
-  * it would be good to have minimal package used to login to routers
-  * oxidized just one consumer of that functionality
-  * what to do with models, we need model to know how to login. Should models be separated to another package? oxidized-core, oxidized-models and oxidized-login?
-  * how can we allow interactive login in oxidized-login? With functional VTY etc? REPL loop in input/ssh and input/telnet?
-
-# thread number
-  * think about algo
-  * if job ended later than now-iteration have rand(node.size) == 0 to add thread
-  * if now is less than job_ended+iteration same chance to remove thread?
-  * should we try to avoid max threads from being hit? (like maybe non-success thread is pulling average?)
-
-# docs, testing
-  * yard docs
-  * minitest tests
+# To Do
+
+## refactor core
+
+* move state from memory to disk, sqlite probably
+* allows us to retain stats etc over restart
+* simplifies code
+* keep only running nodes in memory
+* negligible I/O cost, as majority is I/O wait getting config
+
+## separate login to own package
+
+* oxidized-script is not only use-case
+* it would be good to have minimal package used to login to routers
+* oxidized just one consumer of that functionality
+* what to do with models, we need model to know how to login. Should models be separated to another package? oxidized-core, oxidized-models and oxidized-login?
+* how can we allow interactive login in oxidized-login? With functional VTY etc? REPL loop in input/ssh and input/telnet?
+
+## thread number
+
+* think about algo
+* if job ended later than now-iteration have rand(node.size) == 0 to add thread
+* if now is less than job_ended+iteration same chance to remove thread?
+* should we try to avoid max threads from being hit? (like maybe non-success thread is pulling average?)
+
+## docs, testing
+
+* yard docs
+* minitest tests
diff --git a/docs/Configuration.md b/docs/Configuration.md
index e2db05e..59e3f6d 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -1,10 +1,12 @@
-## Configuration
-### Debugging
+# Configuration
+
+## Debugging
+
 In case a model plugin doesn't work correctly (ios, procurve, etc.), you can enable live debugging of SSH/Telnet sessions. Just add a `debug` option containing the value true to the `input` section. The log files will be created depending on the parent directory of the logfile option.
 
 The following example will log an active ssh/telnet session `/home/oxidized/.config/oxidized/log/<IP-Adress>-<PROTOCOL>`. The file will be truncated on each consecutive ssh/telnet session, so you need to put a `tailf` or `tail -f` on that file!
 
-```
+```yaml
 log: /home/oxidized/.config/oxidized/log
 
 ...
@@ -16,20 +18,20 @@ input:
     secure: false
 ```
 
-### Privileged mode
+## Privileged mode
 
 To start privileged mode before pulling the configuration, Oxidized needs to send the enable command. You can globally enable this, by adding the following snippet to the global section of the configuration file.
 
-```
+```yaml
 vars:
    enable: S3cre7
 ```
 
-### Removing secrets
+## Removing secrets
 
 To strip out secrets from configurations before storing them, Oxidized needs the the remove_secrets flag. You can globally enable this by adding the following snippet to the global sections of the configuration file.
 
-```
+```yaml
 vars:
   remove_secret: true
 ```
@@ -38,32 +40,33 @@ Device models can contain substitution filters to remove potentially sensitive d
 
 As a partial example from ios.rb:
 
-```
+```yaml
   cmd :secret do |cfg|
     cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
     (...)
     cfg
   end
 ```
+
 The above strips out snmp community strings from your saved configs.
 
 **NOTE:** Removing secrets reduces the usefulness as a full configuration backup, but it may make sharing configs easier.
 
-### Disabling SSH exec channels
+## Disabling SSH exec channels
 
 Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices.  This feature can be turned off by setting the `ssh_no_exec`
 variable.
 
-```
+```yaml
 vars:
   ssh_no_exec: true
 ```
 
-### SSH Proxy Command
+## SSH Proxy Command
 
 Oxidized can `ssh` through a proxy as well. To do so we just need to set `ssh_proxy` variable.
 
-```
+```yaml
 ...
 map:
   name: 0
@@ -74,20 +77,21 @@ vars_map:
 ...
 ```
 
-### FTP Passive Mode
+## FTP Passive Mode
 
 Oxidized uses ftp passive mode by default. Some devices require passive mode to be disabled. To do so, we can set `input.ftp.passive` to false
-```
+
+```yaml
 input:
   ftp:
     passive: false
 ```
 
-### Advanced Configuration
+## Advanced Configuration
 
 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.
 
-```
+```yaml
 ---
 username: oxidized
 password: S3cr3tx
@@ -130,14 +134,13 @@ source:
 model_map:
   cisco: ios
   juniper: junos
-
 ```
 
-### Advanced Group Configuration
+## Advanced Group Configuration
 
 For group specific credentials
 
-```
+```yaml
 groups:
   mikrotik:
     username: admin
@@ -146,16 +149,19 @@ groups:
     username: ubnt
     password: ubnt
 ```
+
 and add group mapping
-```
+
+```yaml
 map:
   model: 0
   name: 1
   group: 2
 ```
+
 For model specific credentials
 
-```
+```yaml
 models:
   junos:
     username: admin
@@ -170,26 +176,26 @@ models:
     password: password
 ```
 
-### RESTful API and Web Interface
+## RESTful API and Web Interface
 
 The RESTful API and Web Interface is enabled by configuring the `rest:` parameter in the config file.  This parameter can optionally contain a relative URI.
 
-```
+```yaml
 # Listen on http://127.0.0.1:8888/
 rest: 127.0.0.1:8888
 ```
 
-```
+```yaml
 # Listen on http://10.0.0.1:8000/oxidized/
 rest: 10.0.0.1:8000/oxidized
 ```
 
-### Triggered backups
+## Triggered backups
 
 A node can be moved to head-of-queue via the REST API `GET/POST /node/next/[NODE]`.
 
 In the default configuration this node will be processed when the next job worker becomes available, it could take some time if existing backups are in progress. To execute moved jobs immediately a new job can be added:
 
-```
+```yaml
 next_adds_job: true
 ```
diff --git a/docs/Hooks.md b/docs/Hooks.md
index fab4025..d52ee08 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -1,25 +1,30 @@
 # Hooks
+
 You can define arbitrary number of hooks that subscribe different events. The hook system is modular and different kind of hook types can be enabled.
 
 ## Configuration
+
 Following configuration keys need to be defined for all hooks:
 
-  * `events`: which events to subscribe. Needs to be an array. See below for the list of available events.
-  * `type`: what hook class to use. See below for the list of available hook types.
+* `events`: which events to subscribe. Needs to be an array. See below for the list of available events.
+* `type`: what hook class to use. See below for the list of available hook types.
 
 ### Events
-  * `node_success`: triggered when configuration is succesfully pulled from a node and right before storing the configuration.
-  * `node_fail`: triggered after `retries` amount of failed node pulls.
-  * `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
-  * `nodes_done`: triggered after finished fetching all nodes.
+
+* `node_success`: triggered when configuration is succesfully pulled from a node and right before storing the configuration.
+* `node_fail`: triggered after `retries` amount of failed node pulls.
+* `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
+* `nodes_done`: triggered after finished fetching all nodes.
 
 ## Hook type: exec
+
 The `exec` hook type allows users to run an arbitrary shell command or a binary when triggered.
 
 The command is executed on a separate child process either in synchronous or asynchronous fashion. Non-zero exit values cause errors to be logged. STDOUT and STDERR are currently not collected.
 
 Command is executed with the following environment:
-```
+
+```text
 OX_EVENT
 OX_NODE_NAME
 OX_NODE_IP
@@ -35,13 +40,13 @@ OX_REPO_NAME
 
 Exec hook recognizes following configuration keys:
 
-  * `timeout`: hard timeout for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: 60
-  * `async`: influences whether main thread will wait for the command execution. Set this true for long running commands so node pull is not blocked. Default: false
-  * `cmd`: command to run.
+* `timeout`: hard timeout for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: 60
+* `async`: influences whether main thread will wait for the command execution. Set this true for long running commands so node pull is not blocked. Default: false
+* `cmd`: command to run.
 
+## exec hook configuration example
 
-## Hook configuration example
-```
+```yaml
 hooks:
   name_for_example_hook1:
     type: exec
@@ -55,21 +60,21 @@ hooks:
     timeout: 120
 ```
 
-### githubrepo
+### Hook type: githubrepo
 
 This hook configures the repository `remote` and _push_ the code when the specified event is triggerd. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.
 
 `githubrepo` hook recognizes following configuration keys:
 
-  * `remote_repo`: the remote repository to be pushed to.
-  * `username`: username for repository auth.
-  * `password`: password for repository auth.
-  * `publickey`: publickey for repository auth.
-  * `privatekey`: privatekey for repository auth.
+* `remote_repo`: the remote repository to be pushed to.
+* `username`: username for repository auth.
+* `password`: password for repository auth.
+* `publickey`: publickey for repository auth.
+* `privatekey`: privatekey for repository auth.
 
 When using groups repositories, each group must have its own `remote` in the `remote_repo` config.
 
-``` yaml
+```yaml
 hooks:
   push_to_remote:
     remote_repo:
@@ -78,10 +83,9 @@ hooks:
       firewalls: git@git.intranet:oxidized/firewalls.git
 ```
 
+## githubrepo hook configuration example
 
-## Hook configuration example
-
-``` yaml
+```yaml
 hooks:
   push_to_remote:
     type: githubrepo
@@ -97,14 +101,14 @@ The `awssns` hook publishes messages to AWS SNS topics. This allows you to notif
 
 Fields sent in the message:
 
-  * `event`: Event type (e.g. `node_success`)
-  * `group`: Group name
-  * `model`: Model name (e.g. `eos`)
-  * `node`: Device hostname
+* `event`: Event type (e.g. `node_success`)
+* `group`: Group name
+* `model`: Model name (e.g. `eos`)
+* `node`: Device hostname
 
-Configuration example:
+## awssns hook configuration example
 
-``` yaml
+```yaml
 hooks:
   hook_script:
     type: awssns
@@ -115,8 +119,8 @@ hooks:
 
 AWS SNS hook requires the following configuration keys:
 
-  * `region`: AWS Region name
-  * `topic_arn`: ASN Topic reference
+* `region`: AWS Region name
+* `topic_arn`: ASN Topic reference
 
 Your AWS credentials should be stored in `~/.aws/credentials`.
 
@@ -126,13 +130,13 @@ The `slackdiff` hook posts colorized config diffs to a [Slack](http://www.slack.
 
 You will need to manually install the `slack-api` gem on your system:
 
-```
+```shell
 gem install slack-api
 ```
 
-Configuration example:
+## slackdiff hook configuration example
 
-``` yaml
+```yaml
 hooks:
   slack:
     type: slackdiff
@@ -143,7 +147,7 @@ hooks:
 
 Optionally you can disable snippets and post a formatted message, for instance linking to a commit in a git repo. Named parameters `%{node}`, `%{group}`, `%{model}` and `%{commitref}` are available.
 
-``` yaml
+```yaml
 hooks:
   slack:
     type: slackdiff
@@ -162,13 +166,13 @@ The `xmppdiff` hook posts config diffs to a [XMPP](https://en.wikipedia.org/wiki
 
 You will need to manually install the `xmpp4r` gem on your system:
 
-```
+```shell
 gem install xmpp4r
 ```
 
-Configuration example:
+## xmppdiff hook configuration example
 
-``` yaml
+```yaml
 hooks:
   xmpp:
     type: xmppdiff
diff --git a/docs/Model-Notes/AireOS.md b/docs/Model-Notes/AireOS.md
index 0da9b57..9962f31 100644
--- a/docs/Model-Notes/AireOS.md
+++ b/docs/Model-Notes/AireOS.md
@@ -1,12 +1,12 @@
-Cisco WLC Configuration 
-========================
+Cisco WLC Configuration
+=======================
 
 Create a user with read-write privilege :
 
-```
+```text
 mgmtuser add oxidized **** read-write
 ```
 
-Oxidized needs read-write privilege in order to execute 'config paging disable'. 
+Oxidized needs read-write privilege in order to execute 'config paging disable'.
 
 Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/ArbOS.md b/docs/Model-Notes/ArbOS.md
index 0f5b628..f68467f 100644
--- a/docs/Model-Notes/ArbOS.md
+++ b/docs/Model-Notes/ArbOS.md
@@ -3,7 +3,7 @@ Arbor Networks ArbOS notes
 
 If you are running ArbOS version 7 or lower then you may need to update the model to remove `exec true`:
 
-```
+```ruby
   cfg :ssh do
     pre_logout 'exit'
   end
diff --git a/docs/Model-Notes/Comware.md b/docs/Model-Notes/Comware.md
index 31eb002..0da019a 100644
--- a/docs/Model-Notes/Comware.md
+++ b/docs/Model-Notes/Comware.md
@@ -1,10 +1,12 @@
 Comware Configuration
 =====================
 
-If you find 3Com comware devices aren't being backed up this may be due to prompt detection not matching 
-because a previous login message is disabled after the first prompt. You can disable this on the devices 
-themselves by running this command:
+If you find 3Com comware devices aren't being backed up this may be due to prompt detection not matching because a previous login message is disabled after the first prompt.
 
-`info-center source default channel 1 log state off debug state off`
+You can disable this on the devices themselves by running this command:
+
+```text
+info-center source default channel 1 log state off debug state off
+```
 
 [Reference](https://github.com/ytti/oxidized/issues/1171)
diff --git a/docs/Model-Notes/JunOS.md b/docs/Model-Notes/JunOS.md
index ed8dbca..8093df0 100644
--- a/docs/Model-Notes/JunOS.md
+++ b/docs/Model-Notes/JunOS.md
@@ -1,9 +1,9 @@
 JunOS Configuration
-========================
+===================
 
 Create login class cfg-view
 
-```
+```text
 set system login class cfg-view permissions view-configuration
 set system login class cfg-view allow-commands "(show)|(set cli screen-length)|(set cli screen-width)"
 set system login class cfg-view deny-commands "(clear)|(file)|(file show)|(help)|(load)|(monitor)|(op)|(request)|(save)|(set)|(start)|(test)"
@@ -12,7 +12,7 @@ set system login class cfg-view deny-configuration all
 
 Create a user with cfg-view class
 
-```
+```text
 set system login user oxidized class cfg-view
 set system login user oxidized authentication plain-text-password "verysecret"
 ```
@@ -25,14 +25,10 @@ The commands Oxidized executes are:
 4. show version
 5. show chassis hardware
 6. show system license
-7. show system license keys
-ex22|ex33|ex4|ex8|qfx only
-8. show virtual-chassis
-MX960 only
+7. show system license keys (ex22|ex33|ex4|ex8|qfx only)
+8. show virtual-chassis (MX960 only)
 9. show chassis fabric reachability
 
-
 Oxidized can now retrieve your configuration!
 
-
 Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index 9d7db32..8dcabd3 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -1,21 +1,17 @@
-
-
 Model Notes
-========================
-
+===========
 
 This directory contains implemention notes and caveats to assist you in your oxidized deployment.
 
 Use the table below for more information on the Vendor/Model caveats.
 
-
 Vendor          | Model           |Updated
 ----------------|-----------------|----------------
 3COM|[Comware](Comware.md)|15 Feb 2018
+AireOS|[AireOS](AireOS.md)|29 Nov 2017
 Arbor Networks|[ArbOS](ArbOS.md)|27 Feb 2018
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
 Xyzel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
 
-
 If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
diff --git a/docs/Model-Notes/VRP-Huawei.md b/docs/Model-Notes/VRP-Huawei.md
index d03c752..e68a959 100644
--- a/docs/Model-Notes/VRP-Huawei.md
+++ b/docs/Model-Notes/VRP-Huawei.md
@@ -3,7 +3,7 @@ Huawei VRP Configuration
 
 Create a user with no privileges
 
-```
+```text
     <HUAWEI> system-view
     [~HUAWEI] aaa
     [~HUAWEI-aaa] local-user oxidized password irreversible-cipher verysecret
@@ -21,7 +21,7 @@ The commands Oxidized executes are:
 
 Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the priviledge-level for commands 1 and 4:
 
-```
+```text
     <HUAWEI> system-view
     [~HUAWEI] command-privilege level 1 view global display current-configuration all
     [*HUAWEI] command-privilege level 1 view shell screen-length
@@ -30,5 +30,4 @@ Command 2 and 3 can be executed without issues, but 1 and 4 are only available f
 
 Oxidized can now retrieve your configuration!
 
-
 Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/XGS4600-Zyxel.md b/docs/Model-Notes/XGS4600-Zyxel.md
index 0ff2e7d..17cb2b5 100644
--- a/docs/Model-Notes/XGS4600-Zyxel.md
+++ b/docs/Model-Notes/XGS4600-Zyxel.md
@@ -1,18 +1,20 @@
 ZynOS Configuration
-========================
+===================
 
 ## FTP
+
 FTP access is only possible as admin, other users can login but cannot pull the files.
 For the XGS4600 series the config file is _config_ and not _config-0_
 
-The following line in _oxidized/lib/oxidized/model/zynos.rb_ with need changing
-```
-  cmd 'config-0'
+The following line in _oxidized/lib/oxidized/model/zynos.rb_ will need changing
 
+```text
+  cmd 'config-0'
 ```
 
 The inclusion of an extra ftp option is also require. Within _input_ add the following
-```
+
+```yaml
 input:
   ftp:
     passive: false
@@ -20,5 +22,4 @@ input:
 
 Oxidized can now retrieve your configuration!
 
-
 Back to [Model-Notes](README.md)
diff --git a/docs/Outputs.md b/docs/Outputs.md
index e3bd42d..92c672c 100644
--- a/docs/Outputs.md
+++ b/docs/Outputs.md
@@ -1,23 +1,22 @@
+# Outputs
 
-## Output
-
-### Output: File
+## Output: File
 
 Parent directory needs to be created manually, one file per device, with most recent running config.
 
-```
+```yaml
 output:
   file:
     directory: /var/lib/oxidized/configs
 ```
 
-### Output: Git
+## Output: Git
 
 This uses the rugged/libgit2 interface. So you should remember that normal Git hooks will not be executed.
 
 For a single repositories for all devices:
 
-``` yaml
+```yaml
 output:
   default: git
   git:
@@ -28,7 +27,7 @@ output:
 
 And for groups repositories:
 
-``` yaml
+```yaml
 output:
   default: git
   git:
@@ -40,14 +39,14 @@ output:
 Oxidized will create a repository for each group in the same directory as the `default.git`. For
 example:
 
-``` csv
+```csv
 host1:ios:first
 host2:nxos:second
 ```
 
 This will generate the following repositories:
 
-``` bash
+```bash
 $ ls /var/lib/oxidized/git-repos
 
 default.git first.git second.git
@@ -55,7 +54,7 @@ default.git first.git second.git
 
 If you would like to use groups and a single repository, you can force this with the `single_repo` config.
 
-``` yaml
+```yaml
 output:
   default: git
   git:
@@ -64,15 +63,14 @@ output:
 
 ```
 
-### Output: Git-Crypt
+## Output: Git-Crypt
 
 This uses the gem git and system git-crypt interfaces. Have a look at [GIT-Crypt](https://www.agwa.name/projects/git-crypt/) documentation to know how to install it.
 Additionally to user and email informations, you have to provide the users ID that can be a key ID, a full fingerprint, an email address, or anything else that uniquely identifies a public key to GPG (see "HOW TO SPECIFY A USER ID" in the gpg man page).
 
-
 For a single repositories for all devices:
 
-``` yaml
+```yaml
 output:
   default: gitcrypt
   gitcrypt:
@@ -86,7 +84,7 @@ output:
 
 And for groups repositories:
 
-``` yaml
+```yaml
 output:
   default: gitcrypt
   gitcrypt:
@@ -101,14 +99,14 @@ output:
 Oxidized will create a repository for each group in the same directory as the `default`. For
 example:
 
-``` csv
+```csv
 host1:ios:first
 host2:nxos:second
 ```
 
 This will generate the following repositories:
 
-``` bash
+```bash
 $ ls /var/lib/oxidized/git-repos
 
 default.git first.git second.git
@@ -116,7 +114,7 @@ default.git first.git second.git
 
 If you would like to use groups and a single repository, you can force this with the `single_repo` config.
 
-``` yaml
+```yaml
 output:
   default: gitcrypt
   gitcrypt:
@@ -130,11 +128,11 @@ output:
 
 Please note that user list is only updated once at creation.
 
-### Output: Http
+## Output: Http
 
 POST a config to the specified URL
 
-```
+```yaml
 output:
   default: http
   http:
@@ -143,13 +141,13 @@ output:
     url: "http://192.168.162.50:8080/db/coll"
 ```
 
-### Output types
+## 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` (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
 
-```
+```text
 -  cmd 'show version' do |cfg|
 -    comment cfg.lines.first
 +  cmd 'show version' do |state|
@@ -183,7 +181,7 @@ For example, let's say you want to split out `show version` and `show inventory`
 
 which will result in the following layout
 
-```
+```text
 diff/$FQDN--show_running_config
 nodiff/$FQDN--show_version
 nodiff/$FQDN--show_inventory
diff --git a/docs/Ruby-API.md b/docs/Ruby-API.md
index 2dbc10e..8621870 100644
--- a/docs/Ruby-API.md
+++ b/docs/Ruby-API.md
@@ -3,33 +3,39 @@
 The following objects exist in Oxidized.
 
 ## Input
- * gets config from nodes
- * must implement 'connect', 'get', 'cmd'
- * 'ssh', 'telnet, ftp, and tftp' implemented
+
+* gets config from nodes
+* must implement 'connect', 'get', 'cmd'
+* 'ssh', 'telnet, ftp, and tftp' implemented
 
 ## Output
- * stores config
- * must implement 'store' (may implement 'fetch')
- * 'git' and 'file' (store as flat ascii) implemented
+
+* stores config
+* must implement 'store' (may implement 'fetch')
+* 'git' and 'file' (store as flat ascii) implemented
 
 ## Source
- * gets list of nodes to poll
- * must implement 'load'
- * source can have 'name', 'model', 'group', 'username', 'password', 'input', 'output', 'prompt'
-   * name - name of the devices
-   * model - model to use ios/junos/xyz, model is loaded dynamically when needed (Also default in config file)
-   * input - method to acquire config, loaded dynamically as needed (Also default in config file)
-   * output - method to store config, loaded dynamically as needed (Also default in config file)
-   * prompt - prompt used for node (Also default in config file, can be specified in model too)
- * 'sql', 'csv' and 'http' (supports any format with single entry per line, like router.db)
+
+* gets list of nodes to poll
+* must implement 'load'
+* source can have 'name', 'model', 'group', 'username', 'password', 'input', 'output', 'prompt'
+  * name - name of the devices
+  * model - model to use ios/junos/xyz, model is loaded dynamically when needed (Also default in config file)
+  * input - method to acquire config, loaded dynamically as needed (Also default in config file)
+  * output - method to store config, loaded dynamically as needed (Also default in config file)
+  * prompt - prompt used for node (Also default in config file, can be specified in model too)
+* 'sql', 'csv' and 'http' (supports any format with single entry per line, like router.db)
 
 ## Model
+
 ### At the top level
+
 A model may use several methods at the top level in the class. `cfg` is
 executed in input/output/source context. `cmd` is executed within an instance
 of the model.
 
 #### `cfg`
+
 `cfg` may be called with a list of methods (`:ssh`, `:telnet`) and a block with
 zero parameters.  Calling `cfg` registers the given access methods and calling
 it at least once is required for a model to work.
@@ -38,6 +44,7 @@ The block may contain commands to change some behaviour for the given methods
 (e.g. calling `post_login` to disable the pager).
 
 #### `cmd`
+
 Is used to specify commands that should be executed on a model in order to
 gather its configuration. It can be called with:
 
@@ -69,18 +76,21 @@ Execution order is `:all`, `:secret`, and lastly the command specific block, if
 given.
 
 #### `comment`
+
 Called with a single string containing the string to prepend for comments in
 emitted configuration for this model.
 
 If not specified the default of `'# '` will be used (note the trailing space).
 
 #### `prompt`
+
 Is called with a regular expression that is used to detect when command output
 ends after a command has been executed.
 
 If not specified, a default of `/^([\w.@-]+[#>]\s?)$/` is used.
 
 #### `expect`
+
 Called with a regular expression and a block. The block takes two parameters:
 the regular expression, and the data containing the match.
 
@@ -90,26 +100,32 @@ The passed data is replaced by the return value of the block.
 it's further processed.
 
 ### At the second level
+
 The following methods are available:
 
 #### `comment`
+
 Used inside `cmd` invocations. Comments out every line in the passed string and
 returns the result.
 
 #### `password`
+
 Used inside `cfg` invocations to specify the regular expression used to detect
 the password prompt. If not specified, the default of `/^Password/` is used.
 
 #### `post_login`
+
 Used inside `cfg` invocations to specify commands to run once Oxidized has
 logged in to the switch. Takes one argument that is either a block (taking zero
 parameters) or a string containing a command to execute.
 
 #### `pre_logout`
+
 Used to specify commands to run before Oxidized closes the connection to the
 switch. Takes one argument that is either a block (taking zero parameters) or a
 string containing a command to execute.
 
 #### `send`
+
 Usually used inside `expect` or blocks passed to `post_login`/`pre_logout`.
 Takes a single parameter: a string to be sent to the switch.
diff --git a/docs/Sources.md b/docs/Sources.md
index 7029b72..5599409 100644
--- a/docs/Sources.md
+++ b/docs/Sources.md
@@ -1,10 +1,10 @@
-## Source
+# Sources
 
-### Source: CSV
+## Source: CSV
 
 One line per device, colon seperated. If `ip` isn't present, a DNS lookup will be done against `name`.  For large installations, setting `ip` will dramatically reduce startup time.
 
-```
+```yaml
 source:
   default: csv
   csv:
@@ -22,7 +22,7 @@ source:
 
 Example csv `/var/lib/oxidized/router.db`:
 
-```
+```text
 rtr01.local:192.168.1.1:ios:oxidized:5uP3R53cR3T:T0p53cR3t
 ```
 
@@ -41,25 +41,31 @@ source:
       model: 1
 ```
 
-> Please note, if you are running GPG v2 then you will be prompted for your gpg password on start up, if you use GPG >= 2.1 then you can add the following config to stop that behaviour:
+Please note, if you are running GPG v2 then you will be prompted for your gpg password on start up, if you use GPG >= 2.1 then you can add the following config to stop that behaviour:
 
-> Within `~/.gnupg/gpg-agent.conf`
+Within `~/.gnupg/gpg-agent.conf`
+
+```text
+allow-loopback-pinentry
+```
 
-> `allow-loopback-pinentry`
+and within: `~/.gnupg/gpg.conf`
 
-> and within: `~/.gnupg/gpg.conf`
+```text
+pinentry-mode loopback
+```
 
-> `pinentry-mode loopback`
+## Source: SQL
 
-### 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
+
+## 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
 
-```
+```yaml
 source:
   default: sql
   sql:
@@ -77,11 +83,11 @@ source:
       enable: enable
 ```
 
-### Source: SQLite
+## Source: SQLite
 
 One row per device, filtered by hostname.
 
-```
+```yaml
 source:
   default: sql
   sql:
@@ -97,12 +103,11 @@ source:
       enable: enable
 ```
 
-### Custom SQL Query Support
+## Custom SQL Query Support
 
 You may also implement a custom SQL query to retreive the nodelist using  SQL syntax with the `query:` configuration parameter under the `sql:` stanza.
 
-
-#### Custom SQL Query Examples
+### Custom SQL Query Examples
 
 You may have a table named `nodes` which contains a boolean to indicate if the nodes should be enabled (fetched via oxidized). This can be used in the custom SQL query to avoid fetching from known impacted nodes.
 
@@ -119,21 +124,20 @@ In this example we limit the nodes to two "POPs" of `mypop1` and `mypop2`. We al
 ```sql
 query: "SELECT * FROM nodes WHERE pop IN ('mypop1','mypop2') AND enabled = True"
 ```
+
 The order of the nodes returned will influence the order that nodes are fetched by oxidized. You can use standard SQL `ORDER BY` clauses to influence the node order.
 
 You should always test your SQL query before using it in the oxidized configuration as there is no syntax or error checking performed before sending it to the database engine.
 
 Consult your database documentation for more information on query language and table optimization.
 
-
-
-### Source: HTTP
+## Source: HTTP
 
 One object per device.
 
 HTTP Supports basic auth, configure the user and pass you want to use under the http: section.
 
-```
+```yaml
 source:
   default: http
   http:
@@ -155,7 +159,7 @@ source:
 
 You can also pass `secure: false` if you want to disable ssl certificate verification:
 
-```
+```yaml
 source:
   default: http
   http:
diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index d6d718f..a0ca66b 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -1,159 +1,160 @@
 # Supported OS types
- * Vendor
-   * OS model
- * A10 Networks
-   * [ACOS](/lib/oxidized/model/acos.rb)
- * Accedian Performance Elements (NIDs)
-   * [AEN](/lib/oxidized/model/aen.rb)
- * Alcatel-Lucent
-   * [AOS](/lib/oxidized/model/aos.rb)
-   * [AOS7](/lib/oxidized/model/aos7.rb)
-   * [ISAM](/lib/oxidized/model/isam.rb)
-   * [SR OS (Formerly TiMOS)](/lib/oxidized/model/timos.rb)
-   * Wireless
- * Allied Telesis
-   * [Alliedware Plus](/lib/oxidized/model/awplus.rb)
- * Alvarion
-   * [BreezeACCESS](/lib/oxidized/model/alvarion.rb)
- * APC
-   * [AOS](/lib/oxidized/model/apc_aos.rb)
- * Arbor Networks
-   * [ArbOS](/lib/oxidized/model/arbos.rb)
- * Arista
-   * [EOS](/lib/oxidized/model/eos.rb)
- * Arris
-   * [C4CMTS](/lib/oxidized/model/c4cmts.rb)
- * Aruba
-   * [AOSW](/lib/oxidized/model/aosw.rb)
- * AudioCodes
-   * [AudioCodes](/lib/oxdized/model/audiocodes.rb)
- * Avaya
-   * [VOSS (VSP Operating System Software)](/lib/oxidized/model/voss.rb)
-   * [BOSS (Baystack Operating System Software)](/lib/oxidized/model/boss.rb)
- * Brocade
-   * [FabricOS](lib/oxidized/model/fabricos.rb)
-   * [Ironware](lib/oxidized/model/ironware.rb)
-   * [NOS (Network Operating System)](lib/oxidized/model/nos.rb)
-   * [Vyatta](lib/oxidized/model/vyatta.rb)
-   * [6910](lib/oxidized/model/br6910.rb)
-   * [SLX-OS](lib/oxidized/model/slxos.rb)
- * Casa
-   * [Casa](/lib/oxidized/model/casa.rb)
- * Check Point
-   * [GaiaOS](/lib/oxidized/model/gaiaos.rb)
- * Ciena
-   * [SAOS](/lib/oxidized/model/saos.rb)
- * Cisco
-   * [ACSW](/lib/oxidized/model/acsw.rb)
-   * [AireOS](/lib/oxidized/model/aireos.rb)
-   * [ASA](/lib/oxidized/model/asa.rb)
-   * [AsyncOS](/lib/oxidized/model/asyncos.rb)
-   * [CatOS](/lib/oxidized/model/catos.rb)
-   * [IOS](/lib/oxidized/model/ios.rb)
-   * [IOSXR](/lib/oxidized/model/iosxr.rb)
-   * [NGA](/lib/oxidized/model/cisconga.rb)
-   * [NXOS](/lib/oxidized/model/nxos.rb)
-   * [SMA](/lib/oxidized/model/ciscosma.rb)
-   * [SMB (Nikola series)](/lib/oxidized/model/ciscosmb.rb)
-   * [UCS](/lib/oxidized/model/ucs.rb)
- * Citrix
-   * [NetScaler (Virtual Applicance)](/lib/oxidized/model/netscaler.rb)
- * Coriant (former Tellabs)
-   * [TMOS (8800)](/lib/oxidized/model/corianttmos.rb)
-   * [8600](/lib/oxidized/model/coriant8600.rb)
-   * [Groove](/lib/oxidized/model/coriantgroove.rb)
- * Cumulus
-   * [Linux](/lib/oxidized/model/cumulus.rb)
- * DataCom
-   * [DmSwitch 3000](/lib/oxidized/model/datacom.rb)
- * DCN
-   * [DCN](/lib/oxidized/model/ios.rb) - Map this to ios.
- * DELL
-   * [PowerConnect](/lib/oxidized/model/powerconnect.rb)
-   * [AOSW](/lib/oxidized/model/aosw.rb)
- * D-Link
-   * [D-Link](/lib/oxidized/model/dlink.rb)
- * Ericsson/Redback
-   * [IPOS (former SEOS)](/lib/oxidized/model/ipos.rb)
- * Extreme Networks
-   * [Enterasys](/lib/oxidized/model/enterasys.rb)
-   * [WM](/lib/oxidized/model/mtrlrfs.rb)
-   * [XOS](/lib/oxidized/model/xos.rb)
- * F5
-   * [TMOS](/lib/oxidized/model/tmos.rb)
- * Fiberstore
-   * [S3800](/lib/oxidized/model/gcombnps.rb)
- * Force10
-   * [DNOS](/lib/oxidized/model/dnos.rb)
-   * [FTOS](/lib/oxidized/model/ftos.rb)
- * FortiGate
-   * [FortiOS](/lib/oxidized/model/fortios.rb)
- * Fujitsu
-   * [PRIMERGY Blade switch 1/10Gbe](/lib/oxidized/model/fujitsupy.rb)
- * GCOM Technologies
-   * [Broadband Network Platform Software](/lib/oxidized/model/gcombnps.rb)
- * Hatteras
-   * [Hatteras](/lib/oxidized/model/hatteras.rb)
- * Hirschmann
-   * [HiOS](/lib/oxidized/model/hirschmann.rb)
- * HP
-   * [Comware (HP A-series, H3C, 3Com)](/lib/oxidized/model/comware.rb)
-   * [Procurve](/lib/oxidized/model/procurve.rb)
-   * [BladeSystem (Onboard Administrator)](/lib/oxidized/model/hpebladesystem.rb)
-   * [MSA](/lib/oxidized/model/hpemsa.rb)
- * Huawei
-   * [VRP](/lib/oxidized/model/vrp.rb)
- * Juniper
-   * [JunOS](/lib/oxidized/model/junos.rb)
-   * [ScreenOS (Netscreen)](/lib/oxidized/model/screenos.rb)
- * Mellanox
-   * [MLNX-OS](/lib/oxidized/model/mlnxos.rb)
-   * [Voltaire](/lib/oxidized/model/voltaire.rb)
- * Mikrotik
-   * [RouterOS](/lib/oxidized/model/routeros.rb)
- * Motorola
-   * [RFS](/lib/oxidized/model/mtrlrfs.rb)
- * MRV
-   * [MasterOS](/lib/oxidized/model/masteros.rb)
-   * [FiberDriver](/lib/oxidized/model/fiberdriver.rb)
- * Netgear
-   * [Netgear](/lib/oxidized/model/netgear.rb)
- * Netonix
-   * [WISP Switch (As Netonix)](/lib/oxidized/model/netonix.rb)
- * Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
-   * [SR OS (TiMOS)](/lib/oxidized/model/timos.rb)
- * OneAccess
-   * [OneOS](/lib/oxidized/model/oneos.rb)
- * Opengear
-   * [Opengear](/lib/oxidized/model/opengear.rb)
- * [OPNsense](/lib/oxidized/model/opnsense.rb)
- * Palo Alto
-   * [PANOS](/lib/oxidized/model/panos.rb)
- * [PLANET SG/SGS Switches](/lib/oxidized/model/planet.rb)
- * [pfSense](/lib/oxidized/model/pfsense.rb)
- * Radware
-   * [AlteonOS](/lib/oxidized/model/alteonos.rb)
- * Quanta
-   * [Quanta / VxWorks 6.6 (1.1.0.8)](/lib/oxidized/model/quantaos.rb)
- * Siklu
-   * [EtherHaul](/lib/oxidized/model/siklu.rb)
- * Supermicro
-   * [Supermicro](/lib/oxidized/model/supermicro.rb)
- * Symantec
-   * [Blue Coat ProxySG / Security Gateway OS (SGOS)](/lib/oxidized/model/sgos.rb)
- * Trango Systems
-   * [Trango](/lib/oxidized/model/trango.rb)
- * TPLink
-   * [TPLink](/lib/oxidized/model/tplink.rb)
- * Ubiquiti
-   * [AirOS](/lib/oxidized/model/airos.rb)
-   * [Edgeos](/lib/oxidized/model/edgeos.rb)
-   * [EdgeSwitch](/lib/oxidized/model/edgeswitch.rb)
- * Watchguard
-   * [Fireware OS](/lib/oxidized/model/firewareos.rb)
- * Westell
-   * [Westell 8178G, Westell 8266G](/lib/oxidized/model/weos.rb)
- * Zhone
-   * [Zhone (OLT and MX)](/lib/oxidized/model/zhoneolt.rb)
- * Zyxel
-   * [ZyNOS](/lib/oxidized/model/zynos.rb)
+
+* Vendor
+  * OS model
+* A10 Networks
+  * [ACOS](/lib/oxidized/model/acos.rb)
+* Accedian Performance Elements (NIDs)
+  * [AEN](/lib/oxidized/model/aen.rb)
+* Alcatel-Lucent
+  * [AOS](/lib/oxidized/model/aos.rb)
+  * [AOS7](/lib/oxidized/model/aos7.rb)
+  * [ISAM](/lib/oxidized/model/isam.rb)
+  * [SR OS (Formerly TiMOS)](/lib/oxidized/model/timos.rb)
+  * Wireless
+* Allied Telesis
+  * [Alliedware Plus](/lib/oxidized/model/awplus.rb)
+* Alvarion
+  * [BreezeACCESS](/lib/oxidized/model/alvarion.rb)
+* APC
+  * [AOS](/lib/oxidized/model/apc_aos.rb)
+* Arbor Networks
+  * [ArbOS](/lib/oxidized/model/arbos.rb)
+* Arista
+  * [EOS](/lib/oxidized/model/eos.rb)
+* Arris
+  * [C4CMTS](/lib/oxidized/model/c4cmts.rb)
+* Aruba
+  * [AOSW](/lib/oxidized/model/aosw.rb)
+* AudioCodes
+  * [AudioCodes](/lib/oxdized/model/audiocodes.rb)
+* Avaya
+  * [VOSS (VSP Operating System Software)](/lib/oxidized/model/voss.rb)
+  * [BOSS (Baystack Operating System Software)](/lib/oxidized/model/boss.rb)
+* Brocade
+  * [FabricOS](lib/oxidized/model/fabricos.rb)
+  * [Ironware](lib/oxidized/model/ironware.rb)
+  * [NOS (Network Operating System)](lib/oxidized/model/nos.rb)
+  * [Vyatta](lib/oxidized/model/vyatta.rb)
+  * [6910](lib/oxidized/model/br6910.rb)
+  * [SLX-OS](lib/oxidized/model/slxos.rb)
+* Casa
+  * [Casa](/lib/oxidized/model/casa.rb)
+* Check Point
+  * [GaiaOS](/lib/oxidized/model/gaiaos.rb)
+* Ciena
+  * [SAOS](/lib/oxidized/model/saos.rb)
+* Cisco
+  * [ACSW](/lib/oxidized/model/acsw.rb)
+  * [AireOS](/lib/oxidized/model/aireos.rb)
+  * [ASA](/lib/oxidized/model/asa.rb)
+  * [AsyncOS](/lib/oxidized/model/asyncos.rb)
+  * [CatOS](/lib/oxidized/model/catos.rb)
+  * [IOS](/lib/oxidized/model/ios.rb)
+  * [IOSXR](/lib/oxidized/model/iosxr.rb)
+  * [NGA](/lib/oxidized/model/cisconga.rb)
+  * [NXOS](/lib/oxidized/model/nxos.rb)
+  * [SMA](/lib/oxidized/model/ciscosma.rb)
+  * [SMB (Nikola series)](/lib/oxidized/model/ciscosmb.rb)
+  * [UCS](/lib/oxidized/model/ucs.rb)
+* Citrix
+  * [NetScaler (Virtual Applicance)](/lib/oxidized/model/netscaler.rb)
+* Coriant (former Tellabs)
+  * [TMOS (8800)](/lib/oxidized/model/corianttmos.rb)
+  * [8600](/lib/oxidized/model/coriant8600.rb)
+  * [Groove](/lib/oxidized/model/coriantgroove.rb)
+* Cumulus
+  * [Linux](/lib/oxidized/model/cumulus.rb)
+* DataCom
+  * [DmSwitch 3000](/lib/oxidized/model/datacom.rb)
+* DCN
+  * [DCN](/lib/oxidized/model/ios.rb) - Map this to ios.
+* DELL
+  * [PowerConnect](/lib/oxidized/model/powerconnect.rb)
+  * [AOSW](/lib/oxidized/model/aosw.rb)
+* D-Link
+  * [D-Link](/lib/oxidized/model/dlink.rb)
+* Ericsson/Redback
+  * [IPOS (former SEOS)](/lib/oxidized/model/ipos.rb)
+* Extreme Networks
+  * [Enterasys](/lib/oxidized/model/enterasys.rb)
+  * [WM](/lib/oxidized/model/mtrlrfs.rb)
+  * [XOS](/lib/oxidized/model/xos.rb)
+* F5
+  * [TMOS](/lib/oxidized/model/tmos.rb)
+* Fiberstore
+  * [S3800](/lib/oxidized/model/gcombnps.rb)
+* Force10
+  * [DNOS](/lib/oxidized/model/dnos.rb)
+  * [FTOS](/lib/oxidized/model/ftos.rb)
+* FortiGate
+  * [FortiOS](/lib/oxidized/model/fortios.rb)
+* Fujitsu
+  * [PRIMERGY Blade switch 1/10Gbe](/lib/oxidized/model/fujitsupy.rb)
+* GCOM Technologies
+  * [Broadband Network Platform Software](/lib/oxidized/model/gcombnps.rb)
+* Hatteras
+  * [Hatteras](/lib/oxidized/model/hatteras.rb)
+* Hirschmann
+  * [HiOS](/lib/oxidized/model/hirschmann.rb)
+* HP
+  * [Comware (HP A-series, H3C, 3Com)](/lib/oxidized/model/comware.rb)
+  * [Procurve](/lib/oxidized/model/procurve.rb)
+  * [BladeSystem (Onboard Administrator)](/lib/oxidized/model/hpebladesystem.rb)
+  * [MSA](/lib/oxidized/model/hpemsa.rb)
+* Huawei
+  * [VRP](/lib/oxidized/model/vrp.rb)
+* Juniper
+  * [JunOS](/lib/oxidized/model/junos.rb)
+  * [ScreenOS (Netscreen)](/lib/oxidized/model/screenos.rb)
+* Mellanox
+  * [MLNX-OS](/lib/oxidized/model/mlnxos.rb)
+  * [Voltaire](/lib/oxidized/model/voltaire.rb)
+* Mikrotik
+  * [RouterOS](/lib/oxidized/model/routeros.rb)
+* Motorola
+  * [RFS](/lib/oxidized/model/mtrlrfs.rb)
+* MRV
+  * [MasterOS](/lib/oxidized/model/masteros.rb)
+  * [FiberDriver](/lib/oxidized/model/fiberdriver.rb)
+* Netgear
+  * [Netgear](/lib/oxidized/model/netgear.rb)
+* Netonix
+  * [WISP Switch (As Netonix)](/lib/oxidized/model/netonix.rb)
+* Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
+  * [SR OS (TiMOS)](/lib/oxidized/model/timos.rb)
+* OneAccess
+  * [OneOS](/lib/oxidized/model/oneos.rb)
+* Opengear
+  * [Opengear](/lib/oxidized/model/opengear.rb)
+* [OPNsense](/lib/oxidized/model/opnsense.rb)
+* Palo Alto
+  * [PANOS](/lib/oxidized/model/panos.rb)
+* [PLANET SG/SGS Switches](/lib/oxidized/model/planet.rb)
+* [pfSense](/lib/oxidized/model/pfsense.rb)
+* Radware
+  * [AlteonOS](/lib/oxidized/model/alteonos.rb)
+* Quanta
+  * [Quanta / VxWorks 6.6 (1.1.0.8)](/lib/oxidized/model/quantaos.rb)
+* Siklu
+  * [EtherHaul](/lib/oxidized/model/siklu.rb)
+* Supermicro
+  * [Supermicro](/lib/oxidized/model/supermicro.rb)
+* Symantec
+  * [Blue Coat ProxySG / Security Gateway OS (SGOS)](/lib/oxidized/model/sgos.rb)
+* Trango Systems
+  * [Trango](/lib/oxidized/model/trango.rb)
+* TPLink
+  * [TPLink](/lib/oxidized/model/tplink.rb)
+* Ubiquiti
+  * [AirOS](/lib/oxidized/model/airos.rb)
+  * [Edgeos](/lib/oxidized/model/edgeos.rb)
+  * [EdgeSwitch](/lib/oxidized/model/edgeswitch.rb)
+* Watchguard
+  * [Fireware OS](/lib/oxidized/model/firewareos.rb)
+* Westell
+  * [Westell 8178G, Westell 8266G](/lib/oxidized/model/weos.rb)
+* Zhone
+  * [Zhone (OLT and MX)](/lib/oxidized/model/zhoneolt.rb)
+* Zyxel
+  * [ZyNOS](/lib/oxidized/model/zynos.rb)
-- 
cgit v1.2.3


From 1d4e44f28fab2567f3f2692b281c4163c0e9f6ba Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Wed, 14 Mar 2018 22:00:25 +0100
Subject: Document the process of extending models

---
 README.md                |  5 ++--
 docs/Extending-Models.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+), 2 deletions(-)
 create mode 100644 docs/Extending-Models.md

(limited to 'docs')

diff --git a/README.md b/README.md
index 1d75611..b3c1912 100644
--- a/README.md
+++ b/README.md
@@ -48,8 +48,9 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
     * [Advanced Configuration](docs/Configuration.md#advanced-configuration)
     * [Advanced Group Configuration](docs/Configuration.md#advanced-group-configuration)
     * [Hooks](docs/Hooks.md)
-5. [Help](#help)
-6. [Ruby API](docs/Ruby-API.md#ruby-api)
+5. [Extending Models](docs/Extending-Models.md)
+6. [Help](#help)
+7. [Ruby API](docs/Ruby-API.md#ruby-api)
     * [Input](docs/Ruby-API.md#input)
     * [Output](docs/Ruby-API.md#output)
     * [Source](docs/Ruby-API.md#source)
diff --git a/docs/Extending-Models.md b/docs/Extending-Models.md
new file mode 100644
index 0000000..4f59f69
--- /dev/null
+++ b/docs/Extending-Models.md
@@ -0,0 +1,73 @@
+# Extending and Customizing Oxidized Models
+
+Oxidized supports a growing list of [operating system types](Supported-Os-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.
+
+A user may wish to extend an existing model to collect the output of additional commands. Oxidized offers smart loading of models in order to facilitate this with ease, without the need to introduce changes to the upstream source code.
+
+## Extending an existing model with a new command
+
+The example below can be used to extend the `JunOS` model to collect the output of `show interfaces diagnostics optics` and append the output to the configuration file as a comment. This command retrieves DOM information on pluggable optics present in a `JunOS`-powered chassis.
+
+Create the file `~/.config/oxidized/model/junos.rb` with the following contents:
+
+```ruby
+require 'oxidized/mode/junos.rb'
+
+
+class JunOS
+
+
+    cmd 'show interfaces diagnostics optics' do |cfg|
+        comment cfg
+    end
+
+
+end
+```
+
+Due to smart loading, the user-supplied `~/.config/oxidized/model/junos.rb` file will take precedence over the model with the same name included in Oxidized. The code then uses `require` to load the included model, and extends the class defined therein with an additional command.
+
+Intuitively, it is also possible to:
+
+* Completely re-define an existing model by creating a file in `~/.config/oxidized/model/` with the same name as an existing model, but not `require`-ing the upstream model file.
+* Create a named variation of an existing model, by creating a file with a new name (such as `~/.config/oxidized/model/junos-extra.rb`), Then `require` the original model and extend its base class as in the above example. The named variation can then be specified as an OS type for some devices but not others when defining sources.
+* Create a completely new model, with a new name, for a new operating system type.
+
+## Advanced features
+
+The loosely-coupled architecture of Oxidized allows for easy extensibility in more advanced use cases as well. 
+
+The example below extends the functionality of the `JunOS` model further to collect `display set` formatted configuration from the device, and utilizes the multi-output functionality of the `git` output to place the returned configuration in a separate file within a git repository.
+
+It is possible to configure the `git` output to create new subdirectories under an existing repository instead of creating new repositories for each new defined output type (the default) by including the following configuration in the `~/.config/oxidized/config` file:
+
+```yaml
+output:
+    git:
+        type_as_directory: true
+```
+
+Then, `~/.config/oxidized/model/junos.rb` is adapted as following:
+
+```ruby
+require 'oxidized/mode/junos.rb'
+
+
+class JunOS
+
+
+    cmd 'show interface diagnostic optics' do |cfg|
+        comment cfg
+    end
+
+    cmd 'show configuration | display set' do |cfg|
+        cfg.type = "junos-set"
+        cfg.name = "set"
+        cfg
+    end
+
+
+end
+```
+
+The output of the `show configuration | display set` command is marked with a new arbitrary alternative output type, `junos-set`.  The `git` output will use the output type to create a new subdirectory by the same name. In this subdirectory, the `git` output will create files with the name `<devicename>--set` that will contain the output of this command for each device.
\ No newline at end of file
-- 
cgit v1.2.3


From 94b6638542d98169f9502089f153c0b5e63b3b5f Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Wed, 14 Mar 2018 22:05:07 +0100
Subject: fix a typo that broke a link within new documentation

---
 docs/Extending-Models.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/Extending-Models.md b/docs/Extending-Models.md
index 4f59f69..0707157 100644
--- a/docs/Extending-Models.md
+++ b/docs/Extending-Models.md
@@ -1,6 +1,6 @@
 # Extending and Customizing Oxidized Models
 
-Oxidized supports a growing list of [operating system types](Supported-Os-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.
+Oxidized supports a growing list of [operating system types](Supported-OS-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.
 
 A user may wish to extend an existing model to collect the output of additional commands. Oxidized offers smart loading of models in order to facilitate this with ease, without the need to introduce changes to the upstream source code.
 
-- 
cgit v1.2.3


From f1048f9b9616a2307d0de6c53847d52a16458bb8 Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Wed, 14 Mar 2018 22:14:38 +0100
Subject: rename extending to creating models and correct typos

---
 README.md                |  2 +-
 docs/Creating-Models.md  | 73 ++++++++++++++++++++++++++++++++++++++++++++++++
 docs/Extending-Models.md | 73 ------------------------------------------------
 3 files changed, 74 insertions(+), 74 deletions(-)
 create mode 100644 docs/Creating-Models.md
 delete mode 100644 docs/Extending-Models.md

(limited to 'docs')

diff --git a/README.md b/README.md
index b3c1912..336c05a 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
     * [Advanced Configuration](docs/Configuration.md#advanced-configuration)
     * [Advanced Group Configuration](docs/Configuration.md#advanced-group-configuration)
     * [Hooks](docs/Hooks.md)
-5. [Extending Models](docs/Extending-Models.md)
+5. [Creating and Extending Models](docs/Creating-Models.md)
 6. [Help](#help)
 7. [Ruby API](docs/Ruby-API.md#ruby-api)
     * [Input](docs/Ruby-API.md#input)
diff --git a/docs/Creating-Models.md b/docs/Creating-Models.md
new file mode 100644
index 0000000..3c343e6
--- /dev/null
+++ b/docs/Creating-Models.md
@@ -0,0 +1,73 @@
+# Creating and Extending Oxidized Models
+
+Oxidized supports a growing list of [operating system types](Supported-OS-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.
+
+A user may wish to extend an existing model to collect the output of additional commands. Oxidized offers smart loading of models in order to facilitate this with ease, without the need to introduce changes to the upstream source code.
+
+## Extending an existing model with a new command
+
+The example below can be used to extend the `JunOS` model to collect the output of `show interfaces diagnostics optics` and append the output to the configuration file as a comment. This command retrieves DOM information on pluggable optics present in a `JunOS`-powered chassis.
+
+Create the file `~/.config/oxidized/model/junos.rb` with the following contents:
+
+```ruby
+require 'oxidized/model/junos.rb'
+
+
+class JunOS
+
+
+    cmd 'show interfaces diagnostics optics' do |cfg|
+        comment cfg
+    end
+
+
+end
+```
+
+Due to smart loading, the user-supplied `~/.config/oxidized/model/junos.rb` file will take precedence over the model with the same name included in Oxidized. The code then uses `require` to load the included model, and extends the class defined therein with an additional command.
+
+Intuitively, it is also possible to:
+
+* Completely re-define an existing model by creating a file in `~/.config/oxidized/model/` with the same name as an existing model, but not `require`-ing the upstream model file.
+* Create a named variation of an existing model, by creating a file with a new name (such as `~/.config/oxidized/model/junos-extra.rb`), Then `require` the original model and extend its base class as in the above example. The named variation can then be specified as an OS type for some devices but not others when defining sources.
+* Create a completely new model, with a new name, for a new operating system type.
+
+## Advanced features
+
+The loosely-coupled architecture of Oxidized allows for easy extensibility in more advanced use cases as well.
+
+The example below extends the functionality of the `JunOS` model further to collect `display set` formatted configuration from the device, and utilizes the multi-output functionality of the `git` output to place the returned configuration in a separate file within a git repository.
+
+It is possible to configure the `git` output to create new subdirectories under an existing repository instead of creating new repositories for each new defined output type (the default) by including the following configuration in the `~/.config/oxidized/config` file:
+
+```yaml
+output:
+    git:
+        type_as_directory: true
+```
+
+Then, `~/.config/oxidized/model/junos.rb` is adapted as following:
+
+```ruby
+require 'oxidized/model/junos.rb'
+
+
+class JunOS
+
+
+    cmd 'show interface diagnostic optics' do |cfg|
+        comment cfg
+    end
+
+    cmd 'show configuration | display set' do |cfg|
+        cfg.type = "junos-set"
+        cfg.name = "set"
+        cfg
+    end
+
+
+end
+```
+
+The output of the `show configuration | display set` command is marked with a new arbitrary alternative output type, `junos-set`.  The `git` output will use the output type to create a new subdirectory by the same name. In this subdirectory, the `git` output will create files with the name `<devicename>--set` that will contain the output of this command for each device.
\ No newline at end of file
diff --git a/docs/Extending-Models.md b/docs/Extending-Models.md
deleted file mode 100644
index 0707157..0000000
--- a/docs/Extending-Models.md
+++ /dev/null
@@ -1,73 +0,0 @@
-# Extending and Customizing Oxidized Models
-
-Oxidized supports a growing list of [operating system types](Supported-OS-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.
-
-A user may wish to extend an existing model to collect the output of additional commands. Oxidized offers smart loading of models in order to facilitate this with ease, without the need to introduce changes to the upstream source code.
-
-## Extending an existing model with a new command
-
-The example below can be used to extend the `JunOS` model to collect the output of `show interfaces diagnostics optics` and append the output to the configuration file as a comment. This command retrieves DOM information on pluggable optics present in a `JunOS`-powered chassis.
-
-Create the file `~/.config/oxidized/model/junos.rb` with the following contents:
-
-```ruby
-require 'oxidized/mode/junos.rb'
-
-
-class JunOS
-
-
-    cmd 'show interfaces diagnostics optics' do |cfg|
-        comment cfg
-    end
-
-
-end
-```
-
-Due to smart loading, the user-supplied `~/.config/oxidized/model/junos.rb` file will take precedence over the model with the same name included in Oxidized. The code then uses `require` to load the included model, and extends the class defined therein with an additional command.
-
-Intuitively, it is also possible to:
-
-* Completely re-define an existing model by creating a file in `~/.config/oxidized/model/` with the same name as an existing model, but not `require`-ing the upstream model file.
-* Create a named variation of an existing model, by creating a file with a new name (such as `~/.config/oxidized/model/junos-extra.rb`), Then `require` the original model and extend its base class as in the above example. The named variation can then be specified as an OS type for some devices but not others when defining sources.
-* Create a completely new model, with a new name, for a new operating system type.
-
-## Advanced features
-
-The loosely-coupled architecture of Oxidized allows for easy extensibility in more advanced use cases as well. 
-
-The example below extends the functionality of the `JunOS` model further to collect `display set` formatted configuration from the device, and utilizes the multi-output functionality of the `git` output to place the returned configuration in a separate file within a git repository.
-
-It is possible to configure the `git` output to create new subdirectories under an existing repository instead of creating new repositories for each new defined output type (the default) by including the following configuration in the `~/.config/oxidized/config` file:
-
-```yaml
-output:
-    git:
-        type_as_directory: true
-```
-
-Then, `~/.config/oxidized/model/junos.rb` is adapted as following:
-
-```ruby
-require 'oxidized/mode/junos.rb'
-
-
-class JunOS
-
-
-    cmd 'show interface diagnostic optics' do |cfg|
-        comment cfg
-    end
-
-    cmd 'show configuration | display set' do |cfg|
-        cfg.type = "junos-set"
-        cfg.name = "set"
-        cfg
-    end
-
-
-end
-```
-
-The output of the `show configuration | display set` command is marked with a new arbitrary alternative output type, `junos-set`.  The `git` output will use the output type to create a new subdirectory by the same name. In this subdirectory, the `git` output will create files with the name `<devicename>--set` that will contain the output of this command for each device.
\ No newline at end of file
-- 
cgit v1.2.3


From ce0216fde8cdf562be4cc9d39aba2cf003d3c7f6 Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Fri, 16 Mar 2018 16:19:21 +0100
Subject: documentation touch-ups and issue #1218

---
 README.md                      | 20 ++++++++++++--------
 docs/Creating-Models.md        |  2 +-
 docs/Model-Notes/VRP-Huawei.md |  2 ++
 3 files changed, 15 insertions(+), 9 deletions(-)

(limited to 'docs')

diff --git a/README.md b/README.md
index 336c05a..09929af 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,26 @@
 # 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)
 
-> Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!
+Oxidized is a network device configuration backup tool. It's a RANCID replacement!
 
-[WANTED: MAINTAINER](#help-needed)
+Light and extensible, Oxidized supports over 90 operating system types.
 
-Oxidized is a network device configuration backup tool. It's a RANCID replacement!
+Feature highlights:
 
 * Automatically adds/removes threads to meet configured retrieval interval
-* Restful API to move node immediately to head-of-queue (GET/POST /node/next/[NODE])
-* Syslog udp+file example to catch config change event (ios/junos) and trigger config fetch
-  * Will signal ios/junos user who made change, which output modules can use (via POST)
-  * The git output module uses this info - 'git blame' will for each line show who made the change and when
+* Restful API to a move node immediately to head-of-queue (GET/POST /node/next/[NODE])
+* Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
+  * Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
+  * The `git` output module uses this info - 'git blame' will show who changed each line, and when
 * Restful API to reload list of nodes (GET /reload)
 * Restful API to fetch configurations (/node/fetch/[NODE] or /node/fetch/group/[NODE])
 * Restful API to show list of nodes (GET /nodes)
 * Restful API to show list of version for a node (/node/version[NODE]) and diffs
 
-[Youtube Video: Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h)
+Check out the [Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h) video on YouTube!
+
+> :warning: [Maintainer Wanted!](#help-needed) :warning:
+>
+> Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!
 
 ## Index
 
diff --git a/docs/Creating-Models.md b/docs/Creating-Models.md
index 3c343e6..d7a8155 100644
--- a/docs/Creating-Models.md
+++ b/docs/Creating-Models.md
@@ -1,4 +1,4 @@
-# Creating and Extending Oxidized Models
+# Creating and Extending Models
 
 Oxidized supports a growing list of [operating system types](Supported-OS-Types.md). Out of the box, most model implementations collect configuration data. Some implementations also include a conservative set of additional commands that collect basic device information (device make and model, software version, licensing information, ...) which are appended to the configuration as comments.
 
diff --git a/docs/Model-Notes/VRP-Huawei.md b/docs/Model-Notes/VRP-Huawei.md
index e68a959..a5c0c99 100644
--- a/docs/Model-Notes/VRP-Huawei.md
+++ b/docs/Model-Notes/VRP-Huawei.md
@@ -30,4 +30,6 @@ Command 2 and 3 can be executed without issues, but 1 and 4 are only available f
 
 Oxidized can now retrieve your configuration!
 
+Caveat: Some versions of VRP default to appending a timestamp prior to the output of each `display` command, which will lead to superfluous updates. The configuration statement `timestamp disable` can be used to disable this functionality. (Issue #1218)
+
 Back to [Model-Notes](README.md)
-- 
cgit v1.2.3


From 720facc6f80d2b977d73b944c81c63b6d95e768b Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Fri, 16 Mar 2018 20:31:09 +0100
Subject: improve spelling in docs

---
 README.md                      | 4 ++--
 docs/Configuration.md          | 2 +-
 docs/Hooks.md                  | 4 ++--
 docs/Model-Notes/AireOS.md     | 2 +-
 docs/Model-Notes/Comware.md    | 2 +-
 docs/Model-Notes/README.md     | 4 ++--
 docs/Model-Notes/VRP-Huawei.md | 2 +-
 docs/Sources.md                | 4 ++--
 8 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'docs')

diff --git a/README.md b/README.md
index 09929af..076c4d5 100644
--- a/README.md
+++ b/README.md
@@ -116,7 +116,7 @@ gem install pkg/*.gem
 
 ### Running with Docker
 
-Currently, Docker Hub automatcally builds the master branch as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.
+Currently, Docker Hub automatically builds the master branch as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.
 
 To build your own, clone git repo:
 
@@ -165,7 +165,7 @@ oxidized:
     - /etc/oxidized:/root/.config/oxidized
 ```
 
-Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for futher info):
+Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for further info):
 
 ```shell
 vim /etc/oxidized/router.db
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 59e3f6d..6bbbb61 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -54,7 +54,7 @@ The above strips out snmp community strings from your saved configs.
 
 ## Disabling SSH exec channels
 
-Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices.  This feature can be turned off by setting the `ssh_no_exec`
+Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices. This feature can be turned off by setting the `ssh_no_exec`
 variable.
 
 ```yaml
diff --git a/docs/Hooks.md b/docs/Hooks.md
index 1d263fb..8a0a8b9 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -11,7 +11,7 @@ Following configuration keys need to be defined for all hooks:
 
 ### Events
 
-* `node_success`: triggered when configuration is succesfully pulled from a node and right before storing the configuration.
+* `node_success`: triggered when configuration is successfully pulled from a node and right before storing the configuration.
 * `node_fail`: triggered after `retries` amount of failed node pulls.
 * `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
 * `nodes_done`: triggered after finished fetching all nodes.
@@ -62,7 +62,7 @@ hooks:
 
 ### Hook type: githubrepo
 
-This hook configures the repository `remote` and _push_ the code when the specified event is triggerd. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.
+This hook configures the repository `remote` and _push_ the code when the specified event is triggered. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.
 
 `githubrepo` hook recognizes following configuration keys:
 
diff --git a/docs/Model-Notes/AireOS.md b/docs/Model-Notes/AireOS.md
index 9962f31..5674ae2 100644
--- a/docs/Model-Notes/AireOS.md
+++ b/docs/Model-Notes/AireOS.md
@@ -1,7 +1,7 @@
 Cisco WLC Configuration
 =======================
 
-Create a user with read-write privilege :
+Create a user with read-write privilege:
 
 ```text
 mgmtuser add oxidized **** read-write
diff --git a/docs/Model-Notes/Comware.md b/docs/Model-Notes/Comware.md
index 0da019a..e7a2198 100644
--- a/docs/Model-Notes/Comware.md
+++ b/docs/Model-Notes/Comware.md
@@ -1,7 +1,7 @@
 Comware Configuration
 =====================
 
-If you find 3Com comware devices aren't being backed up this may be due to prompt detection not matching because a previous login message is disabled after the first prompt.
+If you find 3Com Comware devices aren't being backed up this may be due to prompt detection not matching because a previous login message is disabled after the first prompt.
 
 You can disable this on the devices themselves by running this command:
 
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index 8dcabd3..c4b0ed1 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -1,7 +1,7 @@
 Model Notes
 ===========
 
-This directory contains implemention notes and caveats to assist you in your oxidized deployment.
+This directory contains implementation notes and caveats to assist you in your oxidized deployment.
 
 Use the table below for more information on the Vendor/Model caveats.
 
@@ -12,6 +12,6 @@ AireOS|[AireOS](AireOS.md)|29 Nov 2017
 Arbor Networks|[ArbOS](ArbOS.md)|27 Feb 2018
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
-Xyzel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
+Zyxel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
 
 If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
diff --git a/docs/Model-Notes/VRP-Huawei.md b/docs/Model-Notes/VRP-Huawei.md
index a5c0c99..ff5426e 100644
--- a/docs/Model-Notes/VRP-Huawei.md
+++ b/docs/Model-Notes/VRP-Huawei.md
@@ -19,7 +19,7 @@ The commands Oxidized executes are:
 3. display device
 4. display current-configuration all
 
-Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the priviledge-level for commands 1 and 4:
+Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the privilege-level for commands 1 and 4:
 
 ```text
     <HUAWEI> system-view
diff --git a/docs/Sources.md b/docs/Sources.md
index 5599409..6d8e19e 100644
--- a/docs/Sources.md
+++ b/docs/Sources.md
@@ -2,7 +2,7 @@
 
 ## Source: CSV
 
-One line per device, colon seperated. If `ip` isn't present, a DNS lookup will be done against `name`.  For large installations, setting `ip` will dramatically reduce startup time.
+One line per device, colon separated. If `ip` isn't present, a DNS lookup will be done against `name`.  For large installations, setting `ip` will dramatically reduce startup time.
 
 ```yaml
 source:
@@ -105,7 +105,7 @@ source:
 
 ## Custom SQL Query Support
 
-You may also implement a custom SQL query to retreive the nodelist using  SQL syntax with the `query:` configuration parameter under the `sql:` stanza.
+You may also implement a custom SQL query to retrieve the nodelist using  SQL syntax with the `query:` configuration parameter under the `sql:` stanza.
 
 ### Custom SQL Query Examples
 
-- 
cgit v1.2.3


From 9862cff359d6abc7bdc260600acd293d2d85dd2b Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Sat, 17 Mar 2018 13:04:20 +0100
Subject: restore dev comment of @tobbez to aricentiss model

---
 docs/Supported-OS-Types.md       | 3 +--
 lib/oxidized/model/aricentiss.rb | 5 +++++
 2 files changed, 6 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 2e1de7c..1717284 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -141,8 +141,7 @@
 * Supermicro
   * [SSE-G2252, G2252P](/lib/oxidized/model/edgecos.rb)
   * [SSE-G48-TG4, G24-TG4](/lib/oxidized/model/aricentiss.rb)
-  * [SSE-X24S, X24SR, X3348S, X3348SR, X3348T,
-  * X3348TR](/lib/oxidized/model/aricentiss.rb)
+  * [SSE-X24S, X24SR, X3348S, X3348SR, X3348T, X3348TR](/lib/oxidized/model/aricentiss.rb)
   * [SBM-GEM-X2C, GEM-X2C+, GEM-X3S+, XEM-X10SM](/lib/oxidized/model/aricentiss.rb)
 * Symantec
   * [Blue Coat ProxySG / Security Gateway OS (SGOS)](/lib/oxidized/model/sgos.rb)
diff --git a/lib/oxidized/model/aricentiss.rb b/lib/oxidized/model/aricentiss.rb
index 8675263..60c2f48 100644
--- a/lib/oxidized/model/aricentiss.rb
+++ b/lib/oxidized/model/aricentiss.rb
@@ -1,3 +1,8 @@
+# Developed against:
+# #show version
+# Switch ID       Hardware Version                Firmware Version
+# 0               SSE-G48-TG4   (P2-01)           1.0.16-9
+
 class AricentISS < Oxidized::Model
 
   prompt (/^(\e\[27m)?[ \r]*\w+# ?$/)
-- 
cgit v1.2.3


From d3c96a04c15ff0c6cae00d0721a6f5216357207f Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Sat, 17 Mar 2018 17:49:18 +0100
Subject: transition timos to sros

---
 docs/Supported-OS-Types.md       |   4 +-
 lib/oxidized/model/sros.rb       | 118 ++++++++++++++++++++++++++++++++++++++
 lib/oxidized/model/supermicro.rb |   1 +
 lib/oxidized/model/timos.rb      | 120 ++-------------------------------------
 4 files changed, 127 insertions(+), 116 deletions(-)
 create mode 100644 lib/oxidized/model/sros.rb

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 1717284..493918d 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -10,7 +10,7 @@
   * [AOS](/lib/oxidized/model/aos.rb)
   * [AOS7](/lib/oxidized/model/aos7.rb)
   * [ISAM](/lib/oxidized/model/isam.rb)
-  * [SR OS (Formerly TiMOS)](/lib/oxidized/model/timos.rb)
+  * [SR OS (Formerly TiMOS)](/lib/oxidized/model/sros.rb)
   * Wireless
 * Allied Telesis
   * [Alliedware Plus](/lib/oxidized/model/awplus.rb)
@@ -122,7 +122,7 @@
 * Netonix
   * [WISP Switch (As Netonix)](/lib/oxidized/model/netonix.rb)
 * Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
-  * [SR OS (TiMOS)](/lib/oxidized/model/timos.rb)
+  * [SR OS (TiMOS)](/lib/oxidized/model/sros.rb)
 * OneAccess
   * [OneOS](/lib/oxidized/model/oneos.rb)
 * Opengear
diff --git a/lib/oxidized/model/sros.rb b/lib/oxidized/model/sros.rb
new file mode 100644
index 0000000..289bed3
--- /dev/null
+++ b/lib/oxidized/model/sros.rb
@@ -0,0 +1,118 @@
+class SROS < Oxidized::Model
+
+  #
+  # 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?)$/
+
+  cmd :all do |cfg, cmdstring|
+    new_cfg = comment "COMMAND: #{cmdstring}\n"
+    new_cfg << cfg.each_line.to_a[1..-2].join
+  end
+
+  #
+  # Show the boot options file.
+  #
+  cmd 'show bof' do |cfg|
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # Show the system information.
+  #
+  cmd 'show system information' do |cfg|
+    #
+    # Strip uptime.
+    #
+    cfg.sub! /^System Up Time.*\n/, ''
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # Show the card state.
+  #
+  cmd 'show card state' do |cfg|
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # 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"
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # Show the running debug configuration.
+  #
+  cmd 'show debug' do |cfg|
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # Show the saved debug configuration (admin debug-save).
+  #
+  cmd 'file type config.dbg' do |cfg|
+    #
+    # Strip carriage returns.
+    #
+    cfg.gsub! /\r/, ''
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # Show the running persistent indices.
+  #
+  cmd 'admin display-config index' do |cfg|
+    #
+    # Strip carriage returns.
+    #
+    cfg.gsub! /\r/, ''
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+    comment cfg
+  end
+
+  #
+  # Show the running configuration.
+  #
+  cmd 'admin display-config' do |cfg|
+    #
+    # Strip carriage returns.
+    #
+    cfg.gsub! /\r/, ''
+    cfg.gsub! /# Finished .*/, ''
+    cfg.gsub! /# Generated .*/, ''
+  end
+
+  cfg :telnet do
+    username /^Login: /
+    password /^Password: /
+  end
+
+  cfg :telnet, :ssh do
+    post_login 'environment no more'
+    pre_logout 'logout'
+  end
+end
diff --git a/lib/oxidized/model/supermicro.rb b/lib/oxidized/model/supermicro.rb
index 518ae41..56d5ef6 100644
--- a/lib/oxidized/model/supermicro.rb
+++ b/lib/oxidized/model/supermicro.rb
@@ -7,3 +7,4 @@ Supermicro = EdgeCOS
 
 Oxidized.logger.warn "Using deprecated model supermicro, use edgecos instead."
 
+# Deprecated
diff --git a/lib/oxidized/model/timos.rb b/lib/oxidized/model/timos.rb
index c230a8f..e454630 100644
--- a/lib/oxidized/model/timos.rb
+++ b/lib/oxidized/model/timos.rb
@@ -1,118 +1,10 @@
-class TiMOS < Oxidized::Model
+# Backward compatibility shim for deprecated model `timos`.
+# Migrate your source from `timos` to `sros`.
 
-  #
-  # Nokia SR OS (TiMOS) (formerly TiMetra, Alcatel, Alcatel-Lucent).
-  # Used in 7705 SAR, 7210 SAS, 7450 ESS, 7750 SR, 7950 XRS, and NSP.
-  #
+require_relative 'sros.rb'
 
-  comment  '# '
+TiMOS = SROS
 
-  prompt /^([-\w\.:>\*]+\s?[#>]\s?)$/
+Oxidized.logger.warn "Using deprecated model timos, use sros instead."
 
-  cmd :all do |cfg, cmdstring|
-    new_cfg = comment "COMMAND: #{cmdstring}\n"
-    new_cfg << cfg.each_line.to_a[1..-2].join
-  end
-
-  #
-  # Show the boot options file.
-  #
-  cmd 'show bof' do |cfg|
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # Show the system information.
-  #
-  cmd 'show system information' do |cfg|
-    #
-    # Strip uptime.
-    #
-    cfg.sub! /^System Up Time.*\n/, ''
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # Show the card state.
-  #
-  cmd 'show card state' do |cfg|
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # 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"
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # Show the running debug configuration.
-  #
-  cmd 'show debug' do |cfg|
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # Show the saved debug configuration (admin debug-save).
-  #
-  cmd 'file type config.dbg' do |cfg|
-    #
-    # Strip carriage returns.
-    #
-    cfg.gsub! /\r/, ''
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # Show the running persistent indices.
-  #
-  cmd 'admin display-config index' do |cfg|
-    #
-    # Strip carriage returns.
-    #
-    cfg.gsub! /\r/, ''
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-    comment cfg
-  end
-
-  #
-  # Show the running configuration.
-  #
-  cmd 'admin display-config' do |cfg|
-    #
-    # Strip carriage returns.
-    #
-    cfg.gsub! /\r/, ''
-    cfg.gsub! /# Finished .*/, ''
-    cfg.gsub! /# Generated .*/, ''
-  end
-
-  cfg :telnet do
-    username /^Login: /
-    password /^Password: /
-  end
-
-  cfg :telnet, :ssh do
-    post_login 'environment no more'
-    pre_logout 'logout'
-  end
-end
+# Deprecated
-- 
cgit v1.2.3


From 3f8bd19e144d026d0d14ed0f26a6c7c2339bd17a Mon Sep 17 00:00:00 2001
From: Ilya Demyanov <turbidit@gmail.com>
Date: Thu, 5 Apr 2018 19:06:23 +0300
Subject: docs: Fixed the link to SNR model

---
 docs/Supported-OS-Types.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 5240297..7a765f8 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -139,7 +139,7 @@
 * Siklu
   * [EtherHaul](/lib/oxidized/model/siklu.rb)
 * SNR
-  * [SNR-S300G, S2xxx, S3xxx, S4xxx](/lib/oxidized/dcnos.rb)
+  * [SNR-S300G, S2xxx, S3xxx, S4xxx](/lib/oxidized/model/dcnos.rb)
 * Supermicro
   * [SSE-G2252, G2252P](/lib/oxidized/model/edgecos.rb)
   * [SSE-G48-TG4, G24-TG4](/lib/oxidized/model/aricentiss.rb)
-- 
cgit v1.2.3


From 30894a5015e6ce780096bd965493913133197c14 Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Sat, 7 Apr 2018 01:49:05 +0200
Subject: extend githubrepo documentation

---
 docs/Hooks.md | 51 ++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 36 insertions(+), 15 deletions(-)

(limited to 'docs')

diff --git a/docs/Hooks.md b/docs/Hooks.md
index 8a0a8b9..b582a2f 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -9,7 +9,7 @@ Following configuration keys need to be defined for all hooks:
 * `events`: which events to subscribe. Needs to be an array. See below for the list of available events.
 * `type`: what hook class to use. See below for the list of available hook types.
 
-### Events
+## Events
 
 * `node_success`: triggered when configuration is successfully pulled from a node and right before storing the configuration.
 * `node_fail`: triggered after `retries` amount of failed node pulls.
@@ -44,7 +44,7 @@ Exec hook recognizes following configuration keys:
 * `async`: influences whether main thread will wait for the command execution. Set this true for long running commands so node pull is not blocked. Default: false
 * `cmd`: command to run.
 
-## exec hook configuration example
+### exec hook configuration example
 
 ```yaml
 hooks:
@@ -60,21 +60,29 @@ hooks:
     timeout: 120
 ```
 
-### Hook type: githubrepo
+## Hook type: githubrepo
 
-This hook configures the repository `remote` and _push_ the code when the specified event is triggered. If the `username` and `password` are not provided, the `Rugged::Credentials::SshKeyFromAgent` will be used.
+The `githubrepo` hook executes a `git push` to a configured `remote_repo` when the specified event is triggered.
 
-`githubrepo` hook recognizes following configuration keys:
+Several authentication methods are supported:
+
+* Provide a `password` for username + password authentication
+* Provide both a `publickey` and a `privatekey` for ssh key-based authentication
+* Don't provide any credentials for ssh-agent authentication
+
+The username will be set to the relevant part of the `remote_repo` URI, with a fallback to `git`. It is also possible to provide one by setting the `username` configuration key.
+
+For ssh key-based authentication, it is possible to set the environment variable `OXIDIZED_SSH_PASSPHRASE` to a passphrase if the private key requires it.
+
+`githubrepo` hook recognizes the following configuration keys:
 
 * `remote_repo`: the remote repository to be pushed to.
 * `username`: username for repository auth.
 * `password`: password for repository auth.
-* `publickey`: publickey for repository auth.
-* `privatekey`: privatekey for repository auth.
+* `publickey`: public key for repository auth.
+* `privatekey`: private key for repository auth.
 
-It is also possible to set the environment variable `OXIDIZED_SSH_PASSPHRASE` to a passphrase if your keypair requires it.
-
-When using groups repositories, each group must have its own `remote` in the `remote_repo` config.
+When using groups, each group must have a unique entry in the `remote_repo` config.
 
 ```yaml
 hooks:
@@ -85,7 +93,9 @@ hooks:
       firewalls: git@git.intranet:oxidized/firewalls.git
 ```
 
-## githubrepo hook configuration example
+### githubrepo hook configuration example
+
+Authenticate with the username `git` and a password:
 
 ```yaml
 hooks:
@@ -93,10 +103,21 @@ hooks:
     type: githubrepo
     events: [post_store]
     remote_repo: git@git.intranet:oxidized/test.git
-    username: user
     password: pass
 ```
 
+Authenticate with the username `git` and an ssh key:
+
+```yaml
+hooks:
+  push_to_remote:
+    type: githubrepo
+    events: [post_store]
+    remote_repo: git@git.intranet:oxidized/test.git
+    publickey: /root/.ssh/id_rsa.pub
+    privatekey: /root/.ssh/id_rsa
+```
+
 ## Hook type: awssns
 
 The `awssns` hook publishes messages to AWS SNS topics. This allows you to notify other systems of device configuration changes, for example a config orchestration pipeline. Multiple services can subscribe to the same AWS topic.
@@ -108,7 +129,7 @@ Fields sent in the message:
 * `model`: Model name (e.g. `eos`)
 * `node`: Device hostname
 
-## awssns hook configuration example
+### awssns hook configuration example
 
 ```yaml
 hooks:
@@ -136,7 +157,7 @@ You will need to manually install the `slack-api` gem on your system:
 gem install slack-api
 ```
 
-## slackdiff hook configuration example
+### slackdiff hook configuration example
 
 ```yaml
 hooks:
@@ -172,7 +193,7 @@ You will need to manually install the `xmpp4r` gem on your system:
 gem install xmpp4r
 ```
 
-## xmppdiff hook configuration example
+### xmppdiff hook configuration example
 
 ```yaml
 hooks:
-- 
cgit v1.2.3


From bb7b89f0db0c73650e0d1ac035d8441a0cb2e94f Mon Sep 17 00:00:00 2001
From: Wild Kat <wk@futureinquestion.net>
Date: Sat, 7 Apr 2018 01:57:08 +0200
Subject: improve githubrepo auth example

---
 docs/Hooks.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/Hooks.md b/docs/Hooks.md
index b582a2f..fb80a19 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -95,7 +95,7 @@ hooks:
 
 ### githubrepo hook configuration example
 
-Authenticate with the username `git` and a password:
+Authenticate with a username and a password:
 
 ```yaml
 hooks:
@@ -103,6 +103,7 @@ hooks:
     type: githubrepo
     events: [post_store]
     remote_repo: git@git.intranet:oxidized/test.git
+    username: user
     password: pass
 ```
 
-- 
cgit v1.2.3


From b29550ce0cfaf6192652747d340da2dc777ac22b Mon Sep 17 00:00:00 2001
From: Zsolt Zsiros <ZsZs73@users.noreply.github.com>
Date: Mon, 16 Apr 2018 14:48:43 +0200
Subject: model: netgear.rb support for older models (#1268)

* Added support for older models (FW 5.x.y.z like on GS110TP, GS748Tv4, etc)

* Fixed prompt regex

* docs/Model-Notes/Netgear created

* docs/Model-Notes/Netgear fixed typos
---
 docs/Model-Notes/Netgear.md   | 66 +++++++++++++++++++++++++++++++++++++++++++
 docs/Model-Notes/README.md    |  1 +
 lib/oxidized/model/netgear.rb |  5 ++--
 3 files changed, 70 insertions(+), 2 deletions(-)
 create mode 100644 docs/Model-Notes/Netgear.md

(limited to 'docs')

diff --git a/docs/Model-Notes/Netgear.md b/docs/Model-Notes/Netgear.md
new file mode 100644
index 0000000..9bfd094
--- /dev/null
+++ b/docs/Model-Notes/Netgear.md
@@ -0,0 +1,66 @@
+Netgear Configuration
+=====================
+
+There are several models available with CLI management via telnet (port 60000), but they all behave like one of the following:
+- older models:
+```
+Connected to 192.168.3.201.
+
+(GS748Tv4) 
+Applying Interface configuration, please wait ...admin
+Password:********
+(GS748Tv4) >enable
+Password:
+
+(GS748Tv4) #terminal length 0
+
+(GS748Tv4) #show running-config
+```
+
+- newer models:
+```
+Connected to 172.0.3.203.
+
+User:admin
+Password:********
+(GS724Tv4) >enable
+
+(GS724Tv4) #terminal length 0
+
+(GS724Tv4) #show running-config
+```
+
+The main differences are:
+- the prompt for username is different (looks quite strange for older models)
+- enable password
+  - the older model prompts for enable password and it expects empty string
+  - the newer model does not prompt for enable password at all
+
+Configuration for older/newer models: make sure you have defined variable 'enable':
+- `'true'` for newer models
+- `''` empty string: for older models
+
+One possible configuration:
+- oxidized config
+```
+source:
+  default: csv
+  csv:
+    file: "/home/oxidized/.config/oxidized/router.db"
+    delimiter: !ruby/regexp /:/
+    map:
+      name: 0
+      model: 1
+      username: 2
+      password: 3
+    vars_map:
+      enable: 4
+      telnet_port: 5
+```
+- router.db
+```
+switchOldFW:netgear:admin:adminpw::60000
+switchNewFW:netgear:admin:adminpw:true:60000
+```
+
+[Reference](https://github.com/ytti/oxidized/pull/1268)
\ No newline at end of file
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index c4b0ed1..fd1298e 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -12,6 +12,7 @@ AireOS|[AireOS](AireOS.md)|29 Nov 2017
 Arbor Networks|[ArbOS](ArbOS.md)|27 Feb 2018
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
+Netgear|[Netgear](Netgear.md)|11 Apr 2018
 Zyxel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
 
 If you discover additional caveats or problems please make sure to consult the [GitHub issues for oxidized](https://github.com/ytti/oxidized/issues) known issues.
diff --git a/lib/oxidized/model/netgear.rb b/lib/oxidized/model/netgear.rb
index 0ab1349..a32eb66 100644
--- a/lib/oxidized/model/netgear.rb
+++ b/lib/oxidized/model/netgear.rb
@@ -1,15 +1,16 @@
 class Netgear < Oxidized::Model
 
   comment '!'
-  prompt /^(\([\w\-.]+\)\s[#>])$/
+  prompt /^(\([\w\s\-.]+\)\s[#>])$/
 
   cmd :secret do |cfg|
     cfg.gsub!(/password (\S+)/, 'password <hidden>')
+    cfg.gsub!(/encrypted (\S+)/, 'encrypted <hidden>')
     cfg
   end
 
   cfg :telnet do
-    username /^User:/
+    username /^(User:|Applying Interface configuration, please wait ...)/
   end
 
   cfg :telnet, :ssh do
-- 
cgit v1.2.3


From 12c770dd3504748d3e67f99175b26d0515a3d283 Mon Sep 17 00:00:00 2001
From: Yuri Zubov <y.zubov@sumatosoft.com>
Date: Thu, 19 Apr 2018 14:19:41 +0300
Subject: Basic support for NDMS OS (Zyxel Keenetic)

---
 docs/Supported-OS-Types.md |  1 +
 lib/oxidized/model/ndms.rb | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 lib/oxidized/model/ndms.rb

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 7a765f8..4556946 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -163,3 +163,4 @@
   * [Zhone (OLT and MX)](/lib/oxidized/model/zhoneolt.rb)
 * Zyxel
   * [ZyNOS](/lib/oxidized/model/zynos.rb)
+  * [NDMS](/lib/oxidized/model/ndms.rb)
diff --git a/lib/oxidized/model/ndms.rb b/lib/oxidized/model/ndms.rb
new file mode 100644
index 0000000..c632bb9
--- /dev/null
+++ b/lib/oxidized/model/ndms.rb
@@ -0,0 +1,25 @@
+class NDMS < Oxidized::Model
+
+  # Pull config from Zyxel Keenetic devices from version NDMS >= 2.0
+
+  comment  '! '
+
+  prompt /^([\w.@()-]+[#>]\s?)/m
+
+  cmd 'show version' do |cfg|
+    cfg = cfg.each_line.to_a[1..-3].join
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg = cfg.each_line.to_a[1..-2]
+    cfg = cfg.reject { |line| line.match /(clock date|checksum)/ }.join
+    cfg
+  end
+
+  cfg :telnet do
+    username /^Login:/
+    password /^Password:/
+    pre_logout 'exit'
+  end
+end
-- 
cgit v1.2.3


From ffd4cc1569df3a9ad5c1ac453861544762ac4853 Mon Sep 17 00:00:00 2001
From: ytti <saku@ytti.fi>
Date: Mon, 23 Apr 2018 15:44:00 +0300
Subject: Fix Brocade links

Fixes #1302
---
 docs/Supported-OS-Types.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'docs')

diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 4556946..8839cc3 100644
--- a/docs/Supported-OS-Types.md
+++ b/docs/Supported-OS-Types.md
@@ -32,12 +32,12 @@
   * [VOSS (VSP Operating System Software)](/lib/oxidized/model/voss.rb)
   * [BOSS (Baystack Operating System Software)](/lib/oxidized/model/boss.rb)
 * Brocade
-  * [FabricOS](lib/oxidized/model/fabricos.rb)
-  * [Ironware](lib/oxidized/model/ironware.rb)
-  * [NOS (Network Operating System)](lib/oxidized/model/nos.rb)
-  * [Vyatta](lib/oxidized/model/vyatta.rb)
-  * [6910](lib/oxidized/model/br6910.rb)
-  * [SLX-OS](lib/oxidized/model/slxos.rb)
+  * [FabricOS](/lib/oxidized/model/fabricos.rb)
+  * [Ironware](/lib/oxidized/model/ironware.rb)
+  * [NOS (Network Operating System)](/lib/oxidized/model/nos.rb)
+  * [Vyatta](/lib/oxidized/model/vyatta.rb)
+  * [6910](/lib/oxidized/model/br6910.rb)
+  * [SLX-OS](/lib/oxidized/model/slxos.rb)
 * Casa
   * [Casa](/lib/oxidized/model/casa.rb)
 * Check Point
-- 
cgit v1.2.3


From cb002959bfc776de117f2353041e9d40aa486585 Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:07:51 -0500
Subject: Add a note about database engine reserved keywords.

---
 docs/Sources.md | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'docs')

diff --git a/docs/Sources.md b/docs/Sources.md
index 6d8e19e..eb3cd0c 100644
--- a/docs/Sources.md
+++ b/docs/Sources.md
@@ -59,6 +59,9 @@ pinentry-mode loopback
 
  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!
 
+**NOTE** - Many database engines have reserved keywords that may conflict with Oxidized configuration field names (such as 'name', 'group', etc). Pay attention to any names that are used and observed proper quoting methods to avoid errors or unpredictable results.
+
+
 ## Source: MYSQL
 
 `sudo apt-get install libmysqlclient-dev`
-- 
cgit v1.2.3


From 6d9181ae1a191a9e4bfc028edfd3c5b5d0435d0e Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:08:58 -0500
Subject: Consistency - add a link back to Model-Notes at the bottom

---
 docs/Model-Notes/ArbOS.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs')

diff --git a/docs/Model-Notes/ArbOS.md b/docs/Model-Notes/ArbOS.md
index f68467f..ebac997 100644
--- a/docs/Model-Notes/ArbOS.md
+++ b/docs/Model-Notes/ArbOS.md
@@ -8,3 +8,5 @@ If you are running ArbOS version 7 or lower then you may need to update the mode
     pre_logout 'exit'
   end
 ```
+
+Back to [Model-Notes](README.md)
-- 
cgit v1.2.3


From ffbc250f019fadabb7fd26b046c2a2e8e235b33c Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:09:28 -0500
Subject: Consistency - add a link back to Model-Notes at the bottom

---
 docs/Model-Notes/Comware.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs')

diff --git a/docs/Model-Notes/Comware.md b/docs/Model-Notes/Comware.md
index e7a2198..048f312 100644
--- a/docs/Model-Notes/Comware.md
+++ b/docs/Model-Notes/Comware.md
@@ -10,3 +10,5 @@ info-center source default channel 1 log state off debug state off
 ```
 
 [Reference](https://github.com/ytti/oxidized/issues/1171)
+
+Back to [Model-Notes](README.md)
-- 
cgit v1.2.3


From b6f4c3665b773ae0ba95a9a6084392d47779e8fd Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:10:06 -0500
Subject: Netgear notes updates

Consistency - add a link back to Model-Notes at the bottom

Tag a YAML block as YAML for highlighting.
---
 docs/Model-Notes/Netgear.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/Model-Notes/Netgear.md b/docs/Model-Notes/Netgear.md
index 9bfd094..d82bdcc 100644
--- a/docs/Model-Notes/Netgear.md
+++ b/docs/Model-Notes/Netgear.md
@@ -6,7 +6,7 @@ There are several models available with CLI management via telnet (port 60000),
 ```
 Connected to 192.168.3.201.
 
-(GS748Tv4) 
+(GS748Tv4)
 Applying Interface configuration, please wait ...admin
 Password:********
 (GS748Tv4) >enable
@@ -42,7 +42,7 @@ Configuration for older/newer models: make sure you have defined variable 'enabl
 
 One possible configuration:
 - oxidized config
-```
+```yaml
 source:
   default: csv
   csv:
@@ -63,4 +63,6 @@ switchOldFW:netgear:admin:adminpw::60000
 switchNewFW:netgear:admin:adminpw:true:60000
 ```
 
-[Reference](https://github.com/ytti/oxidized/pull/1268)
\ No newline at end of file
+[Reference](https://github.com/ytti/oxidized/pull/1268)
+
+Back to [Model-Notes](README.md)
-- 
cgit v1.2.3


From d1723993e6048621f6a2428bcba51c1cd17a124e Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:11:24 -0500
Subject: Ruby-API.md cleanups

Refer to things as 'device' versus 'switch'

Add some example use case notes for post_login and pre_logout.

MD highlight some items in the list for clarity

misc text clarity adjustments.
---
 docs/Ruby-API.md | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

(limited to 'docs')

diff --git a/docs/Ruby-API.md b/docs/Ruby-API.md
index 8621870..a9963b3 100644
--- a/docs/Ruby-API.md
+++ b/docs/Ruby-API.md
@@ -6,7 +6,7 @@ The following objects exist in Oxidized.
 
 * gets config from nodes
 * must implement 'connect', 'get', 'cmd'
-* 'ssh', 'telnet, ftp, and tftp' implemented
+* 'ssh', 'telnet', 'ftp', and 'tftp' implemented
 
 ## Output
 
@@ -18,12 +18,12 @@ The following objects exist in Oxidized.
 
 * gets list of nodes to poll
 * must implement 'load'
-* source can have 'name', 'model', 'group', 'username', 'password', 'input', 'output', 'prompt'
-  * name - name of the devices
-  * model - model to use ios/junos/xyz, model is loaded dynamically when needed (Also default in config file)
-  * input - method to acquire config, loaded dynamically as needed (Also default in config file)
-  * output - method to store config, loaded dynamically as needed (Also default in config file)
-  * prompt - prompt used for node (Also default in config file, can be specified in model too)
+* source can have 'name', 'model', 'group', 'username', 'password', 'input', 'output', 'prompt' for each device.
+  * `name` - name of the device
+  * `model` - model to use ('ios', 'junos', etc).The model is loaded dynamically by the first node of that model type. (Also default in config file)
+  * `input` - method to acquire config, loaded dynamically as needed (Also default in config file)
+  * `output` - method to store config, loaded dynamically as needed (Also default in config file)
+  * `prompt` - prompt used for node (Also default in config file, can be specified in model too)
 * 'sql', 'csv' and 'http' (supports any format with single entry per line, like router.db)
 
 ## Model
@@ -116,16 +116,20 @@ the password prompt. If not specified, the default of `/^Password/` is used.
 #### `post_login`
 
 Used inside `cfg` invocations to specify commands to run once Oxidized has
-logged in to the switch. Takes one argument that is either a block (taking zero
+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.
+
 #### `pre_logout`
 
 Used to specify commands to run before Oxidized closes the connection to the
-switch. Takes one argument that is either a block (taking zero parameters) or a
+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.)
+
 #### `send`
 
 Usually used inside `expect` or blocks passed to `post_login`/`pre_logout`.
-Takes a single parameter: a string to be sent to the switch.
+Takes a single parameter: a string to be sent to the device.
-- 
cgit v1.2.3


From e383a573e6c11f7366ce52774e191f7272db114f Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:13:49 -0500
Subject: Misc Hooks.md cleanups

misc text clarity.

clarify timeout is in seconds
clarity the publickey/privatekey are paths - not the keys themselves.

Reorder the AWS SNS example of describing the config before the example config for consistency with the rest.
---
 docs/Hooks.md | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

(limited to 'docs')

diff --git a/docs/Hooks.md b/docs/Hooks.md
index fb80a19..ff430ca 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -1,6 +1,6 @@
 # Hooks
 
-You can define arbitrary number of hooks that subscribe different events. The hook system is modular and different kind of hook types can be enabled.
+You can define an arbitrary number of hooks that subscribe to different events. The hook system is modular and different kind of hook types can be enabled.
 
 ## Configuration
 
@@ -38,10 +38,10 @@ OX_REPO_COMMITREF
 OX_REPO_NAME
 ```
 
-Exec hook recognizes following configuration keys:
+Exec hook recognizes the following configuration keys:
 
-* `timeout`: hard timeout for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: 60
-* `async`: influences whether main thread will wait for the command execution. Set this true for long running commands so node pull is not blocked. Default: false
+* `timeout`: hard timeout (in seconds) for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: `60`
+* `async`: Execute the command in an asynchronous fashion. The main thread by default will wait for the hook command execution to complete. Set this to `true` for long running commands so node configuration pulls are not blocked. Default: `false`
 * `cmd`: command to run.
 
 ### exec hook configuration example
@@ -79,8 +79,8 @@ For ssh key-based authentication, it is possible to set the environment variable
 * `remote_repo`: the remote repository to be pushed to.
 * `username`: username for repository auth.
 * `password`: password for repository auth.
-* `publickey`: public key for repository auth.
-* `privatekey`: private key for repository auth.
+* `publickey`: public key file path for repository auth.
+* `privatekey`: private key file path for repository auth.
 
 When using groups, each group must have a unique entry in the `remote_repo` config.
 
@@ -95,7 +95,7 @@ hooks:
 
 ### githubrepo hook configuration example
 
-Authenticate with a username and a password:
+Authenticate with a username and a password without groups in use:
 
 ```yaml
 hooks:
@@ -130,6 +130,11 @@ Fields sent in the message:
 * `model`: Model name (e.g. `eos`)
 * `node`: Device hostname
 
+
+The AWS SNS hook requires the following configuration keys:
+
+* `region`: AWS Region name
+* `topic_arn`: ASN Topic reference
 ### awssns hook configuration example
 
 ```yaml
@@ -141,11 +146,6 @@ hooks:
     topic_arn: arn:aws:sns:us-east-1:1234567:oxidized-test-backup_events
 ```
 
-AWS SNS hook requires the following configuration keys:
-
-* `region`: AWS Region name
-* `topic_arn`: ASN Topic reference
-
 Your AWS credentials should be stored in `~/.aws/credentials`.
 
 ## Hook type: slackdiff
-- 
cgit v1.2.3


From 7d450963907a76b26c47082b5c482a093ba3a533 Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:15:45 -0500
Subject: A few Outputs.md textual cleanups

misc clarity items
---
 docs/Outputs.md | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'docs')

diff --git a/docs/Outputs.md b/docs/Outputs.md
index 92c672c..fab3bf8 100644
--- a/docs/Outputs.md
+++ b/docs/Outputs.md
@@ -14,7 +14,7 @@ output:
 
 This uses the rugged/libgit2 interface. So you should remember that normal Git hooks will not be executed.
 
-For a single repositories for all devices:
+For a single repository containing all devices:
 
 ```yaml
 output:
@@ -25,7 +25,7 @@ output:
     repo: "/var/lib/oxidized/devices.git"
 ```
 
-And for groups repositories:
+And for group-based repositories:
 
 ```yaml
 output:
@@ -68,7 +68,7 @@ output:
 This uses the gem git and system git-crypt interfaces. Have a look at [GIT-Crypt](https://www.agwa.name/projects/git-crypt/) documentation to know how to install it.
 Additionally to user and email informations, you have to provide the users ID that can be a key ID, a full fingerprint, an email address, or anything else that uniquely identifies a public key to GPG (see "HOW TO SPECIFY A USER ID" in the gpg man page).
 
-For a single repositories for all devices:
+For a single repository containing all devices:
 
 ```yaml
 output:
@@ -82,7 +82,7 @@ output:
       - "<user@example.com>"
 ```
 
-And for groups repositories:
+And for group-based repositories:
 
 ```yaml
 output:
@@ -130,8 +130,9 @@ Please note that user list is only updated once at creation.
 
 ## Output: Http
 
-POST a config to the specified URL
+The HTTP output will POST a config to the specified HTTP URL. Basic username/password authentication is supported.
 
+Example HTTP output configuration:
 ```yaml
 output:
   default: http
@@ -185,4 +186,4 @@ which will result in the following layout
 diff/$FQDN--show_running_config
 nodiff/$FQDN--show_version
 nodiff/$FQDN--show_inventory
-```
\ No newline at end of file
+```
-- 
cgit v1.2.3


From 90a84a79279a0bac817ef871a4992e3d7d019cef Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:16:38 -0500
Subject: Give some examples of smart loading

Indicate that it can be used to have local site changes or updated models from the repo.

minor text clarity on other items.
---
 docs/Creating-Models.md | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/Creating-Models.md b/docs/Creating-Models.md
index d7a8155..3cb87c3 100644
--- a/docs/Creating-Models.md
+++ b/docs/Creating-Models.md
@@ -4,6 +4,8 @@ Oxidized supports a growing list of [operating system types](Supported-OS-Types.
 
 A user may wish to extend an existing model to collect the output of additional commands. Oxidized offers smart loading of models in order to facilitate this with ease, without the need to introduce changes to the upstream source code.
 
+This methodology allows local site changes to be preserved during Oxidized version updates / gem updates.
+
 ## Extending an existing model with a new command
 
 The example below can be used to extend the `JunOS` model to collect the output of `show interfaces diagnostics optics` and append the output to the configuration file as a comment. This command retrieves DOM information on pluggable optics present in a `JunOS`-powered chassis.
@@ -25,13 +27,16 @@ class JunOS
 end
 ```
 
-Due to smart loading, the user-supplied `~/.config/oxidized/model/junos.rb` file will take precedence over the model with the same name included in Oxidized. The code then uses `require` to load the included model, and extends the class defined therein with an additional command.
+Due to smart loading, the user-supplied `~/.config/oxidized/model/junos.rb` file will take precedence over the model with the same name included in the Oxidized distribution.
+
+The code then uses `require` to initially load the Oxidized-supplied model, and extends the class defined therein with an additional command.
 
 Intuitively, it is also possible to:
 
 * Completely re-define an existing model by creating a file in `~/.config/oxidized/model/` with the same name as an existing model, but not `require`-ing the upstream model file.
-* Create a named variation of an existing model, by creating a file with a new name (such as `~/.config/oxidized/model/junos-extra.rb`), Then `require` the original model and extend its base class as in the above example. The named variation can then be specified as an OS type for some devices but not others when defining sources.
+* Create a named variation of an existing model, by creating a file with a new name (such as `~/.config/oxidized/model/junos-extra.rb`), Then `require` the original model and extend its base class as in the above example. The named variation can then be specified as an OS type for specific devices that can benefit from the extra functionality. This allows for preservation of the base functionality for the default model types.
 * Create a completely new model, with a new name, for a new operating system type.
+* Testing/validation of an updated model from the [Oxidized GitHub repo models](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model) by placing an updated model in the proper location without disrupting the gem-supplied model files.
 
 ## Advanced features
 
@@ -70,4 +75,4 @@ class JunOS
 end
 ```
 
-The output of the `show configuration | display set` command is marked with a new arbitrary alternative output type, `junos-set`.  The `git` output will use the output type to create a new subdirectory by the same name. In this subdirectory, the `git` output will create files with the name `<devicename>--set` that will contain the output of this command for each device.
\ No newline at end of file
+The output of the `show configuration | display set` command is marked with a new arbitrary alternative output type, `junos-set`.  The `git` output will use the output type to create a new subdirectory by the same name. In this subdirectory, the `git` output will create files with the name `<devicename>--set` that will contain the output of this command for each device.
-- 
cgit v1.2.3


From cdcecd48fd05fecd656f384d074bd06406ac2690 Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
Date: Tue, 24 Apr 2018 10:17:40 -0500
Subject: clarity updates for Configuration doc

typo fixes - IP-Adress -> IP-Address
remove_secrets -> remove_secret
tag a ruby block as ruby for correct highlight
misc other small text clarity  (ssh_proxy is the proxy information etc)
---
 docs/Configuration.md | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

(limited to 'docs')

diff --git a/docs/Configuration.md b/docs/Configuration.md
index 6bbbb61..661e65a 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -4,7 +4,7 @@
 
 In case a model plugin doesn't work correctly (ios, procurve, etc.), you can enable live debugging of SSH/Telnet sessions. Just add a `debug` option containing the value true to the `input` section. The log files will be created depending on the parent directory of the logfile option.
 
-The following example will log an active ssh/telnet session `/home/oxidized/.config/oxidized/log/<IP-Adress>-<PROTOCOL>`. The file will be truncated on each consecutive ssh/telnet session, so you need to put a `tailf` or `tail -f` on that file!
+The following example will log an active ssh/telnet session `/home/oxidized/.config/oxidized/log/<IP-Address>-<PROTOCOL>`. The file will be truncated on each consecutive ssh/telnet session, so you need to put a `tailf` or `tail -f` on that file!
 
 ```yaml
 log: /home/oxidized/.config/oxidized/log
@@ -29,18 +29,18 @@ vars:
 
 ## Removing secrets
 
-To strip out secrets from configurations before storing them, Oxidized needs the the remove_secrets flag. You can globally enable this by adding the following snippet to the global sections of the configuration file.
+To strip out secrets from configurations before storing them, Oxidized needs the `remove_secret` flag. You can globally enable this by adding the following snippet to the global section of the configuration file.
 
 ```yaml
 vars:
   remove_secret: true
 ```
 
-Device models can contain substitution filters to remove potentially sensitive data from configs.
+Device models that contain substitution filters to remove sensitive data will now be run on any fetched configuration.
 
 As a partial example from ios.rb:
 
-```yaml
+```ruby
   cmd :secret do |cfg|
     cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
     (...)
@@ -64,7 +64,11 @@ vars:
 
 ## SSH Proxy Command
 
-Oxidized can `ssh` through a proxy as well. To do so we just need to set `ssh_proxy` variable.
+Oxidized can `ssh` through a proxy as well. To do so we just need to set `ssh_proxy` variable with the proxy host information.
+
+This can be provided on a per-node basis by mapping the proper fields from your source.
+
+An example for a `csv` input source that maps the 4th field as the `ssh_proxy` value.
 
 ```yaml
 ...
@@ -79,7 +83,7 @@ vars_map:
 
 ## FTP Passive Mode
 
-Oxidized uses ftp passive mode by default. Some devices require passive mode to be disabled. To do so, we can set `input.ftp.passive` to false
+Oxidized uses ftp passive mode by default. Some devices require passive mode to be disabled. To do so, we can set `input.ftp.passive` to false - this will make use of FTP active mode.
 
 ```yaml
 input:
@@ -192,10 +196,12 @@ rest: 10.0.0.1:8000/oxidized
 
 ## Triggered backups
 
-A node can be moved to head-of-queue via the REST API `GET/POST /node/next/[NODE]`.
+A node can be moved to head-of-queue via the REST API `GET/POST /node/next/[NODE]`. This can be useful to immediately schedule a fetch of the configuration after some other event such as a syslog message indicating a configuration update on the device.
 
-In the default configuration this node will be processed when the next job worker becomes available, it could take some time if existing backups are in progress. To execute moved jobs immediately a new job can be added:
+In the default configuration this node will be processed when the next job worker becomes available, it could take some time if existing backups are in progress. To execute moved jobs immediately a new job can be added automatically:
 
 ```yaml
 next_adds_job: true
 ```
+
+This will allow for a more timely fetch of the device configuration.
-- 
cgit v1.2.3