docker plugin ls

Estimated reading time: 3 minutes

Description

List plugins

API 1.25+ The client and daemon API must both be at least 1.25 to use this command. Use the docker version command on the client to check your client and daemon API versions.

Usage

docker plugin ls [OPTIONS]

Options

Name, shorthand	Default	Description
`--filter , -f`		Provide filter values (e.g. ‘enabled=true’)
`--format`		Pretty-print plugins using a Go template
`--no-trunc`		Don’t truncate output
`--quiet , -q`		Only display plugin IDs

Parent command

Command	Description
docker plugin	Manage plugins

Command	Description
docker plugin create	Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory.
docker plugin disable	Disable a plugin
docker plugin enable	Enable a plugin
docker plugin inspect	Display detailed information on one or more plugins
docker plugin install	Install a plugin
docker plugin ls	List plugins
docker plugin push	Push a plugin to a registry
docker plugin rm	Remove one or more plugins
docker plugin set	Change settings for a plugin
docker plugin upgrade	Upgrade an existing plugin

Extended description

Lists all the plugins that are currently installed. You can install plugins using the docker plugin install command. You can also filter using the -f or --filter flag. Refer to the filtering section for more information about available filter options.

Examples

$ docker plugin ls

ID                  NAME                             TAG                 DESCRIPTION                ENABLED
69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   true

Filtering

The filtering flag (-f or --filter) format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz")

The currently supported filters are:

enabled (boolean - true or false, 0 or 1)
capability (string - currently volumedriver, networkdriver, ipamdriver, logdriver, metricscollector, or authz)

enabled

The enabled filter matches on plugins enabled or disabled.

capability

The capability filter matches on plugin capabilities. One plugin might have multiple capabilities. Currently volumedriver, networkdriver, ipamdriver, logdriver, metricscollector, and authz are supported capabilities.

$ docker plugin install --disable vieux/sshfs

Installed plugin vieux/sshfs

$ docker plugin ls --filter enabled=true

NAME                  TAG                 DESCRIPTION                ENABLED

Formatting

The formatting options (--format) pretty-prints plugins output using a Go template.

Valid placeholders for the Go template are listed below:

Placeholder	Description
`.ID`	Plugin ID
`.Name`	Plugin name
`.Description`	Plugin description
`.Enabled`	Whether plugin is enabled or not
`.PluginReference`	The reference used to push/pull from a registry

When using the --format option, the plugin ls command will either output the data exactly as the template declares or, when using the table directive, includes column headers as well.

The following example uses a template without headers and outputs the ID and Name entries separated by a colon for all plugins:

$ docker plugin ls --format "{{.ID}}: {{.Name}}"

4be01827a72e: vieux/sshfs:latest