grafana-util-snapshot.1
Browser-readable rendering of a generated roff manpage.
This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.
NAME
grafana-util-snapshot - export and review Grafana snapshot inventory bundles
SYNOPSIS
grafana-util snapshot [SUBCOMMAND] [OPTIONS]
DESCRIPTION
export and review Grafana snapshot inventory bundles.
when you want a local snapshot root that captures dashboard, datasource, and access inventory for later inspection.
BEFORE / AFTER
- Before: snapshot-style review usually means re-querying Grafana or opening a pile of dashboards, datasources, and access records one by one.
- After: export first, then review the local bundle as a repeatable artifact without touching the live server again.
SUBCOMMANDS
- export
- export dashboard, datasource, and access inventory into a local snapshot bundle. Use when: Need a local snapshot root that can be reviewed without Grafana access.
- review
- review a local snapshot inventory without touching Grafana. Use when: Want to inspect an exported snapshot root as table, csv, text, json, yaml, or interactive output.
SUCCESS CRITERIA
- you can hand off a snapshot root and another operator can inspect it without asking for live access
- export output is a durable artifact instead of a temporary UI session
- the snapshot root includes lane metadata that later analysis can resolve without rescanning the whole tree
- review output is clear enough to feed into a follow-up analysis or incident note
FAILURE CHECKS
- if a snapshot export looks empty, verify the auth profile or live connection before assuming the source system is blank
- if review output looks surprising, confirm that you are pointing at the intended snapshot directory
- if automation reads the output, keep the chosen --output-format explicit so the downstream parser knows the contract
Key flags: the root command is a namespace; the operational flags live on export and review. The shared root flag is --color.
Examples:
# Purpose: Export a local snapshot bundle from live Grafana.
grafana-util snapshot export --url http://localhost:3000 --basic-user admin --basic-password admin --output-dir ./snapshot
# Purpose: Review the exported snapshot bundle as JSON.
grafana-util snapshot review --input-dir ./snapshot --output-format json
Related commands: grafana-util overview, grafana-util status staged, grafana-util change bundle.
SEE ALSO
grafana-util(1), grafana-util-status(1), grafana-util-overview(1), grafana-util-dashboard(1), grafana-util-datasource(1), grafana-util-change(1)