Getting a list of remote connections

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 a list of remote connections.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID
None.
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:

{
  "data": [
    {
      "remotepathGroupId": "492015,M8,0",
      "remoteSerialNumber": "492015",
      "remoteStorageTypeId": "M8",
      "pathGroupId": 0,
      "cuType": "REMOTE",
      "portType": "FIBRE",
      "cuStatus": "NML",
      "minNumOfPaths": 1,
      "numOfPaths": 1,
      "timeoutValueForRemoteIOInSeconds": 15,
      "roundTripTimeInMilliSeconds": 1
    }
  ]
}

The following is an example of the output when information about the remote storage system is registered on the REST API server:

{
  "data": [
    {
      "remotepathGroupId": "492015,M8,0",
      "remoteStorageDeviceId": "886000492015",
      "remoteSerialNumber": "492015",
      "remoteStorageModel": "VSP G900",
      "remoteStorageTypeId": "M8",
      "pathGroupId": 0,
      "cuType": "REMOTE",
      "portType": "FIBRE",
      "cuStatus": "NML",
      "minNumOfPaths": 1,
      "numOfPaths": 1,
      "timeoutValueForRemoteIOInSeconds": 15,
      "roundTripTimeInMilliSeconds": 1
    }
  ]
}

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

  • R8: VSP G1000, VSP G1500, or VSP F1500

  • R9: VSP 5000 series
  • M8: VSP E series, VSP Gx00 models or VSP Fx00 models

pathGroupId

int

Path group ID

If the connection setting for the remote path is CU specific, this information is not output.

localCuNumber string

CU number of the local storage system (MCU)

This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.

remoteCuNumber string

CU number of the remote storage system (RCU)

This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.

portType

string

Port type of the remote path

  • FIBRE: All the ports are Fibre Channel ports
  • ESCON: All the ports are ESCON ports
  • ISCSI: All the ports are iSCSI ports
  • MIXED: Multiple port types from among these three types

This item is hidden when the value of the cuType attribute is LOCAL.

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

cuStatus

string

CU status

  • NML: Normal
  • WAR: Warning
  • ERR: Failing
  • Unknown: Unknown. This is output if the cuType attribute is LOCAL.

minNumOfPaths

int

Minimum number of paths

If the cuType attribute is LOCAL, this information is not output.

numOfPaths

int

Number of set remote paths

If the cuType attribute is LOCAL, this information is not output.

incidentMode

string

Incident mode for sending incidents to the RCU host

  • MR: Incidents are sent to the MCU host and the RCU host.
  • RO: Incidents are sent to the RCU host only.

This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.

isFreezeOptionEnabled

boolean

Value of the FREEZE option

  • false: The FREEZE option is disabled.
  • true: The FREEZE option is enabled.

This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.

timeoutValueForRemoteIOInSeconds

int

RIO timeout value (in seconds) for RIO (Remote IO) setting between the local storage system and the remote storage system

If the cuType attribute is LOCAL, this information is not output.

roundTripTimeInMilliSeconds

int

The round-trip time value (in milliseconds) between the local storage system and the remote storage system

If the cuType attribute is LOCAL, this information is not output.

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