github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/operator/index.mdx (about)

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