open-vault/website/source/docs/commands/status.html.md

45 lines
952 B
Markdown
Raw Normal View History

2017-09-08 02:14:21 +00:00
---
layout: "docs"
page_title: "status - Command"
sidebar_current: "docs-commands-status"
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:
```text
$ 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
There are no flags beyond the [standard set of flags](/docs/commands/index.html)
included on all commands.