Creating a parity group

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 creates a parity group.
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

POST base-URL/v1/objects/parity-groups

Request message

Object ID

None.

Query parameters

None.

Body
The following coding example creates a parity group:
{
  "parityGroupId": "2-10",
  "driveLocationIds": ["1-1","1-2","1-3","1-4"],
  "raidType": "3D+1P",
  "isEncryptionEnabled": false,
  "isCopyBackModeEnabled": true,
  "isAcceleratedCompressionEnabled": true,
  "clprId": 1
}

The following coding example creates a distributed parity group by concatenating two parity groups:

{
  "concatenatedParityGroupIds": ["2-9","2-10"],
  "driveLocationIds": ["1-1","1-2","1-3","1-4","1-5","1-6","1-7","1-8"],
  "raidType": "2D+2D",
  "isEncryptionEnabled": false,
  "isCopyBackModeEnabled": true,
  "isAcceleratedCompressionEnabled": true,
  "clprId": 1
}

Attribute

Type

Description

parityGroupId

string

(Optional) Parity group number

Specify the number in gno-sgno format.

Be sure to specify the parityGroupId attribute or the concatenatedParityGroupIds attribute.

concatenatedParityGroupIds

string[]

(Optional) To configure a distributed parity group, specify the parity group numbers of concatenated parity groups.

The concatenated parity groups will be created in the order in which the driveLocationIds attribute is specified.

Be sure to specify the parityGroupId attribute or the concatenatedParityGroupIds attribute.

driveLocationIds

string[]

(Required) Drive location

Specify the locations of the drives to be used to create to the parity group.

raidType

string

(Required) RAID type

Specify one of the following values:

  • 2D+2D
  • 3D+1P
  • 4D+1P
  • 6D+1P
  • 7D+1P
  • 6D+2P
  • 12D+2P
  • 14D+2P

isEncryptionEnabled

boolean

(Optional) Specify whether to enable the encryption function for the parity group.

  • true: Enable the encryption function.
  • false: Disable the encryption function.

You cannot specify true if you specify true for the isAcceleratedCompressionEnabled attribute.

If you omit this item, false will be set.

isCopyBackModeEnabled

boolean

(Optional) Specify whether to enable copy back mode for the parity group.

  • true: Enable copy back mode.
  • false: Disable copy back mode.

If you omit this item, true will be set.

isAcceleratedCompressionEnabled

boolean

(Optional) Specify whether to enable accelerated compression for the parity group.

  • true: Enable accelerated compression.
  • false: Disable accelerated compression.

You cannot specify true if you specify true for the isEncryptionEnabled attribute.

If you omit this item, false will be set.

clprId

int

(Optional) CLPR number

Specify a CLPR number in the range from 0 to 31.

If you omit this item, 0 will be set.

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 created parity group

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 section explaining HTTP status codes.

Status codes

Message

Description

409

Conflict

The parity group is already created with the specified parity group number or the concatenated parity group number.

Coding example

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/parity-groups