oxidized 0.30.0 → 0.31.0

data/docs/Creating-Models.md

@@ -6,6 +6,14 @@ A user may wish to extend an existing model to collect the output of additional
 
 This methodology allows local site changes to be preserved during Oxidized version updates / gem updates. It also enables convenient local development of new models.
 
+## Index
+- [Creating a new model](#creating-a-new-model)
+- [Extending an existing model with a new command](#extending-an-existing-model-with-a-new-command)
+- [Create unit tests for the model](#create-unit-tests-for-the-model)
+- [Advanced features](#advanced-features)
+- [Monkey-patching blocks in existing models](#monkey-patching-blocks-in-existing-models)
+- [Help](#help)
+
 ## Creating a new model
 
 An Oxidized model, at minimum, requires just three elements:
@@ -21,13 +29,19 @@ class RootWare < Oxidized::Model
   using Refinements
   
   cmd 'show complete-config'
+
+  cfg :ssh do
+    pre_logout 'exit'
+  end
+end
 ```
 
 This model, as-is will:
 
-* Log into the device and expect the default prompt.
+* Log into the device with ssh and expect the default prompt.
 * Upon matching it, execute the command `show complete-config`
 * Collect the output.
+* Logout with the command `exit`
 
 It is often useful to, at minimum, define the following additional elements for any newly introduced module:
 
@@ -72,6 +86,33 @@ Intuitively, it is also possible to:
 * Create a completely new model, with a new name, for a new operating system type.
 * Testing/validation of an updated model from the [Oxidized GitHub repo models](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model) by placing an updated model in the proper location without disrupting the gem-supplied model files.
 
+## Create unit tests for the model
+> :warning: model unit tests are still a work in progress and need some polishing.
+
+If you want the model to be integrated into oxidized, you can
+[submit a pull request on github](https://github.com/ytti/oxidized/pulls).
+This is a greatly appreciated submission, as there are probably other users
+using the same network device as you are.
+
+A good (and optional) practice for submissions is to provide a
+[unit test for your model](/spec/model). This reduces the risk that further
+developments could break it, and facilitates debugging issues without having
+access to a physical network device for the model.
+
+In order to simulate the device in the unit test, you need a
+[YAML simulation file](/examples/device-simulation/), have a look at the
+link for an explanation on how to create one.
+
+Creating the unit test itself is explained in
+[README.md in the model unit test directory](/spec/model/README.md).
+
+Remember - producing a YAML simulation file and/or writing a unit test is
+optional.
+The most value comes from the YAML simulation file. The unit
+test can be written by someone else, but you need access to the device for the
+YAML simulation file. If you encounter problems, open an issue or ask for help
+in your pull request.
+
 ## Advanced features
 
 The loosely-coupled architecture of Oxidized allows for easy extensibility in more advanced use cases as well.
@@ -124,19 +165,19 @@ Examples:
 
 ```ruby
 cmd :secret, clear: true do
-  ... "(new code for secret removal which replaces the existing :secret definition in the model)" ...
+  # ... "(new code for secret removal which replaces the existing :secret definition in the model)" ...
 end
 ```
 
 ```ruby
 cmd 'show version', clear: true do |cfg|
-  ... "(new code for parsing 'show version', replaces the existing definition in the model)" ...
+  # ... "(new code for parsing 'show version', replaces the existing definition in the model)" ...
 end
 ```
 
 ```ruby
 cmd :ssh, prepend: true do
-  ... "(code that should run first, before any code in the existing :ssh definition in the model)" ...
+  # ... "(code that should run first, before any code in the existing :ssh definition in the model)" ...
 end
 ```
 

data/docs/Hooks.md

@@ -2,6 +2,15 @@
 
 You can define an arbitrary number of hooks that subscribe to different events. The hook system is modular and different kind of hook types can be enabled.
 
+1. [Events](#events)
+2. Hook types
+ * [exec](#hook-type-exec)
+ * [githubrepo](#hook-type-githubrepo)
+ * [awssns](#hook-type-awssns)
+ * [slackdiff](#hook-type-slackdiff)
+ * [ciscosparkdiff](#ciscosparkdiff)
+ * [xmppdiff](#hook-type-xmppdiff)
+
 ## Configuration
 
 Following configuration keys need to be defined for all hooks:
@@ -184,6 +193,31 @@ hooks:
     privatekey: /root/.ssh/id_rsa
 ```
 
+### Custom branch name
+Githubrepo will use the branch name used in the
+[git output](Outputs.md#output-git) as a remote branch name. When creating the
+git repository for the first time, Oxidized uses the default branch name
+configured in git with `git config --global init.defaultBranch <Name>`. The
+default is `master`.
+
+If you need to rename the branch name after Oxidized has created it, you may do
+it manually. Be aware that you may break things. Make backups and do not
+complain if something goes wrong!
+
+1. Stop oxidized (no one should access the git repository while doing the
+following steps)
+2. Make a backup of your oxidized data, especially the git repository
+3. Change directory to your oxidized git repository (as configured in oxidized
+configuration file)
+4. Inspect the current branches with `git branch -avv`
+5. Rename the default branch with `git branch -m <NewName>`
+6. Remove the reference to the old remote branch  with
+   `git branch -r -d origin/<OldName>`
+6. Inspect the change with `git branch -avv`
+7. Restart oxidized - you're done!
+
+Note that you will also have to clean your remote git repository.
+
 ## Hook type: awssns
 
 The `awssns` hook publishes messages to AWS SNS topics. This allows you to notify other systems of device configuration changes, for example a config orchestration pipeline. Multiple services can subscribe to the same AWS topic.

data/docs/Issues.md

@@ -0,0 +1,91 @@
+# Writing good issues
+If you're experiencing a problem with Oxidized or need a new feature, you can
+[submit an issue on github](https://github.com/ytti/oxidized/issues). We have
+a great community where users help each other through the issue system.
+
+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.
+- By spending time to write a good issue, you save developers time, contributing
+  to Oxidized’s progress without writing a line of code.
+
+## Submit to the correct project
+Choose the appropriate GitHub project based on your issue:
+
+- For issues with the web frontend or REST API, go to
+  [oxidized-web](https://github.com/ytti/oxidized-web/).
+- For issues with oxidized-script, use
+  [oxidized-script](https://github.com/ytti/oxidized-script). (note: as of
+  November 2024, oxidized-script is not actively maintained).
+- For issues with third-party software relying on Oxidized, open an issue in
+  that specific project.
+- For issues with Oxidized itself, go to
+  [oxidized](https://github.com/ytti/oxidized).
+
+## 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.
+- Avoid screenshots of text. Instead, use [code formating](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) for any relevant code snippets.
+
+## Choose your title well
+Keep the title brief yet descriptive. Aim to summarize the main issue or request in a few words.
+
+## Provide detailled informations
+Include as many relevant details as possible. At a minimum, specify:
+
+- Oxidized version and operating system.
+- 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).
+
+Also, provide clear steps to reproduce the issue, if applicable.
+
+## Making feature requests
+Feature requests are welcome, but please understand that unaddressed requests
+may be closed after some time. If you need a feature urgently, consider
+contributing code via a pull request (PR) or hiring a developer.
+
+## Sumbit a YAML Simulation File
+To help developers troubleshoot device-specific issues, you may be asked to submit a
+[YAML simulation file](https://github.com/ytti/oxidized/blob/master/examples/device-simulation/README.md#creating-a-yaml-file-with-device2yamlrb) for your device.
+
+Here's a brief overview how to do it, you can find more details in the link
+above.
+- Fork Oxidized on github
+- Install dependencies (git and Ruby's Net::SSH):
+```
+# Adapt when not using a debian-based distro
+sudo apt install git ruby-net-ssh
+```
+- Clone your forked Oxidized repository:
+```
+git clone git@github.com:<your github user>/oxidized.git
+```
+- run the device2yaml.rb script (you’ll be provided with the command set and
+  output filename to use)
+```
+cd oxidized/examples/device-simulation
+# Replace user and devicename to appropriate values
+./device2yaml.rb user@devicename -c cmdsets/ios -o yaml/asr900_26.8.1b.yaml
+```
+- The script waits 5 seconds between commands, and outputs the response of the
+  device. You can press "ESC" if you see the prompt and want to pass to next
+  command without waiting for the timeout.
+- The result will be stored in `oxidized/examples/device-simulation/yaml/`.
+- Replace any sensitive information with placeholder values in the output file.
+- Commit & push the file to github
+```
+git add yaml/asr900_26.8.1b.yaml
+git commit -m "Device simulation for ASR900"
+git push
+```
+- Create a pull request (PR) in GitHub, referencing the issue number (e.g.,
+  "YAML simulation file for issue #1234").
+
+
+
+
+
+

data/docs/Model-Notes/Cumulus.md

@@ -11,6 +11,9 @@ A variable has been added to enable users running Cumulus Linux > 3.4.0 to targe
 ## NCLU
 It is possible to switch to [NCLU](https://docs.nvidia.com/networking-ethernet-software/cumulus-linux-44/System-Configuration/Network-Command-Line-Utility-NCLU/) as a configuration collecting method, by setting `cumulus_use_nclu` to true
 
+## NVUE
+It is also possible to use [NVUE](https://docs.nvidia.com/networking-ethernet-software/knowledge-base/Setup-and-Getting-Started/NVUE-Cheat-Sheet/) as a configuration collecting method, by setting `cumulus_use_nvue` to true.
+
 ### Example usage
 
 ```yaml
@@ -43,4 +46,6 @@ The default value for `cumulus_routing_daemon` is `quagga` so existing installat
 
 The default value for `cumulus_use_nclu` is `false`, in case NCLU is not installed.
 
+The default value for `cumulus_use_nvue` is `false`, in case NVUE is not installed.
+
 Back to [Model-Notes](README.md)

data/docs/Model-Notes/FSOS.md

@@ -7,5 +7,10 @@ This has been tested against the following models and OS versions
 |S3400-48T4SP        |Version 2.0.2J Build 81736    |
 |S3400-48T4SP        |Version 2.0.2J Build 95262    |
 |S3400-48T6SP        |Version 2.2.0F Build 109661   |
+|S3410-24TS-P        |S3410_FSOS 11.4(1)B74S5       |
+|S5850-48T4Q         |Version 7.0.4.34              |
+|S5800-48MBQ         |Version 7.0.4.21              |
+|S5810-48TS-P        |S5810_FSOS 11.4(1)B74S8, Release(10200711)              |
+|S5860-20SQ          |S5860_FSOS 12.4(1)B0101P1S4   |
 
 Back to [Model-Notes](README.md)

data/docs/Model-Notes/FortiOS.md

@@ -1,18 +1,24 @@
 # FortiOS Configuration
 
-Create user oxidized with ED25519 public key
+## Create user oxidized with ED25519 public key
+You can use a user/password for retrieving the configuration or use a SSH public key:
 
 ```text
 config system admin
 edit oxidized
 set trusthost1 192.0.2.1 255.255.255.255
 set accprofile "super_admin_readonly"
-set ssh-public-key1 "ssh-ed25519 AAAAThisIsJustAnExmapleKey_UseYourOxidizedPUBLICKEY oxidized@librenms"
+set ssh-public-key1 "ssh-ed25519 AAAAThisIsJustAnExampleKey_UseYourOxidizedPUBLICKEY oxidized@librenms"
 end
 ```
 
 
-Fortigate procdues a lot of config changes. I recommend filtering using
+## Configuration changes / hiding passwords
+Fortigate reencrypts its passwords every time the configuration is shown.
+This produces a lot of config changes.
+If you don't want to have a new version every time the configuration is
+downloaded, you can hide all secrets. Beware that you won't have a full backup,
+as all passwords will be replaced with <configuration removed>
 
 ```yaml
 models:
@@ -21,8 +27,18 @@ models:
       remove_secret: true
 ```
 
+## config vs. full config
+On fortios, you can get a configuration without default values (`show .`) or
+including all the default values (`show full-configuration`).
 
+The full configuration can be quite long and produce time-outs.
+Beginning with oxidized 0.30.1, the default is to get the short configuration.
 
-Oxidized can now retrieve your configuration!
+If you need the full configuration, you can activate it in oxidized config file:
+```yaml
+models:
+  fortios:
+    vars:
+      fullconfig: true
+```
 
-Back to [Model-Notes](README.md)

data/docs/Model-Notes/HPEAruba.md

@@ -0,0 +1,31 @@
+# HPE Aruba Networking devices
+HPE Aruba offers various networking devices with different operating systems.
+
+## HPE Aruba Networking Instant Mode (Aruba Instant)
+[Aruba Instant](https://www.arubanetworks.com/techdocs/ArubaDocPortal/content/cons-instant-home.htm)
+runs on IAPs (Instant Access points).
+
+The Oxidized model is [ArubaInstant](/lib/oxidized/model/arubainstant.rb).
+When run on the virtual WLAN controller, it will also collect the list of the
+WLAN-AP linked to the controller.
+
+The aosw model for AOS 8 used to be used for Aruba Instant, but it does not work
+as well and may stop working in the future.
+
+## HPE Aruba Networking Wireless Operating System 8 (AOS 8)
+[AOS 8](https://www.arubanetworks.com/techdocs/ArubaDocPortal/content/cons-aos-home.htm)
+runs on WLAN controllers (mobility controllers) and controller-managed access
+points.
+
+The Oxidized model is [aosw](/lib/oxidized/model/aosw.rb).
+
+## HPE Aruba Networking CX Switch Operating System (AOS-CX)
+[AOS-CX](https://www.arubanetworks.com/techdocs/AOS-CX/help_portal/Content/home.htm)
+is the operating system for the newer CX-Series.
+
+The Oxidized model is [aoscx](/lib/oxidized/model/aoscx.rb).
+
+## Older Models
+Older Devices like ProCurve or 3Com/Comware are listed under the Vendor "HP" in
+the [Supported OS Types](docs/Supported-OS-Types.md) list.
+

data/docs/Model-Notes/OS6.md

@@ -0,0 +1,10 @@
+# OS6 Configuration
+
+The commands Oxidized executes are:
+
+1. terminal length 0
+2. show version
+3. show interfaces transceiver properties
+4. show running-config
+
+Back to [Model-Notes](README.md)

data/docs/Model-Notes/RouterOS.md

@@ -0,0 +1,15 @@
+# Mikrotik RouterOS Configuration
+
+RouterOS 7.12 and later support ED25519 keys. 
+
+Create a key pair, save the public key (``id_ed25519.pub``) and save it on flash. Create a user
+and attach the public key.
+
+```text
+[admin@mikrotik] > /user add name=oxidized group=read disabled=no
+[admin@mikrotik] > /user ssh-keys import public-key-file=id_ed25519.pub user=oxidized
+```
+
+Oxidized can now retrieve your configuration!
+
+Back to [Model-Notes](README.md)

data/docs/Model-Notes/SikluMHTG.md

@@ -0,0 +1,7 @@
+# Siklu Multihaul Terragraph Radio Line
+
+The Siklu Multihaul TG radios use a different command set than the other Siklu radios.
+
+To use this model, your source must designate the model as siklumhtg instead of siklu. It also requires that the MH-TG radio be running at least version 2.1.2.
+
+Back to [Model-Notes](README.md)

data/docs/Outputs.md

@@ -63,6 +63,8 @@ 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).
+
 ## Output: Git-Crypt
 
 This uses the gem git and system git-crypt interfaces. Have a look at [GIT-Crypt](https://www.agwa.name/projects/git-crypt/) documentation to know how to install it.

data/docs/Release.md

@@ -0,0 +1,65 @@
+# How to release a new version of Oxidized?
+This document is targeted at oxidized maintainers. It describes the release process.
+
+## 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.
+
+For a graphical compare, use `git difftool -d 0.30.0..master`.
+
+## Test, test test!
+Test the git code and the container against as much device types an environments as you can.
+
+Do not integrate late PRs into master if they do not fix issues for the release. The must wait for the next release.
+
+## 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
+~/.local/share/gem/ruby/3.1.0/bin/oxidized
+```
+
+## Release in github
+Push the change and 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
+- List new contributors (generated automatically)
+
+## Release in rubygems
+Push the gem with ‘rake push’
+
+## Release in docker.io
+The OCI-Containter is automatically build and pushed to docker.io by github
+
+## Update CHANGELOG.md for next release
+Add
+```
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+```

data/docs/Sources.md

@@ -1,5 +1,8 @@
 # Sources
 
+Note: in all sources, the map attribute `name` is mandatory. It is used to identify the node and
+for example choose the filename for the configuration output.
+
 ## Source: CSV
 
 One line per device, colon separated. If `ip` isn't present, a DNS lookup will be done against `name`.  For large installations, setting `ip` will dramatically reduce startup time.
@@ -55,6 +58,24 @@ and within: `~/.gnupg/gpg.conf`
 pinentry-mode loopback
 ```
 
+## Source: JSONFile
+
+One object per device. Supports GPG encryption like the CSV Source.
+
+```yaml
+source:
+  default: jsonfile
+  jsonfile: 
+    file: /var/lib/oxidized/router.json
+    map:
+      name: hostname
+      model: os
+      username: username
+      password: password
+    vars_map:
+      enable: enable
+```
+
 ## 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!

data/docs/Supported-OS-Types.md

@@ -20,8 +20,9 @@
 |Arbor Networks      |ArbOS                         |[arbos](/lib/oxidized/model/arbos.rb)            |                 |[ArbOS](Model-Notes/ArbOS.md)
 |Arista              |EOS                           |[eos](/lib/oxidized/model/eos.rb)                |                 |[EOS](Model-Notes/EOS.md)
 |Arris               |C4CMTS                        |[c4cmts](/lib/oxidized/model/c4cmts.rb)
-|Aruba               |AOS-CX                        |[aoscx](/lib/oxidized/model/aoscx.rb)            |@robertcheramy
-|                    |AOSW                          |[Aaosw](/lib/oxidized/model/aosw.rb)
+|Aruba               |AOS-CX                        |[aoscx](/lib/oxidized/model/aoscx.rb)            |@robertcheramy   |[HPE Aruba](Model-Notes/HPEAruba.md)
+|                    |AOSW                          |[aosw](/lib/oxidized/model/aosw.rb)                                |[HPE Aruba](Model-Notes/HPEAruba.md)
+|                    |ArubaInstant                  |[arubainstant](/lib/oxidized/model/arubainstant.rb)|@robertcheramy |[HPE Aruba](Model-Notes/HPEAruba.md)
 |Asterfusion         |AsterNOS                      |[asternos](/lib/oxidized/model/asternos.rb)
 |AudioCodes          |AudioCodes                    |[audiocodes](/lib/oxidized/model/audiocodes.rb)
 |                    |MediaPack MP-1xx, Mediant1000 |[audiocodesmp](/lib/oxidized/model/audiocodesmp.rb)
@@ -70,6 +71,7 @@
 |DELL                |PowerConnect                  |[powerconnect](/lib/oxidized/model/powerconnect.rb)
 |                    |AOSW                          |[aosw](/lib/oxidized/model/aosw.rb)              |                 |Same model as Aruba Wireless
 |                    |DellX                         |[dellx](/lib/oxidized/model/dellx.rb)
+|                    |Dell EMC Networking OS6       |[os6](/lib/oxidized/model/os6.rb)              |                 |[Dell EMC Networking OS6](Model-Notes/OS6.md)
 |                    |Dell EMC Networking OS10      |[os10](/lib/oxidized/model/os10.rb)              |                 |[Dell EMC Networking OS10](Model-Notes/OS10.md)
 |D-Link              |D-Link                        |[dlink](/lib/oxidized/model/dlink.rb)
 |                    |D-Link cisco like CLI         |[dlinknextgen](/lib/oxidized/model/dlinknextgen.rb)
@@ -82,7 +84,8 @@
 |                    |Enterasys 800-Series          |[enterasys800](/lib/oxidized/model/enterasys800.rb)
 |                    |WM                            |[mtrlrfs](/lib/oxidized/model/mtrlrfs.rb)
 |                    |XOS, ExtremeWare              |[xos](/lib/oxidized/model/xos.rb)
-|F5                  |TMOS                          |[tmos](/lib/oxidized/model/tmos.rb)
+|F5                  |F5OS                          |[tmos](/lib/oxidized/model/f5os.rb)
+|                    |TMOS                          |[tmos](/lib/oxidized/model/tmos.rb)
 |Fiberstore (fs.com) |S3400                         |[fsos](/lib/oxidized/model/fsos.rb)              |                 |[FSOS](Model-Notes/FSOS.md)
 |                    |S3800                         |[gcombnps](/lib/oxidized/model/gcombnps.rb)
 |                    |S3900                         |[edgecos](/lib/oxidized/model/edgecos.rb)
@@ -119,7 +122,7 @@
 |Linuxgeneric        |CentOS                        |[linuxgeneric](/lib/oxidized/model/linuxgeneric.rb)|               |[LinuxGeneric](Model-Notes/LinuxGeneric.md)
 |Mellanox            |MLNX-OS                       |[mlnxos](/lib/oxidized/model/mlnxos.rb)
 |                    |Voltaire                      |[voltaire](/lib/oxidized/model/voltaire.rb)
-|Mikrotik            |RouterOS                      |[routeros](/lib/oxidized/model/routeros.rb)
+|Mikrotik            |RouterOS                      |[routeros](/lib/oxidized/model/routeros.rb)      |  |[RouterOS](Model-Notes/RouterOS.md)
 |                    |SwOS and SwOS Lite            |[swos](/lib/oxidized/model/swos.rb)
 |Mimosa              |Mimosa (B11)                  |[mimosab11](/lib/oxidized/model/mimosab11.rb)
 |Motorola            |RFS                           |[mtrlrfs](/lib/oxidized/model/mtrlrfs.rb)
@@ -145,7 +148,8 @@
 |Ruijie Networks     |RGOS                          |[rgos](/lib/oxidized/model/rgos.rb)
 |QTECH               |QSW-2800, QSW-3400, QSW-3450, QSW-3500|[qtech](/lib/oxidized/model/qtech.rb)
 |Quanta              |Quanta / VxWorks 6.6 (1.1.0.8)|[quantaos](/lib/oxidized/model/quantaos.rb)
-|Siklu               |EtherHaul                     |[siklu](/lib/oxidized/model/siklu.rb)
+|Siklu               |EtherHaul                     |[siklu](/lib/oxidized/model/siklu.rb)            |@bdg-robert
+|                    |Multihaul TG                  |[siklumhtg](/lib/oxidized/model/siklumhtg.rb)    |@bdg-robert      |[Siklu Multihaul TG](Model-Notes/SikluMHTG.md)
 |Seiko Solutions     |SmartCS, SmartCS mini         |[smartcs](/lib/oxidized/model/smartcs.rb)
 |SonicWALL           |SonicOS                       |[sonicos](/lib/oxidized/model/sonicos.rb)
 |SNR                 |SNR-S300G, S2xxx, S3xxx, S4xxx|[dcnos](/lib/oxidized/model/dcnos.rb)
@@ -165,8 +169,10 @@
 |                    |Edgeos                        |[edgeos](/lib/oxidized/model/edgeos.rb)
 |                    |EdgeSwitch                    |[edgeswitch](/lib/oxidized/model/edgeswitch.rb)
 |                    |AirFiber                      |[airfiber](/lib/oxidized/model/airfiber.rb)
+|Uplink              |EP4440-DP                     |[EP4440](/lib/oxidized/model/uplinkolt.rb)             | |Might support all EP4440 series
 |VMWare              |NSX Edge (configuration)      |[nsxconfig](/lib/oxidized/model/nsxconfig.rb)
 |                    |NSX Edge (firewall rules)     |[nsxfirewall](/lib/oxidized/model/nsxfirewall.rb)
+|                    |NSX Distributed Firewall      |[nsxdfw](/lib/oxidized/model/nsxdfw.rb)
 |Watchguard          |Fireware OS                   |[firewareos](/lib/oxidized/model/firewareos.rb)
 |Westell             |Westell 8178G, Westell 8266G  |[weos](/lib/oxidized/model/weos.rb)
 |YAMAHA              |YAMAHA NVR/RTX Series         |[yamaha](/lib/oxidized/model/yamaha.rb)

data/docs/Troubleshooting.md

@@ -1,4 +1,9 @@
 # Troubleshooting
+## Table of contents
+1. [Connects but no/partial configuration collected](#oxidized-connects-to-a-supported-device-but-no-or-partial-configuration-is-collected)
+2. [No push to remote git repository](#oxidized-does-not-push-to-a-remote-git-repository-hook-githubrepo)
+3. [Git performance issues with large device counts](#git-performance-issues-with-large-device-counts)
+4. [Oxidized ignores the changes I made to its git repository](#oxidized-ignores-the-changes-i-made-to-its-git-repository)
 
 ## Oxidized connects to a supported device but no (or partial) configuration is collected
 
@@ -80,3 +85,33 @@ 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!
+
+## 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
+been warned.
+
+In some situations, you may need to make changes to the git repository of
+oxidized. Stop oxidized, make backups, and be sure you know exactly what you
+are doing. You have been warned.
+
+If you simply clone the git repository, make changes and push them, oxidized
+will ignore these modifications. This is because oxidized caches the HEAD tree
+in the index and `git push` does not update the index because the repository is
+a bare repo and not a working directory repository.
+
+So, you have to update the index manually. For this, go into oxidized repo, and
+run `git ls-tree -r HEAD | git update-index --index-info`. While you're at it,
+consider running `git gc`, as oxidized cannot garbage collect the repo (this
+is not supported in [Rugged](https://github.com/libgit2/rugged)).