Skip to content
User Guide

Manage → Configuration → Snaps

Reached from Manage via the Configuration entry at the bottom of the browse tree.

Choose which elements of a device’s configuration MisterShell captures each time it takes a config snapshot. Different resource types expose different elements — for example, a Cisco device exposes its Running Config; an AWS account exposes per-service bodies.

How a snapshot is captured

One snapshot runs a single collection session and produces several outputs at once — configuration, health, and facts are siblings, not derived from one another:

flowchart TB
  trigger["Scheduled or manual snapshot"]
  ssh["One collection session to the resource<br/>runs the collection commands"]
  parse["Output parsed into structured data"]
  trigger --> ssh --> parse
  parse --> cfg["Configuration<br/>versioned · diff + changed elements"]
  parse --> health["Health metrics<br/>thresholds → healthy / degraded / critical"]
  parse --> facts["Facts<br/>normalized, vendor-neutral"]
  facts --> comp["Compliance evaluated<br/>against your fact-policy rules"]
  cfg --> vcfg["History &amp; change log"]
  health --> vhealth["Health &amp; dashboards"]
  comp --> vcomp["Compliance heatmap"]

The tab is split in two columns. The left column lists resource types; the right column shows the snapshot elements defined for the selected type.

What you can do

  • Pick a resource type on the left and see its snapshot elements on the right.
  • Toggle an element on or off to include or exclude it from future snapshots.
  • Drag-reorder elements to change the order they appear in stored snapshots and diffs.
  • Reset a single element back to its shipped default.

Existing snapshots are never modified — changes only apply to the next snapshot taken for resources of that type.

Common tasks

Turn off an element for a resource type

  1. Click the resource type in the left column. The counter badge shows enabled / total elements.
  2. In the right column, flip the green toggle on the element you want to exclude.
  3. A “disabled” notification confirms the save.

Re-order elements

  1. Grab the ⋮⋮ drag handle on the left of an element card.
  2. Drop it at the new position. A “Snap elements reordered” notification confirms the save.

Reset an element to default

  1. Click the orange circular refresh icon on the element’s row.
  2. Confirm the dialog. Both the enabled state and the display order revert to the shipped default for that element.

Fields

Each element card shows:

FieldMeaning
ToggleWhether the element is captured on the next snapshot
NameThe element’s display name (e.g. Running Config)
DescriptionWhat the element contains
ResetRestore the shipped default

Warnings

If every element is disabled for a type, a yellow banner appears at the top of the right column:

All elements are disabled. Config snapshots for this resource type will fail to persist until at least one element is re-enabled.

Re-enable at least one element to resume collection.

Permissions

  • The tab is shown only to users with app.snaps.write, which also covers every action on it (toggle / reorder / reset).
  • Reading the snap configuration through the API uses app.snaps.read.