Getting a list of server path information

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify the id value obtained by getting information about the server.

Attribute	Type	Description
id	int	(Required) Server ID

Query parameters

Parameter	Type	Filter Condition
hbaWwn	string	(Optional) WWN of the HBA Path information is obtained about the server that has the WWN of the HBA that is a perfect match to the specified value.
iscsiName	string	(Optional) iSCSI name Path information is obtained about the server that has the iSCSI name that is a perfect match to the specified value.
portId	string	(Optional) Port ID of the assigned port Path information is obtained about the server that has the port ID of the assigned port that is a perfect match to the specified value.

Body

None.

Response message

Body

The following is an example of the output when getting the path information of a Fibre Channel-connected server (ID 10):

{
  "data": [
    {
      "id": "000000102cceccc9,CL1-A",
      "serverId": 10,
      "hbaWwn": "000000102cceccc9",
      "portId": "CL1-A"
    },
    {
      "id": "1111111111111111,CL1-A",
      "serverId": 10,
      "hbaWwn": "1111111111111111",
      "portId": "CL1-A"
    }
  ],
  "count": 2
}

The following is an example of the output when getting the path information of an iSCSI-connected server (ID 11):

{
  "data": [
    {
      "id": "iqn.1994-05.com.redhat:496799ba93,CL1-B",
      "serverId": 11,
      "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
      "portIds": "CL1-B"
    },
    {
      "id": "iqn.1994-05.com.redhat:a7526e46aa,CL1-B",
      "serverId": 11,
      "iscsiName": "iqn.1994-05.com.redhat:a7526e46aa",
      "portIds": "CL1-B"
    }
  ],
  "count": 2
}

The following is an example of the output when getting the path information of server with no paths defined:

{
  "data": [],
  "count": 0
}

Attribute	Type	Description
id	string	The WWN of the HBA (or iSCSI name) and the port ID of the assigned port appear in a format in which they are linked by a comma.
serverId	int	Server ID
hbaWwn	string	WWN of the HBA
iscsiName	string	iSCSI name
portId	string	Port ID of the assigned port

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