Back to Influxdb

influxd-ctl CLI

content/enterprise_influxdb/v1/tools/influxd-ctl/_index.md

latest5.0 KB
Original Source

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

CommandDescription
add-dataAdd a data node
add-metaAdd a meta node
backupBack up a cluster
copy-shardCopy a shard between data nodes
copy-shard-statusShow all active copy shard tasks
entropyManage entropy in a cluster
joinJoin a meta or data node
kill-copy-shardAbort an in-progress shard copy
ldapManage LDAP in a cluster
leaveRemove a meta or data node
remove-dataRemove a data node
remove-metaRemove a meta node
remove-shardRemove a shard from a data node
restoreRestore a backup of a cluster
showShow cluster members
show-shardsShows shards in a cluster
node-labelsManage node labels
tokenGenerates a signed JWT token
truncate-shardsTruncate current shards
update-dataUpdate a data node

Global flags {#influxd-ctl-global-flags}

FlagDescription
-auth-typeAuthentication type to use (none default, basic, jwt)
-bindMeta node HTTP bind address (default is localhost:8091)
-bind-tlsUse TLS
-configConfiguration file path
-kSkip certificate verification (ignored without -bind-tls)
-pwdPassword for basic authentication (ignored without -auth-type basic)
-secretJWT shared secret (ignored without -auth-type jwt)
-userUsername (ignored without -auth-type basic or jwt)

Examples

Bind to a remote meta node

sh
influxd-ctl -bind meta-node-02:8091

Authenticate with JWT

sh
influxd-ctl -auth-type jwt -secret oatclusters

Authenticate with basic authentication

sh
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:

bash
Error: unable to parse authentication credentials.

If authentication is enabled and the influxd-ctl command provides the incorrect username or password, the system returns:

bash
Error: authorization failed.

{{% /expand %}} {{< /expand-wrapper >}}