Getting information about external path groups

Storage Advisor Embedded User Guide

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

You can obtain a list of information about external path groups and about related external paths.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/external-path-groups

Request message

Object ID
None.
Query parameters

With each request, you can obtain information about a maximum of 200 external path groups. To obtain information about additional external path groups, run the API request multiple times by using a combination of the count and startId parameters. By specifying the count parameter, you can also filter the external path group information you require.

Parameter

Type

Filter Condition

startId

int

(Optional) Specify the ID of the external path group from which to start obtaining information, by using a value in the range from 0 through 63231.

count

int

(Optional) Specify the number of external path groups for which information is obtained, by using a value in the range from 1 through 200.

If this parameter is omitted, 200 is assumed.

Body
None.

Response message

Body
{
  "data": [
    {
      "id": 1235,
      "externalPaths": [
        {
          "portId": "CL5-A",
          "portProtocol": "FC",
          "externalPortWwn": "50060e8012000c60"
        }
      ]
    },
    {
      "id": 1200,
      "externalPaths": [
        {
          "portId": "CL1-B",
          "portProtocol": "iSCSI",
          "externalPortIpAddress": "10.1.9.122",
          "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d011",
          "externalTcpPortNumber": 3260,
          "virtualPortNumber": 1
        }
      ]
    }
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

Attribute

Type

Description

id

int

External path group ID

externalPaths

object[]

Information about each external path related to the external path group appears.

  • portId (string)

    ID of the external connection port

  • portProtocol (string)

    Protocol of the port

    • FC
    • iSCSI

    If port information cannot be obtained, this attribute will not appear.

  • externalPortWwn (string)

    WWN of the port of the externally connected storage system

    If an iSCSI port is specified, this attribute will not appear.

  • externalPortIpAddress (string)

    IP address of the port of the externally connected storage system

    This attribute is output in IPv4 or IPv6 format.

    If an FC port is specified, this attribute will not appear.

  • externalPortIscsiName (string)

    Name of the iSCSI target for the port of the externally connected storage system

    If an FC port is specified, this attribute will not appear.

  • externalTcpPortNumber (int)

    TCP port number of the port of the externally connected storage system

    If an FC port is specified, this attribute will not appear.

  • virtualPortNumber (int)

    Virtual port number of the external connection port

    In the following cases, this attribute will not appear.

    • If an FC port is specified
    • If an iSCSI port is specified and the use of virtual ports is disabled

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/external-path-groups