mirror of https://github.com/hashicorp/consul
68 lines
1.7 KiB
Plaintext
68 lines
1.7 KiB
Plaintext
|
---
|
||
|
|
layout: "docs"
|
||
|
|
page_title: "Commands: Operator Autopilot"
|
||
|
|
sidebar_current: "docs-commands-operator-autopilot"
|
||
|
|
description: >
|
||
|
|
The operator autopilot subcommand is used to view and modify Consul's Autopilot configuration.
|
||
|
|
---
|
||
|
|
|
||
|
|
# Consul Operator Autopilot
|
||
|
|
|
||
|
|
Command: `consul operator autopilot`
|
||
|
|
|
||
|
|
The Autopilot operator command is used to interact with Consul's Autopilot subsystem. The
|
||
|
|
command can be used to view or modify the current Autopilot configuration.
|
||
|
|
|
||
|
|
```text
|
||
|
|
Usage: consul operator autopilot <subcommand> [options]
|
||
|
|
|
||
|
|
The Autopilot operator command is used to interact with Consul's Autopilot
|
||
|
|
subsystem. The command can be used to view or modify the current configuration.
|
||
|
|
|
||
|
|
Subcommands:
|
||
|
|
|
||
|
|
get-config Display the current Autopilot configuration
|
||
|
|
set-config Modify the current Autopilot configuration
|
||
|
|
```
|
||
|
|
|
||
|
|
## get-config
|
||
|
|
|
||
|
|
This command displays the current Raft peer configuration.
|
||
|
|
|
||
|
|
Usage: `consul operator autopilot get-config [options]`
|
||
|
|
|
||
|
|
#### API Options
|
||
|
|
|
||
|
|
<%= partial "docs/commands/http_api_options_client" %>
|
||
|
|
<%= partial "docs/commands/http_api_options_server" %>
|
||
|
|
|
||
|
|
The output looks like this:
|
||
|
|
|
||
|
|
```
|
||
|
|
DeadServerCleanup = true
|
||
|
|
```
|
||
|
|
|
||
|
|
## set-config
|
||
|
|
|
||
|
|
Modifies the current Autopilot configuration.
|
||
|
|
|
||
|
|
Usage: `consul operator autopilot set-config [options]`
|
||
|
|
|
||
|
|
#### API Options
|
||
|
|
|
||
|
|
<%= partial "docs/commands/http_api_options_client" %>
|
||
|
|
<%= partial "docs/commands/http_api_options_server" %>
|
||
|
|
|
||
|
|
#### Command Options
|
||
|
|
|
||
|
|
* `-dead-server-cleanup` - Specifies whether to enable automatic removal of dead servers
|
||
|
|
upon the successful joining of new servers to the cluster. Must be one of `[true|false]`.
|
||
|
|
|
||
|
|
The output looks like this:
|
||
|
|
|
||
|
|
```
|
||
|
|
Configuration updated!
|
||
|
|
```
|
||
|
|
|
||
|
|
The return code will indicate success or failure.
|