Getting a list of external path groups

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 a list of information about external path groups. It also obtains information about the related external parity groups and external paths.

Depending on the number of resources for which information is to be obtained, you might have to run this API request more than once to obtain information about all of those resources. In such cases, each time you run the request, if information was not obtained for one or more external path groups, the attribute nextPageHeadPathGroupId in the response body indicates the ID of the first external path group for which information was not obtained. To obtain information about the remaining external path groups, run the API request with the path group ID indicated by nextPageHeadPathGroupId specified for the parameter headPathGroupId in the query. If information was obtained for all target resources, the attribute nextPageHeadPathGroupId returns the value -1.

Important:

The API request for getting a list of external path groups can be used only when Fibre Channel ports are used. The request cannot be used when iSCSI ports are used.

If you are using an iSCSI port, use storage management software such as CCI. For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage systems, you can perform this operation by using the Platform REST API (Simple). For detailed information about this operation, see the Hitachi Storage Advisor Embedded Guide on the Hitachi Vantara Knowledge website.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

None.

Query parameters

Parameter

Type

Filter Condition

externalParityGroupId

string

(Optional) External parity group number

Specify the number in gno-sgno format.

You cannot specify this parameter and the ldevId parameter at the same time.

ldevId

int

(Optional) LDEV number

You cannot specify this parameter and the externalParityGroupId parameter at the same time.

headPathGroupId

int

(Optional) ID of the first external path group of the external path groups for which information is to be obtained

If you want to specify a range of external path groups for which to information is to be obtained, specify the ID of the first external path group in the target range.

Body

None.

Response message

Body
{
    "data": [
        {
            "externalPathGroupId": 0,
            "externalSerialNumber": "91110309",
            "externalProductId": "HUS",
            "externalParityGroups": [
                {
                    "externalParityGroupId": "1-1",
                    "externalParityGroupStatus": "BLK",
                    "cacheMode": "D",
                    "isInflowControlEnabled": false,
                    "mpBladeId": 0,
                    "loadBalanceMode": "N",
                    "pathMode": "M",
                    "isDataDirectMapping": false,
                    "externalLuns": [
                        {
                            "portId": "CL5-B",
                            "externalWwn": "50060e8010539b51",
                            "priority": 1,
                            "externalLun": 0,
                            "pathStatus": "BLK"
                        }
                    ]
                },
                {
                    "externalParityGroupId": "1-12",
                    "externalParityGroupStatus": "BLK",
                    "cacheMode": "E",
                    "isInflowControlEnabled": false,
                    "mpBladeId": 2,
                    "loadBalanceMode": "N",
                    "pathMode": "M",
                    "isDataDirectMapping": false,
                    "externalLuns": [
                        {
                            "portId": "CL5-B",
                            "externalWwn": "50060e8010539b51",
                            "priority": 1,
                            "externalLun": 19,
                            "pathStatus": "BLK"
                        }
                    ]
                }
            ],
            "externalPaths": [
                {
                    "portId": "CL5-B",
                    "externalWwn": "50060e8010539b51"
                }
            ],
            "nextPageHeadPathGroupId": -1
        },
        {
            "externalPathGroupId": 1,
            "externalSerialNumber": "210945",
            "externalProductId": "HUS VM",
            "externalParityGroups": [
                {
                    "externalParityGroupId": "1-2",
                    "externalParityGroupStatus": "NML",
                    "cacheMode": "D",
                    "isInflowControlEnabled": false,
                    "mpBladeId": 1,
                    "loadBalanceMode": "N",
                    "pathMode": "M",
                    "isDataDirectMapping": false,
                    "externalLuns": [
                        {
                            "portId": "CL5-B",
                            "externalWwn": "50060e80132ac120",
                            "priority": 1,
                            "externalLun": 21,
                            "pathStatus": "NML"
                        }
                    ]
                },
                {
                    "externalParityGroupId": "1-23",
                    "externalParityGroupStatus": "NML",
                    "cacheMode": "E",
                    "isInflowControlEnabled": false,
                    "mpBladeId": 2,
                    "loadBalanceMode": "N",
                    "pathMode": "M",
                    "isDataDirectMapping": false,
                    "externalLuns": [
                        {
                            "portId": "CL5-B",
                            "externalWwn": "50060e80132ac120",
                            "priority": 1,
                            "externalLun": 32,
                            "pathStatus": "NML"
                        }
                    ]
                }
            ],
            "externalPaths": [
                {
                    "portId": "CL5-B",
                    "externalWwn": "50060e80132ac120"
                }
            ],
            "nextPageHeadPathGroupId": -1
        }
    ]
}

Attribute

Type

Description

externalPathGroupId

int

External path group number

externalSerialNumber

string

Serial number of the external storage system

externalProductId

string

Product ID of the external storage system

externalParityGroups

object[]

The following attributes are output for each external parity group:

  • externalParityGroupId (string)

    External parity group number

  • externalParityGroupStatus (string)

    Status of the external parity group

    • NML: Normal

    • CHK: The mapping path status is being checked

    • SYN: Data in the cache is being written to the volume

    • DSC: The parity group is disconnected from the external storage system or the external volumes

    • BLK: The mapping path is blocked

    • WAR: The status of the mapping path is not normal

    • Unknown: Unknown

  • cacheMode (string)

    Cache mode

    • E: Enabled

    • D: Disabled

    For an external parity group that has the nondisruptive migration attribute, the following values are output:
    • EM: Enabled

    • DM: Disabled

    • TM: Through

    • SM: Synchronized writing

  • isInflowControlEnabled (boolean)

    Inflow cache control

    • true: Enabled

    • false: Disabled

  • mpBladeId (int)

    MP blade ID

  • loadBalanceMode (string)
    The load balancing method for I/O operations for the external storage system
    • N: Standard round-robin method

    • E: Expanded round-robin method

    • D: I/O is performed over a single path, and load balancing is not used

  • pathMode (string)

    Path mode of the external storage system

    • M: Multi mode

    • S: Single mode

    • A: APLB mode

    • AL: ALUA mode

    • MA: Multi mode (in a state in which the mode can be changed to the ALUA mode)

    • SA: Single mode (in a state in which the mode can be changed to the ALUA mode)

  • isDataDirectMapping (boolean)

    Whether the data direct mapping attribute is enabled

    • true: Enabled

    • false: Disabled

  • externalLuns (object[])

    The following attributes are output for each LU on the external storage system:

    • portId (string)

      Port number

    • externalWwn (string)

      WWN of the external storage system

    • priority (int)

      Priority within the external path group

    • externalLun (int)

      LUN within the ports of the external storage system

    • pathStatus (string)

      Status of the external path

      NML: Normal

      CHK: Temporarily blocked (The status of the external path is being checked.)

      BLK: Blocked

      DSC: Disconnected

      Unknown: Unknown

externalPaths

object[]

The following attributes are output for each external path:

  • portId (string)

    Port number

  • externalWwn (string)

    WWN of the external storage system

  • qDepth (int)

    Number of Read/Write commands that can be queued to the external parity group

    This information is obtained only when the qDepth attribute is set.

  • ioTimeOut (int)

    The value (in seconds) set for the I/O time over for the external parity group

    This information is obtained only when the ioTimeOut attribute is set.

  • blockedPathMonitoring (int)

    The time (in seconds) until the external parity group is blocked after all paths to the external parity group are disconnected

    This information is obtained only when the blockedPathMonitoring attribute is set.

nextPageHeadPathGroupId

int

ID of the first external path group for which information was not obtained

If you were not able to obtain information about all target external path groups by a single execution of the request, you can obtain information about the remaining external path groups by running the request again, with this value specified for the parameter headPathGroupId in the query.

If information was obtained about all target external path groups, the value -1 is output.

Status codes

For details on the status codes of the API, see the description on HTTP status codes.

Coding example

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