mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
CLI docs and examples of format
This commit is contained in:
parent
1d503be466
commit
4ad3dfb05f
1 changed files with 48 additions and 0 deletions
|
@ -659,6 +659,54 @@ Insert file from github
|
||||||
|
|
||||||
Return low-level information on a container
|
Return low-level information on a container
|
||||||
|
|
||||||
|
-format="": template to output results
|
||||||
|
|
||||||
|
By default, this will render all results in a JSON array. If a format
|
||||||
|
is specified, the given template will be executed for each result.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
docker inspect -format='{{.NetworkSettings.IPAddress}}' $INSTANCE_ID
|
||||||
|
|
||||||
|
List All Port Bindings
|
||||||
|
......................
|
||||||
|
|
||||||
|
One can loop over arrays and maps in the results to produce simple
|
||||||
|
text output:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
docker inspect -format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' $INSTANCE_ID
|
||||||
|
|
||||||
|
Find a Specific Port Mapping
|
||||||
|
............................
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
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
|
||||||
|
mappings to a list of external address/port objects, so to grab just
|
||||||
|
the numeric public port, you use ``index`` to find the specific port
|
||||||
|
map, and then ``index`` 0 contains first object inside of that. Then
|
||||||
|
we ask for the ``HostPort`` field to get the public address.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
docker inspect -format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID
|
||||||
|
|
||||||
.. _cli_kill:
|
.. _cli_kill:
|
||||||
|
|
||||||
``kill``
|
``kill``
|
||||||
|
|
Loading…
Add table
Reference in a new issue