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.1.1.tar.gz (116.8 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.1.1-py3-none-any.whl (204.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_cisco_aci-0.1.1.tar.gz
  • Upload date:
  • Size: 116.8 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.1.1.tar.gz
Algorithm Hash digest
SHA256 0809e2539a040f7f413d40ac6c07b7acd6d55f4a959add96f243772e64f94fe7
MD5 5d3d77f605b981df9dd154b052b81403
BLAKE2b-256 0e77d0a3b389ac64215463b0d5271fb9e62067ca54296e48ccb5bcfe9e7359a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_cisco_aci-0.1.1.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.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_cisco_aci-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6a26e8d24bba3bb8eb71022d808814eaef130750f32cce107d5c82806c517763
MD5 b90bf20cb59efca1b64d7e4b3ed51476
BLAKE2b-256 e1499e9aa384629c4ee30d926506b6f01e43a45cb9e520082d4b87734de2a064

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_cisco_aci-0.1.1-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