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/00-plan.md — overall plan for the NSO ↔ NetBox integration (cross-cutting; lives here because the adapter implements the contract).
docs/api-contract.md — canonical northbound REST API contract. The NetBox plugin builds against this.
docs/nso-adapter.md — adapter design (this repo).

Companion repos: netbox-nso-plugin — the NetBox plugin that consumes this adapter; nso-packages — the NSO-side YANG service packages (network-state-export read exports + the *-reconciler write services) 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, logging) — 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; docs/00-plan.md §6/§7 records the original Phase 1 plan.

Download files

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

Source Distribution

nso_adapter-1.0.0.tar.gz (461.9 kB view details)

Uploaded Aug 29, 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.

nso_adapter-1.0.0-py3-none-any.whl (520.3 kB view details)

Uploaded Aug 29, 2026 Python 3

File details

Details for the file nso_adapter-1.0.0.tar.gz.

File metadata

Download URL: nso_adapter-1.0.0.tar.gz
Upload date: Aug 29, 2026
Size: 461.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nso_adapter-1.0.0.tar.gz
Algorithm	Hash digest
SHA256	`9eedc2fc254aa58f313e49f12be7e056d6f0e616300ae05ee9bdfea8ae044b79`
MD5	`24f06588711a0f90f414297aac458a3f`
BLAKE2b-256	`84b7f1f85df659ede4e36ba5849e953cee220d0c177bb213b36477a7da29cdd5`

See more details on using hashes here.

Provenance

The following attestation bundles were made for nso_adapter-1.0.0.tar.gz:

Publisher: release.yml on marcinpsk/nso-adapter

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: nso_adapter-1.0.0.tar.gz
- Subject digest: 9eedc2fc254aa58f313e49f12be7e056d6f0e616300ae05ee9bdfea8ae044b79
- Sigstore transparency entry: 2638135837
- Sigstore integration time: Aug 29, 2026
Source repository:
- Permalink: marcinpsk/nso-adapter@eda439ec76122f2b289b1503ba9c3790d3aeeaa9
- 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.yml@eda439ec76122f2b289b1503ba9c3790d3aeeaa9
- Trigger Event: push