Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add influx CLI 2.1 release notes (#2944) 

* add influx release notes

* add headings

* Update influx-cli.md

* Update influx-cli.md

* Update password.md

* Update password.md

* Update password.md

* release note edits

* Update password.md

* Update add.md

* added latest-cli shortcode (#2946)

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* edits

* add link to compression flag

* rmv extra

* update compression descrp

* update per version support for backup

* remove 2.1

* Add global --http-debug flag (#2948)

* add global flag to apply

* add global flag to appy

* update influx commands with global flag

* revert to add back duplicate-oss tag

* remove dup

* rmv global tag from config cmds

Co-authored-by: mluu12 <87089043+mluu12@users.noreply.github.com>

Co-authored-by: mluu12 <87089043+mluu12@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
pull/2935/head^2
kelseiv 2021-07-30 10:35:40 -07:00 committed by GitHub
parent dc186578df
commit 6a5760976c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
55 changed files with 606 additions and 473 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -339,6 +339,19 @@ Easier to maintain being you update the version number in the `data/products.yml
{{< latest-patch product="chronograf" version="1.7" >}}
```
### Latest influx CLI version
Use the `{{< latest-cli >}}` shortcode to add the latest version of the `influx`
CLI supported by the minor version of InfluxDB.
By default, this shortcode parses the minor version from the URL.
To specify a specific minor version, use the `version` argument.
Maintain CLI version numbers in the `data/products.yml` file instead of updating individual links and code examples.
```md
{{< latest-cli >}}
{{< latest-cli version="2.1" >}}
```
### API endpoint
Use the `{{< api-endpoint >}}` shortcode to generate a code block that contains
a colored request method and a specified API endpoint.

2
content/influxdb/cloud/reference/cli/influx/apply/_index.md
View File

@ -14,4 +14,4 @@ related:
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
---
{{< duplicate-oss >}}
{{< duplicate-oss >}}

59
content/influxdb/cloud/reference/release-notes/influx-cli.md Normal file
View File

@ -0,0 +1,59 @@
---
title: influx CLI release notes
description: Important changes and and what's new in each version of the influx command line interface (CLI).
weight: 103
menu:
influxdb_cloud_ref:
parent: Release notes
name: influx CLI
---
## v2.1.0 [2021-07-29]
## New repository
This is the initial release of the `influx` CLI from the `influxdata/influx-cli` GitHub repository.
## Breaking changes
### `influx write` skip-header parsing
To simplify the CLI parser, the `write` command no longer supports `--skipHeader`
as short-hand for `--skipHeader 1`.
### Stricter input validation for `influx template` commands
The `apply`, `export`, and `stacks` commands now raise errors when CLI options fail to parse instead of silently discarding bad inputs.
This change was made to help users debug when their commands fail to execute as expected.
### Server-side template summarization and validation
The `template` and `template validate` commands now use an API request to the server to perform their logic, instead of performing the work on the client-side.
Offline summarization and validation is no longer supported.
This change was made to avoid significant code duplication between `influxdb` and `influx CLI`, and to allow server-side template logic to evolve without requiring coordinated CLI changes.
### `influx stacks --json` output conventions
The output of `influx stacks --json` previously used an UpperCamelCase naming convention for most keys.
The command now uses lowerCamelCase consistently for all objects keys, matching the schema returned by the API.
## Features
- Add global `--http-debug` flag to all `influx` commands to help inspect communication with InfluxDB servers.
- Update [`bucket create`](/influxdb/cloud/reference/cli/influx/bucket/create/) to allow setting a schema type.
- Update [`bucket list`](/influxdb/cloud/reference/cli/influx/bucket/list/) to display schema types.
- Bind [`--skip-verify`](/influxdb/cloud/reference/cli/influx/org/members/add/#flags) flag to the `INFLUX_SKIP_VERIFY` environment variable.
- (InfluxDB Cloud only) Add [`buck
- (InfluxDB OSS only) Updates to `backup` and `restore`:
- Reimplement [`backup`](/influxdb/cloud/reference/cli/influx/backup/) to support downloading embedded SQL store from InfluxDB 2.0 or later.
- Add [`--compression`](/influxdb/v2.0/reference/cli/influx/backup/_index.md) flag to support GZIP compression of downloaded files.
- Reimplement `restore` to support uploading embedded SQL store from InfluxDB v2.1.x.
- (InfluxDB OSS only) Add [`--password`](/influxdb/cloud/reference/cli/influx/user/password/) flag to `user password` command to allow bypassing interactive prompt.
## Bug fixes
- Fix interactive password collection and color rendering in PowerShell.
- `org members list` no longer hangs on organizations with more than 10 members.
- Detect and warn when inputs to `write` contain standalone CR characters.
- `dashboards` command now accepts `--org` flag, or falls back to default org in config.
- Return a consistent error when responses fail to decode, including hints for OSS-only and Cloud-only commands.

8
content/influxdb/cloud/sign-up.md
View File

@ -176,8 +176,8 @@ To see all available `influx` commands, type `influx -h` or check out [influx -
Click one of the following buttons to download and install the `influx` CLI appropriate for your chipset.
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch >}}-linux-amd64.tar.gz" download >influx CLI (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch >}}-linux-arm64.tar.gz" download >influx CLI (arm)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-cli >}}-linux-amd64.tar.gz" download >influx CLI (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-cli >}}-linux-arm64.tar.gz" download >influx CLI (arm)</a>
#### Step 2: Unpackage the influx binary
@ -185,7 +185,7 @@ Click one of the following buttons to download and install the `influx` CLI appr
```sh
# Unpackage contents to the current working directory
tar xvfz influxdb-client-{{< latest-patch >}}-linux-amd64.tar.gz
tar xvfz influxdb-client-{{< latest-cli >}}-linux-amd64.tar.gz
```
#### Step 3: (Optional) Place the binary in your $PATH
@ -197,7 +197,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH,
```sh
# Copy the influx and influxd binary to your $PATH
sudo cp influxdb-client-{{< latest-patch >}}-linux-amd64/influx /usr/local/bin/
sudo cp influxdb-client-{{< latest-cli >}}-linux-amd64/influx /usr/local/bin/
```
{{% note %}}

45
content/influxdb/v2.0/reference/cli/influx/apply/_index.md
View File

@ -24,28 +24,29 @@ influx apply [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` |
| | `--disable-color` | Disable color in output | | |
| | `--disable-table-borders` | Disable table borders | | |
| `-e` | `--encoding` | Encoding of the input stream | string | |
| | `--env-ref` | Environment references to provide with the template (format: `--env-ref=REF_KEY=REF_VALUE`) | string | |
| `-f` | `--file` | Path to template file (supports HTTP(S) URLs or file paths) | string | |
| | `--filter` | Resources to skip when applying the template (filter by `kind` or `resource`) | string | |
| | `--force` | Ignore warnings about destructive changes | | |
| `-h` | `--help` | Help for the `apply` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name that owns the bucket (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the bucket (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-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 | | |
| | `--stack-id` | Stack ID to associate when applying the template | string | |
| `-t` | `--token` | Authentication 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` |
| | `--disable-color` | Disable color in output | | |
| | `--disable-table-borders` | Disable table borders | | |
| `-e` | `--encoding` | Encoding of the input stream | string | |
| | `--env-ref` | Environment references to provide with the template (format: `--env-ref=REF_KEY=REF_VALUE`) | string | |
| `-f` | `--file` | Path to template file (supports HTTP(S) URLs or file paths) | string | |
| | `--filter` | Resources to skip when applying the template (filter by `kind` or `resource`) | string | |
| | `--force` | Ignore warnings about destructive changes | | |
| `-h` | `--help` | Help for the `apply` command | | |
| | `--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 | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name that owns the bucket (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID that owns the bucket (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| `-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 | | |
| | `--stack-id` | Stack ID to associate when applying the template | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples: how to apply a template or stack

13
content/influxdb/v2.0/reference/cli/influx/auth/active.md
View File

@ -18,16 +18,17 @@ influx auth active [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 `active` 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 >}}) Authentication token ID | string | |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | ({{< req >}}) Authentication token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Example

19
content/influxdb/v2.0/reference/cli/influx/auth/create.md
View File

@ -17,16 +17,17 @@ influx auth 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` | Authentication token description | string | |
| :--- | :------------------------------ | :-------------------------------------------------------------------- | :---------: | :-------------------- |
| `-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` | Authentication token 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` |
| | `--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` |
| `-o` | `--org` | Organization name (mutually exclusive with `--org-id`) | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID (mutually exclusive with `--org`) | string | `INFLUX_ORG_ID` |
| | `--read-bucket` | Grant permission to read a specified bucket ID | stringArray | |
| | `--read-buckets` | Grant permission to read **all** organization buckets | | |
| | `--read-checks` | Grant permission to read checks | | |
@ -39,8 +40,8 @@ influx auth create [flags]
| | `--read-telegrafs` | Grant permission to read Telegraf configurations | | |
| | `--read-user` | Grant permission to read organization users | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--write-bucket` | Grant permission to write to specified a bucket ID | stringArray | |
| | `--write-buckets` | Grant permission to create and update **all** organization buckets | | |
| | `--write-checks` | Grant permission to create checks | | |

23
content/influxdb/v2.0/reference/cli/influx/auth/delete.md
View File

@ -16,17 +16,18 @@ influx auth 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 >}}) Authentication token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication 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` | ({{< req >}}) Authentication token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

23
content/influxdb/v2.0/reference/cli/influx/auth/inactive.md
View File

@ -24,17 +24,18 @@ influx auth inactive [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 `inactive` 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 >}}) Authentication token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication 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 `inactive` 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 >}}) Authentication token ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

31
content/influxdb/v2.0/reference/cli/influx/auth/list.md
View File

@ -21,21 +21,22 @@ influx auth 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` | Authentication token ID | string | |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |
| 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` | Authentication token ID | string | |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | |
| | `--user-id` | User ID | string | |
## Examples

33
content/influxdb/v2.0/reference/cli/influx/backup/_index.md
View File

@ -22,20 +22,23 @@ influx backup [flags] path
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|------|-------------------|------------------------------------------------------------- |------------|-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket-id` | ID of the bucket to back up from (mutually exclusive with `--bucket`) | string | |
| `-b` | `--bucket` | Name of the bucket to back up from (mutually exclusive with `--bucket-id`) | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `backup` 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` |
| `-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 | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| ---- | ----------------- | ---------------------------------------------------------------------------------------------------------- | ---------- | --------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket-id` | ID of the bucket to back up from (mutually exclusive with `--bucket`) | string | |
| `-b` | `--bucket` | Name of the bucket to back up from (mutually exclusive with `--bucket-id`) | string | |
| | `--compression` | By default, `gzip` argument enables compression on downloaded files. Set to `none` to disable compression. | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `backup` 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` |
| `-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 | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
@ -58,4 +61,4 @@ influx backup ./
##### Back up a specific bucket to a directory
```sh
influx backup --bucket example-bucket /path/to/backup/dir/
```
```

1
content/influxdb/v2.0/reference/cli/influx/bucket/_index.md
View File

@ -36,5 +36,6 @@ influx bucket [command]
| | `--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` | Authentication token | string | `INFLUX_TOKEN` |

1
content/influxdb/v2.0/reference/cli/influx/bucket/create.md
View File

@ -33,6 +33,7 @@ influx bucket create [flags]
| `-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` |

1
content/influxdb/v2.0/reference/cli/influx/bucket/delete.md
View File

@ -29,6 +29,7 @@ influx bucket delete [flags]
| `-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 | |

1
content/influxdb/v2.0/reference/cli/influx/bucket/list.md
View File

@ -29,6 +29,7 @@ influx bucket list [flags]
| `-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` |

1
content/influxdb/v2.0/reference/cli/influx/bucket/update.md
View File

@ -31,6 +31,7 @@ influx bucket update [flags]
| `-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` |

20
content/influxdb/v2.0/reference/cli/influx/config/create.md
View File

@ -17,16 +17,16 @@ influx config create [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-a` | `--active` | Set the specified connection to be the active configuration. | | |
| `-n` | `--config-name` | ({{< req >}}) Name of the new configuration. | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `-u` | `--host-url` | ({{< req >}}) Connection URL for the new configuration. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :--------------- | :----------------------------------------------------------- | :--------: | :-------------------- |
| `-a` | `--active` | Set the specified connection to be the active configuration. | | |
| `-n` | `--config-name` | ({{< req >}}) Name of the new configuration. | string | |
| `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `-u` | `--host-url` | ({{< req >}}) Connection URL for the new configuration. | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

10
content/influxdb/v2.0/reference/cli/influx/config/list.md
View File

@ -22,8 +22,8 @@ influx config list [flags]
`list`, `ls`
## Flags
| Flag | | Description | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:------------------ |
| `-h` | `--help` | Help for the `list` command | |
| | `--hide-headers` | Hide table headers (default `false`) | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON (default `false`) | `INFLUX_OUTPUT_JSON` |
| Flag | | Description | {{< cli/mapped >}} |
| :--- | :--------------- | :------------------------------------------- | :-------------------- |
| `-h` | `--help` | Help for the `list` command | |
| | `--hide-headers` | Hide table headers (default `false`) | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON (default `false`) | `INFLUX_OUTPUT_JSON` |

10
content/influxdb/v2.0/reference/cli/influx/config/rm.md
View File

@ -23,11 +23,11 @@ influx config rm <config-name> [flags]
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :--------------- | :------------------------------------------- | :--------: | :-------------------- |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
## Examples

18
content/influxdb/v2.0/reference/cli/influx/config/set.md
View File

@ -20,15 +20,15 @@ influx config set [flags]
`set` , `update`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-a` | --active` | Set the specified connection to active | | |
| `-n` | --config-name` | Name for the InfluxDB connection configuration to set or update | string | |
| `-h` | --help` | Help for the `set` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `-u` | --host-url` | URL for InfluxDB connection configuration to set or update | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name for the connection configuration | string | |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :--------------- | :-------------------------------------------------------------- | :--------: | :-------------------- |
| `-a` | `--active` | Set the specified connection to active | | |
| `-n` | `--config-name` | Name for the InfluxDB connection configuration to set or update | string | |
| `-h` | `--help` | Help for the `set` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `-u` | `--host-url` | URL for InfluxDB connection configuration to set or update | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name for the connection configuration | string | |
## Examples

15
content/influxdb/v2.0/reference/cli/influx/dashboards/_index.md
View File

@ -22,18 +22,19 @@ influx dashboards [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 `dashboards` command | | |
| | `--hide-headers` | Hide table headers | | `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` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| `-i` | `--id` | Dashboard ID to retrieve | stringArray | |
| | `--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` |
| `-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` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

31
content/influxdb/v2.0/reference/cli/influx/delete/_index.md
View File

@ -24,21 +24,22 @@ Running `influx delete` without the `-p` or `--predicate` flag deletes all data
{{% /warn %}}
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------:|:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket` | Name of bucket to remove data from (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` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-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 | | |
| | `--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` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket` | Name of bucket to remove data from (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` |
| `-h` | `--help` | Help for the `delete` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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` |
| `-p` | `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/influxdb/v2.0/reference/syntax/delete-predicate)) | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--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` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

59
content/influxdb/v2.0/reference/cli/influx/export/_index.md
View File

@ -33,35 +33,36 @@ influx export [command]
## Flags
| Flag | | Description | Input Type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:---------- |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket-names` | Comma-separated list of bucket names | string | |
| | `--buckets` | Comma-separated list of bucket IDs | string | |
| | `--check-names` | Comma-separated list of check names | string | |
| | `--checks` | Comma-separated list of check IDs | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| | `--dashboard-names` | Comma-separated list of dashboard names | string | |
| | `--dashboards` | Comma-separated list of dashboard IDs | string | |
| | `--endpoint-names` | Comma-separated list of notification endpoint names | string | |
| | `--endpoints` | Comma-separated list of notification endpoint IDs | string | |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--label-names` | Comma-separated list of label names | string | |
| | `--labels` | Comma-separated list of label IDs | string | |
| | `--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 | | |
| | `--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 | |
| | `--telegraf-config-names` | Comma-separated list of Telegraf configuration names | string | |
| | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--variable-names` | Comma-separated list of variable names | string | |
| | `--variables` | Comma-separated list of variable IDs | string | |
| Flag | | Description | Input Type | {{< cli/mapped >}} |
| :--- | :------------------------ | :------------------------------------------------------------------------------- | :--------- | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--bucket-names` | Comma-separated list of bucket names | string | |
| | `--buckets` | Comma-separated list of bucket IDs | string | |
| | `--check-names` | Comma-separated list of check names | string | |
| | `--checks` | Comma-separated list of check IDs | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--dashboard-names` | Comma-separated list of dashboard names | string | |
| | `--dashboards` | Comma-separated list of dashboard IDs | string | |
| | `--endpoint-names` | Comma-separated list of notification endpoint names | string | |
| | `--endpoints` | Comma-separated list of notification endpoint IDs | string | |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--label-names` | Comma-separated list of label names | string | |
| | `--labels` | Comma-separated list of label IDs | string | |
| | `--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 | | |
| | `--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 | |
| | `--telegraf-config-names` | Comma-separated list of Telegraf configuration names | string | |
| | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| | `--variable-names` | Comma-separated list of variable names | string | |
| | `--variables` | Comma-separated list of variable IDs | string | |
## Examples

25
content/influxdb/v2.0/reference/cli/influx/export/all.md
View File

@ -31,18 +31,19 @@ influx export all [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` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| | `--filter` | Specify resources to export by labelName or resourceKind (format: `--filter=labelName=example`) | stringArray | |
| `-h` | `--help` | Help for the `export all` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-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 | | |
| `-t` | `--token` | Authentication 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` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| | `--filter` | Specify resources to export by labelName or resourceKind (format: `--filter=labelName=example`) | stringArray | |
| `-h` | `--help` | Help for the `export all` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

23
content/influxdb/v2.0/reference/cli/influx/export/stack.md
View File

@ -28,17 +28,18 @@ influx export stack <stack_id> [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` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export stack` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-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 | | |
| `-t` | `--token` | Authentication 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` |
| `-f` | `--file` | Template output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h` | `--help` | Help for the `export stack` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

1
content/influxdb/v2.0/reference/cli/influx/org/create.md
View File

@ -24,6 +24,7 @@ influx org create [flags]
| `-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 | | |

23
content/influxdb/v2.0/reference/cli/influx/org/delete.md
View File

@ -16,17 +16,18 @@ influx org 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 >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication 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` | ({{< req >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

25
content/influxdb/v2.0/reference/cli/influx/org/list.md
View File

@ -21,18 +21,19 @@ influx org 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` | 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 | | |
| `-t` | `--token` | Authentication 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` | 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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

20
content/influxdb/v2.0/reference/cli/influx/org/members/add.md
View File

@ -16,15 +16,15 @@ influx org members add [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `add` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | User ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-h` | `--help` | Help for the `add` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-m` | `--member` | User ID | string | |
| `-n` | `--name` | Organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
@ -35,4 +35,4 @@ influx org members add [flags]
influx org members add \
--member 00x0oo0X0xxxo000 \
--name example-org
```
```

21
content/influxdb/v2.0/reference/cli/influx/org/members/list.md
View File

@ -16,16 +16,17 @@ influx org members list [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-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` | 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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :--------------- | :--------------------------------------------------------- | :--------: | :-------------------- |
| `-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` | 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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

1
content/influxdb/v2.0/reference/cli/influx/org/members/remove.md
View File

@ -20,6 +20,7 @@ influx org members remove [flags]
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-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` |

17
content/influxdb/v2.0/reference/cli/influx/org/update.md
View File

@ -17,18 +17,19 @@ influx org 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` | New description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :----------------------- |
| `-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` | New description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
| `-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 >}}) Organization ID | string | `INFLUX_ORG_ID` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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` |
| `-n` | `--name` | New organization name | string | `INFLUX_ORG` |
| `-n` | `--name` | New organization name | string | `INFLUX_ORG` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

15
content/influxdb/v2.0/reference/cli/influx/ping/_index.md
View File

@ -24,10 +24,11 @@ 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` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| 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 | | |

27
content/influxdb/v2.0/reference/cli/influx/query/_index.md
View File

@ -36,19 +36,20 @@ drop columns such as `_start` and `_stop` to optimize the download file size.
{{% /note %}}
## 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` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `query` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-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` | `--profilers` | Flux query profilers to enable (comma-separated) | string | |
| `-r` | `--raw` | Output raw query results (annotated CSV) | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication 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` |
| `-f` | `--file` | Path to Flux script file | string | |
| `-h` | `--help` | Help for the `query` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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` |
| `-p` | `--profilers` | Flux query profilers to enable (comma-separated) | string | |
| `-r` | `--raw` | Output raw query results (annotated CSV) | | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

21
content/influxdb/v2.0/reference/cli/influx/repl/_index.md
View File

@ -31,13 +31,14 @@ Use **ctrl + d** to exit the REPL.
To use the Flux REPL, you must first authenticate with a [token](/influxdb/v2.0/security/tokens/view-tokens/).
## 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 `repl` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-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` | Authentication 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 `repl` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |

35
content/influxdb/v2.0/reference/cli/influx/restore/index.md
View File

@ -42,23 +42,24 @@ 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` | Authentication 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` |
| | `--http-debug` | Inspect communication with InfluxDB servers. | string | |
| | `--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` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

17
content/influxdb/v2.0/reference/cli/influx/secret/delete.md
View File

@ -18,18 +18,19 @@ influx secret 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` |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-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` |
| | `--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` |
| `-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` |
| `-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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

15
content/influxdb/v2.0/reference/cli/influx/secret/list.md
View File

@ -21,17 +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` |
| | `--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` |
| `-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` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

19
content/influxdb/v2.0/reference/cli/influx/secret/update.md
View File

@ -27,19 +27,20 @@ influx secret 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` |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-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` |
| | `--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` |
| `-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` |
| `-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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | ({{< req >}}) Secret value | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-v` | `--value` | ({{< req >}}) Secret value | string | |
## Examples

29
content/influxdb/v2.0/reference/cli/influx/setup/_index.md
View File

@ -29,20 +29,21 @@ 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` |
| `-f` | `--force` | Skip confirmation prompt | | |
| `-h` | `--help` | Help for the `setup` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-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 | |
| 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` |
| `-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 | |
| `-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 | |
{{% note %}}
Valid `--retention` units are nanoseconds (`ns`), microseconds (`us` or `µs`),

15
content/influxdb/v2.0/reference/cli/influx/stacks/_index.md
View File

@ -35,19 +35,20 @@ influx stacks [command]
## 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 `stacks` 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` |
| | `--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` |
| `-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 | | |
| | `--stack-id` | Stack IDs to filter by | stringArray | |
| | `--stack-name` | Stack names to filter by | stringArray | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

21
content/influxdb/v2.0/reference/cli/influx/stacks/init.md
View File

@ -19,21 +19,22 @@ influx stacks init [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` |
| 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 `init` 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` |
| | `--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` |
| `-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 | | |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-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 | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

17
content/influxdb/v2.0/reference/cli/influx/stacks/remove.md
View File

@ -22,20 +22,21 @@ influx stacks remove [flags]
`remove`, `rm`, `uninstall`
## 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` |
| 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` |
| | `--force` | Skip confirmation prompt. | | |
| `-h` | `--help` | Help for the `remove` 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` |
| | `--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` |
| `-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 | | |
| | `--stack-id` | Stack IDs to remove | list of strings | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

23
content/influxdb/v2.0/reference/cli/influx/stacks/update.md
View File

@ -17,22 +17,23 @@ influx stacks update [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--addResource` | Associate an existing resource with a stack | string | |
| `-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` | `--export-file` | Destination for exported template | string | |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :-------------------- | :-------------------------------------------------------------------- | :-------------: | :-------------------- |
| | `--addResource` | Associate an existing resource with a stack | string | |
| `-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` | `--export-file` | Destination for exported template | 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` |
| `-i` | `--stack-id` | The stack ID to update | string | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--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 | | |
| `-d` | `--stack-description` | Stack description | string | |
| `-n` | `--stack-name` | Stack name | string | |
| `-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 | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
{{% warn %}}
#### Export an updated template

17
content/influxdb/v2.0/reference/cli/influx/task/create.md
View File

@ -17,18 +17,19 @@ influx task create [task literal] [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` |
| `-f` | `--file` | Path to Flux script file | string | |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-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 `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` |
| | `--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` |
| `-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` | Authentication token | string | `INFLUX_TOKEN` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Example

23
content/influxdb/v2.0/reference/cli/influx/task/delete.md
View File

@ -16,17 +16,18 @@ influx task 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 >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication 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` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

31
content/influxdb/v2.0/reference/cli/influx/task/list.md
View File

@ -21,21 +21,22 @@ influx task 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` | Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-n` | `--user-id` | Task owner ID | string | |
| 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` | Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--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 | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-n` | `--user-id` | Task owner ID | string | |
## Examples

25
content/influxdb/v2.0/reference/cli/influx/task/log/list.md
View File

@ -21,18 +21,19 @@ influx task log 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` |
| | `--run-id` | Run ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication 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 | |
| | `--run-id` | Run ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

37
content/influxdb/v2.0/reference/cli/influx/task/retry-failed.md
View File

@ -15,24 +15,25 @@ influx task retry-failed [flags]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--after` | Retry task runs that occurred after this time (RFC3339 timestamp) | string | |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| | `--before` | Retry task runs that occurred before this time (RFC3339 timestamp) | string | |
| | `--dry-run` | Print information about task runs that would be retried | | |
| `-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` | Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-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 | | |
| | `--task-limit` | Maximum number of tasks to retry failed runs for (`1-500`, default `100`) | integer | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :------------------------------------------------------------------------ | :--------: | :-------------------- |
| | `--after` | Retry task runs that occurred after this time (RFC3339 timestamp) | string | |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| | `--before` | Retry task runs that occurred before this time (RFC3339 timestamp) | string | |
| | `--dry-run` | Print information about task runs that would be retried | | |
| `-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` | Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-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 | | |
| | `--task-limit` | Maximum number of tasks to retry failed runs for (`1-500`, default `100`) | integer | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

31
content/influxdb/v2.0/reference/cli/influx/task/run/list.md
View File

@ -21,21 +21,22 @@ influx task run list [flags]
`list`, `ls`, `find`
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--after` | After-time for filtering | string | |
| | `--before` | Before-time for filtering | 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` |
| | `--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 | | |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| Flag | | Description | Input type | {{< cli/mapped >}} |
| :--- | :---------------- | :-------------------------------------------------------------------- | :--------: | :-------------------- |
| `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--after` | After-time for filtering | string | |
| | `--before` | Before-time for filtering | 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 | |
| | `--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 | | |
| | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

21
content/influxdb/v2.0/reference/cli/influx/task/run/retry.md
View File

@ -16,16 +16,17 @@ influx task run retry [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 `retry` command | | |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-r` | `--run-id` | ({{< req >}}) Run ID | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-i` | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication 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 `retry` command | | |
| | `--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 | | |
| `-i` | `--task-id` | ({{< req >}}) Task ID | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples

27
content/influxdb/v2.0/reference/cli/influx/task/update.md
View File

@ -16,19 +16,20 @@ influx task update [task literal] [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` |
| `-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` |
| `-i` | `--id` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--status` | Update task status (`active` or `inactive`) | string | |
| `-t` | `--token` | Authentication 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` |
| `-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` | ({{< req >}}) Task ID | string | |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--status` | Update task status (`active` or `inactive`) | string | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Example

5
content/influxdb/v2.0/reference/cli/influx/user/password.md
View File

@ -27,7 +27,8 @@ influx user password [flags]
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| `-i` | `--id` | User ID | string | |
| `-n` | `--name` | Username | string | |
| | `--skip-verify` | Skip TLS certificate verification | | |
| | `--password` | Use `password` flag to send your password instead of typing it in | string | |
| | `--skip-verify` | Skip TLS certificate verification | | `INFLUX_SKIP_VERIFY` |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
@ -44,4 +45,4 @@ influx user password --name example-username
```sh
influx user password --id 0Xx0oox00XXoxxoo1
# Prompts for password
```
```

2
data/products.yml
View File

@ -14,6 +14,8 @@ influxdb:
"1.5": 5
"1.4": 3
"1.3": 9
latest_cli:
"2.0": 2.1.0
influxdb_cloud:
name: InfluxDB Cloud

13
layouts/shortcodes/latest-cli.html Normal file
View File

@ -0,0 +1,13 @@
{{- $scratch := newScratch -}}
{{- $productPathData := findRE "[^/]+.*?" .Page.RelPermalink -}}
{{- $parsedVersion := replaceRE "v" "" (index $productPathData 1) -}}
{{- $versionArg := .Get "version" | default "" -}}
{{- $latestVersion := replaceRE "v" "" (index .Site.Data.products.influxdb "latest") -}}
{{- $version := cond (gt (len $versionArg) 0) $versionArg $parsedVersion -}}
{{- $cliVersions := index .Site.Data.products.influxdb "latest_cli" -}}
{{- if eq $version "cloud" -}}
{{- $scratch.Set "cliVersion" (index $cliVersions $latestVersion) -}}
{{- else -}}
{{- $scratch.Set "cliVersion" (index $cliVersions $version) -}}
{{- end -}}
{{- $scratch.Get "cliVersion" -}}