Consul
Consul Operator
Command: consul operator
The operator command provides cluster-level tools for Consul operators, such
as interacting with the Raft subsystem. This was added in Consul 0.7.
Use this command with extreme caution, as improper use could lead to a Consul outage and even loss of data.
If ACLs are enabled then a token with operator privileges may be required in order to use this command. Requests are forwarded internally to the leader if required, so this can be run from any Consul node in a cluster. See the ACL Guide for more information.
See the Disaster recovery for Consul clusters guide for some examples of how this command is used. For an API to perform these operations programmatically, please see the documentation for the Operator endpoint.
Usage
Usage: consul operator <subcommand> [options]
Provides cluster-level tools for Consul operators, such as interacting with
the Raft subsystem. NOTE: Use this command with extreme caution, as improper
use could lead to a Consul outage and even loss of data.
If ACLs are enabled then a token with operator privileges may be required in
order to use this command. Requests are forwarded internally to the leader
if required, so this can be run from any Consul node in a cluster.
Run consul operator <subcommand> with no arguments for help on that
subcommand.
Subcommands:
area Provides tools for working with network areas
audit Interact with the audit logging subsystem
autopilot Provides tools for modifying Autopilot configuration
raft Provides cluster-level tools for Consul operators
usage Provides cluster-level usage information
utilization Generate a Consul utilization bundle for license reporting
For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar or one of the links below: