oxidized 0.20.0 → 0.21.0

data/docs/Ruby-API.md

@@ -0,0 +1,115 @@
+# Ruby API
+
+The following objects exist in Oxidized.
+
+## Input
+ * gets config from nodes
+ * must implement 'connect', 'get', 'cmd'
+ * 'ssh', 'telnet, ftp, and tftp' implemented
+
+## Output
+ * stores config
+ * must implement 'store' (may implement 'fetch')
+ * 'git' and 'file' (store as flat ascii) implemented
+
+## Source
+ * gets list of nodes to poll
+ * must implement 'load'
+ * source can have 'name', 'model', 'group', 'username', 'password', 'input', 'output', 'prompt'
+   * name - name of the devices
+   * model - model to use ios/junos/xyz, model is loaded dynamically when needed (Also default in config file)
+   * input - method to acquire config, loaded dynamically as needed (Also default in config file)
+   * output - method to store config, loaded dynamically as needed (Also default in config file)
+   * prompt - prompt used for node (Also default in config file, can be specified in model too)
+ * 'sql', 'csv' and 'http' (supports any format with single entry per line, like router.db)
+
+## Model
+### At the top level
+A model may use several methods at the top level in the class. `cfg` is
+executed in input/output/source context. `cmd` is executed within an instance
+of the model.
+
+#### `cfg`
+`cfg` may be called with a list of methods (`:ssh`, `:telnet`) and a block with
+zero parameters.  Calling `cfg` registers the given access methods and calling
+it at least once is required for a model to work.
+
+The block may contain commands to change some behaviour for the given methods
+(e.g. calling `post_login` to disable the pager).
+
+#### `cmd`
+Is used to specify commands that should be executed on a model in order to
+gather its configuration. It can be called with:
+
+* Just a string
+* A string and a block
+* `:all` and a block
+* `:secret` and a block
+
+The block takes a single parameter `cfg` containing the output of the command
+being processed.
+
+Calling `cmd` with just a string will emit the output of the command given in
+that string as configuration.
+
+Calling `cmd` with a string and a block will pass the output of the given
+command to the block, then emit its return value (that must be a string) as
+configuration.
+
+Calling `cmd` with `:all` and a block will pass all command output through this
+block before emitting it. This is useful if some cleanup is required of the
+output of all commands.
+
+Calling `cmd` with `:secret` and a block will pass all configuration to the
+given block before emitting it to hide secrets if secret hiding is enabled. The
+block should replace any secrets with `'<hidden>'` and return the resulting
+string.
+
+Execution order is `:all`, `:secret`, and lastly the command specific block, if
+given.
+
+#### `comment`
+Called with a single string containing the string to prepend for comments in
+emitted configuration for this model.
+
+If not specified the default of `'# '` will be used (note the trailing space).
+
+#### `prompt`
+Is called with a regular expression that is used to detect when command output
+ends after a command has been executed.
+
+If not specified, a default of `/^([\w.@-]+[#>]\s?)$/` is used.
+
+#### `expect`
+Called with a regular expression and a block. The block takes two parameters:
+the regular expression, and the data containing the match.
+
+The passed data is replaced by the return value of the block.
+
+`expect` can be used to, for example, strip escape sequences from output before
+it's further processed.
+
+### At the second level
+The following methods are available:
+
+#### `comment`
+Used inside `cmd` invocations. Comments out every line in the passed string and
+returns the result.
+
+#### `password`
+Used inside `cfg` invocations to specify the regular expression used to detect
+the password prompt. If not specified, the default of `/^Password/` is used.
+
+#### `post_login`
+Used inside `cfg` invocations to specify commands to run once Oxidized has
+logged in to the switch. Takes one argument that is either a block (taking zero
+parameters) or a string containing a command to execute.
+
+#### `pre_logout`
+Used to specify commands to run before Oxidized closes the connection to the
+switch. Takes one argument that is either a block (taking zero parameters) or a
+string containing a command to execute.
+
+#### `send`
+Usually used inside `expect` or blocks passed to `post_login`/`pre_logout`.
+Takes a single parameter: a string to be sent to the switch.

data/docs/Sources.md

@@ -0,0 +1,110 @@
+## Source
+
+### Source: CSV
+
+One line per device, colon seperated. If `ip` isn't present, a DNS lookup will be done against `name`.  For large installations, setting `ip` will dramatically reduce startup time.
+
+```
+source:
+  default: csv
+  csv:
+    file: /var/lib/oxidized/router.db
+    delimiter: !ruby/regexp /:/
+    map:
+      name: 0
+      ip: 1
+      model: 2
+      username: 3
+      password: 4
+    vars_map:
+      enable: 5
+```
+
+Example csv `/var/lib/oxidized/router.db`:
+
+```
+rtr01.local,192.168.1.1,ios,oxidized,5uP3R53cR3T,T0p53cR3t
+```
+
+### Source: SQL
+ Oxidized uses the `sequel` ruby gem. You can use a variety of databases that aren't explicitly listed. For more information visit https://github.com/jeremyevans/sequel Make sure you have the correct adapter!
+### Source: MYSQL
+
+`sudo apt-get install libmysqlclient-dev`
+
+The values correspond to your fields in the DB such that ip, model, etc are field names in the DB
+
+```
+source:
+  default: sql
+  sql:
+    adapter: mysql2
+    database: oxidized
+    table: nodes
+    user: root
+    password: rootpass
+    map:
+      name: ip
+      model: model
+      username: username
+      password: password
+    vars_map:
+      enable: enable
+```
+
+### Source: SQLite
+
+One row per device, filtered by hostname.
+
+```
+source:
+  default: sql
+  sql:
+    adapter: sqlite
+    database: "/var/lib/oxidized/devices.db"
+    table: devices
+    map:
+      name: fqdn
+      model: model
+      username: username
+      password: password
+    vars_map:
+      enable: enable
+```
+
+### Source: HTTP
+
+One object per device.
+
+HTTP Supports basic auth, configure the user and pass you want to use under the http: section.
+
+```
+source:
+  default: http
+  http:
+    url: https://url/api
+    scheme: https
+    delimiter: !ruby/regexp /:/
+    user: username
+    pass: password
+    map:
+      name: hostname
+      model: os
+      username: username
+      password: password
+    vars_map:
+      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
+```

data/docs/Supported-OS-Types.md

@@ -0,0 +1,149 @@
+# Supported OS types
+ * Vendor
+   * OS model
+ * A10 Networks
+   * [ACOS](/lib/oxidized/model/acos.rb)
+ * Accedian Performance Elements (NIDs)
+   * [AEN](/lib/oxidized/model/aen.rb)
+ * Alcatel-Lucent
+   * [AOS](/lib/oxidized/model/aos.rb)
+   * [AOS7](/lib/oxidized/model/aos7.rb)
+   * [ISAM](/lib/oxidized/model/isam.rb)
+   * [SR OS (Formerly TiMOS)](/lib/oxidized/model/timos.rb)
+   * Wireless
+ * Alvarion
+   * [BreezeACCESS](/lib/oxidized/model/alvarion.rb)
+ * APC
+   * [AOS](/lib/oxidized/model/apc_aos.rb)
+ * Arista
+   * [EOS](/lib/oxidized/model/eos.rb)
+ * Arris
+   * [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)
+   * [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
+   * [SAOS](/lib/oxidized/model/saos.rb)
+ * Cisco
+   * [ACSW](/lib/oxidized/model/acsw.rb)
+   * [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)
+   * [TMOS (8800)](/lib/oxidized/model/corianttmos.rb)
+   * [8600](/lib/oxidized/model/coriant8600.rb)
+   * [Groove](/lib/oxidized/model/coriantgroove.rb)
+ * Cumulus
+   * [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)
+ * D-Link
+   * [D-Link](/lib/oxidized/model/dlink.rb)
+ * Ericsson/Redback
+   * [IPOS (former SEOS)](/lib/oxidized/model/ipos.rb)
+ * Extreme Networks
+   * [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
+   * [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)
+ * 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)
+   * [BladeSystem (Onboard Administrator)](/lib/oxidized/model/hpebladesystem.rb)
+   * [MSA](/lib/oxidized/model/hpemsa.rb)
+ * Huawei
+   * [VRP](/lib/oxidized/model/vrp.rb)
+ * Juniper
+   * [JunOS](/lib/oxidized/model/junos.rb)
+   * [ScreenOS (Netscreen)](/lib/oxidized/model/screenos.rb)
+ * Mellanox
+   * [MLNX-OS](/lib/oxidized/model/mlnxos.rb)
+   * [Voltaire](/lib/oxidized/model/voltaire.rb)
+ * Mikrotik
+   * [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)
+ * Netgear
+   * [Netgear](/lib/oxidized/model/netgear.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)
+ * OneAccess
+   * [OneOS](/lib/oxidized/model/oneos.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)
+ * Radware
+   * [AlteonOS](/lib/oxidized/model/alteonos.rb)
+ * Quanta
+   * [Quanta / VxWorks 6.6 (1.1.0.8)](/lib/oxidized/model/quantaos.rb)
+ * Siklu
+   * [EtherHaul](/lib/oxidized/model/siklu.rb)
+ * Supermicro
+   * [Supermicro](/lib/oxidized/model/supermicro.rb)
+ * Symantec
+   * [Blue Coat ProxySG / Security Gateway OS (SGOS)](/lib/oxidized/model/sgos.rb)
+ * Trango Systems
+   * [Trango](/lib/oxidized/model/trango.rb)
+ * TPLink
+   * [TPLink](/lib/oxidized/model/tplink.rb)
+ * Ubiquiti
+   * [AirOS](/lib/oxidized/model/airos.rb)
+   * [Edgeos](/lib/oxidized/model/edgeos.rb)
+   * [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
+   * [ZyNOS](/lib/oxidized/model/zynos.rb)

data/docs/VRP-Huawei.md

@@ -0,0 +1,27 @@
+Huawei VRP Configuration
+========================
+
+Create a user with no privileges
+
+    <HUAWEI> system-view
+    [~HUAWEI] aaa
+    [~HUAWEI-aaa] local-user oxidized password irreversible-cipher verysecret
+    [*HUAWEI-aaa] local-user oxidized level 1
+    [*HUAWEI-aaa] local-user oxidized service-type terminal ssh
+    [*HUAWEI-aaa] commit
+
+The commands Oxidized executes are:
+
+1. screen-length 0 temporary
+2. display version
+3. display device
+4. display current-configuration all
+
+Command 2 and 3 can be executed without issues, but 1 and 4 are only available for higher level users. Instead of making Oxidized a read/write user on your device, lower the priviledge-level for commands 1 and 4:
+
+    <HUAWEI> system-view
+    [~HUAWEI] command-privilege level 1 view global display current-configuration all
+    [*HUAWEI] command-privilege level 1 view shell screen-length
+    [*HUAWEI] commit
+
+Oxidized can now retrieve your configuration!

data/extra/oxidized-report-git-commits

@@ -17,64 +17,45 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# 20170615 - Andre Sencioles <asenci@gmail.com>
+#            Removed requirement for Git working directory
+#            Check job status
+#
+#
 # usage: add the following hook to the oxidized config file:
 # 
 # hooks:
 #  email_output:
 #    type: exec
 #    events: [post_store, node_fail]
-#    cmd: '/home/oxidized/extra/oxidized-report-git-commits ~/gitdir/ | mail -s "Oxidized updates for ${OX_NODE_NAME}" update-recipient@example.com'
+#    cmd: '/home/oxidized/extra/oxidized-report-git-commits | mail -s "Oxidized updates for ${OX_NODE_NAME}" update-recipient@example.com'
 #    async: true
 #    timeout: 120
 # 
 #
-# The script takes a single argument, namely a git working directory name,
-# e.g.  "~/gitdir/".  This is only used as a staging directory and should
-# not be set to be the same as the git repo directory.
-#
 
-PATH=${PATH}:/usr/local/bin:/usr/local/sbin
-export PATH
+echo "Node name: ${OX_NODE_NAME}"
+echo "Group name: ${OX_NODE_GROUP}"
+echo "Job status: ${OX_JOB_STATUS}"
+echo "Job time: ${OX_JOB_TIME}"
 
-gitdir=$1
+if [ "${OX_EVENT}" = "node_fail" ]; then
+    echo 'Job failed'
+    exit 64
+fi
 
-if [ X${OX_REPO_COMMITREF} = "X" ]; then
-	echo \$OX_REPO_COMMITREF not set
+if [ -z "${OX_REPO_COMMITREF}" ]; then
+	echo '$OX_REPO_COMMITREF not set'
 	exit 64
 fi
 
-if [ X${OX_REPO_NAME} = "X" ]; then
-	echo \$OX_REPO_NAME not set
+if [ -z "${OX_REPO_NAME}" ]; then
+	echo '$OX_REPO_NAME not set'
 	exit 64
 fi
 	
-if [ ! -d ${gitdir}/.git ]; then
-	git clone -q ${OX_REPO_NAME} ${gitdir}
-
-	ret=$?
-	if [ X"${ret}" != X0 ] && [ X"${ret}" != X1 ]; then
-		echo git clone failed: aborting.
-		exit 128
-	fi
-fi
-
-cd ${gitdir}
-
-git pull -q > /dev/null 2>&1 
-ret=$?
-if [ X"${ret}" != X0 ] && [ X"${ret}" != X1 ]; then
-	echo git pull failed: aborting.
-	exit 128
-fi
-
-# Git is probably working at this stage, so safe to emit more info
-
-echo "Node name: ${OX_NODE_NAME}"
-echo "Group Name: ${OX_NODE_GROUP}"
-echo "Job Time: ${OX_JOB_TIME}"
-echo "Git Commit ID: ${OX_REPO_COMMITREF}"
-echo "Git Repo: ${OX_REPO_NAME}"
-echo "Local working dir: ${gitdir}"
+echo "Git repo: ${OX_REPO_NAME}"
+echo "Git commit ID: ${OX_REPO_COMMITREF}"
 echo ""
 
-git diff --no-color ${OX_REPO_COMMITREF}~1..${OX_REPO_COMMITREF}
+git --bare --git-dir="${OX_REPO_NAME}" show --pretty='' --no-color "${OX_REPO_COMMITREF}"