Getting information about a specific external path group

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 acquires information about a specified external path group and the external parity groups and external paths that are related to the specified external path group.
Important:

The API request for getting information about a specific external path group 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/object-ID

Request message

Object ID

Specify the value of externalPathGroupId that was obtained by the request to get information about the external path group.

Attribute

Type

Description

externalPathGroupId

int

(Required) External path group number

Query parameters

None.

Body

None.

Response message

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

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 external parity group is disconnected from the external storage system or the external volume

    • 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 (E)

    • 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 displayed 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.

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