Skip to main content

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

Uploaded Source

Built Distribution

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

nso_adapter-0.4.0-py3-none-any.whl (500.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nso_adapter-0.4.0.tar.gz
  • Upload date:
  • Size: 441.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-0.4.0.tar.gz
Algorithm Hash digest
SHA256 fb231b97777cd592544add73af5a7f922fe1d57254cdd8354c05965ab15b463d
MD5 3f6ce3b86c32543fb93dee5290c0de6a
BLAKE2b-256 5c256e98846376675f1ecd3ef55ecd4e55d9095ca37c380c9c9bf8e92d658b4a

See more details on using hashes here.

Provenance

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

File details

Details for the file nso_adapter-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: nso_adapter-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 500.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nso_adapter-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1ccd60f33b5fa730f93529c345fc709a16a6c0adb60bc81df1ae7be919c3c3a
MD5 8f1adbf2ffaaa1702cb91366793e1e8b
BLAKE2b-256 27d3d8550bbb9f41608b00cc6b4c10b04b8016627e88cdcdfa96515a7acb9539

See more details on using hashes here.

Provenance

The following attestation bundles were made for nso_adapter-0.4.0-py3-none-any.whl:

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.

Release history Release notifications | RSS feed

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.4.1

2 files

This release

0.4.0 This release

2 files

0.3.0

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