open-vault/website/content/docs/commands/unwrap.mdx

46 lines
1.4 KiB
Plaintext
Raw Normal View History

2017-09-08 02:14:30 +00:00
---
layout: docs
page_title: unwrap - Command
2017-09-08 02:14:30 +00:00
description: |-
The "unwrap" command unwraps a wrapped secret from Vault by the given token.
The result is the same as the "vault read" operation on the non-wrapped
secret. If no token is given, the data in the currently authenticated token is
unwrapped.
---
# unwrap
The `unwrap` command unwraps a wrapped secret from Vault by the given token. The
result is the same as the "vault read" operation on the non-wrapped secret. If
no token is given, the data in the currently authenticated token is unwrapped.
## Examples
Unwrap the data in the cubbyhole secrets engine for a token:
```shell-session
2017-09-08 02:14:30 +00:00
$ vault unwrap 3de9ece1-b347-e143-29b0-dc2dc31caafd
```
Unwrap the data in the active token:
```shell-session
$ vault login 848f9ccf-7176-098c-5e2b-75a0689d41cd
2017-09-08 02:14:30 +00:00
$ vault unwrap # unwraps 848f9ccf...
```
## Usage
The following flags are available in addition to the [standard set of
flags](/vault/docs/commands) included on all commands.
2017-09-08 02:14:30 +00:00
### Output Options
- `-field` `(string: "")` - Print only the field with the given name. Specifying
this option will take precedence over other formatting directives. The result
CLI Enhancements (#3897) * Use Colored UI if stdout is a tty * Add format options to operator unseal * Add format test on operator unseal * Add -no-color output flag, and use BasicUi if no-color flag is provided * Move seal status formatting logic to OutputSealStatus * Apply no-color to warnings from DeprecatedCommands as well * Add OutputWithFormat to support arbitrary data, add format option to auth list * Add ability to output arbitrary list data on TableFormatter * Clear up switch logic on format * Add format option for list-related commands * Add format option to rest of commands that returns a client API response * Remove initOutputYAML and initOutputJSON, and use OutputWithFormat instead * Remove outputAsYAML and outputAsJSON, and use OutputWithFormat instead * Remove -no-color flag, use env var exclusively to toggle colored output * Fix compile * Remove -no-color flag in main.go * Add missing FlagSetOutputFormat * Fix generate-root/decode test * Migrate init functions to main.go * Add no-color flag back as hidden * Handle non-supported data types for TableFormatter.OutputList * Pull formatting much further up to remove the need to use c.flagFormat (#3950) * Pull formatting much further up to remove the need to use c.flagFormat Also remove OutputWithFormat as the logic can cause issues. * Use const for env var * Minor updates * Remove unnecessary check * Fix SSH output and some tests * Fix tests * Make race detector not run on generate root since it kills Travis these days * Update docs * Update docs * Address review feedback * Handle --format as well as -format
2018-02-12 23:12:16 +00:00
will not have a trailing newline making it ideal for piping to other processes.
2017-09-08 02:14:30 +00:00
- `-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.