mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-10 08:37:00 +02:00
0b12cdcfd1
* Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Updating the license from MPL to Business Source License. Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at https://hashi.co/bsl-blog, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl. * add missing license headers * Update copyright file headers to BUS-1.1 * Fix test that expected exact offset on hcl file --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com> Co-authored-by: Sarah Thompson <sthompson@hashicorp.com> Co-authored-by: Brian Kassouf <bkassouf@hashicorp.com>
58 lines
1.5 KiB
Go
58 lines
1.5 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package command
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
var _ cli.Command = (*KVMetadataCommand)(nil)
|
|
|
|
type KVMetadataCommand struct {
|
|
*BaseCommand
|
|
}
|
|
|
|
func (c *KVMetadataCommand) Synopsis() string {
|
|
return "Interact with Vault's Key-Value storage"
|
|
}
|
|
|
|
func (c *KVMetadataCommand) Help() string {
|
|
helpText := `
|
|
Usage: vault kv metadata <subcommand> [options] [args]
|
|
|
|
This command has subcommands for interacting with the metadata endpoint in
|
|
Vault's key-value store. Here are some simple examples, and more detailed
|
|
examples are available in the subcommands or the documentation.
|
|
|
|
Create or update a metadata entry for a key:
|
|
|
|
$ vault kv metadata put -mount=secret -max-versions=5 -delete-version-after=3h25m19s foo
|
|
|
|
Get the metadata for a key, this provides information about each existing
|
|
version:
|
|
|
|
$ vault kv metadata get -mount=secret foo
|
|
|
|
Delete a key and all existing versions:
|
|
|
|
$ vault kv metadata delete -mount=secret foo
|
|
|
|
The deprecated path-like syntax can also be used, but this should be avoided
|
|
for KV v2, as the fact that it is not actually the full API path to
|
|
the secret (secret/metadata/foo) can cause confusion:
|
|
|
|
$ vault kv metadata get secret/foo
|
|
|
|
Please see the individual subcommand help for detailed usage information.
|
|
`
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *KVMetadataCommand) Run(args []string) int {
|
|
return cli.RunResultHelp
|
|
}
|