Archived documentation version rendered and hosted by DevNetExpertTraining.com
Documentation

influx task update

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

Usage

influx task update [task literal] [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
-f --file Path to Flux script file string
-h --help Help for the update command
--hide-headers Hide table headers (default false) INFLUX_HIDE_HEADERS
--host HTTP address of InfluxDB (default http://localhost:8086) string INFLUX_HOST
--http-debug Inspect communication with InfluxDB servers. string
-i --id (Required) Task ID string
--json Output data as JSON (default false) INFLUX_OUTPUT_JSON
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
--status Update task status (active or inactive) string
-t --token API token string INFLUX_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

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.