netbox-nso-plugin

NetBox 4.6 plugin that integrates NetBox with Cisco NSO via the nso-adapter REST API — a bidirectional sync: device state is imported into NetBox, and operator-accepted values become intent that is applied back to the device through NSO (reconcile-mode commits).

Features

  • Mark NetBox devices as NSO-managed and choose the managed scopes (interfaces, routing, VLANs/L2, SNMP, logging, …) per device.
  • Device NSO tab: counts-first category summaries with lazy row expansion, a merged per-interface table (enabled / description / IPs / MTU / switchport), pagination + search, and inline editing of operator-owned values.
  • Read mirrors for: interface attributes/IPs/MTU, VLAN database, switchport, SVI/IRB, dot1q subinterfaces, L2 services (epipe/vpls SAPs), LACP/LAG, IS-IS (incl. levels, segment-routing, Flex-Algo), OSPF, BGP (peers/AFs/templates), route policies, redistribution, static routes, BFD, SNMP (secret-safe), logging hosts — materialised into native NetBox / netbox-routing objects with NSO*State status overlays and clobber-safe 3-way merge.
  • Accept → Apply write path: Accept promotes a value to NetBox-owned intent; one device Apply commits all pending scopes via the NSO *-reconciler services, with a two-panel preview (intent summary + native device diff). Greenfield writes for operator-created routes, VLANs, policies, SVIs, subinterfaces and more.
  • Drift handling: value-aware drift display, plus intent split-brain detection (orphaned and partial) with one-click re-sync of the adapter intent mirror — never touches the device.
  • Adapter actions from the tab: Sync, Detect drift, Test connection, Apply, with job polling.
  • Device onboarding NetBox → NSO (create node, fetch host keys, sync-from) from the NSO Devices dashboard.
  • Exposes NSODeviceManagement at /api/plugins/nso/device-management/ for the adapter's self-healing reconcile path.

Requirements

  • NetBox ≥ 4.6.0
  • Python ≥ 3.12

Installation

pip install netbox-nso-plugin

Add to PLUGINS in configuration.py:

PLUGINS = ["netbox_nso_plugin"]
PLUGINS_CONFIG = {
    "netbox_nso_plugin": {
        "adapter_url": "https://nso-adapter.example.net",
        "adapter_token": "<bearer token>",
    }
}

Run migrations:

python manage.py migrate netbox_nso_plugin

Development

See .devcontainer/ for the Docker-based development environment.

Project links

Data verified by PyPI on Aug 10, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.3.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for MarcinZieba from gravatar.com MarcinZieba

Credits

Author: Marcin Zieba

GitHub Statistics

Data verified by PyPI on Aug 10, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.12.0

Tags

netbox plugin nso cisco automation networking

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_nso_plugin-0.2.0.tar.gz (974.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_nso_plugin-0.2.0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file netbox_nso_plugin-0.2.0.tar.gz.

File metadata

  • Download URL: netbox_nso_plugin-0.2.0.tar.gz
  • Upload date:
  • Size: 974.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for netbox_nso_plugin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d223df01a6ac1be05c4e25b848cece6c3b4aea1ecc7d92113b873963dcbf0857
MD5 d6e029d870e44a20e9026ed6ad52ad9c
BLAKE2b-256 e1188ca627e0522037d925dc759fb432d4bac8ad74535130c5281ec57d1f1731

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_nso_plugin-0.2.0.tar.gz:

Publisher: release.yaml on marcinpsk/netbox-nso-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_nso_plugin-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_nso_plugin-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2948eb3cef1aaccd5022db8b16fce2a4e6e645b83558a5cdd1eb11058cd4054
MD5 db181e9084f7f5f6ba49425a4f10098f
BLAKE2b-256 b2d5a0ae8360339a0a24aadd5f5395fff7feebc447bf2027eca380c17f58d5cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_nso_plugin-0.2.0-py3-none-any.whl:

Publisher: release.yaml on marcinpsk/netbox-nso-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.3.0

2 files

This release

0.2.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page