Canceling migration for an entire copy group

Execution permission

Storage Administrator (Local Copy)

Request line

POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/split/invoke

Request message

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 (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.
svolDeviceGroupName	string	(Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

Query parameters

None.

Body

{
  "parameters":{
    "forceSplit": true
  }
}

Attribute	Type	Description
forceSplit	boolean	(Optional) Specify whether to cancel migration. true: Cancel migration. false: Do not cancel migration. If this attribute is omitted, false is assumed.

Response message

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 copy group for which migration was canceled

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

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/vm-cg,dgp,dgs/actions/split/invoke