Registering an iSCSI port

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 registers the iSCSI port of the remote storage system to the iSCSI port of the local storage system. You can specify the serial number and the series name of the remote storage system to register an iSCSI port. Alternatively, you can specify the storage device ID of the remote storage system to register an iSCSI port. Perform this operation before adding a remote path to a remote connection.

Execution permission

Storage Administrator (Remote Copy)

Request line

POST base-URL/v1/objects/remote-iscsi-ports

Request message

Object ID
None.
Query parameters
None.
Body

The following is a coding example for registering an iSCSI port by specifying the serial number, series name, and the TCP port number of the remote storage system:

{
  "localPortId": "CL1-B",
  "remoteSerialNumber": "492015",
  "remoteStorageTypeId": "M8",
  "remotePortId": "CL2-D",
  "remoteIpAddress": "192.168.116.29",
  "remoteTcpPort": 3260
}

The following is a coding example for registering an iSCSI port by specifying the serial number and the series name of the remote storage system, without specifying the TCP port number:

{
  "localPortId": "CL1-B",
  "remoteSerialNumber": "492015",
  "remoteStorageTypeId": "M8",
  "remotePortId": "CL2-D",
  "remoteIpAddress": "192.168.116.29"
}

When registering an iSCSI port by specifying the serial number and the series name of the remote storage system:

Attribute

Type

Description

localPortId

string

(Required) Port number of the local storage system

remoteSerialNumber

string

(Required) Serial number of the remote storage system

remoteStorageTypeId

string

(Required) ID that indicates the model of the remote storage system

You can specify the following values:

  • R9: VSP 5000 series
  • M8: VSP E series, VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900

remotePortId

string

(Required) Port number of the remote storage system

remoteIpAddress

string

(Required) IP address of the remote storage system

You can specify an IPv4 or IPv6 address.

remoteTcpPort

int

(Optional) TCP port number

If this attribute is not specified, the TCP port number for the iSCSI target of the local storage system will be set to the TCP port number of the remote storage system.

The following is a coding example for registering an iSCSI port by specifying the storage device ID and the TCP port number of the remote storage system:

{
  "localPortId": "CL1-B",
  "remoteStorageDeviceId": "886000492015",
  "remotePortId": "CL2-D",
  "remoteIpAddress": "192.168.116.29"
}

When registering the iSCSI port by specifying the storage device ID of the remote storage system:

Attribute

Type

Description

localPortId

string

(Required) Port number of the local storage system

remoteStorageDeviceId

string

(Required) Storage device ID of the remote storage system

remotePortId

string

(Required) Port number of the remote storage system

remoteIpAddress

string

(Required) IP address of the remote storage system

You can specify an IPv4 or IPv6 address.

remoteTcpPort

int

(Optional) TCP port number

If this attribute is not specified, the TCP port number for the iSCSI target of the local storage system will be set to the TCP port number of the remote storage system.

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 iSCSI port of the remote storage system that was registered to the iSCSI port of the local storage system

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/remote-iscsi-ports