Documentation

influx task update

The influx task update command updates information related to tasks in InfluxDB.

Usage

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
-i--id(Required) Task IDstring
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
--skip-verifySkip TLS certificate verification
--statusUpdate task status (active or inactive)string
-t--tokenAuthentication tokenstringINFLUX_TOKEN

Example

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

Update a task from a Flux string
export UPDATED_FLUX_TASK='
  option task = {
    name: "Example Task",
    every: 1d
  }

  from(bucket: "example-bucket")
    |> range(start: -task.every)
    |> filter(fn: (r) => (r._measurement == "m")
    |> aggregateWindow(every: 1h, fn: mean)
    |> to(bucket: "default-ds-1d", org: "my-org")
'

influx task update $UPDATED_FLUX_TASK
Update a task from a Flux file
influx task update --file /path/to/example-task.flux
Enable a task
influx task update --status active
Disable a task
influx task update --status inactive

Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: