From e136da10c6d43dc304cce021d8b67712ab957683 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 21 Jan 2019 14:43:08 -0700 Subject: [PATCH] added all cli command doc pages --- content/v2.0/reference/cli/_index.md | 10 ++++- content/v2.0/reference/cli/influx/_index.md | 31 +++++++------ .../v2.0/reference/cli/influx/auth/_index.md | 26 +++++------ .../v2.0/reference/cli/influx/auth/active.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/auth/create.md | 44 +++++++++++++++++++ .../v2.0/reference/cli/influx/auth/delete.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/auth/find.md | 31 +++++++++++++ .../reference/cli/influx/auth/inactive.md | 29 ++++++++++++ .../reference/cli/influx/bucket/_index.md | 24 +++++----- .../reference/cli/influx/bucket/create.md | 32 ++++++++++++++ .../reference/cli/influx/bucket/delete.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/bucket/find.md | 32 ++++++++++++++ .../reference/cli/influx/bucket/update.md | 31 +++++++++++++ .../v2.0/reference/cli/influx/help/_index.md | 9 ++-- .../v2.0/reference/cli/influx/org/_index.md | 26 +++++------ .../v2.0/reference/cli/influx/org/create.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/org/delete.md | 29 ++++++++++++ content/v2.0/reference/cli/influx/org/find.md | 30 +++++++++++++ .../cli/influx/org/members/_index.md | 36 +++++++++++++++ .../reference/cli/influx/org/members/add.md | 31 +++++++++++++ .../reference/cli/influx/org/members/list.md | 30 +++++++++++++ .../cli/influx/org/members/remove.md | 31 +++++++++++++ .../v2.0/reference/cli/influx/org/update.md | 30 +++++++++++++ .../v2.0/reference/cli/influx/query/_index.md | 10 +++-- .../v2.0/reference/cli/influx/repl/_index.md | 11 +++-- .../v2.0/reference/cli/influx/setup/_index.md | 9 ++-- .../v2.0/reference/cli/influx/task/_index.md | 24 +++++----- .../v2.0/reference/cli/influx/task/create.md | 30 +++++++++++++ .../v2.0/reference/cli/influx/task/delete.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/task/find.md | 32 ++++++++++++++ .../reference/cli/influx/task/log/_index.md | 34 ++++++++++++++ .../reference/cli/influx/task/log/find.md | 31 +++++++++++++ .../v2.0/reference/cli/influx/task/retry.md | 30 +++++++++++++ .../reference/cli/influx/task/run/_index.md | 36 +++++++++++++++ .../reference/cli/influx/task/run/find.md | 34 ++++++++++++++ .../v2.0/reference/cli/influx/task/update.md | 30 +++++++++++++ .../v2.0/reference/cli/influx/user/_index.md | 18 ++++---- .../v2.0/reference/cli/influx/user/create.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/user/delete.md | 29 ++++++++++++ .../v2.0/reference/cli/influx/user/find.md | 30 +++++++++++++ .../v2.0/reference/cli/influx/user/update.md | 31 +++++++++++++ .../v2.0/reference/cli/influx/write/_index.md | 10 +++-- 42 files changed, 1050 insertions(+), 95 deletions(-) create mode 100644 content/v2.0/reference/cli/influx/auth/active.md create mode 100644 content/v2.0/reference/cli/influx/auth/create.md create mode 100644 content/v2.0/reference/cli/influx/auth/delete.md create mode 100644 content/v2.0/reference/cli/influx/auth/find.md create mode 100644 content/v2.0/reference/cli/influx/auth/inactive.md create mode 100644 content/v2.0/reference/cli/influx/bucket/create.md create mode 100644 content/v2.0/reference/cli/influx/bucket/delete.md create mode 100644 content/v2.0/reference/cli/influx/bucket/find.md create mode 100644 content/v2.0/reference/cli/influx/bucket/update.md create mode 100644 content/v2.0/reference/cli/influx/org/create.md create mode 100644 content/v2.0/reference/cli/influx/org/delete.md create mode 100644 content/v2.0/reference/cli/influx/org/find.md create mode 100644 content/v2.0/reference/cli/influx/org/members/_index.md create mode 100644 content/v2.0/reference/cli/influx/org/members/add.md create mode 100644 content/v2.0/reference/cli/influx/org/members/list.md create mode 100644 content/v2.0/reference/cli/influx/org/members/remove.md create mode 100644 content/v2.0/reference/cli/influx/org/update.md create mode 100644 content/v2.0/reference/cli/influx/task/create.md create mode 100644 content/v2.0/reference/cli/influx/task/delete.md create mode 100644 content/v2.0/reference/cli/influx/task/find.md create mode 100644 content/v2.0/reference/cli/influx/task/log/_index.md create mode 100644 content/v2.0/reference/cli/influx/task/log/find.md create mode 100644 content/v2.0/reference/cli/influx/task/retry.md create mode 100644 content/v2.0/reference/cli/influx/task/run/_index.md create mode 100644 content/v2.0/reference/cli/influx/task/run/find.md create mode 100644 content/v2.0/reference/cli/influx/task/update.md create mode 100644 content/v2.0/reference/cli/influx/user/create.md create mode 100644 content/v2.0/reference/cli/influx/user/delete.md create mode 100644 content/v2.0/reference/cli/influx/user/find.md create mode 100644 content/v2.0/reference/cli/influx/user/update.md diff --git a/content/v2.0/reference/cli/_index.md b/content/v2.0/reference/cli/_index.md index dde15e9e7..5a38e0f18 100644 --- a/content/v2.0/reference/cli/_index.md +++ b/content/v2.0/reference/cli/_index.md @@ -1,11 +1,17 @@ --- title: Command line tools seotitle: Command line tools for managing InfluxDB -description: InfluxDB comes with command line tools meant to aid in managing and working with InfluxDB. +description: > + InfluxDB provides command line tools designed to aid in managing and working + with InfluxDB from the command line. menu: v2_0_ref: name: Command line tools weight: 1 --- -_Placeholder for command line content._ +InfluxDB provides command line tools designed to aid in managing and working +with InfluxDB from the command line. +The following command line interfaces (CLIs) are available: + +[influx](/v2.0/reference/cli/influx) diff --git a/content/v2.0/reference/cli/influx/_index.md b/content/v2.0/reference/cli/influx/_index.md index ab82d6e35..d4cb35d24 100644 --- a/content/v2.0/reference/cli/influx/_index.md +++ b/content/v2.0/reference/cli/influx/_index.md @@ -1,7 +1,9 @@ --- title: influx CLI seotitle: "'influx' command line client" -description: placeholder +description: > + The 'influx' CLI includes commands to manage many aspects of InfluxDB, + including buckets, organizations, users, tasks, etc. menu: v2_0_ref: name: influx @@ -9,7 +11,8 @@ menu: wieght: 1 --- -The `influx` command line interface (CLI). +The `influx` CLI includes commands to manage many aspects of InfluxDB, +including buckets, organizations, users, tasks, etc. ## Usage ``` @@ -18,18 +21,18 @@ influx [command] ``` ## Commands -| Command | Description | -|:------- |:----------- | -| [auth](/v2.0/reference/cli/influx/auth) | Authorization management commands | -| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands | -| [help](/v2.0/reference/cli/influx/help) | Help about any command | -| [org](/v2.0/reference/cli/influx/org) | Organization management commands | -| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query | -| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) | -| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket... | -| [task](/v2.0/reference/cli/influx/task) | Task management commands | -| [user](/v2.0/reference/cli/influx/user) | User management commands | -| [write](/v2.0/reference/cli/influx/write) | Write points to InfluxDB | +| Command | Description | +|:------- |:----------- | +| [auth](/v2.0/reference/cli/influx/auth) | Authorization management commands | +| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands | +| [help](/v2.0/reference/cli/influx/help) | Help about any command | +| [org](/v2.0/reference/cli/influx/org) | Organization management commands | +| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query | +| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) | +| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. | +| [task](/v2.0/reference/cli/influx/task) | Task management commands | +| [user](/v2.0/reference/cli/influx/user) | User management commands | +| [write](/v2.0/reference/cli/influx/write) | Write points to InfluxDB | ## Flags | Flag | Description | Input type | diff --git a/content/v2.0/reference/cli/influx/auth/_index.md b/content/v2.0/reference/cli/influx/auth/_index.md index ece05326f..1e538d558 100644 --- a/content/v2.0/reference/cli/influx/auth/_index.md +++ b/content/v2.0/reference/cli/influx/auth/_index.md @@ -1,6 +1,6 @@ --- -title: Influx authorization management commands -description: placeholder +title: influx auth – Authorization management commands +description: The 'influx auth' command and its subcommands manage authorizations in InfluxDB. menu: v2_0_ref: name: influx auth @@ -8,7 +8,7 @@ menu: weight: 1 --- -Authorization management commands +The `influx auth` command and its subcommands manage authorizations in InfluxDB. ## Usage ``` @@ -20,18 +20,18 @@ influx auth [command] `auth`, `authorization` ## Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| active | Active authorization | -| create | Create authorization | -| delete | Delete authorization | -| find | Find authorization | -| inactive | Inactive authorization | +| Subcommand | Description | +|:---------- |:----------- | +| [active](/v2.0/reference/cli/influx/auth/active) | Active 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 | +| [inactive](/v2.0/reference/cli/influx/auth/inactive) | Inactive authorization | ## Flags -| Flag | Description | -|:---- |:----------- | -| `-h`, `--help` | Help for the auth command | +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for the `auth` command | ## Global Flags | Global flag | Description | Input type | diff --git a/content/v2.0/reference/cli/influx/auth/active.md b/content/v2.0/reference/cli/influx/auth/active.md new file mode 100644 index 000000000..3658dc64f --- /dev/null +++ b/content/v2.0/reference/cli/influx/auth/active.md @@ -0,0 +1,29 @@ +--- +title: influx auth active +description: placeholder +menu: + v2_0_ref: + name: influx auth active + parent: influx auth + weight: 1 +--- + +Active authorization + +## Usage +``` +influx auth active [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------:| +| `-h`, `--help` | Help for the `active` command | | +| `-i`, `--id` | The authorization ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/auth/create.md b/content/v2.0/reference/cli/influx/auth/create.md new file mode 100644 index 000000000..6fa35b477 --- /dev/null +++ b/content/v2.0/reference/cli/influx/auth/create.md @@ -0,0 +1,44 @@ +--- +title: influx auth create +description: placeholder +menu: + v2_0_ref: + name: influx auth create + parent: influx auth + weight: 1 +--- + +Create authorization + +## Usage +``` +influx auth create [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `create` command | | +| `-o`, `--org` | The organization name **(Required)** | string | +| `--read-bucket` | The bucket ID | stringArray | +| `--read-buckets` | Grants the permission to perform read actions against organization buckets | | +| `--read-dashboards` | Grants the permission to read dashboards | | +| `--read-orgs` | Grants the permission to read organizations | | +| `--read-tasks` | Grants the permission to read tasks | | +| `--read-telegrafs` | Grants the permission to read telegraf configs | | +| `--read-user` | Grants the permission to perform read actions against organization users | | +| `-u`, `--user` | The user name | string | +| `--write-bucket` | The bucket ID | stringArray | +| `--write-buckets` | Grants the permission to perform mutative actions against organization buckets | | +| `--write-dashboards` | Grants the permission to create dashboards | | +| `--write-orgs` | Grants the permission to create organizations | | +| `--write-tasks` | Grants the permission to create tasks | | +| `--write-telegrafs` | Grants the permission to create telegraf configs | | +| `--write-user` | Grants the permission to perform mutative actions against organization users | | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/auth/delete.md b/content/v2.0/reference/cli/influx/auth/delete.md new file mode 100644 index 000000000..ea7075d33 --- /dev/null +++ b/content/v2.0/reference/cli/influx/auth/delete.md @@ -0,0 +1,29 @@ +--- +title: influx auth delete +description: placeholder +menu: + v2_0_ref: + name: influx auth delete + parent: influx auth + weight: 1 +--- + +Delete authorization + +## Usage +``` +influx auth delete [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `delete` command | | +| `-i`, `--id` | The authorization ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/auth/find.md b/content/v2.0/reference/cli/influx/auth/find.md new file mode 100644 index 000000000..1c1389463 --- /dev/null +++ b/content/v2.0/reference/cli/influx/auth/find.md @@ -0,0 +1,31 @@ +--- +title: influx auth find +description: placeholder +menu: + v2_0_ref: + name: influx auth find + parent: influx auth + weight: 1 +--- + +Find authorization + +## Usage +``` +influx auth find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `find` command | | +| `-i`, `--id` | The authorization ID | string | +| `-u`, `--user` | The user | string | +| `--user-id` | The user ID | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/auth/inactive.md b/content/v2.0/reference/cli/influx/auth/inactive.md new file mode 100644 index 000000000..6ebf30317 --- /dev/null +++ b/content/v2.0/reference/cli/influx/auth/inactive.md @@ -0,0 +1,29 @@ +--- +title: influx auth inactive +description: placeholder +menu: + v2_0_ref: + name: influx auth inactive + parent: influx auth + weight: 1 +--- + +Inactive authorization + +## Usage +``` +influx auth inactive [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `inactive` command | | +| `-i`, `--id` | The authorization ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/bucket/_index.md b/content/v2.0/reference/cli/influx/bucket/_index.md index 69c439e30..2d27ded14 100644 --- a/content/v2.0/reference/cli/influx/bucket/_index.md +++ b/content/v2.0/reference/cli/influx/bucket/_index.md @@ -1,6 +1,6 @@ --- -title: Influx bucket management commands -description: placeholder +title: influx bucket – Bucket management commands +description: The 'influx bucket' command and its subcommands manage buckets in InfluxDB. menu: v2_0_ref: name: influx bucket @@ -8,7 +8,7 @@ menu: weight: 1 --- -Bucket management commands +The `influx bucket` command and its subcommands manage buckets in InfluxDB. ## Usage ``` @@ -17,17 +17,17 @@ influx bucket [command] ``` ## Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| create | Create bucket | -| delete | Delete bucket | -| find | Find buckets | -| update | Update bucket | +| Subcommand | Description | +|:---------- |:----------- | +| [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 | +| [update](/v2.0/reference/cli/influx/bucket/update) | Update bucket | ## Flags -| Flag | Description | -|:---- |:----------- | -| `-h`, `--help` | Help for the bucket command | +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for the `bucket` command | ## Global Flags | Global flag | Description | Input type | diff --git a/content/v2.0/reference/cli/influx/bucket/create.md b/content/v2.0/reference/cli/influx/bucket/create.md new file mode 100644 index 000000000..4569996e4 --- /dev/null +++ b/content/v2.0/reference/cli/influx/bucket/create.md @@ -0,0 +1,32 @@ +--- +title: influx bucket create +description: placeholder +menu: + v2_0_ref: + name: influx bucket create + parent: influx bucket + weight: 1 +--- + +Create bucket + +## Usage +``` +influx bucket create [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `create` command | | +| `-n`, `--name` | Name of bucket that will be created | string | +| `-o`, `--org` | Name of the organization that owns the bucket | string | +| `--org-id` | The ID of the organization that owns the bucket | string | +| `-r`, `--retention` | Duration in nanoseconds data will live in bucket | duration | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/bucket/delete.md b/content/v2.0/reference/cli/influx/bucket/delete.md new file mode 100644 index 000000000..08e5ec3f6 --- /dev/null +++ b/content/v2.0/reference/cli/influx/bucket/delete.md @@ -0,0 +1,29 @@ +--- +title: influx bucket delete +description: placeholder +menu: + v2_0_ref: + name: influx bucket delete + parent: influx bucket + weight: 1 +--- + +Delete bucket + +## Usage +``` +influx bucket delete [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `delete` command | | +| `-i`, `--id` | The bucket ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/bucket/find.md b/content/v2.0/reference/cli/influx/bucket/find.md new file mode 100644 index 000000000..5d49dd291 --- /dev/null +++ b/content/v2.0/reference/cli/influx/bucket/find.md @@ -0,0 +1,32 @@ +--- +title: influx bucket find +description: placeholder +menu: + v2_0_ref: + name: influx bucket find + parent: influx bucket + weight: 1 +--- + +Find buckets + +## Usage +``` +influx bucket find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `find` command | | +| `-i`, `--id` | The bucket ID | string | +| `-n`, `--name` | The bucket name | string | +| `-o`, `--org` | The bucket organization name | string | +| `--org-id` | The bucket organization ID | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/bucket/update.md b/content/v2.0/reference/cli/influx/bucket/update.md new file mode 100644 index 000000000..9a0fd08ba --- /dev/null +++ b/content/v2.0/reference/cli/influx/bucket/update.md @@ -0,0 +1,31 @@ +--- +title: influx bucket update +description: placeholder +menu: + v2_0_ref: + name: influx bucket update + parent: influx bucket + weight: 1 +--- + +Update bucket + +## Usage +``` +influx bucket update [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for the `update` command | | +| `-i`, `--id` | The bucket ID **(Required)** | string | +| `-n`, `--name` | New bucket name | string | +| `-r`, `--retention` | New duration data will live in bucket | duration | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/help/_index.md b/content/v2.0/reference/cli/influx/help/_index.md index 43f95bf39..d137d13f7 100644 --- a/content/v2.0/reference/cli/influx/help/_index.md +++ b/content/v2.0/reference/cli/influx/help/_index.md @@ -1,6 +1,6 @@ --- -title: Influx help command -description: placeholder +title: influx help – Help command for the influx CLI +description: The 'influx help' command provides help for any command in the `influx` command line interface. menu: v2_0_ref: name: influx help @@ -8,8 +8,7 @@ menu: weight: 1 --- -Help provides help for any command in the application. -Simply type influx help [path to command] for full details. +The `influx help` command provides help for any command in the `influx` command line interface. ## Usage ``` @@ -19,7 +18,7 @@ influx help [command] [flags] ## Flags | Flag | Description | |:---- |:----------- | -| `-h`, `--help` | help for help | +| `-h`, `--help` | Help for help | ## Global Flags | Global flag | Description | Input type | diff --git a/content/v2.0/reference/cli/influx/org/_index.md b/content/v2.0/reference/cli/influx/org/_index.md index 9c666591d..b8ec673f1 100644 --- a/content/v2.0/reference/cli/influx/org/_index.md +++ b/content/v2.0/reference/cli/influx/org/_index.md @@ -1,6 +1,6 @@ --- -title: Influx organization management commands -description: placeholder +title: influx org – Organization management commands +description: The 'influx org' command and its subcommands manage organization information in InfluxDB. menu: v2_0_ref: name: influx org @@ -8,7 +8,7 @@ menu: weight: 1 --- -Organization management commands +The `influx org` command and its subcommands manage organization information in InfluxDB. ## Usage ``` @@ -20,18 +20,18 @@ influx org [command] `org`, `organization` ## Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| create | Create organization | -| delete | Delete organization | -| find | Find organizations | -| members | Organization membership commands | -| update | Update organization | +| Subcommand | Description | +|:---------- |:----------- | +| [create](/v2.0/reference/cli/influx/org/create) | Create organization | +| [delete](/v2.0/reference/cli/influx/org/delete) | Delete organization | +| [find](/v2.0/reference/cli/influx/org/find) | Find organizations | +| [members](/v2.0/reference/cli/influx/org/members) | Organization membership commands | +| [update](/v2.0/reference/cli/influx/org/update) | Update organization | ## Flags -| Flag | Description | -|:---- |:----------- | -| `-h`, `--help` | Help for the org command | +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for the `org` command | ## Global Flags | Global flag | Description | Input type | diff --git a/content/v2.0/reference/cli/influx/org/create.md b/content/v2.0/reference/cli/influx/org/create.md new file mode 100644 index 000000000..8e7700089 --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/create.md @@ -0,0 +1,29 @@ +--- +title: influx org create +description: placeholder +menu: + v2_0_ref: + name: influx org create + parent: influx org + weight: 1 +--- + +Create organization + +## Usage +``` +influx org create [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `create` | | +| `-n`, `--name` | The name of organization that will be created | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/delete.md b/content/v2.0/reference/cli/influx/org/delete.md new file mode 100644 index 000000000..25ab6b322 --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/delete.md @@ -0,0 +1,29 @@ +--- +title: influx org delete +description: placeholder +menu: + v2_0_ref: + name: influx org delete + parent: influx org + weight: 1 +--- + +Delete organization + +## Usage +``` + influx org delete [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `delete` | | +| `-i`, `--id` | The organization ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/find.md b/content/v2.0/reference/cli/influx/org/find.md new file mode 100644 index 000000000..6ab489fd7 --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/find.md @@ -0,0 +1,30 @@ +--- +title: influx org find +description: placeholder +menu: + v2_0_ref: + name: influx org find + parent: influx org + weight: 1 +--- + +Find organizations + +## Usage +``` +influx org find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `find` | | +| `-i`, `--id` | The organization ID | string | +| `-n`, `--name` | The organization name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/members/_index.md b/content/v2.0/reference/cli/influx/org/members/_index.md new file mode 100644 index 000000000..58559e13b --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/members/_index.md @@ -0,0 +1,36 @@ +--- +title: influx org members - Organization membership management commands +description: The 'influx org members' command and its subcommands manage organization members in InfluxDB. +menu: + v2_0_ref: + name: influx org members + parent: influx org + weight: 1 +--- + +The `influx org members` command and its subcommands manage organization members in InfluxDB. + +## Usage +``` +influx org members [flags] +influx org members [command] +``` + +## Subcommands +| Subcommand | Description | +|:---------- |:----------- | +| add | Add organization member | +| list | List organization members | +| remove | Remove organization member | + +## Flags +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for `members` | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/members/add.md b/content/v2.0/reference/cli/influx/org/members/add.md new file mode 100644 index 000000000..87c014dc1 --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/members/add.md @@ -0,0 +1,31 @@ +--- +title: influx org members add +description: placeholder +menu: + v2_0_ref: + name: influx org members add + parent: influx org members + weight: 1 +--- + +Add organization member + +## Usage +``` +influx org members add [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `add` | | +| `-i`, `--id` | The organization ID | string | +| `-o`, `--member` | The member ID | string | +| `-n`, `--name` | The organization name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/members/list.md b/content/v2.0/reference/cli/influx/org/members/list.md new file mode 100644 index 000000000..4cc07bff9 --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/members/list.md @@ -0,0 +1,30 @@ +--- +title: influx org members list +description: placeholder +menu: + v2_0_ref: + name: influx org members list + parent: influx org members + weight: 1 +--- + +List organization members + +## Usage +``` +influx org members list [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `list` | | +| `-i`, `--id` | The organization ID | string | +| `-n`, `--name` | The organization name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/members/remove.md b/content/v2.0/reference/cli/influx/org/members/remove.md new file mode 100644 index 000000000..46b049e0a --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/members/remove.md @@ -0,0 +1,31 @@ +--- +title: influx org members remove +description: placeholder +menu: + v2_0_ref: + name: influx org members remove + parent: influx org members + weight: 1 +--- + +Remove organization member + +## Usage +``` +influx org members remove [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `remove` | | +| `-i`, `--id` | The organization ID | string | +| `-o`, `--member` | The member ID | string | +| `-n`, `--name` | The organization name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/org/update.md b/content/v2.0/reference/cli/influx/org/update.md new file mode 100644 index 000000000..7e466f03d --- /dev/null +++ b/content/v2.0/reference/cli/influx/org/update.md @@ -0,0 +1,30 @@ +--- +title: influx org update +description: placeholder +menu: + v2_0_ref: + name: influx org update + parent: influx org + weight: 1 +--- + +Update organization + +## Usage +``` +influx org update [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `update` | | +| `-i`, `--id` | The organization ID **(Required)** | string | +| `-n`, `--name` | The organization name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/query/_index.md b/content/v2.0/reference/cli/influx/query/_index.md index f9aa500a9..39b573e36 100644 --- a/content/v2.0/reference/cli/influx/query/_index.md +++ b/content/v2.0/reference/cli/influx/query/_index.md @@ -1,6 +1,8 @@ --- -title: Influx query command -description: placeholder +title: influx query – Execute queries from the influx CLI +description: > + The 'influx query' command executes a literal Flux query provided as a string + or a literal Flux query contained in a file by specifying the file prefixed with an '@' sign. menu: v2_0_ref: name: influx query @@ -8,8 +10,8 @@ menu: weight: 1 --- -Execute a literal Flux query provided as a string, -or execute a literal Flux query contained in a file by specifying the file prefixed with an @ sign. +The `influx query` command executes a literal Flux query provided as a string +or a literal Flux query contained in a file by specifying the file prefixed with an `@` sign. ## Usage ``` diff --git a/content/v2.0/reference/cli/influx/repl/_index.md b/content/v2.0/reference/cli/influx/repl/_index.md index 53dfdadc3..7a91b5a46 100644 --- a/content/v2.0/reference/cli/influx/repl/_index.md +++ b/content/v2.0/reference/cli/influx/repl/_index.md @@ -1,6 +1,8 @@ --- -title: Influx repl command -description: placeholder +title: influx repl – Enter an interactive REPL +description: > + The 'influx repl' command opens and interactive read-eval-print-loop (REPL) + from which you can run Flux commands. menu: v2_0_ref: name: influx repl @@ -8,7 +10,8 @@ menu: weight: 1 --- -Interactive REPL (read-eval-print-loop) +The `influx repl` command opens and interactive read-eval-print-loop (REPL) +from which you can run Flux commands. ## Usage ``` @@ -18,7 +21,7 @@ influx repl [flags] ## Flags | Flag | Description | Input type | |:---- |:----------- |:----------:| -| `-h`, `--help` | Help for the repl command | | +| `-h`, `--help` | Help for the `repl` command | | | `-o`, `--org` | The name of the organization | string | | `--org-id` | The ID of organization to query | string | diff --git a/content/v2.0/reference/cli/influx/setup/_index.md b/content/v2.0/reference/cli/influx/setup/_index.md index 69439ff80..b628152e1 100644 --- a/content/v2.0/reference/cli/influx/setup/_index.md +++ b/content/v2.0/reference/cli/influx/setup/_index.md @@ -1,6 +1,8 @@ --- -title: Influx setup command -description: placeholder +title: influx setup – Run the initial Influx DB setup +description: > + The 'influx setup' command walks through the initial InfluxDB setup process, + creating a default user, organization, and bucket. menu: v2_0_ref: name: influx setup @@ -8,7 +10,8 @@ menu: weight: 1 --- -Create default username, password, org, bucket... +The `influx setup` command walks through the initial InfluxDB setup process, +creating a default user, organization, and bucket. ## Usage ``` diff --git a/content/v2.0/reference/cli/influx/task/_index.md b/content/v2.0/reference/cli/influx/task/_index.md index df4db30af..6f6d8b449 100644 --- a/content/v2.0/reference/cli/influx/task/_index.md +++ b/content/v2.0/reference/cli/influx/task/_index.md @@ -1,6 +1,6 @@ --- -title: Influx task management commands -description: placeholder +title: influx task – Task management commands +description: The 'influx task' command and its subcommands manage tasks in InfluxDB. menu: v2_0_ref: name: influx task @@ -8,7 +8,7 @@ menu: weight: 1 --- -Task management commands +The `influx task` command and its subcommands manage tasks in InfluxDB. ### Usage ``` @@ -17,15 +17,15 @@ influx task [command] ``` ### Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| create | Create task | -| delete | Delete task | -| find | Find tasks | -| log | Log related commands | -| retry | retry a run | -| run | Run related commands | -| update | Update task | +| Subcommand | Description | +|:---------- |:----------- | +| [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 | +| [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 | +| [update](/v2.0/reference/cli/influx/task/update) | Update task | ### Flags | Flag | Description | diff --git a/content/v2.0/reference/cli/influx/task/create.md b/content/v2.0/reference/cli/influx/task/create.md new file mode 100644 index 000000000..46bff39fd --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/create.md @@ -0,0 +1,30 @@ +--- +title: influx task create +description: placeholder +menu: + v2_0_ref: + name: influx task create + parent: influx task + weight: 1 +--- + +Create task + +## Usage +``` +influx task create [query literal or @/path/to/query.flux] [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `create` | | +| `--org` | Organization name | string | +| `--org-id` | ID of the organization that owns the task | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/delete.md b/content/v2.0/reference/cli/influx/task/delete.md new file mode 100644 index 000000000..7e325e912 --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/delete.md @@ -0,0 +1,29 @@ +--- +title: influx task delete +description: placeholder +menu: + v2_0_ref: + name: influx task delete + parent: influx task + weight: 1 +--- + +Delete task + +## Usage +``` +influx task delete [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `delete` | | +| `-i`, `--id` | Task id **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/find.md b/content/v2.0/reference/cli/influx/task/find.md new file mode 100644 index 000000000..7430d7b6a --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/find.md @@ -0,0 +1,32 @@ +--- +title: influx task find +description: placeholder +menu: + v2_0_ref: + name: influx task find + parent: influx task + weight: 1 +--- + +Find tasks + +## Usage +``` +influx task find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `find` | | +| `-i`, `--id` | Task ID | string | +| `--limit` | The number of tasks to find (default `100`) | integer | +| `--org-id` | Task organization ID | string | +| `-n`, `--user-id` | Task owner ID | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/log/_index.md b/content/v2.0/reference/cli/influx/task/log/_index.md new file mode 100644 index 000000000..062a77dce --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/log/_index.md @@ -0,0 +1,34 @@ +--- +title: influx task log +description: The 'influx task log' and its subcommand 'find' output log information related related to a task. +menu: + v2_0_ref: + name: influx task log + parent: influx task + weight: 1 +--- + +The `influx task log` command and its subcommand `find` output log information related to a task. + +## Usage +``` +influx task log [flags] +influx task log [command] +``` + +## Subcommands +| Subcommand | Description | +|:---------- |:----------- | +| find | Find logs for task | + +## Flags +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for `log` | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/log/find.md b/content/v2.0/reference/cli/influx/task/log/find.md new file mode 100644 index 000000000..3e49e8565 --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/log/find.md @@ -0,0 +1,31 @@ +--- +title: influx task log find +description: The 'influx task log find' command outputs log information related to a task. +menu: + v2_0_ref: + name: influx task log find + parent: influx task log + weight: 1 +--- + +The `influx task log find` command outputs log information related to a task. + +## Usage +``` +influx task log find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `find` | | +| `--org-id` | Organization ID | string | +| `--run-id` | Run ID | string | +| `--task-id` | Task ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/retry.md b/content/v2.0/reference/cli/influx/task/retry.md new file mode 100644 index 000000000..411e25710 --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/retry.md @@ -0,0 +1,30 @@ +--- +title: influx task retry +description: placeholder +menu: + v2_0_ref: + name: influx task retry + parent: influx task + weight: 1 +--- + +retry a run + +## Usage +``` +influx task retry [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `retry` | | +| `-r`, `--run-id` | Run id **(Required)** | string | +| `-i`, `--task-id` | Task id **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/run/_index.md b/content/v2.0/reference/cli/influx/task/run/_index.md new file mode 100644 index 000000000..57ee36dfc --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/run/_index.md @@ -0,0 +1,36 @@ +--- +title: influx task run +description: > + The 'influx task run' command and its subcommand 'find' output information + related to runs of a task. +menu: + v2_0_ref: + name: influx task run + parent: influx task + weight: 1 +--- + +The `influx task run` command and its subcommand `find` output information related to runs of a task. + +## Usage +``` +influx task run [flags] +influx task run [command] +``` + +## Subcommands +| Subcommand | Description | +|:---------- |:----------- | +| find | Find runs for a task | + +## Flags +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for `run` | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/run/find.md b/content/v2.0/reference/cli/influx/task/run/find.md new file mode 100644 index 000000000..43fce658f --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/run/find.md @@ -0,0 +1,34 @@ +--- +title: influx task run find +description: placeholder +menu: + v2_0_ref: + name: influx task run find + parent: influx task run + weight: 1 +--- + +The `influx task run find` command outputs information related runs of a task. + +## Usage +``` +influx task run find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `--after` | After-time for filtering | string | +| `--before` | Before-time for filtering | string | +| `-h`,`--help` | Help for `find` | | +| `--limit` | Limit the number of results | integer | +| `--org-id` | Organization ID | string | +| `--run-id` | Run ID | string | +| `--task-id` | Task ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/task/update.md b/content/v2.0/reference/cli/influx/task/update.md new file mode 100644 index 000000000..ef53c1095 --- /dev/null +++ b/content/v2.0/reference/cli/influx/task/update.md @@ -0,0 +1,30 @@ +--- +title: influx task update +description: placeholder +menu: + v2_0_ref: + name: influx task update + parent: influx task + weight: 1 +--- + +Update task + +## Usage +``` +influx task update [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `update` | | +| `-i`, `--id` | Task ID **(Required)** | string | +| `--status` | Update task status | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/user/_index.md b/content/v2.0/reference/cli/influx/user/_index.md index ee83e3ca3..c5ef7ed80 100644 --- a/content/v2.0/reference/cli/influx/user/_index.md +++ b/content/v2.0/reference/cli/influx/user/_index.md @@ -1,6 +1,6 @@ --- -title: Influx user management commands -description: placeholder +title: influx user – User management commands +description: The 'influx user' command and its subcommands manage user information in InfluxDB. menu: v2_0_ref: name: influx user @@ -8,7 +8,7 @@ menu: weight: 1 --- -User management commands +The `influx user` command and its subcommands manage user information in InfluxDB. ## Usage ``` @@ -17,12 +17,12 @@ influx user [command] ``` ## Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| create | Create user | -| delete | Delete user | -| find | Find user | -| update | Update user | +| Subcommand | Description | +|:---------- |:----------- | +| [create](/v2.0/reference/cli/influx/user/create) | Create user | +| [delete](/v2.0/reference/cli/influx/user/delete) | Delete user | +| [find](/v2.0/reference/cli/influx/user/find) | Find user | +| [update](/v2.0/reference/cli/influx/user/update) | Update user | ## Flags | Flag | Description | diff --git a/content/v2.0/reference/cli/influx/user/create.md b/content/v2.0/reference/cli/influx/user/create.md new file mode 100644 index 000000000..f1a426c4d --- /dev/null +++ b/content/v2.0/reference/cli/influx/user/create.md @@ -0,0 +1,29 @@ +--- +title: influx user create +description: The 'influx user create' command creates a user in InfluxDB. +menu: + v2_0_ref: + name: influx user create + parent: influx user + weight: 1 +--- + +The `influx user create` command creates a user in InfluxDB. + +## Usage +``` +influx user create [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `create` | | +| `-n`, `--name` | The user name **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/user/delete.md b/content/v2.0/reference/cli/influx/user/delete.md new file mode 100644 index 000000000..d74d4240d --- /dev/null +++ b/content/v2.0/reference/cli/influx/user/delete.md @@ -0,0 +1,29 @@ +--- +title: influx user delete +description: The 'influx user delete' command deletes a specified user. +menu: + v2_0_ref: + name: influx user delete + parent: influx user + weight: 1 +--- + +The `influx user delete` command deletes a specified user. + +## Usage +``` +influx user delete [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `delete` | | +| `-i`, `--id` | The user ID **(Required)** | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/user/find.md b/content/v2.0/reference/cli/influx/user/find.md new file mode 100644 index 000000000..81bb0030f --- /dev/null +++ b/content/v2.0/reference/cli/influx/user/find.md @@ -0,0 +1,30 @@ +--- +title: influx user find +description: The 'influx user find' lists and searches for users in InfluxDB. +menu: + v2_0_ref: + name: influx user find + parent: influx user + weight: 1 +--- + +The `influx user find` command lists and searches for users in InfluxDB. + +## Usage +``` +influx user find [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `find` | | +| `-i`, `--id` | The user ID | string | +| `-n`, `--name` | The user name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/user/update.md b/content/v2.0/reference/cli/influx/user/update.md new file mode 100644 index 000000000..7eef1845f --- /dev/null +++ b/content/v2.0/reference/cli/influx/user/update.md @@ -0,0 +1,31 @@ +--- +title: influx user update +description: > + The 'influx user update' command updates information related to a user such as their user name. +menu: + v2_0_ref: + name: influx user update + parent: influx user + weight: 1 +--- + +The `influx user update` command updates information related to a user such as their user name. + +## Usage +``` +influx user update [flags] +``` + +## Flags +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `update` | | +| `-i`, `--id` | The user ID **(Required)** | string | +| `-n`, `--name` | The user name | string | + +## Global Flags +| Global flag | Description | Input type | +|:----------- |:----------- |:----------:| +| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | +| `--local` | Run commands locally against the filesystem | | +| `-t`, `--token` | API token to be used throughout client calls | string | diff --git a/content/v2.0/reference/cli/influx/write/_index.md b/content/v2.0/reference/cli/influx/write/_index.md index e95f0c6ac..41ed630d5 100644 --- a/content/v2.0/reference/cli/influx/write/_index.md +++ b/content/v2.0/reference/cli/influx/write/_index.md @@ -1,6 +1,8 @@ --- -title: Influx write command -description: placeholder +title: influx write – Write data to InfluxDB using the CLI +description: > + The 'influx write' command writes line protocol to InfluxDB either via a single + line of line protocol, or a via a file containing line protocol. menu: v2_0_ref: name: influx write @@ -8,8 +10,8 @@ menu: weight: 1 --- -Write a single line of line protocol to InfluxDB, -or add an entire file specified with an @ prefix. +The `influx write` writes a single line of line protocol to InfluxDB, +or adds an entire file specified with an `@` prefix. ## Usage ```