Snapshot - netdisco/netdisco GitHub Wiki

The snapshot feature takes a complete SNMP image of a device and saves it in the Netdisco database. This can be shared with a developer to help with troubleshooting, or browsed within the web interface.

⚠️
Sharing data might expose private information from your devices. Only share snapshots with those you trust to act responsibly.
⚠️
Importing data from another user is a security risk. Netdisco will process and render this data. Take extreme care!

Before Starting

You need to load an SNMP MIB dataset into your database. At the command-line run:

~/bin/netdisco-do loadmibs

After this when you update Netdisco, the netdisco-deploy script will re-run the loadmibs job for you.

Share a Snapshot

You can ask Netdisco to take the snapshot or do it yourself at the command-line.

Netdisco option

In the web interface: Log in as an admin user. Go to the Details tab for any device, click the Snapshot drop-down menu, then click Create. A job will be queued to take the snapshot. Refresh the page sometime later and the Snapshot button will be green to indicate the file is ready. Click the Snapshot drop-down again, and select Download.

Or, at the command-line:

~/bin/netdisco-do snapshot -d x.x.x.x

snmpwalk option

Run this command:

snmpbulkwalk -v 2c -c <community> -ObentU <device-ip> .1

Sometimes a "bulkwalk" is not successful (it takes a very very long time or the output is too many Megabytes). You can try "snmpwalk" instead, or else use the Netdisco option as above.

Sharing of the snapshot file is left as an exercise to the reader ;-).

Develop with a Snapshot

This process is if you have been sent a snapshot file and need to introduce it to your Netdisco installation as a new device.

Take the shared file, rename it to the IP of the device, and put it in a snapshots folder within Netdisco’s logs folder. Run a discover job on the device IP. Enable debug (-D) to confirm the file is imported.

mkdir ~netdisco/logs/snapshots
mv ~/Downloads/snapshot-file.txt ~netdisco/logs/snapshots/x.x.x.x
~/bin/netdisco-do discover -d x.x.x.x -D

Discovery will create a pseudo device in Netdisco with all properties of the cloned device. You can run ~/bin/netdisco-do show for any data in the snapshot, and of course browse the MIB Objects in the web.

Browse the SNMP Data

Follow the 'Share a Snapshot' steps above and the browsing data is installed. If you import a Snapshot as in 'Develop with a Snapshot', the same happens.

Go to the SNMP tab for the device to browse and search within the captured data.

Caveats

Only the branches and leaves of MIBs in the netdisco-mibs bundle are shown. That is, even if your device returns data for a table or leaf, the browser cannot display it unless the MIB is included in netdisco-mibs.

⚠️ **GitHub.com Fallback** ⚠️