Mapping 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 creates an external parity group on the local storage system, and then registers (maps) volumes on an external storage system to the created external parity group. When a volume is mapped, the external path group and the external path are also created.
Important:

The API request for mapping an external volume can be used only when Fibre Channel ports are used. The request cannot be used when iSCSI ports are used.

If you are using an iSCSI port, use storage management software such as CCI. For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage systems, you can perform this operation by using the Platform REST API (Simple). For detailed information about this operation, see the Hitachi Storage Advisor Embedded Guide on the Hitachi Vantara Knowledge website.

Note:

If you use a port for external connections as the endpoint of an I/O path from an external storage system to a local storage system, the I/O path might become disconnected. Use a route that can be used as an external path. For details about external paths, see the Hitachi Universal Volume Manager User Guide.

Execution permission

Storage Administrator (Provisioning)

Request line

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

Request message

Object ID

None.

Query parameters
None.
Body
{   "externalParityGroupId":"1-1",
    "externalPathGroupId":1,
    "portId":"CL7-A",
    "externalWwn":"50060e80222fd141",
    "lunId":0,
    "emulationType":"OPEN-V",
    "clprId":0
}

Attribute

Type

Description

externalParityGroupId

string

(Required) External parity group number

Specify the number in gno-sgno format.

externalPathGroupId

int

(Required) External path group ID

If the specified path group ID does not exist, a new path group ID will be created.

portId

string

(Required) Number of the port on the local storage system

externalWwn

string

(Required) WWN of the external storage system

lunId

int

(Required) LUN of the port on the external storage system

emulationType

string

(Optional) Emulation type

Specifiable values are as follows:

OPEN-3 , OPEN-8 , OPEN-9 , OPEN-E , OPEN-K , OPEN-L , OPEN-V , 3380-3 , 3380-3A , 3380-3B , 3380-3C , 3390-1 , 3390-2 , 3390-3 , 3390-A , 3390-3A , 3390-3B , 3390-3C , 3390-3R , 3390-9 , 3390-9A , 3390-9B , 3390-9C , 3390-L , 3390-LA , 3390-LB , 3390-LC , 3390-M , 3390-MA , 3390-MB , 3390-MC , 3390-V , 6586-G , 6586-J , 6586-K , 6586-KA , 6586-KB , 6586-KC , 6588-1 , 6588-3 , 6588-9 , 6588-A , 6588-3A , 6588-3B , 6588-3C , 6588-9A , 6588-9B , 6588-9C , 6588-L , 6588-LA , 6588-LB , 6588-LC

If this attribute is omitted, OPEN-V is set.

clprId

int

(Optional) CLPR number to be used by the external parity group

Specify a decimal (base 10) number in the range from 0 to 31.

If this attribute is omitted, 0 is set.

isExternalAttributeMigration

boolean

(Optional) Whether to set the nondisruptive migration attribute for the external parity group

  • true: Set the attribute.
  • false: Do not set the attribute

If this attribute is omitted, false is set.

commandDeviceLdevId

int

(Optional) LDEV number of the remote command device

Specify this attribute if you want to map the command device of the external storage system.

The specified LDEV number is assigned to the remote command device.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects. To check whether the execution results of this API request have been correctly applied, execute the API request for getting information about the external paths.

Attribute

Description

affectedResources

URL of the mapped external parity 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 POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/external-parity-groups