docker plugin ls
読む時間の目安: 2 分
説明
プラグインを一覧表示します。
API 1.25 以上
このコマンドを利用するには、クライアントとデーモンの API はともに、最低でも
1.25
である必要があります。
クライアント上においてdocker version
コマンドを実行して、クライアントとデーモンの API バージョンを確認してください。
利用方法
$ docker plugin ls [オプション]
追加説明
現在インストールされているプラグインの一覧を表示します。
プラグインのインストールには 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
)の指定書式は「キー=値」というものです。
複数のフィルターが必要な場合は、フラグを複数指定します。
(たとえば--filter "foo=bar" --filter "bif=baz"
など。)
現在サポートされているフィルターは以下のとおりです。
- enabled (ブール値。true または false、0 または 1)
- capability (文字列。現在のところ以下のいずれか。
volumedriver
、networkdriver
、ipamdriver
、logdriver
、metricscollector
、authz
)
enabled
enabled
フィルターは、有効プラグインまたは無効プラグインを検索します。
capability
capability
フィルターはプラグインのケーパビリティーを検索します。
プラグインは複数のケーパビリティーを持つことがあります。
現在のところサポートされているケーパビリティーは以下です。
volumedriver
、networkdriver
、ipamdriver
、logdriver
、metricscollector
、authz
$ docker plugin install --disable vieux/sshfs
Installed plugin vieux/sshfs
$ docker plugin ls --filter enabled=true
ID NAME DESCRIPTION ENABLED
フォーマット設定
フォーマット設定オプション(--format
)により Go 言語のテンプレートを利用して、プラグインをわかりやすく出力することができます。
Go 言語テンプレートによるプレースホルダー(placeholder)は以下のとおりです。
プレースホルダー | 内容説明 |
---|---|
.ID |
プラグイン ID。 |
.Name |
プラグイン名とタグ。 |
.Description |
プラグインの内容説明。 |
.Enabled |
プラグインが有効であるかどうか。 |
.PluginReference |
レジストリに対するプッシュ、プルにおいて利用される参照名。 |
--format
オプションを利用するとplugin ls
コマンドは、テンプレートが定めるデータを直接出力します。
またtable
ディレクティブを利用すると、カラムヘッダーも同時に出力されます。
以下は、ヘッダーを含めずにテンプレートを利用する例であり、すべてのプラグインにおけるID
、Name
の各項目がコロン(:
)で区切って表示されます。
$ 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 push | レジストリにプラグインをプッシュします。 |
docker plugin rm | 1 つまたは複数のプラグインを削除します。 |
docker plugin set | プラグインの設定を変更します。 |
docker plugin upgrade | 既存プラグインをアップグレードします。 |