VaultCLI Update-Secret Command

Use the vaultCLI update-secret command to update the properties of a secret.

Syntax

vaultcli update-secrets [options]

Option Description

-h or --help

 Displays usage text.

-b or --boxid string

 The name or ID of the box where the secret will be created.

-d or --description string

 A short description of the secret.

-x or --exclusive-checkout string {enable|disable|unset}

If this flag is set, all secret checkouts will be exclusive. Use unset to clear the property.

Important: If this property is set in a secret, it takes precedence over the property being set in a box.

-e or --expires_at string {unset}

The expiration time in RFC 3339 format, prefixed with TS. For example, TS2020-12-12T22:04:16.162848Z. Use unset to clear the property.

-l or --lease-duration string {unset}

The lease duration to enforce for this secret. The duration must be in ISO 8601 format. For example, P1M15DT12H30M. Use unset to clear the property.

Important: If this property is set in a secret, it takes precedence over the property being set in a box.

-L or --lease-renewable string

Reserved for future use.

-r or --revision int

The revision number of the secret.

-r or --rotation-duration string {unset}

The duration for when the secret will be rotated. The behavior depends on the rotation-force option. The duration must be in ISO 8601 format. For example, P1M15DT12H30M. Use unset to clear the property.

Important: If this property is set in a secret, it takes precedence over the property being set in a box.

-f or --rotation-force string {enable|disable|unset}

If this flag is set, it forces the rotation of this secret. The behavior varies depending on the rotation-duration and rotation-on-checkin options. Use unset to clear the property.

Important: If this property is set in a secret, it takes precedence over the property being set in a box.

-o or --rotation-on-checkin string {enable|disable|unset}

If this flag is set, the secret rotation is attempted when the secret is checked in. The behavior depends on the rotation-force option. Use unset to clear the property.

Important: If this property is set in a secret, it takes precedence over the property being set in a box.

-s or --secretid string

 The ID or name of the secret to update. Strings must be enclosed in double quotes.

-t or --tagkey stringArray

 The tag key to associate with the secret. This option is repeatable.

-v or --tagvalue stringArray

 The tag value to associate with the secret. This option is repeatable.