docker volume inspectコマンドの使い方(実例付)

Docker公式ロゴ3b
©2023 Docker Inc. All rights reserved

 本記事はDocker ver24.0.7の環境で確認しています。

 このコマンドは、データボリュームの様々な属性情報を表示できます。

 オプションで、指定した属性のみ出力することも可能です。

 dockerのデータボリュームにつきましては、別記事「docker volume createコマンドの使い方(実例付)」をご参照ください。

docker volume inspectコマンドのフォーマットとオプション

フォーマット

docker volume inspect [オプション] [データボリューム名] ...

主なオプション一覧

オプション概説
-f, --format=[] 出力フォーマットを指定する

コマンド例

$ docker volume inspect testvol01

docker volume inspectコマンドの主な使い方

 以下で実例をまじえたコマンドの使い方を解説していきたいと思います。

実例では、Ubuntuの公式イメージにより起動したコンテナ(testvm)を使用します。

コンテナは「docker run -dit --init --name testvm ubuntu」で起動します。

※「--rm」オプションを付けておりませんので、ご利用後はコンテナ削除をお忘れなく。

基本事項の解説

 docker volume inspectコマンドは、指定したデータボリュームの属性情報を出力します。

 例えば、データボリュームのドライバ情報や記憶領域の物理パスなどが出力可能です。トラブル時の切り分けに使えそうですね。

 データボリューム作成時に付与したラベルを表示することも可能です。

データボリュームの属性情報の一覧を出力する

 データボリュームの属性情報を確認するため、以下のコマンドでデータボリュームtestvol01を作成します。

$ docker volume create --label testlabel=aaa testvol01

※「docker volume create」コマンドにつきましては別記事「docker volume createコマンドの使い方(実例付)」を参照下さい

 データボリュームtestvol01の属性情報をvolume inspectコマンドで確認してみました。

$ docker volume inspect testvol01

 属性情報は以下のようなフォーマットで出力されます。

[
    {
        "CreatedAt": "2023-10-14T09:39:19+09:00",
        "Driver": "local",
        "Labels": {
            "testlabel": "aaa"
        },
        "Mountpoint": "/var/lib/docker/volumes/testvol01/_data",
        "Name": "testvol01",
        "Options": null,
        "Scope": "local"
    }
]

※各属性情報に関しましては、別記事「docker volume createコマンドの使い方(実例付)」をご参照ください。

オプションで出力フォーマットを指定する

 以下のコマンドを実行すると、「--format」オプションで指定した「Mountpoint」のみ出力されます。

$ docker volume inspect --format 'Mountpoint: {{.Mountpoint}}' testvol01

 結果は以下のように出力されます。

Mountpoint: /var/lib/docker/volumes/testvol01/_data

おわりに

  以上でdocker volume inspectコマンドの紹介を終わります。

 ご指摘、ご要望などが御座いましたらコメントいただけるとうれしいです。

 他のDockerコマンドの実例付紹介記事は、本サイト内の別記事「Dockerのコマンドの一覧(オリジナルな実例付き)」をご参照ください。

 最後までお読みいただきありがとうございました。

コメント