docker inspect (original) (raw)
| Description | Return low-level information on Docker objects |
|---|---|
| Usage | docker inspect [OPTIONS] NAME|ID [NAME |
Docker inspect provides detailed information on constructs controlled by Docker.
By default, docker inspect will render results in a JSON array.
Format the output (--format)
If a format is specified, the given template will be executed for each result.
Go'stext/template package describes all the details of the format.
Specify target type (--type)
--type config|container|image|node|network|secret|service|volume|task|plugin
The docker inspect command matches any type of object by either ID or name. In some cases multiple type of objects (for example, a container and a volume) exist with the same name, making the result ambiguous.
To restrict docker inspect to a specific type of object, use the --typeoption.
The following example inspects a volume named myvolume.
Inspect the size of a container (-s, --size)
The --size, or short-form -s, option adds two additional fields to thedocker inspect output. This option only works for containers. The container doesn't have to be running, it also works for stopped containers.
The output includes the full output of a regular docker inspect command, with the following additional fields:
SizeRootFs: the total size of all the files in the container, in bytes.SizeRw: the size of the files that have been created or changed in the container, compared to it's image, in bytes.
| Option | Default | Description |
|---|---|---|
| -f, --format | Format output using a custom template:'json': Print in JSON format'TEMPLATE': Print output using the given Go template.Refer tohttps://docs.docker.com/go/formatting/ for more information about formatting output with templates | |
| -s, --size | Display total file sizes if the type is container | |
| --type | Return JSON for specified type |
Get an instance's IP address
For the most part, you can pick out any field from the JSON in a fairly straightforward manner.
Get an instance's MAC address
Get an instance's log path
Get an instance's image name
List all port bindings
You can loop over arrays and maps in the results to produce simple text output:
Find a specific port mapping
The .Field syntax doesn't work when the field name begins with a number, but the template language's index function does. The .NetworkSettings.Portssection contains a map of the internal port mappings to a list of external address/port objects. To grab just the numeric public port, you use index to find the specific port map, and then index 0 contains the first object inside of that. Then, specify the HostPort field to get the public address.
Get a subsection in JSON format
If you request a field which is itself a structure containing other fields, by default you get a Go-style dump of the inner values. Docker adds a template function, json, which can be applied to get results in JSON format.