1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
<h1>docker plugin ls</h1> <p><br></p> <p>List plugins</p> <h2 id="usage">Usage</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin ls [OPTIONS]
</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">Lists all the plugins that are currently installed. You can install plugins using the <a href="../plugin_install/index"><code class="language-plaintext highlighter-rouge">docker plugin install</code></a> command. You can also filter using the <code class="language-plaintext highlighter-rouge">-f</code> or <code class="language-plaintext highlighter-rouge">--filter</code> flag. Refer to the <a href="#filtering">filtering</a> section for more information about available filter options.</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">--filter</code> , <code class="language-plaintext highlighter-rouge">-f</code>
</td> <td></td> <td>Provide filter values (e.g. 'enabled=true')</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--format</code></td> <td></td> <td>Pretty-print plugins using a Go template</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--no-trunc</code></td> <td></td> <td>Don't truncate output</td> </tr> <tr> <td>
<code class="language-plaintext highlighter-rouge">--quiet</code> , <code class="language-plaintext highlighter-rouge">-q</code>
</td> <td></td> <td>Only display plugin IDs</td> </tr> </tbody> </table> <h2 id="examples">Examples</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin ls
ID NAME DESCRIPTION ENABLED
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
</pre></div> <h3 id="filtering">Filtering</h3> <p>The filtering flag (<code class="language-plaintext highlighter-rouge">-f</code> or <code class="language-plaintext highlighter-rouge">--filter</code>) format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., <code class="language-plaintext highlighter-rouge">--filter "foo=bar" --filter "bif=baz"</code>)</p> <p>The currently supported filters are:</p> <ul> <li>enabled (boolean - true or false, 0 or 1)</li> <li>capability (string - currently <code class="language-plaintext highlighter-rouge">volumedriver</code>, <code class="language-plaintext highlighter-rouge">networkdriver</code>, <code class="language-plaintext highlighter-rouge">ipamdriver</code>, <code class="language-plaintext highlighter-rouge">logdriver</code>, <code class="language-plaintext highlighter-rouge">metricscollector</code>, or <code class="language-plaintext highlighter-rouge">authz</code>)</li> </ul> <h4 id="enabled">enabled</h4> <p>The <code class="language-plaintext highlighter-rouge">enabled</code> filter matches on plugins enabled or disabled.</p> <h4 id="capability">capability</h4> <p>The <code class="language-plaintext highlighter-rouge">capability</code> filter matches on plugin capabilities. One plugin might have multiple capabilities. Currently <code class="language-plaintext highlighter-rouge">volumedriver</code>, <code class="language-plaintext highlighter-rouge">networkdriver</code>, <code class="language-plaintext highlighter-rouge">ipamdriver</code>, <code class="language-plaintext highlighter-rouge">logdriver</code>, <code class="language-plaintext highlighter-rouge">metricscollector</code>, and <code class="language-plaintext highlighter-rouge">authz</code> are supported capabilities.</p> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin install --disable vieux/sshfs
Installed plugin vieux/sshfs
$ docker plugin ls --filter enabled=true
ID NAME DESCRIPTION ENABLED
</pre></div> <h3 id="formatting">Formatting</h3> <p>The formatting options (<code class="language-plaintext highlighter-rouge">--format</code>) pretty-prints plugins output using a Go template.</p> <p>Valid placeholders for the Go template are listed below:</p> <table> <thead> <tr> <th>Placeholder</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">.ID</code></td> <td>Plugin ID</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.Name</code></td> <td>Plugin name and tag</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.Description</code></td> <td>Plugin description</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.Enabled</code></td> <td>Whether plugin is enabled or not</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.PluginReference</code></td> <td>The reference used to push/pull from a registry</td> </tr> </tbody> </table> <p>When using the <code class="language-plaintext highlighter-rouge">--format</code> option, the <code class="language-plaintext highlighter-rouge">plugin ls</code> command will either output the data exactly as the template declares or, when using the <code class="language-plaintext highlighter-rouge">table</code> directive, includes column headers as well.</p> <p>The following example uses a template without headers and outputs the <code class="language-plaintext highlighter-rouge">ID</code> and <code class="language-plaintext highlighter-rouge">Name</code> entries separated by a colon (<code class="language-plaintext highlighter-rouge">:</code>) for all plugins:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker plugin ls --format "{{.ID}}: {{.Name}}"
4be01827a72e: vieux/sshfs:latest
</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="../plugin_inspect/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="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">
© 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_ls/" class="_attribution-link">https://docs.docker.com/engine/reference/commandline/plugin_ls/</a>
</p>
</div>
|
