What can I use Netpicker for?
Netpicker is designed for network and NetDevOps engineers. We aim to provide the best tools possible for network design validation, security assessments and network compliance audits.
For network engineers, Netpicker provides you with:
- Periodic, automated, scheduled backups of the configurations of all your network devices (117+ supported vendors)
- An easy-to-use, graphical interface to check the configs of your devices and run real-time show commands
- Built-in comparison of device configs, useful in case of change management audits, pre- and post-change checks, post-mortems after security incidents
- A CIS test library to check for best practices and common misconfigurations for most major vendors
- A CVE test library to check for known vulnerabilities in your devices, unpatched or outdated versions
For NetDevOps engineers, Netpicker provides powerful tools to automate your network configuration management:
- A graphical interface to test and debug your Python scripts against your network devices with real-time feedback
- A powerful REST API that enables you to automate everything you can do manually in Netpicker
- A fully open data set-up: you can export and import your Python tests and device backups from the underlying Git repository
What do I get with Netpicker?
We see Netpicker as a platform for network testing and automation. This means that Netpicker provides the building blocks you need to build your own tests. We provide:
- a test runner
- example Python test scripts
- documentation on how to write your own tests
- a GUI for running, scheduling and debugging tests
- an API which you can use to automate things
The rest is up to you! We encourage sharing your tests with the open-source NetDevOps community and will be actively participating ourselves.
What you can test
Write your own tests.
Use your Python skills for maximum flexibility.
Netpicker enables you to run automated Python tests against your device configurations, show command output and real-time data from APIs like Netbox or Slurp’it. We provide libraries in pytest format for CIS hardening, common design validations, CVE checks and many more. You can use any Python code you want to create the test you need for your use case.
Easy to use
Not a coder? No problem.
Use our powerful GUI to get things done.
Type
Command
show arp
Must include the text:
Regular expression?
192.168.60.32
Command output
show arp: Protocol Address Age (min) Hardware Addr Type Interface Internet 192.168.60.2 97 000c.292e.36b6 ARPA Ethernet0/3 Internet 192.168.60.32 214 000c.2987.5096 ARPA Ethernet0/3 Internet 192.168.60.101 196 5000.0001.0000 ARPA Ethernet0/3
Netpicker is designed for network and NetDevOps engineers. We provide an easy-to-use, graphical interface to check the configs of your devices and run real-time show commands.
Open source
Community-supported libraries.
Included with Netpicker.
Netpicker has an active open-source community on Slack and GitHub. We are constantly adding new vendor modules for our Kopimiko device backup library and adding new CIS and CVE tests to our pytest-for-networking repository. We invite you to join our community on Slack and contribute to the project.
Integration
Engineer-friendly REST API.
For all your automation desires.
Devices
GET /api/v1/devices/{tenant}/ Get all devices
GET /api/v1/devices/{tenant}/{device} Get device
PATCH /api/v1/devices/{tenant}/ Edit device
DELETE /api/v1/devices/{tenant}/ Delete device
POST /api/v1/devices/{tenant}/ Create device
Netpicker provides a REST API to manage your devices, backups and tests. You can run CLI show commands, run tests, and restore backups from the API. The API is documented with Swagger / OpenAPI and you can try it out in our sandbox environment.
For some example use cases, check out our Use Cases page or Get started with Netpicker right away!