Skip to content

Commit

Permalink
Vault Status Command Differs Depending on Format (#19361)
Browse files Browse the repository at this point in the history
* vault-issue-9185

* removing new lines:

* removing new space

* fix grammar

* change field name
  • Loading branch information
akshya96 committed Mar 1, 2023
1 parent 3e663fc commit cf6be21
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions website/content/docs/commands/status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,21 @@ flags](/vault/docs/commands) included on all commands.
- `-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.

By default, the output is displayed in "table" format.

#### Output Fields

1. The field for total shares is displayed as `"n"` instead of `n` in yaml outputs.
2. The following fields in "table" format are displayed only when relevant:
- "Unseal Progress" and "Unseal Nonce" are displayed when vault is sealed.
- "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured.
- "Seal Migration in Progress" is displayed when it is in progress.
- "Cluster Name" and "Cluster ID" are displayed if they have a value.
- "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero.
- "Warnings" are displayed if the warnings apply.
- The following fields are displayed only when HA mode is enabled and is unsealed:
- "HA Cluster".
- "HA Mode".
- "Active Since" is displayed if the node is active and has a valid active time.
- "Performance Standby" Node and "Performance Standby Last Remote WAL" are displayed for performance standby nodes.

0 comments on commit cf6be21

Please sign in to comment.