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

resolved merge conflicts

pull/22/head
Scott Anderson 2019-01-22 12:59:43 -07:00
parent d6c4cecbf8 99478bd6a2
commit 379e78a00e
43 changed files with 1345 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
assets/styles/layouts/_layout-article.scss
View File

@ -139,6 +139,7 @@
code,pre {
background: $article-code-bg;
font-family: 'Inconsolata', monospace;
color: $article-code;
}
p,li,table,h2,h3,h4,h5,h6 {

10
content/v2.0/reference/cli/_index.md
View File

@ -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)}}

43
content/v2.0/reference/cli/influx/_index.md Normal file
View File

@ -0,0 +1,43 @@
---
title: influx CLI
seotitle: "'influx' command line client"
description: >
The 'influx' CLI includes commands to manage many aspects of InfluxDB,
including buckets, organizations, users, tasks, etc.
menu:
v2_0_ref:
name: influx
parent: Command line tools
wieght: 1
---
The `influx` CLI includes commands to manage many aspects of InfluxDB,
including buckets, organizations, users, tasks, etc.
## Usage
```
influx [flags]
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, 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 |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for the influx command | |
| `--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 |

41
content/v2.0/reference/cli/influx/auth/_index.md Normal file
View File

@ -0,0 +1,41 @@
---
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
parent: influx
weight: 1
---
The `influx auth` command and its subcommands manage authorizations in InfluxDB.
## Usage
```
influx auth [flags]
influx auth [command]
```
#### Aliases
`auth`, `authorization`
## Subcommands
| 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 |
## 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 |

29
content/v2.0/reference/cli/influx/auth/active.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx auth active
description: The 'influx auth active' command activates an authorization.
menu:
v2_0_ref:
name: influx auth active
parent: influx auth
weight: 1
---
The `influx auth active` command activates an authorization in InfluxDB.
## 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 |

44
content/v2.0/reference/cli/influx/auth/create.md Normal file
View File

@ -0,0 +1,44 @@
---
title: influx auth create
description: The 'influx auth create' creates an authorization in InfluxDB.
menu:
v2_0_ref:
name: influx auth create
parent: influx auth
weight: 1
---
The `influx auth create` creates an authorization in InfluxDB.
## 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 |

29
content/v2.0/reference/cli/influx/auth/delete.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx auth delete
description: The 'influx auth delete' command deletes an authorization in InfluxDB.
menu:
v2_0_ref:
name: influx auth delete
parent: influx auth
weight: 1
---
The `influx auth delete` command deletes an authorization in InfluxDB.
## 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 |

31
content/v2.0/reference/cli/influx/auth/find.md Normal file
View File

@ -0,0 +1,31 @@
---
title: influx auth find
description: The 'influx auth find' command lists and searches authorizations in InfluxDB.
menu:
v2_0_ref:
name: influx auth find
parent: influx auth
weight: 1
---
The `influx auth find` command lists and searches authorizations in InfluxDB.
## 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 |

29
content/v2.0/reference/cli/influx/auth/inactive.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx auth inactive
description: The 'influx auth inactive' inactivates an authorization in InfluxDB.
menu:
v2_0_ref:
name: influx auth inactive
parent: influx auth
weight: 1
---
The `influx auth inactive` inactivates an authorization in InfluxDB.
## 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 |

37
content/v2.0/reference/cli/influx/bucket/_index.md Normal file
View File

@ -0,0 +1,37 @@
---
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
parent: influx
weight: 1
---
The `influx bucket` command and its subcommands manage buckets in InfluxDB.
## Usage
```
influx bucket [flags]
influx bucket [command]
```
## Subcommands
| 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 |
## 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 |

32
content/v2.0/reference/cli/influx/bucket/create.md Normal file
View File

@ -0,0 +1,32 @@
---
title: influx bucket create
description: The 'influx bucket create' command creates a new bucket in InfluxDB.
menu:
v2_0_ref:
name: influx bucket create
parent: influx bucket
weight: 1
---
The `influx bucket create` command creates a new bucket in InfluxDB.
## 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 |

29
content/v2.0/reference/cli/influx/bucket/delete.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx bucket delete
description: The 'influx bucket delete' command deletes a bucket from InfluxDB and all the data it contains.
menu:
v2_0_ref:
name: influx bucket delete
parent: influx bucket
weight: 1
---
The `influx bucket delete` command deletes a bucket from InfluxDB and all the data it contains.
## 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 |

32
content/v2.0/reference/cli/influx/bucket/find.md Normal file
View File

@ -0,0 +1,32 @@
---
title: influx bucket find
description: The 'influx bucket find' command lists and searches for buckets in InfluxDB.
menu:
v2_0_ref:
name: influx bucket find
parent: influx bucket
weight: 1
---
The `influx bucket find` command lists and searches for buckets in InfluxDB.
## 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 |

31
content/v2.0/reference/cli/influx/bucket/update.md Normal file
View File

@ -0,0 +1,31 @@
---
title: influx bucket update
description: The 'influx bucket update' command updates information associated with buckets in InfluxDB.
menu:
v2_0_ref:
name: influx bucket update
parent: influx bucket
weight: 1
---
The `influx bucket update` command updates information associated with buckets in InfluxDB.
## 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 |

28
content/v2.0/reference/cli/influx/help/_index.md Normal file
View File

@ -0,0 +1,28 @@
---
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
parent: influx
weight: 1
---
The `influx help` command provides help for any command in the `influx` command line interface.
## Usage
```
influx help [command] [flags]
```
## Flags
| Flag | Description |
|:---- |:----------- |
| `-h`, `--help` | Help for help |
## 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 |

41
content/v2.0/reference/cli/influx/org/_index.md Normal file
View File

@ -0,0 +1,41 @@
---
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
parent: influx
weight: 1
---
The `influx org` command and its subcommands manage organization information in InfluxDB.
## Usage
```
influx org [flags]
influx org [command]
```
#### Aliases
`org`, `organization`
## Subcommands
| 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 |
## 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 |

29
content/v2.0/reference/cli/influx/org/create.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx org create
description: The 'influx org create' creates a new organization in InfluxDB.
menu:
v2_0_ref:
name: influx org create
parent: influx org
weight: 1
---
The `influx org create` creates a new organization in InfluxDB.
## 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 |

29
content/v2.0/reference/cli/influx/org/delete.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx org delete
description: The 'influx org delete' command deletes an organization in InfluxDB.
menu:
v2_0_ref:
name: influx org delete
parent: influx org
weight: 1
---
The `influx org delete` command deletes an organization in InfluxDB.
## 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 |

30
content/v2.0/reference/cli/influx/org/find.md Normal file
View File

@ -0,0 +1,30 @@
---
title: influx org find
description: The 'influx org find' lists and searches for organizations in InfluxDB.
menu:
v2_0_ref:
name: influx org find
parent: influx org
weight: 1
---
The `influx org find` lists and searches for organizations in InfluxDB.
## 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 |

36
content/v2.0/reference/cli/influx/org/members/_index.md Normal file
View File

@ -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 |

31
content/v2.0/reference/cli/influx/org/members/add.md Normal file
View File

@ -0,0 +1,31 @@
---
title: influx org members add
description: The 'influx org members add' command adds a new member to an organization in InfluxDB.
menu:
v2_0_ref:
name: influx org members add
parent: influx org members
weight: 1
---
The `influx org members add` command adds a new member to an organization in InfluxDB.
## 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 |

30
content/v2.0/reference/cli/influx/org/members/list.md Normal file
View File

@ -0,0 +1,30 @@
---
title: influx org members list
description: The 'influx org members list' command lists members within an organization in InfluxDB.
menu:
v2_0_ref:
name: influx org members list
parent: influx org members
weight: 1
---
The `influx org members list` command lists members within an organization in InfluxDB.
## 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 |

31
content/v2.0/reference/cli/influx/org/members/remove.md Normal file
View File

@ -0,0 +1,31 @@
---
title: influx org members remove
description: The 'influx org members remove' command removes a member from an organization in InfluxDB.
menu:
v2_0_ref:
name: influx org members remove
parent: influx org members
weight: 1
---
The `influx org members remove` command removes a member from an organization in InfluxDB.
## 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 |

30
content/v2.0/reference/cli/influx/org/update.md Normal file
View File

@ -0,0 +1,30 @@
---
title: influx org update
description: The 'influx org update' command updates information related to organizations in InfluxDB.
menu:
v2_0_ref:
name: influx org update
parent: influx org
weight: 1
---
The `influx org update` command updates information related to organizations in InfluxDB.
## 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 |

32
content/v2.0/reference/cli/influx/query/_index.md Normal file
View File

@ -0,0 +1,32 @@
---
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
parent: influx
weight: 1
---
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
```
influx query [query literal or @/path/to/query.flux] [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for the query command | |
| `--org-id` | The 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 |

33
content/v2.0/reference/cli/influx/repl/_index.md Normal file
View File

@ -0,0 +1,33 @@
---
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
parent: influx
weight: 1
---
The `influx repl` command opens and interactive read-eval-print-loop (REPL)
from which you can run Flux commands.
## Usage
```
influx repl [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for the `repl` command | |
| `-o`, `--org` | The name of the organization | string |
| `--org-id` | The ID of organization to query | 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 |

31
content/v2.0/reference/cli/influx/setup/_index.md Normal file
View File

@ -0,0 +1,31 @@
---
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
parent: influx
weight: 1
---
The `influx setup` command walks through the initial InfluxDB setup process,
creating a default user, organization, and bucket.
## Usage
```
influx setup [flags]
```
## Flags
| Flag | Description |
|:---- |:----------- |
| `-h`, `--help` | Help for the `setup` command |
## 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 |

40
content/v2.0/reference/cli/influx/task/_index.md Normal file
View File

@ -0,0 +1,40 @@
---
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
parent: influx
weight: 1
---
The `influx task` command and its subcommands manage tasks in InfluxDB.
### Usage
```
influx task [flags]
influx task [command]
```
### Subcommands
| 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 |
|:---- |:----------- |
| `-h`, `--help` | Help for the `task` command |
### 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 |

30
content/v2.0/reference/cli/influx/task/create.md Normal file
View File

@ -0,0 +1,30 @@
---
title: influx task create
description: The 'influx task create' command creates a new task in InfluxDB.
menu:
v2_0_ref:
name: influx task create
parent: influx task
weight: 1
---
The `influx task create` command creates a new task in InfluxDB.
## 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 |

29
content/v2.0/reference/cli/influx/task/delete.md Normal file
View File

@ -0,0 +1,29 @@
---
title: influx task delete
description: The 'influx task delete' command deletes a task in InfluxDB.
menu:
v2_0_ref:
name: influx task delete
parent: influx task
weight: 1
---
The `influx task delete` command deletes a task in InfluxDB.
## 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 |

32
content/v2.0/reference/cli/influx/task/find.md Normal file
View File

@ -0,0 +1,32 @@
---
title: influx task find
description: The 'influx task find' command lists and searches for tasks in InfluxDB.
menu:
v2_0_ref:
name: influx task find
parent: influx task
weight: 1
---
The `influx task find` command lists and searches for tasks in InfluxDB.
## 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 |

34
content/v2.0/reference/cli/influx/task/log/_index.md Normal file
View File

@ -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 |

31
content/v2.0/reference/cli/influx/task/log/find.md Normal file
View File

@ -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 |

30
content/v2.0/reference/cli/influx/task/retry.md Normal file
View File

@ -0,0 +1,30 @@
---
title: influx task retry
description: The 'influx task retry' command retries to run a task in InfluxDB.
menu:
v2_0_ref:
name: influx task retry
parent: influx task
weight: 1
---
The `influx task retry` command retries to run a task in InfluxDB.
## 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 |

36
content/v2.0/reference/cli/influx/task/run/_index.md Normal file
View File

@ -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 |

34
content/v2.0/reference/cli/influx/task/run/find.md Normal file
View File

@ -0,0 +1,34 @@
---
title: influx task run find
description: The 'influx task run find' command outputs information related to runs of a task.
menu:
v2_0_ref:
name: influx task run find
parent: influx task run
weight: 1
---
The `influx task run find` command outputs information related to 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 |

30
content/v2.0/reference/cli/influx/task/update.md Normal file
View File

@ -0,0 +1,30 @@
---
title: influx task update
description: The 'influx task update' command updates information related to tasks in InfluxDB.
menu:
v2_0_ref:
name: influx task update
parent: influx task
weight: 1
---
The `influx task update` command updates information related to tasks in InfluxDB.
## 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 |

37
content/v2.0/reference/cli/influx/user/_index.md Normal file
View File

@ -0,0 +1,37 @@
---
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
parent: influx
weight: 1
---
The `influx user` command and its subcommands manage user information in InfluxDB.
## Usage
```
influx user [flags]
influx user [command]
```
## Subcommands
| 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 |
|:---- |:----------- |
| `-h`, `--help` | Help for the `user` command |
## 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 |

29
content/v2.0/reference/cli/influx/user/create.md Normal file
View File

@ -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 new 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 |

29
content/v2.0/reference/cli/influx/user/delete.md Normal file
View File

@ -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 in InfluxDB.
## 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 |

30
content/v2.0/reference/cli/influx/user/find.md Normal file
View File

@ -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 |

31
content/v2.0/reference/cli/influx/user/update.md Normal file
View File

@ -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 in InfluxDB.
## 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 |

36
content/v2.0/reference/cli/influx/write/_index.md Normal file
View File

@ -0,0 +1,36 @@
---
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
parent: influx
weight: 1
---
The `influx write` writes a single line of line protocol to InfluxDB,
or adds an entire file specified with an `@` prefix.
## Usage
```
influx write [line protocol or @/path/to/points.txt] [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-b`, `--bucket` | The name of destination bucket | string |
| `--bucket-id` | The ID of destination bucket | string |
| `-h`, `--help` | Help for the write command | |
| `-o`, `--org` | The name of the organization that owns the bucket | string |
| `--org-id` | The ID of the organization that owns the bucket | string |
| `-p`, `--precision` | Precision of the timestamps of the lines (default `ns`) | 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 |