mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
165 lines
8.2 KiB
Plaintext
165 lines
8.2 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.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# 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
|
|
|
|
Print the current Vault status:
|
|
|
|
```shell-session
|
|
$ vault status
|
|
```
|
|
|
|
Example output of a Vault server running in development mode.
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Key Value
|
|
--- -----
|
|
Seal Type shamir
|
|
Initialized true
|
|
Sealed false
|
|
Total Shares 5
|
|
Threshold 3
|
|
Version 1.19.1
|
|
Build Date 2025-04-02T15:43:36Z
|
|
Storage Type inmem
|
|
Cluster Name vault-cluster-1e76691a
|
|
Cluster ID c4ca5956-383b-20cc-7a7d-494e0b01f045
|
|
HA Enabled false
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
|
|
Example output of a Vault cluster configured with [integrated storage](/vault/docs/concepts/integrated-storage) as its storage backend.
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```plaintext
|
|
Key Value
|
|
--- -----
|
|
Seal Type shamir
|
|
Initialized true
|
|
Sealed false
|
|
Total Shares 5
|
|
Threshold 3
|
|
Version 1.19.2
|
|
Build Date 2025-04-17T16:41:30Z
|
|
Storage Type raft
|
|
Cluster Name vault-cluster-c754bf5d
|
|
Cluster ID 460c2929-1f4a-7dc2-c436-fbf8712d5d09
|
|
Removed From Cluster false
|
|
HA Enabled true
|
|
HA Cluster https://10.1.42.101:8201
|
|
HA Mode active
|
|
Active Since 2025-04-25T18:48:04.102445716Z
|
|
Raft Committed Index 52
|
|
Raft Applied Index 52
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
<Tip title="Output references">
|
|
|
|
Refer to the [command output fields](#command-output-fields) section to learn more about the output.
|
|
|
|
</Tip>
|
|
|
|
## Usage
|
|
|
|
The following flags are available in addition to the [standard set of
|
|
flags](/vault/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.
|
|
|
|
## Command output fields
|
|
|
|
The output includes the following fields that are relevant to your Vault server.
|
|
|
|
<Tabs>
|
|
<Tab heading="Common fields">
|
|
|
|
| Field name | Description |
|
|
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Seal Type | The [seal type](/vault/docs/configuration/seal) configured to protect the Vault's root key |
|
|
| Initialized | Indicates if the Vault has been [initialized](/vault/docs/commands/operator/init) or not |
|
|
| Sealed | `false` if the Vault is unsealed and ready to operate; otherwise, `true` and you need to perform the [unseal](/vault/docs/commands/operator/unseal) operation. |
|
|
| Total Shares | The total number of unseal keys when the seal type is [Shamir seals](/vault/docs/concepts/seal#shamir-seals). |
|
|
| Threshold | The number of key shares required to construct the root key. |
|
|
| Total Recovery Shares | The total number of recovery keys when configured with [auto-unseal](/vault/docs/concepts/seal#auto-unseal). |
|
|
| Version | Vault version |
|
|
| Build Date | The Vault binary build date. |
|
|
| Storage Type | Vault [storage](/vault/docs/concepts/storage) configured to store Vault data. |
|
|
| Cluster Name | Name of the Vault cluster. |
|
|
| Cluster ID | ID of the Valut cluster. |
|
|
| HA Enabled | Indicates if the Vault is a [highly availabile](/vault/docs/concepts/ha) cluster. |
|
|
|
|
|
|
</Tab>
|
|
<Tab heading="HA fields">
|
|
|
|
The following fields are only for highly available (HA) clusters:
|
|
|
|
| Field name | Description |
|
|
| ------------ | ------------------------------------------------------------------------------------ |
|
|
| HA Cluster | The address to advertise to other Vault nodes in the cluster for request forwarding. |
|
|
| HA Mode | The HA mode of the Vault: active or standby. |
|
|
| Active Since | Indicates if the Vault is active and has a valid active time. |
|
|
|
|
</Tab>
|
|
<Tab heading="Raft fields">
|
|
|
|
The following fields are only when the storage or HA backend is raft:
|
|
|
|
| Field name | Description |
|
|
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Removed From Cluster | Indicates if the node has been removed from the HA cluster. This field is displayed only when the storage or HA backend is raft. |
|
|
| Raft Committed Index | The index of the committed log entry if the value is non-zero. |
|
|
| Raft Applied Index | The highest index of raft log last applied to the finite state machine or added to `fsm_pending` queue if the value is non-zero. |
|
|
| Last WAL | Index of the last write-ahead log (WAL) if the value is non-zero. |
|
|
|
|
</Tab>
|
|
<Tab heading="Enterprise Replication">
|
|
|
|
| Field name | Description |
|
|
| ----------------------------------- | ---------------------------------------------------------------------------------- |
|
|
| Active Node Address | The active node address that performance standby nodes use for request forwarding. |
|
|
| Performance Standby Node | Indicates if the node is a performance standby node or not. |
|
|
| Performance Standby Last Remote WAL | Index of the last write-ahead log (WAL) received from the active node. |
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
In addition, the output displays the following fields if applicable:
|
|
|
|
- **`Unseal Progress`** and **`Unseal Nonce`** when the Vault is sealed.
|
|
- **`HCP Link Status`** and **`HCP Link Resource ID`** when [HCP link](/vault/docs/commands/hcp) is configured.
|
|
- **`Seal Migration in Progress`** when the [seal migration](/vault/docs/commands/operator/migrate) is in progress.
|
|
|