credential-libraries update
Command: boundary credential-libraries update
The credential-libraries update
command lets you update Boundary credential library resources.
Examples
The following example updates an existing Vault credential library with the ID csvlt_5fvkRjCjou
to point to a new Vault secrets engine path:
Example output:
Usage
Command options
-description
(string: "")
- A description to set on the credential library.-id
(string: "")
- The ID of the credential library to update.-name
(string: "")
- A name to set on the credential library.-version
(int: 0)
- The version of the credential library against which to perform the update operation. If you don't specify a version, the command performs a check-and-set automatically.
Usages by type
The available types are vault-generic
and vault-ssh-certificate
.
Note
A credential library type, vault
is deprecated, so use vault-generic
type
instead.
The credential-libraries update vault-generic
command lets you update a generic Vault credential library.
Example
The following example updates a generic Vault credential library with the ID clvlt_1234567890
to add the name devops
and the description For DevOps usage
:
Usage
Vault credential library options
The following are specific Vault credential library options in addition to the command options:
-credential-mapping-override
- An override for credential mapping.-vault-http-method
(string: "")
- The HTTP method the library should use when it communicates with Vault.-vault-http-request-body
(strinboundary credential-libraries update vault-ssh-certificate -id clvsclt_1234567890 -name devops -description "For DevOps usage": "")
- The HTTP request body the credential library uses to communicate with Vault. This value can be the HTTP request body itself, it can refer to a file on disk (file://
) from which the value is read, or it can refer to an environment variable (env://
) from which the value is read.-vault-path
(string: "")
- The path in Vault to request credentials from.
CLI options
In addition to the command specific options, there are options common to all CLI commands and subcommands: