docker plugin ls

プラグインを一覧表示します。

【API 1.25+】このコマンドを使うには、クライアントとデーモン API の両方が、少なくとも 1.25 の必要があります。クライアントとデーモン API のバージョンを調べるには、 docker version コマンドを使います。

使い方

$ docker plugin ls [OPTIONS]

補足説明

インストール済みの全てのプラグインを表示します。 docker plugin install コマンドでプラグインをインストールできます。 -f--filter フラグを使ってフィルタもできます。利用可能なフィルタのオプションに関する情報は、 フィルタリング のセクションをご覧ください。

コマンドの使用例は、以下の 使用例のセクション をご覧ください。

オプション

名前, 省略形

デフォルト

説明

--filter , -f

フィルタの値を指定(例: enabled=true

--format

Go テンプレートを使ってプラグインの出力を整形

--no-trunc

出力を省略しない

--quiet , -q

プラグイン ID のみ表示

使用例

$ docker plugin ls

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

フィルタリング

フィルタリングのフラグ( -f--filter )は「key=value」の形式です。複数のフィルタを使うには、複数回フラグを使います(例: --filter "foo=bar" --filter "bif=baz" )。

現時点でサポートしているフィルタは、

  • enabled (ブール値 - true か false 、0 か 1)

  • capability (文字列 - 現時点では volumedrivernetworkdriveripamdriverlogdrivermetricscollectorauthz

enabled

enabled フィルタは、有効化か無効化に一致するプラグインを表示します。

capability

capability フィルタはプラグインのケーパビリティに一致します。1つのプラグインは、複数のケーパビリティを持ち得ます。現時点でサポートされているケーパビリティは、 volumedrivernetworkdriveripamdriverlogdrivermetricscollectorauthz です。

$ docker plugin install --disable vieux/sshfs

Installed plugin vieux/sshfs

$ docker plugin ls --filter enabled=true

ID                  NAME                DESCRIPTION         ENABLED

表示形式

フォーマットのオプション( --format )は Go テンプレートを使いプラグインの出力を整形します。

Go テンプレートで置き換え可能な一覧は、次の通りです:

.ID

プラグイン ID

.Name

プラグイン名とタグ

.Description

プラグイン説明

.Enabled

プラグインが有効かどうか

.PluginReference

レジストリから push または pull のために使うリファレンス

plugin ls コマンドに --format オプションを使えば、テンプレートで指定したデータを出力するだけでなく、 table 命令を使うとカラム(例)ヘッダも同様に表示します。

次の例はヘッダを除くテンプレートを使い、実行中の全てのコンテナに対して、 IDName エントリを句切って出力します。

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

4be01827a72e: vieux/sshfs:latest

親コマンド

コマンド

説明

docker plugin

プラグインを管理

関連コマンド

コマンド

説明

docker plugin create

rootfs と設定からプラグインを作成。プラグインのデータディレクトリには、 config.json と rootfs ディレクトリが必須

docker plugin disable

プラグインの無効化

docker plugin enable

プラグインの有効化

docker plugin inspect

1つまたは複数プラグインの詳細情報を表示

docker plugin install

プラグインをインストール

docker plugin ls

プラグイン一覧表示

docker plugin rm

1つまたは複数プラグインを削除

docker plugin set

プラグインの設定を変更

docker plugin upgrade

既存のプラグインを更新