influx template

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


influx template [flags]
influx template [command]


validateValidate a template


FlagDescriptionInput TypeMaps to ?
--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


Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

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
Summarize all InfluxDB templates in a directory
influx template \
  --file /path/to/template/dir/ \
Specify the encoding of the InfluxDB template to summarize
influx template \
  --file /path/to/template \
  --encoding json

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.