Deleting a copy group (Volume Migration)

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request deletes pairs by using the specified copy group. When the pairs are all deleted, the device groups are also deleted.

Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Local Copy)

Request line

DELETE base-URL/v1/objects/local-clone-copygroups/object-ID

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
None.

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 deleted copy group

Coding example

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 forcibly deleting a copy group

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.

  • true: Forcibly delete the copy group.
  • false: Do not forcibly delete the copy group.

When the attribute is omitted, false is assumed.