Getting a list of LUs defined for a port 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 the LUs that are defined for the port on an external storage system that is externally connected to the local storage system.

Note:

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-luns

Request message

Object ID: None.

Query parameters

When a Fibre Channel port is used:

Parameter	Type	Filter Condition
portId	string	(Required) Number of the port on the local storage system
externalWwn	string	(Required) WWN of the port on the external storage system

When an iSCSI port is used:

Parameter	Type	Filter Condition
portId	string	(Required) Port number on the local storage system
iscsiIpAddress	string	(Required) IP address of the iSCSI target on the external storage system
iscsiName	string	(Required) iSCSI name of the iSCSI target on the external storage system Specify this parameter in iqn or eui format.

Parameter

Type

Filter Condition

portId

string

(Required) Port number on the local storage system

iscsiIpAddress

string

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

iscsiName

string

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

Specify this parameter in iqn or eui format.

Body: None.

Response message

Body

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

{
  "data" : [ {
    "externalLun" : 0,
    "portId" : "CL7-A",
    "externalWwn" : "50060e80222fd141",
    "externalVolumeCapacity" : 62914560,
    "externalVolumeInfo" : "OPEN-V HITACHI 50412FD100CC"
  } ]
}

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

{
  "data" : [ {
    "externalLun" : 0,
    "portId" : "CL7-A",
    "externalVolumeCapacity" : 62914560,
    "externalVolumeInfo" : "OPEN-V HITACHI 50412FD100CC",
    "iscsiIpAddress" : "192.168.0.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.
externalLun	int	LUN that can be referenced from the port on the external storage system
externalVolumeCapacity	long	Capacity of the external volume on the external storage system (1 block = 512 bytes)
externalVolumeInfo	string	The product ID and the device identification (output in ASCII format) in the SCSI information for the external volume on the external storage system This information is obtained in a format in which the product ID and the device identification are concatenated by a space. If the LU cannot be used as an external volume group, `OTHER` is output for the product ID.

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-luns?portId=CL7-A&externalWwn=50060e80222fd141"