ssh auth docs and misc documentation fixups, closes ytti#1379 (ytti#1381

)
s-fu · Jun 12, 2018 · fcb0e5e · fcb0e5e
1 parent cb5741b
commit fcb0e5e
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,7 @@
 * FEATURE: cambium model
 * FEATURE: ssh key passphrase (@wk)
 * FEATURE: cisco spark hook (@rgnv)
+* FEATURE: added support for setting ssh auth methods (@laf)
 * BUGFIX: models procurve, br6910, vyos, fortios, edgeos, vyatta, junos, powerconnect, supermicro, fortios, firewareos, aricentiss, dnos, nxos, hpbladesystem, netgear, xos, boss, opengear, pfsense, asyncos
 
 ## 0.21.0

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -66,9 +66,9 @@ vars:
 
 By default, Oxidized registers the following auth methods: `none`, `publickey` and `password`. However you can configure this globally, by groups, models or nodes.
 
-```
+```yaml
 vars:
-    auth_methods: none, publickey, password, keyboard-interactive
+    auth_methods: [ "none", "publickey", "password", "keyboard-interactive" ]
 ```
 
 ## SSH Proxy Command

diff --git a/docs/Model-Notes/Cumulus.md b/docs/Model-Notes/Cumulus.md
@@ -35,4 +35,6 @@ And set the `cumulus_routing_daemon` variable in the `router.db` file.
 cumulus1:192.168.121.134:cumulus:cumulus:frr
 ```
 
-The default variable is `quagga` so existing installations continue to operate without interruption.
+The default variable is `quagga` so existing installations continue to operate without interruption.
+
+Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/EOS.md b/docs/Model-Notes/EOS.md
@@ -1,9 +1,13 @@
 Arista EOS Configuration
 ========================
 
-By default EOS requires keyboard-interactive to be added to your Oxidized config. You can avoid having to do this by configuring the following on the EOS device:
+By default, EOS requires the `keyboard-interactive` SSH authentication method for a successful SSH login. To add support for this method to your Oxidized configuration, see the [SSH Auth Methods](../Configuration.md#ssh-auth-methods) directive.
 
-```
+It is also possible to modify the EOS configuration to accept the `password` method which Oxidized presents by default. To do so, the following configuration statement can be used:
+
+```text
 management ssh
    authentication mode password
 ```
+
+Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/Netgear.md b/docs/Model-Notes/Netgear.md
@@ -2,8 +2,10 @@ 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:
-```
+
+### Older models:
+
+```text
 Connected to 192.168.3.201.
 
 (GS748Tv4)
@@ -17,8 +19,9 @@ Password:
 (GS748Tv4) #show running-config
 ```
 
-- newer models:
-```
+### Newer models:
+
+```text
 Connected to 172.0.3.203.
 
 User:admin
@@ -31,17 +34,21 @@ Password:********
 ```
 
 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
+
+* 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
+
+* `'true'` for newer models
+* `''` empty string: for older models
 
 One possible configuration:
-- oxidized config
+
+### oxidized config
+
 ```yaml
 source:
   default: csv
@@ -57,8 +64,10 @@ source:
       enable: 4
       telnet_port: 5
 ```
-- router.db
-```
+
+### router.db
+
+```text
 switchOldFW:netgear:admin:adminpw::60000
 switchNewFW:netgear:admin:adminpw:true:60000
 ```

diff --git a/docs/Model-Notes/XGS4600-Zyxel.md b/docs/Model-Notes/XGS4600-Zyxel.md
@@ -20,7 +20,6 @@ input:
     passive: false
 ```
 
-
 ## SSH/TelNet
 
 Below is the table from the XGS4600 CLI Reference Guide (Version 3.79~4.50 Edition 1, 07/2017)
@@ -33,7 +32,6 @@ Privilege Level | Types of commands at this privilege level
 13|Configure features except for login accounts, SNMP user accounts, the authentication method sequence and authorization settings, multiple logins, administrator and enable passwords, and configuration information display.
 14|Configure login accounts, SNMP user accounts, the authentication method sequence and authorization settings, multiple logins, and administrator and enable passwords, and display configuration information.
 
-
 Oxidized can now retrieve your configuration!
 
 Back to [Model-Notes](README.md)