influx telegrafs update
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 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, --orgor--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!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.