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 info - Command
|
|
description: The "plugin info" command displays information about a plugin in the catalog.
|
|
---
|
|
|
|
# plugin info
|
|
|
|
The `plugin info` displays information about a plugin in the catalog.
|
|
The plugin's type of "auth", "database", or "secret" must be included.
|
|
|
|
## deprecation_status field
|
|
|
|
As of 1.12, all builtin plugins will have an associated Deprecation
|
|
Status. This status will be reflected in the `deprecation_status` key/value
|
|
pair, seen below.
|
|
|
|
## Examples
|
|
|
|
Display information about a plugin
|
|
|
|
```shell-session
|
|
$ vault plugin info auth my-custom-plugin
|
|
|
|
Key Value
|
|
--- -----
|
|
args []
|
|
builtin false
|
|
command my-custom-plugin
|
|
deprecation_status n/a
|
|
name my-custom-plugin
|
|
sha256 d3f0a8be02f6c074cf38c9c99d4d04c9c6466249
|
|
```
|
|
|
|
```shell-session
|
|
$ vault plugin info database postgresql-database-plugin
|
|
Key Value
|
|
--- -----
|
|
args []
|
|
builtin true
|
|
command n/a
|
|
deprecation_status supported
|
|
name postgresql-database-plugin
|
|
sha256 n/a
|
|
```
|
|
|
|
## Usage
|
|
|
|
The following flags are available in addition to the [standard set of
|
|
flags](/docs/commands) included on all commands.
|
|
|
|
### Output Options
|
|
|
|
- `-field` `(string: "")` - Print only the field with the given name. Specifying
|
|
this option will take precedence over other formatting directives. The result
|
|
will not have a trailing newline making it ideal for piping to other
|
|
processes.
|
|
|
|
- `-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.
|