Changing journal 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 journal settings, such as Data Overflow Watch and the transfer speed.
Note:

If a user uses the REST API to lock the resources of a target storage system, any request that includes a change to the transfer speed (the copySpeed attribute) cannot run. In such a case, unlock the resources before performing the operation.

Execution permission

Storage Administrator (Remote Copy)

Request line

PATCH base-URL/v1/objects/journals/object-ID

Request message

Object ID
Specify the value of journalId that was obtained by the processing to get information about journals.

Attribute

Type

Description

journalId

int

(Required) Journal ID

Query parameters
None.
Body

The following is a coding example for changing the following settings: Data Overflow Watch, cache mode, and transfer speed:

{
  "dataOverflowWatchInSeconds": 60,
  "isCacheModeEnabled": true,
  "copySpeed": 100
}

The following is a coding example for changing the following settings: mirror copy speed and Path Blockade Watch Time for the mirror:

{
  "mirrorUnit": {
    "muNumber": 0,
    "copyPace": "M",
    "pathBlockadeWatchInMinutes": 10
  }
}

The following is a coding example for changing the following settings: Data Overflow Watch, cache mode, transfer speed, copy speed per mirror, and Path Blockade Watch Time for the mirror:

{
  "dataOverflowWatchInSeconds": 60,
  "isCacheModeEnabled": true,
  "copySpeed": 100,
  "mirrorUnit": {
    "muNumber": 0,
    "copyPace": "M",
    "pathBlockadeWatchInMinutes": 10
  }
}

Attribute

Type

Description

dataOverflowWatchInSeconds

int

(Optional) Data Overflow Watch (in seconds)

This value is set to 60 by default when a journal is created.

If 0 is specified, control on inflow of update I/O to the journal volume will be disabled.

isCacheModeEnabled

boolean

(Optional) Specify whether to enable the cache mode setting.

  • true: The cache mode setting is enabled.
  • false: Disable the cache mode setting.

This value is set to true by default when a journal is created.

copySpeed

int

(Optional) Transfer speed (in Mbps)

Specify the transfer speed for data transfer. You can specify one of the following values:

3, 10, 100, or 256

This value is set to 256 by default when a journal is created.

mirrorUnit

object

Specify the following attributes for each mirror:

  • (Optional) muNumber (int)

    MU (mirror unit) number

    Specify this attribute together with either the copyPace attribute or the pathBlockadeWatchInMinutes attribute.

  • (Optional) copyPace (string)

    Copy speed

    The type is not case sensitive.

    • L: Low speed
    • M: Medium speed
    • H: High speed

    This value is set to L by default when a journal is created.

  • (Optional) pathBlockadeWatchInMinutes (int)

    Path Blockade Watch Time (in minutes)

    Specify a value in the range from 0 to 60.

    This value is set to 5 by default when a journal is created.

    If 0 is specified, the Path Blockade Watch Time is not changed, and the function that transfers the Path Blockade Watch Time to the secondary site of the mirror (the RCU) is disabled.

    If a value other than 0 is specified, the specified value is set as the value for the Path Blockade Watch Time, and the function that transfers the Path Blockade Watch Time to the secondary site of the mirror (the RCU) is enabled.

Response message

Body

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

Attribute

Description

affectedResources

URL of the changed journal

You can use detailed journal information to check changed setting values. You can obtain detailed information by specifying journalInfo=detail for the query parameter of the API for getting a list of journals.

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 PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/journals/100