influx task update

  • 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 task update command updates information related to tasks in InfluxDB.

Usage

  1. influx task update [task literal] [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c—active-configCLI configuration to use for commandstring
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-f—filePath to Flux script filestring
-h—helpHelp for the update command
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
—hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
—http-debugInspect communication with InfluxDB servers.string
-i—id(Required) Task IDstring
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
—statusUpdate task status (active or inactive)string
-t—tokenAPI tokenstringINFLUX_TOKEN

Example

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:

Update a task from a Flux string
  1. export UPDATED_FLUX_TASK='
  2. option task = {
  3. name: "Example Task",
  4. every: 1d
  5. }
  6. from(bucket: "example-bucket")
  7. |> range(start: -task.every)
  8. |> filter(fn: (r) => r._measurement == "m")
  9. |> aggregateWindow(every: 1h, fn: mean)
  10. |> to(bucket: "default-ds-1d", org: "my-org")
  11. '
  12. influx task update $UPDATED_FLUX_TASK
Update a task from a Flux file
  1. influx task update --file /path/to/example-task.flux
Enable a task
  1. influx task update --status active
Disable a task
  1. influx task update --status inactive