Docker-Docs/_data/engine-cli/docker_volume_inspect.yaml

65 lines
1.6 KiB
YAML

command: docker volume inspect
short: Display detailed information on one or more volumes
long: |-
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](http://golang.org/pkg/text/template/) package describes all the
details of the format.
usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...]
pname: docker volume
plink: docker_volume.yaml
options:
- option: format
shorthand: f
value_type: string
description: Format the output using the given Go template
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
```bash
$ docker volume create myvolume
myvolume
```
Use the `docker volume inspect` comment to inspect the configuration of the volume:
```bash
$ docker volume inspect myvolume
```
The output is in JSON format, for example:
```json
[
{
"CreatedAt": "2020-04-19T11:00:21Z",
"Driver": "local",
"Labels": {},
"Mountpoint": "/var/lib/docker/volumes/8140a838303144125b4f54653b47ede0486282c623c3551fbc7f390cdc3e9cf5/_data",
"Name": "myvolume",
"Options": {},
"Scope": "local"
}
]
```
Use the `--format` flag to format the output using a Go template, for example,
to print the `Mountpoint` property:
```bash
$ docker volume inspect --format '{{ .Mountpoint }}' myvolume
/var/lib/docker/volumes/myvolume/_data
```
deprecated: false
min_api_version: "1.21"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false