If you are using the current version of Cumulus NetQ, the content on this page may not be up to date. The current version of the documentation is available here. If you are redirected to the main page of the user guide, then this page may have been renamed; please search for it there.

Network Snapshots

Snapshots capture a network’s state—including the services running on the network—at a particular point in time. Comparing snapshots lets you check what (if anything) changed in the network, which can be helpful when upgrading a switch or modifying its configuration. This section outlines how to create, compare, and interpret snapshots.

Create a Network Snapshot

To create a snapshot:

  1. From the workbench header, select snapshot, then Create Snapshot:

    modal prompting user to create, compare, view, or delete snapshots
  2. Next, enter the snapshot’s name, time frame, and the elements you’d like included in the snapshot:

    modal prompting user to add name, time frame, and options while creating a snapshot

    To capture the network’s current state, click Now. To capture the network’s state at a previous date and time, click Past, then in the Start Time field, select the calendar icon.

    The Choose options field includes all the elements and services that may run on the network. All are selected by default. Click any element to remove it from the snapshot. Nodes and services are included in all snapshots.

    The Notes field is optional. You can add a note to remind you of the snapshot’s purpose.

  3. Select Finish. The card now appears on your workbench.

  4. When you are finished viewing the snapshot, click Dismiss to remove it from your workbench. You can add it back by selecting snapshot in the header and navigating to the option to view snapshots.

Compare Network Snapshots

You can compare the state of your network before and after an upgrade or other configuration change to help avoid unwanted changes to your network’s state.

To compare network snapshots:

  1. From the workbench header, click snapshot.

  2. Select Compare Snapshots, then select the two snapshots you want to compare.

  3. Click Finish.

If the snapshot cards are already on your workbench, place the cards side-by-side for a high-level comparison. For a more detailed comparison, click Compare on one of the cards and select a snapshot for comparison from the list.

Interpreting the Comparison Data

For each network element with changes, a visualization displays the differences between the two snapshots. Green represents additions, red represents subtractions, and orange represents updates.

In the following example, Snapshot 3 and Snapshot 4 are being compared. Snapshot 3 has a BGP count of 212 and Snapshot 4 has a BGP count of 186. The comparison also shows 98 BGP updates.

comparison data displayed for two snapshots

From this view, you can dismiss the snapshots or select View Details for additional information and to filter and export the data as a JSON file.

The following table describes the information provided for each element type when changes are present:

ElementData Descriptions
BGP
  • Hostname: Name of the host running the BGP session
  • VRF: Virtual route forwarding interface if used
  • BGP Session: Session that was removed or added
  • ASN: Autonomous system number
CLAG
  • Hostname: Name of the host running the CLAG session
  • CLAG Sysmac: MAC address for a bond interface pair that was removed or added
Interface
  • Hostname: Name of the host where the interface resides
  • IF Name: Name of the interface that was removed or added
IP Address
  • Hostname: Name of the host where address was removed or added
  • Prefix: IP address prefix
  • Mask: IP address mask
  • IF Name: Name of the interface that owns the address
Links
  • Hostname: Name of the host where the link was removed or added
  • IF Name: Name of the link
  • Kind: Bond, bridge, eth, loopback, macvlan, swp, vlan, vrf, or vxlan
LLDP
  • Hostname: Name of the discovered host that was removed or added
  • IF Name: Name of the interface
MAC Address
  • Hostname: Name of the host where MAC address resides
  • MAC address: MAC address that was removed or added
  • VLAN: VLAN associated with the MAC address
Neighbor
  • Hostname: Name of the neighbor peer that was removed or added
  • VRF: Virtual route forwarding interface if used
  • IF Name: Name of the neighbor interface
  • IP address: Neighbor IP address
Node
  • Hostname: Name of the network node that was removed or added
OSPF
  • Hostname: Name of the host running the OSPF session
  • IF Name: Name of the associated interface that was removed or added
  • Area: Routing domain for this host device
  • Peer ID: Network subnet address of router with access to the peer device
Route
  • Hostname: Name of the host running the route that was removed or added
  • VRF: Virtual route forwarding interface associated with route
  • Prefix: IP address prefix
Sensors
  • Hostname: Name of the host where sensor resides
  • Kind: Power supply unit, fan, or temperature
  • Name: Name of the sensor that was removed or added
Services
  • Hostname: Name of the host where service is running
  • Name: Name of the service that was removed or added
  • VRF: Virtual route forwarding interface associated with service