79c9e527a3
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>
71 lines
2.4 KiB
Markdown
71 lines
2.4 KiB
Markdown
# volume inspect
|
|
|
|
<!---MARKER_GEN_START-->
|
|
Display detailed information on one or more volumes
|
|
|
|
### Options
|
|
|
|
| Name | Type | Default | Description |
|
|
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
|
|
|
|
|
|
<!---MARKER_GEN_END-->
|
|
|
|
## 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](https://golang.org/pkg/text/template/) package describes all the
|
|
details of the format.
|
|
|
|
## Examples
|
|
|
|
```console
|
|
$ docker volume create myvolume
|
|
|
|
myvolume
|
|
```
|
|
|
|
Use the `docker volume inspect` comment to inspect the configuration of the volume:
|
|
|
|
```console
|
|
$ 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"
|
|
}
|
|
]
|
|
```
|
|
|
|
### <a name="format"></a> Format the output (--format)
|
|
|
|
Use the `--format` flag to format the output using a Go template, for example,
|
|
to print the `Mountpoint` property:
|
|
|
|
```console
|
|
$ docker volume inspect --format '{{ .Mountpoint }}' myvolume
|
|
|
|
/var/lib/docker/volumes/myvolume/_data
|
|
```
|
|
|
|
## Related commands
|
|
|
|
* [volume create](volume_create.md)
|
|
* [volume ls](volume_ls.md)
|
|
* [volume rm](volume_rm.md)
|
|
* [volume prune](volume_prune.md)
|
|
* [Understand Data Volumes](https://docs.docker.com/storage/volumes/)
|