README.md in oxidized-0.18.0 vs README.md in oxidized-0.19.0
- old
+ new
@@ -68,10 +68,12 @@
* [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)
+ * Casa
+ * [Casa](lib/oxidized/model/casa.rb)
* Check Point
* [GaiaOS](lib/oxidized/model/gaiaos.rb)
* Ciena
* [SOAS](lib/oxidized/model/saos.rb)
* Cisco
@@ -92,10 +94,12 @@
* DataCom
* [DmSwitch 3000](lib/oxidized/model/datacom.rb)
* DELL
* [PowerConnect](lib/oxidized/model/powerconnect.rb)
* [AOSW](lib/oxidized/model/aosw.rb)
+ * D-Link
+ * [D-Link](lib/oxidized/model/dlink.rb)
* Ericsson/Redback
* [IPOS (former SEOS)](lib/oxidized/model/ipos.rb)
* Extreme Networks
* [XOS](lib/oxidized/model/xos.rb)
* [WM](lib/oxidized/model/mtrlrfs.rb)
@@ -104,13 +108,18 @@
* Force10
* [DNOS](lib/oxidized/model/dnos.rb)
* [FTOS](lib/oxidized/model/ftos.rb)
* FortiGate
* [FortiOS](lib/oxidized/model/fortios.rb)
+ * Fujitsu
+ * [PRIMERGY Blade switch 1/10Gbe](lib/oxidized/model/fujitsupy.rb)
+ * Hatteras
+ * [Hatteras](lib/oxidized/model/hatteras.rb)
* HP
* [Comware (HP A-series, H3C, 3Com)](lib/oxidized/model/comware.rb)
* [Procurve](lib/oxidized/model/procurve.rb)
+ * [BladeSystem (Onboard Administrator)](lib/oxidized/model/hpebladesystem.rb)
* Huawei
* [VRP](lib/oxidized/model/vrp.rb)
* Juniper
* [JunOS](lib/oxidized/model/junos.rb)
* [ScreenOS (Netscreen)](lib/oxidized/model/screenos.rb)
@@ -120,23 +129,27 @@
* [RouterOS](lib/oxidized/model/routeros.rb)
* Motorola
* [RFS](lib/oxidized/model/mtrlrfs.rb)
* MRV
* [MasterOS](lib/oxidized/model/masteros.rb)
+ * [FiberDriver](lib/oxidized/model/fiberdriver.rb)
* Netonix
* [WISP Switch (As Netonix)](lib/oxidized/model/netonix.rb)
* Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
* [SR OS (TiMOS)](lib/oxidized/model/timos.rb)
* Opengear
* [Opengear](lib/oxidized/model/opengear.rb)
* Palo Alto
* [PANOS](lib/oxidized/model/panos.rb)
+ * [PLANET SG/SGS Switches](lib/oxidized/model/planet.rb)
* [pfSense](lib/oxidized/model/pfsense.rb)
* Quanta
* [Quanta / VxWorks 6.6 (1.1.0.8)](lib/oxidized/model/quantaos.rb)
* Supermicro
* [Supermicro](lib/oxidized/model/supermicro.rb)
+ * Trango Systems
+ * [Trango](lib/oxidized/model/trango.rb)
* Ubiquiti
* [AirOS](lib/oxidized/model/airos.rb)
* [Edgeos](lib/oxidized/model/edgeos.rb)
* [EdgeSwitch](lib/oxidized/model/edgeswitch.rb)
* Watchguard
@@ -292,21 +305,21 @@
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.yml
# docker-compose file example for oxidized that will start along with docker daemon
oxidized:
restart: always
- image: oxidized/oxidized:latest
+ image: oxidized/oxidized:latest
ports:
- 8888:8888/tcp
environment:
CONFIG_RELOAD_INTERVAL: 600
volumes:
- - /etc/oxidized:/root/.config/oxidized
+ - /etc/oxidized:/root/.config/oxidized
```
create the `/etc/oxidized/router.db`
```
@@ -491,10 +504,21 @@
enable: enable
headers:
X-Auth-Token: 'somerandomstring'
```
+You can also pass `secure: false` if you want to disable ssl certificate verification:
+
+```
+source:
+ default: http
+ http:
+ url: https://url/api
+ scheme: https
+ secure: false
+```
+
### Output: File
Parent directory needs to be created manually, one file per device, with most recent running config.
```
@@ -788,9 +812,38 @@
events: [post_store]
remote_repo: git@git.intranet:oxidized/test.git
username: user
password: pass
```
+
+## Hook type: awssns
+
+The `awssns` hook publishes messages to AWS SNS topics. This allows you to notify other systems of device configuration changes, for example a config orchestration pipeline. Multiple services can subscribe to the same AWS topic.
+
+Fields sent in the message:
+
+ * `event`: Event type (e.g. `node_success`)
+ * `group`: Group name
+ * `model`: Model name (e.g. `eos`)
+ * `node`: Device hostname
+
+Configuration example:
+
+``` yaml
+hooks:
+ hook_script:
+ type: awssns
+ events: [node_fail,node_success,post_store]
+ region: us-east-1
+ topic_arn: arn:aws:sns:us-east-1:1234567:oxidized-test-backup_events
+```
+
+AWS SNS hook requires the following configuration keys:
+
+ * `region`: AWS Region name
+ * `topic_arn`: ASN Topic reference
+
+Your AWS credentials should be stored in `~/.aws/credentials`.
# Ruby API
The following objects exist in Oxidized.