github.com/containers/podman/v5@v5.1.0-rc1/docs/source/markdown/podman-volume-inspect.1.md (about)

     1  % podman-volume-inspect 1
     2  
     3  ## NAME
     4  podman\-volume\-inspect - Get detailed information on one or more volumes
     5  
     6  ## SYNOPSIS
     7  **podman volume inspect** [*options*] *volume* [...]
     8  
     9  ## DESCRIPTION
    10  
    11  Display detailed information on one or more volumes. The output can be formatted using
    12  the **--format** flag and a Go template. To get detailed information about all the
    13  existing volumes, use the **--all** flag.
    14  Volumes can be queried individually by providing their full name or a unique partial name.
    15  
    16  
    17  ## OPTIONS
    18  
    19  #### **--all**, **-a**
    20  
    21  Inspect all volumes.
    22  
    23  #### **--format**, **-f**=*format*
    24  
    25  Format volume output using Go template
    26  
    27  Valid placeholders for the Go template are listed below:
    28  
    29  | **Placeholder**     | **Description**                                        |
    30  | ------------------- | ------------------------------------------------------ |
    31  | .Anonymous          | Indicates whether volume is anonymous                  |
    32  | .CreatedAt ...      | Volume creation time                                   |
    33  | .Driver             | Volume driver                                          |
    34  | .GID                | GID the volume was created with                        |
    35  | .Labels ...         | Label information associated with the volume           |
    36  | .LockNumber         | Number of the volume's Libpod lock                     |
    37  | .MountCount         | Number of times the volume is mounted                  |
    38  | .Mountpoint         | Source of volume mount point                           |
    39  | .Name               | Volume name                                            |
    40  | .NeedsChown         | Indicates volume needs to be chowned on first use      |
    41  | .NeedsCopyUp        | Indicates volume needs dest data copied up on first use|
    42  | .Options ...        | Volume options                                         |
    43  | .Scope              | Volume scope                                           |
    44  | .Status ...         | Status of the volume                                   |
    45  | .StorageID          | StorageID of the volume                                |
    46  | .Timeout            | Timeout of the volume                                  |
    47  | .UID                | UID the volume was created with                        |
    48  
    49  #### **--help**
    50  
    51  Print usage statement
    52  
    53  
    54  ## EXAMPLES
    55  
    56  Inspect named volume.
    57  ```
    58  $ podman volume inspect myvol
    59  [
    60       {
    61            "Name": "myvol",
    62            "Driver": "local",
    63            "Mountpoint": "/home/myusername/.local/share/containers/storage/volumes/myvol/_data",
    64            "CreatedAt": "2023-03-13T16:26:48.423069028-04:00",
    65            "Labels": {},
    66            "Scope": "local",
    67            "Options": {},
    68            "MountCount": 0,
    69            "NeedsCopyUp": true,
    70            "NeedsChown": true
    71       }
    72  ]
    73  ```
    74  
    75  Inspect all volumes.
    76  ```
    77  $ podman volume inspect --all
    78  [
    79       {
    80            "Name": "myvol",
    81            "Driver": "local",
    82            "Mountpoint": "/home/myusername/.local/share/containers/storage/volumes/myvol/_data",
    83            "CreatedAt": "2023-03-13T16:26:48.423069028-04:00",
    84            "Labels": {},
    85            "Scope": "local",
    86            "Options": {},
    87            "MountCount": 0,
    88            "NeedsCopyUp": true,
    89            "NeedsChown": true
    90       }
    91  ]
    92  ```
    93  
    94  Inspect named volume and display its Driver and Scope field.
    95  ```
    96  $ podman volume inspect --format "{{.Driver}} {{.Scope}}" myvol
    97  local local
    98  ```
    99  
   100  ## SEE ALSO
   101  **[podman(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**, **[podman-inspect(1)](podman-inspect.1.md)**
   102  
   103  ## HISTORY
   104  November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>