# NetBox ACI Plugin
The NetBox plugin for Cisco ACI allows NetBox to document ACI specific objects
like Tenants (TN), Application Profiles (AP), Endpoint Groups (EPG),
Endpoint Security Groups (ESG), Bridge Domains (BD) and
Contexts (CTX) / Virtual Routing and Forwarding (VRF).
[](https://pypi.org/project/netbox-aci-plugin/)
Documentation: https://pheus.github.io/netbox-aci-plugin/
## Features
- Tenants
- Application Profiles
- Endpoint Groups
- uSeg Endpoint Groups
- Endpoint Security Groups
- Bridge Domains
- VRF
- Contracts
- Contract Subjects
- Contract Filters
## Compatibility
The following table details the tested plugin versions for each NetBox version:
| NetBox Version | Plugin Version |
|:--------------:|:--------------:|
| 4.4 | 0.1.0 |
| 4.3 | 0.1.0 |
## Installing
### For Docker Setups
For instructions specific to NetBox Docker setups,
see the [netbox-docker plugin documentation](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
### Via PyPI
Activate your NetBox Python virtual environment and run:
```bash
source /opt/netbox/venv/bin/activate
pip install netbox-aci-plugin
```
**Important:** When using NetBox's upgrade.sh, the virtual environment is
deleted and recreated.
To ensure that the ACI plugin is reinstalled during an upgrade,
add it to your `local_requirements.txt` (for local installations) or
`plugin_requirements.txt` (for container-based installations).
```txt
netbox-aci-plugin
```
## Configuration
Enable the plugin by editing the NetBox configuration file.
For local installations, update `/opt/netbox/netbox/netbox/configuration.py`;
for Docker setups, modify `/configuration/plugins.py`:
```python
PLUGINS = [
'netbox_aci_plugin'
]
PLUGINS_CONFIG = {
"netbox_aci_plugin": {
# create default ACI Tenants "common", "infra", "mgmt" during migration
"create_default_aci_tenants": True,
# create default ACI Filters "arp", "icmp", "ip" during migration
"create_default_aci_contract_filters": True,
},
}
```
After configuration, apply the changes by running the database migrations:
```bash
source /opt/netbox/venv/bin/activate
cd /opt/netbox
python3 netbox/manage.py migrate
```
## Status
This project is in alpha.
While core functionality is stable, bugs and missing features may still be
present.
Use in testing or non-critical environments, and proceed with caution
in production.
## Release notes
See the [changelog](https://github.com/pheus/netbox-aci-plugin/blob/main/CHANGELOG.md).
## Licensing
GNU General Public License v3.0 or later.
See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
## Credits
Based on the NetBox plugin tutorial:
- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the
[`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.
Raw data
{
"_id": null,
"home_page": null,
"name": "netbox-aci-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": "Martin Hauser <git@pheus.dev>",
"keywords": "netbox, netbox-plugin, cisco, aci",
"author": null,
"author_email": "Martin Hauser <git@pheus.dev>",
"download_url": "https://files.pythonhosted.org/packages/0c/bf/4433cb29c4ee64fe02ac698c1b7424ff0c4841415349073aa08f54c8bea0/netbox_aci_plugin-0.1.0.tar.gz",
"platform": null,
"description": "# NetBox ACI Plugin\n\nThe NetBox plugin for Cisco ACI allows NetBox to document ACI specific objects\nlike Tenants (TN), Application Profiles (AP), Endpoint Groups (EPG),\nEndpoint Security Groups (ESG), Bridge Domains (BD) and\nContexts (CTX) / Virtual Routing and Forwarding (VRF).\n\n[](https://pypi.org/project/netbox-aci-plugin/)\n\nDocumentation: https://pheus.github.io/netbox-aci-plugin/\n\n## Features\n\n- Tenants\n- Application Profiles\n- Endpoint Groups\n- uSeg Endpoint Groups\n- Endpoint Security Groups\n- Bridge Domains\n- VRF\n- Contracts\n- Contract Subjects\n- Contract Filters\n\n## Compatibility\n\nThe following table details the tested plugin versions for each NetBox version:\n\n| NetBox Version | Plugin Version |\n|:--------------:|:--------------:|\n| 4.4 | 0.1.0 |\n| 4.3 | 0.1.0 |\n\n\n\n## Installing\n\n### For Docker Setups\n\nFor instructions specific to NetBox Docker setups,\nsee the [netbox-docker plugin documentation](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).\n\n### Via PyPI\n\nActivate your NetBox Python virtual environment and run:\n\n```bash\nsource /opt/netbox/venv/bin/activate\n\npip install netbox-aci-plugin\n```\n\n**Important:** When using NetBox's upgrade.sh, the virtual environment is\ndeleted and recreated.\nTo ensure that the ACI plugin is reinstalled during an upgrade,\nadd it to your `local_requirements.txt` (for local installations) or\n`plugin_requirements.txt` (for container-based installations).\n\n```txt\nnetbox-aci-plugin\n```\n\n## Configuration\n\nEnable the plugin by editing the NetBox configuration file.\nFor local installations, update `/opt/netbox/netbox/netbox/configuration.py`;\nfor Docker setups, modify `/configuration/plugins.py`:\n\n```python\nPLUGINS = [\n 'netbox_aci_plugin'\n]\n\nPLUGINS_CONFIG = {\n \"netbox_aci_plugin\": {\n # create default ACI Tenants \"common\", \"infra\", \"mgmt\" during migration\n \"create_default_aci_tenants\": True,\n # create default ACI Filters \"arp\", \"icmp\", \"ip\" during migration\n \"create_default_aci_contract_filters\": True,\n },\n}\n```\n\nAfter configuration, apply the changes by running the database migrations:\n\n```bash\nsource /opt/netbox/venv/bin/activate\ncd /opt/netbox\npython3 netbox/manage.py migrate\n```\n\n## Status\n\nThis project is in alpha.\nWhile core functionality is stable, bugs and missing features may still be\npresent.\nUse in testing or non-critical environments, and proceed with caution\nin production.\n\n## Release notes\n\nSee the [changelog](https://github.com/pheus/netbox-aci-plugin/blob/main/CHANGELOG.md).\n\n## Licensing\n\nGNU General Public License v3.0 or later.\n\nSee [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.\n\n## Credits\n\nBased on the NetBox plugin tutorial:\n\n- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)\n- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the\n[`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.\n",
"bugtrack_url": null,
"license": null,
"summary": "NetBox plugin for Cisco ACI",
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/pheus/netbox-aci-plugin/releases",
"Documentation": "https://pheus.github.io/netbox-aci-plugin/",
"Homepage": "https://github.com/pheus/netbox-aci-plugin",
"Issues": "https://github.com/pheus/netbox-aci-plugin/issues",
"Source": "https://github.com/pheus/netbox-aci-plugin"
},
"split_keywords": [
"netbox",
" netbox-plugin",
" cisco",
" aci"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7c4b12601776fd0001a08382e0d24fc4039bcaf62f3a61f14e9ea4ba90f8a20f",
"md5": "7bae41bef245d2e0ec064df670d8ded7",
"sha256": "160d17c63dcfd7d037059a1d2ab70f87238721c3f317d04b3052b695e23b01d2"
},
"downloads": -1,
"filename": "netbox_aci_plugin-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7bae41bef245d2e0ec064df670d8ded7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.0",
"size": 234468,
"upload_time": "2025-09-03T15:23:27",
"upload_time_iso_8601": "2025-09-03T15:23:27.043027Z",
"url": "https://files.pythonhosted.org/packages/7c/4b/12601776fd0001a08382e0d24fc4039bcaf62f3a61f14e9ea4ba90f8a20f/netbox_aci_plugin-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0cbf4433cb29c4ee64fe02ac698c1b7424ff0c4841415349073aa08f54c8bea0",
"md5": "946a2260aa5115337bf0fcc588603e53",
"sha256": "ff762042eb213661850dc5ddc4581dfa90554185f0179d59b31113d9de48e135"
},
"downloads": -1,
"filename": "netbox_aci_plugin-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "946a2260aa5115337bf0fcc588603e53",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0",
"size": 139327,
"upload_time": "2025-09-03T15:23:28",
"upload_time_iso_8601": "2025-09-03T15:23:28.344726Z",
"url": "https://files.pythonhosted.org/packages/0c/bf/4433cb29c4ee64fe02ac698c1b7424ff0c4841415349073aa08f54c8bea0/netbox_aci_plugin-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 15:23:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pheus",
"github_project": "netbox-aci-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netbox-aci-plugin"
}
JSON
