Getting information about a specific 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
If you specify a port, the following request gets information about that iSCSI port of the remote storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-iscsi-ports/object-ID

Request message

Object ID

Specify the value of remoteIscsiPortId that was obtained by the processing to get information about the port. You can also specify the attributes and connect them with commas as follows:

localPortId,remoteSerialNumber,remoteStorageTypeId,remotePortId

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

Query parameters

None.

Body

None.

Response message

Body

The following is an example of the output when information about the remote storage system is not registered on the REST API server:

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

The following is an example of the output when information about the remote storage system is registered on the REST API server:

{
  "remoteIscsiPortId": "CL1-B,410012,M8,CL2-D",
  "localPortId": "CL1-B",
  "remoteStorageDeviceId": "886000410012",
  "remoteSerialNumber": "410012",
  "remoteStorageModel": "VSP G900",
  "remoteStorageTypeId": "M8",
  "remotePortId": "CL2-D",
  "remoteIpAddress": "192.168.116.29",
  "remoteTcpPort": 3260
}

Attribute

Type

Description

remoteIscsiPortId

string

Object ID for the iSCSI port

localPortId

string

Port number of the local storage system

remoteStorageDeviceId

string

Storage device ID of the remote storage system

This attribute is output when information about the remote storage system is registered on the REST API server.

remoteSerialNumber

string

Serial number of the remote storage system

remoteStorageModel

string

Model type of the remote storage system

This attribute is output when information about the remote storage system is registered on the REST API server.

remoteStorageTypeId

string

ID that indicates the model of the remote storage system

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

remotePortId

string

Port number of the remote storage system

remoteIpAddress

string

IP address of the remote storage system

remoteTcpPort

int

TCP port number of the remote 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 GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-iscsi-ports/CL1-B,410012,M8,CL2-D