From 3c6718905cf5b58d7b6daa5ce49704ba9c866834 Mon Sep 17 00:00:00 2001 From: EG Noriega Date: Fri, 10 Mar 2017 12:08:41 -0500 Subject: [PATCH] Add details for inspect command usage Signed-off-by: Eric G. Noriega Signed-off-by: Vincent Demeester --- docs/reference/commandline/inspect.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index 842faf9b49..5b33b0ba19 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -30,13 +30,34 @@ Options: ## Description -By default, `docker inspect` 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. +Docker inspect provides detailed information on constructs controlled by Docker. + +By default, `docker inspect` will render results in a JSON array. + +## Request a custom response format (--format) + 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. +## Specify target type (--type) + +`--type 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 ambigious. + +To restrict `docker inspect` to a specific type of object, use the `--type` +option. + +The following example inspects a _volume_ named "myvolume" + +```bash +$ docker inspect --type=volume myvolume +``` + ## Examples ### Get an instance's IP address