Support & Community
If you need help, Join our Discord server: https://discord.com/invite/utv9qWsnRY or e-mail us on: support@netpicker.io
NetBox Automation & Config Backup Plugin
Netbox plugin to automatically Automate & Backup your Network with Netpicker.
Compatibility
| NetBox Version | Plugin Version |
|---|---|
| NetBox 4.6 | >= 1.1.x |
| NetBox 4.5 | >= 1.0.x |
| NetBox 4.4 | >= 0.9.x |
| NetBox 4.3 | >= 0.8.x |
Features
- Netpicker Configuration View: Integrated interface for managing Netpicker configurations within Netbox
- Simple Automation: Streamlined automation workflows for network operations
Installation
Option 1: PyPI Installation
The plugin is available as a Python package on PyPI and can be installed with pip:
# Activate your Netbox virtual environment
source /opt/netbox/venv/bin/activate
# Install the plugin
pip install --no-cache-dir netpicker-netbox-plugin
Option 2: Development Installation
For development or custom modifications:
# Clone the repository
git clone <repository-url>
cd netpicker-netbox-plugin
# Install dependencies
poetry install
# Install in development mode
poetry run pip install -e .
Configuration
1. Add to Netbox Configuration
Add the plugin to your netbox.conf.py or environment variables:
PLUGINS = [
'netpicker',
]
2. Run Database Migrations
python manage.py migrate
3. Create Super User (if needed)
python manage.py createsuperuser
4. Restart Netbox
Restart your Netbox service to load the plugin:
# If using systemd
sudo systemctl restart netbox
# If using Docker
docker compose restart netbox
Docker Deployment
The project includes Docker support for easy deployment:
# Start all services
docker compose up -d --build
# View logs
docker compose logs -f netbox
# Stop services
docker compose down
The Docker setup includes:
- Netbox application
- Netbox worker for background tasks
- Netbox housekeeping
- PostgreSQL database
- Redis for caching and sessions
Usage
Once installed and configured, the Netpicker plugin will be available in your Netbox interface:
- Navigate to the Netpicker section in the Netbox navigation
- Access configuration views and automation tools
- Use the API endpoints for programmatic access
API Endpoints
The plugin provides REST API endpoints accessible at /api/plugins/netpicker/.
Development
For development information, see DEVELOPMENT.md.
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Submit a pull request
Support
For issues and questions:
- Create an issue in the repository
- Contact the maintainers
- Send an email to support@netpicker.io
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file netpicker_netbox_plugin-1.1.2.tar.gz.
File metadata
- Download URL: netpicker_netbox_plugin-1.1.2.tar.gz
- Upload date:
- Size: 45.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.13.14 Linux/5.15.0-174-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0fa05039ad473ecd2937fe19e614aa159be75b5ff594bf1ea4c50624bb0d4639
|
|
| MD5 |
0509b404ae452d9fda9580f5d65e183a
|
|
| BLAKE2b-256 |
4374be837b659193de5c9bbe04358cd47b4f4eec371407073286a5ac33803a38
|
File details
Details for the file netpicker_netbox_plugin-1.1.2-py3-none-any.whl.
File metadata
- Download URL: netpicker_netbox_plugin-1.1.2-py3-none-any.whl
- Upload date:
- Size: 68.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.13.14 Linux/5.15.0-174-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
97402b771be16d8d20773a0a4ba359725365fe0352fdd51802b5564afdb2e20a
|
|
| MD5 |
059b12ed0baea875d315c48faff38005
|
|
| BLAKE2b-256 |
fc77a78e00b3e97e52e97955c227b64121b1a977ef35bee31a09a375ab3c2695
|
