github.com/sl1pm4t/consul@v1.4.5-0.20190325224627-74c31c540f9c/website/source/docs/commands/operator/autopilot.html.markdown.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: Operator Autopilot"
     4  sidebar_current: "docs-commands-operator-autopilot"
     5  description: >
     6    The operator autopilot subcommand is used to view and modify Consul's Autopilot configuration.
     7  ---
     8  
     9  # Consul Operator Autopilot
    10  
    11  Command: `consul operator autopilot`
    12  
    13  The Autopilot operator command is used to interact with Consul's Autopilot subsystem. The
    14  command can be used to view or modify the current Autopilot configuration. See the
    15  [Autopilot Guide](/docs/guides/autopilot.html) for more information about Autopilot.
    16  
    17  ```text
    18  Usage: consul operator autopilot <subcommand> [options]
    19  
    20  The Autopilot operator command is used to interact with Consul's Autopilot
    21  subsystem. The command can be used to view or modify the current configuration.
    22  
    23  Subcommands:
    24  
    25      get-config    Display the current Autopilot configuration
    26      set-config    Modify the current Autopilot configuration
    27  ```
    28  
    29  ## get-config
    30  
    31  This command displays the current Raft peer configuration.
    32  
    33  Usage: `consul operator autopilot get-config [options]`
    34  
    35  #### API Options
    36  
    37  <%= partial "docs/commands/http_api_options_client" %>
    38  <%= partial "docs/commands/http_api_options_server" %>
    39  
    40  The output looks like this:
    41  
    42  ```
    43  CleanupDeadServers = true
    44  LastContactThreshold = 200ms
    45  MaxTrailingLogs = 250
    46  ServerStabilizationTime = 10s
    47  RedundancyZoneTag = ""
    48  DisableUpgradeMigration = false
    49  UpgradeMigrationTag = ""
    50  ```
    51  
    52  ## set-config
    53  
    54  Modifies the current Autopilot configuration.
    55  
    56  Usage: `consul operator autopilot set-config [options]`
    57  
    58  #### API Options
    59  
    60  <%= partial "docs/commands/http_api_options_client" %>
    61  <%= partial "docs/commands/http_api_options_server" %>
    62  
    63  #### Command Options
    64  
    65  * `-cleanup-dead-servers` - Specifies whether to enable automatic removal of dead servers
    66  upon the successful joining of new servers to the cluster. Must be one of `[true|false]`.
    67  
    68  * `-last-contact-threshold` - Controls the maximum amount of time a server can go without contact
    69  from the leader before being considered unhealthy. Must be a duration value such as `200ms`.
    70  
    71  * `-max-trailing-logs` - Controls the maximum number of log entries that a server can trail
    72  the leader by before being considered unhealthy.
    73  
    74  * `-server-stabilization-time` - Controls the minimum amount of time a server must be stable in
    75  the 'healthy' state before being added to the cluster. Only takes effect if all servers are
    76  running Raft protocol version 3 or higher. Must be a duration value such as `10s`.
    77  
    78  * `-disable-upgrade-migration` - (Enterprise-only) Controls whether Consul will avoid promoting
    79  new servers until it can perform a migration. Must be one of `[true|false]`.
    80  
    81  * `-redundancy-zone-tag`- (Enterprise-only) Controls the [`-node-meta`](/docs/agent/options.html#_node_meta)
    82  key name used for separating servers into different redundancy zones.
    83  
    84  * `-upgrade-version-tag` - (Enterprise-only) Controls the [`-node-meta`](/docs/agent/options.html#_node_meta)
    85  tag to use for version info when performing upgrade migrations. If left blank, the Consul version will be used.
    86  
    87  The output looks like this:
    88  
    89  ```
    90  Configuration updated!
    91  ```
    92  
    93  The return code will indicate success or failure.