summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
-rw-r--r--docs/Creating-Models.md2
-rw-r--r--docs/Model-Notes/VRP-Huawei.md2
3 files changed, 15 insertions, 9 deletions
diff --git a/README.md b/README.md
index 336c05a..09929af 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,26 @@
# Oxidized [![Build Status](https://travis-ci.org/Shopify/oxidized.svg)](https://travis-ci.org/Shopify/oxidized) [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized) [![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-> Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!
+Oxidized is a network device configuration backup tool. It's a RANCID replacement!
-[WANTED: MAINTAINER](#help-needed)
+Light and extensible, Oxidized supports over 90 operating system types.
-Oxidized is a network device configuration backup tool. It's a RANCID replacement!
+Feature highlights:
* Automatically adds/removes threads to meet configured retrieval interval
-* Restful API to move node immediately to head-of-queue (GET/POST /node/next/[NODE])
-* Syslog udp+file example to catch config change event (ios/junos) and trigger config fetch
- * Will signal ios/junos user who made change, which output modules can use (via POST)
- * The git output module uses this info - 'git blame' will for each line show who made the change and when
+* Restful API to a move node immediately to head-of-queue (GET/POST /node/next/[NODE])
+* Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
+ * Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
+ * The `git` output module uses this info - 'git blame' will show who changed each line, and when
* Restful API to reload list of nodes (GET /reload)
* Restful API to fetch configurations (/node/fetch/[NODE] or /node/fetch/group/[NODE])
* Restful API to show list of nodes (GET /nodes)
* Restful API to show list of version for a node (/node/version[NODE]) and diffs
-[Youtube Video: Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h)
+Check out the [Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h) video on YouTube!
+
+> :warning: [Maintainer Wanted!](#help-needed) :warning:
+>
+> Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!
## Index
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/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)