Shredding a 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 shreds an LDEV (basic volume) or DP volume. Overwrite the volume three times with dummy data. You can stop shredding before its completion. Change the status of the volume to be shredded to blocked. When shredding is complete, the status of the volume is automatically changed to normal. If you stopped shredding before completion, the status of the volume remains as blocked.

Notes when stopping shredding

If you make a request to stop shredding, all of the volumes that are currently being shredded are stopped.

Shredding might not stop even if you make a request to stop shredding. In such case, make the request according to the progress status of the shredding. The progress of the shredding can be checked from the value of the preparingOperationProgressRate attribute that is obtained from the information of the target volume.

  • When the value of the attribute is 0, shredding has not started.

    When the value is 0, shredding is not stopped even if a request is made.

    Request the stopping of the shredding after the value is greater than or equal to 1.

  • When a request for stopping shredding is made but the value of the attribute does not change to 100, shredding is not stopped.

    In such case, make a request to stop the shredding again.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/ldevs/object-ID/actions/shred/invoke

Request message

Object ID
Specify the value of ldevId that was obtained by the processing to get information about volumes.

Attribute

Type

Description

ldevId

int

(Required) Specify the LDEV number with a decimal (base 10) number.

Query parameters
None.
Body

The following is a coding example for performing shredding by specifying the dummy data pattern:

{
  "parameters": {
    "operationType": "start",
    "pattern": "F0F0F0"
  }
}

The following is a coding example for performing shredding without specifying the dummy data pattern:

{
  "parameters": {
    "operationType": "start"
  }
}

The following is a coding example for stopping shredding before completion:

{
  "parameters": {
    "operationType": "stop"
  }
}

Attribute

Type

Description

operationType

string

(Required) Run or stop shredding.

The specifiable values are as follows:

start: Run shredding

stop: Stop shredding

pattern

string

(Optional) Dummy data pattern to be used for the second overwrite

Specify a pattern consisting of 1 to 8 characters in a hexadecimal format.

Specification example: 0F0F0F

If the value is not specified, the default pattern FFFFFFFF will be used.

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 shredded volume

Action template

GET base-URL/v1/objects/ldevs/object-ID/actions/shred

Status codes

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 specified action cannot run because the volume meets one of the following conditions:

  • The LDEV status is normal or the status is being changed.
  • The LDEV is used as a Quorum disk.
  • The LDEV is used as a system disk.
  • The LDEV is used as a pool volume.
  • The LDEV is used as a deduplication system data volume (fingerprint).
  • The LDEV is used as a journal volume.
  • The LDEV is used as a pair volume of a global-active device.
  • The LDEV is used as a pair volume of ShadowImage.
  • The LDEV is used as a pair volume of TrueCopy or Universal Replicator.
  • The LDEV is used as a pair volume of Thin Image or Copy-on-Write Snapshot.

Coding example

To get an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/ldevs/100/actions/shred

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/ldevs/100/actions/shred/invoke