5.3 KiB
5.3 KiB
| title | description | menu | aliases | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| influxd-ctl CLI | Use the `influxd-ctl` CLI to manage your InfluxDB Enterprise cluster. |
|
|
The influxd-ctl CLI provides commands for managing your InfluxDB Enterprise cluster.
The influxd-ctl utility is available on all InfluxDB Enterprise
meta nodes.
Usage
influxd-ctl [global-flags] <command> [command-flags] [arguments]
Commands
| Command | Description |
|---|---|
| add-data | Add a data node |
| add-meta | Add a meta node |
| backup | Back up a cluster |
| copy-shard | Copy a shard between data nodes |
| copy-shard-status | Show all active copy shard tasks |
| entropy | Manage entropy in a cluster |
| join | Join a meta or data node |
| kill-copy-shard | Abort an in-progress shard copy |
| ldap | Manage LDAP in a cluster |
| leave | Remove a meta or data node |
| remove-data | Remove a data node |
| remove-meta | Remove a meta node |
| remove-shard | Remove a shard from a data node |
| restore | Restore a backup of a cluster |
| show | Show cluster members |
| show-shards | Shows shards in a cluster |
| node-labels | Manage node labels |
| token | Generates a signed JWT token |
| truncate-shards | Truncate current shards |
| update-data | Update a data node |
Global flags
| Flag | Description |
|---|---|
-auth-type |
Authentication type to use (none default, basic, jwt) |
-bind |
Meta node HTTP bind address (default is localhost:8091) |
-bind-tls |
Use TLS |
-config |
Configuration file path |
-k |
Skip certificate verification (ignored without -bind-tls) |
-pwd |
Password for basic authentication (ignored without -auth-type basic) |
-secret |
JWT shared secret (ignored without -auth-type jwt) |
-user |
Username (ignored without -auth-type basic or jwt) |
Examples
Bind to a remote meta node
influxd-ctl -bind meta-node-02:8091
Authenticate with JWT
influxd-ctl -auth-type jwt -secret oatclusters
Authenticate with basic authentication
influxd-ctl -auth-type basic -user admin -pwd passw0rd
{{< expand-wrapper >}}
{{% expand "Troubleshoot influxd-ctl authentication" %}}
If authentication is enabled in the cluster's
meta node configuration files
and data node configuration files
and the influxd-ctl command does not include authentication details, the system returns:
Error: unable to parse authentication credentials.
If authentication is enabled and the influxd-ctl command provides the incorrect
username or password, the system returns:
Error: authorization failed.
{{% /expand %}} {{< /expand-wrapper >}}