github.com/ncodes/nomad@v0.5.7-0.20170403112158-97adf4a74fb3/website/source/docs/commands/operator-index.html.md.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 Nomad operators.
     7  ---
     8  
     9  # Nomad Operator
    10   
    11  Command: `nomad operator`
    12  
    13  The `operator` command provides cluster-level tools for Nomad operators, such
    14  as interacting with the Raft subsystem. This was added in Nomad 0.5.5.
    15  
    16  ~> Use this command with extreme caution, as improper use could lead to a Nomad
    17  outage and even loss of data.
    18  
    19  See the [Outage Recovery](/guides/outage.html) guide for some examples of how
    20  this command is used. For an API to perform these operations programatically,
    21  please see the documentation for the [Operator](/guides/outage.html)
    22  endpoint.
    23  
    24  ## Usage
    25  
    26  Usage: `nomad operator <subcommand> <subcommand> [options]`
    27  
    28  Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
    29  The following subcommands are available:
    30  
    31  * [`raft list-peers`][list] - Display the current Raft peer configuration
    32  * [`raft remove-peer`][remove] - Remove a Nomad server from the Raft configuration
    33  
    34  [list]: /docs/commands/operator-raft-list-peers.html "Raft List Peers command"
    35  [remove]: /docs/commands/operator-raft-remove-peer.html "Raft Remove Peer command"