2016-11-09 17:49:09 -08:00
# plugin inspect
2016-06-09 23:57:15 +02:00
2023-01-06 19:04:05 +01:00
<!-- - MARKER_GEN_START -->
2016-08-31 14:42:52 +08:00
Display detailed information on one or more plugins
2016-06-09 23:57:15 +02:00
2023-01-06 19:04:05 +01:00
### Options
| Name | Type | Default | Description |
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`-f` ](#format ), [`--format` ](#format ) | `string` | | Format output using a custom template:< br > 'json': Print in JSON format< br > 'TEMPLATE': Print output using the given Go template.< br > Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
<!-- - MARKER_GEN_END -->
2016-06-09 23:57:15 +02:00
2017-02-07 15:42:48 -08:00
## Description
2016-06-09 23:57:15 +02:00
Returns information about a plugin. By default, this command renders all results
in a JSON array.
2017-02-07 15:42:48 -08:00
## Examples
2016-06-09 23:57:15 +02:00
2020-04-19 15:43:08 +02:00
### Inspect a plugin
2017-02-07 15:42:48 -08:00
2024-02-13 13:40:53 +01:00
The following example inspects the `tiborvass/sample-volume-plugin` plugin:
2020-04-19 15:43:08 +02:00
2021-08-21 14:54:14 +02:00
```console
2016-12-14 00:35:34 -08:00
$ docker plugin inspect tiborvass/sample-volume-plugin:latest
2020-04-19 15:43:08 +02:00
```
Output is in JSON format (output below is formatted for readability):
2017-02-07 15:42:48 -08:00
2020-04-19 15:43:08 +02:00
```json
2016-06-09 23:57:15 +02:00
{
2016-07-20 23:37:55 +02:00
"Id": "8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21",
2016-12-14 00:35:34 -08:00
"Name": "tiborvass/sample-volume-plugin:latest",
2017-01-28 16:54:32 -08:00
"PluginReference": "tiborvas/sample-volume-plugin:latest",
2016-08-04 16:19:46 -07:00
"Enabled": true,
2016-07-20 23:37:55 +02:00
"Config": {
"Mounts": [
{
"Name": "",
"Description": "",
"Settable": null,
"Source": "/data",
"Destination": "/data",
"Type": "bind",
"Options": [
"shared",
"rbind"
2016-06-09 23:57:15 +02:00
]
2016-07-20 23:37:55 +02:00
},
{
"Name": "",
"Description": "",
"Settable": null,
"Source": null,
"Destination": "/foobar",
"Type": "tmpfs",
"Options": null
}
],
"Env": [
"DEBUG=1"
],
"Args": null,
"Devices": null
},
"Manifest": {
"ManifestVersion": "v0",
"Description": "A test plugin for Docker",
"Documentation": "https://docs.docker.com/engine/extend/plugins/",
"Interface": {
"Types": [
"docker.volumedriver/1.0"
],
"Socket": "plugins.sock"
2016-06-09 23:57:15 +02:00
},
2016-07-20 23:37:55 +02:00
"Entrypoint": [
2016-12-14 00:35:34 -08:00
"plugin-sample-volume-plugin",
2016-07-20 23:37:55 +02:00
"/data"
],
"Workdir": "",
"User": {
2016-06-09 23:57:15 +02:00
},
2016-07-20 23:37:55 +02:00
"Network": {
"Type": "host"
},
"Capabilities": null,
"Mounts": [
{
"Name": "",
"Description": "",
"Settable": null,
"Source": "/data",
"Destination": "/data",
"Type": "bind",
"Options": [
"shared",
"rbind"
]
},
{
"Name": "",
"Description": "",
"Settable": null,
"Source": null,
"Destination": "/foobar",
"Type": "tmpfs",
"Options": null
}
],
"Devices": [
{
"Name": "device",
"Description": "a host device to mount",
"Settable": null,
"Path": "/dev/cpu_dma_latency"
}
],
"Env": [
{
"Name": "DEBUG",
"Description": "If set, prints debug messages",
"Settable": null,
"Value": "1"
}
],
"Args": {
"Name": "args",
"Description": "command line arguments",
"Settable": null,
"Value": [
]
}
}
2016-06-09 23:57:15 +02:00
}
```
2017-02-07 15:42:48 -08:00
2016-06-09 23:57:15 +02:00
2023-01-06 19:28:29 +01:00
### <a name="format"></a> Format the output (--format)
2016-06-09 23:57:15 +02:00
2021-08-21 14:54:14 +02:00
```console
2016-12-14 00:35:34 -08:00
$ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest
2017-02-07 15:42:48 -08:00
2016-08-17 04:52:27 -07:00
8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21
```
2017-02-07 15:42:48 -08:00
## Related commands
2016-06-09 23:57:15 +02:00
2016-10-04 12:01:19 -07:00
* [plugin create ](plugin_create.md )
2016-06-09 23:57:15 +02:00
* [plugin enable ](plugin_enable.md )
* [plugin disable ](plugin_disable.md )
* [plugin install ](plugin_install.md )
2016-11-14 08:38:06 -08:00
* [plugin ls ](plugin_ls.md )
* [plugin push ](plugin_push.md )
2016-06-09 23:57:15 +02:00
* [plugin rm ](plugin_rm.md )
2016-10-31 17:07:05 -07:00
* [plugin set ](plugin_set.md )
2017-01-28 16:54:32 -08:00
* [plugin upgrade ](plugin_upgrade.md )