From 77e5c874896e8f17aa32fa40b96196a8d2932ff5 Mon Sep 17 00:00:00 2001
From: Jason Ackley <jason@ackley.net>
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/README.md     | 17 +++++++++++++++++
 docs/Model-Notes/VRP-Huawei.md | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 docs/Model-Notes/README.md
 create mode 100644 docs/Model-Notes/VRP-Huawei.md

(limited to 'docs/Model-Notes')

diff --git a/docs/Model-Notes/README.md b/docs/Model-Notes/README.md
new file mode 100644
index 0000000..15ab445
--- /dev/null
+++ b/docs/Model-Notes/README.md
@@ -0,0 +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
+----------------|-----------------|----------------
+Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
+
+
+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
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
+
+```
+    <HUAWEI> 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:
+
+```
+    <HUAWEI> 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