Managing snapshots

Storage Administrator (View Only)

GET base-URL/simple/v1/objects/snapshots

• Object ID

  None.

• Query parameters

  With each request, you can obtain information for a maximum of 1000 snapshots. To obtain information for more than 1000 snapshots, execute the API request several times by using a combination of the count and startId parameters. By specifying the count parameter, you can also filter the snapshot information.

  Parameter	Type	Filter Condition
  masterVolumeId	int	(Optional) Master volume ID of the snapshot
  snapshotDateFrom	ISO8601string	(Optional) Specify the date and time from which snapshots will be obtained, in YYYY-MM-DDThh:mm:ssZ format. Information about snapshots created on and after the date and time specified for this parameter will be obtained.
  snapshotDateTo	ISO8601string	(Optional) Specify the date and time until which snapshots will be obtained, in YYYY-MM-DDThh:mm:ssZ format. Information about snapshots created on and before the date and time specified for this parameter will be obtained.
  snapshotGroupName	string	(Optional) Snapshot group name Information about the snapshot that is a perfect match with the specified value is obtained.
  startId	string	(Optional) Specify the first snapshot information to obtain, by specifying the master volume ID of the snapshot and the snapshot ID, linked by a comma. masterVolumeId,snapshotId If this parameter is omitted, "0,0" is assumed.
  count	int	(Optional) Specify the number of snapshots by using a value in the range from 1 through 1000. If this parameter is omitted, 1000 is considered.

• Body

  None.

• Body

  {
    "data": [
      {
        "id": "100,3",
        "masterVolumeId": 100,
        "snapshotId": 3,
        "status": "Completed",
        "snapshotDate": "2015-03-20T09:27:35Z",
        "snapshotGroupName": "snapshotGroup",
        "rootVolumeId": 100,
        "type": "Snapshot",
        "poolId": 10,
        "usedCapacityPerRootVolume": 126,
        "isVolumeCapacityExpanding": false
      },
      {
        "id": "100,4",
        "masterVolumeId": 100,
        "snapshotId": 4,
        "status": "Completed",
        "snapshotDate": "2015-03-20T09:27:35Z",
        "snapshotGroupName": "snapshotGroup",
        "rootVolumeId": 100,
        "type": "Snapshot",
        "poolId": 10,
        "usedCapacityPerRootVolume": 126,
        "isVolumeCapacityExpanding": false
      },
    ],
    "count": 2,
    "totalCount": 2,
    "hasNext": false
  }

  Attribute	Type	Description
  id	string	Master volume ID of the snapshot and the snapshot ID, linked by a comma
  masterVolumeId	int	Master volume ID of the snapshot
  snapshotId	int	Snapshot ID The mirror unit number is obtained.
  status	string	Status of the snapshot: Creating: Snapshot creation is in progress In Sync: Snapshot synchronization is complete Completed: Snapshot creation is complete Deleting:Snapshot deletion is in progress Restoring: Snapshot restoration is in progress Preparing: Preparation for Snap Clone is in progress Clone Ready: Snap Clone is ready Cloning: Replication by using Snap Clone is in progress Diff Cloning: Replication by using Diff Clone in the VASA environment is in progress Removing: Removal of the Snap Clone settings is in progress Error: A failure has occurred
  snapshotDate	ISO8601string	Date and time when the snapshot was created
  snapshotGroupName	string	Snapshot group name
  mappedVolumeId	int	ID of the volume to be created from the snapshots This attribute is obtained only if the ID of the volume for which the snapshot was created is defined.
  rootVolumeId	int	ID of the root volume of the snapshots
  poolId	int	ID of the pool in which the differential data of the snapshots is stored
  usedCapacityPerRootVolume	long	The amount of disk space (MiB) occupied by differential information and control information used by the snapshot group created from the same volume.
  isVolumeCapacityExpanding	boolean	Indicates whether the snapshot capacity is being expanded true: Capacity expansion is in progress When a volume is mapped to the snapshot, true appears (indicating that processing to expand the capacity is occurring) if the capacity of the volume from which the snapshot was created differs from the capacity of the volume to which the snapshot is mapped. When no volume is mapped to the snapshot, true appears (indicating that processing to expand the capacity is occurring) only if processing is expanding the capacity of the volume from which the snapshot was created. false: Capacity expansion is not occurring
  type	string	Type of snapshot: Snap Clone: Snap Clone replication is in progress Snapshot: A snapshot or volume ID is defined for the snapshot Diff Clone: Diff Clone replication in the VASA environment is in progress (VSP G130, G/F350, G/F370, G/F700, G/F900 models only)
  diffCompareVolumeId	int	Volume ID of the base volume that is used when creating a Diff Clone The attribute type appears only for Diff Clone.

See HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshots

Storage Administrator (View Only)

GET base-URL/simple/v1/objects/snapshots/object-ID

• Object ID

  Specify the id value obtained by requesting snapshot information. The value of the id attribute is obtained in the following format, where the master volume ID of the snapshot and the snapshot ID are linked by a comma. You can specify these values (obtained by getting snapshot information) in the command by using the same format: masterVolumeId followed by snapshotId, linked by a comma.

  masterVolumeId,snapshotId

  Attribute	Type	Description
  masterVolumeId	int	(Required) Master volume ID of the snapshot
  snapshotId	int	(Required) Snapshot ID

• Query parameters

  None.

• Body

  None.

• Body

  The following is an example of the output when getting information about a specific snapshot (master volume ID of the snapshot: 100, snapshot ID: 3).

  {
    "id": "100,3",
    "masterVolumeId": 100,
    "snapshotId": 3,
    "status": "Completed",
    "snapshotDate": "2015-03-20T09:27:35Z",
    "snapshotGroupName": "snapshotGroup",
    "rootVolumeId": 100,
    "type": "Snapshot",
    "poolId": 10,
    "usedCapacityPerRootVolume": 126,
    "isVolumeCapacityExpanding": false
  }

See HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshots/100,3

Storage Administrator (Local Copy)

DELETE base-URL/simple/v1/objects/snapshots/object-ID

• Object ID

  Specify the id value obtained by getting snapshot information. The value of the id attribute is obtained in the following format, where the master volume ID of the snapshot and the snapshot ID are linked by a comma. You can specify these values (obtained by getting snapshot information) in the command by using the same format: masterVolumeId followed by snapshotId, linked by a comma.

  masterVolumeId,snapshotId

  Attribute	Type	Description
  masterVolumeId	int	(Required) Master volume ID of the snapshot
  snapshotId	int	(Required) Snapshot ID

• Query parameters

  None.

• Body

  None.

• Body

  Attribute	Type	Description
  statusResource	string	URL used to obtain the execution results of the delete a snapshot request

  Note

  Execute the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.

See HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshots/100,3

Storage Administrator (View Only)

GET base-URL/simple/v1/objects/snapshot-groups/object-ID

• Object ID

  Specify a value for the name that was obtained by getting the list of snapshot group names.

  Attribute	Type	Description
  name	string	(Required) Snapshot group name

  Note

  Do not specify the following snapshot group names:

  • Names that include a slash (/) or backslash (\)
  • Names consisting of only a period (.)

  You can get information about these snapshot groups by running the API request for getting snapshot information with the query parameter snapshotGroupName specified.

• Query parameters

  With each request, you can obtain information for a maximum of 1000 snapshot groups. To obtain information for more than 1000 snapshot groups, execute the API request several times by using a combination of the count and startId parameters. By specifying the count parameter, you can also filter the snapshot group information to obtain.

  Parameter	Type	Filter Condition
  startSnapshotId	string	(Optional) Specify the ID of the snapshot from which to obtain information. If this parameter is omitted, "0,0" is assumed.
  count	int	(Optional) Specify the number of snapshot groups for which you want to obtain information by using a value in the range from 1 through 1000. If this parameter is omitted, 1000 is assumed.

• Body

  None.

• Body

  The following is an example of the output when getting information about the snapshot group with the name snapshotGroup:

  {
    "name": "snapshotGroup",
    "snapshots": [
      {
        "masterVolumeId": 100,
        "snapshotId": 3
      },
      {
        "masterVolumeId": 100,
        "snapshotId": 4
      }
    ],
    "count": 2,
    "totalCount": 2,
    "hasNext": false
  }

  Attribute	Type	Description
  name	string	Snapshot group name
  snapshots	object[]	The following information about the snapshot is obtained: masterVolumeId (int) Master volume ID of the snapshot snapshotId (int) Snapshot ID The mirror unit number is obtained.

See HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshot-groups/snapshotGroup

Storage Administrator (Local Copy)

DELETE base-URL/simple/v1/objects/snapshot-groups/object-ID

• Object ID

  Specify a value for the name that was obtained by getting the list of snapshot group names.

  Attribute	Type	Description
  name	string	(Required) Snapshot group name

  Note

  Do not specify a snapshot group name that contains a slash (/) or a backslash (\).

  To delete a snapshot group whose name contains a slash (/) or a backslash (\), execute the API request for deleting a snapshot.

  If all snapshots in a snapshot group are deleted, the snapshot group is also deleted automatically.

• Query parameters

  None.

• Body

  None.

• Body

  Attribute	Type	Description
  statusResource	string	URL used to obtain the execution results of the delete the snapshot group request

  Note

  Execute the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.

See HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshot-groups/snapshotGroup

Displays the information of snapshot group and snapshot data that are defined in the device. If this option is omitted, the list of snapshot group is displayed.

raidcom get snapshot [-ldev_id <ldev#> [-key opt] | -snapshotgroup <name> 
[-key opt]] [-format_time] [{-check_status | -check_status_not} <string>... 
[-time <time>]]

• [-ldev_id <ldev#>]

  Specifies the LDEV number to be displayed the snapshot data information. Specifies either one of P-VOL or S-VOL for the LDEV number.

• [-snapshotgroup <name>]

  Specifies the snapshot group in which you want to display the snapshot data information.

• [-key opt]

  Specify the -key opt option together with the -ldev_id or the -snapshotgroup option to display the following:

  • SMPP as the snapshot data status
  • (VSP 5000 series, VSP G130, G/F350, G/F370, G/F700, G/F900) SLU attribute and information of the Diff Clone pair that is being used in the VASA environment
  • (VSP 5000 series, VSP G1x00 and VSP F1500, VSP G130, G/F350, G/F370, G/F700, G/F900) Status of expansion processing of DP-VOL
  • (VSP 5000 series, VSP G130, G/F350, G/F370, G/F700, G/F900) Status of the Read Only attribute of the Snapshot data.

• [–format_time]

  Specify this option to display the time when a snapshot data (SPLT-TIME) is created, with the format¹ below. The time zone used in the storage system² is displayed. Zero “0” is added to the beginning if the value of each element is shorter than the regulated length.

  Format: YYYY-MM-DDThh:mm:ss

  Where:

  • YYYY-MM-DD = year-month-date
  • hh = time in 24 hours, range 0-23
  • mm:ss = minute:second

  For example, December 2, 2016, one o’clock p.m. is displayed as 2016-12-02T13:00:00

  Notes:

  1. “T” in the format separates the date and the time.

  2. For VSP 5000 series, VSP G130, G/F350, G/F370, G/F700, G/F900, VSP Gx00 models and VSP Fx00 models, the time zone set in the device is used.

     For other models, UTC+0 is used.

• [-check_status <string> [-time <time>]]

  Check if the snapshot group or the snapshot data is in the same state as specified in <string>. If the option contains multiple states, the OR condition check is performed and verifies that the snapshot group or snapshot data is in one of the states contained in the option.

  The following strings are specified in the <string>:

  • COPY: Copy status.
  • PAIR: Pair status.
  • PSUS: Suspend status.
  • PSUE: Suspend failure status.
  • PFUL: Indicates that the Thin Image or Copy-on-Write Snapshot pool exceeds the threshold in the PAIR status.
  • PFUS: Indicates that the Thin Image or Copy-on-Write Snapshot pool exceeds the threshold in the PSUS status.
  • RCPY: Shows that the copying is in progress by resynchronization.
  • SMPP: Indicates that the pair is being deleted. When specifying SMPP, specify -key opt as well.
  • PSUP: Indicates that the pair with the clone attribute is split.

  If "-time" is specified, the status of the snapshot group or the snapshot data is checked every three seconds until the end of the specified <time> (seconds).

  When this option is specified, the returned values are as follows:

  • The snapshot group or the snapshot data is in one of the specified states: 0
  • The snapshot group or the snapshot data is in none of the specified states (without -time option): 1
  • The snapshot group or the snapshot data is in none of the specified states (when the specified <time> passed): EX_EWSTOT

  Note:

  When you specify -snapshotgroup <name>, and the pair is deleted, EX_ENOOBJ is returned.

• [-check_status_not <string> [-time <time>]]

  Check if the snapshot group or the snapshot data is not in the same state as specified in <string>. If the option contains multiple states, the OR condition check is performed and verifies that the snapshot group or snapshot data is not in any of the states contained in the option. The following strings are specified in the <string>.

  • COPY: Copy status.
  • PAIR: Pair status.
  • PSUS: Suspend status.
  • PSUE: Suspend failure status.
  • PFUL: Indicates that the Thin Image or Copy-on-Write Snapshot pool exceeds the threshold in the PAIR status.
  • PFUS: Indicates that the Thin Image or Copy-on-Write Snapshot pool exceeds the threshold in the PSUS status.
  • RCPY: Shows that the copying is in progress by resynchronization.
  • SMPP: Indicates that the pair is being deleted. When specifying SMPP, specify -key opt as well.
  • PSUP: Indicates that the pair with the clone attribute is split.

  If "-time" is specified, the status of the snapshot group or the snapshot data is checked every three seconds until the end of the specified <time> (seconds).

  When this option is specified, the returned values are as follows:

  • The snapshot group or the snapshot data is not in any of the specified states: 0
  • The snapshot group or the snapshot data is in one of the specified states (without -time option): 1
  • The snapshot group or the snapshot data is in one of the specified states (when the specified <time> passed): EX_EWSTOT
  Note

  When you specify -snapshotgroup <name>, and the pair is deleted, EX_ENOOBJ is returned.

• SnapShot_name

  Displays the name of snapshot group defined in the device.

• P/S

  Displays the attribute of the target LDEV. It displays P-VOL for the P-VOL and S-VOL for the S-VOL. In the list of snapshot, "-" is displayed.

• STAT

  Displays the following status of each snapshot data:

  • SMPP: The pair is being deleted.
  • PSUP: The pair is being suspended.
  • CPYD: The differential data is being copied.
  • Other statuses: See pairdisplay command.

• Serial#

  Displays the product serial number.

• LDEV#

  Displays the LDEV number related to the snapshot.

• MU#

  Displays the Mirror ID of the P-VOL for the snapshot.

• P-LDEV#

  Displays the LDEV number of the volume (P-VOL or S-VOL) of the pair associated with the snapshot data. If the LDEV that is paired belongs to a different virtual storage machine, "----" is displayed.

• PID

  Displays the pool ID.

• %

  When MODE is clone or cascade mode, displays one of the following according to the status of STAT:

  • When STAT is COPY, RCPY, SMPP, or PSUP: Displays the progress rate of each processing.
  • For other statuses: Displays the concordance rate between the P-VOL and the S-VOL of a pair.

    When MODE is other than clone or cascade mode, the concordance rate between the P-VOL and the S-VOL is always displayed regardless of the STAT status.

  The following shows the concordance rate for each pair status.

  • PSUS: 0% to 100%
  • RCPY: 0% to 100%¹
  • PAIR: 100%
  • COPY: 0% to 100%²
  • CPYD: 0% to 100%
  Note

  1. Displays the concordance rate before changing to RCPY status. The displayed value might decrease during RCPY status because the copy works.
  2. Displays the concordance rate before changing to COPY status. The displayed value does not change during COPY status.

• MODE

  Displays the status of snapshot data:

  • G: The snapshot data created in CTG mode.
  • W: The status when the data are written in the secondary volume from the host in the PSUS/PFUS status.
  • C: The snapshot data created in clone mode.
  • A: The snapshot data created in cascade mode.
  • D: The snapshot data created in Diff Clone mode that is used in the VASA environment.

• SPLT-TIME

  Displays the time when a snapshot data is created. When -format_time option is specified, displays in YYYY-MM-DDThh:mm:ss format. When -format_time option is not specified, indicates accumulated time in seconds from January 1, 1970 (GMT).

• SLU

  Displays whether the SLU attribute is set for the snapshot:

  • Y: The SLU attribute is set.
  • N: Non-SLU attribute is set.

    A hyphen (-) is displayed for unsupported DKCMAIN microcode version.

• C_LDEV#

  Displays the LDEV number of the diff compare volume (base volume), which is used for comparing the difference between the Diff Clone pair volumes in the VASA environment.

  A hyphen (-) is displayed for unsupported microcode version.

• P

  Displays the status of expansion processing of DP-VOL (VSP 5000 series, VSP G1x00 and VSP F1500and VSP G130, G/F350, G/F370, G/F700, G/F900 only).

  • E: Expansion is in progress.
  • N: Not processed.

  • - (hyphen): This information is not available.

  A hyphen (-) is displayed if the microcode version is not supported.

• R

  Displays the status of the Read Only attribute of the snapshot data (VSP 5000 seriesand VSP G130, G/F350, G/F370, G/F700, G/F900 only).

  • E: Read Only attribute is enabled.
  • D: Read Only attribute is disabled.
  • - (hyphen): This information is not available.

  A hyphen (-) is displayed if the microcode version is not supported.

Operate the specified snapshot group.

raidcom modify snapshot -ldev_id <ldev#> {-snapshotgroup <name> 
| -mirror_id <mu#>} -snapshot_data <op> [-copy_pace <copy pace>]
 
raidcom modify snapshot -snapshotgroup <name> -snapshot_data <op> 
[-copy_pace <copy pace>] 
 
raidcom modify snapshot -ldev_id <ldev#> -snapshot_data <op> 
[-copy_pace <copy pace>] 
 
raidcom modify snapshot -snapshotgroup <current name>
<new name> -snapshot_data rename

• -ldev_id <ldev#>

  Specifies the LDEV number of P-VOL (or S-VOL) to be performed.

• -snapshotgroup <name>

  Specifies the snapshot group name in which the snapshot data is included.

• -mirror_id <mu#>

  Specifies the mirror ID of a snapshot data.

• -snapshot_data <op>

  Specifies the operation to be performed for the specified snapshot group. The parameter of the operation to be specified is the following:

  • create: Creates snapshot data.¹
  • split: Creates snapshot data.¹
  • resync: Discards the created snapshot data.¹
  • restore: Restores the snapshot data.¹
  • clone: Clones pairs.²

• [-copy_pace <copy pace>]

  Specifies the copy speed. Enabled only when clone is specified for -snapshot_data. The following speeds can be specified:

  • slower
  • medium
  • faster

  When clone is specified for -snapshot_data, if you did not specify the copy speed, medium is set. When you specify a value other than clone, if you specify the copy speed, this option is not enabled.

• -snapshotgroup <current name> <new name> -snapshot_data rename

  Specifies when you change the snapshot group name. The snapshot group name specified in <current name> is changed to the name specified in <new name>.

The following shows the operation of the snapshot data with the combination of options and parameters:

Deletes the snapshot data and the snapshot group. The relevant snapshot data of the LDEV is deleted from the snapshot group by specifying LDEV number. When no snapshot data left in the snapshot group, the snapshot group is deleted.

raidcom delete snapshot {-snapshotgroup <name> | -ldev_id <ldev#> 
{-mirror_id <mu#> |-snapshotgroup <name> | -range tree}}

• -snapshotgroup <name>

  Specifies the snapshot group in which the target data to be deleted is included.

  If the snapshot group is specified as the target, all the snapshot data and the snapshot group are deleted.

• -ldev_id <ldev#>

  Specifies the LDEV number of P-VOL or S-VOL for the snapshot data to be deleted.

  When P-VOL is specified, specify the snapshot data by specifying the MU number or the snapshot group (Specifying the MU number or the snapshot group is mandatory).

  When you specify the S-VOL, do not specify a MU number or a Snapshot group. If you specify the MU number or the Snapshot group, the P-VOL of specified LDEV number becomes the subject of deletion.

• -mirror_id <mu#>

  Specifies the Mirror ID of the snapshot data to be deleted.

• -snapshotgroup <name>

  Specifies the snapshot group to be deleted.

  The smallest number of MU in the snapshot group becomes the subject to be deleted.

• -range tree

  Specify this option to delete snapshot data in all layers of a snapshot tree for which the root volume is specified by -ldev_id <ldev#>. To specify this option, the following conditions must be met:

  • Root volume is an LDEV specified by -ldev_id <ldev#>.
  • The pair to be deleted was created in the cascade or clone mode.
  • The user has the operation authority for volumes of all pairs to be deleted.
  Note

  When multiple snapshot trees are cloned, specify the root volume of the first snapshot tree for -ldev_id <ldev#>, and execute the command. Only the first snapshot tree is deleted, and the status of the pairs under the first snapshot tree changes to PSUE. Specify the root volume of a snapshot tree under the first snapshot tree for -ldev_id <ldev#>, and execute the command again. When this option is specified, the SIM code (4b3xxx) that indicates abnormal termination of the Thin Image option might be output. However, the snapshot tree has been deleted normally and there is no problem.