Back to Influxdb

Index

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

latest2.8 KB
Original Source

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

SubcommandDescription
validateValidate a template

Flags

FlagDescriptionInput Type{{< cli/mapped >}}
--disable-colorDisable color in output
--disable-table-bordersDisable table borders
-e--encodingTemplate encoding (yaml,yml,json, or jsonnet)string
-f--filePath to template file (supports HTTP(S) URLs or file paths)stringArray
-h--helpHelp for the template command
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-R--recurseRecurse 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
sh
influx template --file /path/to/template.yml
Summarize InfluxDB templates from multiple files
sh
influx template \
  --file /path/to/template1.yml \
  --file /path/to/template2.yml
Summarize an InfluxDB template from a URL
sh
influx template --file https://example.com/path/to/template.yml
Summarize all InfluxDB templates in a directory
sh
influx template \
  --file /path/to/template/dir/ \
  --recurse
Specify the encoding of the InfluxDB template to summarize
sh
influx template \
  --file /path/to/template \
  --encoding json