To add external libraries for using in the python rules, these are the steps: Modify the docker-compose.override.yml:x-shared-libs: &shared-libs:environment:PYTHONPATH:...
External Python libraries
read more
How can we help?
Category
Backup devices using SSH keys
The private keys must be made available inside agent and kibbitzer containers, so that they are accessible whenever an ssh connection is being opened to the devices. Steps to get...
Entering privileged mode for backups in Netpicker
To allow Netpicker to perform backups on platforms that require elevated privileges, you must configure the kibbitzer container appropriately. This involves setting...
External Git repository sync
This feature allows automatic syncing of configs and rules (local repository) to external Git providers (e.g., GitHub, GitLab). When enabled, any push to the local repository...
HTTPS support for Netpicker
Add an SSL Certificate First, ensure you have the file nginx-ssl.conf in your project folder. If it’s missing, download it from the Netpicker GitHub repository. To add a...
Audit logging
You can set up audit logging by setting an extra parameter in your docker-compose.yml file:x-api: &api_commonimage: netpicker/apienvironment:ENABLE_AUDIT_LOGGING: 1This logs...
Entering configuration / edit / enable / elevated / sudo mode
You can enter ‘configuration mode’, ‘edit mode’, ‘enable mode’, ‘evelated mode’ or ‘sudo mode’ for Linux for a device in a Netpicker rule using:def rule_processes(device):with...
Custom device timeout setup
To use device tags for custom (Netmiko) timeouts for config backups and real-time commands in the test run, you need to add an extra parameter to your docker-compose.yml file....
How to sync Netpicker’s local Git repository for config backups with GitHub
Overview This article explains how to sync data from a local Git repository inside a Docker container to a remote Git repository (e.g., GitHub), using a script executed from the...
Webhooks
Webhooks are triggered after Netpicker completes a process. Use the {{ __ctx__ }} tag in the webhook template to get the results as dictionary or use the {{ __ctx__ | tojson...
Custom config backup command setup
Netpicker supports backing up configs for all Netmiko vendors. By default, it uses the command show running-config to get the config via screen scraping. Watch this quick...
Release notes
How to updateYou can easily update to the latest version by running the following command in the Netpicker directory:bash down.shmv docker-compose.yml docker-compose.yml.bakgit...