Managing ShadowImage pairs
You can perform operations on ShadowImage pairs, such as get information about copy groups, pair status, and configuration. You can create, split, resync, and delete pairs. ShadowImage pairs consist of a primary volume in the same storage system as the copy source and a secondary volume.
Overview of ShadowImage
ShadowImage creates a copy of a data volume in the same storage system as the copy source.
You can create a ShadowImage pair or manage the pair status by issuing an API from a REST API client. You can also operate ShadowImage pairs in units of copy groups. In addition, if you define a consistency group, the pair statuses of all pairs in the group are transited at the same time.
A ShadowImage pair consists of a primary volume (P-VOL) and a secondary volume (S-VOL). The primary volume can be paired with more than one secondary volume. Each secondary volume is managed according to the MU (mirror unit) number.
For details about ShadowImage, see the Hitachi ShadowImage® User Guide.
Workflow for operating ShadowImage pairs
The following shows the ShadowImage functions that can be run by the REST API:
-
Getting information about copy groups
Obtains a list of copy groups registered in the target storage system. You can also obtain information about a specific copy group.
-
Getting pair status and configuration information
Obtains a ShadowImage pair status and configuration information. You can check if a pair operation is complete. You can also obtain pair information in units of copy groups.
If the copy group in which the target ShadowImage pair is registered contains a ShadowImage pair that was created or deleted by using another REST API server or software other than the REST API, correct information about that pair might not be obtained. In such a case, update the information about the pairs to the most recent information before you obtain information.
-
Creating a pair
Creates a new ShadowImage pair in a copy group of the target storage system. A copy group is a group made up of copy pairs. Each copy group consists of a device group made up of primary volumes, and a device group made up of secondary volumes. If the copy group is not already created, the copy group and its corresponding device groups are automatically created. You will be able to perform operations in units of copy groups by registering ShadowImage pairs in a copy group.
To create a pair in a new copy group:
To create a pair in an existing copy group:
-
Splitting a pair
Splits a ShadowImage pair and enables read and write access for a secondary volume. You can also split pairs in units of copy groups.
-
Resynchronizing a pair
Resynchronizes a split ShadowImage pair based on the primary volume. Even during resynchronization, you can access the P-VOL. You can also resynchronize pairs in units of copy groups.
-
Resynchronizing a pair by a restore
Resynchronizes a split ShadowImage pair based on a secondary volume. During resynchronization by a restore, you cannot access the P-VOL. You can also perform a restore in units of copy groups.
-
Deleting a pair
Deletes a ShadowImage pair that is unnecessary. If you delete a pair, the pair is dissolved. The data in the primary volume and secondary volume remains unchanged. In addition, if you delete all the ShadowImage pairs in a copy group, the copy group and the device group included in the copy group are automatically deleted. You can also delete pairs in units of copy groups.
You can delete a pair at any time regardless of the pair status. However, if you delete a pair while the pair status is being changed, the pair might be deleted before its status is changed, and the request to change the pair status might time out.
During the creation, splitting, and resynchronizing of pairs, if multiple asynchronous processing requests are issued at the same time, jobs might get stuck and the job status might not change to Completed because data copying takes a long time. In such cases, specify Job-Mode-Wait-Configuration-Change:NoWait in the request header so that the job status changes to Completed without waiting for data copying to finish, and the next job starts. At this time, data copying continues even after job execution ends. To check whether data copying has finished, check the pair status of the target resource instead of the job status. For details about the pair status, see the description of the pair status transitions.
Pair status (ShadowImage)
The following explains the operations and status transitions for pairs.
Pair status |
Description |
Access to the P-VOL |
Access to the S-VOL |
SMPL |
Unpaired volumes |
- |
- |
COPY |
The pair is being created. An initial copy or resynchronization is being performed. |
R/W enabled |
R enabled |
PAIR |
Paired volumes The initial copy is complete. The update data of the P-VOL will be asynchronously copied to the S-VOL. |
R/W enabled |
R enabled |
PSUS |
The pair is being split by operation. (This value is output for the P-VOL.) |
R/W enabled |
R/W enabled |
SSUS |
The pair is being split by operation. (This value is output for the S-VOL when the P-VOL is PSUS.) |
R/W enabled |
R/W enabled |
PSUE |
The pairing is suspended due to a failure. The P-VOL and the S-VOL are not synchronized. |
R/W enabled |
R enabled |
RCPY |
A restore operation is being performed. (Data is being copied from the S-VOL to the P-VOL.) |
Not enabled |
R enabled |
If you delete a pair, the pair status changes to SMPL.
In the following cases, if you perform an operation on a pair, the request successfully returns a response, but the details specified in the request body are not actually applied:
- When you perform a pair splitting operation on a pair for which the status is PSUS or SSUS
- When you perform a pair resynchronization operation on a pair for which the status is COPY, PAIR, or RCPY
Getting a list of copy groups
The following request gets information about the copy groups containing ShadowImage pairs in the storage system.
If the copy group name or device group name contains spaces, the copy group information cannot be obtained.
Storage Administrator (View Only)
GET base-URL/v1/objects/local-clone-copygroups
Object ID
None.
Query parameters
None.
Body
None.
Body
{ "data": [ { "copyGroupName": "localCopyGroup1", "pvolDeviceGroupName": "localCopyGroup1P_", "svolDeviceGroupName": "localCopyGroup1S_", "localCloneCopygroupId": "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_" }, { "copyGroupName": "localCopyGroup2", "pvolDeviceGroupName": "localCopyGrouppvol", "svolDeviceGroupName": "localCopyGroupsvol", "localCloneCopygroupId": "localCopyGroup2,localCopyGrouppvol,localCopyGroupsvol" } ] }
Attribute
Type
Description
copyGroupName
string
Copy group name
pvolDeviceGroupName
string
Device group name for the P-VOL
svolDeviceGroupName
string
Device group name for the S-VOL
localCloneCopygroupId
string
Object ID of the copy group that contains a ShadowImage pair
The following attributes are output, separated by commas:
copyGroupName
pvolDeviceGroupName
svolDeviceGroupName
For details on the status codes of the request for this operation, see the section explaining HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups
Getting information about a specific copy group
The following request gets information about the specified copy group. This request also gets information about ShadowImage pairs included in the copy group. The request can be used to check the pair status or get configuration information about the pairs.
- If the target copy group contains a ShadowImage pair that was created or deleted by using another REST API server or software other than the REST API, correct information about that pair might not be obtained. To obtain the most recent information about such pairs, use the API for obtaining a list of ShadowImage pairs.
- If the copy group name, device group name, or copy pair name contains spaces, the information cannot be obtained.
Storage Administrator (View Only)
GET base-URL/v1/objects/local-clone-copygroups/object-ID
Object ID
Specify the
localCloneCopygroupId
value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specifies the device group name for the P-VOL. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specifies the device group name for the S-VOL. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
None.
Body
{ "localCloneCopygroupId" : "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_", "copyGroupName" : "localCopyGroup1", "pvolDeviceGroupName" : "localCopyGroup1P_", "svolDeviceGroupName" : "localCopyGroup1S_", "copyPairs" : [ { "localCloneCopypairId" : "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1", "copyGroupName" : "localCopyGroup1", "copyPairName" : "pair1", "replicationType" : "SI", "copyMode" : "NotSnapshot", "copyProgressRate" : 100, "pvolLdevId" : 10, "pvolStatus" : "PAIR", "svolLdevId" : 20, "svolStatus" : "PAIR", "pvolMuNumber" : 0 }, { "localCloneCopypairId" : "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair2", "copyGroupName" : "localCopyGroup1", "copyPairName" : "pair2", "replicationType" : "SI", "copyMode" : "NotSnapshot", "copyProgressRate" : 100, "pvolLdevId" : 30, "pvolStatus" : "PAIR", "svolLdevId" : 40, "svolStatus" : "PAIR", "pvolMuNumber" : 0 } ] }
Attribute
Type
Description
copyGroupName
string
Copy group name
pvolDeviceGroupName
string
Device group name for the P-VOL
svolDeviceGroupName
string
Device group name for the S-VOL
localCloneCopygroupId
string
Object ID of the copy group that contains a ShadowImage pair
The following attributes are output, separated by commas:
copyGroupName
pvolDeviceGroupName
svolDeviceGroupName
copyPairs
object[]
The following attributes about the ShadowImage pairs included in the copy group:
-
copyGroupName (string)
Copy group name
-
copyPairName (string)
Copy pair name
-
replicationType (string)
Pair type
Outputs SI (ShadowImage).
-
copyMode (string)
Copy mode
Outputs NotSnapshot.
-
copyProgressRate (int)
Copy progress rate (%)
This attribute is not output if no information can be obtained.
-
pvolLdevId (int)
LDEV number of the P-VOL
-
svolLdevId (int)
LDEV number of the S-VOL
-
pvolMuNumber (int)
MU number of the P-VOL
-
pvolStatus (string)
Pair volume status of the P-VOL
For details, see the section describing the pair status (ShadowImage).
This attribute is not output if no information can be obtained.
-
svolStatus (string)
Pair volume status of the S-VOL
For details, see the section describing the pair status (ShadowImage).
This attribute is not output if no information can be obtained.
-
consistencyGroupId (int)
Consistency group ID
This attribute is not output if no consistency group consists.
-
localCloneCopypairId (string)
Object ID of the ShadowImage pair
The following attributes are output, separated by commas:
copyGroupName
pvolDeviceGroupName
svolDeviceGroupName
copyPairName
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the section explaining HTTP status codes.
Status code |
Message |
Description |
404 |
Not Found |
No copy group can be obtained, or no pair was included in the copy group that was obtained. |
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_
Getting a list of ShadowImage pairs
The following request obtains information about the ShadowImage pairs in a copy group specified by using query parameters. You can also update the pair information when you obtain information about ShadowImage pairs.
- If the target copy group contains a ShadowImage pair that was created or deleted by
using another REST API server or software other than the REST API, information about
that pair might not be obtained. To obtain the most recent information about such pairs,
run the API with
refresh=true
specified for the query parameter. Note that such processing takes time because the information about the pairs in the specified copy group is updated, and then information is obtained. - If the copy group name, device group name, or copy pair name contains spaces, the information cannot be obtained.
Storage Administrator (View Only)
GET base-URL/v1/objects/local-clone-copypairs
Object ID
None.
Query parameters
Parameter
Type
Filter condition
localCloneCopyGroupId
string
(Required) Object ID of the copy group that contains a pair
Specify the
localCloneCopygroupId
value obtained by getting the list of copy groups. You can also specify the following attributes separated by a comma:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
- copyGroupName (string)
Copy group name
Value should not exceed 31 characters.
- pvolDeviceGroupName (string)
Device group name for the P-VOL
Value should not exceed 31 characters.
- svolDeviceGroupName (string)
Device group name for the S-VOL
Value should not exceed 31 characters.
refresh
boolean
(Optional) Whether to update the pair information to the most recent:
- true: Pair information will be updated.
- false: Pair information will not be updated.
If you specify true, processing takes time because the information about the pairs in the specified copy group is updated and then information is obtained. If this parameter is omitted, false is assumed.
- copyGroupName (string)
Body
None.
Body
Information about the pairs in the specified copy group is obtained in a list. For details about the response body, see the section describing the API for obtaining information about specific ShadowImage pairs.
For details on the status codes of the request for this operation, see the section explaining HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs?localCloneCopyGroupId=localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_&refresh=true"
Getting information about a specific ShadowImage pair
The following request gets information about the specified ShadowImage pair. This request can confirm whether a pair operation is finished based on the pair status, and can get configuration information such as the consistency group ID used when adding a pair.
- If the target ShadowImage pair was created or deleted by using another REST API server or software other than the REST API, correct information about that pair might not be obtained. To obtain the most recent information about the pairs, use the API for obtaining a list of ShadowImage pairs.
- If the copy group name, device group name, or copy pair name contains spaces, information cannot be obtained.
Storage Administrator (View Only)
GET base-URL/v1/objects/local-clone-copypairs/object-ID
Object ID
Specify the
localCloneCopypairId
value obtained by getting the ShadowImage pair information. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
copyPairName
string
(Required) Specify the name of the copy pair. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
None.
Body
{ "localCloneCopypairId" : "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1", "copyGroupName" : "localCopyGroup1", "copyPairName" : "pair1", "replicationType" : "SI", "copyMode" : "NotSnapshot", "copyProgressRate" : 100, "pvolLdevId" : 10, "pvolStatus" : "PAIR", "svolLdevId" : 20, "svolStatus" : "PAIR", "pvolMuNumber" : 0 }
Attribute
Type
Description
copyGroupName
string
Copy group name
copyPairName
string
Copy pair name
replicationType
string
Pair type
SI: ShadowImage
copyMode
string
Copy mode
Outputs NotSnapshot.
copyProgressRate
int
Copy progress rate (%)
This attribute is not output if no information can be obtained.
pvolLdevId
int
LDEV number of the P-VOL
svolLdevId
int
LDEV number of the S-VOL
pvolMuNumber
int
MU number of the P-VOL
pvolStatus
string
Pair volume status of the P-VOL
For details, see the section describing the pair status (ShadowImage).
This attribute is not output if no information can be obtained.
svolStatus
string
Pair volume status of the S-VOL
For details, see the section describing the pair status (ShadowImage).
This attribute is not output if no information can be obtained.
consistencyGroupId
int
Consistency group ID
This attribute is not output if no consistency group consists.
localCloneCopypairId
string
Object ID of the ShadowImage pair
The following attributes are output, separated by commas:
copyGroupName
pvolDeviceGroupName
svolDeviceGroupName
copyPairName
For details on the status codes of the request for this operation, see the section explaining HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1
Creating a ShadowImage pair
The following request creates a ShadowImage pair in the target storage system. The ShadowImage pair is either added to a newly created copy group or to an existing copy group.
Storage Administrator (Provisioning) and Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copypairs
Object ID
None.
Query parameters
None.
Body
{ "copyGroupName": "localCopyGroup1", "copyPairName": "pair1", "replicationType": "SI", "pvolLdevId": 10, "pvolMuNumber": 0, "svolLdevId": 20, "pvolDeviceGroupName": "localCopyGroup1P_", "svolDeviceGroupName": "localCopyGroup1S_", "isNewGroupCreation": true, "copyPace": 1, "isConsistencyGroup": true, "consistencyGroupId": 1, "quickMode": false, "autoSplit": false, "isDataReductionForceCopy": true }
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 29 characters. The name is case sensitive.
copyPairName
string
(Required) Specify the copy pair name. Value should not exceed 31 characters. The name is case sensitive.
replicationType
string
(Required) Specify SI (ShadowImage) as the pair type.
pvolLdevId
int
(Required) Specify the LDEV number of the P-VOL with a decimal (base 10) number.
svolLdevId
int
(Required) Specify the LDEV number of the S-VOL with a decimal (base 10) number.
pvolDeviceGroupName
string
(Optional) Specify the device group name for the P-VOL. Value should not exceed 31 characters. The name is case sensitive.
Specify a device group name that differs from the device group name for the S-VOL. In addition, to add a ShadowImage pair to an existing copy group, specify the device group name for an existing P-VOL.
If this value is omitted, copyGroupNameP_ is assumed.
svolDeviceGroupName
string
(Optional) Specify the device group name for the S-VOL. Value should not exceed 31 characters. The name is case sensitive.
Specify a device group name that differs from the device group name for the P-VOL. To add a ShadowImage pair to an existing copy group, specify the device group name for an existing S-VOL.
If this value is omitted, copyGroupNameS_ is assumed.
isNewGroupCreation
boolean
(Required) Depending on the value, this attribute specifies whether to add a ShadowImage pair to a newly created copy group or to an existing copy group.
Make sure that the ShadowImage pair is not added to a copy group that includes Volume Migration pairs.
- true: Adds the ShadowImage pair to a newly created copy group.
- false: Adds the ShadowImage pair to an existing copy group.
pvolMuNumber
int
(Optional) Specify the MU number of the P-VOL.
If you specify true for the
isNewGroupCreation
attribute, make sure to specify this attribute. If you specify false for theisNewGroupCreation
attribute, you cannot specify this attribute.- If the S-VOL is in layer 1, specify a value in the range from 0 to 2.
- If the S-VOL is in layer 2, specify 1 or 2.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
If this value is omitted, 3 is assumed.
isConsistencyGroup
boolean
(Optional) Depending on the value, this attribute specifies whether to register the new pair in a consistency group. If a pair that is already registered in the consistency group exists in the copy group, you can register the new pair in the same consistency group.
- true: Registers the pair in a consistency group.
- false: Does not register the pair in a consistency group.
When the value of the
autoSplit
attribute is true, you cannot specify true for this item.If this value is omitted, false is assumed.
consistencyGroupId
int
(Optional) To register the new pair in the consistency group, specify the consistency group ID (0 to 127). If a pair is already registered in a consistency group in a copy group, specify the ID of the consistency group to which the existing pair belongs.
If you specify true for the
isConsistencyGroup
attribute and do not specify this attribute, a new consistency group ID is assigned.autoSplit
boolean
(Optional) Depending on the value, this attribute specifies whether to split the pair automatically after the operation finishes.
- true: Splits the pair after the operation finishes
- false: Does not split the pair after the operation finishes
When the value of the
isConsistencyGroup
attribute is true, you cannot specify true for this item.If this value is omitted, false is assumed.
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
You can specify true for this item only when the value of the
autoSplit
attribute is true.If this value is omitted, false is assumed.
isDataReductionForceCopy
boolean
(Optional) Specify whether to forcibly create a pair for the volume for which the capacity saving function (dedupe and compression) is enabled.
- true: Forcibly create a pair#
- false: Do not forcibly create a pair
When the attribute is omitted, false is assumed.
#: Copying data of the volume for which the capacity saving function (compression or deduplication) is enabled might take up to several months, depending on the amount of data. Be sure to take this into account when planning when to create such a pair.
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section explaining job objects.Attribute
Description
affectedResources
URL of the created ShadowImage pair
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs
Splitting ShadowImage pairs in units of copy groups
The following request splits the ShadowImage pairs included in the specified copy group. If the pair is split, data can be read from or written to the secondary volume.
forceSplit
attribute in the action template is unnecessary.
When using the action template, remove this attribute before creating a
request.Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/split/invoke
Object ID
Specify the
localCloneCopygroupId
value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "quickMode": true, "copyPace": 10, "forceSuspend": false } }
Attribute
Type
Description
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
If this value is omitted, false is assumed.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
If you specify true for the forceSuspend attribute, you cannot specify this attribute.
forceSuspend
boolean
(Optional) Specify whether to force splitting of the pair.
- true: Forces splitting of the pair.
- false: Does not force splitting of the pair.
If this value is omitted, false is assumed.
If you specify true for this attribute, you cannot specify the
copyPace
attribute.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the split copy group
GET base-URL/v1/objects/local-clone-copygroups/object-ID/actions/split
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The action template cannot be obtained, because the object is incorrect. |
To get an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/split
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/split/invoke
Splitting a ShadowImage pair
The following request splits the specified ShadowImage pair. If the pair is split, data can be read from or written to the secondary volume.
forceSplit
attribute in the action template is unnecessary.
When using the action template, remove this attribute before creating a
request.Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copypairs/object-ID/actions/split/invoke
Object ID
Specify the
localCloneCopypairId
value obtained by getting the ShadowImage pair information. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
copyPairName
string
(Required) Specify the name of the copy pair. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "quickMode": true, "copyPace": 10, "forceSuspend": false } }
Attribute
Type
Description
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
If this value is omitted, false is assumed.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
If you specify true for the forceSuspend attribute, you cannot specify this attribute.
forceSuspend
boolean
(Optional) Specify whether to force splitting of the pair. - true: Forces splitting of the pair.
- false: Does not force splitting of the pair.
If this value is omitted, false is assumed.
If you specify true for this attribute, you cannot specify the
copyPace
attribute.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the split ShadowImage pair
GET base-URL/v1/objects/local-clone-copypairs/object-ID/actions/split
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The action template cannot be obtained, because the object is incorrect. |
To get an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1/actions/split
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1/actions/split/invoke
Resynchronizing ShadowImage pairs in units of copy groups
The following HTTP request resynchronizes ShadowImage pairs that were split in the specified copy group in the normal direction (from primary volumes to secondary volumes).
Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/resync/invoke
Object ID
Specify the
localCloneCopygroupId
value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "quickMode": true, "copyPace": 10 } }
Attribute
Type
Description
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
If this value is omitted, false is assumed.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the resynchronized copy group
GET base-URL/v1/objects/local-clone-copygroups/object-ID/actions/resync
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The action template cannot be obtained, because the object is incorrect. |
To get an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/resync
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/resync/invoke
Resynchronizing a ShadowImage pair
The following HTTP request resynchronizes a split ShadowImage pair in the normal direction (from the primary volume to the secondary volume).
Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copypairs/object-ID/actions/resync/invoke
Object ID
Specify the
localCloneCopypairId
value obtained by getting the ShadowImage pair information. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
copyPairName
string
(Required) Specify the name of the copy pair. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "quickMode": true, "copyPace": 10 } }
Attribute
Type
Description
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
If this value is omitted, false is assumed.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the resynchronized ShadowImage pair
GET base-URL/v1/objects/local-clone-copypairs/object-ID/actions/resync
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The action template cannot be obtained, because the object is incorrect. |
To get an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1/actions/resync
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1/actions/resync/invoke
Restoring ShadowImage pairs in units of copy groups
The following HTTP request resynchronizes ShadowImage pairs that were split in the specified copy group in the reverse direction (from secondary volumes to the primary volumes).
Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/restore/invoke
Object ID
Specify the
localCloneCopygroupId
value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "quickMode": true, "copyPace": 10 } }
Attribute
Type
Description
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
If this value is omitted, false is assumed.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the restored copy group
GET base-URL/v1/objects/local-clone-copygroups/object-ID/actions/restore
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The action template cannot be obtained, because the object is incorrect. |
To get an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/restore
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_/actions/restore/invoke
Restoring a ShadowImage pair
The following HTTP request resynchronizes a split ShadowImage pair in the reverse direction (from the secondary volume to the primary volume).
Storage Administrator (Local Copy)
POST base-URL/v1/objects/local-clone-copypairs/object-ID/actions/restore/invoke
Object ID
Specify the
localCloneCopypairId
value obtained by getting the ShadowImage pair information. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
copyPairName
string
(Required) Specify the name of the copy pair. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "quickMode": true, "copyPace": 10 } }
Attribute
Type
Description
quickMode
boolean
(Optional) Specify whether to run in quick mode.
- true: Performs execution in quick mode.
- false: Performs execution in normal mode.
If this value is omitted, false is assumed.
copyPace
int
(Optional) Specify a value in the range from 1 to 15 to be the copy speed. The larger the value, the higher the speed.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the restored ShadowImage pair
GET base-URL/v1/objects/local-clone-copypairs/object-ID/actions/restore
The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the section explaining HTTP status codes.
Status code |
Message |
Description |
412 |
Precondition Failed |
The action template cannot be obtained, because the object is incorrect. |
To get an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1/actions/restore
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1/actions/restore/invoke
Deleting a copy group
The following request deletes ShadowImage pairs by using the specified copy group. When the pairs are all deleted, the device groups are also deleted.
Storage Administrator (Provisioning) and Storage Administrator (Local Copy)
DELETE base-URL/v1/objects/local-clone-copygroups/object-ID
Object ID
Specify the
localCloneCopygroupId
value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
None.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the deleted copy group
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_
When a copy group cannot be deleted because the
device group in a local storage system remains or because the configuration is not
normal, you can forcibly delete the copy group by specifying the
forceDelete
attribute for the request body. The following shows
a coding example of using the forceDelete
attribute:
{ "forceDelete" : true }
Attribute |
Type |
Description |
forceDelete |
boolean |
(Optional) Specify whether to delete the copy group forcibly.
When the attribute is omitted, false is assumed. |
Deleting a ShadowImage pair
The following request deletes the specified ShadowImage pair. If there is no ShadowImage pair in the copy group, the copy group and the device group that makes up of the copy group are also deleted.
Storage Administrator (Provisioning) and Storage Administrator (Local Copy)
DELETE base-URL/v1/objects/local-clone-copypairs/object-ID
Object ID
Specify the
localCloneCopypairId
value obtained by getting the ShadowImage pair information. You can also specify the following attributes and connect them with commas:copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName
Attribute
Type
Description
copyGroupName
string
(Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.
pvolDeviceGroupName
string
(Required) Specify the P-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName
string
(Required) Specify the S-VOL device group name. Value should not exceed 31 characters. The name is case sensitive.
copyPairName
string
(Required) Specify the name of the copy pair. Value should not exceed 31 characters. The name is case sensitive.
Query parameters
None.
Body
None.
Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.
Attribute
Description
affectedResources
URL of the deleted ShadowImage pair
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1