e5d84ad45a
* Refactor docs links to learn * Apply suggestions from code review Co-authored-by: Derek Strickland <1111455+DerekStrickland@users.noreply.github.com> Co-authored-by: Derek Strickland <1111455+DerekStrickland@users.noreply.github.com>
49 lines
1.7 KiB
Plaintext
49 lines
1.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'Commands: Operator'
|
|
sidebar_title: operator
|
|
description: |
|
|
The operator command provides cluster-level tools for Consul operators.
|
|
---
|
|
|
|
# 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. Review the
|
|
[ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more information.
|
|
|
|
Review the [Outage Recovery](https://learn.hashicorp.com/tutorials/consul/recovery-outage) tutorial for some examples of how
|
|
this command is used. For an API to perform these operations programmatically,
|
|
please check the documentation for the [Operator](/api/operator)
|
|
endpoint.
|
|
|
|
## Usage
|
|
|
|
```text
|
|
Usage: consul operator <subcommand> [options]
|
|
|
|
# ...
|
|
|
|
Subcommands:
|
|
|
|
area Provides tools for working with network areas (Enterprise-only)
|
|
autopilot Provides tools for modifying Autopilot configuration
|
|
raft Provides cluster-level tools for Consul operators
|
|
```
|
|
|
|
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:
|
|
|
|
- [area](/docs/commands/operator/area) <EnterpriseAlert inline />
|
|
- [autopilot](/docs/commands/operator/autopilot)
|
|
- [raft](/docs/commands/operator/raft)
|