Getting port information

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 obtains information about ports.

Execution permission

Important:
  • If the storage system model is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, if you execute this API request with detailInfoType=logins specified, pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

  • Pay attention to the number of concurrent executions if this API request is run when the storage system is VSP E1090 or VSP E1090H, detailInfoType=loginHostNqn is specified in the query, and portId is not specified. For details, see "Implementing retry processing".

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/ports

Request message

Object ID
None.
Query parameters

You can filter execution results by specifying conditions, or get additional detailed port information.

When filtering execution results:

Parameter

Type

Filter condition

portType

string

(Optional) Port type

You can specify the following conditions:

  • FIBRE
  • SCSI
  • ISCSI
  • ENAS
  • ESCON
  • FICON

If this parameter is omitted, information about ports of all port types will be obtained.

If you specify portId, you cannot specify this parameter.

portAttributes

string

(Optional) Port attribute

You can specify the following conditions:

  • TAR: Target port (Fibre Target port)
  • MCU: Initiator port (MCU Initiator port)
  • RCU: RCU target port (RCU Target port)
  • ELUN: External port (External Initiator port)

If this parameter is omitted, information about all port attributes will be obtained.

Information about bidirectional ports will be obtained regardless of which value is specified for this parameter.

If you specify portId, you cannot specify this parameter.

portId

string

(Optional) Port number

If this parameter is omitted, information about all port numbers will be obtained. If you specify this parameter, be sure to specify logins or loginHostNqn for the detailInfoType parameter. Note that the portType parameter and the portAttributes parameter cannot be specified at the same time.

When collecting additional detailed information:

Parameter

Type

Description

detailInfoType

string

(Optional) Type of detailed information to be obtained

You can use this parameter together with parameters that filter the execution results.

  • logins: Information about logins to a port corresponding to the WWN of an HBA or iSCSI name

    You can get this information if the port type is FIBRE, or ISCSI.

    This value cannot be specified at the same time as loginHostNqn.

  • portMode: Operating mode of the port
  • loginHostNqn: Information about login to the host NQN port

    Information can be obtained if the port type is FIBRE.

    This value can be specified if the storage system is VSP 5000 series, VSP E1090, or VSP E1090H.

    This value cannot be specified at the same time as logins.

Body
None.

Response message

Body

The following is an example of the output when information obtained about all ports:

{
  "data": [
    {
      "portId": "CL1-A",
      "portType": "FIBRE",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "AUT",
      "loopId": "EF",
      "fabricMode": true,
      "portConnection": "PtoP",
      "lunSecuritySetting": true,
      "wwn": "50060e80124e3b00"
    },
    {
      "portId": "CL1-B",
      "portType": "ISCSI",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "10G",
      "loopId": "00",
      "fabricMode": false,
      "lunSecuritySetting": true
    }
  ]
}

The following is an example of the output when information is obtained about ports by specifying the port type:

{
  "data": [
    {
      "portId": "CL1-B",
      "portType": "ISCSI",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "10G",
      "loopId": "00",
      "fabricMode": false,
      "lunSecuritySetting": true
    }
  ]
}

Attribute

Type

Description

portId

string

Port number

portType

string

Port type

One of the following values is output:

FIBRE, SCSI, ISCSI, ENAS, ESCON, FICON

portAttributes

string[]

The value set for the port attribute

  • TAR: Target port (Fibre Target port)
  • MCU: Initiator port (MCU Initiator port)
  • RCU: RCU target port (RCU Target port)
  • ELUN: External port (External Initiator port)

For a bidirectional port, all four attributes are output.

portSpeed

string

The value set for the transfer speed

  • AUT (AUTO)
  • nG (where n is a number)

loopId

string

The value set for the port loop ID (AL_PA)

fabricMode

boolean

Fabric mode of the port

  • true: Set.
  • false: Not set.

portConnection

string

Topology setting for the port

  • FCAL
  • PtoP

If the portType attribute is ISCSI, this information is not output.

lunSecuritySetting

boolean

LUN security setting for the port

  • true: Set.
  • false: Not set.

wwn

string

External WWN

If the portType attribute is ISCSI, this information is not output.

The following is an example of the output when requesting additional detailed information:

{
  "data" : [ 
    {
      "portId" : "CL1-A",
      "portType" : "FIBRE",
      "portAttributes" : [ "TAR" ],
      "portSpeed" : "AUT",
      "loopId" : "EF",
      "fabricMode" : true,
      "portConnection" : "PtoP",
      "lunSecuritySetting" : true,
      "wwn" : "50060e8007274300",
      "logins" : [
        {
          "loginWwn" : "C0507603BFAA002C",
          "wwnNickName" : "-",
          "isLoggedIn" : false
        }, 
        {
          "loginWwn" : "C05076087D5A0012",
          "wwnNickName" : "ep22_10_0",
          "hostGroupId" : "CL1-A,9",
          "isLoggedIn" : true
        }
      ]
    },
    {
      "portId" : "CL1-B",
      "portType" : "ISCSI",
      "portAttributes" : [ "TAR" ],
      "portSpeed" : "10G",
      "loopId" : "00",
      "fabricMode" : false,
      "lunSecuritySetting" : true,
      "logins" : [
        {
          "loginIscsiName" : "iqn.1991-05.com.microsoft:hy0295",
          "iscsiNickName" : "hypoi0295",
          "hostGroupId" : "CL1-B,0",
          "iscsiTargetName" : "iqn.1994-04.jp.co.hitachi:rsd.h8h.t.10011.1d000",
          "isLoggedIn" : false
        },
        {
          "loginIscsiName" : "iqn.1991-05.com.microsoft:hy0295",
          "iscsiNickName" : "hypoi0295",
          "hostGroupId" : "CL1-B,94",
          "iscsiTargetName" : "iqn.1994-04.jp.co.hitachi:rsd.h8h.t.10011.1d05e",
          "isLoggedIn" : true
        }
      ]
    }
  ]
}

You can also get the following information by executing the request with logins specified for detailInfoType in the query parameters.

Attribute

Type

Description

logins

object[]

Information about logins to a storage system port corresponding to the WWN of an HBA or iSCSI name

For the WWN:

  • loginWwn (string)

    WWN of the HBA

  • wwnNickName (string)#

    WWN nickname

  • hostGroupId (string)#

    Object ID of the host group

  • isLoggedIn (boolean)

    Login status of the host

    • true: Logged in
    • false: Not logged in

For iSCSI name:

  • loginIscsiName (string)

    iSCSI name of iSCSI initiator

  • iscsiNickName (string)#

    iSCSI nickname

  • hostGroupId (string)#

    Object ID of iSCSI target

  • iscsiTargetName (string)

    iSCSI name of iSCSI target

  • isLoggedIn (boolean)

    Login status of the host

    • true: Logged in
    • false: Not logged in

#: For a VSP 5000 series storage system, it might take some time (from about 30 seconds to a few minutes) after the values for these attributes are updated before you can obtain the updated information by using the REST API. Wait a while and then execute the request again.

You can also get the following information by executing the request with portMode specified for detailInfoType in the query parameters.

Attribute

Type

Description

portMode

string

Operating mode of the port

  • FC-NVMe: NVMe mode
  • FCP-SCSI: SCSI mode
  • NOT SUPPORTED: This value is output if the storage system is not a VSP 5000 series, VSP E1090, VSP E1090H storage system or if the port does not support FC-NVMe.

You can also get the following information by executing the request with loginHostNqn specified for detailInfoType in the query parameters.

Attribute

Type

Description

hostNqnLogins

object[]

Information related to host NQN logins

  • hostNqn (string)

    Host NQN

  • isLoggedIn (boolean)

    Host NQN login information

    • true: Logged in
    • false: Not logged in

Status codes

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

Coding example

To obtain information about all ports:

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/ports

To obtain information about ports by specifying the port type:

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/ports?portType=ISCSI

To obtain information about ports by requesting additional detailed 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/ports?detailInfoType=logins