| Name | netbox-security JSON |
| Version |
1.2.7
JSON |
| download |
| home_page | None |
| Summary | A Netbox plugin for tracking Security and NAT related objects |
| upload_time | 2025-07-11 10:37:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
netbox
netbox-plugin
security
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NetBox Security Plugin
[Netbox](https://github.com/netbox-community/netbox) plugin for Security and NAT related objects documentation.
<div align="center">
<a href="https://pypi.org/project/netbox-security/"><img src="https://img.shields.io/pypi/v/netbox-security" alt="PyPi"/></a>
<a href="https://github.com/andy-shady-org/netbox-security/stargazers"><img src="https://img.shields.io/github/stars/andy-shady-org/netbox-security?style=flat" alt="Stars Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-security/network/members"><img src="https://img.shields.io/github/forks/andy-shady-org/netbox-security?style=flat" alt="Forks Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-security/issues"><img src="https://img.shields.io/github/issues/andy-shady-org/netbox-security" alt="Issues Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-security/pulls"><img src="https://img.shields.io/github/issues-pr/andy-shady-org/netbox-security" alt="Pull Requests Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-security/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/andy-shady-org/netbox-security?color=2b9348"></a>
<a href="https://github.com/andy-shady-org/netbox-security/blob/master/LICENSE"><img src="https://img.shields.io/github/license/andy-shady-org/netbox-security?color=2b9348" alt="License Badge"/></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style Black"/></a>
<a href="https://pepy.tech/project/netbox-security"><img alt="Downloads" src="https://static.pepy.tech/badge/netbox-security"></a>
<a href="https://pepy.tech/project/netbox-security"><img alt="Downloads/Week" src="https://static.pepy.tech/badge/netbox-security/month"></a>
<a href="https://pepy.tech/project/netbox-security"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-security/week"></a>
</div>
## Features
This plugin provides following Models:
* Addresses
* Address Sets
* Address Lists
* Security Zones
* Security Zone Policies
* NAT Pools
* NAT Pool Members
* NAT Rule-sets
* NAT Rules
* Firewall Filters
* Firewall Filter Rules
* Firewall Policers
## Compatibility
| NetBox Version | NetBox Security Version |
|----------------|-------------------------|
| NetBox 4.2 | \>= 1.0.2 |
| NetBox 4.3 | \>= 1.1.0 |
## Installation
The plugin is available as a Python package in pypi and can be installed with pip
```
pip install netbox-security
```
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
```
PLUGINS = ['netbox_security']
```
Restart NetBox and add `netbox-security` to your local_requirements.txt
Perform database migrations:
```bash
cd /opt/netbox
source venv/bin/activate
python ./netbox/manage.py migrate netbox_security
python ./netbox/manage.py reindex netbox_security
```
Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documentation](https://netbox.readthedocs.io/en/stable/plugins/)
## Configuration
The following options are available:
* `virtual_ext_page`: String (default left) Virtual Machine related objects table position. The following values are available:
left, right, full_width. Set empty value for disable.
* `interface_ext_page`: String (default full_width) Interface related objects table position. The following values are available:
left, right, full_width. Set empty value for disable.
* `address_ext_page`: String (default right) Address/Address Set related objects table position. The following values are available:
left, right, full_width. Set empty value for disable.
* `top_level_menu`: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.
## Contribute
Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
## Documentation
For further information, please refer to the full documentation: [Using NetBox Security](docs/using_netbox_security.md)
## Credits
- Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.
- Thanks to Dan Sheppard for the abstracted field generation stuff which I also used.
- Thanks to Kris Beevers and Mark Coleman at Netbox Labs for encouragement and engagement.
Raw data
{
"_id": null,
"home_page": null,
"name": "netbox-security",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "netbox, netbox-plugin, security",
"author": null,
"author_email": "Andy Wilson <andy@shady.org>",
"download_url": "https://files.pythonhosted.org/packages/f1/0a/28dd7aaca48e0466916da1e61057ea1308f1ef82cfdd0aaad4028b917f4b/netbox_security-1.2.7.tar.gz",
"platform": null,
"description": "# NetBox Security Plugin\n[Netbox](https://github.com/netbox-community/netbox) plugin for Security and NAT related objects documentation.\n\n<div align=\"center\">\n<a href=\"https://pypi.org/project/netbox-security/\"><img src=\"https://img.shields.io/pypi/v/netbox-security\" alt=\"PyPi\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-security/stargazers\"><img src=\"https://img.shields.io/github/stars/andy-shady-org/netbox-security?style=flat\" alt=\"Stars Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-security/network/members\"><img src=\"https://img.shields.io/github/forks/andy-shady-org/netbox-security?style=flat\" alt=\"Forks Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-security/issues\"><img src=\"https://img.shields.io/github/issues/andy-shady-org/netbox-security\" alt=\"Issues Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-security/pulls\"><img src=\"https://img.shields.io/github/issues-pr/andy-shady-org/netbox-security\" alt=\"Pull Requests Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-security/graphs/contributors\"><img alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/andy-shady-org/netbox-security?color=2b9348\"></a>\n<a href=\"https://github.com/andy-shady-org/netbox-security/blob/master/LICENSE\"><img src=\"https://img.shields.io/github/license/andy-shady-org/netbox-security?color=2b9348\" alt=\"License Badge\"/></a>\n<a href=\"https://github.com/psf/black\"><img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code Style Black\"/></a>\n<a href=\"https://pepy.tech/project/netbox-security\"><img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/netbox-security\"></a>\n<a href=\"https://pepy.tech/project/netbox-security\"><img alt=\"Downloads/Week\" src=\"https://static.pepy.tech/badge/netbox-security/month\"></a>\n<a href=\"https://pepy.tech/project/netbox-security\"><img alt=\"Downloads/Month\" src=\"https://static.pepy.tech/badge/netbox-security/week\"></a>\n</div>\n\n\n## Features\nThis plugin provides following Models:\n* Addresses\n* Address Sets\n* Address Lists\n* Security Zones\n* Security Zone Policies\n* NAT Pools\n* NAT Pool Members\n* NAT Rule-sets\n* NAT Rules\n* Firewall Filters\n* Firewall Filter Rules\n* Firewall Policers\n\n## Compatibility\n\n| NetBox Version | NetBox Security Version |\n|----------------|-------------------------|\n| NetBox 4.2 | \\>= 1.0.2 |\n| NetBox 4.3 | \\>= 1.1.0 |\n\n## Installation\n\nThe plugin is available as a Python package in pypi and can be installed with pip \n\n```\npip install netbox-security\n```\nEnable the plugin in /opt/netbox/netbox/netbox/configuration.py:\n```\nPLUGINS = ['netbox_security']\n```\nRestart NetBox and add `netbox-security` to your local_requirements.txt\n\nPerform database migrations:\n```bash\ncd /opt/netbox\nsource venv/bin/activate\npython ./netbox/manage.py migrate netbox_security\npython ./netbox/manage.py reindex netbox_security\n```\n\nFull documentation on using plugins with NetBox: [Using Plugins - NetBox Documentation](https://netbox.readthedocs.io/en/stable/plugins/)\n\n\n## Configuration\n\nThe following options are available:\n* `virtual_ext_page`: String (default left) Virtual Machine related objects table position. The following values are available: \nleft, right, full_width. Set empty value for disable.\n* `interface_ext_page`: String (default full_width) Interface related objects table position. The following values are available: \nleft, right, full_width. Set empty value for disable.\n* `address_ext_page`: String (default right) Address/Address Set related objects table position. The following values are available: \nleft, right, full_width. Set empty value for disable.\n* `top_level_menu`: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.\n\n\n## Contribute\n\nContributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)\n\n\n## Documentation\n\nFor further information, please refer to the full documentation: [Using NetBox Security](docs/using_netbox_security.md)\n\n\n## Credits\n\n- Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.\n- Thanks to Dan Sheppard for the abstracted field generation stuff which I also used.\n- Thanks to Kris Beevers and Mark Coleman at Netbox Labs for encouragement and engagement.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Netbox plugin for tracking Security and NAT related objects",
"version": "1.2.7",
"project_urls": {
"Documentation": "https://github.com/andy-shady-org/netbox-security/blob/main/README.md",
"Homepage": "https://github.com/andy-shady-org/netbox-security",
"Issues": "https://github.com/andy-shady-org/netbox-security/issues",
"Repository": "https://github.com/andy-shady-org/netbox-security"
},
"split_keywords": [
"netbox",
" netbox-plugin",
" security"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "42ae3b9df4082e8bddb8bcbc93d56f6f5ad3a638a7ce49eba5e188a8a1d0eab9",
"md5": "c30fcbf186023b9885624c1d1ff78fc0",
"sha256": "99832083c9785a378452528e021ccbf1714b7dc40f873a207b3b4c806e8cbb6b"
},
"downloads": -1,
"filename": "netbox_security-1.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c30fcbf186023b9885624c1d1ff78fc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 158451,
"upload_time": "2025-07-11T10:37:51",
"upload_time_iso_8601": "2025-07-11T10:37:51.399259Z",
"url": "https://files.pythonhosted.org/packages/42/ae/3b9df4082e8bddb8bcbc93d56f6f5ad3a638a7ce49eba5e188a8a1d0eab9/netbox_security-1.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f10a28dd7aaca48e0466916da1e61057ea1308f1ef82cfdd0aaad4028b917f4b",
"md5": "68c4e9a75ae2e20c6f9e8fc9fcdffae9",
"sha256": "befd5af7e1872496c63082ebef5281760f39a38cd261d27ad16385adb130f3ff"
},
"downloads": -1,
"filename": "netbox_security-1.2.7.tar.gz",
"has_sig": false,
"md5_digest": "68c4e9a75ae2e20c6f9e8fc9fcdffae9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 64139,
"upload_time": "2025-07-11T10:37:53",
"upload_time_iso_8601": "2025-07-11T10:37:53.459724Z",
"url": "https://files.pythonhosted.org/packages/f1/0a/28dd7aaca48e0466916da1e61057ea1308f1ef82cfdd0aaad4028b917f4b/netbox_security-1.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 10:37:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andy-shady-org",
"github_project": "netbox-security",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netbox-security"
}
