README.md in oxidized-0.9.0 vs README.md in oxidized-0.10.0
- old
+ new
@@ -1,6 +1,6 @@
-# Oxidized
+# Oxidized [](https://travis-ci.org/Shopify/oxidized)
[](http://badge.fury.io/rb/oxidized)
Oxidized is a network device configuration backup tool. It's a RANCID replacement!
@@ -40,43 +40,70 @@
* [Source](#source)
* [Model](#model)
# Supported OS types
- * A10 Networks ACOS
- * Alcatel-Lucent ISAM 7302/7330
- * Alcatel-Lucent Operating System AOS
- * Alcatel-Lucent Operating System AOS7
- * Alcatel-Lucent Operating System Wireless
- * Alcatel-Lucent TiMOS
- * Arista EOS
- * Brocade Fabric OS
- * Brocade Ironware
- * Brocade NOS (Network Operating System)
- * Brocade Vyatta
- * Cisco AireOS
- * Cisco ASA
- * Cisco IOS
- * Cisco IOS-XR
- * Cisco NXOS
- * Cisco SMB (Nikola series)
- * Cumulus Linux
- * DELL PowerConnect
- * Extreme Networks XOS
- * Force10 FTOS
- * Force10 NDOS
- * FortiGate FortiOS
- * HP Comware (HP A-series, H3C, 3Com)
- * HP ProCurve
- * Huawei VRP
- * Juniper JunOS
- * Juniper ScreenOS (Netscreen)
- * Mikrotik RouterOS
- * MRV Master-OS
- * Ubiquiti AirOS
- * Palo Alto PAN-OS
- * Zyxel ZyNOS
+ * A10 Networks
+ * ACOS
+ * Alcatel-Lucent
+ * ISAM
+ * AOS
+ * AOS7
+ * Wireless
+ * TiMOS
+ * Arista
+ * EOS
+ * Arris
+ * C4CMTS
+ * Aruba
+ * AOSW
+ * Brocade
+ * FabricOS
+ * Ironware
+ * NOS (Network Operating System)
+ * Vyatta
+ * Ciena
+ * SOAS
+ * Cisco
+ * AireOS
+ * ASA
+ * IOS
+ * IOSXR
+ * NXOS
+ * SMB (Nikola series)
+ * Cumulus
+ * Linux
+ * DELL
+ * PowerConnect
+ * AOSW
+ * Extreme Networks
+ * XOS
+ * Force10
+ * FTOS
+ * Force10
+ * DNOS
+ * FortiGate
+ * FortiOS
+ * HP
+ * Comware (HP A-series, H3C, 3Com)
+ * Procurve
+ * Huawei
+ * VRP
+ * Juniper
+ * JunOS
+ * ScreenOS (Netscreen)
+ * Mikrotik
+ * RouterOS
+ * MRV
+ * MasterOS
+ * Ubiquiti
+ * AirOS
+ * Edgeos
+ * Palo Alto
+ * PANOS
+ * Zyxel
+ * ZyNOS
# Installation
## Debian
Install all required packages and gems.
@@ -111,11 +138,11 @@
## Outputs
Possible outputs are either ```file``` or ```git```. The file backend takes a destination directory as argument and will keep a file per device, with most recent running version of a device. The GIT backend (recommended) will initialize an empty GIT repository in the specified path and create a new commit on every configuration change. Take a look at the [Cookbook](#cookbook) for more details.
-Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if Syslog::Logger exists (>=2.0) and syslog is used instead.
+Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog`(requires Ruby >= 2.0) is set to `true`.
First create the directory where the CSV ```output``` is going to store device configs and start Oxidized once.
```
mkdir ~/.config/oxidized/configs
oxidized
@@ -442,9 +469,11 @@
OX_NODE_FROM
OX_NODE_MSG
OX_NODE_GROUP
OX_JOB_STATUS
OX_JOB_TIME
+OX_REPO_COMMITREF
+OX_REPO_NAME
```
Exec hook recognizes following configuration keys:
* `timeout`: hard timeout for the command execution. SIGTERM will be sent to the child process after the timeout has elapsed. Default: 60