Adding remote paths to 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 adds a remote path to the existing remote connection. You can add a remote path when the value of the connection setting of the remote path is CU Free. 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/object-ID/actions/add-remotepath/invoke

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
{
  "parameters": {
    "localPortId": "CL1-A",
    "remotePortId": "CL2-B"
  }
}

Attribute

Type

Description

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 remote path that was added to the remote connection

Action template

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

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

412

Precondition Failed

The number of the remote paths already registered to the target remote connection is eight, which is the maximum number of remote paths that can be registered.

Coding example

To get an action template:

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/actions/add-remotepath

To run the request after getting an action template:

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/492015,M8,255/actions/add-remotepath/invoke