DeleteVolume
Suggest changes
PDFs
You can use the DeleteVolume method to mark an active volume for deletion. When marked, the volume is purged (permanently deleted) after the cleanup interval elapses.
After making a request to delete a volume, any active iSCSI connections to the volume are immediately terminated and no further connections are allowed while the volume is in this state. A marked volume is not returned in target discovery requests.
Any snapshots of a volume that has been marked for deletion are not affected. Snapshots are kept until the volume is purged from the system. If a volume is marked for deletion and has a bulk volume read or bulk volume write operation in progress, the bulk volume read or write operation is stopped.
If the volume you delete is paired with a volume, replication between the paired volumes is suspended and no data is transferred to it or from it while in a deleted state. The remote volume the deleted volume was paired with enters into a PausedMisconfigured state and data is no longer sent to it or from the deleted volume. Until the deleted volume is purged, it can be restored and data transfers resume. If the deleted volume gets purged from the system, the volume it was paired with enters into a StoppedMisconfigured state and the volume pairing status is removed. The purged volume becomes permanently unavailable.
Parameter
This method has the following input parameter:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
volumeID |
The ID of the volume to delete. |
integer |
None |
Yes |
Return values
This method has the following return values:
Name |
Description |
Type |
volume |
Object containing information about the deleted volume. |
|
volumeID |
The volumeID of the deleted volume. |
integer |
curve |
The curve is a set of key-value pairs. The keys are the I/O sizes in bytes. The values represent the cost of performing an IOP at a specific I/O size. The curve is calculated relative to a 4096 byte operation set at 100 IOPS. |
JSON object |
Request example
Requests for this method are similar to the following example:
{
"method": "DeleteVolume",
"params": {
"volumeID" : 5
},
"id" : 1
}
Response example
This method returns a response similar to the following example:
{
"id": 1,
"result": {
"volume": {
"access": "readWrite",
"accountID": 1,
"attributes": {
"name1": "value1",
"name2": "value2",
"name3": "value3"
},
"blockSize": 4096,
"createTime": "2016-03-28T16:16:13Z",
"deleteTime": "2016-03-31T22:59:42Z",
"enable512e": true,
"iqn": "iqn.2010-01.com.solidfire:jyay.1459181777648.5",
"name": "1459181777648",
"purgeTime": "2016-04-01T06:59:42Z",
"qos": {
"burstIOPS": 150,
"burstTime": 60,
"curve": {
"4096": 100,
"8192": 160,
"16384": 270,
"32768": 500,
"65536": 1000,
"131072": 1950,
"262144": 3900,
"524288": 7600,
"1048576": 15000
},
"maxIOPS": 100,
"minIOPS": 60
},
"scsiEUIDeviceID": "6a79617900000005f47acc0100000000",
"scsiNAADeviceID": "6f47acc1000000006a79617900000005",
"sliceCount": 1,
"status": "deleted",
"totalSize": 1000341504,
"virtualVolumeID": null,
"volumeAccessGroups": [
1
],
"volumeID": 5,
"volumePairs": []
}
}
}
New since version
9.6