Creating a 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 creates a remote connection, and then adds a remote path. By using this request, you can create a CU Free remote connection. You can specify the serial number and the series name of the remote storage system to create a remote connection. Alternatively, you can specify the storage device ID of the remote storage system to create a remote connection. To add a remote path for an iSCSI port, register in advance the iSCSI port of the remote storage system to the iSCSI port of the local storage system.

Execution permission

Storage Administrator (Remote Copy)

Request line

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

Request message

Object ID
None.
Query parameters
None.
Body
The following is a coding example for creating a remote connection by specifying the serial number and the series name of the remote storage system:
{
  "remoteSerialNumber": "492015",
  "remoteStorageTypeId": "M8",
  "pathGroupId": 255,
  "localPortId": "CL3-B",
  "remotePortId": "CL2-C"
}

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

Specify a decimal (base 10) number in the range from 0 to 255.

localPortId

string

(Required) Port number of the local storage system

remotePortId

string

(Required) Port number of the remote storage system

The following is a coding example for creating a remote connection by specifying the storage device ID of the remote storage system:

{
  "remoteStorageDeviceId": "886000410011",
  "pathGroupId": 255,
  "localPortId": "CL3-B",
  "remotePortId": "CL2-C"
}

Attribute

Type

Description

remoteStorageDeviceId

string

(Required) Storage device ID of the remote storage system

pathGroupId

int

(Required) Path group ID

Specify a decimal (base 10) number in the range from 0 to 255.

localPortId

string

(Required) Port number of the local storage system

remotePortId

string

(Required) Port number of the remote storage system

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the registered remote connection

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the section explaining HTTP status codes.

Status code

Message

Description

409

Conflict

A remote connection has already been created with the specified path group ID.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remotepath-groups