Getting information about the paths between a server and a specific port

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request obtains information about the paths between the server and the specific port that corresponds to the specified server ID, WWN of an HBA (or iSCSI name), and port ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/paths/object-ID

Request message

Object ID

Combine multiple object IDs specified.

Specify the serverId value and the id value, obtained by using the API function for getting the path information of the server, in the following format.

serverId/paths/id

For the id value, you can specify whether to obtain the information in a format that is a combination of the hbaWwn (or iscsiName) value and the portId value.

  • To specify the WWN of the HBA:
    serverId/paths/hbaWwn,portId

    Attribute

    Type

    Description

    serverId

    int

    (Required) Server ID

    hbaWwn

    string

    (Required) WWN of the HBA

    portId

    string

    (Required) Port ID

  • To specify the iSCSI name:
    serverId/paths/iscsiName,portId

    Attribute

    Type

    Description

    serverId

    int

    (Required) Server ID

    iscsiName

    string

    (Required) iSCSI name

    portId

    string

    (Required) Port ID

Query parameters
None.
Body
None.

Response message

Body

The following is an example of the output when getting information about paths between a server (ID 10, WWN of the HBA: 000000102cceccc9) that is connected using Fibre Channel, and a specific port (ID CL1-A):

{
  "id": "000000102cceccc9,CL1-A",
  "serverId": 10,
  "hbaWwn": "000000102cceccc9",
  "portId": "CL1-A"
}

The following is an example of the output when getting information about paths between a server (ID 11, iSCSI name: iqn.1994-05.com.redhat:496799ba93) that is connected using iSCSI, and a specific port (ID CL1-B):

{
  "id": "iqn.1994-05.com.redhat:496799ba93,CL1-B",
  "serverId": 11,
  "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
  "portId": "CL1-B"
}

For details about the attributes to obtain, see the description of the API function for getting server path information.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/paths/000000102cceccc9,CL1-A