Getting a list of ports on an external 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
The following request acquires a list of ports for an external storage system that is connected to the local storage system.
Note:
  • In the case of an iSCSI port, if an iSCSI target that cannot connect to the target iSCSI port is registered, attempts to obtain information might fail because a heavy load might be placed on the network or external storage system. After registering the iSCSI name, perform a login test to verify that you can log in.

  • If you use a port for external connections as the endpoint of an I/O path from an external storage system to a local storage system, the I/O path might become disconnected. Use a route that can be used as an external path. For details about external paths, see the Hitachi Universal Volume Manager User Guide.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/external-storage-ports

Request message

Object ID
None.
Query parameters

Parameter

Type

Filter condition

portId

string

(Required) Number of the port on the local storage system

Body
None.

Response message

Body

The following is a coding example when a Fibre Channel port is used:

{
  "data" : [ {
    "externalWwn" : "50060e80222fd141",
    "portId" : "CL7-A",
    "externalSerialNumber" : "477777",
    "externalStorageInfo" : "HITACHI VSP Gx00",
    "externalPathMode" : "Multi",
    "externalIsUsed" : false
  } ]
}

The following is a coding example when an iSCSI port is used:

{
  "data" : [ {
    "portId" : "CL2-D",
    "externalSerialNumber" : "477777",
    "externalStorageInfo" : "HITACHI VSP Gx00",
    "externalPathMode" : "Multi",
    "externalIsUsed" : true,
    "iscsiIpAddress" : "192.0.1.100",
    "iscsiName" : "iqn.rest.example.of.iscsi1",
    "virtualPortId" : 0
  } ]
}

Attribute

Type

Description

portId

string

Number of the port on the local storage system

externalWwn

string

WWN of the port on the external storage system

This attribute is displayed when a Fibre Channel port is used.

iscsiIpAddress

string

IP address of the iSCSI target on the external storage system

This attribute is displayed when an iSCSI port is used.

iscsiName

string

Name of the iSCSI target on the external storage system

This attribute is displayed when an iSCSI port is used.

virtualPortId

int

Virtual port ID

This attribute is displayed when an iSCSI port is used and virtual port mode is enabled.

externalSerialNumber

string

Serial number of the external storage system

externalStorageInfo

string

The vendor information and product ID of the external storage system

This information is obtained in a format in which the vendor information and product ID are concatenated by a space.

externalPathMode

string

Path mode for the external path of the port on the external storage system

  • Multi: Multi mode
  • Single: Single mode
  • APLB: APLB mode

externalIsUsed

boolean

Whether the port of the external storage system that is externally connected to the local storage system is being used to map external volumes

  • true: Used
  • false: Not used

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/external-storage-ports?portId=CL7-A