# Return to the knowledge base

Category

Knowledge Base, Netbox

How to update the Netpicker NetBox plugin

Follow these steps to update the Netpicker plugin in a standard NetBox installation under /opt/netbox.

Before you begin

  • Plan a short maintenance window because NetBox services must be restarted.
  • Check the Netpicker NetBox plugin page on PyPI and confirm that the plugin version supports your NetBox version.
  • Back up your NetBox database and configuration before changing the installed package.

1. Update the Python package

Run the following command to install the latest compatible release in NetBox’s virtual environment:

sudo /opt/netbox/venv/bin/python3 -m pip install --no-cache-dir --upgrade netpicker-netbox-plugin

If you manage additional packages through /opt/netbox/local_requirements.txt, make sure it also contains:

netpicker-netbox-plugin

This ensures that the plugin is reinstalled if the NetBox virtual environment is rebuilt.

2. Confirm that the plugin is enabled

Open NetBox’s configuration/plugins.py file. In a standard installation, this is commonly located at /opt/netbox/netbox/netbox/configuration/plugins.py.

Make sure the PLUGINS setting includes netpicker:

PLUGINS = ["netpicker"]

If other plugins are already enabled, keep their entries and add "netpicker" to the existing list.

3. Apply database migrations and collect static files

cd /opt/netbox
sudo -u netbox /opt/netbox/venv/bin/python3 netbox/manage.py migrate
sudo -u netbox /opt/netbox/venv/bin/python3 netbox/manage.py collectstatic --no-input

Running the migration command is safe even when the new plugin version does not include database migrations.

4. Restart NetBox

Restart both the NetBox web service and its background workers:

sudo systemctl restart netbox netbox-rq

A full server reboot also reloads the plugin, but it is normally unnecessary.

5. Verify the update

Check the installed plugin version and confirm that both services are running:

/opt/netbox/venv/bin/python3 -m pip show netpicker-netbox-plugin
sudo systemctl status netbox netbox-rq --no-pager

Sign in to NetBox and confirm that the Netpicker menu and plugin pages load normally. If a service fails to start, inspect the recent logs:

sudo journalctl -u netbox -u netbox-rq -n 100 --no-pager

For current releases, compatibility details, and package downloads, see the Netpicker NetBox plugin on PyPI.

Would you like a hands-on session?

A couple times a week our in-house trainer is available for a private or group session. In this session we can cover our Slurp'it or Mock'it solution but also integrations with Netpicker, NetBox, Nautobot & Infrahub.

Book a workshop
Yes, keep me informed

Connect with us on LinkedIn to stay updated on the latest happenings, news, and exciting developments at Slurp'it. Just click the button below to follow us and be a part of our professional network.

Newsletter