added influx dashboards command, deprecated influx repl, resovles #1270

pull/1274/head
Scott Anderson 2020-08-06 12:25:47 -06:00
parent 61ef334676
commit e6c937b516
3 changed files with 51 additions and 0 deletions

View File

@ -51,6 +51,7 @@ retrieving authentication tokens._
| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands |
| [completion](/v2.0/reference/cli/influx/completion) | Generate completion scripts |
| [config](/v2.0/reference/cli/influx/config) | Configuration management commands |
| [dashboards](/v2.0/reference/cli/influx/dashboards) | List dashboards |
| [delete](/v2.0/reference/cli/influx/delete) | Delete points from InfluxDB |
| [export](/v2.0/reference/cli/influx/export) | Export resources as a template |
| [help](/v2.0/reference/cli/influx/help) | Help about any command |
@ -62,6 +63,7 @@ retrieving authentication tokens._
| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. |
| [stacks](/v2.0/reference/cli/influx/stacks) | Manage InfluxDB stacks |
| [task](/v2.0/reference/cli/influx/task) | Task management commands |
| [telegrafs](/v2.0/reference/cli/influx/telegrafs) | Telegraf configuration management commands |
| [template](/v2.0/reference/cli/influx/template) | Summarize and validate an InfluxDB template |
| [transpile](/v2.0/reference/cli/influx/transpile) | Manually transpile an InfluxQL query to Flux |
| [user](/v2.0/reference/cli/influx/user) | User management commands |

View File

@ -0,0 +1,42 @@
---
title: influx dashboards
description: >
The `influx dashboards` command lists existing InfluxDB dashboards.
menu:
v2_0_ref:
name: influx dashboards
parent: influx
weight: 101
v2.0/tags: [telegraf]
---
The `influx dashboards` command lists existing InfluxDB dashboards.
## Usage
```sh
influx dashboards [flags]
influx dashboards [command]
```
## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `dashboards` command | | |
| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `$INFLUX_HOST` |
| `-i` | `--id` | Dashboard ID to retrieve | string | |
| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
## Examples
```sh
# List all known dashboards
influx dashboards
# List all known dashboards matching IDs
influx dashboards -i $ID1 -i $ID2
```

View File

@ -11,6 +11,13 @@ weight: 101
v2.0/tags: [query]
---
{{% warn %}}
#### Removed in InfluxDB 2.0 beta-16
The `influx repl` command was removed in **InfluxDB 2.0 beta-16**.
To use the Flux REPL, build the REPL from source.
For more information, see the [Flux GitHub repository](https://github.com/influxdata/flux/#readme).
{{% /warn %}}
The `influx repl` command opens an interactive read-eval-print-loop (REPL)
from which you can run Flux commands.