influx template

  • influx CLI 2.0.1+
  • InfluxDB 2.0.1+

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

Usage

1. influx template [flags]
2. 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 either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

  • --host: InfluxDB host
  • -o, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token

Summarize InfluxDB Templates:

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

templates