| layout | page_title | description |
|---|---|---|
docs |
Commands: operator |
The operator command provides cluster-level tools for Nomad operators.
|
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.
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.
Usage: nomad operator <subcommand> <subcommand> [options]
Run nomad operator <subcommand> with no arguments for help on that subcommand.
The following subcommands are available:
-
operator autopilot get-config- Display the current Autopilot configuration -
operator autopilot set-config- Modify the current Autopilot configuration -
operator debug- Build an archive of debug data -
operator gossip keyring generate- Generates a gossip encryption key -
operator gossip keyring install- Install a gossip encryption key -
operator gossip keyring list- List available gossip encryption keys -
operator gossip keyring remove- Deletes a gossip encryption key -
operator gossip keyring use- Sets a gossip encryption key as the active key -
operator raft list-peers- Display the current Raft peer configuration -
operator raft remove-peer- Remove a Nomad server from the Raft configuration -
operator root keyring list- List available root encryption keys -
operator root keyring remove- Deletes a root encryption key -
operator root keyring rotate- Rotates the root encryption key -
operator scheduler get-config- Display the current scheduler configuration -
operator scheduler set-config- Modify the scheduler configuration -
operator snapshot agent- Inspects a snapshot of the Nomad server state -
operator snapshot save- Saves a snapshot of the Nomad server state -
operator snapshot restore- Restores a snapshot of the Nomad server state -
operator snapshot inspect- Inspects a snapshot of the Nomad server state