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.0.tar.gz (115.7 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.0-py3-none-any.whl (204.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_cisco_aci-0.1.0.tar.gz
  • Upload date:
  • Size: 115.7 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.0.tar.gz
Algorithm Hash digest
SHA256 1a98d7903b7753635102897b5d3829bf4f00367b9716307519e7aa6284f762f9
MD5 848da65a7dfd61578438a5720b986337
BLAKE2b-256 fb5a0c049235ea469786a4ee9d850aafe02b86a0dc424208a6f5228629a68879

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for netbox_cisco_aci-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02179e7bba9c4db76acf71bccc3475298ac5394124ab5585454f4d9d0d423e4b
MD5 b19bd661a2f6e25c0769ec2fa8b76701
BLAKE2b-256 3d0fd77ce8719a9368d1a0c9d0de34ebff127d734ad9269f6c3984d6a0b76736

See more details on using hashes here.

Provenance

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