Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vault Status Command Differs Depending on Format #19361

Merged
merged 5 commits into from
Mar 1, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 unseal nonce is displayed as `"n"` instead of `n` in yaml outputs.
akshya96 marked this conversation as resolved.
Show resolved Hide resolved
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
akshya96 marked this conversation as resolved.
Show resolved Hide resolved
- "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero
- "Warnings" are displayed if they exist
akshya96 marked this conversation as resolved.
Show resolved Hide resolved
- The following fields are displayed only when HA mode is enabled and is unsealed:
- "HA Cluster"
- "HA Mode"
- "Active Since" is displayed if node is active and has valid active time
akshya96 marked this conversation as resolved.
Show resolved Hide resolved
- "Performance Standby" Node and "Performance Standby Last Remote WAL" are displayed for performance standby nodes