File: podman-volume-inspect.1.md

package info (click to toggle)
podman 5.4.2%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 23,124 kB
  • sloc: sh: 6,119; perl: 2,710; python: 2,258; ansic: 1,556; makefile: 1,022; xml: 121; ruby: 42; awk: 12; csh: 8
file content (104 lines) | stat: -rw-r--r-- 3,960 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
% podman-volume-inspect 1

## NAME
podman\-volume\-inspect - Get detailed information on one or more volumes

## SYNOPSIS
**podman volume inspect** [*options*] *volume* [...]

## DESCRIPTION

Display detailed information on one or more volumes. The output can be formatted using
the **--format** flag and a Go template. To get detailed information about all the
existing volumes, use the **--all** flag.
Volumes can be queried individually by providing their full name or a unique partial name.


## OPTIONS

#### **--all**, **-a**

Inspect all volumes.

#### **--format**, **-f**=*format*

Format volume output using Go template

Valid placeholders for the Go template are listed below:

| **Placeholder**     | **Description**                                                             |
| ------------------- | --------------------------------------------------------------------------- |
| .Anonymous          | Indicates whether volume is anonymous                                       |
| .CreatedAt ...      | Volume creation time                                                        |
| .Driver             | Volume driver                                                               |
| .GID                | GID the volume was created with                                             |
| .Labels ...         | Label information associated with the volume                                |
| .LockNumber         | Number of the volume's Libpod lock                                          |
| .MountCount         | Number of times the volume is mounted                                       |
| .Mountpoint         | Source of volume mount point                                                |
| .Name               | Volume name                                                                 |
| .NeedsChown         | Indicates volume will be chowned on next use                                |
| .NeedsCopyUp        | Indicates data at the destination will be copied into the volume on next use|
| .Options ...        | Volume options                                                              |
| .Scope              | Volume scope                                                                |
| .Status ...         | Status of the volume                                                        |
| .StorageID          | StorageID of the volume                                                     |
| .Timeout            | Timeout of the volume                                                       |
| .UID                | UID the volume was created with                                             |

#### **--help**

Print usage statement


## EXAMPLES

Inspect named volume.
```
$ podman volume inspect myvol
[
     {
          "Name": "myvol",
          "Driver": "local",
          "Mountpoint": "/home/myusername/.local/share/containers/storage/volumes/myvol/_data",
          "CreatedAt": "2023-03-13T16:26:48.423069028-04:00",
          "Labels": {},
          "Scope": "local",
          "Options": {},
          "MountCount": 0,
          "NeedsCopyUp": true,
          "NeedsChown": true
     }
]
```

Inspect all volumes.
```
$ podman volume inspect --all
[
     {
          "Name": "myvol",
          "Driver": "local",
          "Mountpoint": "/home/myusername/.local/share/containers/storage/volumes/myvol/_data",
          "CreatedAt": "2023-03-13T16:26:48.423069028-04:00",
          "Labels": {},
          "Scope": "local",
          "Options": {},
          "MountCount": 0,
          "NeedsCopyUp": true,
          "NeedsChown": true
     }
]
```

Inspect named volume and display its Driver and Scope field.
```
$ podman volume inspect --format "{{.Driver}} {{.Scope}}" myvol
local local
```

## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**, **[podman-inspect(1)](podman-inspect.1.md)**

## HISTORY
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>