Skip to main content
Pure1 Support Portal

purepgroup-list

Name

purepgroup-list, purepgroup-listobj — display protection group attributes and storage consumption

Synopsis

purepgroup list [ --cli | --csv | --nvp ] [--filter FILTER] [--limit LIMIT] [--notitle] [--page] [ --pending | --pending-only ] [--raw] [ --retention | --schedule | --snap | --space ] [--sort SORT] [ --source | --target ] [--total] [--transfer] [PGROUP...]

purepgroup listobj [--csv] [ --pending | --pending-only ] [ --source | --target ] [ --type { --hgroup | --host | --pgroup | --snap | --source | --target | --vol } ] [PGROUP...]

Arguments

PGROUP

Protection group for which the information specified by options is to be displayed.

Options

Options that control information displayed:

-h | --help

Can be used with any command or subcommand to display a brief syntax description.

--pending

Displays a list of protection groups or snapshots that have been destroyed and are in the eradication pending state.

--pending-only

Only display destroyed protection groups or snapshots that are in the eradication pending state.

--retention

Displays the retention schedule for each protection group.

--schedule

Displays the snapshot and replication schedule for each protection group.

--snap

Displays a list of scheduled and on-demand snapshots taken in each source and target protection group.

--source

Displays a list of protection groups or snapshots that were created on this array.

--space

Displays the size and space consumption details for all snapshots in each protection group.

--target

Displays a list of protection groups or snapshots that were replicated to this array.

--total

Used with --space to display total physical space occupied by snapshot data for each protection group.

--transfer

Used with --snap to display replication data transfer statistics, including data transfer start time, data transfer end time, data transfer progress, and amount of logical/physical data transferred.

--type

Displays a list of hosts, host groups, protection groups, snapshots, sources, targets or volumes associated with the specified protection groups.

Options that control display format:

--cli

Displays output in the form of CLI commands that can be issued to reproduce the current configuration. The --cli output is not meaningful when combined with immutable attributes.

--csv

Lists information in comma-separated value (CSV) format. The --csv output can be used for scripting purposes and imported into spreadsheet programs.

--notitle

Lists information without column titles.

--nvp

Lists information in name-value pair (NVP) format, in the form ITEMNAME=VALUE. Argument names and information items are displayed flush left. The --nvp output is designed both for convenient viewing of what might otherwise be wide listings, and for parsing individual items for scripting purposes.

--page

Turns on interactive paging.

--raw

Displays the unformatted version of column titles and data. For example, in the purearray monitor output, the unformatted version of column title us/op (read) is usec_per_read_op. The --raw output is used to sort and filter list results.

Options that manage display results:

--filter

Displays only the rows that meet the filter criteria specified.

--limit

Limits the size of the list output to the specified maxmimum number of rows.

--sort

Sorts the list output in ascending or descending order by the column specified.

Conventions

The protection group snapshot naming convention is PGROUP.NNN, where:

  • PGROUP is the name of the protection group.

  • NNN is a unique monotonically increasing number or a manually-assigned protection group snapshot suffix name.

The protection group volume snapshot naming convention is PGROUP.NNN.VOL, where:

  • PGROUP is the name of the protection group.

  • NNN is a unique monotonically increasing number or a manually-assigned protection group snapshot suffix name.

  • VOL is name of the volume member.

If you are viewing replicated snapshots on a target array, the snapshot name begins with the name of the source array from where the snapshot was taken.

Description

The purepgroup list command displays information about each protection group, including its associated source array, target arrays, hosts, host groups, and volumes. Optionally, add the protection group argument to any of the commands to view details for the specified protection groups.

In the following sample output, the current array includes three protection groups: two protection groups, named pgroup1 and pgroup10, that were created on the current array; and one protection group, named pg1, that was created on another array named array5.

Protection group pgroup1 has been set up on the current array, named array1, to replicate snapshots to a target array named array2, which has allowed replication.

Protection group pgroup10 has also been set up on the current array (array1) to replicate snapshots to target array array3. However, array3 has not allowed replication.

Protection group pg1 was created on array5 and added the current array as a target for replication purposes.

$ purepgroup list
Name        Source  Targets               Host Groups  Hosts  Volumes
array5:pg1  array5  -                     -            -      array:vol1
pgroup1     array1  array2                -            -      v1
                                                              v2
                                                              v3
pgroup10    array1  array3 (disallowed)   hg1          -      -
    

The purepgroup list command includes the mutually exclusive --schedule, --retention, and --space options.

The --schedule option displays the snapshot and replication schedule for each protection group.

In the following sample output, the snapshot and replication schedules have been enabled for protection group pgroup1. The protection group has been configured to enable snapshot generation every hour and replication every 2 hours. Replication is suspended during the blackout period between 9am and 5pm. Replication from the source to target arrays will not occur during the blackout period, but hourly snapshots will continue to be taken on the source array.

The snapshot schedule for protection group pg1 on source array array5 has also been configured to enable snapshot generation every hour. However, replication has been disabled. Once enabled, snapshot replication will occur every 2 days at or soon after 6pm.

$ purepgroup list --schedule
Name        Schedule   Enabled  Frequency  At   Blackout
array5:pg1  snap       True     6h         -    -
            replicate  False    2d         6pm  -
pgroup1     snap       True     1h         -    -
            replicate  True     2h         6pm  9am-5pm
    

The --retention option displays the retention schedule for each protection group.

In the following sample output, the retention schedule has been set to keep all snapshots on the source array for 1 day. After that, Purity will keep 2 of the snapshots for an additional 7 days and eradicate the others. Seven days later, Purity will eradicate the 2 snapshots.

The retention schedule has also been set to keep all replicated snapshots on the target array for 7 days. After that, Purity will keep 4 of the replicated snapshots for an additional 7 days and eradicate the others. Seven days later, Purity will eradicate the 4 snapshots.

$ purepgroup list --retention
Name        Array   All For  Per Day  Days
pgroup1     source  1d       2        7
            target  7d       4        7

The --space option displays the size and space consumption details for all snapshots in each protection group. Include the --total option to display the total space consumption for all protection groups.

The --snap option displays a list of scheduled and on-demand snapshots generated or replicated of each protection group. The list also displays the snapshot creation date. Include the --transfer option to display replication data transfer statistics, including data transfer start time, data transfer end time, data transfer progress, and amount of logical/physical data transferred.

The --pending option includes protection groups or snapshots that have been destroyed and are in the eradication pending state in the output list. The --pending option can also be used in conjunction with the --schedule, --retention, --space, or --snap options to include a list of pending protection groups or snapshots.

The --pending-only option only displays protection groups or snapshots that have been destroyed and are in the eradication pending state in the output list. The --pending-only option can also be used in conjunction with the --schedule, --retention, --space, or --snap options to include a list of pending protection groups or snapshots.

The purepgroup listobj command displays a list of protection groups. Include the protection group argument to view the list for the specified protection group.

Include the --type option to view a list of hosts, host groups, snapshots, sources, targets or volumes associated with a protection group. The the --type option produces the following types of lists:

--type hgroup

Displays a list of host groups that belong to a protection group.

--type host

Displays a list of hosts that belong to a protection group.

--type pgroup (default if --type option not specified)

Displays a list of protection groups.

--type snap

Displays a list of snapshots that were taken for a protection group.

--type source

Displays a list of replication source arrays.

--type target

Displays a list of replication target arrays.

--type vol

Displays a list of volumes that belong to a protection group.

The --source option displays a list of protection groups or snapshots that were created on this array.

The --target option displays a list of protection groups or snapshots that were replicated to this array.

Exceptions

None.

Examples

Example 1

purepgroup list
      

Displays information about each protection group, including its source array, target arrays, hosts, host groups, and volumes.

Example 2

purepgroup list --pending --snap
      

Displays a list of snapshots, both on-demand and scheduled, including those which have been destroyed and are in the eradication pending state.

Example 3

purepgroup list --pending-only --snap
      

Displays a list of snapshots, both on-demand and scheduled, that have been destroyed and are in the eradication pending state.

Example 4

purepgroup list --schedule pgroup4
      

Displays the snapshot and replication schedule for protection group pgroup4.

Example 5

purepgroup listobj
      

Displays a list of protection groups.

Example 6

purepgroup listobj --type vol pgroup7 pgroup10
      

Displays volumes that belong to protection group pgroup7, pgroup10, or both.

Example 7

purepgroup listobj --type snap --target
      

Displays protection group snapshots replicated to this array.

Author

Pure Storage Inc.