The following request creates an external parity group in a storage system, and then creates (maps) volumes for the storage system that is externally connected to the newly created external parity group. An external path group and external paths are also created at the same time. Volumes created by using this request are called external volumes.
Execution permission
- If the capacity of an external volume exceeds 4,194,304 MiB (4 TiB), an external volume with a capacity of 4,194,304 MiB (4 TiB) is created.
- Before using iSCSI for the connection, you must register the information about the external iSCSI targets to the local port for the external connection.
Storage Administrator (Provisioning)
Request line
POST base-URL/simple/v1/objects/external-volumes
Request message
- Body
-
The following are examples of creating an external volume:
- When an
FC:
{ "externalParityGroupId": "8-501", "externalPathGroupId": 501, "portId": "CL5-A", "externalPortWwn": "50060e8012000c60", "lun": 501 } - When an
iSCSI:
{ "externalParityGroupId": "9-1025", "externalPathGroupId": 1025, "portId": "CL1-B", "externalPortIpAddress": "10.1.2.122", "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d00b", "lun": 1025 }
Attribute
Type
Description
externalParityGroupId
string
(Required) ID of the external parity group
Specify a unique (unused) ID that is not being used for the external parity group.
Specify the ID in the format X-Y.
For X, you can specify an integer in the range from 1 through 16384.
For Y, you can specify an integer in the range from 1 through 4096.
Example: 1-1
externalPathGroupId
int
(Required) ID of the external path group
Specify a unique (unused) ID for the external path group.
You can specify an integer in the range from 0 to 63231.
portId
string
(Required) Port ID for connecting with the external storage system
externalPortWwn
string
(Optional) WWN of the port of the externally connected storage system
If you specify an FC port, you must specify this attribute.
If you specify an iSCSI port, any value specified for this attribute will be ignored.
externalPortIpAddress
string
(Optional) IP address of the port of the externally connected storage system
You can specify an IPv4 or IPv6 address.
If you specify an iSCSI port, you must specify this attribute.
If you specify an FC port, any value specified for this attribute will be ignored.
externalPortIscsiName
string
(Optional) Name of the iSCSI target for the port of the externally connected storage system
If you specify an iSCSI port, you must specify this attribute.
If you specify an FC port, any value specified for this attribute will be ignored.
lun
int
(Required) LUN assigned to the port of the externally connected storage system
- When an
FC:
Response message
- Body
-
Attribute
Type
Description
statusResource
string
URL to use to obtain the results of the newly-created external volumes
Note:Run the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.
Status codes
See HTTP status codes.
Coding example
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes