Unmapping an external volume

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 unmaps an external volume by deleting the external parity group. If the last external parity group is deleted, the external path group itself is also deleted.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/v1/objects/external-parity-groups/object-ID

Request message

Object ID

Specify the value of externalParityGroupId that was obtained by the processing to get information about the external path group.

Attribute

Type

Description

externalParityGroupId

string

(Required) External parity group number

Query parameters
None.
Body
{
  "force": true
}

Attribute

Type

Description

force

boolean

(Optional) Specify whether to forcibly unmap the external volume without destaging it.

Specify true to unmap the external volume without destaging it.

  • true: Forcibly unmap the external volume.

  • false: Unmap the external volume only if the external volume has been destaged.

If this attribute is omitted, false is set.

If you specify false, first execute the API function to disconnect the external volume.

Response message

Body

A job object is returned. See the description for the job object. affectedResources is not displayed for this API. To check whether the unmapping was successful, execute the API request for getting information about an external path group.

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/external-parity-groups/1-1