plucky (1) podman-volume-ls.1.gz

Provided by: podman_5.4.0+ds1-1_amd64 bug

NAME

       podman-volume-ls - List all the available volumes

SYNOPSIS

       podman volume ls [options]

DESCRIPTION

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

OPTIONS

   --filter, -f=filter
       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  label  which  is
       exclusive. Filters with different keys always work exclusive.

       Volumes can be filtered by the following attributes:

       ┌────────────┬───────────────────────────────────────┐
       │FilterDescription                           │
       ├────────────┼───────────────────────────────────────┤
       │dangling    │ [Dangling]  Matches  all  volumes not │
       │            │ referenced by any containers          │
       ├────────────┼───────────────────────────────────────┤
       │driver      │ [Driver]  Matches  volumes  based  on │
       │            │ their driver                          │
       ├────────────┼───────────────────────────────────────┤
       │label       │ [Key]  or  [Key=Value] Label assigned │
       │            │ to a volume                           │
       ├────────────┼───────────────────────────────────────┤
       │name        │ [Name] Volume name (accepts regex)    │
       ├────────────┼───────────────────────────────────────┤
       │opt         │ Matches a storage driver options      │
       ├────────────┼───────────────────────────────────────┤
       │scopeFilters volume by scope               │
       ├────────────┼───────────────────────────────────────┤
       │after/since │ Filter by volumes created  after  the │
       │            │ given VOLUME (name or tag)            │
       ├────────────┼───────────────────────────────────────┤
       │until       │ Only  remove  volumes  created before │
       │            │ given timestamp                       │
       └────────────┴───────────────────────────────────────┘

   --format=format
       Format volume output using Go template.

       Valid placeholders for the Go template are listed below:

       ┌──────────────────────────┬───────────────────────────────────────┐
       │PlaceholderDescription                           │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.Anonymous                │ Indicates whether volume is anonymous │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.CreatedAt ...Volume creation time                  │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.DriverVolume driver                         │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.GIDGID of volume                         │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.InspectVolumeData ...Don't use                             │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.Labels ...               │ Label information associated with the │
       │                          │ volume                                │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.LockNumber               │ Number of the volume's Libpod lock    │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.MountCount               │ Number of times the volume is mounted │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.MountpointSource of volume mount point          │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.NameVolume name                           │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.NeedsChown               │ Indicates  whether volume needs to be │
       │                          │ chowned                               │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.NeedsCopyUp              │ Indicates  if  volume  needs  to   be │
       │                          │ copied up to                          │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.Options ...Volume options                        │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.ScopeVolume scope                          │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.Status ...Status of the volume                  │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.StorageIDStorageID of the volume               │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.TimeoutTimeout of the volume                 │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.UIDUID of volume                         │
       ├──────────────────────────┼───────────────────────────────────────┤
       │.VolumeConfigResponse ...Don't use                             │
       └──────────────────────────┴───────────────────────────────────────┘

   --help
       Print usage statement.

   --noheading, -n
       Omit the table headings from the listing.

   --quiet, -q
       Print volume output in quiet mode. Only print the volume names.

EXAMPLES

       List all volumes.

       $ podman volume ls

       List all volumes and display content as json format.

       $ podman volume ls --format json

       List all volumes and display their Driver and Scope fields

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

       List volumes with the name foo and label blue.

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

       List volumes with the label key=value.

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

SEE ALSO

       podman(1), podman-volume(1)

HISTORY

       November 2018, Originally compiled by Urvashi Mohnani umohnani@redhat.commailto:umohnani@redhat.compodman-volume-ls(1)