A NetBox plugin for Access List management
Project description
NetBox Access Lists Plugin
A Netbox plugin for Access List management.
Features
This plugin provides the following models:
- Access Lists
- Access List to Interface Assignment
- Access List Rules (abstract model bassis for other rules)
- Access List Standard Rules
- Access List Extended Rules
Origin
Based on the NetBox plugin tutorial by jeremystretch:
All credit should go to Jeremy. Thanks, Jeremy!
This project just looks to build on top of this framework and model presented.
Contributing
This project is currently maintained jointly by:
See the CONTRIBUTING for more information.
Compatibility
Each Plugin Version listed below has been tested with its corresponding NetBox Version.
NetBox Version | Plugin Version |
---|---|
3.2 | 1.0.1 |
3.3 | 1.1.1 |
3.4 | 1.2.0(coming) |
Installing
For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.
You can install with pip:
pip install netbox-acls
or by adding to your local_requirements.txt
or plugin_requirements.txt
(netbox-docker):
netbox-acls
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py
,
or if you use netbox-docker, your /configuration/plugins.py
file :
PLUGINS = [
'netbox_acls'
]
PLUGINS_CONFIG = {
"netbox_acls": {},
}
Developing
VSCode + Docker + Dev Containers
To develop this plugin further one can use the included .devcontainer configuration. This configuration creates a docker container which includes a fully working netbox installation. Currently it should work when using WSL 2. For this to work make sure you have Docker Desktop installed and the WSL 2 integrations activated.
- In the WSL terminal, enter
code
to run Visual studio code. - Install the devcontainer extension "ms-vscode-remote.remote-containers"
- Press Ctrl+Shift+P and use the "Dev Container: Clone Repository in Container Volume" function to clone this repository. This will take a while depending on your computer
- If you'd like the netbox instance to be prepopulated run
make Makefile example_initializers
andmake Makefile load_initializers
- Start the netbox instance using
make Makefile all
Your netbox instance will be served under 0.0.0.0:8000, so it should now be available under localhost:8000.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for netbox_acls-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e5a8aaf0dbcf9e3db07b744e3aa8742460b8ff9f09e09d99832bc0ed58af24c |
|
MD5 | aafc7b3e946166bb2955295e26df2d9c |
|
BLAKE2b-256 | c143f1a1277070bf9e3edd70a5e599fce5cf818a919beec45f3dfb34ce1ff35d |