Getting information about LU paths

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 gets information about LU paths defined for the iSCSI target or the host group for the port.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/luns

Request message

Object ID
None.
Query parameters

Parameter

Type

Filter Condition

portId

string

(Required) Port number

hostGroupNumber

int

(Required) Host group number (for an iSCSI target, this is the target ID)

You must specify either this parameter or the hostGroupNumberList parameter.

isBasicLunInformation

boolean

(Optional) Specify whether to get only basic information.

  • true: Gets only basic information. (Does not get the host reservation status.)
  • false: Gets all the items.

If this parameter is omitted, false is assumed.

lunOption

string

(Optional) Specify the type of information you want to get.
  • ALUA: Gets information about ALUA settings.

If you specify both this parameter and the hostGroupNumberList parameter, this parameter will be ignored.

hostGroupNumberList

string

(Optional) Host group number (for an iSCSI target, this is the target ID)

You can obtain information quickly by specifying this parameter. If you specify this parameter, the value of the hostModeOptions attribute is not obtained.

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

You must specify either this parameter or the hostGroupNumber parameter.

Body

None.

Response message

Body

The following is an example of the output when only basic information is obtained:

{
  "data": [
    {
      "lunId": "CL1-A,1,1",
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "hostMode": "LINUX/IRIX",
      "lun": 1,
      "ldevId": 1,
      "isCommandDevice": false
    },
    {
      "lunId": "CL1-A,1,2",
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "hostMode": "LINUX/IRIX",
      "lun": 2,
      "ldevId": 2,
      "isCommandDevice": false
    }
  ]
}

The following is an example of the output generated when getting information about all items:

{
  "data": [
    {
      "lunId": "CL1-A,1,1",
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "hostMode": "LINUX/IRIX",
      "lun": 1,
      "ldevId": 1,
      "isCommandDevice": false,
      "luHostReserve": {
        "openSystem": false,
        "persistent": false,
        "pgrKey": false,
        "mainframe": false,
        "acaReserve": false
      }
    }
  ]
}

Attribute

Type

Description

lunId

string

Object ID for the LUN

portId

string

Port number

hostGroupNumber

int

Host group number of the port (for an iSCSI target, this is the target ID)

hostMode

string

Host mode for setting the host adapter of the host group

For details on the values to be obtained, see the description of the API function for changing the host group or iSCSI target settings.

lun

int

LUN between the host group and the mapped LDEV

ldevId

int

LDEV number

isCommandDevice

boolean

Gets information about whether the device is a command device.

luHostReserve

object

Host reservation status of the LU

When false is specified for isBasicLunInformation and the LU is in the reserved status, the following attributes are output:

  • openSystem (boolean)

    Indicates whether the LU is reserved for open systems.

  • persistent (boolean)

    Indicates whether the LU is in the persistent reservation status.

  • pgrKey (boolean)

    Indicates whether the LU is reserved by a PGR key.

  • mainframe (boolean)

    Indicates whether the LU is reserved for mainframes.

  • acaReserve (boolean)

    Indicates whether the LU is in the ACA reservation status.

hostModeOptions

int[]

Number of the host mode option set for the host group

This is not output if a host mode option is not set.

This attribute is not output if hostGroupNumberList is specified as a query parameter.

For details on the number to be obtained, see the Provisioning Guide for Open Systems , or the Provisioning Guide .

isAluaEnabled

boolean

Whether the ALUA attribute is enabled:

This attribute is displayed only if you specified ALUA for lunOption in the query parameters.

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

asymmetricAccessState

string

Priority level of the ALUA path

This attribute is displayed only if you specified ALUA for lunOption in the query parameters.

  • Active/Optimized: Higher priority
  • Active/Non-Optimized: Lower priority
  • Not Supported: Not supported

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

When getting only basic information:

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/luns?portId=CL1-A&hostGroupNumber=1&isBasicLunInformation=true"

When getting information about all items:

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/luns?portId=CL1-A&hostGroupNumber=1"