Changing the drive settings

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 request below configures a drive. You can use this request to assign a specified drive as a spare drive and to release the assignment of a specified drive.

Note:

You can use this API function for VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/v1/objects/drives/object-ID

Request message

Object ID

Specify the driveLocationId value obtained by getting information about the drive list.

Attribute	Type	Description
driveLocationId	string	(Required) Drive location (location of the drive box)

Query parameters: None.

Body

{
  "isSpareEnabled": false
}

Attribute	Type	Description
isSpareEnabled	boolean	(Required) Spare drive setting `true`: Assigns the specified drive as a spare drive. `false`: Releases the assignment as a spare drive.

Attribute

Type

Description

isSpareEnabled

boolean

(Required) Spare drive setting

true: Assigns the specified drive as a spare drive.
false: Releases the assignment as a spare drive.

Response message

Body

A job object is returned. For details on the attributes other than affectedResources, see the section explaining job objects.

Attribute	Description
affectedResources	URL of the drive whose setting was changed

Status codes

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

Action template

None.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/drives/0-0