github.com/outbrain/consul@v1.4.5/website/source/docs/commands/operator.html.markdown.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: Operator"
     4  sidebar_current: "docs-commands-operator"
     5  description: >
     6    The operator command provides cluster-level tools for Consul operators.
     7  ---
     8  
     9  # Consul Operator
    10  
    11  Command: `consul operator`
    12  
    13  The `operator` command provides cluster-level tools for Consul operators, such
    14  as interacting with the Raft subsystem. This was added in Consul 0.7.
    15  
    16  ~> Use this command with extreme caution, as improper use could lead to a Consul
    17     outage and even loss of data.
    18  
    19  If ACLs are enabled then a token with operator privileges may be required in
    20  order to use this command. Requests are forwarded internally to the leader
    21  if required, so this can be run from any Consul node in a cluster. See the
    22  [ACL Guide](/docs/guides/acl.html#operator) for more information.
    23  
    24  See the [Outage Recovery](/docs/guides/outage.html) guide for some examples of how
    25  this command is used. For an API to perform these operations programmatically,
    26  please see the documentation for the [Operator](/api/operator.html)
    27  endpoint.
    28  
    29  ## Usage
    30  
    31  ```text
    32  Usage: consul operator <subcommand> [options]
    33  
    34    # ...
    35  
    36  Subcommands:
    37  
    38      area         Provides tools for working with network areas (Enterprise-only)
    39      autopilot    Provides tools for modifying Autopilot configuration
    40      raft         Provides cluster-level tools for Consul operators
    41  ```
    42  
    43  For more information, examples, and usage about a subcommand, click on the name
    44  of the subcommand in the sidebar or one of the links below:
    45  
    46  - [area] (/docs/commands/operator/area.html)
    47  - [autopilot] (/docs/commands/operator/autopilot.html)
    48  - [raft] (/docs/commands/operator/raft.html)