oxidized 0.33.0 → 0.34.0

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.
 

data/docs/Docker.md

@@ -222,7 +222,9 @@ If not, a quick way to solve it is to delete `~/.local/share/containers/`.
 Beware - this will delete **all** your containers!
 
 ### Store the ssh keys a remote git repository
-When you user the githubrepo hook to upload your configs to a remote git repository, you have to store your ssh-key and the public keys of the remote server. Create a folder `~/oxidized-ssh` and map it to `/home/oxidized/.ssh`.
+When you use the githubrepo hook to upload your configs to a remote git
+repository, you have to store your ssh-key and the public keys of the remote
+server. Create a directory `~/oxidized-ssh` and map it to `/home/oxidized/.ssh`.
 
 
 To generate an ssh-key, run:
@@ -230,11 +232,14 @@ To generate an ssh-key, run:
 ssh-keygen -q -t ed25519 -C "Oxidized Push Key@`hostname`" -N "YOURPASSPHRASE" -m PEM -f ~/oxidized-ssh/oxidized-key
 ```
 
-You also need to store the public keys of the remote git server in known_hosts. If you do not,
-oxidized will refuse to push to the remote Git with the error `#<Rugged::SshError: invalid or unknown remote ssh hostkey>`, see Issue #2753.
+You also need to store the public keys of the remote git server in known_hosts.
+If you don't store the keys, oxidized will refuse to push to the remote Git with
+the error
+`#<Rugged::SshError: invalid or unknown remote ssh hostkey>`, see Issue #2753.
 
 ```shell
 ssh-keyscan git-server.example.com > ~/oxidized-ssh/known_hosts
 ```
 
-Don't forget to set the permission (owner) of the files for the user oxidized inside the container!
+Don't forget to set the permission (owner) of the files for the user oxidized
+inside the container, or this will not work!

data/docs/Issues.md

@@ -7,7 +7,8 @@ This guide provides tips on writing your issue to make it easier for the
 community and developers to understand and respond effectively.
 
 Why write good issues?
-- A clear and detailed issue improves the chances of getting your problem resolved.
+- A clear and detailed issue improves the chances of getting your problem
+  resolved.
 - By spending time to write a good issue, you save developers time, contributing
   to Oxidized’s progress without writing a line of code.
 
@@ -21,7 +22,7 @@ following rules:
   questions in the templates), expect your issue to be closed without a comment.
 - Inactive issues will be marked "stale" automatically after 90 days. Issues
   are not closed automatically; this is a manual action by a maintainer.
-- A feature requests may be closed after some time of inactivity, as obviously
+- A feature request may be closed after some time of inactivity, as obviously
   no one has found the time to implement it. Consider contributing code in a
   Pull Request instead.
 - While it is OK to ask for help (using the support request template), don't be
@@ -41,6 +42,13 @@ Choose the appropriate GitHub project based on your issue:
 - For issues with Oxidized itself, go to
   [oxidized](https://github.com/ytti/oxidized).
 
+## Use the latest version
+If you are using an old version of oxidized, you may encounter issues that have
+been solved. No support will be provided for older versions of oxidized.
+
+If you can, please also test against the latest git version, or at least read
+[CHANGELOG.md](/CHANGELOG.md) to see if your problem has been solved on master.
+
 ## Format your issue
 - Use [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format your issue.
 - Preview your text before submitting to ensure it renders correctly.
@@ -53,6 +61,7 @@ Keep the title brief yet descriptive. Aim to summarize the main issue or request
 Include as many relevant details as possible. At a minimum, specify:
 
 - Oxidized version and operating system.
+- Which model (oxidized name AND Manufacturer name) is the issue about.
 - Relevant parts of your Oxidized configuration and a brief explanation of your setup.
 - Output of the error, if relevant.
 - For issues related to specific devices, consider creating a YAML Simulation file (instructions below).

data/docs/ModelUnitTests.md

@@ -21,7 +21,7 @@ See the link for instructions on how to produce it.
 
 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>`.
@@ -31,17 +31,17 @@ automatic model unit tests.
 
 ### Expected Output
 You need a second file that contains the expected output, which has the same
-name as the YAML simulation file but ends with `:output.txt` instead of
-`:simulation.yaml`.
+name as the YAML simulation file but ends with `#output.txt` instead of
+`#simulation.yaml`.
 
 You can automatically produce an output file based on the current model for all
-YAML simulation files missing an `:output.txt`:
+YAML simulation files missing an `#output.txt`:
 ```shell
 bundle exec ruby spec/model/atoms_generate.rb
 ```
 
 In the following example,
-`spec/model/data/aoscx:R8N85A-C6000-48G-CL4_PL.10.08.1010:output.txt` (the
+`spec/model/data/aoscx#R8N85A-C6000-48G-CL4_PL.10.08.1010#output.txt` (the
 second file in the list) was missing:
 
 ```shell
@@ -50,21 +50,21 @@ Run options: --seed 57811
 
 # Running:
 
-Generating output file for aoscx:R0X25A-6410_FL.10.10.1100:simulation... SKIP, output already exists
-Generating output file for aoscx:R8N85A-C6000-48G-CL4_PL.10.08.1010:simulation... OK
-Generating output file for arubainstant:IAP515_8.10.0.6_VWLC:simulation... SKIP, output already exists
-Generating output file for asa:5512_9.12-4-67_single-context:simulation... SKIP, output already exists
-Generating output file for garderos:R7709_003_006_068:simulation... SKIP, output already exists
-Generating output file for ios:C8200L_16.12.1:simulation... FAIL, no simulation file
-Generating output file for ios:C9200L-24P-4G_17.09.04a:simulation... SKIP, output already exists
-Generating output file for ios:C9800-L-F-K9_17.06.05:simulation... SKIP, output already exists
-Generating output file for ios:asr920_16.8.1b:simulation... SKIP, output already exists
-Generating output file for junos:srx300_22.4:simulation... SKIP, output already exists
-Generating output file for opnsense:nano_23.7:simulation... SKIP, output already exists
-Generating output file for pfsense:CE_2.7.2:simulation... SKIP, output already exists
-Generating output file for routeros:CHR_7.10.1:simulation... SKIP, output already exists
-Generating output file for routeros:CHR_7.16:simulation... SKIP, output already exists
-Generating output file for routeros:L009UiGS_7.15.2:simulation... SKIP, output already exists
+Generating output file for aoscx#R0X25A-6410_FL.10.10.1100#simulation... SKIP, output already exists
+Generating output file for aoscx#R8N85A-C6000-48G-CL4_PL.10.08.1010#simulation... OK
+Generating output file for arubainstant#IAP515_8.10.0.6_VWLC#simulation... SKIP, output already exists
+Generating output file for asa#5512_9.12-4-67_single-context#simulation... SKIP, output already exists
+Generating output file for garderos#R7709_003_006_068#simulation... SKIP, output already exists
+Generating output file for ios#C8200L_16.12.1#simulation... FAIL, no simulation file
+Generating output file for ios#C9200L-24P-4G_17.09.04a#simulation... SKIP, output already exists
+Generating output file for ios#C9800-L-F-K9_17.06.05#simulation... SKIP, output already exists
+Generating output file for ios#asr920_16.8.1b#simulation... SKIP, output already exists
+Generating output file for junos#srx300_22.4#simulation... SKIP, output already exists
+Generating output file for opnsense#nano_23.7#simulation... SKIP, output already exists
+Generating output file for pfsense#CE_2.7.2#simulation... SKIP, output already exists
+Generating output file for routeros#CHR_7.10.1#simulation... SKIP, output already exists
+Generating output file for routeros#CHR_7.16#simulation... SKIP, output already exists
+Generating output file for routeros#L009UiGS_7.15.2#simulation... SKIP, output already exists
 .
 
 Finished in 0.904792s, 1.1052 runs/s, 0.0000 assertions/s.
@@ -76,7 +76,7 @@ Line Coverage: 58.02% (651 / 1122)
 ```
 
 ### Running the Tests
-You can modify the `:output.txt` file to match your expectations and modify the
+You can modify the `#output.txt` file to match your expectations and modify the
 model accordingly. Run `bundle exec rake` to run the tests.
 
 Here is an example when the output of the VTP command is missing in the expected
@@ -94,7 +94,7 @@ Run options: --seed 31447
 Finished in 7.963602s, 14.6918 runs/s, 48.7217 assertions/s.
 
   1) Failure:
-ATOMS tests#test_0006_ios:C9200L-24P-4G_17.09.04a:output has expected output [spec/model/model_atoms_spec.rb:12]:
+ATOMS tests#test_0006_ios#C9200L-24P-4G_17.09.04a#output has expected output [spec/model/model_atoms_spec.rb:12]:
 --- expected
 +++ actual
 @@ -9,6 +9,21 @@
@@ -138,9 +138,19 @@ If you want to be sure that your model has been tested, run
 `bundle exec rake test TESTOPTS="--verbose"` and search for your models unter
 `ATOMS tests`
 
+### Running only one test
+If you want to run only one test while debuging your model, you can select it
+with the option `--name=/regexp/`:
+```
+bundle exec rake test TESTOPTS="--verbose --name=/ios#C9800.*output/"
+```
+
+You can also set `Oxidized.asetus.cfg.debug = true` in
+`spec/model/model_helper.rb` to activate debug logs.
+
 ## Device Prompt
 You can specify device prompts to test in a YAML file named
-`spec/model/data/<model>:generic:prompt.yaml`.
+`spec/model/data/<model>#generic#prompt.yaml`.
 
 The YAML file has three sections containing a list of prompts to test:
 - pass: these prompts will pass the prompt regexp.
@@ -162,7 +172,7 @@ fail:
 ## Secrets
 You can test if the model effectively removes secrets from your YAML simulation
 file with a YAML file named like the YAML simulation, but with the suffix
-`:secret.yaml`.
+`#secret.yaml`.
 
 The YAML file has two sections containing a list of strings to test:
 - fail: the test will fail if the output contains these strings.
@@ -180,7 +190,7 @@ pass:
 ## Custom tests
 When you write custom tests for your models, please do not use the filenames
 mentioned above, as it will interfere with the standard tests. If you need to
-store a custom simulation file, use `model:description:custom_simulation.yaml`.
+store a custom simulation file, use `model#description#custom_simulation.yaml`.
 
 The [cumulus test](/spec/model/cumulus_spec.rb) is an example of a custom
 test.

data/docs/Outputs.md

@@ -10,9 +10,48 @@ output:
     directory: /var/lib/oxidized/configs
 ```
 
+### Groups
+If you use groups, the nodes will be stored in directories named after the
+groups. The directories are stored one level above the directory for configurations
+without groups.
+
+Example:
+```
+/var/lib/oxidized/
++ configs/     # Configurations of groupless nodes
++ group1/      # Configurations of nodes in group1
++ group2/      # Configurations of nodes in group2
+```
+
+### Clean obsolete nodes
+The `file` output can automatically remove the configuration of nodes no
+longer present in the [source](Sources.md).
+
+> :warning: **Warning:** this might be a dangerous operation: oxidized
+> will remove **any** file not matching the hostname of the nodes configured
+> in the source.
+
+When using groups, it will remove any files not matching the hostnames of the
+nodes from the groups directories (which are on the same level as the default
+directory). As a safety measure, oxidized will only clean configuration out of
+active groups. If the group `example` isn't used anymore, oxidized won't clean
+the configurations out of the directory `../example/`.
+
+Configuration:
+
+```yaml
+output:
+  default: file
+  clean_obsolete_nodes: true
+  file:
+    directory: "~/.config/oxidized/configs/default"
+```
+
+
 ## Output: Git
 
-This uses the rugged/libgit2 interface. So you should remember that normal Git hooks will not be executed.
+This uses the rugged/libgit2 interface. So you should remember that normal Git
+hooks will not be executed.
 
 For a single repository containing all devices:
 
@@ -63,7 +102,49 @@ output:
 
 ```
 
-Over time, your Git repository will expand, potentially leading to performance issues. For instructions on how to address this, see [git performance issues with large device counts](Troubleshooting.md#git-performance-issues-with-large-device-counts).
+### Git performance issues with large device counts
+When you use git to store your configurations, the size of your repository will
+grow over time. This growth may lead to performance issues. If you encounter
+such issues, you should perform a Git garbage collection on your repository.
+
+Follow these steps to do so:
+
+1. Stop oxidized (no one should access the git repository while running garbage
+   collection)
+2. Make a backup of your oxidized data, especially the Git repository
+3. Change directory your oxidized git repository (as configured in oxidized
+   configuration file)
+4. Execute the command `git gc` to run the garbage collection
+5. Restart oxidized - you're done!
+
+
+### Clean obsolete nodes
+The `git` output can automatically remove the configuration of nodes no
+longer present in the [source](Sources.md).
+
+> :warning: **Limitations**
+> - this currently only works with `single_repo: true`
+> - it will ignore configurations saved as [output types](#output-types) in
+>   a separate repository.
+> - oxidized will refuse to remove old configurations
+>   when saving  [output types](#output-types) in a subdirectory of the git
+>   repository (`type_as_directory: true`), or it would remove the output
+>   type directories
+
+Oxidized will remove **any** file within the git repository not matching the
+group and hostname of the nodes configured in the source and will then commit
+the change into git.
+
+Configuration:
+
+```yaml
+output:
+  default: git
+  clean_obsolete_nodes: true
+  git:
+    single_repo: true
+    repo: "~/.config/oxidized/devices.git"
+```
 
 ## Output: Git-Crypt
 

data/docs/Release.md

@@ -1,6 +1,12 @@
 # How to release a new version of Oxidized?
 This document is targeted at oxidized maintainers. It describes the release process.
 
+## Version numbering
+Oxidized versions are nummered like major.minor.patch
+- currently, the major version is 0.
+- minor is incremented when releasing new features.
+- patch is incremented when releasing fixes only.
+
 ## Review changes
 Run `git diff 0.30.0..master` (where `0.30.0` is to be changed to the last release) and review
 all the changes that have been done. Have a specific look at changes you don't understand.
@@ -23,6 +29,18 @@ If you change some code => Restart the release process at the beginning ;-)
 ## Make sure the file permissions are correct
 Run `bundle exec rake chmod`
 
+## Create a release branch
+Name the release branch `release/0.xx.yy`
+
+Update CHANGELOG.md:
+- review it
+- add release notes
+- set the new version (replace `[Unreleased]` with `[0.xx.yy – 202Y-MM-DD]`)
+
+Change the version in `lib/oxidized/version.rb`
+
+Upload the branch to github, make a Pull Request for it.
+
 ## Make sure you pass all GitHub CI
 They test different ruby versions, the docker build process and codeql.
 
@@ -30,38 +48,28 @@ They test different ruby versions, the docker build process and codeql.
 Test the git code and the container against as much device types and
 environments as you can.
 
-## Version numbering
-Oxidized versions are nummered like major.minor.patch
-- currently, the major version is 0.
-- minor is incremented when releasing new features.
-- patch is incremented when releasing fixes only.
-
 ## Prepare the release in your working repository
-1. Checkout the master branch of oxidized. Make sure you are up to date with origin.
-2. Change the version in lib/oxidized/version.rb
-3. Change CHANGELOG.md to replace [Unreleased] with [0.xx.yy – 202Y-MM-DD]
-4. Run `git diff` to check your changes
-5. Commit the changes to the local git repository with a commit message “chore(release): release version 0.xx.yy”
-6. Tag the commit with `git tag -a 0.xx.yy -m "Release 0.xx.yy"`
-7. Build the gem with ‘rake build’
-8. Run `git diff` to check if there have been more changes (there shouldn't)
-9. Install an test the gem locally
-```
-gem install --user-install pkg/oxidized-0.30.0.gem
+1. Merge the Pull Request into master
+2. `git pull` master
+3. Tag the commit with `git tag -a 0.xx.yy -m "Release 0.xx.yy"`
+4. Build the gem with ‘rake build’
+5. Run `git diff` to check if there have been more changes (there shouldn't)
+6. Install an test the gem locally
+```shell
+gem install --user-install pkg/oxidized-0.xx.yy.gem
 ~/.local/share/gem/ruby/3.1.0/bin/oxidized
 ```
 
 ## Release in github
-Push the change and the tag to github:
+Push the tag to github:
 ```
-git push
 git push origin 0.xx.yy
 ```
 
-Make a release from the tag in github
-- Thank the contributors
-- Only describe major changes, and refer to CHANGELOG.md
+Make a release from the tag in github.
+- Take the release notes frm CHANGELOG.md
 - List new contributors (generated automatically)
+- Keep the Full Changelog (generated automatically)
 
 ## Release in rubygems
 Push the gem with ‘rake push’

data/docs/Supported-OS-Types.md

@@ -2,6 +2,7 @@
 
 |Vendor              |OS model                      |oxidized model                                   |model maintainers|comment / model notes|
 |--------------------|------------------------------|-------------------------------------------------|-----------------|---------------------|
+|6WIND               |VSR                           |[sixwind](/lib/oxidized/model/sixwind.rb)        |@hcaldicott      |
 |A10 Networks        |ACOS                          |[acos](/lib/oxidized/model/acos.rb)              |                 |
 |Accedian Performance Elements (NIDs)|AEN           |[aen](/lib/oxidized/model/aen.rb)
 |Acme Packet         |ACMEPACKET                    |[acmepacket](/lib/oxidized/model/acmepacket.rb)
@@ -30,6 +31,7 @@
 |                    |BOSS (Baystack Operating System Software)|[boss](/lib/oxidized/model/boss.rb)
 |BDCOM               |S2200PB, S2200-B, S2500-B, S2500-C, S2500PB, S2500-P, S2900 series|[bdcom](/lib/oxidized/model/bdcom.rb)
 |Brocade             |FabricOS                      |[fabricos](/lib/oxidized/model/fabricos.rb)
+|                    |Enhanced Fabric OS            |[efos](/lib/oxidized/model/efos.rb)
 |                    |FastIron                      |[fastiron](/lib/oxidized/model/fastiron.rb)
 |                    |IronWare                      |[ironware](/lib/oxidized/model/ironware.rb)
 |                    |NOS (Network Operating System)|[nos](/lib/oxidized/model/nos.rb)
@@ -43,6 +45,7 @@
 |Centec Networks     |CNOS                          |[cnos](/lib/oxidized/model/cnos.rb)
 |Check Point         |GaiaOS                        |[gaiaos](/lib/oxidized/model/gaiaos.rb)
 |Ciena               |SAOS                          |[saos](/lib/oxidized/model/saos.rb)
+|                    |SAOS10                        |[saos10](/lib/oxidized/model/saos10.rb)
 |Cisco               |ACSW                          |[acsw](/lib/oxidized/model/acsw.rb)
 |                    |AireOS                        |[aireos](/lib/oxidized/model/aireos.rb)          |                 |[AireOS](Model-Notes/AireOS.md)
 |                    |ASA                           |[asa](/lib/oxidized/model/asa.rb)                |@robertcheramy
@@ -131,6 +134,7 @@
 |MRV                 |MasterOS                      |[masteros](/lib/oxidized/model/masteros.rb)
 |                    |FiberDriver                   |[fiberdriver](/lib/oxidized/model/fiberdriver.rb)
 |NEC                 |NEC IX                        |[necix](/lib/oxidized/model/necix.rb)
+|Netgate             |TNSR                          |[tnsr](/lib/oxidized/model/tnsr.rb)              |@Vantomas
 |Netgear             |Netgear switches              |[netgear](/lib/oxidized/model/netgear.rb)        |                 |[Netgear](Model-Notes/Netgear.md)
 |Netonix             |WISP Switch (As Netonix)      |[netonix](/lib/oxidized/model/netonix.rb)
 |Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)|SR OS (TiMOS)|[sros](/lib/oxidized/model/sros.rb)  |                 |[Nokia ISAM](Model-Notes/Nokia.md)

data/docs/Troubleshooting.md

@@ -27,7 +27,10 @@ Welcome to the advanced nuclear launchinator 5A-X20. Proceed with caution.
 SEKRET-5A-X20#
 ```
 
-Review the relevant device model file and identify the defined prompt. You can find the device models in the `lib/oxidized/model` sub-folder of the repository. For example, the Cisco IOS model, `ios.rb` may use the following prompt:
+Review the relevant device model file and identify the defined prompt. You can
+find the device models in the `lib/oxidized/model` subdirectory of the
+repository. For example, the Cisco IOS model, `ios.rb` may use the following
+prompt:
 
 ```text
   prompt /^([\w.@()-]+[#>]\s?)$/
@@ -85,23 +88,6 @@ If you are running oxidized in a container, you need to map /home/oxidized/.ssh
 container to a local repository and save the known_hosts in the local repository. You can
 find an example how to do this under [examples/podman-compose](/examples/podman-compose/)
 
-## Git performance issues with large device counts
-When you use git to store your configurations, the size of your repository will
-grow over time. This growth can lead to performance issues. To resolve these
-issues, you should perform a Git garbage collection on your repository.
-
-Follow these steps to do so:
-
-1. Stop oxidized (no one should access the git repository while running garbage collection)
-2. Make a backup of your oxidized data, especially the Git repository
-3. Change directory your oxidized git repository (as configured in oxidized configuration file)
-4. Execute the command `git gc` to run the garbage collection
-5. Restart oxidized - you're done!
-
-Note that slow performance in oxidized-web when listing the versions of a device
-are due to the necessity to go through the whole git log to search the
-history. See Issue #3121, the fix will come with oxidized version 0.33.0.
-
 ## Oxidized ignores the changes I made to its git repository
 First of all: you shouldn't manipulate the git repository of oxidized. Don't
 create it, don't modify it, leave it alone. You can break things. You have

data/extra/device2yaml.rb

@@ -6,24 +6,21 @@ require 'optparse'
 require 'etc'
 require 'timeout'
 
-# This scripts logs in a network device and outputs a yaml file that can be
+# This script logs in a network device and outputs a YAML file that can be
 # used for model unit tests in spec/model/
 # For more information, see docs/DeviceSimulation.md
 
-# This script is quick & dirty - it grew with the time an could be a project
-# for its own. It works, and that should be enough ;-)
-
 ################# Methods
 # Runs cmd in the ssh session, either im exec mode or with a tty
 # saves the output to @output
 def ssh_exec(cmd)
-  puts "\n### Sending #{cmd}..."
-  @output&.puts "  #{cmd}: |-"
+  puts "\n### Sending #{cmd.dump}..."
+  @output&.puts "  #{@sequence_prepend_command}#{cmd.dump}: |-"
 
   if @exec_mode
-    @ssh_output = @ssh.exec! cmd + "\n"
+    @ssh_output = @ssh.exec! cmd
   else
-    @ses.send_data cmd + "\n"
+    @ses.send_data cmd
     shell_wait
   end
   yaml_output('    ')
@@ -68,7 +65,14 @@ def shell_wait
           puts "\n### ESC pressed, skipping idle timeout"
           return false
         else
-          # if not, send the char through ssh
+          # if not, record the char and send the char through ssh
+          puts "\n### #{char.dump} pressed"
+          yaml_output('    ')
+          @output&.puts "  #{@sequence_prepend_command}#{char.dump}: |-"
+          @ssh_output = ''
+          start_time = Time.now
+          @ssh_output_length = @ssh_output.length
+
           @ses.send_data char
         end
       end
@@ -85,6 +89,8 @@ def yaml_output(prepend = '')
   # Now print the collected output to @output
   firstline = true
 
+  prepend = @sequence_prepend_output + prepend
+
   # as we want to prepend 'prepend' to each line, we need each_line and chomp
   # chomp removes the trainling \n
   @ssh_output.each_line(chomp: true) do |line|
@@ -113,6 +119,9 @@ end
 
 # Define options
 options = {}
+@sequence_prepend_command = '- '
+@sequence_prepend_output = '  '
+
 optparse = OptionParser.new do |opts|
   opts.banner = <<~HEREDOC
     Usages:
@@ -140,6 +149,10 @@ optparse = OptionParser.new do |opts|
     options[:timeout] = timeout
   end
   opts.on('-e', '--exec-mode', 'Run ssh in exec mode (without tty)') { @exec_mode = true }
+  opts.on('-u', '--unordered', 'The YAML simulation should not enforce an order of the commands') do
+    @sequence_prepend_command = ''
+    @sequence_prepend_output = ''
+  end
   opts.on '-h', '--help', 'Print this help' do
     puts opts
     exit
@@ -182,6 +195,8 @@ elsif options[:input]
 end
 
 puts "Running #{ssh_commands} on #{ssh_user}@#{ssh_host}"
+# Add \n to each command
+ssh_commands.map! { |s| s + "\n" }
 
 # Defaut idle timeout: 5 seconds, as tests showed that 2 seconds is too short
 @idle_timeout = options[:timeout] || 5

data/extra/rest_client.rb

@@ -38,7 +38,8 @@ module Oxidized
 
     def next(opt)
       data = JSON.dump opt
-      @web.put PATH + '/node/next/' + opt[:name].to_s, data
+      headers = { 'content-type': 'application/json' }
+      @web.put PATH + '/node/next/' + opt[:name].to_s, data, headers
     end
   end
 end

data/extra/syslog.rb

@@ -8,8 +8,10 @@
 # set system syslog host SERVER interactive-commands notice
 # set system syslog host SERVER match "^mgd\[[0-9]+\]: UI_COMMIT: .*"
 
-# Ports < 1024 need extra privileges, use a port higher than this by setting the port option in your oxidized config file.
-# To use the default port for syslog (514) you shouldn't pass an argument, but you will need to allow this with:
+# Ports < 1024 need extra privileges, use a port higher than this by setting the
+# port option in your oxidized config file.
+# To use the default port for syslog (514) you shouldn't pass an argument, but
+# you will need to allow this with:
 # sudo setcap 'cap_net_bind_service=+ep' /usr/bin/ruby
 
 # Config options are:
@@ -52,6 +54,7 @@ module Oxidized
   class SyslogMonitor
     MSG = {
       ios:   /%SYS-(SW[0-9]+-)?5-CONFIG_I:/,
+      iosxr: /%MGBL-SYS-5-CONFIG_I/,
       junos: 'UI_COMMIT:',
       eos:   /%SYS-5-CONFIG_I:/,
       nxos:  /%VSHD-5-VSHD_SYSLOG_CONFIG_I:/,
@@ -89,6 +92,7 @@ module Oxidized
       opts[:from] = log[-1][1..-2]
       opts
     end
+    alias iosxr ios
     alias nxos ios
     alias eos ios
 
@@ -116,7 +120,8 @@ module Oxidized
     def run(io)
       loop do
         log = select [io]
-        log, ip = log.first.first, nil
+        log = log.first.first
+        ip = nil
         if @mode == :udp
           log, ip = log.recvfrom_nonblock 2000
           ip = ip.last