Skip to content

README.md

Latest commit

 

History

History
86 lines (53 loc) · 2.69 KB

README.md

File metadata and controls

86 lines (53 loc) · 2.69 KB

Netbox Oxidized Config Viewer

View configurations backed up in Oxidized in Netbox

This project was created using human directed AI coding, primarily Devstral and Google Gemini.

To install in its current form

  • Download repo and transfer to somewhere close to your Netbox install

  • Activate Netbox venv

  • pip install -e path/to/netbox-oxidized-config-viewer

  • Add to Netbox configuration.yml

    • PLUGINS = [ "netbox_oxidized_config_viewer"]
    • PLUGINS_CONFIG = { 'netbox_oxidized_config_viewer': { 'oxidized_api_url': 'http://localhost:8888/' },

  • Free software: GPL v3

  • Documentation: https://.github.io/netbox-oxidized-config-viewer/

Features

Allows viewing of config from device tab

Screenshot 2025-08-07 161609

Download previous config versions

Display diff of config versions (alpha version feature)

Lists all devices with config backups as well as their versions

Allows triggering a new backup from Netbox UI

Screenshot 2025-08-07 161645

Compatibility

NetBox Version Plugin Version
4.0 0.1.0

Installing

For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.

While this is still in development and not yet on pypi you can install with pip:

pip install git+https://github.com/prettyokay-software/netbox-oxidized-config-viewer

or by adding to your local_requirements.txt or plugin_requirements.txt (netbox-docker):

git+https://github.com/prettyokay-software/netbox-oxidized-config-viewer

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py, or if you use netbox-docker, your /configuration/plugins.py file :

PLUGINS = [
    'netbox-oxidized-config-viewer'
]

PLUGINS_CONFIG = {
    "netbox-oxidized-config-viewer": {'oxidized_api_url': 'http://localhost:8888/'},
}

Credits

Based on the NetBox plugin tutorial:

This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin project template.