summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Configuration.md41
-rw-r--r--docs/Creating-Models.md11
-rw-r--r--docs/Hooks.md105
-rw-r--r--docs/Model-Notes/ArbOS.md2
-rw-r--r--docs/Model-Notes/Comware.md2
-rw-r--r--docs/Model-Notes/EOS.md9
-rw-r--r--docs/Model-Notes/Netgear.md68
-rw-r--r--docs/Model-Notes/README.md4
-rw-r--r--docs/Model-Notes/XGS4600-Zyxel.md14
-rw-r--r--docs/Outputs.md13
-rw-r--r--docs/Ruby-API.md24
-rw-r--r--docs/Sources.md3
-rw-r--r--docs/Supported-OS-Types.md20
13 files changed, 259 insertions, 57 deletions
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 6bbbb61..aea5e3c 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>'
(...)
@@ -62,9 +62,22 @@ vars:
ssh_no_exec: true
```
+## SSH Auth Methods
+
+By default, Oxidized registers the following auth methods: `none`, `publickey` and `password`. However you can configure this globally, by groups, models or nodes.
+
+```
+vars:
+ auth_methods: none, publickey, password, keyboard-interactive
+```
+
## 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 +92,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 +205,22 @@ 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.
+
+## Disabling DNS resolution
+
+In some instances it might not be desirable to attempt to resolve names of nodes. One such use case is when nodes are accessed through an SSH proxy, where the remote end resolves the names differently than the host on which Oxidized runs would.
+
+Names can instead be passed verbatim to the input:
+
+```yaml
+resolve_dns: false
+```
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.
diff --git a/docs/Hooks.md b/docs/Hooks.md
index 8a0a8b9..09b6117 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
@@ -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.
@@ -38,13 +38,13 @@ 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
+### 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.
-
-It is also possible to set the environment variable `OXIDIZED_SSH_PASSPHRASE` to a passphrase if your keypair requires it.
+* `publickey`: public key file path for repository auth.
+* `privatekey`: private key file path for repository auth.
-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 a username and a password without groups in use:
```yaml
hooks:
@@ -97,6 +107,18 @@ hooks:
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 +130,12 @@ Fields sent in the message:
* `model`: Model name (e.g. `eos`)
* `node`: Device hostname
-## awssns hook configuration example
+
+The AWS SNS hook requires the following configuration keys:
+
+* `region`: AWS Region name
+* `topic_arn`: ASN Topic reference
+### awssns hook configuration example
```yaml
hooks:
@@ -119,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
@@ -136,7 +158,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:
@@ -162,6 +184,43 @@ hooks:
Note the channel name must be in quotes.
+## Hook type: ciscosparkdiff
+
+The `ciscosparkdiff` hook posts config diffs to a [Cisco Spark](https://www.ciscospark.com/) space of your choice. It only triggers for `post_store` events.
+
+You will need to manually install the `cisco_spark` gem on your system (see [cisco_spark-ruby](https://github.com/NGMarmaduke/cisco_spark-ruby)) and generate either a [Bot or OAUTH access key](https://developer.ciscospark.com/apps.html), and retrieve the [Spark Space ID](https://developer.ciscospark.com/endpoint-rooms-get.html)
+
+```shell
+gem install cisco_spark
+```
+
+### ciscosparkdiff hook configuration example
+
+```yaml
+hooks:
+ ciscospark:
+ type: ciscosparkdiff
+ events: [post_store]
+ accesskey: SPARK_BOT_API_OR_OAUTH_KEY
+ space: SPARK_SPACE_ID
+ diff: true
+```
+
+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
+hooks:
+ ciscospark:
+ type: ciscosparkdiff
+ events: [post_store]
+ accesskey: SPARK_BOT_API_OR_OAUTH_KEY
+ space: SPARK_SPACE_ID
+ diff: false
+ message: "%{node} %{group} %{model} updated https://git.intranet/network-changes/commit/%{commitref}"
+```
+
+Note the space and access tokens must be in quotes.
+
## Hook type: xmppdiff
The `xmppdiff` hook posts config diffs to a [XMPP](https://en.wikipedia.org/wiki/XMPP) chatroom of your choice. It only triggers for `post_store` events.
@@ -172,7 +231,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:
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)
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)
diff --git a/docs/Model-Notes/EOS.md b/docs/Model-Notes/EOS.md
new file mode 100644
index 0000000..66287e3
--- /dev/null
+++ b/docs/Model-Notes/EOS.md
@@ -0,0 +1,9 @@
+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:
+
+```
+management ssh
+ authentication mode password
+```
diff --git a/docs/Model-Notes/Netgear.md b/docs/Model-Notes/Netgear.md
new file mode 100644
index 0000000..d82bdcc
--- /dev/null
+++ b/docs/Model-Notes/Netgear.md
@@ -0,0 +1,68 @@
+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
+```yaml
+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)
+
+Back to [Model-Notes](README.md)
diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
index c4b0ed1..993eb77 100644
--- a/docs/Model-Notes/README.md
+++ b/docs/Model-Notes/README.md
@@ -10,8 +10,10 @@ 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
+Arista|[EOS](EOS.md)|05 Feb 2018
Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
-Zyxel|[XGS4600 Series](XGS4600-Zyxel.md)|23 Jan 2018
+Netgear|[Netgear](Netgear.md)|11 Apr 2018
+Zyxel|[XGS4600 Series](XGS4600-Zyxel.md)|1 Feb 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
index 17cb2b5..8b58ed8 100644
--- a/docs/Model-Notes/XGS4600-Zyxel.md
+++ b/docs/Model-Notes/XGS4600-Zyxel.md
@@ -20,6 +20,20 @@ input:
passive: false
```
+
+## SSH/TelNet
+
+Below is the table from the XGS4600 CLI Reference Guide (Version 3.79~4.50 Edition 1, 07/2017)
+Take this table with a pinch of salt, level 3 will not allow _show running-config_!
+
+Privilege Level | Types of commands at this privilege level
+----------------|-------------------------------------------
+0|Display basic system information.
+3|Display configuration or status.
+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)
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
+```
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.
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`
diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md
index 493918d..5850bd1 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
@@ -63,6 +63,8 @@
* [TMOS (8800)](/lib/oxidized/model/corianttmos.rb)
* [8600](/lib/oxidized/model/coriant8600.rb)
* [Groove](/lib/oxidized/model/coriantgroove.rb)
+* ComNet
+ * [ComNet Microsemi Switch](/lib/oxidized/model/comnetms.rb)
* Cumulus
* [Linux](/lib/oxidized/model/cumulus.rb)
* DataCom
@@ -95,6 +97,8 @@
* [Broadband Network Platform Software](/lib/oxidized/model/gcombnps.rb)
* Hatteras
* [Hatteras](/lib/oxidized/model/hatteras.rb)
+* Hillstone Networks
+ * [StoneOS](/lib/oxidized/model/stoneos.rb)
* Hirschmann
* [HiOS](/lib/oxidized/model/hirschmann.rb)
* HP
@@ -127,6 +131,7 @@
* [OneOS](/lib/oxidized/model/oneos.rb)
* Opengear
* [Opengear](/lib/oxidized/model/opengear.rb)
+* [OpenWRT](/lib/oxidized/model/openwrt.rb)
* [OPNsense](/lib/oxidized/model/opnsense.rb)
* Palo Alto
* [PANOS](/lib/oxidized/model/panos.rb)
@@ -138,6 +143,8 @@
* [Quanta / VxWorks 6.6 (1.1.0.8)](/lib/oxidized/model/quantaos.rb)
* Siklu
* [EtherHaul](/lib/oxidized/model/siklu.rb)
+* SNR
+ * [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)
@@ -161,3 +168,4 @@
* [Zhone (OLT and MX)](/lib/oxidized/model/zhoneolt.rb)
* Zyxel
* [ZyNOS](/lib/oxidized/model/zynos.rb)
+ * [NDMS](/lib/oxidized/model/ndms.rb)