influx telegrafs

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+

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 telegrafs command lists Telegraf configurations. Subcommands manage Telegraf configurations.

Usage

  1. influx telegrafs [flags]
  2. influx telegrafs [command]

Subcommands

SubcommandDescription
createCreate a Telegraf configuration
rmRemove a Telegraf configuration
updateUpdate a Telegraf configuration

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-h—helpHelp for the telegrafs command
—hide-headersHide table headersINFLUX_HIDE_HEADERS
-i—idTelegraf configuration ID to retrievestring
—jsonOutput data as JSONINFLUX_OUTPUT_JSON
-o—orgOrganization name (mutually exclusive with —org-id)stringINFLUX_ORG
—org-idOrganization ID (mutually exclusive with —org)stringINFLUX_ORG_ID
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t—tokenAPI tokenstringINFLUX_TOKEN

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
List all Telegraf configurations
  1. influx telegrafs
List a Telegraf configuration with the specified ID
  1. influx telegrafs --id 0Xx0oox00XXoxxoo1

telegraf