Getting information about a specific remote connection

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 gets information about a specific remote connection. You can get information about a remote connection when the value of the connection setting of the remote path is CU Free.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remotepath-groups/object-ID

Request message

Object ID

Specify the value of remotepathGroupId that was obtained by the processing to get information about the remote connection. You can also specify the attributes and connect them with commas as follows:

remoteSerialNumber,remoteStorageTypeId,pathGroupId

Attribute

Type

Description

remoteSerialNumber

string

(Required) Serial number of the remote storage system

remoteStorageTypeId

string

(Required) ID that indicates the model of the remote storage system

You can specify the following values:

  • R9: VSP 5000 series
  • M8: VSP E series, VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900

pathGroupId

int

(Required) Path group ID

Query parameters
None.
Body
None.

Response message

Body
The following is an example of the output when information about the remote storage system is not registered on the REST API server:
{
  "remotepathGroupId": "492015,M8,255",
  "remoteSerialNumber": "492015",
  "remoteStorageTypeId": "M8",
  "pathGroupId": 255,
  "remotePaths": [
    {
      "cuType": "REMOTE",
      "portType": "ISCSI",
      "pathNumber": 0,
      "localPortId": "CL3-B",
      "remotePortId": "CL2-C",
      "pathStatus": "ERR_03"
    }
  ]
}
The following is an example of the output when information about the remote storage system is registered on the REST API server:
{
  "remotepathGroupId": "492015,M8,255",
  "remoteStorageDeviceId": "886000492015",
  "remoteSerialNumber": "492015",
  "remoteStorageModel": "VSP G900",
  "remoteStorageTypeId": "M8",
  "pathGroupId": 255,
  "remotePaths": [
    {
      "cuType": "REMOTE",
      "portType": "ISCSI",
      "pathNumber": 0,
      "localPortId": "CL3-B",
      "remotePortId": "CL2-C",
      "pathStatus": "ERR_03"
    }
  ]
}

Attribute

Type

Description

remotepathGroupId

string

Object ID for the remote connection

remoteStorageDeviceId

string

Storage device ID of the remote storage system

This attribute is output when information about the remote storage system is registered on the REST API server.

remoteSerialNumber

string

Serial number of the remote storage system

remoteStorageModel

string

Model type of the remote storage system

This attribute is output when information about the remote storage system is registered on the REST API server.

remoteStorageTypeId

string

ID that indicates the model of the remote storage system

  • R9: VSP 5000 series
  • M8: VSP E series, VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900

pathGroupId

int

Path group ID

remotePaths

objects[]

The following attributes are output for each remote path:

  • cuType (string)

    CU type

    • REMOTE: If a remote path is set from the local storage system to the remote storage system
    • LOCAL: If a remote path is set from the remote storage system to the local storage system
  • portType (string)

    Port type of the remote path

    • FIBRE: Fibre Channel port
    • ESCON: ESCON port
    • ISCSI: iSCSI port
  • pathNumber (int)

    Path number

  • localPortId (string)

    Port number of the local storage system (MCU)

  • remotePortId (string)

    Port number of the remote storage system (RCU)

  • pathStatus (string)

    The path status

    • NML_01: Normal
    • ERR_02: Initialization failed
    • ERR_03: Communication timeout
    • ERR_04: Logical blockade
    • ERR_05: Resource Shortage
    • ERR_06: Serial Number Mismatch
    • ERR_10: Invalid Port
    • ERR_80: RCU Port Number Mismatch
    • ERR_81: RCU Port Type Mismatch
    • ERR_82: Communication Failed
    • IN_PRG: The path is being created or deleted.

Status codes

For details on the status codes of the request for this operation, 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/remotepath-groups/492015,M8,255