github.com/pwn-term/docker@v0.0.0-20210616085119-6e977cce2565/cli/docs/reference/commandline/plugin_inspect.md (about)

     1  ---
     2  title: "plugin inspect"
     3  description: "The plugin inspect command description and usage"
     4  keywords: "plugin, inspect"
     5  ---
     6  
     7  # plugin inspect
     8  
     9  ```markdown
    10  Usage:  docker plugin inspect [OPTIONS] PLUGIN [PLUGIN...]
    11  
    12  Display detailed information on one or more plugins
    13  
    14  Options:
    15    -f, --format string   Format the output using the given Go template
    16        --help            Print usage
    17  ```
    18  
    19  ## Description
    20  
    21  Returns information about a plugin. By default, this command renders all results
    22  in a JSON array.
    23  
    24  ## Examples
    25  
    26  ### Inspect a plugin
    27  
    28  The following example example inspects the `tiborvass/sample-volume-plugin` plugin:
    29  
    30  ```bash
    31  $ docker plugin inspect tiborvass/sample-volume-plugin:latest
    32  ```
    33  
    34  Output is in JSON format (output below is formatted for readability):
    35  
    36  ```json
    37  {
    38    "Id": "8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21",
    39    "Name": "tiborvass/sample-volume-plugin:latest",
    40    "PluginReference": "tiborvas/sample-volume-plugin:latest",
    41    "Enabled": true,
    42    "Config": {
    43      "Mounts": [
    44        {
    45          "Name": "",
    46          "Description": "",
    47          "Settable": null,
    48          "Source": "/data",
    49          "Destination": "/data",
    50          "Type": "bind",
    51          "Options": [
    52            "shared",
    53            "rbind"
    54          ]
    55        },
    56        {
    57          "Name": "",
    58          "Description": "",
    59          "Settable": null,
    60          "Source": null,
    61          "Destination": "/foobar",
    62          "Type": "tmpfs",
    63          "Options": null
    64        }
    65      ],
    66      "Env": [
    67        "DEBUG=1"
    68      ],
    69      "Args": null,
    70      "Devices": null
    71    },
    72    "Manifest": {
    73      "ManifestVersion": "v0",
    74      "Description": "A test plugin for Docker",
    75      "Documentation": "https://docs.docker.com/engine/extend/plugins/",
    76      "Interface": {
    77        "Types": [
    78          "docker.volumedriver/1.0"
    79        ],
    80        "Socket": "plugins.sock"
    81      },
    82      "Entrypoint": [
    83        "plugin-sample-volume-plugin",
    84        "/data"
    85      ],
    86      "Workdir": "",
    87      "User": {
    88      },
    89      "Network": {
    90        "Type": "host"
    91      },
    92      "Capabilities": null,
    93      "Mounts": [
    94        {
    95          "Name": "",
    96          "Description": "",
    97          "Settable": null,
    98          "Source": "/data",
    99          "Destination": "/data",
   100          "Type": "bind",
   101          "Options": [
   102            "shared",
   103            "rbind"
   104          ]
   105        },
   106        {
   107          "Name": "",
   108          "Description": "",
   109          "Settable": null,
   110          "Source": null,
   111          "Destination": "/foobar",
   112          "Type": "tmpfs",
   113          "Options": null
   114        }
   115      ],
   116      "Devices": [
   117        {
   118          "Name": "device",
   119          "Description": "a host device to mount",
   120          "Settable": null,
   121          "Path": "/dev/cpu_dma_latency"
   122        }
   123      ],
   124      "Env": [
   125        {
   126          "Name": "DEBUG",
   127          "Description": "If set, prints debug messages",
   128          "Settable": null,
   129          "Value": "1"
   130        }
   131      ],
   132      "Args": {
   133        "Name": "args",
   134        "Description": "command line arguments",
   135        "Settable": null,
   136        "Value": [
   137  
   138        ]
   139      }
   140    }
   141  }
   142  ```
   143  
   144  
   145  ### Formatting the output
   146  
   147  ```bash
   148  $ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest
   149  
   150  8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21
   151  ```
   152  
   153  ## Related commands
   154  
   155  * [plugin create](plugin_create.md)
   156  * [plugin enable](plugin_enable.md)
   157  * [plugin disable](plugin_disable.md)
   158  * [plugin install](plugin_install.md)
   159  * [plugin ls](plugin_ls.md)
   160  * [plugin push](plugin_push.md)
   161  * [plugin rm](plugin_rm.md)
   162  * [plugin set](plugin_set.md)
   163  * [plugin upgrade](plugin_upgrade.md)