Skip to main content

NetBox plugin for daily-operations visibility of Cisco ACI fabrics.

Project description

netbox-cisco-aci

A NetBox plugin for operational visibility and documentation of Cisco ACI fabrics.

Models every ACI construct needed for daily operations — Fabrics, Pods, Nodes (linked to existing dcim.Device records), Tenants, VRFs, Bridge Domains and subnets, Application Profiles, EPGs / ESGs (including uSeg), Contracts / Subjects / Filters, AAEPs, Domains, VLAN Pools, Switch and Interface profiles, L3Outs (with BGP / OSPF / EIGRP peers and External EPGs), and per-interface EPG/BD/Subnet bindings so you can see the ACI policy applied to any device or port at a glance.

CI codecov PyPI Python NetBox License Docs

Compatibility

See the compatibility matrix for supported NetBox versions.

The plugin is designed to run unmodified on NetBox Enterprise and NetBox Cloud (both Kubernetes-based, multi-pod, immutable filesystems) as well as classic single-VM installs. The contract is documented in docs/cloud-compatibility.md and enforced by the cloud-compat CI job.

Features

  • Fabric topology — Fabric → Pod → Node, with each Node optionally linked to a dcim.Device so existing inventory remains the source of truth for hardware.
  • Tenancy model — Tenant → VRF, Bridge Domain (+ Subnets), Application Profile → EPG / ESG, including uSeg attributes.
  • Access policies — VLAN Pools, Physical / L3 / VMM Domains, AAEPs with EPG mappings, Switch Profiles, Interface Profiles, Interface Policy Groups, and per-policy refs (CDP / LLDP / LACP / MCP / STP / Link Level).
  • Contracts — Contracts, Subjects, Filters with entries, and Provider / Consumer relations (including common-tenant imports and inter-VRF / shared-services patterns).
  • L3Outs — Logical Node Profiles, Logical Interface Profiles (routed / SVI / sub-interface), BGP / OSPF / EIGRP peers, External EPGs with subnets and contract bindings.
  • Device & interface visibility — every static port binding links an EPG to a dcim.Interface. The plugin injects panels on both the Device and Interface detail views showing the EPGs, BDs, Subnets, and VRFs that touch that hardware.
  • Full NetBox surface — REST API, GraphQL, search, navigation, change-logging, journal, custom fields, tags, and per-object RBAC.

Installation

source /opt/netbox/venv/bin/activate
pip install netbox-cisco-aci

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ['netbox_cisco_aci']

Run migrations and restart NetBox:

python /opt/netbox/netbox/manage.py migrate
sudo systemctl restart netbox netbox-rq

Add netbox-cisco-aci to local_requirements.txt.

Configuration

The plugin works with sensible defaults. Optional settings live under PLUGINS_CONFIG['netbox_cisco_aci'] — see the configuration docs.

Development

See AGENTS.md for repository conventions and docs/development.md for the dev-loop quickstart.

Licensing

Apache License 2.0 — see LICENSE.

Project details


Download files

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

Source Distribution

netbox_cisco_aci-0.2.0.tar.gz (127.9 kB view details)

Uploaded Source

Built Distribution

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

netbox_cisco_aci-0.2.0-py3-none-any.whl (218.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_cisco_aci-0.2.0.tar.gz
  • Upload date:
  • Size: 127.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_cisco_aci-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bb3f24521b49f0b35440e53d48d4850fab5483647434533c0254e37646c99ba5
MD5 afed9c1ecf501e8bcb4ebdcf397ae83b
BLAKE2b-256 4e3fa77fe86e8b79b746724b9c05c285f8d7b18beb8bb97b426ad4a46f17677e

See more details on using hashes here.

Provenance

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

Publisher: release.yml on droolingtaz/netbox-cisco-aci

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_cisco_aci-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_cisco_aci-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dedbe300632b3b86b0d280271ac1cc8842816e2bbec1f8b1d947b84ed74c9e64
MD5 d94c3db2378506a682e1f4aff133cf8e
BLAKE2b-256 851431df02d0bf5bdc40eb5a4943f37e71a0d3d5231207965e13d2fcea28fad5

See more details on using hashes here.

Provenance

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

Publisher: release.yml on droolingtaz/netbox-cisco-aci

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page