oxidized 0.32.1 → 0.34.0

data/docs/Configuration.md

@@ -2,9 +2,15 @@
 
 ## 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.
+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-Address>-<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!
+The following example will log an active ssh/telnet session
+`/home/oxidized/.config/oxidized/log/<IP-Address>-<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!
 
 ```yaml
 log: /home/oxidized/.config/oxidized/log
@@ -22,7 +28,9 @@ input:
 
 ## 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.
+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:
@@ -31,14 +39,17 @@ vars:
 
 ## Removing secrets
 
-To strip out secrets from configurations before storing them, Oxidized needs the `remove_secret` flag. You can globally enable this by adding the following snippet to the global section of the configuration file.
+To strip out secrets from configurations before storing them, Oxidized needs the
+`remove_secret` flag. You can globally enable this by adding the following
+snippet to the global section of the configuration file.
 
 ```yaml
 vars:
   remove_secret: true
 ```
 
-Device models that contain substitution filters to remove sensitive data will now be run on any fetched configuration.
+Device models that contain substitution filters to remove sensitive data will
+now be run on any fetched configuration.
 
 As a partial example from ios.rb:
 
@@ -56,7 +67,9 @@ 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
@@ -66,7 +79,11 @@ vars:
 
 ## Disabling SSH keepalives
 
-Oxidized SSH input makes use of SSH keepalives to prevent timeouts from slower devices and to quickly tear down stale sessions in larger deployments. There have been reports of SSH keepalives breaking compatibility with certain OS types. They can be disabled using the `ssh_no_keepalive` variable on a per-node basis (by specifying it in the source) or configured application-wide.
+Oxidized SSH input makes use of SSH keepalives to prevent timeouts from slower
+devices and to quickly tear down stale sessions in larger deployments. There
+have been reports of SSH keepalives breaking compatibility with certain OS
+types. They can be disabled using the `ssh_no_keepalive` variable on a per-node
+basis (by specifying it in the source) or configured application-wide.
 
 ```yaml
 vars:
@@ -84,9 +101,12 @@ vars:
 
 ## Public Key Authentication with SSH
 
-Instead of password-based login, Oxidized can make use of key-based SSH authentication.
+Instead of password-based login, Oxidized can make use of key-based SSH
+authentication.
 
-You can tell Oxidized to use one or more private keys globally, or specify the key to be used on a per-node basis. The latter can be done by mapping the `ssh_keys` variable through the active source.
+You can tell Oxidized to use one or more private keys globally, or specify the
+key to be used on a per-node basis. The latter can be done by mapping the
+`ssh_keys` variable through the active source.
 
 Global:
 
@@ -108,7 +128,8 @@ vars_map:
 # ...
 ```
 
-If you are using a non-standard path, especially when copying the private key via a secured channel, make sure that the permissions are set correctly:
+If you are using a non-standard path, especially when copying the private key
+via a secured channel, make sure that the permissions are set correctly:
 
 ```bash
 foo@bar:~$ ls -la ~/.ssh/
@@ -120,15 +141,20 @@ drwx------ 5 oxidized oxidized 4096 Mar 13 21:40 ..
 -rw-r--r-- 1 oxidized oxidized   94 Mar 13 17:02 id_ed25519.pub
 ```
 
-Finally, multiple private keys can be specified as an array of file paths, such as `["~/.ssh/id_rsa", "~/.ssh/id_another_rsa"]`.
+Finally, multiple private keys can be specified as an array of file paths, such
+as `["~/.ssh/id_rsa", "~/.ssh/id_another_rsa"]`.
 
 ## SSH Proxy Command
 
-Oxidized can `ssh` through a proxy as well. To do so we just need to set `ssh_proxy` variable with the proxy host information and optionally set the `ssh_proxy_port` with the SSH port if it is not listening on port 22.
+Oxidized can `ssh` through a proxy as well. To do so we just need to set
+`ssh_proxy` variable with the proxy host information and optionally set the
+`ssh_proxy_port` with the SSH port if it is not listening on port 22.
 
-This can be provided on a per-node basis by mapping the proper fields from your source.
+This can be provided on a per-node basis by mapping the proper fields from your
+source.
 
-An example for a `csv` input source that maps the 4th field as the `ssh_proxy` value and the 5th field as `ssh_proxy_port`.
+An example for a `csv` input source that maps the 4th field as the `ssh_proxy`
+value and the 5th field as `ssh_proxy_port`.
 
 ```yaml
 # ...
@@ -144,9 +170,12 @@ vars_map:
 
 ## SSH enabling legacy algorithms
 
-When connecting to older firmware over SSH, it is sometimes necessary to enable legacy/disabled settings like KexAlgorithms, HostKeyAlgorithms, MAC or the Encryption.
+When connecting to older firmware over SSH, it is sometimes necessary to enable
+legacy/disabled settings like KexAlgorithms, HostKeyAlgorithms, MAC or the
+Encryption.
 
-These settings can be provided on a per-node basis by mapping the ssh_kex, ssh_host_key, ssh_hmac and the ssh_encryption fields from you source.
+These settings can be provided on a per-node basis by mapping the ssh_kex,
+ssh_host_key, ssh_hmac and the ssh_encryption fields from you source.
 
 ```yaml
 # ...
@@ -164,7 +193,9 @@ 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 - this will make use of FTP active 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 - this will make
+use of FTP active mode.
 
 ```yaml
 input:
@@ -207,7 +238,21 @@ crash:
 vars:
   enable: S3cr3tx
 groups: {}
-rest: 127.0.0.1:8888
+extensions:
+  oxidized-web:
+    load: true
+    # Bind to any IPv4 interface
+    listen: 0.0.0.0
+    # Bind to port 8888 (default)
+    port: 8888
+    # Prefix prod to the URL, so http://oxidized.full.domain/prod/
+    url_prefix: prod
+    # virtual hosts to listen to (others will be denied)
+    vhosts:
+      - localhost
+      - 127.0.0.1
+      - oxidized
+      - oxidized.full.domain
 pid: ~/.config/oxidized/oxidized.pid
 input:
   default: ssh, telnet
@@ -337,35 +382,99 @@ From least to most important:
 
 More important options overwrite less important ones if they are set.
 
-## RESTful API and Web Interface
+## oxidized-web: RESTful API and web interface
+
+The RESTful API and web interface are enabled by installing the `oxidized-web`
+gem and configuring the `extensions.oxidized-web:` section in the configuration
+file. You can set the following parameter:
+- `load`: `true`/`false`: Enables or disables the `oxidized-web` extension
+  (default: `false`)
+- `listen`: Specifies the interface to bind to (default: `127.0.0.1`). Valid
+  options:
+  - `127.0.0.1`: Allows IPv4 connections from localhost only
+  - `'[::1]'`: Allows IPv6 connections from localhost only
+  - `<IPv4-Address>` or `'[<IPv6-Address>]'`: Binds to a specific interface
+  - `0.0.0.0`: Binds to any IPv4 interface
+  - `'[::]'`:  Binds to any IPv4 and IPv6 interface
+- `port`: Specifies the TCP port to listen to (default: `8888`)
+- `url_prefix`: Defines a URL prefix (default: no prefix)
+- `vhosts`: A list of virtual hosts to listen to. If not specified, it will
+  respond to any virtual host.
+
+> [!NOTE]
+> The old syntax `rest: 127.0.0.1:8888/prefix` is still supported but
+> deprecated. It produces a warning and won't be suported in future releases.
+>
+> If the `rest` configuration is used, the extensions.oxidized-web will be
+> ignored.
+
+> [!NOTE]
+> You need oxidized-web version 0.16.0 or later to use the
+> extentions.oxidized-web configuration
 
-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://[::1]:8888/
-rest: "[::1]:8888"
+extensions:
+  oxidized-web:
+    load: true
+    listen: '[::1]'
+    port: 8888
 ```
 
 ```yaml
 # Listen on http://127.0.0.1:8888/
-rest: 127.0.0.1:8888
+extensions:
+  oxidized-web:
+    load: true
+    listen: 127.0.0.1
+    port: 8888
 ```
 
 ```yaml
 # Listen on http://[2001:db8:0:face:b001:0:dead:beaf]:8888/oxidized/
-rest: "[2001:db8:0:face:b001:0:dead:beaf]:8888"
+extensions:
+  oxidized-web:
+    load: true
+    listen: '[2001:db8:0:face:b001:0:dead:beaf]'
+    port: 8888
+    url_prefix: oxidized
 ```
 
 ```yaml
 # Listen on http://10.0.0.1:8000/oxidized/
-rest: 10.0.0.1:8000/oxidized
+extensions:
+  oxidized-web:
+    load: true
+    listen: 10.0.0.1
+    port: 8000
+    url_prefix: oxidized
+```
+
+```yaml
+# Listen on any interface to http://oxidized.rocks:8888 and
+# http://oxidized:8888
+extensions:
+  oxidized-web:
+    load: true
+    listen: '[::]'
+    url_prefix: oxidized
+    vhosts:
+     - oxidized.rocks
+     - oxidized
 ```
 
 ## Triggered backups
 
-A node can be moved to head-of-queue via the REST API `GET/POST /node/next/[NODE]`. This can be useful to immediately schedule a fetch of the configuration after some other event such as a syslog message indicating a configuration update on the device.
+A node can be moved to head-of-queue via the REST API `GET/PUT
+/node/next/[NODE]`. This can be useful to immediately schedule a fetch of the
+configuration after some other event such as a syslog message indicating a
+configuration update on the device.
 
-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 automatically:
+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
+automatically:
 
 ```yaml
 next_adds_job: true
@@ -375,7 +484,10 @@ This will allow for a more timely fetch of the device configuration.
 
 ## Disabling DNS resolution
 
-In some instances it might not be desirable to attempt to resolve names of nodes. One such use case is when nodes are accessed through an SSH proxy, where the remote end resolves the names differently than the host on which Oxidized runs would.
+In some instances it might not be desirable to attempt to resolve names of
+nodes. One such use case is when nodes are accessed through an SSH proxy, where
+the remote end resolves the names differently than the host on which Oxidized
+runs would.
 
 Names can instead be passed verbatim to the input:
 
@@ -389,3 +501,100 @@ You can use some environment variables to change default root directories values
 
 * `OXIDIZED_HOME` may be used to set oxidized configuration directory, which defaults to `~/.config/oxidized`
 * `OXIDIZED_LOGS` may be used to set oxidzied logs and crash directories root, which default to `~/.config/oxidized`
+
+## Logging
+Oxidized supports parallel logging to different systems (appenders). The
+following appenders are currently supported:
+- `stderr`: log to standard error (this is the default)
+- `stdout`: log to standard output
+- `file`: log to a file
+- `syslog`: log to syslog
+
+> `stderr` and `stdout` are mutually exclusive and will produce a warning if used
+> simultaneously.
+
+> Note: `syslog` currently produces two timestamps because of an issue in
+> [Sematic Logger](https://github.com/reidmorrison/semantic_logger/issues/316).
+
+> You can configure as many file appenders as you wish.
+
+You can set a log level globally and/or for each appender.
+- The global log level will limit which log messages are accepted, depending
+  on their level.
+  - The default global log level is `:info`.
+  - If you set `debug: true` in the configuration, the global log level will be
+    forced to `:debug`.
+- The appender log level limits which log messages are displayed by the
+  appender, depending on their level.
+  - The default is `:trace`.
+
+
+> Available log levels: `:trace`, `:debug`, `:info`, `:warn`,
+> `:error` and `:fatal`
+
+Here is a configuration example logging `:error` to syslog, `:warn` to stdout
+and `:info` to `~/.config/oxidized/info.log`:
+
+```yaml
+logger:
+  # Default level
+  # level: :info
+  appenders:
+    - type: syslog
+      level: :error
+    - type: stdout
+      level: :warn
+    - type: file
+      # Default level is :trace, so we get the logs in the default level (:info)
+      file: ~/.config/oxidized/info.log
+```
+
+If you want to log :trace to a file and `:info` to stdout, you must set the
+global log level to `:trace`, and limit the stdout appender to `:info`:
+
+```yaml
+logger:
+  level: :trace
+  appenders:
+    - type: stdout
+      level: :info
+    - type: file
+      file: ~/.config/oxidized/trace.log
+```
+
+### Change log level
+You can change the global log level of oxidized by sending a SIGUSR2 to
+the process:
+```
+kill -SIGUSR2 424242
+```
+It will rotate between the log levels and log a warning with the new level
+(you won't see the warning when the log level is `:fatal` or `:error`):
+```
+2025-06-30 15:25:27.972881 W [109750:2640] SemanticLogger -- Changed global default log level to :warn
+```
+
+If you specified a log level for an appender, this log level won't be
+changed.
+
+> :warning: **Warning** This currently does not work when oxidized-web is used
+> and will kill the whole oxidized application. This will be corrected in a
+> future release of oxidized-web.
+
+### Dump running threads
+With the SIGTTIN signal, oxidized will log a backtrace for each of its threads.
+```
+kill -SIGTTIN 424242
+```
+
+The threads used to fetch the configs are named `Oxidized::Job 'hostname'`:
+
+```
+2025-06-30 15:32:22.293047 W [110549:2640 core.rb:76] Thread Dump -- Backtrace:
+/home/xxx/oxidized/lib/oxidized/core.rb:76:in `sleep'
+/home/xxx/oxidized/lib/oxidized/core.rb:76:in `block in run'
+(...)
+2025-06-30 15:32:22.293409 W [110549:Oxidized::Job 'host2' ssh.rb:127] Thread Dump -- Backtrace:
+/home/xxx/oxidized/lib/oxidized/input/ssh.rb:127:in `sleep'
+/home/xxx/oxidized/lib/oxidized/input/ssh.rb:127:in `block (2 levels) in expect'
+```

data/docs/DeviceSimulation.md

@@ -21,7 +21,7 @@ information is the responses to the commands used in the Oxidized models.
 
 The YAML simulation files are stored under
 [/spec/model/data/](/spec/model/data/), with the naming convention
-`<model>:<description>:simulation.yaml`, where `<model>` is the lowercase name
+`<model>#<description>#simulation.yaml`, where `<model>` is the lowercase name
 of the Oxidized model and `<description>` is the name of the test case.
 `<description>` is generally formatted as `<hardware>_<software>` or
 `<hardware>_<software>_<information>`.
@@ -61,6 +61,7 @@ Usages:
     -o, --output file                Specify an output YAML-file
     -t, --timeout value              Specify the idle timeout beween commands (default: 5 seconds)
     -e, --exec-mode                  Run ssh in exec mode (without tty)
+    -u, --unordered                  The YAML simulation should not enforce an order of the commands
     -h, --help                       Print this help
 ```
 
@@ -80,10 +81,16 @@ output of the command is shortened or slips into the next command in the YAML
 file. You will have to change the idle timeout to a greater value to address
 this.
 - When run without the output argument, `device2yaml.rb` will only print the SSH
-output to the standard output. You must use `-o <model:HW_SW:simulation.yaml>`
+output to the standard output. You must use `-o <model#HW_SW#simulation.yaml>`
 to store the collected data in a YAML file.
 - If your Oxidized model uses SSH exec mode (look for `exec true` in the model),
 you will have to use the option `-e` to run `device2yaml.rb` in SSH exec mode.
+- The default behavior is to create a YAML file in which the commands must
+  appear in the order used in the Oxidized model. This is useful for simulating
+  devices that paginate output. To allow any order or include more commands than
+  the model uses, use the option `-u`. Note that the `unordered` mode may not
+  produce a useful YAML file when combined with user input (see
+  [Interactive Mode](#interactive-mode) below).
 
 Note that `device2yaml.rb` takes some time to run because of the idle timeout of
 (default) 5 seconds between each command. You can press the "Escape" key if you
@@ -100,7 +107,7 @@ show version
 show vtp status
 show inventory
 show running-config
-exit" -o spec/model/data/ios:C8200L_16.12.1:simulation.yaml
+exit" -o spec/model/data/ios#C8200L_16.12.1#simulation.yaml
 ```
 ### Publishing the YAML Simulation File to Oxidized
 Publishing the YAML simulation file of your device helps maintain Oxidized. This
@@ -124,7 +131,7 @@ change the hostname everywhere.
 
 The YAML simulation files are stored under
 [/spec/model/data/](/spec/model/data/), with the naming convention
-`<model>:<description>:simulation.yaml`, where `<model>` is the lowercase name
+`<model>#<description>#simulation.yaml`, where `<model>` is the lowercase name
 of the Oxidized model and `<description>` is the name of the test case.
 `<description>` is generally formatted as `<hardware>_<software>` or
 `<hardware>_<software>_<information>`.
@@ -134,9 +141,9 @@ automatic model unit tests.
 
 Examples:
 
-- spec/model/data/aoscx:R0X25A-6410_FL.10.10.1100:simulation.yaml
-- spec/model/data/asa:5512_9.12-4-67_single-context:simulation.yaml
-- spec/model/data/ios:C9200L-24P-4G_17.09.04a:simulation.yaml
+- spec/model/data/aoscx#R0X25A-6410_FL.10.10.1100#simulation.yaml
+- spec/model/data/asa#5512_9.12-4-67_single-context#simulation.yaml
+- spec/model/data/ios#C9200L-24P-4G_17.09.04a#simulation.yaml
 
 When you are finished, commit and push to your forked repository on GitHub, and
 submit a Pull Request. Thank you for your help!
@@ -153,6 +160,11 @@ page.
 
 You can also use this to enter an enable password.
 
+Every key press will be recorded in the YAML file, so that it can be used
+in the simulation afterwards, especialy for devices that paginate output. You
+may need to clean the YAML file manually if you don't want some input (such
+as passwords) to be included.
+
 If you press the "Esc" key, `device2yaml.rb` will not wait for the idle timeout
 and will process the next command right away.