mirror of
https://github.com/lucaspalomodevelop/netbox-acls.git
synced 2026-03-12 23:27:23 +00:00
80 lines
2.4 KiB
Markdown
80 lines
2.4 KiB
Markdown
# netbox-access-lists
|
|
|
|
A NetBox plugin for Access List management
|
|
|
|
## Origin
|
|
|
|
Based on the NetBox plugin tutorial by [jeremystretch](https://github.com/jeremystretch):
|
|
|
|
- [demo repo](https://github.com/netbox-community/netbox-plugin-demo)
|
|
- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
|
|
|
|
All credit should go to Jeremy. Thanks Jeremy!
|
|
|
|
This project just looks to build on top of this framework and model presented.
|
|
|
|
## Compatibility
|
|
|
|
This plugin was first developed using 3.2.5, and tested with all of 3.2.0.
|
|
|
|
| NetBox Version | Plugin Version |
|
|
|----------------|----------------|
|
|
| 3.2 | 1.0.0 |
|
|
| 3.3 | TBD |
|
|
|
|
## Installing
|
|
|
|
For adding to a NetBox Docker setup see
|
|
[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
|
|
|
|
While this is still in development and not yet on pypi you can install with pip:
|
|
|
|
```bash
|
|
pip install git+https://github.com/ryanmerolle/netbox-access-lists.git@dev
|
|
```
|
|
|
|
or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
|
|
|
|
```bash
|
|
git+https://github.com/ryanmerolle/netbox-access-lists.git@dev
|
|
```
|
|
|
|
Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
|
|
or if you use netbox-docker, your `/configuration/plugins.py` file :
|
|
|
|
```python
|
|
PLUGINS = [
|
|
'netbox_access_lists'
|
|
]
|
|
|
|
PLUGINS_CONFIG = {
|
|
"netbox_access_lists": {},
|
|
}
|
|
```
|
|
|
|
## Screenshots
|
|
|
|
Access List - List View
|
|
|
|
|
|
Access List (Type Extended) - Individual View
|
|
|
|
|
|
Access List (Type Standard) - Individual View
|
|
|
|
|
|
Extended Access List Rules - List View
|
|
|
|
|
|
Standard Access List Rules - List View
|
|
|
|
|
|
Access List Interface Assignments- List View
|
|
|
|
|
|
Host (device, virtual_chassis, virtual_machine) Access Lists - New Card
|
|
|
|
|
|
Host Interface (vminterface interface) Access Lists - New Card
|
|
|