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

influxctl 2.1.0 () 

* add updates for influxctl 2.1.0

* fixed influxctl global flags table alignment

* remove hidden influxctl cluster commands and flags

* remove hidden influxctl cluster commands and flags

* removed dedicated references from clustered
pull/5202/head^2
Scott Anderson 2023-10-27 16:04:33 -06:00 committed by GitHub
parent d0db0e3abb
commit 1dd714f0a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
38 changed files with 387 additions and 46 deletions

50
content/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/create.md Normal file
View File

@ -0,0 +1,50 @@
---
title: influxctl cluster create
description: >
The `influxctl cluster create` command creates an InfluxDB cluster.
menu:
influxdb_cloud_dedicated:
parent: influxctl cluster
weight: 301
draft: true
---
The `influxctl cluster create` command creates an {{% product-name omit=" Clustered" %}} cluster.
## Usage
```sh
influxctl cluster create [flags]
```
## Flags
| Flag | | Description |
| :--- | ------------------------- | :-------------------------------------------------------------------------------------------- |
| | `--region` | {{< req >}}: Region to create cluster in |
| | `--category` | {{< req >}}: Cluster category (`contract`, `internal`, `unpaid_poc`, `paid_poc`, or `system`) |
| | `--ingestor-units` | Ingestor units _(default is 0)_ |
| | `--ingestor-granularity` | Ingestor granularity _(default is 0)_ |
| | `--compactor-units` | Compactor units _(default is 0)_ |
| | `--compactor-granularity` | Compactor granularity _(default is 0)_ |
| | `--query-units` | Query units _(default is 0)_ |
| | `--query-granularity` | Query granularity _(default is 0)_ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Create an InfluxDB Cloud Dedicated cluster
```sh
influxctl cluster create \
--region us-west-2 \
--category internal \
--ingestor-units 3 \
--compactor-units 1 \
--query-units 1 \
example-cluster-name
```

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/get.md
View File

@ -35,6 +35,10 @@ influxctl cluster get <CLUSTER_ID>
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Return information about a cluster

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/list.md
View File

@ -28,3 +28,7 @@ influxctl cluster list
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

55
content/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/update.md Normal file
View File

@ -0,0 +1,55 @@
---
title: influxctl cluster update
description: >
The `influxctl cluster update` command updates an InfluxDB cluster.
menu:
influxdb_cloud_dedicated:
parent: influxctl cluster
weight: 301
draft: true
---
The `influxctl cluster update` command updates an {{% product-name omit=" Clustered" %}} cluster.
## Usage
```sh
influxctl cluster update [flags] <CLUSTER_ID>
```
## Arguments
| Argument | Description |
| :------------- | :----------------------- |
| **CLUSTER_ID** | ID of the cluster to get |
## Flags
| Flag | | Description |
| :--- | ------------------------- | :-------------------------------------------------------------------------------------------- |
| | `--state` | {{< req >}}: Cluster state (`ready` or `deleted`) |
| | `--category` | {{< req >}}: Cluster category (`contract`, `internal`, `unpaid_poc`, `paid_poc`, or `system`) |
| | `--ingestor-units` | Ingestor units _(default is 0)_ |
| | `--ingestor-granularity` | Ingestor granularity _(default is 0)_ |
| | `--compactor-units` | Compactor units _(default is 0)_ |
| | `--compactor-granularity` | Compactor granularity _(default is 0)_ |
| | `--query-units` | Query units _(default is 0)_ |
| | `--query-granularity` | Query granularity _(default is 0)_ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Update an InfluxDB Cloud Dedicated cluster
```sh
influxctl cluster update \
--state ready \
--category contract \
--ingestor-units 3 \
--compactor-units 1 \
--query-units 1 \
```

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/database/create.md
View File

@ -68,6 +68,10 @@ influxctl database create [--retention-period 0s] <DATABASE_NAME>
| | `--max-columns` | Maximum columns per table (default is 250, 0 uses default) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Create a database with an infinite retention period](#create-a-database-with-an-infinite-retention-period)

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/database/delete.md
View File

@ -42,6 +42,10 @@ when creating a new database.
| | `--force` | Do not prompt for confirmation to delete (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Delete a database named "mydb"

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/database/list.md
View File

@ -28,3 +28,7 @@ influxctl database list [--format=table|json]
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/database/update.md
View File

@ -33,6 +33,10 @@ influxctl database update <DATABASE_NAME> [flags]
| | `--max-columns` | Maximum columns per table (default is 250, 0 uses default) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Update a database's retention period](#update-a-databases-retention-period)

17
content/influxdb/cloud-dedicated/reference/cli/influxctl/token/create.md
View File

@ -13,6 +13,10 @@ The `influxctl token create` command creates a database token with specified
permissions to resources in an InfluxDB Cloud Dedicated cluster and outputs
the token string.
The `--format` option lets you print the output in other formats.
By default, the 'table' format is used, but the 'json' format is
available for programmatic parsing by other tooling.
{{% note %}}
#### Store secure tokens in a secret store
@ -37,11 +41,16 @@ influxctl token create \
## Flags
| Flag | | Description |
| :--- | :----------------- | :------------------------------------------------- |
| | `--read-database` | Grant read permissions to a database _(Repeatable)_ |
| Flag | | Description |
| :--- | :----------------- | :--------------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--read-database` | Grant read permissions to a database _(Repeatable)_ |
| | `--write-database` | Grant write permissions to a database _(Repeatable)_ |
| `-h` | `--help` | Output command help |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/token/delete.md
View File

@ -44,6 +44,10 @@ Cloud Dedicated cluster.
| | `--force` | Do not prompt for confirmation to delete (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Delete a database token](#delete-a-database-token)

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/token/get.md
View File

@ -29,6 +29,10 @@ influxctl token get [command options] <TOKEN_ID>
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
{{% code-placeholders "TOKEN_ID" %}}

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/token/list.md
View File

@ -28,3 +28,7 @@ influxctl token list [--format=table|json]
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/token/update.md
View File

@ -43,6 +43,10 @@ To retain existing permissions, include them in the update command.
| | `--write-database` | Grant write permissions to a database _(Repeatable)_ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Update a token's permissions](#update-a-tokens-permissions)

2
content/influxdb/cloud-dedicated/reference/cli/influxctl/user/_index.md
View File

@ -33,4 +33,4 @@ influxctl user [subcommand] [subcommand options] [arguments...]
| Flag | | Description |
| :--- | :------- | :------------------ |
| `-h` | `--help` | Output command help |
| `-h` | `--help` | Output command help |

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/user/delete.md
View File

@ -36,6 +36,10 @@ and cannot be undone.
| :--- | :------- | :------------------ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
{{% code-placeholders "USER_ID" %}}

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/user/invite.md
View File

@ -32,6 +32,10 @@ influxctl user invite [command options] <FIRST_NAME> <LAST_NAME> <EMAIL>
| :--- | :------- | :------------------ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
{{% code-placeholders "(FIRST|LAST)_NAME|EMAIL" %}}

4
content/influxdb/cloud-dedicated/reference/cli/influxctl/user/list.md
View File

@ -28,3 +28,7 @@ influxctl user list [command options]
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

17
content/influxdb/clustered/reference/cli/influxctl/_index.md
View File

@ -13,7 +13,7 @@ influxdb/clustered/tags: [cli]
---
The `influxctl` command line interface (CLI) performs administrative tasks in
a cluster.
an InfluxDB cluster.
- [Usage](#usage)
- [Commands](#commands)
@ -30,8 +30,8 @@ influxctl [flags] [command]
## Commands
| Command | Description |
| :---------------------------------------------------------------- | :------------------------------------- |
| Command | Description |
| :---------------------------------------------------------------------- | :------------------------------------- |
| [cluster](/influxdb/clustered/reference/cli/influxctl/cluster/) | List InfluxDB v3 cluster information |
| [database](/influxdb/clustered/reference/cli/influxctl/database/) | Manage InfluxDB v3 databases |
| [token](/influxdb/clustered/reference/cli/influxctl/token/) | Manage InfluxDB v3 database tokens |
@ -368,23 +368,20 @@ The `influxctl` CLI uses [Auth0](https://auth0.com/) to authenticate access to
your InfluxDB cluster.
When you issue an `influxctl` command, the CLI checks for an active **Auth0** token.
If none exists, you are directed to login to **Auth0** via a browser using
credentials you should have created when setting up your
{{< product-name omit=" Clustered" >}} cluster.
credentials you should have created when setting up your InfluxDB Cloud
Dedicated cluster.
Auth0 issues a short-lived (1 hour) token that authenticates access to your
InfluxDB cluster.
## Troubleshoot
- **Not loading module "atk-bridge"**: When authenticating, some Linux systems
might report the following warning in the terminal (on stderr):
- **Not loading module "atk-bridge"**: When authenticating, some Linux systems might report the following warning in the terminal (on stderr):
```sh
Not loading module "atk-bridge": The functionality is provided by GTK natively. Please try to not load it.
```
To silence the warning when running `influxctl` commands, unset the
`GTK_MODULES` environment variable
(or remove `gail:atk-bridge` from its value)--for example:
To silence the warning when running `influxctl` commands, unset the `GTK_MODULES` environment variable (or remove `gail:atk-bridge` from its value)--for example:
```sh
GTK_MODULES= influxctl ...

6
content/influxdb/clustered/reference/cli/influxctl/cluster/_index.md
View File

@ -20,11 +20,11 @@ influxctl cluster [subcommand] [subcommand options] [arguments...]
## Subcommands
| Subcommand | Description |
| :---------------------------------------------------------------- | :------------------------------ |
| Subcommand | Description |
| :---------------------------------------------------------------------- | :------------------------------ |
| [get](/influxdb/clustered/reference/cli/influxctl/cluster/get/) | Get information about a cluster |
| [list](/influxdb/clustered/reference/cli/influxctl/cluster/list/) | List all clusters |
| help, h | Output command help |
| help, h | Output command help |
## Flags

56
content/influxdb/clustered/reference/cli/influxctl/cluster/create.md Normal file
View File

@ -0,0 +1,56 @@
---
title: influxctl cluster create
description: >
The `influxctl cluster create` command creates an InfluxDB cluster.
menu:
influxdb_clustered:
parent: influxctl cluster
weight: 301
draft: true
---
The `influxctl cluster create` command creates an {{% product-name omit=" Clustered" %}} cluster.
{{% warn %}}
This command is not supported by InfluxDB Clustered.
<!-- For information about create an InfluxDB Cluster, see
[Install InfluxDB Clustered](/influxdb/clustered/install/). -->
{{% /warn %}}
## Usage
```sh
influxctl cluster create [flags]
```
## Flags
| Flag | | Description |
| :--- | ------------------------- | :-------------------------------------------------------------------------------------------- |
| | `--region` | {{< req >}}: Region to create cluster in |
| | `--category` | {{< req >}}: Cluster category (`contract`, `internal`, `unpaid_poc`, `paid_poc`, or `system`) |
| | `--ingestor-units` | Ingestor units _(default is 0)_ |
| | `--ingestor-granularity` | Ingestor granularity _(default is 0)_ |
| | `--compactor-units` | Compactor units _(default is 0)_ |
| | `--compactor-granularity` | Compactor granularity _(default is 0)_ |
| | `--query-units` | Query units _(default is 0)_ |
| | `--query-granularity` | Query granularity _(default is 0)_ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Create an InfluxDB cluster
```sh
influxctl cluster create \
--region us-west-2 \
--category internal \
--ingestor-units 3 \
--compactor-units 1 \
--query-units 1 \
example-cluster-name
```

4
content/influxdb/clustered/reference/cli/influxctl/cluster/get.md
View File

@ -33,6 +33,10 @@ influxctl cluster get <CLUSTER_ID>
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Return information about a cluster

4
content/influxdb/clustered/reference/cli/influxctl/cluster/list.md
View File

@ -28,3 +28,7 @@ influxctl cluster list
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

61
content/influxdb/clustered/reference/cli/influxctl/cluster/update.md Normal file
View File

@ -0,0 +1,61 @@
---
title: influxctl cluster update
description: >
The `influxctl cluster update` command updates an InfluxDB cluster.
menu:
influxdb_clustered:
parent: influxctl cluster
weight: 301
draft: true
---
The `influxctl cluster update` command updates an {{% product-name omit=" Clustered" %}} cluster.
{{% warn %}}
This command is not supported by InfluxDB Clustered.
<!-- For information about create an InfluxDB Cluster, see
[Install InfluxDB Clustered](/influxdb/clustered/install/). -->
{{% /warn %}}
## Usage
```sh
influxctl cluster update [flags] <CLUSTER_ID>
```
## Arguments
| Argument | Description |
| :------------- | :----------------------- |
| **CLUSTER_ID** | ID of the cluster to get |
## Flags
| Flag | | Description |
| :--- | ------------------------- | :-------------------------------------------------------------------------------------------- |
| | `--state` | {{< req >}}: Cluster state (`ready` or `deleted`) |
| | `--category` | {{< req >}}: Cluster category (`contract`, `internal`, `unpaid_poc`, `paid_poc`, or `system`) |
| | `--ingestor-units` | Ingestor units _(default is 0)_ |
| | `--ingestor-granularity` | Ingestor granularity _(default is 0)_ |
| | `--compactor-units` | Compactor units _(default is 0)_ |
| | `--compactor-granularity` | Compactor granularity _(default is 0)_ |
| | `--query-units` | Query units _(default is 0)_ |
| | `--query-granularity` | Query granularity _(default is 0)_ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Update an InfluxDB cluster
```sh
influxctl cluster update \
--state ready \
--category contract \
--ingestor-units 3 \
--compactor-units 1 \
--query-units 1 \
```

6
content/influxdb/clustered/reference/cli/influxctl/database/_index.md
View File

@ -20,13 +20,13 @@ influxctl database [subcommand] [flags]
## Subcommands
| Subcommand | Description |
| :--------------------------------------------------------------------- | :------------------ |
| Subcommand | Description |
| :--------------------------------------------------------------------------- | :------------------ |
| [create](/influxdb/clustered/reference/cli/influxctl/database/create/) | Create a database |
| [delete](/influxdb/clustered/reference/cli/influxctl/database/delete/) | Delete a database |
| [list](/influxdb/clustered/reference/cli/influxctl/database/list/) | List databases |
| [update](/influxdb/clustered/reference/cli/influxctl/database/list/) | Update a database |
| help, h | Output command help |
| help, h | Output command help |
## Flags

7
content/influxdb/clustered/reference/cli/influxctl/database/create.md
View File

@ -1,8 +1,7 @@
---
title: influxctl database create
description: >
The `influxctl database create` command creates a new database in an InfluxDB
cluster.
The `influxctl database create` command creates a new database in an InfluxDB cluster.
menu:
influxdb_clustered:
parent: influxctl database
@ -68,6 +67,10 @@ influxctl database create [--retention-period 0s] <DATABASE_NAME>
| | `--max-columns` | Maximum columns per table (default is 250, 0 uses default) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Create a database with an infinite retention period](#create-a-database-with-an-infinite-retention-period)

4
content/influxdb/clustered/reference/cli/influxctl/database/delete.md
View File

@ -40,6 +40,10 @@ when creating a new database.
| | `--force` | Do not prompt for confirmation to delete (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
##### Delete a database named "mydb"

10
content/influxdb/clustered/reference/cli/influxctl/database/list.md
View File

@ -1,14 +1,16 @@
---
title: influxctl database list
description: >
The `influxctl database list` command lists all databases in an InfluxDB cluster.
The `influxctl database list` command lists all databases in an InfluxDB Cloud
Dedicated cluster.
menu:
influxdb_clustered:
parent: influxctl database
weight: 301
---
The `influxctl database list` command lists all databases in an InfluxDB cluster.
The `influxctl database list` command lists all databases in an InfluxDB Cloud
Dedicated cluster.
The `--format` option lets you print the output in other formats.
By default, the 'table' format is used, but the 'json' format is
@ -26,3 +28,7 @@ influxctl database list [--format=table|json]
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

4
content/influxdb/clustered/reference/cli/influxctl/database/update.md
View File

@ -33,6 +33,10 @@ influxctl database update <DATABASE_NAME> [flags]
| | `--max-columns` | Maximum columns per table (default is 250, 0 uses default) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Update a database's retention period](#update-a-databases-retention-period)

6
content/influxdb/clustered/reference/cli/influxctl/token/_index.md
View File

@ -20,14 +20,14 @@ influxctl token [subcommand] [flags]
## Subcommands
| Subcommand | Description |
| :------------------------------------------------------------------ | :---------------------------- |
| Subcommand | Description |
| :------------------------------------------------------------------------ | :---------------------------- |
| [create](/influxdb/clustered/reference/cli/influxctl/token/create/) | Create a database token |
| [delete](/influxdb/clustered/reference/cli/influxctl/token/delete/) | Delete a database token |
| [get](/influxdb/clustered/reference/cli/influxctl/token/get/) | Get information about a token |
| [list](/influxdb/clustered/reference/cli/influxctl/token/list/) | List database tokens |
| [update](/influxdb/clustered/reference/cli/influxctl/token/update/) | Update a database token |
| help, h | Output command help |
| help, h | Output command help |
## Flags

17
content/influxdb/clustered/reference/cli/influxctl/token/create.md
View File

@ -13,6 +13,10 @@ The `influxctl token create` command creates a database token with specified
permissions to resources in an InfluxDB cluster and outputs
the token string.
The `--format` option lets you print the output in other formats.
By default, the 'table' format is used, but the 'json' format is
available for programmatic parsing by other tooling.
{{% note %}}
#### Store secure tokens in a secret store
@ -37,11 +41,16 @@ influxctl token create \
## Flags
| Flag | | Description |
| :--- | :----------------- | :------------------------------------------------- |
| | `--read-database` | Grant read permissions to a database _(Repeatable)_ |
| Flag | | Description |
| :--- | :----------------- | :--------------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--read-database` | Grant read permissions to a database _(Repeatable)_ |
| | `--write-database` | Grant write permissions to a database _(Repeatable)_ |
| `-h` | `--help` | Output command help |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples

4
content/influxdb/clustered/reference/cli/influxctl/token/delete.md
View File

@ -43,6 +43,10 @@ updated with a new database token to continue to interact with your InfluxDB clu
| | `--force` | Do not prompt for confirmation to delete (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Delete a database token](#delete-a-database-token)

4
content/influxdb/clustered/reference/cli/influxctl/token/get.md
View File

@ -29,6 +29,10 @@ influxctl token get [command options] <TOKEN_ID>
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
{{% code-placeholders "TOKEN_ID" %}}

7
content/influxdb/clustered/reference/cli/influxctl/token/list.md
View File

@ -8,7 +8,8 @@ menu:
weight: 301
---
The `influxctl token list` command lists all database tokens in an InfluxDB cluster.
The `influxctl token list` command lists all database tokens in an InfluxDB Cloud
Dedicated cluster.
The `--format` option lets you print the output in other formats.
By default, the 'table' format is used, but the 'json' format is
@ -26,3 +27,7 @@ influxctl token list [--format=table|json]
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}

4
content/influxdb/clustered/reference/cli/influxctl/token/update.md
View File

@ -43,6 +43,10 @@ To retain existing permissions, include them in the update command.
| | `--write-database` | Grant write permissions to a database _(Repeatable)_ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Update a token's permissions](#update-a-tokens-permissions)

8
content/influxdb/clustered/reference/cli/influxctl/user/_index.md
View File

@ -21,15 +21,15 @@ influxctl user [subcommand] [subcommand options] [arguments...]
## Subcommands
| Subcommand | Description |
| :----------------------------------------------------------------- | :------------------ |
| Subcommand | Description |
| :----------------------------------------------------------------------- | :------------------ |
| [delete](/influxdb/clustered/reference/cli/influxctl/user/delete/) | Delete a user |
| [invite](/influxdb/clustered/reference/cli/influxctl/user/invite/) | Invite a user |
| [list](/influxdb/clustered/reference/cli/influxctl/user/list/) | List all users |
| help, h | Output command help |
| help, h | Output command help |
## Flags
| Flag | | Description |
| :--- | :------- | :------------------ |
| `-h` | `--help` | Output command help |
| `-h` | `--help` | Output command help |

6
content/influxdb/clustered/reference/cli/influxctl/user/delete.md
View File

@ -1,7 +1,7 @@
---
title: influxctl user delete
description: >
The `influxctl user delete` command deletes a user from your InfluxDB Clustered account.
The `influxctl user delete` command deletes a user from your InfluxDB cluster.
menu:
influxdb_clustered:
parent: influxctl user
@ -36,6 +36,10 @@ and cannot be undone.
| :--- | :------- | :------------------ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
{{% code-placeholders "USER_ID" %}}

7
content/influxdb/clustered/reference/cli/influxctl/user/invite.md
View File

@ -1,8 +1,7 @@
---
title: influxctl user invite
description: >
The `influxctl user invite` command invites a user to your InfluxDB Clustered
account.
The `influxctl user invite` command invites a user to your InfluxDB cluster.
menu:
influxdb_clustered:
parent: influxctl user
@ -32,6 +31,10 @@ influxctl user invite [command options] <FIRST_NAME> <LAST_NAME> <EMAIL>
| :--- | :------- | :------------------ |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
{{% code-placeholders "(FIRST|LAST)_NAME|EMAIL" %}}

15
content/influxdb/clustered/reference/cli/influxctl/user/list.md
View File

@ -1,19 +1,18 @@
---
title: influxctl user list
description: >
The `influxctl user list` command lists all users associated with your InfluxDB
cluster.
The `influxctl user list` command lists all users associated with your
InfluxDB account ID.
menu:
influxdb_clustered:
parent: influxctl user
weight: 301
---
The `influxctl user list` command lists all users associated with your InfluxDB
cluster.
The `influxctl user list` command lists all users associated with your
InfluxDB account ID.
The `--format` option lets you print result in other formats.
The `--format` option lets you print the output in other formats.
By default, the 'table' format is used, but the 'json' format is
available for programmatic parsing by other tooling.
@ -29,3 +28,7 @@ influxctl user list [command options]
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}