influx template

• influx CLI 2.0.1+
• InfluxDB 2.0.1+

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 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

Flags

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:

• from a local file
• from multiple files
• from a URL
• from a directory
• using a specific encoding

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

Related

• InfluxDB templates
• influx CLI—Provide required authentication credentials
• influx CLI—Flag patterns and conventions

templates