2017-02-10 01:58:20 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: 'Commands: operator'
|
|
|
|
|
sidebar_title: operator
|
|
|
|
|
description: |
|
2017-02-10 01:58:20 +00:00
|
|
|
The operator command provides cluster-level tools for Nomad operators.
|
|
|
|
|
---
|
|
|
|
|
|
2018-03-22 20:39:18 +00:00
|
|
|
# Command: operator
|
2017-02-10 01:58:20 +00:00
|
|
|
|
|
|
|
|
The `operator` command provides cluster-level tools for Nomad operators, such
|
|
|
|
|
as interacting with the Raft subsystem. This was added in Nomad 0.5.5.
|
|
|
|
|
|
|
|
|
|
~> Use this command with extreme caution, as improper use could lead to a Nomad
|
|
|
|
|
outage and even loss of data.
|
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
See the [Outage Recovery guide] guide for some examples of how this command is
|
|
|
|
|
used. For an API to perform these operations programmatically, please see the
|
|
|
|
|
documentation for the [Operator] endpoint.
|
2017-02-10 01:58:20 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `nomad operator <subcommand> <subcommand> [options]`
|
|
|
|
|
|
|
|
|
|
Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
|
|
|
|
|
The following subcommands are available:
|
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- [`operator autopilot get-config`][get-config] - Display the current Autopilot
|
|
|
|
|
configuration
|
|
|
|
|
|
|
|
|
|
- [`operator autopilot set-config`][set-config] - Modify the current Autopilot
|
|
|
|
|
configuration
|
|
|
|
|
|
|
|
|
|
- [`operator keygen`][keygen] - Generates a new encryption key
|
|
|
|
|
|
|
|
|
|
- [`operator keyring`][keyring] - Manages gossip layer encryption keys
|
|
|
|
|
|
|
|
|
|
- [`operator raft list-peers`][list] - Display the current Raft peer
|
|
|
|
|
configuration
|
|
|
|
|
|
|
|
|
|
- [`operator raft remove-peer`][remove] - Remove a Nomad server from the Raft
|
|
|
|
|
configuration
|
2017-03-15 18:29:36 +00:00
|
|
|
|
2020-06-19 16:52:54 +00:00
|
|
|
- [`operator snapshot agent`][snapshot-agent] <EnterpriseAlert inline /> - Inspects a snapshot of the Nomad server state
|
|
|
|
|
|
2020-06-19 16:31:40 +00:00
|
|
|
- [`operator snapshot save`][snapshot-save] - Saves a snapshot of the Nomad server state
|
|
|
|
|
|
|
|
|
|
- [`operator snapshot restore`][snapshot-restore] - Restores a snapshot of the Nomad server state
|
|
|
|
|
|
|
|
|
|
- [`operator snapshot inspect`][snapshot-inspect] - Inspects a snapshot of the Nomad server state
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
[get-config]: /docs/commands/operator/autopilot-get-config 'Autopilot Get Config command'
|
|
|
|
|
[keygen]: /docs/commands/operator/keygen 'Generates a new encryption key'
|
|
|
|
|
[keyring]: /docs/commands/operator/keyring 'Manages gossip layer encryption keys'
|
|
|
|
|
[list]: /docs/commands/operator/raft-list-peers 'Raft List Peers command'
|
2020-03-20 22:26:58 +00:00
|
|
|
[operator]: /api-docs/operator 'Operator API documentation'
|
2020-03-20 21:00:59 +00:00
|
|
|
[outage recovery guide]: https://learn.hashicorp.com/nomad/operating-nomad/outage
|
2020-02-06 23:45:31 +00:00
|
|
|
[remove]: /docs/commands/operator/raft-remove-peer 'Raft Remove Peer command'
|
|
|
|
|
[set-config]: /docs/commands/operator/autopilot-set-config 'Autopilot Set Config command'
|
2020-06-19 16:31:40 +00:00
|
|
|
[snapshot-save]: /docs/commands/operator/snapshot-save 'Snapshot Save command'
|
|
|
|
|
[snapshot-restore]: /docs/commands/operator/snapshot-restore 'Snapshot Restore command'
|
|
|
|
|
[snapshot-inspect]: /docs/commands/operator/snapshot-inspect 'Snapshot Inspect command'
|
2020-06-19 16:52:54 +00:00
|
|
|
[snapshot-agent]: /docs/commands/operator/snapshot-agent 'Snapshot Agent command'
|
