diff options
author | Wild Kat <wk@futureinquestion.net> | 2018-03-12 00:19:20 +0100 |
---|---|---|
committer | Wild Kat <wk@futureinquestion.net> | 2018-03-12 09:03:07 +0100 |
commit | 87600b1f5f12711afe29c408e02dbbd927e3f25d (patch) | |
tree | 454ef170f1e1be1761587ea26a4ba1d21bc0dfcb /docs/Model-Notes | |
parent | 34cdbeb75f3c74d803fb60c509fc06e4f6365f0c (diff) |
Lint and standardize markdown documentation
Diffstat (limited to 'docs/Model-Notes')
-rw-r--r-- | docs/Model-Notes/AireOS.md | 8 | ||||
-rw-r--r-- | docs/Model-Notes/ArbOS.md | 2 | ||||
-rw-r--r-- | docs/Model-Notes/Comware.md | 10 | ||||
-rw-r--r-- | docs/Model-Notes/JunOS.md | 14 | ||||
-rw-r--r-- | docs/Model-Notes/README.md | 8 | ||||
-rw-r--r-- | docs/Model-Notes/VRP-Huawei.md | 5 | ||||
-rw-r--r-- | docs/Model-Notes/XGS4600-Zyxel.md | 13 |
7 files changed, 27 insertions, 33 deletions
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) |