Group Snaps using pxctl

This document explains how to take group snapshots of your container data with Portworx.

First, let’s get an overview of the available flags before diving in:

pxctl volume snapshot group --help
Create group snapshots for given group id or labels

  pxctl volume snapshot group [flags]

  group, g

  -d, --delete-on-failure   delete created snaps if not all volumes succeeded in the group
  -g, --group string        group id
  -h, --help                help for group
  -l, --label string        list of comma-separated name=value pairs
  -v, --volume_ids string   list of comma-separated volume IDs

Global Flags:
      --ca string            path to root certificate for ssl usage
      --cert string          path to client certificate for ssl usage
      --color                output with color coding
      --config string        config file (default is $HOME/.pxctl.yaml)
      --context string       context name that overrides the current auth context
  -j, --json                 output in json
      --key string           path to client key for ssl usage
      --output-type string   use "wide" to show more details
      --raw                  raw CLI output for instrumentation
      --ssl                  ssl enabled for portworx

To take a group snapshot of the volumes labelled with v1=x1, use this command:

pxctl volume snapshot group --label v1=x1
Volume 549285969696152595 : Snapshot 1026872711217134654
Volume 952350606466932557 : Snapshot 218459942880193319

You can easily group volumes by IDs and take a group snapshot with the --volume_ids flag:

pxctl volume snapshot group --volume_ids 83958335106174418,874802361339616936
Volume 83958335106174418 : Snapshot 362408823552094597
Volume 874802361339616936 : Snapshot 895516478416742770
  • For more information about creating group snapshots of Portworx volumes through Kubernetes, refer to the Snapshot group of PVCs page.

Last edited: Tuesday, May 9, 2023