9849af8663
* api: Add deprecation status to plugin endpoints * cli: Add -detailed flag to `plugin list` * docs: Update plugin list/info docs
62 lines
1.8 KiB
Plaintext
62 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: plugin list - Command
|
|
description: The "plugin list" command lists all available plugins in the plugin catalog.
|
|
---
|
|
|
|
# plugin list
|
|
|
|
The `plugin list` command lists all available plugins in the plugin catalog.
|
|
It can be used alone or with a type such as "auth", "database", or "secret".
|
|
|
|
## Deprecation Status Column
|
|
|
|
As of 1.12, all builtin plugins will have an associated Deprecation
|
|
Status. This status will be reflected in the `Deprecation Status` column, seen
|
|
below. All non-builtin plugins will show a `Deprecation Status` of "n/a".
|
|
|
|
## Examples
|
|
|
|
List all available plugins in the catalog.
|
|
|
|
```shell-session
|
|
$ vault plugin list
|
|
|
|
Plugins
|
|
-------
|
|
my-custom-plugin
|
|
# ...
|
|
|
|
$ vault plugin list database
|
|
Plugins
|
|
-------
|
|
cassandra-database-plugin
|
|
# ...
|
|
```
|
|
|
|
List detailed plugin information:
|
|
|
|
```shell-session
|
|
$ vault plugin list -detailed
|
|
Name Type Version Deprecation Status
|
|
---- ---- ------- ------------------
|
|
alicloud auth v0.12.0+builtin supported
|
|
app-id auth v1.12.0+builtin.vault pending removal
|
|
# ...
|
|
```
|
|
## Usage
|
|
|
|
The following flags are available in addition to the [standard set of
|
|
flags](/docs/commands) included on all commands.
|
|
|
|
### Output Options
|
|
|
|
- `-format` `(string: "table")` - Print the output in the given format. Valid
|
|
formats are "table", "json", or "yaml". This can also be specified via the
|
|
`VAULT_FORMAT` environment variable.
|
|
|
|
### Command Options
|
|
|
|
- `-detailed` `(bool: false)` - Print detailed information such as version and
|
|
deprecation status about each plugin.
|