• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Nomad
  • Install
  • Intro
  • Tutorials
  • Documentation
  • API
  • Tools
  • Plugins
  • Sign up
Nomad Home

Documentation

Skip to main contentOverview

    • Overview
    • agent
    • agent-info
    • fmt
    • monitor
      • Overview
      • api
      • debug
      • keygen
      • keyring
      • metrics
    • status
    • ui
    • version

  • Schedulers

  • Nomad Ecosystem
  • Nomad Partnerships
  • Who Uses Nomad
  • FAQ

  • Resources

  • Tutorial Library
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Nomad
  3. Documentation
  4. Commands (CLI)
  5. operator
  • Nomad
  • v1.3.x
  • v1.2.x
  • v1.1.x
  • v1.0.x
  • v0.12.x
  • v0.11.x

»Command: 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 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

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 keygen - Generates a new encryption key

  • operator keyring - Manages gossip layer encryption keys

  • operator raft list-peers - Display the current Raft peer configuration

  • operator raft remove-peer - Remove a Nomad server from the Raft configuration

  • operator scheduler get-config - Display the current scheduler configuration

  • operator scheduler set-config - Modify the scheduler configuration

  • operator snapshot agent

    Enterprise
    - 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

Edit this page on GitHub

On this page

  1. Command: operator
  2. Usage
Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)