github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/docs/commands/operator/index.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: operator'
     4  sidebar_title: operator
     5  description: |
     6    The operator command provides cluster-level tools for Nomad operators.
     7  ---
     8  
     9  # Command: operator
    10  
    11  The `operator` command provides cluster-level tools for Nomad operators, such
    12  as interacting with the Raft subsystem. This was added in Nomad 0.5.5.
    13  
    14  ~> Use this command with extreme caution, as improper use could lead to a Nomad
    15  outage and even loss of data.
    16  
    17  See the [Outage Recovery guide] guide for some examples of how this command is
    18  used. For an API to perform these operations programmatically, please see the
    19  documentation for the [Operator] endpoint.
    20  
    21  ## Usage
    22  
    23  Usage: `nomad operator <subcommand> <subcommand> [options]`
    24  
    25  Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
    26  The following subcommands are available:
    27  
    28  - [`operator autopilot get-config`][get-config] - Display the current Autopilot
    29    configuration
    30  
    31  - [`operator autopilot set-config`][set-config] - Modify the current Autopilot
    32    configuration
    33  
    34  - [`operator debug`][debug] - Build an archive of debug data
    35  
    36  - [`operator keygen`][keygen] - Generates a new encryption key
    37  
    38  - [`operator keyring`][keyring] - Manages gossip layer encryption keys
    39  
    40  - [`operator raft list-peers`][list] - Display the current Raft peer
    41    configuration
    42  
    43  - [`operator raft remove-peer`][remove] - Remove a Nomad server from the Raft
    44    configuration
    45  
    46  - [`operator snapshot agent`][snapshot-agent] <EnterpriseAlert inline /> - Inspects a snapshot of the Nomad server state
    47  
    48  - [`operator snapshot save`][snapshot-save] - Saves a snapshot of the Nomad server state
    49  
    50  - [`operator snapshot restore`][snapshot-restore] - Restores a snapshot of the Nomad server state
    51  
    52  - [`operator snapshot inspect`][snapshot-inspect] - Inspects a snapshot of the Nomad server state
    53  
    54  [get-config]: /docs/commands/operator/autopilot-get-config 'Autopilot Get Config command'
    55  [keygen]: /docs/commands/operator/keygen 'Generates a new encryption key'
    56  [keyring]: /docs/commands/operator/keyring 'Manages gossip layer encryption keys'
    57  [list]: /docs/commands/operator/raft-list-peers 'Raft List Peers command'
    58  [operator]: /api-docs/operator 'Operator API documentation'
    59  [outage recovery guide]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
    60  [remove]: /docs/commands/operator/raft-remove-peer 'Raft Remove Peer command'
    61  [set-config]: /docs/commands/operator/autopilot-set-config 'Autopilot Set Config command'
    62  [snapshot-save]: /docs/commands/operator/snapshot-save 'Snapshot Save command'
    63  [snapshot-restore]: /docs/commands/operator/snapshot-restore 'Snapshot Restore command'
    64  [snapshot-inspect]: /docs/commands/operator/snapshot-inspect 'Snapshot Inspect command'
    65  [snapshot-agent]: /docs/commands/operator/snapshot-agent 'Snapshot Agent command'