Changing the remote connection settings

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 changes the remote connection settings such as the minimum number of paths, communication timeout value, and the return response time. You can change the remote connection settings when the value of the connection setting of the remote path is CU Free.

Execution permission

Storage Administrator (Remote Copy)

Request line

PATCH 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
{
  "minNumOfPaths": 1,
  "timeoutValueForRemoteIOInSeconds": 15,
  "roundTripTimeInMilliSeconds": 1
}

Attribute

Type

Description

minNumOfPaths

int

Minimum number of remote paths

Specify a value in the range from 1 to 8.

This value is set to 1 by default when a remote connection is created.

Specify a value that is no more than the number of remote paths registered in the remote connection.

timeoutValueForRemoteIOInSeconds

int

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

Specify a value in the range from 10 to 100.

This value is set to 15 by default when a remote connection is created.

roundTripTimeInMilliSeconds

int

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

Specify a value in the range from 1 to 500.

Default: 1

This value is set to 1 by default when a remote connection is created.

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 changed 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

400

Bad Request

Values smaller or greater than the specifiable values exist in the specified values.

Coding example

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