Documentation

influxd-ctl CLI

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

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

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

Troubleshoot influxd-ctl authentication


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: