In case a model plugin doesn't work correctly (ios, procurve, etc.), you can enable live debugging of SSH/Telnet sessions. Just add a debug
option containing the value true to the input
section. The log files will be created depending on the parent directory of the logfile option.
The following example will log an active ssh/telnet session /home/oxidized/.config/oxidized/log/<IP-Adress>-<PROTOCOL>
. The file will be truncated on each consecutive ssh/telnet session, so you need to put a tailf
or tail -f
on that file!
log: /home/oxidized/.config/oxidized/log
...
input:
default: ssh, telnet
debug: true
ssh:
secure: false
To start privileged mode before pulling the configuration, Oxidized needs to send the enable command. You can globally enable this, by adding the following snippet to the global section of the configuration file.
vars:
enable: S3cre7
To strip out secrets from configurations before storing them, Oxidized needs the the remove_secrets flag. You can globally enable this by adding the following snippet to the global sections of the configuration file.
vars:
remove_secret: true
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.
NOTE: Removing secrets reduces the usefulness as a full configuration backup, but it may make sharing configs easier.
Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices. This feature can be turned off by setting the ssh_no_exec
variable.
vars:
ssh_no_exec: true
Oxidized can ssh
through a proxy as well. To do so we just need to set ssh_proxy
variable.
...
map:
name: 0
model: 1
vars_map:
enable: 2
ssh_proxy: 3
...
Below is an advanced example configuration. You will be able to (optionally) override options per device. The router.db format used is hostname:model:username:password:enable_password
. Hostname and model will be the only required options, all others override the global configuration sections.
---
username: oxidized
password: S3cr3tx
model: junos
interval: 3600 #interval in seconds
log: ~/.config/oxidized/log
debug: false
threads: 30
timeout: 20
retries: 3
prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
vars:
enable: S3cr3tx
groups: {}
rest: 127.0.0.1:8888
pid: ~/.config/oxidized/oxidized.pid
input:
default: ssh, telnet
debug: false
ssh:
secure: false
output:
default: git
git:
user: Oxidized
email: [email protected]
repo: "~/.config/oxidized/oxidized.git"
source:
default: csv
csv:
file: ~/.config/oxidized/router.db
delimiter: !ruby/regexp /:/
map:
name: 0
model: 1
username: 2
password: 3
vars_map:
enable: 4
model_map:
cisco: ios
juniper: junos
For group specific credentials
groups:
mikrotik:
username: admin
password: blank
ubiquiti:
username: ubnt
password: ubnt
and add group mapping
map:
model: 0
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
The RESTful API and Web Interface is enabled by configuring the rest:
parameter in the config file. This parameter can optionally contain a relative URI.
# Listen on http://127.0.0.1:8888/
rest: 127.0.0.1:8888
# Listen on http://10.0.0.1:8000/oxidized/
rest: 10.0.0.1:8000/oxidized
A node can be moved to head-of-queue via the REST API GET/POST /node/next/[NODE]
.
In the default configuration this node will be processed when the next job worker becomes available, it could take some time if existing backups are in progress. To execute moved jobs immediately a new job can be added:
next_adds_job: true