mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-23 23:51:08 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
85 lines
2.4 KiB
Plaintext
85 lines
2.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: plugin - Command
|
|
description: |-
|
|
The "plugin" command groups subcommands for interacting with
|
|
Vault's plugins and the plugin catalog.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# plugin
|
|
|
|
The `plugin` command groups subcommands for interacting with Vault's plugins and
|
|
the plugin catalog
|
|
|
|
## Examples
|
|
|
|
List all available secret plugins in the catalog:
|
|
|
|
```shell-session
|
|
$ vault plugin list secret
|
|
|
|
Name Version
|
|
---- -------
|
|
ad v0.14.0+builtin
|
|
alicloud v0.13.0+builtin
|
|
...
|
|
```
|
|
|
|
Register a new secret plugin to the catalog:
|
|
|
|
```shell-session
|
|
$ vault plugin register \
|
|
-sha256=d3f0a8be02f6c074cf38c9c99d4d04c9c6466249 \
|
|
secret my-custom-plugin
|
|
Success! Registered plugin: my-custom-plugin
|
|
```
|
|
|
|
Register a plugin with `-download` <EnterpriseAlert inline="true"/>:
|
|
|
|
```shell-session
|
|
$ vault plugin register
|
|
-download \
|
|
-version=0.16.0+ent \
|
|
secret \
|
|
vault-plugin-secrets-keymgmt
|
|
```
|
|
|
|
Get information about a plugin in the catalog:
|
|
|
|
```shell-session
|
|
$ vault plugin info secret my-custom-plugin
|
|
Key Value
|
|
--- -----
|
|
args []
|
|
builtin false
|
|
command my-custom-plugin
|
|
deprecation_status n/a
|
|
name my-custom-plugin
|
|
oci_image n/a
|
|
runtime n/a
|
|
sha256 33e72f3d30ff2acdbf3cf3c8fa1c8945b60dab876c4226ab25617a63c9f16cc5
|
|
version n/a
|
|
```
|
|
|
|
## Usage
|
|
|
|
```text
|
|
Usage: vault plugin <subcommand> [options] [args]
|
|
|
|
# ...
|
|
|
|
Subcommands:
|
|
deregister Deregister an existing plugin in the catalog
|
|
info Read information about a plugin in the catalog
|
|
list Lists available plugins
|
|
register Registers a new plugin in the catalog
|
|
reload Reload mounted plugin backend
|
|
reload-status Get the status of an active or recently completed global plugin reload
|
|
```
|
|
|
|
For more information, examples, and usage about a subcommand, click on the name
|
|
of the subcommand in the sidebar.
|