Registering the iSCSI name for the iSCSI target

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
For the iSCSI target of the specified port, the following request registers the iSCSI name of the host on the initiator side.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/host-iscsis

Request message

Object ID
None.
Query parameters
None.
Body
{
  "portId": "CL1-D",
  "hostGroupNumber": 1,
  "iscsiName": "iqn.myrestapiiscsi20150907"
}

Attribute

Type

Description

iscsiName

string

(Required) iSCSI name of the host bus adapter (iSCSI initiator)

Specify this item in the iqn or eui format.

  • iqn format

    Specify a value in the range from 5 to 223. You can use the following characters:

    Alphanumeric characters (lowercase), periods (.), hyphens (-), and colons (:)

    Specification example: iqn.2014-04.jp.co.hitachi:xxx.h70.i.62510.1a.ff

  • eui format

    After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters.

    Specification example: eui.ABCDEF1234567890

portId

string

(Required) Port number

hostGroupNumber

int

(Required) Target ID of the iSCSI target

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 registered iSCSI name

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/host-iscsis