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.

Environment
- Plugins
Framework
- Django
Programming Language
Topic
- System :: Networking

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.3.0.tar.gz (989.5 kB view details)

Uploaded Aug 18, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

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

Uploaded Aug 18, 2026 Python 3

File details

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

File metadata

Download URL: netbox_nso_plugin-0.3.0.tar.gz
Upload date: Aug 18, 2026
Size: 989.5 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.3.0.tar.gz
Algorithm	Hash digest
SHA256	`e65d37db9691c31c8ae514c11d2972785624aa27f69c8a812a6748e168000255`
MD5	`7f34e3e3abf7ec6328e7b978e7619d4b`
BLAKE2b-256	`797213296b5625fe896f9f263bff72973f56f6fd0774f434b1f17b54d902274c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_nso_plugin-0.3.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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: netbox_nso_plugin-0.3.0.tar.gz
- Subject digest: e65d37db9691c31c8ae514c11d2972785624aa27f69c8a812a6748e168000255
- Sigstore transparency entry: 2502297148
- Sigstore integration time: Aug 18, 2026
Source repository:
- Permalink: marcinpsk/netbox-nso-plugin@740d157d239a91a8491ea5768365831ebb1159a6
- Branch / Tag: refs/heads/main
- Owner: https://github.com/marcinpsk
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yaml@740d157d239a91a8491ea5768365831ebb1159a6
- Trigger Event: push