Registering an iSCSI name of an external storage system to a port on the local storage system

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
This request registers an iSCSI name of an external storage system to a port on the local storage system.

After registering the iSCSI name, run the API request that performs a login test to verify that you can log in. If the attempt to log in fails, revise the settings so that you can log in, or delete that iSCSI target. If iSCSI targets remain to which you cannot log in, attempts to obtain information might fail because a heavy load might be placed on the network or external storage system when you search for an iSCSI target of a port on the external storage system.

Note:
  • 0 is assumed for the virtual port ID if virtual port mode is enabled for the local storage system.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/iscsi-ports/object-ID/actions/register/invoke

Request message

Object ID

Specify the value of portId that was obtained by the processing to get information about ports.

Attribute

Type

Description

portId

string

(Required) Port number of the local storage system

Query parameters
None.
Body
{
    "parameters": {
        "iscsiIpAddress": "192.168.0.100",
        "iscsiName": "iqn.rest.example.of.iscsi1",
        "tcpPort" : 3260
    }
}

Attribute

Type

Description

iscsiIpAddress

string

(Required) IP address of the iSCSI target on the external storage system

Specify an IPv4 or IPv6 IP address.

iscsiName

string

(Required) iSCSI name of the iSCSI target on the external storage system

Specify the name in iqn or eui format.

This attribute is case sensitive.

tcpPort

int

(Optional) TCP port number of the iSCSI target on the external storage system

If this attribute is omitted, the TCP port number of the port on the local storage system is assumed.

If the iSCSI name and IP address to be specified are already registered to a port of the local storage system, set the same value as that port or omit this attribute. If you omit this attribute in this situation, the following settings are applied:
  • If the iSCSI name and IP address are already registered to the same port as the port specified for object-ID, the registered tcpPort value is not changed.
  • If the iSCSI name and IP address are registered to a port different from the port specified for object-ID, the same value as the value that was set for tcpPort when the iSCSI name and IP address were registered to that port is set for the port specified for object-ID.

Response message

A job object is returned. For details about attributes other than affectedResources, see the description of job objects.

Attribute

Description

affectedResources

URL of the port (on the local storage system) to which information about the iSCSI name of the external storage system is registered

Action template

None.

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session f76884c29fff4dfaa664aa6981087b71" -X POST "https://192.0.2.100/ConfigurationManager/v1/objects/iscsi-ports/CL1-A/actions/register/invoke"