diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 80 |
1 files changed, 76 insertions, 4 deletions
@@ -1,5 +1,9 @@ # 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) +** Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!** + +[WANTED: MAINTAINER](#help-needed) + Oxidized is a network device configuration backup tool. It's a RANCID replacement! * automatically adds/removes threads to meet configured retrieval interval @@ -66,6 +70,11 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * [C4CMTS](lib/oxidized/model/c4cmts.rb) * Aruba * [AOSW](lib/oxidized/model/aosw.rb) + * AudioCodes + * [AudioCodes](lib/oxdized/model/audiocodes.rb) + * Avaya + * [VOSS (VSP Operating System Software)](lib/oxidized/model/voss.rb) + * [BOSS (Baystack Operating System Software)](lib/oxidized/model/boss.rb) * Brocade * [FabricOS](lib/oxidized/model/fabricos.rb) * [Ironware](lib/oxidized/model/ironware.rb) @@ -81,12 +90,15 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * Cisco * [AireOS](lib/oxidized/model/aireos.rb) * [ASA](lib/oxidized/model/asa.rb) + * [AsyncOS](lib/oxidized/model/asyncos.rb) * [CatOS](lib/oxidized/model/catos.rb) * [IOS](lib/oxidized/model/ios.rb) * [IOSXR](lib/oxidized/model/iosxr.rb) * [NGA](lib/oxidized/model/cisconga.rb) * [NXOS](lib/oxidized/model/nxos.rb) + * [SMA](lib/oxidized/model/ciscosma.rb) * [SMB (Nikola series)](lib/oxidized/model/ciscosmb.rb) + * [UCS](lib/oxidized/model/ucs.rb) * Citrix * [NetScaler (Virtual Applicance)](lib/oxidized/model/netscaler.rb) * Coriant (former Tellabs) @@ -96,6 +108,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * [Linux](lib/oxidized/model/cumulus.rb) * DataCom * [DmSwitch 3000](lib/oxidized/model/datacom.rb) + * DCN + * [DCN](lib/oxidized/model/ios.rb) - Map this to ios. * DELL * [PowerConnect](lib/oxidized/model/powerconnect.rb) * [AOSW](lib/oxidized/model/aosw.rb) @@ -104,8 +118,9 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * Ericsson/Redback * [IPOS (former SEOS)](lib/oxidized/model/ipos.rb) * Extreme Networks - * [XOS](lib/oxidized/model/xos.rb) + * [Enterasys](/lib/oxidized/model/enterasys.rb) * [WM](lib/oxidized/model/mtrlrfs.rb) + * [XOS](lib/oxidized/model/xos.rb) * F5 * [TMOS](lib/oxidized/model/tmos.rb) * Force10 @@ -117,6 +132,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * [PRIMERGY Blade switch 1/10Gbe](lib/oxidized/model/fujitsupy.rb) * Hatteras * [Hatteras](lib/oxidized/model/hatteras.rb) + * Hirschmann + * [HiOS](lib/oxidized/model/hirschmann.rb) * HP * [Comware (HP A-series, H3C, 3Com)](lib/oxidized/model/comware.rb) * [Procurve](lib/oxidized/model/procurve.rb) @@ -137,6 +154,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * MRV * [MasterOS](lib/oxidized/model/masteros.rb) * [FiberDriver](lib/oxidized/model/fiberdriver.rb) + * Netgear + * [Netgear](lib/oxidized/model/netgear.rb) * Netonix * [WISP Switch (As Netonix)](lib/oxidized/model/netonix.rb) * Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent) @@ -165,6 +184,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen * [EdgeSwitch](lib/oxidized/model/edgeswitch.rb) * Watchguard * [Fireware OS](lib/oxidized/model/firewareos.rb) + * Westell + * [Westell 8178G, Westell 8266G](lib/oxidized/model/weos.rb) * Zhone * [Zhone (OLT and MX)](lib/oxidized/model/zhoneolt.rb) * Zyxel @@ -838,6 +859,22 @@ map: name: 1 group: 2 ``` +For model specific credentials + +``` +models: + junos: + username: admin + password: password + ironware: + username: admin + password: password + vars: + enable: enablepassword + apc_aos: + username: apc + password: password +``` ### Triggered backups @@ -872,6 +909,7 @@ Command is executed with the following environment: ``` OX_EVENT OX_NODE_NAME +OX_NODE_IP OX_NODE_FROM OX_NODE_MSG OX_NODE_GROUP @@ -989,6 +1027,9 @@ hooks: channel: "#network-changes" ``` +Note the channel name must be in quotes. + + # Extra ## Ubuntu SystemV init setup @@ -1014,11 +1055,9 @@ chown oxidized:oxidized /var/run/oxidized 3.)Make oxidized start on boot ``` -update-rc.d oxidized deafults +update-rc.d oxidized defaults ``` -Note the channel name must be in quotes. - # Ruby API The following objects exist in Oxidized. @@ -1052,6 +1091,39 @@ The following objects exist in Oxidized. * 'junos', 'ios', 'ironware' and 'powerconnect' implemented +# Help Needed + +As things stand right now, `oxidized` is maintained by a single person. A great +many [contributors](https://github.com/ytti/oxidized/graphs/contributors) have +helped further the software, however contributions are not the same as ongoing +owner- and maintainership. It appears that many companies use the software to +manage their network infrastructure, this is great news! But without additional +help to maintain the software and put out releases, the future of oxidized +might be less bright. The current pace of development and the much needed +refactoring simply are not sustainable if they are to be driven by a single +person. + +## Maintainer duties and expectations + +* 4 hours per week to perform triage on issues, review pull requests and help answer any questions from users. +* Above average knowledge of the Ruby programming language. +* Professional experience with both oxidized and some other config backup tool (like rancid). +* Ability to keep a cool head, and enjoy interaction with end users! :) +* A desire and passion to help drive `oxidized` towards its `1.x.x` stage of life + * help refactor the code + * rework the core infrastructure +* Permission from your employer to contribute to open source projects + +## YES, I WANT TO HELP + +Awesome! Simply send an email to Saku Ytti <saku@ytti.fi>. + +## Further reading + +Brian Anderson (from Rust fame) wrote an [excellent +post](http://brson.github.io/2017/04/05/minimally-nice-maintainer) on what it +means to be a maintainer. + # License and Copyright Copyright 2013-2015 Saku Ytti <saku@ytti.fi> |