grafana-util docs

grafana-util-dashboard-list-vars.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-dashboard-list-vars - List dashboard templating variables and datasource-like choices from live Grafana, a local dashboard file, or a local export tree.

SYNOPSIS

grafana-util dashboard list-vars [OPTIONS]

DESCRIPTION

List dashboard templating variables and datasource-like choices from live Grafana, a local dashboard file, or a local export tree.

Use this when you need to list variable state, feed a screenshot workflow, debug variable-scoped dashboard URLs, or inspect a rendered local dashboard file.

COMMON OPTIONS

--dashboard-uid or --dashboard-url
choose the dashboard to inspect for variable values.
--input
read one local dashboard JSON file instead of calling Grafana.
--input-dir
read a dashboard from a local export tree instead of calling Grafana.
--input-format
interpret --input-dir as raw or provisioning.
--vars-query
overlay a variable query string such as var-env=prod&var-host=web01.
--org-id
scope the inspection to one org.
--output-format
render table, csv, text, json, or yaml.
--no-header
suppress table or CSV headers.
--output-file
write a copy of the output to disk.

EXAMPLES

List dashboard templating variables and datasource-like choices from live Grafana, a local dashboard file, or a local export tree.

grafana-util dashboard list-vars --dashboard-url 'https://grafana.example.com/d/cpu-main/cpu-overview?var-cluster=prod-a' --profile prod --output-format table

SEE ALSO

grafana-util(1), grafana-util-dashboard(1)