| Name | netbox-services JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | A NetBox services Plugin for Service Providers |
| upload_time | 2025-10-08 03:17:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
netbox-plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NetBox Services Plugin
This plugin extends NetBox to manage and relate business services to network resources. It introduces a `Service` model that allows you to track various service types (such as L2VPN, L3VPN, DIA, Transit, CDN, Voice) and associate them with devices, interfaces, cables, VLANs, prefixes, VRFs, ASNs, route targets, L2VPNs, tunnels, and virtual machines.
## Features
- Add, edit, and delete business services.
- Relate services to network objects (devices, interfaces, cables, VLANs, prefixes, VRFs, ASNs, route targets, L2VPNs, tunnels, virtual machines).
- Filter and view services in a table with all relevant fields.
- Custom forms and views for relating specific network objects to a service.
- Integrated navigation and changelog support.
## Usage
- Access the plugin from the NetBox navigation menu under "Business Services".
- Create new services and relate them to network resources.
- Use the detail view to see all associations for a service.
## Why
Because you might be looking for such a thing.
Tagging is great for simple categorization, but the NetBox Services plugin goes far beyond that by letting you model real business services and their relationships to network resources.
Instead of just tagging a device or prefix as "DIA," you can create a full DIA service—like "NW-123456" from Cogent—and link it to all relevant devices, interfaces, prefixes, VRFs, ASNs, and more.
For example, with a DIA service from Cogent (Service ID: NW-123456), you can:
- See all devices and interfaces delivering that service.
- Track the exact IP prefixes, VRFs, and ASNs involved.
- Relate cables, tunnels, and even virtual machines to the service.
- View and manage all these relationships in one place, with history and forms tailored to each resource.
This gives you a true service-centric view of your network, making troubleshooting, reporting, and change management much more powerful and organized than simple tagging ever could.
## Requirements
- NetBox 4.x or later
- Django 4.x or later
## Installation
1. Clone this repository into your NetBox `plugins` directory. You can also install it on your system / venv / coffee maker with
```bash
pip install netbox_services
```
2. Add `'netbox_services'` to the `PLUGINS` list in your NetBox configuration.
```python
PLUGINS = [
'netbox_services'
],
```
3. Run migrations: `python manage.py migrate netbox_services`
4. Restart NetBox.
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "netbox-services",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Arturo Baldo <baldoarturo@gmail.com>",
"keywords": "netbox-plugin",
"author": null,
"author_email": "Arturo Baldo <baldoarturo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1f/80/e8b14a38200320b9c6d29bdd849bef28a8a2ea0d96258e7dacd664699a98/netbox_services-0.0.8.tar.gz",
"platform": null,
"description": "# NetBox Services Plugin\n\nThis plugin extends NetBox to manage and relate business services to network resources. It introduces a `Service` model that allows you to track various service types (such as L2VPN, L3VPN, DIA, Transit, CDN, Voice) and associate them with devices, interfaces, cables, VLANs, prefixes, VRFs, ASNs, route targets, L2VPNs, tunnels, and virtual machines.\n\n## Features\n- Add, edit, and delete business services.\n- Relate services to network objects (devices, interfaces, cables, VLANs, prefixes, VRFs, ASNs, route targets, L2VPNs, tunnels, virtual machines).\n- Filter and view services in a table with all relevant fields.\n- Custom forms and views for relating specific network objects to a service.\n- Integrated navigation and changelog support.\n\n## Usage\n- Access the plugin from the NetBox navigation menu under \"Business Services\".\n- Create new services and relate them to network resources.\n- Use the detail view to see all associations for a service.\n\n\n\n## Why\nBecause you might be looking for such a thing. \n\nTagging is great for simple categorization, but the NetBox Services plugin goes far beyond that by letting you model real business services and their relationships to network resources.\n\nInstead of just tagging a device or prefix as \"DIA,\" you can create a full DIA service\u2014like \"NW-123456\" from Cogent\u2014and link it to all relevant devices, interfaces, prefixes, VRFs, ASNs, and more.\n\nFor example, with a DIA service from Cogent (Service ID: NW-123456), you can:\n\n- See all devices and interfaces delivering that service.\n- Track the exact IP prefixes, VRFs, and ASNs involved.\n- Relate cables, tunnels, and even virtual machines to the service.\n- View and manage all these relationships in one place, with history and forms tailored to each resource.\n\nThis gives you a true service-centric view of your network, making troubleshooting, reporting, and change management much more powerful and organized than simple tagging ever could.\n\n## Requirements\n- NetBox 4.x or later\n- Django 4.x or later\n\n## Installation\n1. Clone this repository into your NetBox `plugins` directory. You can also install it on your system / venv / coffee maker with\n```bash\npip install netbox_services\n```\n\n2. Add `'netbox_services'` to the `PLUGINS` list in your NetBox configuration.\n\n```python\n PLUGINS = [\n 'netbox_services'\n ],\n```\n\n3. Run migrations: `python manage.py migrate netbox_services`\n4. Restart NetBox.\n\n## License\nMIT\n",
"bugtrack_url": null,
"license": null,
"summary": "A NetBox services Plugin for Service Providers",
"version": "0.0.8",
"project_urls": {
"Documentation": "https://github.com/baldoarturo/netbox-services/blob/main/README.md",
"Source": "https://github.com/baldoarturo/netbox-services",
"Tracker": "https://github.com/baldoarturo/netbox-services/issues"
},
"split_keywords": [
"netbox-plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "00570228e4118d31ae3f707a65eb2b4249471a84bdb6ff21a0de1f830f2dc4f0",
"md5": "013499a3808a3a3e3d27f913fdc51f74",
"sha256": "7fe71d9c1889567e35dcc3e75840b3cbb772042785d3cdd9e8d2b5e46ed847b8"
},
"downloads": -1,
"filename": "netbox_services-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "013499a3808a3a3e3d27f913fdc51f74",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13722,
"upload_time": "2025-10-08T03:17:10",
"upload_time_iso_8601": "2025-10-08T03:17:10.684486Z",
"url": "https://files.pythonhosted.org/packages/00/57/0228e4118d31ae3f707a65eb2b4249471a84bdb6ff21a0de1f830f2dc4f0/netbox_services-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1f80e8b14a38200320b9c6d29bdd849bef28a8a2ea0d96258e7dacd664699a98",
"md5": "85fe44bbfa7ba08b408c5bcf29223de0",
"sha256": "5a8b077110844a760de12de5242f48c7a4dd8a680c1276c45423562d1df51fe7"
},
"downloads": -1,
"filename": "netbox_services-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "85fe44bbfa7ba08b408c5bcf29223de0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10154,
"upload_time": "2025-10-08T03:17:11",
"upload_time_iso_8601": "2025-10-08T03:17:11.437711Z",
"url": "https://files.pythonhosted.org/packages/1f/80/e8b14a38200320b9c6d29bdd849bef28a8a2ea0d96258e7dacd664699a98/netbox_services-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 03:17:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "baldoarturo",
"github_project": "netbox-services",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netbox-services"
}
