open-nomad/website/source/docs/commands/operator.html.md.erb
2017-12-18 14:29:41 -08:00

40 lines
1.6 KiB
Plaintext

---
layout: "docs"
page_title: "Commands: operator"
sidebar_current: "docs-commands-operator"
description: >
The operator command provides cluster-level tools for Nomad operators.
---
# Nomad Operator
Command: `nomad operator`
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](/guides/outage.html) guide for some examples of how
this command is used. For an API to perform these operations programatically,
please see the documentation for the [Operator](/guides/outage.html)
endpoint.
## Usage
Usage: `nomad operator <subcommand> <subcommand> [options]`
Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
The following subcommands are available:
* [`autopilot get-config`][get-config] - Display the current Autopilot configuration
* [`autopilot set-config`][set-config] - Modify the current Autopilot configuration
* [`raft list-peers`][list] - Display the current Raft peer configuration
* [`raft remove-peer`][remove] - Remove a Nomad server from the Raft configuration
[get-config]: /docs/commands/operator/autopilot-get-config.html "Autopilot Get Config command"
[set-config]: /docs/commands/operator/autopilot-set-config.html "Autopilot Set Config command"
[list]: /docs/commands/operator/raft-list-peers.html "Raft List Peers command"
[remove]: /docs/commands/operator/raft-remove-peer.html "Raft Remove Peer command"