Getting iSCSI names

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
Specifying a port and iSCSI target, the following request gets the iSCSI name information registered for the iSCSI target.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/host-iscsis

Request message

Object ID
None.
Query parameters

Parameter

Type

Filter Condition

portId

string

(Required) Port number

hostGroupNumber

int

(Optional) Target ID of the iSCSI target

You must specify one of the following parameters: this parameter, the hostGroupName parameter, or the hostGroupNumberList parameter.

hostGroupName

string

(Optional) Name of the iSCSI target

You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupNumberList parameter.

hostGroupNumberList

string

(Optional) Target IDs of iSCSI targets

You can obtain information quickly by specifying this parameter.

To specify multiple IDs, delimit each ID by using a comma.

You must specify one of the following parameters: this parameter, the hostGroupNumber parameter, or the hostGroupName parameter.

displayHostGroupName

boolean

(Optional) If you specify the hostGroupNumberList parameter, specify whether to get the names of the iSCSI targets (the values of the hostGroupName attribute).

If you specify false, the processing will take shorter than if you were to specify true.

  • true: Obtain the names of the iSCSI targets.
  • false: Do not obtain the names of the iSCSI targets.

If you specify this parameter but do not specify the hostGroupNumberList parameter, this parameter will be ignored.

If this parameter is omitted, the value true is assumed.

Body
None.

Response message

Body
{
  "data": [
    {
      "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3A496799ba93",
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "hostGroupName": "1D-G00",
      "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
      "iscsiNickname": "a_a"
    },
    {
      "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3Aa7526e46aac.target",
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "hostGroupName": "1D-G00",
      "iscsiName": "iqn.1994-05.com.redhat:a7526e46aac.target",
      "iscsiNickname": "a_a"
    }
  ]
}

Attribute

Type

Description

hostIscsiId

string

Object ID for the iSCSI name

portId

string

Port number

hostGroupNumber

int

Target ID of the iSCSI target

hostGroupName

string

Name of the iSCSI target

This attribute will not be obtained if the hostGroupNumberList parameter is specified as a query parameter and false is specified for the displayHostGroupName parameter.

iscsiName

string

iSCSI name of the host bus adapter (iSCSI initiator) registered for the iSCSI target

iscsiNickname

string

iSCSI nickname

Status codes

For details on the status codes of the request for this operation, see the section explaining 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/host-iscsis?portId=CL1-D&hostGroupNumber=1"