open-vault/website/content/docs/commands/secrets/index.mdx

81 lines
2 KiB
Plaintext
Raw Normal View History

2017-09-08 02:14:09 +00:00
---
layout: docs
page_title: secrets - Command
sidebar_title: <code>secrets</code>
2017-09-08 02:14:09 +00:00
description: |-
The "secrets" command groups subcommands for interacting with Vault's secrets
engines.
---
# secrets
The `secrets` command groups subcommands for interacting with Vault's secrets
engines. Each secrets engine behaves differently. Please see the documentation
2017-09-08 02:14:09 +00:00
for more information.
Some secrets engines persist data, some act as data pass-through, and some
generate dynamic credentials. The secrets engine will likely require
configuration after it is mounted. For details on the specific configuration
options, please see the [secrets engine
documentation](/docs/secrets).
2017-09-08 02:14:09 +00:00
## Examples
Enable a secrets engine:
```shell-session
2017-09-08 02:14:09 +00:00
$ vault secrets enable database
Success! Enabled the database secrets engine at: database/
```
List all secrets engines:
```shell-session
2017-09-08 02:14:09 +00:00
$ vault secrets list
Path Type Description
---- ---- -----------
cubbyhole/ cubbyhole per-token private secret storage
database/ database n/a
secret/ kv key/value secret storage
2017-09-08 02:14:09 +00:00
sys/ system system endpoints used for control, policy and debugging
```
Move a secrets engine to a new path:
```shell-session
2017-09-08 02:14:09 +00:00
$ vault secrets move database/ db-prod/
Success! Moved secrets engine database/ to: db-prod/
```
Tune a secrets engine:
```shell-session
2017-09-08 02:14:09 +00:00
$ vault secrets tune -max-lease-ttl=30m db-prod/
Success! Tuned the secrets engine at: db-prod/
```
Disable a secrets engine:
```shell-session
2017-09-08 02:14:09 +00:00
$ vault secrets disable db-prod/
Success! Disabled the secrets engine (if it existed) at: db-prod/
```
## Usage
```text
Usage: vault secrets <subcommand> [options] [args]
# ...
Subcommands:
disable Disable a secrets engine
2017-09-08 02:14:09 +00:00
enable Enable a secrets engine
list List enabled secrets engines
move Move a secrets engine to a new path
tune Tune a secrets engine configuration
```
For more information, examples, and usage about a subcommand, click on the name
of the subcommand in the sidebar.