To allow Netpicker to perform backups on platforms that require elevated privileges, you must configure the kibbitzer container appropriately. This involves setting the ...
Entering privileged mode for backups in Netpicker
read more...
How can we help?
Category
Using custom TextFSM templates
First, place your TextFSM index and templates in a directory on the host machine. Then, edit the x-api section in docker-compose.override.yml by Adding a new environment...
Reset default admin password
To reset the default admin password to 12345678 in Netpicker, you can execute the following command on the Netpicker host machine: docker exec -ti db sh -c "echo update...
Run real-time commands
Normally with Python rules, you have to have some backups for Netpicker to test your assertion against. First, let’s run a test and see if we have the word “ospf” in the...
Automation: Jobs and Workflows
In the automation section you can take your devices, and run jobs on them. These jobs are written in python code and will allow you to execute cli commands on your device. You...
Using multiple tenants in Netpicker (multi-tenancy)
In Netpicker, you can set up multiple tenants to isolate your devices and administer them in separate workspaces. Each tenant has its own devices and users can be given access to...
Adding CVEasy verified CVE rules to Netpicker
First, clone the git repository with the Netpicker Policies and rules using the git clone command that can be found on the Netpicker Policies page: This should give you a local...
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: 1 This...
System requirements
If you need help setting up Netpicker on your system, contact us and one of our engineers can help and advise you. Requirements for the Docker images An operating system with the...
Dedicated network connections
Netpicker provides the option to use dedicated network connections when connecting using SSH to your devices. By default, this is not enabled because it can slow down running the...
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...
Netpicker Test Creator (Custom ChatGPT)
To help network engineers writing Python tests for their use cases, we created a Custom ChatGPT called Netpicker Test Creator. Watch this tutorial for a quick guide: Check it...
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...
Netpicker architecture overview
Netpicker is an on-premise containerized solution designed to automate network device configuration and testing. The architecture leverages Docker containers, role-based access,...
NetBox integration
Netpicker supports pynetbox, the Python API client library for NetBox. To set it up, you need to provide the API endpoint and your token as two extra environment variables...
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...