vault operator rekey <key>

Generates a new set of unseal keys. This can optionally change the total number of key shares or the required threshold of those key shares to reconstruct the root key. This operation is zero downtime, but it requires the Vault is unsealed and a quorum of existing unseal keys are provided

Arguments

NameDescription
keyAn unseal key may be provided directly on the command line as an argument to the command. If key is specified as '-', the command will read from stdin. If a TTY is available, the command will prompt for text

Options

NameDescription
--help, -hDisplay help
-address <string>Address of the Vault server. The default is https://127.0.0.1:8200. This can also be specified via the VAULT_ADDR environment variable
-agent-address <string>Address of the Agent. This can also be specified via the VAULT_AGENT_ADDR environment variable
-ca-cert <string>Path on the local disk to a single PEM-encoded CA certificate to verify the Vault server's SSL certificate. This takes precedence over -ca-path. This can also be specified via the VAULT_CACERT environment variable
-ca-path <string>Path on the local disk to a directory of PEM-encoded CA certificates to verify the Vault server's SSL certificate. This can also be specified via the VAULT_CAPATH environment variable
-client-cert <string>Path on the local disk to a single PEM-encoded CA certificate to use for TLS authentication to the Vault server. If this flag is specified, -client-key is also required. This can also be specified via the VAULT_CLIENT_CERT environment variable
-client-key <string>Path on the local disk to a single PEM-encoded private key matching the client certificate from -client-cert. This can also be specified via the VAULT_CLIENT_KEY environment variable
-header-key <string>Key-value pair provided as key=value to provide http header added to any request done by the CLI.Trying to add headers starting with 'X-Vault-' is forbidden and will make the command fail This can be specified multiple times
-mfa <string>Supply MFA credentials as part of X-Vault-MFA header. This can also be specified via the VAULT_MFA environment variable
-namespace <string>The namespace to use for the command. Setting this is not necessary but allows using relative paths. -ns can be used as shortcut. The default is (not set). This can also be specified via the VAULT_NAMESPACE environment variable
-non-interactive <string>When set true, prevents asking the user for input via the terminal. The default is false
-output-curl-string <string>Instead of executing the request, print an equivalent cURL command string and exit. The default is false
-policy-override <string>Override a Sentinel policy that has a soft-mandatory enforcement_level specified The default is false
-tls-server-name <string>Name to use as the SNI host when connecting to the Vault server via TLS. This can also be specified via the VAULT_TLS_SERVER_NAME environment variable
-tls-skip-verify <string>Disable verification of TLS certificates. Using this option is highly discouraged as it decreases the security of data transmissions to and from the Vault server. The default is false. This can also be specified via the VAULT_SKIP_VERIFY environment variable
-unlock-key <string>Key to unlock a namespace API lock. The default is (not set)
-wrap-ttl <string>Wraps the response in a cubbyhole token with the requested TTL. The response is available via the 'vault unwrap' command. The TTL is specified as a numeric string with suffix like '30s' or '5m'. This can also be specified via the VAULT_WRAP_TTL environment variable
-format <string>Print the output in the given format. Valid formats are 'table', 'json', 'yaml', or 'pretty'. The default is table. This can also be specified via the VAULT_FORMAT environment variable
-cancelReset the rekeying progress. This will discard any submitted unseal keys or configuration. The default is false
-initInitialize the rekeying operation. This can only be done if no rekeying operation is in progress. Customize the new number of key shares and key threshold using the -key-shares and -key-threshold flags. The default is false
-key-shares, -n <int>Number of key shares to split the generated root key into. This is the number of 'unseal keys' to generate. This is aliased as '-n'. The default is 5
-key-threshold, -t <int>Number of key shares required to reconstruct the root key. This must be less than or equal to -key-shares. This is aliased as '-t'. The default is 3
-nonce <string>Nonce value provided at initialization. The same nonce value must be provided with each unseal key
-pgp-keys <pgp_key>Comma-separated list of paths to files on disk containing public PGP keys OR a comma-separated list of Keybase usernames using the format 'keybase:<username>'. When supplied, the generated unseal keys will be encrypted and base64-encoded in the order specified in this list. The number of entries must match -key-shares, unless -stored-shares are used
-statusPrint the status of the current attempt without providing an unseal key. The default is false
-target <string>Target for rekeying. 'recovery' only applies when HSM support is enabled. The default is barrier
-verifyIndicates that the action (-status, -cancel, or providing a key share) will be affecting verification for the current rekey attempt. The default is false
-backupStore a backup of the current PGP encrypted unseal keys in Vault's core. The encrypted values can be recovered in the event of failure or discarded after success. See the -backup-delete and -backup-retrieve options for more information. This option only applies when the existing unseal keys were PGP encrypted. The default is false
-backup-deleteDelete any stored backup unseal keys. The default is false
-backup-retriesRetrieve the backed-up unseal keys. This option is only available if the PGP keys were provided and the backup has not been deleted. The default is false