From f720682514df9f49d35e6ced8af41e5dc789f8e0 Mon Sep 17 00:00:00 2001 From: Neil Lathwood Date: Thu, 9 Nov 2017 22:28:49 +0000 Subject: docs: Added comment to clarify interval value is in seconds (#1093) --- docs/Configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Configuration.md') diff --git a/docs/Configuration.md b/docs/Configuration.md index df0caa4..db71bc7 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -83,7 +83,7 @@ Below is an advanced example configuration. You will be able to (optionally) ove username: oxidized password: S3cr3tx model: junos -interval: 3600 +interval: 3600 #interval in seconds log: ~/.config/oxidized/log debug: false threads: 30 -- cgit v1.2.1 From 4e59878052f0668f4dde2282e86882626936f6b4 Mon Sep 17 00:00:00 2001 From: KodApa85 Date: Thu, 25 Jan 2018 22:01:39 +0000 Subject: model: Fixed FTP Passive/Active modes & Xyzel XGS4600 series Docs (#1161) * FTP Passive/Active mode added * Documentation for Xyzel XGS4600 series --- docs/Configuration.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/Configuration.md') diff --git a/docs/Configuration.md b/docs/Configuration.md index db71bc7..e2db05e 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -74,6 +74,15 @@ vars_map: ... ``` +### FTP Passive Mode + +Oxidized uses ftp passive mode by default. Some devices require passive mode to be disabled. To do so, we can set `input.ftp.passive` to false +``` +input: + ftp: + passive: false +``` + ### Advanced Configuration 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. -- cgit v1.2.1 From 87600b1f5f12711afe29c408e02dbbd927e3f25d Mon Sep 17 00:00:00 2001 From: Wild Kat Date: Mon, 12 Mar 2018 00:19:20 +0100 Subject: Lint and standardize markdown documentation --- docs/Configuration.md | 58 ++++++++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 26 deletions(-) (limited to 'docs/Configuration.md') diff --git a/docs/Configuration.md b/docs/Configuration.md index e2db05e..59e3f6d 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,10 +1,12 @@ -## Configuration -### Debugging +# Configuration + +## Debugging + 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/-`. The file will be truncated on each consecutive ssh/telnet session, so you need to put a `tailf` or `tail -f` on that file! -``` +```yaml log: /home/oxidized/.config/oxidized/log ... @@ -16,20 +18,20 @@ input: secure: false ``` -### Privileged mode +## Privileged mode 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. -``` +```yaml vars: enable: S3cre7 ``` -### Removing secrets +## Removing secrets 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. -``` +```yaml vars: remove_secret: true ``` @@ -38,32 +40,33 @@ Device models can contain substitution filters to remove potentially sensitive d As a partial example from ios.rb: -``` +```yaml cmd :secret do |cfg| cfg.gsub! /^(snmp-server community).*/, '\\1 ' (...) 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. -### Disabling SSH exec channels +## Disabling SSH exec channels 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. -``` +```yaml vars: ssh_no_exec: true ``` -### SSH Proxy Command +## SSH Proxy Command Oxidized can `ssh` through a proxy as well. To do so we just need to set `ssh_proxy` variable. -``` +```yaml ... map: name: 0 @@ -74,20 +77,21 @@ vars_map: ... ``` -### FTP Passive Mode +## FTP Passive Mode Oxidized uses ftp passive mode by default. Some devices require passive mode to be disabled. To do so, we can set `input.ftp.passive` to false -``` + +```yaml input: ftp: passive: false ``` -### Advanced Configuration +## Advanced Configuration 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. -``` +```yaml --- username: oxidized password: S3cr3tx @@ -130,14 +134,13 @@ source: model_map: cisco: ios juniper: junos - ``` -### Advanced Group Configuration +## Advanced Group Configuration For group specific credentials -``` +```yaml groups: mikrotik: username: admin @@ -146,16 +149,19 @@ groups: username: ubnt password: ubnt ``` + and add group mapping -``` + +```yaml map: model: 0 name: 1 group: 2 ``` + For model specific credentials -``` +```yaml models: junos: username: admin @@ -170,26 +176,26 @@ models: password: password ``` -### RESTful API and Web Interface +## RESTful API and Web Interface 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. -``` +```yaml # Listen on http://127.0.0.1:8888/ rest: 127.0.0.1:8888 ``` -``` +```yaml # Listen on http://10.0.0.1:8000/oxidized/ rest: 10.0.0.1:8000/oxidized ``` -### Triggered backups +## Triggered backups 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: -``` +```yaml next_adds_job: true ``` -- cgit v1.2.1 From 720facc6f80d2b977d73b944c81c63b6d95e768b Mon Sep 17 00:00:00 2001 From: Wild Kat Date: Fri, 16 Mar 2018 20:31:09 +0100 Subject: improve spelling in docs --- docs/Configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Configuration.md') diff --git a/docs/Configuration.md b/docs/Configuration.md index 59e3f6d..6bbbb61 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -54,7 +54,7 @@ The above strips out snmp community strings from your saved configs. ## Disabling SSH exec channels -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` +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. ```yaml -- cgit v1.2.1