diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Configuration.md | 2 | ||||
| -rw-r--r-- | docs/Creating-Models.md | 2 | ||||
| -rw-r--r-- | docs/Hooks.md | 4 | ||||
| -rw-r--r-- | docs/Model-Notes/AireOS.md | 2 | ||||
| -rw-r--r-- | docs/Model-Notes/Comware.md | 2 | ||||
| -rw-r--r-- | docs/Model-Notes/README.md | 4 | ||||
| -rw-r--r-- | docs/Model-Notes/VRP-Huawei.md | 4 | ||||
| -rw-r--r-- | docs/Sources.md | 4 | ||||
| -rw-r--r-- | docs/Supported-OS-Types.md | 5 |
9 files changed, 17 insertions, 12 deletions
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/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/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 e68a959..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 @@ -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) 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 diff --git a/docs/Supported-OS-Types.md b/docs/Supported-OS-Types.md index a0ca66b..1717284 100644 --- a/docs/Supported-OS-Types.md +++ b/docs/Supported-OS-Types.md @@ -139,7 +139,10 @@ * Siklu * [EtherHaul](/lib/oxidized/model/siklu.rb) * Supermicro - * [Supermicro](/lib/oxidized/model/supermicro.rb) + * [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) + * [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) * Trango Systems |