docker/cli

mirror of https://github.com/docker/cli.git synced 2025-09-11 06:30:44 +03:00

Files

Kevin Alvarez 79c9e527a3 docs: generate markdown

Keep frontmatter for docker, dockerd and index markdown files.
Also needs to move cli.md > docker.md before generation and
then move it back because cli.md is needed for yaml generation on docs
website: https://github.com/docker/cli/pull/3924#discussion_r1059986605

Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

2023-01-06 22:36:47 +01:00

2.4 KiB

Raw Blame History

volume inspect

Display detailed information on one or more volumes

Options

Name	Type	Default	Description
`-f`, `--format`	`string`		Format output using a custom template: 'json': Print in JSON format 'TEMPLATE': Print output using the given Go template. Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates

Description

Returns information about a volume. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a given template for each result. Go's text/template package describes all the details of the format.

Examples

$ docker volume create myvolume

myvolume

Use the docker volume inspect comment to inspect the configuration of the volume:

$ docker volume inspect myvolume

The output is in JSON format, for example:

[
  {
    "CreatedAt": "2020-04-19T11:00:21Z",
    "Driver": "local",
    "Labels": {},
    "Mountpoint": "/var/lib/docker/volumes/8140a838303144125b4f54653b47ede0486282c623c3551fbc7f390cdc3e9cf5/_data",
    "Name": "myvolume",
    "Options": {},
    "Scope": "local"
  }
]

Format the output (--format)

Use the --format flag to format the output using a Go template, for example, to print the Mountpoint property:

$ docker volume inspect --format '{{ .Mountpoint }}' myvolume

/var/lib/docker/volumes/myvolume/_data

2.4 KiB Raw Blame History