Add `INFLUX_SKIP_VERIFY` to `influx` CLI docs (#3048)

Closes #3046
pull/3057/head
pierwill 2021-08-20 14:45:43 -05:00 committed by GitHub
parent edcf8f713a
commit 234a65b7d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
67 changed files with 373 additions and 373 deletions

View File

@ -20,24 +20,24 @@ influx bucket-schema create [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :------------------ | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | ({{< req >}}) Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | ({{< req >}}) Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--columns-file` | ({{< req >}}) Path to column definitions file. For more information, see [Create a columns file](/influxdb/cloud/reference/cli/influx/bucket-schema/create/#create-a-columns-file). | string | |
| | `--columns-format` | Columns file format (`csv`, `ndjson`, `json`, default: `auto`). For more information, see [Create a schema with columns format](#create-a-schema-with-columns-format) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | ({{< req >}}) Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | ({{< req >}}) Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--columns-file` | ({{< req >}}) Path to column definitions file. For more information, see [Create a columns file](/influxdb/cloud/reference/cli/influx/bucket-schema/create/#create-a-columns-file). | string | |
| | `--columns-format` | Columns file format (`csv`, `ndjson`, `json`, default: `auto`). For more information, see [Create a schema with columns format](#create-a-schema-with-columns-format) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -22,21 +22,21 @@ influx bucket-schema list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :------------------ | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
|:-----|:--------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-n` | `--name` | Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -29,24 +29,24 @@ influx bucket-schema update [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :------------------ | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | ({{< req >}}) Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | ({{< req >}}) Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--columns-file` | ({{< req >}}) Path to column definitions file. For more information, see [Create a columns file](/influxdb/cloud/reference/cli/influx/bucket-schema/create/#create-a-columns-file). | string | |
| | `--columns-format` | Columns file format (`csv`, `ndjson`, `json`, default: `auto`). For more information, see [Update a schema with columns format](#update-a-schema-with-columns-format) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-n` | `--bucket` | ({{< req >}}) Bucket name (mutually exclusive with `--bucket-id`) | string | |
| `-i` | `--bucket-id` | ({{< req >}}) Bucket ID (mutually exclusive with `--bucket`) | string | |
| | `--columns-file` | ({{< req >}}) Path to column definitions file. For more information, see [Create a columns file](/influxdb/cloud/reference/cli/influx/bucket-schema/create/#create-a-columns-file). | string | |
| | `--columns-format` | Columns file format (`csv`, `ndjson`, `json`, default: `auto`). For more information, see [Update a schema with columns format](#update-a-schema-with-columns-format) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-x` | `--extended-output` | Print column information for each measurement schema (default: false) | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Measurement name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -38,23 +38,23 @@ influx restore [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Name of the bucket to restore (mutually exclusive with `--bucket-id`) | string | |
| | `--bucket-id` | ID of the bucket to restore (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| | `--full` | Fully restore and replace all data on server | | |
| `-h` | `--help` | Help for the `restore` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--new-bucket` | Name of the bucket to restore to | string | |
| | `--new-org` | Name of the organization to restore to | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Name of the bucket to restore (mutually exclusive with `--bucket-id`) | string | |
| | `--bucket-id` | ID of the bucket to restore (mutually exclusive with `--bucket`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--full` | Fully restore and replace all data on server | | |
| `-h` | `--help` | Help for the `restore` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--new-bucket` | Name of the bucket to restore to | string | |
| | `--new-org` | Name of the organization to restore to | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -44,7 +44,7 @@ influx apply [flags]
| `-q` | `--quiet` | Disable output printing | | |
| `-R` | `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | | |
| | `--secret` | Secrets to provide with the template (format: `--secret=SECRET_KEY=SECRET_VALUE`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--stack-id` | Stack ID to associate when applying the template | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -27,7 +27,7 @@ influx auth active [flags]
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Example

View File

@ -39,7 +39,7 @@ influx auth create [flags]
| | `--read-tasks` | Grant permission to read tasks | | |
| | `--read-telegrafs` | Grant permission to read Telegraf configurations | | |
| | `--read-user` | Grant permission to read organization users | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--write-bucket` | Grant permission to write to specified a bucket ID | stringArray | |

View File

@ -26,7 +26,7 @@ influx auth delete [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -34,7 +34,7 @@ influx auth inactive [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) API token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -33,7 +33,7 @@ influx auth list [flags]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |

View File

@ -37,7 +37,7 @@ influx backup [flags] path
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | string | |
| | `--skip-verify` | Skip TLS certificate verification | string | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -30,12 +30,12 @@ influx bucket [command]
| [update](/influxdb/v2.0/reference/cli/influx/bucket/update) | Update bucket |
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `bucket` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:-----------|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `bucket` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -25,24 +25,24 @@ influx bucket create [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :----------------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | string | |
| `-h` | `--help` | Help for the `create` 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 | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-r` | `--retention` | Duration bucket retains data (0 is infinite, default is 0) | duration | |
| | `--schema-type` | Bucket schema type (`explicit`, default `implicit`) _(Cloud only)_. For more information, see [Manage bucket schema](/influxdb/cloud/organizations/buckets/bucket-schema/). | string | |
| | `--shard-group-duration` | Bucket shard group duration (OSS only) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | string | |
| `-h` | `--help` | Help for the `create` 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 | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-r` | `--retention` | Duration bucket retains data (0 is infinite, default is 0) | duration | |
| | `--schema-type` | Bucket schema type (`explicit`, default `implicit`) _(Cloud only)_. For more information, see [Manage bucket schema](/influxdb/cloud/organizations/buckets/bucket-schema/). | string | |
| | `--shard-group-duration` | Bucket shard group duration (OSS only) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

View File

@ -22,21 +22,21 @@ influx bucket delete [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` 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` | Bucket ID _(required if no `--name`)_ | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name _(requires `--org` or `org-id`)_ | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` 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` | Bucket ID _(required if no `--name`)_ | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name _(requires `--org` or `org-id`)_ | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -22,21 +22,21 @@ influx bucket list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` 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` | Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` 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` | Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -23,22 +23,22 @@ influx bucket update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | 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` | ({{< req >}}) Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
| `-r` | `--retention` | New duration bucket will retain data | duration | |
| | `--shard-group-duration` | Custom shard group duration for the bucket (OSS only) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:-------------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Bucket description | 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` | ({{< req >}}) Bucket ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
| `-r` | `--retention` | New duration bucket will retain data | duration | |
| | `--shard-group-duration` | Custom shard group duration for the bucket (OSS only) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

View File

@ -33,7 +33,7 @@ influx dashboards [flags]
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -36,7 +36,7 @@ Running `influx delete` without the `-p` or `--predicate` flag deletes all data
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/influxdb/v2.0/reference/syntax/delete-predicate)) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--start` | ({{< req >}}) Start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| | `--stop` | ({{< req >}}) Stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -54,7 +54,7 @@ influx export [command]
| | `--resource-type` | Resource type associated with all IDs via stdin | string | |
| | `--rule-names` | Comma-separated list of notification rule names | string | |
| | `--rules` | Comma-separated list of notification rule IDs | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--stack-id` | Stack ID to include resources from in export | string | |
| | `--task-names` | Comma-separated list of task names | string | |
| | `--tasks` | Comma-separated list of task IDs | string | |

View File

@ -42,7 +42,7 @@ influx export all [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name that owns the resources (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -38,7 +38,7 @@ influx export stack <stack_id> [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name that owns the resources (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the resources (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -16,19 +16,19 @@ influx org create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Description of the organization | | |
| `-h` | `--help` | Help for the `create` 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 | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Organization name | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Description of the organization | | |
| `-h` | `--help` | Help for the `create` 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 | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Organization name | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -26,7 +26,7 @@ influx org delete [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -32,7 +32,7 @@ influx org list [flags]
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -25,7 +25,7 @@ influx org members list [flags]
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -16,16 +16,16 @@ influx org members remove [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `remove` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | Member ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:----------------|:-----------------------------------------------------------|:----------:|:---------------------|
| `-h` | `--help` | Help for the `remove` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | Member ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -28,7 +28,7 @@ influx org update [flags]
| `-i` | `--id` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | New organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -25,10 +25,10 @@ influx ping [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------- | :-------------------- |
|:-----|:------------------|:----------------------------------------------------------------------|:-----------|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `ping` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |

View File

@ -48,7 +48,7 @@ drop columns such as `_start` and `_stop` to optimize the download file size.
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--profilers` | Flux query profilers to enable (comma-separated) | string | |
| `-r` | `--raw` | Output raw query results (annotated CSV) | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -40,5 +40,5 @@ To use the Flux REPL, you must first authenticate with a [token](/influxdb/v2.0/
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -58,7 +58,7 @@ influx restore [flags]
| | `--new-org` | Name of the organization to restore to | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -29,7 +29,7 @@ influx secret delete [flags]
| `-k` | `--key` | ({{< req >}}) Secret key | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -21,18 +21,18 @@ influx secret list [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` 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 | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -38,7 +38,7 @@ influx secret update [flags]
| `-k` | `--key` | ({{< req >}}) Secret key | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | ({{< req >}}) Secret value | string | |

View File

@ -30,20 +30,20 @@ influx setup [flags]
## Flags
| Flag | | Description | Data type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :-------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Primary bucket name | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
|:-----|:------------------|:----------------------------------------------------------------------|:---------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Primary bucket name | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-f` | `--force` | Skip confirmation prompt | | |
| `-h` | `--help` | Help for the `setup` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Primary organization name | string | |
| `-p` | `--password` | Password for primary user | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-o` | `--org` | Primary organization name | string | |
| `-p` | `--password` | Password for primary user | string | |
| `-r` | `--retention` | Duration bucket will retain data (0 is infinite, default is 0) | duration | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Token for admin user (auto-generated by default) | string | `INFLUX_TOKEN` |
| `-u` | `--username` | Primary username | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | Token for admin user (auto-generated by default) | string | `INFLUX_TOKEN` |
| `-u` | `--username` | Primary username | string | |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),
@ -65,4 +65,4 @@ influx setup \
--username example-user \
--password ExAmPl3PA55W0rD \
--force
```
```

View File

@ -45,7 +45,7 @@ influx stacks [command]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--stack-id` | Stack IDs to filter by | stringArray | |
| | `--stack-name` | Stack names to filter by | stringArray | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -30,7 +30,7 @@ influx stacks init [flags]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-u` | `--template-url` | Template URLs to associate with a stack | list of strings | |

View File

@ -34,7 +34,7 @@ influx stacks remove [flags]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--stack-id` | Stack IDs to remove | list of strings | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -29,7 +29,7 @@ influx stacks update [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--stack-id` | The stack ID to update | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-u` | `--template-url` | Template URLs to associate with a stack | list of strings | |

View File

@ -28,7 +28,7 @@ influx task create [task literal] [flags]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Example

View File

@ -26,7 +26,7 @@ influx task delete [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -34,7 +34,7 @@ influx task list [flags]
| | `--limit` | Number of tasks to find (default `100`) | integer | |
| `-o` | `--org` | Task organization name | string | `INFLUX_ORG` |
| | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-n` | `--user-id` | Task owner ID | string | |

View File

@ -31,7 +31,7 @@ influx task log list [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--run-id` | Run ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -31,7 +31,7 @@ influx task retry-failed [flags]
| `-o` | `--org` | Task organization name | string | `INFLUX_ORG` |
| | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| | `--run-limit` | Maximum number of failed runs to retry per task (`1-500`, default `100`) | integer | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--task-limit` | Maximum number of tasks to retry failed runs for (`1-500`, default `100`) | integer | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -34,7 +34,7 @@ influx task run list [flags]
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--limit` | Limit the number of results | integer | |
| | `--run-id` | Run ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -24,7 +24,7 @@ influx task run retry [flags]
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-r` | `--run-id` | ({{< req >}}) Run ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-i` | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -27,7 +27,7 @@ influx task update [task literal] [flags]
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--status` | Update task status (`active` or `inactive`) | string | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |

View File

@ -33,18 +33,18 @@ influx telegrafs [command]
| [update](/influxdb/v2.0/reference/cli/influx/telegrafs/update) | Update a Telegraf configuration |
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `telegrafs` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| `-i` | `--id` | Telegraf configuration ID to retrieve | string | |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `telegrafs` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| `-i` | `--id` | Telegraf configuration ID to retrieve | string | |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -1,5 +1,5 @@
---
title: influx telegrafs create
title: influx telegrafs create
description: >
The `influx telegrafs create` command creates a Telegraf configuration in InfluxDB
using a provided Telegraf configuration file.
@ -19,20 +19,20 @@ influx telegrafs create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Telegraf configuration description | string | |
| `-f` | `--file` | Path to Telegraf configuration | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Telegraf configuration name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Telegraf configuration description | string | |
| `-f` | `--file` | Path to Telegraf configuration | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Telegraf configuration name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -21,15 +21,15 @@ influx telegrafs rm [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
|:-----|:------------------|:----------------------------------------------------------------------|:-----------:|:-----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `rm` command | | |
| | `--hide-headers` | Hide the table headers | | `$INFLUX_HIDE_HEADERS` |
| `-i` | `--id` | Telegraf configuration ID to remove | stringArray | |
| | `--json` | Output data as json | | `$INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -19,20 +19,20 @@ influx telegrafs update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Telegraf configuration description | string | |
| `-f` | `--file` | Path to Telegraf configuration | string | |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Telegraf configuration name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Telegraf configuration description | string | |
| `-f` | `--file` | Path to Telegraf configuration | string | |
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Telegraf configuration name | string | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -17,20 +17,20 @@ influx user create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Username | string | `INFLUX_NAME` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--password` | User password | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | ({{< req >}}) Username | string | `INFLUX_NAME` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--password` | User password | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -17,17 +17,17 @@ influx user delete [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) User ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) User ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -22,18 +22,18 @@ influx user list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | User ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Username | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `list` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | User ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Username | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -18,18 +18,18 @@ influx user update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-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` |
| `-i` | `--id` | ({{< req >}}) User ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Username | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:----------------------------------------------------------------------|:----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-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` |
| `-i` | `--id` | ({{< req >}}) User ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-n` | `--name` | Username | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
## Examples

View File

@ -19,7 +19,7 @@ influx v1 auth create [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:------------------------------------------------------------------------------------------------------- |:-----------:|:------------------------|
|:-----|:------------------|:-----------------------------------------------------------------------------------------------------------|:-----------:|:------------------------|
| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` |
| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` |
| `-d` | `--description` | Token description | string | |
@ -32,8 +32,8 @@ influx v1 auth create [flags]
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| | `--password` | Password to set on the authorization | | |
| | `--read-bucket` | Bucket ID to assign read permissions to | stringArray | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--username` | ({{< req >}}) Token username | string | |
| | `--write-bucket` | Bucket ID to assign write permissions to | stringArray | |

View File

@ -27,8 +27,8 @@ influx v1 auth delete [flags]
| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) Authorization ID | string | |
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--username` | Authorization username | string | `$INFLUX_USERNAME` |
## Examples

View File

@ -32,8 +32,8 @@ influx v1 auth list [flags]
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| `-u` | `--user` | InfluxDB user | string | |
| | `--user-id` | InfluxDB user ID | string | |
| | `--username` | Authorization username | string | `$INFLUX_USERNAME` |

View File

@ -28,8 +28,8 @@ influx v1 auth set-active [flags]
| | `--host` | ({{< req >}}) HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| `-i` | `--id` | Authorization ID | string | |
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--username` | Authorization username | string | `$INFLUX_USERNAME` |
## Examples

View File

@ -28,8 +28,8 @@ influx v1 auth set-inactive [flags]
| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) Authorization ID | string | |
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--username` | Authorization username | string | `$INFLUX_USERNAME` |
## Examples

View File

@ -26,8 +26,8 @@ influx v1 auth set-password [flags]
| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| `-i` | `--id` | Authorization ID | string | |
| | `--password` | Password to set on the authorization | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--username` | Authorization username | string | `$INFLUX_USERNAME` |
## Examples

View File

@ -18,22 +18,22 @@ influx v1 dbrp create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:------|:------------------|:-------------------------------------------------------------------------|:----------:|:------------------------|
| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` |
| | `--bucket-id` | Bucket ID to map to | | |
| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` |
| | `--db` | InfluxDB v1 database to map from | | |
| | `--default` | Set DBRP mapping's retention policy as default | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| | `--rp` | InfluxDB v1 retention policy to map from | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:------------------|:-------------------------------------------------------------------------|:----------:|:------------------------|
| `-c` | `--active-config` | Config name to use for command | string | `$INFLUX_ACTIVE_CONFIG` |
| | `--bucket-id` | Bucket ID to map to | | |
| | `--configs-path` | Path to the influx CLI configurations (default: `~/.influxdbv2/configs`) | string | `$INFLUX_CONFIGS_PATH` |
| | `--db` | InfluxDB v1 database to map from | | |
| | `--default` | Set DBRP mapping's retention policy as default | | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| | `--rp` | InfluxDB v1 retention policy to map from | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
## Examples

View File

@ -29,8 +29,8 @@ influx v1 dbrp delete [flags]
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
## Examples

View File

@ -34,8 +34,8 @@ influx v1 dbrp list [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| | `--rp` | Filter DBRP mappings by InfluxDB v1 retention policy | string | `$INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
## Examples

View File

@ -31,8 +31,8 @@ influx v1 dbrp update [flags]
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `$INFLUX_ORG_ID` |
| `-r` | `--rp` | InfluxDB v1 retention policy to map from | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | API token | string | `$INFLUX_TOKEN` |
## Examples

View File

@ -63,31 +63,31 @@ In **extended annotated CSV**, measurements, fields, and values and their types
| [dryrun](/influxdb/v2.0/reference/cli/influx/write/dryrun) | Write to stdout instead of InfluxDB |
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:---------------------------------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Bucket name (mutually exclusive with `--bucket-id`) | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | `INFLUX_BUCKET_ID` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:-------------------------------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Bucket name (mutually exclusive with `--bucket-id`) | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | `INFLUX_BUCKET_ID` |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--compression` | Input compression (`none` or `gzip`, default is `none` unless input file ends with `.gz`.) | string | |
| | `--debug` | Output errors to stderr | | |
| | `--encoding` | Character encoding of input (default `UTF-8`) | string | |
| | `--error-file` | Path to a file used for recording rejected row errors | string | |
| `-f` | `--file` | File to import | stringArray | |
| | `--format` | Input format (`lp` or `csv`, default `lp`) | string | |
| | `--header` | Prepend header line to CSV input data | string | |
| `-h` | `--help` | Help for the `write` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--max-line-length` | Maximum number of bytes that can be read for a single line (default `16000000`) | integer | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--precision` | Precision of the timestamps (default `ns`) | string | `INFLUX_PRECISION` |
| | `--rate-limit` | Throttle write rate (examples: `5 MB / 5 min` or `1MB/s`). | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skipHeader` | Skip first *n* rows of input data | integer | |
| | `--skipRowOnError` | Output CSV errors to stderr, but continue processing | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--url` | URL to import data from | stringArray | |
| | `--debug` | Output errors to stderr | | |
| | `--encoding` | Character encoding of input (default `UTF-8`) | string | |
| | `--error-file` | Path to a file used for recording rejected row errors | string | |
| `-f` | `--file` | File to import | stringArray | |
| | `--format` | Input format (`lp` or `csv`, default `lp`) | string | |
| | `--header` | Prepend header line to CSV input data | string | |
| `-h` | `--help` | Help for the `write` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--max-line-length` | Maximum number of bytes that can be read for a single line (default `16000000`) | integer | |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--precision` | Precision of the timestamps (default `ns`) | string | `INFLUX_PRECISION` |
| | `--rate-limit` | Throttle write rate (examples: `5 MB / 5 min` or `1MB/s`). | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--skipHeader` | Skip first *n* rows of input data | integer | |
| | `--skipRowOnError` | Output CSV errors to stderr, but continue processing | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--url` | URL to import data from | stringArray | |
## Examples

View File

@ -32,7 +32,7 @@ influx write dryrun [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:-----|:--------------------|:--------------------------------------------------------------------------------|:----------: |:----------------------|
|:-----|:--------------------|:--------------------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| `-b` | `--bucket` | Bucket name (mutually exclusive with `--bucket-id`) | string | `INFLUX_BUCKET_NAME` |
| | `--bucket-id` | Bucket ID (mutually exclusive with `--bucket`) | string | `INFLUX_BUCKET_ID` |
@ -50,10 +50,10 @@ influx write dryrun [flags]
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-p` | `--precision` | Precision of the timestamps (default `ns`) | string | `INFLUX_PRECISION` |
| | `--rate-limit` | Throttle write rate (examples: `5 MB / 5 min` or `1MB/s`). | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| | `--skipHeader` | Skip first *n* rows of input data | integer | |
| | `--skipRowOnError` | Output CSV errors to stderr, but continue processing | | |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | API token | string | `INFLUX_TOKEN` |
| `-u` | `--url` | URL to import data from | stringArray | |
## Examples