File: podman-volume-ls.1.md.in

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 (106 lines) | stat: -rw-r--r-- 4,326 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
105
106
% podman-volume-ls 1

## 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:

| **Filter**  | **Description**                                                                       |
| ----------  | ------------------------------------------------------------------------------------- |
| 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                                                      |
| scope       | Filters 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:

| **Placeholder**           | **Description**                              |
| ------------------------- | -------------------------------------------- |
| .Anonymous                | Indicates whether volume is anonymous        |
| .CreatedAt ...            | Volume creation time                         |
| .Driver                   | Volume driver                                |
| .GID                      | GID 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        |
| .Mountpoint               | Source of volume mount point                 |
| .Name                     | Volume name                                  |
| .NeedsChown               | Indicates whether volume needs to be chowned |
| .NeedsCopyUp              | Indicates if volume needs to be copied up to |
| .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                                    |

#### **--help**

Print usage statement.

@@option noheading

#### **--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.1.md)**, **[podman-volume(1)](podman-volume.1.md)**

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