2015-06-21 20:41:38 +00:00
|
|
|
<!--[metadata]>
|
|
|
|
+++
|
|
|
|
title = "inspect"
|
|
|
|
description = "The inspect command description and usage"
|
|
|
|
keywords = ["inspect, container, json"]
|
|
|
|
[menu.main]
|
|
|
|
parent = "smn_cli"
|
|
|
|
+++
|
|
|
|
<![end-metadata]-->
|
|
|
|
|
|
|
|
# inspect
|
|
|
|
|
|
|
|
Usage: docker inspect [OPTIONS] CONTAINER|IMAGE [CONTAINER|IMAGE...]
|
|
|
|
|
|
|
|
Return low-level information on a container or image
|
|
|
|
|
2015-10-03 15:56:41 +00:00
|
|
|
-f, --format="" Format the output using the given go template
|
2015-12-23 14:37:06 +00:00
|
|
|
--help Print usage
|
2015-10-03 15:56:41 +00:00
|
|
|
--type=container|image Return JSON for specified type, permissible
|
|
|
|
values are "image" or "container"
|
2015-12-23 14:37:06 +00:00
|
|
|
-s, --size Display total file sizes if the type is container
|
2015-06-26 14:47:31 +00:00
|
|
|
|
2015-12-28 08:29:39 +00:00
|
|
|
By default, this will render all results in a JSON array. If the container and
|
|
|
|
image have the same name, this will return container JSON for unspecified type.
|
|
|
|
If a format is specified, the given template will be executed for each result.
|
2015-06-21 20:41:38 +00:00
|
|
|
|
|
|
|
Go's [text/template](http://golang.org/pkg/text/template/) package
|
|
|
|
describes all the details of the format.
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
**Get an instance's IP address:**
|
|
|
|
|
|
|
|
For the most part, you can pick out any field from the JSON in a fairly
|
|
|
|
straightforward manner.
|
|
|
|
|
2015-09-30 20:11:36 +00:00
|
|
|
$ docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $INSTANCE_ID
|
2015-06-21 20:41:38 +00:00
|
|
|
|
|
|
|
**Get an instance's MAC Address:**
|
|
|
|
|
|
|
|
For the most part, you can pick out any field from the JSON in a fairly
|
|
|
|
straightforward manner.
|
|
|
|
|
2015-09-30 20:11:36 +00:00
|
|
|
$ docker inspect '{{range .NetworkSettings.Networks}}{{.MacAddress}}{{end}}' $INSTANCE_ID
|
2015-06-21 20:41:38 +00:00
|
|
|
|
|
|
|
**Get an instance's log path:**
|
|
|
|
|
|
|
|
$ docker inspect --format='{{.LogPath}}' $INSTANCE_ID
|
|
|
|
|
|
|
|
**List All Port Bindings:**
|
|
|
|
|
|
|
|
One can loop over arrays and maps in the results to produce simple text
|
|
|
|
output:
|
|
|
|
|
|
|
|
$ docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' $INSTANCE_ID
|
|
|
|
|
|
|
|
**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.Ports` section contains a map of the internal port
|
2015-09-30 20:11:36 +00:00
|
|
|
mappings to a list of external address/port objects. To grab just the
|
2015-06-21 20:41:38 +00:00
|
|
|
numeric public port, you use `index` to find the specific port map, and
|
|
|
|
then `index` 0 contains the first object inside of that. Then we ask for
|
|
|
|
the `HostPort` field to get the public address.
|
|
|
|
|
|
|
|
$ docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID
|
|
|
|
|
2015-12-15 13:35:55 +00:00
|
|
|
**Get a subsection in JSON format:**
|
2015-06-21 20:41:38 +00:00
|
|
|
|
2015-12-15 13:35:55 +00:00
|
|
|
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.
|
2015-06-21 20:41:38 +00:00
|
|
|
|
2015-12-15 13:35:55 +00:00
|
|
|
$ docker inspect --format='{{json .Config}}' $INSTANCE_ID
|