docs-v2/content/shared/influxdb-v2/reference/cli/influx/template/_index.md

2.8 KiB

The influx template command summarizes the specified InfluxDB template. The command returns information about all resources included in the template.

Usage

influx template [flags]
influx template [command]

Subcommands

Subcommand Description
validate Validate a template

Flags

Flag Description Input Type {{< cli/mapped >}}
--disable-color Disable color in output
--disable-table-borders Disable table borders
-e --encoding Template encoding (yaml,yml,json, or jsonnet) string
-f --file Path to template file (supports HTTP(S) URLs or file paths) stringArray
-h --help Help for the template command
--json Output data as JSON (default false) INFLUX_OUTPUT_JSON
-R --recurse Recurse through files in the directory specified in -f, --file

Examples

{{< cli/influx-creds-note >}}

Summarize InfluxDB Templates:

Summarize an InfluxDB template from a local file
influx template --file /path/to/template.yml
Summarize InfluxDB templates from multiple files
influx template \
  --file /path/to/template1.yml \
  --file /path/to/template2.yml
Summarize an InfluxDB template from a URL
influx template --file https://example.com/path/to/template.yml
Summarize all InfluxDB templates in a directory
influx template \
  --file /path/to/template/dir/ \
  --recurse
Specify the encoding of the InfluxDB template to summarize
influx template \
  --file /path/to/template \
  --encoding json