1podman-volume-ls(1)         General Commands Manual        podman-volume-ls(1)
2
3
4

NAME

6       podman-volume-ls - List all the available volumes
7
8

SYNOPSIS

10       podman volume ls [options]
11
12

DESCRIPTION

14       Lists  all the volumes that exist. The output can be filtered using the
15       --filter flag and can be formatted to either JSON or a Go template  us‐
16       ing  the  --format  flag. Use the --quiet flag to print only the volume
17       names.
18
19

OPTIONS

21   --filter, -f=filter
22       Filter what volumes are shown in the output.  Multiple filters  can  be
23       given  with  multiple uses of the --filter flag.  Filters with the same
24       key work inclusive, with the only exception being label which is exclu‐
25       sive. Filters with different keys always work exclusive.
26
27
28       Volumes can be filtered by the following attributes:
29
30
31       ┌────────────┬────────────────────────────┐
32       │Filter      │ Description                │
33       ├────────────┼────────────────────────────┤
34       │dangling    │ [Dangling]   Matches   all │
35       │            │ volumes not referenced  by │
36       │            │ any containers             │
37       ├────────────┼────────────────────────────┤
38       │driver      │ [Driver]  Matches  volumes │
39       │            │ based on their driver      │
40       ├────────────┼────────────────────────────┤
41       │label       │ [Key] or [Key=Value] Label │
42       │            │ assigned to a volume       │
43       ├────────────┼────────────────────────────┤
44       │name        │ [Name]  Volume  name  (ac‐ │
45       │            │ cepts regex)               │
46       ├────────────┼────────────────────────────┤
47       │opt         │ Matches a  storage  driver │
48       │            │ options                    │
49       ├────────────┼────────────────────────────┤
50       │scope       │ Filters volume by scope    │
51       ├────────────┼────────────────────────────┤
52       │after/since │ Filter  by volumes created │
53       │            │ after  the  given   VOLUME │
54       │            │ (name or tag)              │
55       ├────────────┼────────────────────────────┤
56       │until       │ Only  remove  volumes cre‐ │
57       │            │ ated  before  given  time‐ │
58       │            │ stamp                      │
59       └────────────┴────────────────────────────┘
60
61   --format=format
62       Format volume output using Go template.
63
64
65       Valid placeholders for the Go template are listed below:
66
67
68       ┌──────────────────────────┬──────────────────────────────┐
69       │Placeholder               │ Description                  │
70       ├──────────────────────────┼──────────────────────────────┤
71       │.Anonymous                │ Indicates  whether volume is │
72       │                          │ anonymous                    │
73       ├──────────────────────────┼──────────────────────────────┤
74       │.CreatedAt                │ Volume creation time         │
75       ├──────────────────────────┼──────────────────────────────┤
76       │.Driver                   │ Volume driver                │
77       ├──────────────────────────┼──────────────────────────────┤
78       │.GID                      │ GID of volume                │
79       ├──────────────────────────┼──────────────────────────────┤
80       │.InspectVolumeData ...    │ Don't use                    │
81       ├──────────────────────────┼──────────────────────────────┤
82       │.Labels                   │ Label information associated │
83       │                          │ with the volume              │
84       ├──────────────────────────┼──────────────────────────────┤
85       │.LockNumber               │ Number  of the volume's Lib‐ │
86       │                          │ pod lock                     │
87       ├──────────────────────────┼──────────────────────────────┤
88       │.MountCount               │ Number of times  the  volume │
89       │                          │ is mounted                   │
90       ├──────────────────────────┼──────────────────────────────┤
91       │.Mountpoint               │ Source of volume mount point │
92       ├──────────────────────────┼──────────────────────────────┤
93       │.Name                     │ Volume name                  │
94       ├──────────────────────────┼──────────────────────────────┤
95       │.NeedsChown               │ Indicates   whether   volume │
96       │                          │ needs to be chowned          │
97       ├──────────────────────────┼──────────────────────────────┤
98       │.NeedsCopyUp              │ Indicates if volume needs to │
99       │                          │ be copied up to              │
100       ├──────────────────────────┼──────────────────────────────┤
101       │.Options                  │ Volume options               │
102       ├──────────────────────────┼──────────────────────────────┤
103       │.Scope                    │ Volume scope                 │
104       ├──────────────────────────┼──────────────────────────────┤
105       │.Status                   │ Status of the volume         │
106       ├──────────────────────────┼──────────────────────────────┤
107       │.StorageID                │ StorageID of the volume      │
108       ├──────────────────────────┼──────────────────────────────┤
109       │.Timeout                  │ Timeout of the volume        │
110       ├──────────────────────────┼──────────────────────────────┤
111       │.UID                      │ UID of volume                │
112       ├──────────────────────────┼──────────────────────────────┤
113       │.VolumeConfigResponse ... │ Don't use                    │
114       └──────────────────────────┴──────────────────────────────┘
115
116   --help
117       Print usage statement.
118
119
120   --noheading, -n
121       Omit the table headings from the listing.
122
123
124   --quiet, -q
125       Print volume output in quiet mode. Only print the volume names.
126
127

EXAMPLES

129       $ podman volume ls
130
131       $ podman volume ls --format json
132
133       $ podman volume ls --format "{{.Driver}} {{.Scope}}"
134
135       $ podman volume ls --filter name=foo,label=blue
136
137       $ podman volume ls --filter label=key=value
138
139
140

SEE ALSO

142       podman(1), podman-volume(1)
143
144

HISTORY

146       November  2018,  Originally  compiled  by Urvashi Mohnani umohnani@red‐
147       hat.com ⟨mailto:umohnani@redhat.com⟩
148
149
150
151                                                           podman-volume-ls(1)