Documentation

influx telegrafs update

The influx telegrafs update command updates a Telegraf configuration to match the specified parameters. If a name or description are not provided, they are set to an empty string.

Usage

influx telegrafs update [flags]

Flags

Flag Description Input type Maps to ?
-c --active-config CLI configuration to use for command string
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-d --description Telegraf configuration description string
-f --file Path to Telegraf configuration string
-h --help Help for the update command
--hide-headers Hide table headers INFLUX_HIDE_HEADERS
--json Output data as JSON INFLUX_OUTPUT_JSON
-n --name Telegraf configuration name string
-o --org Organization name (mutually exclusive with --org-id) string INFLUX_ORG
--org-id Organization ID (mutually exclusive with --org) string INFLUX_ORG_ID
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
-t --token API token string INFLUX_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
Update a Telegraf configuration
influx telegrafs update \
  --id 0Xx0oox00XXoxxoo1 \
  --name "Example configuration name" \
  --description "Example Telegraf configuration description" \
  --file /path/to/telegraf.conf
Update a Telegraf configuration via stdin
cat /path/to/telegraf.conf | influx telegrafs update \
  --id 0Xx0oox00XXoxxoo1 \
  --name "Example configuration name" \
  --description "Example Telegraf configuration description" \

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: