updated all find cli commands to list, resolves #753

pull/754/head
Scott Anderson 2020-02-11 08:29:35 -07:00
parent 35bb58581d
commit 1e92cda9c6
37 changed files with 139 additions and 101 deletions

View File

@ -27,7 +27,7 @@ to delete a bucket.
Use the [`influx bucket delete` command](/v2.0/reference/cli/influx/bucket/delete)
to delete a bucket. Deleting a bucket requires the following:
- The bucket ID _(provided in the output of `influx bucket find`)_
- The bucket ID _(provided in the output of `influx bucket list`)_
- The name or ID of the organization to which the bucket belongs
```sh

View File

@ -49,7 +49,7 @@ If you change a bucket name, be sure to update the bucket in the above places as
Use the [`influx bucket update` command](/v2.0/reference/cli/influx/bucket/update)
to update a bucket. Updating a bucket requires the following:
- The bucket ID _(provided in the output of `influx bucket find`)_
- The bucket ID _(provided in the output of `influx bucket list`)_
- The name or ID of the organization the bucket belongs to.
##### Update the name of a bucket

View File

@ -20,13 +20,13 @@ weight: 202
## View buckets using the influx CLI
Use the [`influx bucket find` command](/v2.0/reference/cli/influx/bucket/find)
to view a buckets in an organization.
Use the [`influx bucket list` command](/v2.0/reference/cli/influx/bucket/list)
to view a buckets in an organization.
```sh
influx bucket find
influx bucket list
```
Other filtering options such as filtering by organization, name, or ID are available.
See the [`influx bucket find` documentation](/v2.0/reference/cli/influx/bucket/find)
See the [`influx bucket list` documentation](/v2.0/reference/cli/influx/bucket/list)
for information about other available flags.

View File

@ -29,7 +29,7 @@ to delete an organization.
Use the [`influx org delete` command](/v2.0/reference/cli/influx/org/delete)
to delete an organization. Deleting an organization requires the following:
- The organization ID _(provided in the output of `influx org find`)_
- The organization ID _(provided in the output of `influx org list`)_
```sh
# Syntax

View File

@ -30,7 +30,7 @@ _Complete content coming soon_ -->
1. Get a list of users and their IDs by running the following:
```sh
influx user find
influx user list
```
2. To add a user to an organization, run the following command:

View File

@ -33,7 +33,7 @@ For information about deleting a user from InfluxDB, see [Delete a user](/v2.0/u
Use the [`influx org members remove` command](/v2.0/reference/cli/influx/org/members/remove)
to remove a member from an organization. Removing a member requires the following:
- The organization name or ID _(provided in the output of [`influx org find`](/v2.0/reference/cli/influx/org/find/))_
- The organization name or ID _(provided in the output of [`influx org list`](/v2.0/reference/cli/influx/org/list/))_
- The member ID _(provided in the output of [`influx org members list`](/v2.0/reference/cli/influx/org/members/list/))_
```sh

View File

@ -38,7 +38,7 @@ If you change an organization name, be sure to update the organization in the ab
Use the [`influx org update` command](/v2.0/reference/cli/influx/org/update)
to update an organization. Updating an organization requires the following:
- The org ID _(provided in the output of `influx org find`)_
- The org ID _(provided in the output of `influx org list`)_
##### Update the name of a organization
```sh

View File

@ -23,15 +23,15 @@ to view organizations.
## View organizations using the influx CLI
Use the [`influx org find` command](/v2.0/reference/cli/influx/org/find)
Use the [`influx org list` command](/v2.0/reference/cli/influx/org/list)
to view organizations.
```sh
influx org find
influx org list
```
Filtering options such as filtering by name or ID are available.
See the [`influx org find` documentation](/v2.0/reference/cli/influx/org/find)
See the [`influx org list` documentation](/v2.0/reference/cli/influx/org/list)
for information about other available flags.
## View your organization ID
@ -46,10 +46,10 @@ http://localhost:9999/orgs/<span class="bp" style="font-weight:bold;margin:0 .15
### Organization ID in the CLI
Use [`influx org find`](#view-organizations-using-the-influx-cli) to view your organization ID.
Use [`influx org list`](#view-organizations-using-the-influx-cli) to view your organization ID.
```sh
> influx org find
> influx org list
ID Name
03a2bbf46249a000 org-1

View File

@ -25,7 +25,7 @@ related:
## Delete a task with the influx CLI
Use the `influx task delete` command to delete a task.
_This command requires a task ID, which is available in the output of `influx task find`._
_This command requires a task ID, which is available in the output of `influx task list`._
```sh
# Syntax

View File

@ -34,10 +34,10 @@ To run a task from the `influx` CLI, the task must have already run at least onc
```sh
# List all tasks to find the ID of the task to run
influx task find
influx task list
# Use the task ID to list previous runs of the task
influx task run find --task-id=0000000000000000
influx task run list --task-id=0000000000000000
# Use the task ID and run ID to retry a run
influx task run retry --task-id=0000000000000000 --run-id=0000000000000000

View File

@ -31,14 +31,14 @@ to view task run histories and associated logs.
To view logs associated with a run, click **View Logs** next to the run in the task's run history.
## View a task's run history with the influx CLI
Use the `influx task run find` command to view a task's run history.
Use the `influx task run list` command to view a task's run history.
```sh
# List all tasks to find the ID of the task to run
influx task find
influx task list
# Use the task ID to view the run history of a task
influx task run find --task-id=0000000000000000
influx task run list --task-id=0000000000000000
```
{{% note %}}

View File

@ -38,7 +38,7 @@ task you want to activate or inactivate.
## Update a task with the influx CLI
Use the `influx task update` command to update or change the status of an existing task.
_This command requires a task ID, which is available in the output of `influx task find`._
_This command requires a task ID, which is available in the output of `influx task list`._
#### Update a task Flux script
Pass the file path of your updated Flux script to the `influx task update` command

View File

@ -9,7 +9,7 @@ menu:
parent: Manage tasks
weight: 202
related:
- /v2.0/reference/cli/influx/task/find
- /v2.0/reference/cli/influx/task/list
---
## View tasks in the InfluxDB UI
@ -25,14 +25,14 @@ Click the **Tasks** icon in the left navigation to view the lists of tasks.
3. Click on the heading of any column to sort by that field.
## View tasks with the influx CLI
Use the `influx task find` command to return a list of created tasks.
Use the `influx task list` command to return a list of created tasks.
```sh
influx task find
influx task list
```
#### Filter tasks using the CLI
Other filtering options such as filtering by organization or user,
or limiting the number of tasks returned, are available.
See the [`influx task find` documentation](/v2.0/reference/cli/influx/task/find)
See the [`influx task list` documentation](/v2.0/reference/cli/influx/task/list)
for information about other available flags.

View File

@ -26,7 +26,7 @@ influx auth [command]
| [active](/v2.0/reference/cli/influx/auth/active) | Activate authorization |
| [create](/v2.0/reference/cli/influx/auth/create) | Create authorization |
| [delete](/v2.0/reference/cli/influx/auth/delete) | Delete authorization |
| [find](/v2.0/reference/cli/influx/auth/find) | Find authorization |
| [list](/v2.0/reference/cli/influx/auth/list) | List authorizations |
| [inactive](/v2.0/reference/cli/influx/auth/inactive) | Inactivate authorization |
## Flags

View File

@ -1,24 +1,29 @@
---
title: influx auth find
description: The 'influx auth find' command lists and searches authorizations in InfluxDB.
title: influx auth list
description: The 'influx auth list' command lists and searches authorizations in InfluxDB.
menu:
v2_0_ref:
name: influx auth find
name: influx auth list
parent: influx auth
weight: 201
aliases:
- /v2.0/reference/cli/influx/auth/find
---
The `influx auth find` command lists and searches authorizations in InfluxDB.
The `influx auth list` command lists and searches authorizations in InfluxDB.
## Usage
```
influx auth find [flags]
influx auth list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for the `find` command | |
| `-h`, `--help` | Help for the `list` command | |
| `-i`, `--id` | The authorization ID | string |
| `-o`, `--org` | The organization | string |
| `--org-id` | The organization ID | string |

View File

@ -22,7 +22,7 @@ influx bucket [command]
|:---------- |:----------- |
| [create](/v2.0/reference/cli/influx/bucket/create) | Create bucket |
| [delete](/v2.0/reference/cli/influx/bucket/delete) | Delete bucket |
| [find](/v2.0/reference/cli/influx/bucket/find) | Find buckets |
| [list](/v2.0/reference/cli/influx/bucket/find) | List buckets |
| [update](/v2.0/reference/cli/influx/bucket/update) | Update bucket |
## Flags

View File

@ -1,24 +1,29 @@
---
title: influx bucket find
description: The 'influx bucket find' command lists and searches for buckets in InfluxDB.
title: influx bucket list
description: The 'influx bucket list' command lists and searches for buckets in InfluxDB.
menu:
v2_0_ref:
name: influx bucket find
name: influx bucket list
parent: influx bucket
weight: 201
aliases:
- /v2.0/reference/cli/influx/bucket/find
---
The `influx bucket find` command lists and searches for buckets in InfluxDB.
The `influx bucket list` command lists and searches for buckets in InfluxDB.
## Usage
```
influx bucket find [flags]
influx bucket list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for the `find` command | |
| `-h`, `--help` | Help for the `list` command | |
| `-i`, `--id` | The bucket ID | string |
| `-n`, `--name` | The bucket name | string |
| `-o`, `--org` | The bucket organization name | string |

View File

@ -25,7 +25,7 @@ influx org [command]
|:---------- |:----------- |
| [create](/v2.0/reference/cli/influx/org/create) | Create an organization |
| [delete](/v2.0/reference/cli/influx/org/delete) | Delete an organization |
| [find](/v2.0/reference/cli/influx/org/find) | Find organizations |
| [list](/v2.0/reference/cli/influx/org/list) | List organizations |
| [members](/v2.0/reference/cli/influx/org/members) | Organization membership commands |
| [update](/v2.0/reference/cli/influx/org/update) | Update an organization |

View File

@ -1,24 +1,29 @@
---
title: influx org find
description: The 'influx org find' lists and searches for organizations in InfluxDB.
title: influx org list
description: The 'influx org list' lists and searches for organizations in InfluxDB.
menu:
v2_0_ref:
name: influx org find
name: influx org list
parent: influx org
weight: 201
aliases:
- /v2.0/reference/influx/org/find
---
The `influx org find` lists and searches for organizations in InfluxDB.
The `influx org list` lists and searches for organizations in InfluxDB.
## Usage
```
influx org find [flags]
influx org list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `find` | |
| `-h`, `--help` | Help for `list` | |
| `-i`, `--id` | Organization ID | string |
| `-n`, `--name` | Organization name | string |

View File

@ -21,7 +21,7 @@ influx secret [subcommand]
| Subcommand | Description |
|:---------- |:----------- |
| [delete](/v2.0/reference/cli/influx/secret/delete/) | Delete a secret |
| [find](/v2.0/reference/cli/influx/secret/find/) | Find secrets |
| [list](/v2.0/reference/cli/influx/secret/list/) | List secrets |
| [update](/v2.0/reference/cli/influx/secret/update/) | Add or update a secret |
## Flags

View File

@ -1,25 +1,28 @@
---
title: influx secret find
description: The 'influx secret find' command lists secret keys.
title: influx secret list
description: The 'influx secret list' command lists secret keys.
menu:
v2_0_ref:
name: influx secret find
name: influx secret list
parent: influx secret
weight: 101
v2.0/tags: [secrets]
---
The `influx secret find` command lists secret keys.
The `influx secret list` command lists secret keys.
## Usage
```
influx secret find [flags]
influx secret list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for `secret find` | |
| `-h`, `--help` | Help for `secret list` | |
| `-o`, `--org` | Organization name | string |
| `--org-id` | Organization ID | string |

View File

@ -22,7 +22,7 @@ influx task [command]
|:---------- |:----------- |
| [create](/v2.0/reference/cli/influx/task/create) | Create task |
| [delete](/v2.0/reference/cli/influx/task/delete) | Delete task |
| [find](/v2.0/reference/cli/influx/task/find) | Find tasks |
| [list](/v2.0/reference/cli/influx/task/list) | List tasks |
| [log](/v2.0/reference/cli/influx/task/log) | Log related commands |
| [retry](/v2.0/reference/cli/influx/task/retry) | retry a run |
| [run](/v2.0/reference/cli/influx/task/run) | Run related commands |

View File

@ -1,26 +1,31 @@
---
title: influx task find
description: The 'influx task find' command lists and searches for tasks in InfluxDB.
title: influx task list
description: The 'influx task list' command lists and searches for tasks in InfluxDB.
menu:
v2_0_ref:
name: influx task find
name: influx task list
parent: influx task
weight: 201
aliases:
- /v2.0/reference/cli/influx/task/find
---
The `influx task find` command lists and searches for tasks in InfluxDB.
The `influx task list` command lists and searches for tasks in InfluxDB.
## Usage
```
influx task find [flags]
influx task list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `find` | |
| `-h`, `--help` | Help for `list` | |
| `-i`, `--id` | Task ID | string |
| `--limit` | The number of tasks to find (default `100`) | integer |
| `--limit` | The number of tasks to list (default `100`) | integer |
| `--org` | Task organization name | string |
| `--org-id` | Task organization ID | string |
| `-n`, `--user-id` | Task owner ID | string |

View File

@ -1,6 +1,6 @@
---
title: influx task log
description: The 'influx task log' and its subcommand 'find' output log information related related to a task.
description: The 'influx task log' and its subcommand 'list' output log information related related to a task.
menu:
v2_0_ref:
name: influx task log
@ -9,7 +9,7 @@ weight: 201
v2.0/tags: [logs]
---
The `influx task log` command and its subcommand `find` output log information related to a task.
The `influx task log` command and its subcommand `list` output log information related to a task.
## Usage
```
@ -20,7 +20,7 @@ influx task log [command]
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [find](/v2.0/reference/cli/influx/task/log/find) | Find logs for task |
| [list](/v2.0/reference/cli/influx/task/log/list) | List logs for task |
## Flags
| Flag | Description |

View File

@ -1,24 +1,29 @@
---
title: influx task log find
description: The 'influx task log find' command outputs log information related to a task.
title: influx task log list
description: The 'influx task log list' command outputs log information related to a task.
menu:
v2_0_ref:
name: influx task log find
name: influx task log list
parent: influx task log
weight: 301
aliases:
- /v2.0/reference/cli/influx/task/log/find
---
The `influx task log find` command outputs log information related to a task.
The `influx task log list` command outputs log information related to a task.
## Usage
```
influx task log find [flags]
influx task log list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `find` | |
| `-h`, `--help` | Help for `list` | |
| `--org-id` | Organization ID | string |
| `--run-id` | Run ID | string |
| `--task-id` | Task ID **(Required)** | string |

View File

@ -1,7 +1,7 @@
---
title: influx task run
description: >
The 'influx task run' command and its subcommand 'find' output information
The 'influx task run' command and its subcommand 'list' output information
related to runs of a task.
menu:
v2_0_ref:
@ -10,7 +10,7 @@ menu:
weight: 201
---
The `influx task run` command and its subcommand `find` output information related to runs of a task.
The `influx task run` command and its subcommand `list` output information related to runs of a task.
## Usage
```
@ -21,7 +21,7 @@ influx task run [command]
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [find](/v2.0/reference/cli/influx/task/run/find) | Find runs for a task |
| [list](/v2.0/reference/cli/influx/task/run/list) | List runs for a task |
## Flags
| Flag | Description |

View File

@ -1,26 +1,31 @@
---
title: influx task run find
description: The 'influx task run find' command outputs information related to runs of a task.
title: influx task run list
description: The 'influx task run list' command outputs information related to runs of a task.
menu:
v2_0_ref:
name: influx task run find
name: influx task run list
parent: influx task run
weight: 301
aliases:
- /v2.0/reference/cli/influx/task/run/find
---
The `influx task run find` command outputs information related to runs of a task.
The `influx task run list` command outputs information related to runs of a task.
## Usage
```
influx task run find [flags]
influx task run list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `--after` | After-time for filtering | string |
| `--before` | Before-time for filtering | string |
| `-h`,`--help` | Help for `find` | |
| `-h`,`--help` | Help for `list` | |
| `--limit` | Limit the number of results | integer |
| `--org-id` | Organization ID | string |
| `--run-id` | Run ID | string |

View File

@ -22,7 +22,7 @@ influx user [command]
|:---------- |:----------- |
| [create](/v2.0/reference/cli/influx/user/create) | Create a user |
| [delete](/v2.0/reference/cli/influx/user/delete) | Delete a user |
| [find](/v2.0/reference/cli/influx/user/find) | Find a user |
| [list](/v2.0/reference/cli/influx/user/list) | List users |
| [password](/v2.0/reference/cli/influx/user/password) | Update a user's password |
| [update](/v2.0/reference/cli/influx/user/update) | Update a user |

View File

@ -1,24 +1,29 @@
---
title: influx user find
description: The 'influx user find' lists and searches for users in InfluxDB.
title: influx user list
description: The 'influx user list' lists and searches for users in InfluxDB.
menu:
v2_0_ref:
name: influx user find
name: influx user list
parent: influx user
weight: 201
aliases:
- /v2.0/reference/cli/influx/user/find
---
The `influx user find` command lists and searches for users in InfluxDB.
The `influx user list` command lists and searches for users in InfluxDB.
## Usage
```
influx user find [flags]
influx user list [flags]
```
#### Aliases
`list`, `ls`, `find`
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `find` | |
| `-h`, `--help` | Help for `list` | |
| `-i`, `--id` | The user ID | string |
| `-n`, `--name` | The username | string |

View File

@ -11,11 +11,11 @@ weight: 302
View secret keys using the `influx` command line interface (CLI) or the InfluxDB API.
## View secret keys using the influx CLI
Use the [`influx secret find` command](/v2.0/reference/cli/influx/secret/find/)
Use the [`influx secret list` command](/v2.0/reference/cli/influx/secret/list/)
to list your organization's secret keys.
```sh
influx secret find
influx secret list
```
## View secret keys using the InfluxDB API

View File

@ -48,5 +48,5 @@ influx auth create -o my-org \
```
Filtering options such as filtering by authorization ID, username, or user ID are available.
See the [`influx auth find` documentation](/v2.0/reference/cli/influx/auth/find)
See the [`influx auth list` documentation](/v2.0/reference/cli/influx/auth/list)
for information about other available flags.

View File

@ -25,13 +25,13 @@ command line interface (CLI).
## View tokens using the influx CLI
Use the [`influx auth find` command](/v2.0/reference/cli/influx/auth/find)
Use the [`influx auth list` command](/v2.0/reference/cli/influx/auth/list)
to view tokens.
```sh
influx auth find
influx auth list
```
Filtering options such as filtering by authorization ID, username, or user ID are available.
See the [`influx auth find` documentation](/v2.0/reference/cli/influx/auth/find)
See the [`influx auth list` documentation](/v2.0/reference/cli/influx/auth/list)
for information about other available flags.

View File

@ -20,7 +20,7 @@ User passwords cannot be updated in the InfluxDB UI.
Use the [`influx user password` command](/v2.0/reference/cli/influx/user/password)
to update a password for a user. To update a password, you need the following:
- Username or user ID _(provided in the output of `influx user find`)_
- Username or user ID _(provided in the output of `influx user list`)_
- New password
##### Update a password

View File

@ -25,7 +25,7 @@ and include the following:
- Username
- Organization name or organization ID to add the user to _(provided in the output of
[`influx org find`](/v2.0/reference/cli/influx/org/find/))_
[`influx org list`](/v2.0/reference/cli/influx/org/list/))_
```sh
# Syntax
@ -41,7 +41,7 @@ include a password and organization ID with the `influx user create` command.
- Username
- Organization name or organization ID to add the user to _(provided in the output of
[`influx org find`](/v2.0/reference/cli/influx/org/find/))_
[`influx org list`](/v2.0/reference/cli/influx/org/list/))_
- Password
```sh

View File

@ -29,7 +29,7 @@ Users cannot be deleted from the InfluxDB UI.
Use the [`influx user delete` command](/v2.0/reference/cli/influx/user/delete)
to delete a user. Deleting a user requires the following:
- The user ID _(provided in the output of `influx user find`)_
- The user ID _(provided in the output of `influx user list`)_
```sh
# Syntax

View File

@ -23,7 +23,7 @@ User information cannot be updated in the InfluxDB UI.
Use the [`influx user update` command](/v2.0/reference/cli/influx/user/update)
to update a user. Updating a user requires the following:
- The user ID _(provided in the output of `influx user find`)_
- The user ID _(provided in the output of `influx user list`)_
##### Update the name of a user
```sh

View File

@ -20,13 +20,13 @@ There is no list of users in the InfluxDB UI.
## View users using the influx CLI
Use the [`influx user find` command](/v2.0/reference/cli/influx/user/find)
Use the [`influx user list` command](/v2.0/reference/cli/influx/user/list)
to view users.
```sh
influx user find
influx user list
```
Filtering options such as filtering by username or ID are available.
See the [`influx user find` documentation](/v2.0/reference/cli/influx/user/find)
See the [`influx user list` documentation](/v2.0/reference/cli/influx/user/list)
for information about other available flags.