From 77e5c874896e8f17aa32fa40b96196a8d2932ff5 Mon Sep 17 00:00:00 2001 From: Jason Ackley 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/VRP-Huawei.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/Model-Notes/VRP-Huawei.md (limited to 'docs/Model-Notes/VRP-Huawei.md') 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 + +``` + 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: + +``` + 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) -- cgit v1.2.1 From 87600b1f5f12711afe29c408e02dbbd927e3f25d Mon Sep 17 00:00:00 2001 From: Wild Kat Date: Mon, 12 Mar 2018 00:19:20 +0100 Subject: Lint and standardize markdown documentation --- docs/Model-Notes/VRP-Huawei.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/Model-Notes/VRP-Huawei.md') 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 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 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) -- cgit v1.2.1 From ce0216fde8cdf562be4cc9d39aba2cf003d3c7f6 Mon Sep 17 00:00:00 2001 From: Wild Kat Date: Fri, 16 Mar 2018 16:19:21 +0100 Subject: documentation touch-ups and issue #1218 --- docs/Model-Notes/VRP-Huawei.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/Model-Notes/VRP-Huawei.md') 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.1 From 720facc6f80d2b977d73b944c81c63b6d95e768b Mon Sep 17 00:00:00 2001 From: Wild Kat Date: Fri, 16 Mar 2018 20:31:09 +0100 Subject: improve spelling in docs --- docs/Model-Notes/VRP-Huawei.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Model-Notes/VRP-Huawei.md') 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 system-view -- cgit v1.2.1