diff --git a/command/token_renew.go b/command/token_renew.go index d5a07df5e1..88d6fa20fb 100644 --- a/command/token_renew.go +++ b/command/token_renew.go @@ -77,10 +77,10 @@ func (c *TokenRenewCommand) Flags() *FlagSets { Default: 0, EnvVar: "", Completion: complete.PredictAnything, - Usage: "Request a specific increment for renewal. Vault is not required " + - "to honor this request. If not supplied, Vault will use the default " + - "TTL. This is specified as a numeric string with suffix like \"30s\" " + - "or \"5m\".", + Usage: "Request a specific increment for renewal. This increment may " + + "not be honored, for instance in the case of periodic tokens. If not " + + "supplied, Vault will use the default TTL. This is specified as a " + + "numeric string with suffix like \"30s\" or \"5m\".", }) return set diff --git a/website/content/api-docs/auth/token.mdx b/website/content/api-docs/auth/token.mdx index 67e8c03242..48dd4e9556 100644 --- a/website/content/api-docs/auth/token.mdx +++ b/website/content/api-docs/auth/token.mdx @@ -337,8 +337,10 @@ if there is a lease associated with it. - `token` `(string: )` - Token to renew. This can be part of the URL or the body. -- `increment` `(string: "")` - An optional requested lease increment can be - provided. This increment may be ignored. +- `increment` `(string: "")` - An optional requested increment duration can be + provided. This increment may not be honored, for instance in the case of periodic tokens. + If not supplied, Vault will use the default TTL. This is specified as a numeric string + with suffix like "30s" or "5m". ### Sample Payload @@ -386,8 +388,10 @@ possible only if there is a lease associated with it. ### Parameters -- `increment` `(string: "")` - An optional requested lease increment can be - provided. This increment may be ignored. +- `increment` `(string: "")` - An optional requested increment duration can be + provided. This increment may not be honored, for instance in the case of periodic tokens. + If not supplied, Vault will use the default TTL. This is specified as a numeric string + with suffix like "30s" or "5m". ### Sample Payload diff --git a/website/content/docs/commands/token/renew.mdx b/website/content/docs/commands/token/renew.mdx index 5a9b845ab3..48052f609b 100644 --- a/website/content/docs/commands/token/renew.mdx +++ b/website/content/docs/commands/token/renew.mdx @@ -50,6 +50,6 @@ flags](/docs/commands) included on all commands. ### Command Options - `-increment` `(duration: "")` - Request a specific increment for renewal. - Vault is not required to honor this request. If not supplied, Vault will use + Vault will not honor this request for periodic tokens. If not supplied, Vault will use the default TTL. This is specified as a numeric string with suffix like "30s" or "5m". This is aliased as "-i".