README.md in oxidized-0.17.0 vs README.md in oxidized-0.18.0
- old
+ new
@@ -1,6 +1,6 @@
-# Oxidized [](https://travis-ci.org/Shopify/oxidized) [](http://badge.fury.io/rb/oxidized) [](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# Oxidized [](https://travis-ci.org/Shopify/oxidized) [](http://badge.fury.io/rb/oxidized) [](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Oxidized is a network device configuration backup tool. It's a RANCID replacement!
* automatically adds/removes threads to meet configured retrieval interval
* restful API to move node immediately to head-of-queue (GET/POST /node/next/[NODE])
@@ -43,106 +43,108 @@
* [Source](#source)
* [Model](#model)
# Supported OS types
* Vendor
- * OS - model_name
+ * OS model
* A10 Networks
- * ACOS - acos
+ * [ACOS](lib/oxidized/model/acos.rb)
* Alcatel-Lucent
- * AOS - aos
- * AOS7 - aos7
- * ISAM - isam
+ * [AOS](lib/oxidized/model/aos.rb)
+ * [AOS7](lib/oxidized/model/aos7.rb)
+ * [ISAM](lib/oxidized/model/isam.rb)
* Wireless
* Alvarion
- * BreezeACCESS - alvarion
+ * [BreezeACCESS](lib/oxidized/model/alvarion.rb)
+ * APC
+ * [AOS](lib/oxidized/model/apc_aos.rb)
* Arista
- * EOS - eos
+ * [EOS](lib/oxidized/model/eos.rb)
* Arris
- * C4CMTS - c4cmts
+ * [C4CMTS](lib/oxidized/model/c4cmts.rb)
* Aruba
- * AOSW - aosw
+ * [AOSW](lib/oxidized/model/aosw.rb)
* Brocade
- * FabricOS - fabricos
- * Ironware - ironware
- * NOS (Network Operating System) - nos
- * Vyatta - vyatta
- * 6910 - br6910
+ * [FabricOS](lib/oxidized/model/fabricos.rb)
+ * [Ironware](lib/oxidized/model/ironware.rb)
+ * [NOS (Network Operating System)](lib/oxidized/model/nos.rb)
+ * [Vyatta](lib/oxidized/model/vyatta.rb)
+ * [6910](lib/oxidized/model/br6910.rb)
* Check Point
- * GaiaOS - gaiaos
+ * [GaiaOS](lib/oxidized/model/gaiaos.rb)
* Ciena
- * SOAS - saos
+ * [SOAS](lib/oxidized/model/saos.rb)
* Cisco
- * AireOS - aireos
- * ASA - asa
- * CatOS - catos
- * IOS - ios
- * IOSXR - iosxr
- * NXOS - nxos
- * SMB (Nikola series)
+ * [AireOS](lib/oxidized/model/aireos.rb)
+ * [ASA](lib/oxidized/model/asa.rb)
+ * [CatOS](lib/oxidized/model/catos.rb)
+ * [IOS](lib/oxidized/model/ios.rb)
+ * [IOSXR](lib/oxidized/model/iosxr.rb)
+ * [NXOS](lib/oxidized/model/nxos.rb)
+ * [SMB (Nikola series)](lib/oxidized/model/ciscosmb.rb)
* Citrix
- * NetScaler (Virtual Applicance) - netscaler
+ * [NetScaler (Virtual Applicance)](lib/oxidized/model/netscaler.rb)
* Coriant (former Tellabs)
- * TMOS (8800) - tmos
- * 8600 -
+ * [TMOS (8800)](lib/oxidized/model/corianttmos.rb)
+ * [8600](lib/oxidized/model/coriant8600.rb)
* Cumulus
- * Linux
+ * [Linux](lib/oxidized/model/cumulus.rb)
* DataCom
- * DmSwitch 3000
+ * [DmSwitch 3000](lib/oxidized/model/datacom.rb)
* DELL
- * PowerConnect - powerconnect
- * AOSW - aosw
+ * [PowerConnect](lib/oxidized/model/powerconnect.rb)
+ * [AOSW](lib/oxidized/model/aosw.rb)
* Ericsson/Redback
- * IPOS (former SEOS) - ipos
+ * [IPOS (former SEOS)](lib/oxidized/model/ipos.rb)
* Extreme Networks
- * XOS - xos
- * WM
+ * [XOS](lib/oxidized/model/xos.rb)
+ * [WM](lib/oxidized/model/mtrlrfs.rb)
* F5
- * TMOS
+ * [TMOS](lib/oxidized/model/tmos.rb)
* Force10
- * DNOS - dnos
- * FTOS - ftos
+ * [DNOS](lib/oxidized/model/dnos.rb)
+ * [FTOS](lib/oxidized/model/ftos.rb)
* FortiGate
- * FortiOS - fortios
+ * [FortiOS](lib/oxidized/model/fortios.rb)
* HP
- * Comware (HP A-series, H3C, 3Com) - comware
- * Procurve - procurve
+ * [Comware (HP A-series, H3C, 3Com)](lib/oxidized/model/comware.rb)
+ * [Procurve](lib/oxidized/model/procurve.rb)
* Huawei
- * VRP
+ * [VRP](lib/oxidized/model/vrp.rb)
* Juniper
- * JunOS
- * ScreenOS (Netscreen)
+ * [JunOS](lib/oxidized/model/junos.rb)
+ * [ScreenOS (Netscreen)](lib/oxidized/model/screenos.rb)
* Mellanox
- * MLNX-OS - mlnxos
+ * [MLNX-OS](lib/oxidized/model/mlnxos.rb)
* Mikrotik
- * RouterOS - routeros
+ * [RouterOS](lib/oxidized/model/routeros.rb)
* Motorola
- * RFS
+ * [RFS](lib/oxidized/model/mtrlrfs.rb)
* MRV
- * MasterOS - masteros
+ * [MasterOS](lib/oxidized/model/masteros.rb)
* Netonix
- * WISP Switch (As Netonix) - netonix
+ * [WISP Switch (As Netonix)](lib/oxidized/model/netonix.rb)
* Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
- * SR OS (TiMOS) - timos
+ * [SR OS (TiMOS)](lib/oxidized/model/timos.rb)
* Opengear
- * Opengear - opengear
+ * [Opengear](lib/oxidized/model/opengear.rb)
* Palo Alto
- * PANOS - panos
- * pfSense - pfsense
+ * [PANOS](lib/oxidized/model/panos.rb)
+ * [pfSense](lib/oxidized/model/pfsense.rb)
* Quanta
- * Quanta / VxWorks 6.6 (1.1.0.8) - quantaos
+ * [Quanta / VxWorks 6.6 (1.1.0.8)](lib/oxidized/model/quantaos.rb)
* Supermicro
- * Supermicro - supermicro
+ * [Supermicro](lib/oxidized/model/supermicro.rb)
* Ubiquiti
- * AirOS - airos
- * Edgeos - edgeos
- * EdgeSwitch - edgeswitch
+ * [AirOS](lib/oxidized/model/airos.rb)
+ * [Edgeos](lib/oxidized/model/edgeos.rb)
+ * [EdgeSwitch](lib/oxidized/model/edgeswitch.rb)
* Watchguard
- * Fireware OS - firewareos
+ * [Fireware OS](lib/oxidized/model/firewareos.rb)
* Zyxel
- * ZyNOS - zynos
+ * [ZyNOS](lib/oxidized/model/zynos.rb)
# Installation
## Debian
Install all required packages and gems.
@@ -284,11 +286,29 @@
_Note: this step in only needed for creating Oxidized's configuration file and can be skipped if you already have it
```
docker run --rm -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest oxidized
```
+If the RESTful API and Web Interface are enabled, on the docker host running the container
+edit /etc/oxidized/config and modify 'rest: 127.0.0.1:8888' by 'rest: 0.0.0.0:8888'
+this will bind port 8888 to all interfaces then expose port out. (Issue #445)
+You can also use docker-compose to launch oxidized container:
+```
+# docker-compose.yml
+# docker-compose file example for oxidized that will start along with docker daemon
+oxidized:
+ restart: always
+ image: oxidized/oxidized:latest
+ ports:
+ - 8888:8888/tcp
+ environment:
+ CONFIG_RELOAD_INTERVAL: 600
+ volumes:
+ - /etc/oxidized:/root/.config/oxidized
+```
+
create the `/etc/oxidized/router.db`
```
vim /etc/oxidized/router.db
```
@@ -345,14 +365,14 @@
Device models can contain substitution filters to remove potentially sensitive data from configs.
As a partial example from ios.rb:
-```
+```
cmd :secret do |cfg|
cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
- (...)
+ (...)
cfg
end
```
The above strips out snmp community strings from your saved configs.
@@ -414,13 +434,13 @@
default: sql
sql:
adapter: mysql2
database: oxidized
table: nodes
- username: root
+ username: root
password: rootpass
map:
- name: ip
+ name: ip
model: model
username: username
password: password
vars_map:
enable: enable