influx task update

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+
  • Updated in CLI v2.4.0

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

Usage

1. 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
—script-id (InfluxDB Cloud only) Invokable script ID to execute string
—script-params (InfluxDB Cloud only) Invokable script JSON parameters string
—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 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. }

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

14. influx task update \
15. --id 0001234 \
16. $UPDATED_FLUX_TASK
Update a task from a Flux file
1. influx task update \
2. --id 0001234 \
3. --file /path/to/example-task.flux
Update a task from a script ID
1. influx task update \
2. --id 0001234 \
3. --script-id 0004567
Enable a task
1. influx task update \
2. --id 0001234 \
3. --status active
Disable a task
1. influx task update \
2. --id 0001234 \
3. --status inactive