summaryrefslogtreecommitdiff
path: root/devdocs/docker/engine%2Freference%2Fcommandline%2Fplugin_inspect%2Findex.html
diff options
context:
space:
mode:
Diffstat (limited to 'devdocs/docker/engine%2Freference%2Fcommandline%2Fplugin_inspect%2Findex.html')
-rw-r--r--devdocs/docker/engine%2Freference%2Fcommandline%2Fplugin_inspect%2Findex.html118
1 files changed, 0 insertions, 118 deletions
diff --git a/devdocs/docker/engine%2Freference%2Fcommandline%2Fplugin_inspect%2Findex.html b/devdocs/docker/engine%2Freference%2Fcommandline%2Fplugin_inspect%2Findex.html
deleted file mode 100644
index 60c7b0eb..00000000
--- a/devdocs/docker/engine%2Freference%2Fcommandline%2Fplugin_inspect%2Findex.html
+++ /dev/null
@@ -1,118 +0,0 @@
-<h1>docker plugin inspect</h1> <p><br></p> <p>Display detailed information on one or more plugins</p> <h2 id="usage">Usage</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin inspect [OPTIONS] PLUGIN [PLUGIN...]
-</pre></div> <p>Refer to the <a href="#options">options section</a> for an overview of available <a href="#options"><code class="language-plaintext highlighter-rouge">OPTIONS</code></a> for this command.</p> <h2 id="description">Description</h2> <p name="extended-description">Returns information about a plugin. By default, this command renders all results in a JSON array.</p> <p>For example uses of this command, refer to the <a href="#examples">examples section</a> below.</p> <h2 id="options">Options</h2> <table> <thead> <tr> <td>Name, shorthand</td> <td>Default</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>
-<code class="language-plaintext highlighter-rouge">--format</code> , <code class="language-plaintext highlighter-rouge">-f</code>
-</td> <td></td> <td>Format the output using the given Go template</td> </tr> </tbody> </table> <h2 id="examples">Examples</h2> <h3 id="inspect-a-plugin">Inspect a plugin</h3> <p>The following example example inspects the <code class="language-plaintext highlighter-rouge">tiborvass/sample-volume-plugin</code> plugin:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin inspect tiborvass/sample-volume-plugin:latest
-</pre></div> <p>Output is in JSON format (output below is formatted for readability):</p> <div class="highlight"><pre class="highlight" data-language="">{
- "Id": "8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21",
- "Name": "tiborvass/sample-volume-plugin:latest",
- "PluginReference": "tiborvas/sample-volume-plugin:latest",
- "Enabled": true,
- "Config": {
- "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
- }
- ],
- "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"
- },
- "Entrypoint": [
- "plugin-sample-volume-plugin",
- "/data"
- ],
- "Workdir": "",
- "User": {
- },
- "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": [
-
- ]
- }
- }
-}
-</pre></div> <h3 id="formatting-the-output">Formatting the output</h3> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest
-
-8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21
-</pre></div> <h2 id="parent-command">Parent command</h2> <table> <thead> <tr> <th style="text-align: left">Command</th> <th style="text-align: left">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left"><a href="../plugin/index">docker plugin</a></td> <td style="text-align: left">Manage plugins</td> </tr> </tbody> </table> <h2 id="related-commands">Related commands</h2> <table> <thead> <tr> <td>Command</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td><a href="../plugin_create/index">docker plugin create</a></td> <td>Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory.</td> </tr> <tr> <td><a href="../plugin_disable/index">docker plugin disable</a></td> <td>Disable a plugin</td> </tr> <tr> <td><a href="../plugin_enable/index">docker plugin enable</a></td> <td>Enable a plugin</td> </tr> <tr> <td><a href="index">docker plugin inspect</a></td> <td>Display detailed information on one or more plugins</td> </tr> <tr> <td><a href="../plugin_install/index">docker plugin install</a></td> <td>Install a plugin</td> </tr> <tr> <td><a href="../plugin_ls/index">docker plugin ls</a></td> <td>List plugins</td> </tr> <tr> <td><a href="../plugin_push/index">docker plugin push</a></td> <td>Push a plugin to a registry</td> </tr> <tr> <td><a href="../plugin_rm/index">docker plugin rm</a></td> <td>Remove one or more plugins</td> </tr> <tr> <td><a href="../plugin_set/index">docker plugin set</a></td> <td>Change settings for a plugin</td> </tr> <tr> <td><a href="../plugin_upgrade/index">docker plugin upgrade</a></td> <td>Upgrade an existing plugin</td> </tr> </tbody> </table> <div class="_attribution">
- <p class="_attribution-p">
- &copy; 2019 Docker, Inc.<br>Licensed under the Apache License, Version 2.0.<br>Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br>Docker, Inc. and other parties may also have trademark rights in other terms used herein.<br>
- <a href="https://docs.docker.com/engine/reference/commandline/plugin_inspect/" class="_attribution-link">https://docs.docker.com/engine/reference/commandline/plugin_inspect/</a>
- </p>
-</div>