Skip to main content

plugin

The plugin command groups subcommands for interacting with OpenBao's plugins and the plugin catalog

Examples​

List all available secret plugins in the catalog:

$ bao plugin list secret

Name            Version
----            -------
kubernetes      v0.5.0+builtin
kv              v0.15.0+builtin
...

Register a new secret plugin to the catalog:

$ bao plugin register \
  -sha256=d3f0a8be02f6c074cf38c9c99d4d04c9c6466249 \
  secret my-custom-plugin
Success! Registered plugin: my-custom-plugin

Get information about a plugin in the catalog:

$ bao plugin info secret my-custom-plugin
Key                   Value
---                   -----
args                  []
builtin               false
command               my-custom-plugin
deprecation_status    n/a
name                  my-custom-plugin
sha256                33e72f3d30ff2acdbf3cf3c8fa1c8945b60dab876c4226ab25617a63c9f16cc5
version               n/a

Usage​

Usage: bao 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.