influx stacks
- influx CLI 2.0.1+
- InfluxDB 2.0.1+
This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.
The influx stacks
command and its subcommands list and manage InfluxDB stacks and associated resources.
Usage
influx stacks [flags]
influx stacks [command]
Subcommands
Subcommand | Description |
---|---|
init | Initialize a stack |
remove | Remove a stack |
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-c | —active-config | CLI configuration to use for command | string | |
—configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs ) | string | INFLUX_CONFIGS_PATH | |
-h | —help | Help for the stacks command | ||
—hide-headers | Hide table headers (default false ) | INFLUX_HIDE_HEADERS | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
—http-debug | Inspect communication with InfluxDB servers. | string | ||
—json | Output data as JSON (default false ) | INFLUX_OUTPUT_JSON | ||
-o | —org | Organization name (mutually exclusive with —org-id ) | string | INFLUX_ORG |
—org-id | Organization ID (mutually exclusive with —org ) | string | INFLUX_ORG_ID | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
—stack-id | Stack IDs to filter by | stringArray | ||
—stack-name | Stack names to filter by | stringArray | ||
-t | —token | API token | string | INFLUX_TOKEN |
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST
, INFLUX_ORG
, and INFLUX_TOKEN
). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host
: InfluxDB host-o, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token- Filter stacks by name
- Filter stacks by ID
List all stacks
influx stacks
Filter stacks by name
influx stacks \
--stack-name stack1 \
--stack-name stack2
Filter stacks by ID
influx stacks \
--stack-id 0Xx0oox00XXoxxoo1 \
--stack-id 0Xx0oox00XXoxxoo2
Related
- InfluxDB stacks
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions