open-vault/website/content/docs/commands/status.mdx
Bryce Kalow b76a56d40c
feat(website): migrates nav data format and updates docs pages (#11242)
* migrates nav data format and updates docs pages

* removes sidebar_title from content files
2021-04-06 13:49:04 -04:00

50 lines
1.1 KiB
Plaintext

---
layout: docs
page_title: status - Command
description: |-
The "status" command prints the current state of Vault including whether it is
sealed and if HA mode is enabled. This command prints regardless of whether
the Vault is sealed.
---
# status
The `status` command prints the current state of Vault including whether it is
sealed and if HA mode is enabled. This command prints regardless of whether the
Vault is sealed.
The exit code reflects the seal status:
- 0 - unsealed
- 1 - error
- 2 - sealed
## Examples
Check the status:
```shell-session
$ vault status
Sealed: false
Key Shares: 5
Key Threshold: 3
Unseal Progress: 0
Unseal Nonce:
Version: x.y.z
Cluster Name: vault-cluster-49ffd45f
Cluster ID: d2dad792-fb99-1c8d-452e-528d073ba205
High-Availability Enabled: false
```
## Usage
The following flags are available in addition to the [standard set of
flags](/docs/commands) included on all commands.
### Output Options
- `-format` `(string: "table")` - Print the output in the given format. Valid
formats are "table", "json", or "yaml". This can also be specified via the
`VAULT_FORMAT` environment variable.