nso-adapter
Middleware service between Cisco NSO and consumers (NetBox first). Speaks NSO RESTCONF; exposes a consumer-agnostic northbound REST API. Internally split into a generic NSO core and pluggable consumer bindings; a NetBox binding ships with it.
Documentation
docs/api-contract.md is the canonical northbound REST
API contract. The NetBox plugin builds against it.
Companion repo netbox-nso-plugin provides the
NetBox plugin that consumes this adapter. nso-packages contains the
NSO-side YANG service packages (network-state-export read exports and the
*-reconciler write services) that the adapter drives over RESTCONF.
Status
In active development (Phase 2, 2026-06). The northbound API serves ~57
endpoints across 16 config families (interfaces/IPs/MTU, VLAN/switchport,
SVI, subinterfaces, L2 services, LAG, IS-IS, OSPF, BGP, route-policy,
redistribution, static routes, BFD, SNMP, and logging). It provides read mirrors
plus a full-replace intent store with a durable apply worker, post-apply dry-run
verification, periodic + SSE-triggered sync, and an intent-summary endpoint
for split-brain detection. docs/api-contract.md is kept in lock-step with
the implemented surface.
Development
The custom review-pattern pre-commit hooks require the opengrep executable on
PATH. Follow the official OpenGrep installation instructions,
or set OPENGREP_BIN to an installed executable. These checks run in local
pre-commit only. GitHub Actions and the pre-push stage do not run OpenGrep.
1 maintainer
Release files for nso-adapter 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nso_adapter-1.5.0.tar.gz | 554.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nso_adapter-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / nso_adapter-1.5.0.tar.gz
| Download URL | nso_adapter-1.5.0.tar.gz |
|---|---|
| Size | 554.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
259c23ccc2ecce4dd1b08d745e8d50de81bf3e72f2fa638fe973076437d8f2b1
|
|
BLAKE2b-256 checksum How to use checksums |
daac0184ef4a268b5ac6bc41f551d8319eb7a92ac2e21d2be86e7cfdc198703c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.
Transparency logRelease files / nso_adapter-1.5.0-py3-none-any.whl
| Download URL | nso_adapter-1.5.0-py3-none-any.whl |
|---|---|
| Size | 570.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
15d28d6acfec8e5bd9007233949d9e1fe99c1367b30895dde642fe121a862d3f
|
|
BLAKE2b-256 checksum How to use checksums |
5495efee95a549681232204e1600224ef34b50894686e8e397bdb05b8e08002b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.
Transparency log
