ContextQMD
Back to Influxdb

Update

content/shared/influxdb-v2/reference/cli/influx/telegrafs/update.md

latest2.6 KB
Original Source

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

sh
influx telegrafs update [flags]

Flags

FlagDescriptionInput type{{< cli/mapped >}}
-c--active-configCLI configuration to use for commandstring
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-d--descriptionTelegraf configuration descriptionstring
-f--filePath to Telegraf configurationstring
-h--helpHelp for the update command
--hide-headersHide table headersINFLUX_HIDE_HEADERS
--jsonOutput data as JSONINFLUX_OUTPUT_JSON
-n--nameTelegraf configuration namestring
-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

{{< cli/influx-creds-note >}}

Update a Telegraf configuration
sh
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
sh
cat /path/to/telegraf.conf | influx telegrafs update \
  --id 0Xx0oox00XXoxxoo1 \
  --name "Example configuration name" \
  --description "Example Telegraf configuration description" \