open-nomad/website/content/docs/commands/operator/snapshot-state.mdx
Tim Gross f2615992a4
cli: unhide advanced operator raft debugging commands (#11682)
The `nomad operator raft` and `nomad operator snapshot state`
subcommands for inspecting on-disk raft state were hidden and
undocumented. Expose and document these so that advanced operators
have support for these tools.
2021-12-16 10:32:11 -05:00

31 lines
701 B
Plaintext

---
layout: docs
page_title: 'Commands: operator snapshot state'
description: |
Displays a JSON representation of a Raft snapshot.
---
# Command: operator snapshot state
Displays a JSON representation of state in a raft snapshot on disk.
~> **Warning:** This is a low-level debugging tool and not subject to
Nomad's usual backward compatibility guarantees.
## Usage
```plaintext
nomad operator snapshot state <file>
```
## Examples
The output of this command can be very large, so it's recommended that
you redirect the output to a file for later examination with other
tools.
```shell-session
$ nomad operator snapshot state backup.snap > ~/raft-state.json
$ jq . < ~/raft-state.json
```