Documentation

influx template

This page documents an earlier version of InfluxDB. InfluxDB v2.1 is the latest stable version. View this page in the v2.1 documentation.

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 Maps to ?
--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

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 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

Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.