.nh
.TH podman-volume-ls 1
.SH NAME
.PP
podman-volume-ls - List all the available volumes

.SH SYNOPSIS
.PP
\fBpodman volume ls\fP [\fIoptions\fP]

.SH DESCRIPTION
.PP
Lists all the volumes that exist. The output can be filtered using the \fB--filter\fP
flag and can be formatted to either JSON or a Go template using the \fB--format\fP
flag. Use the \fB--quiet\fP flag to print only the volume names.

.SH OPTIONS
.SS \fB--filter\fP, \fB-f\fP=\fIfilter\fP
.PP
Filter what volumes are shown in the output.
Multiple filters can be given with multiple uses of the --filter flag.
Filters with the same key work inclusive, with the only exception being \fBlabel\fR
which is exclusive. Filters with different keys always work exclusive.

.PP
Volumes can be filtered by the following attributes:

.TS
allbox;
l l 
l l .
\fB\fBFilter\fP\fP	\fB\fBDescription\fP\fP
dangling	T{
[Dangling] Matches all volumes not referenced by any containers
T}
driver	T{
[Driver] Matches volumes based on their driver
T}
label	T{
[Key] or [Key=Value] Label assigned to a volume
T}
name	T{
[Name] Volume name (accepts regex)
T}
opt	T{
Matches a storage driver options
T}
scope	Filters volume by scope
after/since	T{
Filter by volumes created after the given VOLUME (name or tag)
T}
until	T{
Only remove volumes created before given timestamp
T}
.TE

.SS \fB--format\fP=\fIformat\fP
.PP
Format volume output using Go template.

.PP
Valid placeholders for the Go template are listed below:

.TS
allbox;
l l 
l l .
\fB\fBPlaceholder\fP\fP	\fB\fBDescription\fP\fP
\&.Anonymous	T{
Indicates whether volume is anonymous
T}
\&.CreatedAt ...	Volume creation time
\&.Driver	Volume driver
\&.GID	GID of volume
\&.InspectVolumeData ...	Don't use
\&.Labels ...	T{
Label information associated with the volume
T}
\&.LockNumber	T{
Number of the volume's Libpod lock
T}
\&.MountCount	T{
Number of times the volume is mounted
T}
\&.Mountpoint	Source of volume mount point
\&.Name	Volume name
\&.NeedsChown	T{
Indicates whether volume needs to be chowned
T}
\&.NeedsCopyUp	T{
Indicates if volume needs to be copied up to
T}
\&.Options ...	Volume options
\&.Scope	Volume scope
\&.Status ...	Status of the volume
\&.StorageID	StorageID of the volume
\&.Timeout	Timeout of the volume
\&.UID	UID of volume
\&.VolumeConfigResponse ...	Don't use
.TE

.SS \fB--help\fP
.PP
Print usage statement.

.SS \fB--noheading\fP, \fB-n\fP
.PP
Omit the table headings from the listing.

.SS \fB--quiet\fP, \fB-q\fP
.PP
Print volume output in quiet mode. Only print the volume names.

.SH EXAMPLES
.PP
List all volumes.

.EX
$ podman volume ls

.EE

.PP
List all volumes and display content as json format.

.EX
$ podman volume ls --format json

.EE

.PP
List all volumes and display their Driver and Scope fields

.EX
$ podman volume ls --format "{{.Driver}} {{.Scope}}"

.EE

.PP
List volumes with the name foo and label blue.

.EX
$ podman volume ls --filter name=foo,label=blue

.EE

.PP
List volumes with the label key=value.

.EX
$ podman volume ls --filter label=key=value

.EE

.SH SEE ALSO
.PP
\fBpodman(1)\fP, \fBpodman-volume(1)\fP

.SH HISTORY
.PP
November 2018, Originally compiled by Urvashi Mohnani umohnani@redhat.com
\[la]mailto:umohnani@redhat.com\[ra]