Skip to content

Commit

Permalink
documentation touch-ups and issue ytti#1218
Browse files Browse the repository at this point in the history
  • Loading branch information
wk committed Mar 16, 2018
1 parent 5a87937 commit ce0216f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Creating-Models.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/Model-Notes/VRP-Huawei.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit ce0216f

Please sign in to comment.