github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/volume/snapshot-list.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: volume snapshot list'
     4  description: |
     5    List external volume snapshots.
     6  ---
     7  
     8  # Command: volume snapshot list
     9  
    10  The `volume snapshot list` command lists volume snapshots known to a
    11  [Container Storage Interface (CSI)][csi] storage provider. Only CSI plugins
    12  that implement the [Controller][csi_plugins_internals] interface support this
    13  command.
    14  
    15  ## Usage
    16  
    17  ```plaintext
    18  nomad volume snapshot list [-plugin plugin_id -secrets key=value]
    19  ```
    20  
    21  The `volume snapshot list` command returns a list of snapshots along with their
    22  source volume ID as known to the external storage provider. This is not the
    23  same as the Nomad volume ID, as the source volume may not be [registered] with
    24  Nomad.
    25  
    26  ## General Options
    27  
    28  @include 'general_options.mdx'
    29  
    30  ## Snapshot List Options
    31  
    32  - `-page-token`: Where to start pagination.
    33  - `-per-page`: How many results to show per page.
    34  - `-plugin`: Display only snapshots managed by a particular [CSI
    35    plugin][csi_plugin]. This flag is required and accepts a plugin ID
    36    or prefix. If there is an exact match based on the provided plugin,
    37    then that specific plugin will be queried. Otherwise, a list of
    38    matching plugins will be displayed.
    39  - `-secret`: Secrets to pass to the plugin to list snapshots. Accepts
    40    multiple flags in the form `-secret key=value`
    41  - `-verbose`: Display full information for the resulting snapshot.
    42  
    43  When ACLs are enabled, this command requires a token with the
    44  `csi-list-volumes` capability for the plugin's namespace.
    45  
    46  ## Examples
    47  
    48  List volume snapshots for a plugin:
    49  
    50  ```shell-session
    51  $ nomad volume snapshot list -plugin aws-ebs0
    52  Snapshot ID  External ID  Size   Creation Time         Ready?
    53  snap-12345   vol-abcdef   50GiB  2021-01-03T12:15:02Z  true
    54  snap-67890   vol-fedcba   50GiB  2021-01-04T15:45:00Z  true
    55  ```
    56  
    57  List volume snapshots with two secret key/value pairs:
    58  ```shell-session
    59  $ nomad volume snapshot list -plugin aws-ebs0 -secret key1=value1 -secret key2=val2
    60  Snapshot ID  External ID  Size   Creation Time         Ready?
    61  snap-12345   vol-abcdef   50GiB  2021-01-03T12:15:02Z  true
    62  ```
    63  
    64  [csi]: https://github.com/container-storage-interface/spec
    65  [csi_plugin]: /docs/job-specification/csi_plugin
    66  [registered]: /docs/commands/volume/register
    67  [csi_plugins_internals]: /docs/concepts/plugins/csi#csi-plugins