Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Managing global-active device pairs

You can perform operations on global-active device pairs. Global-active device enables you to duplicate volumes between two storage systems to improve availability of the storage systems. You can create, resync, delete, suspend, and swap global-active device pairs.

Overview of global-active device

Global-active device enables you to duplicate volumes between two storage systems to improve availability of the storage systems. If you register resources of each storage system in the same virtual storage machine and specify the same virtual LDEV ID for the volumes to be paired, the host can handle the volumes as a volume of a storage system. I/O from the host can be received by both storage systems. If data is written in one volume, the data is automatically synchronized with another volume.
GUID-6F62FE5B-2915-4F4F-8D18-167AC01B5270-low.gif

If you issue an API request from a REST API client, you can create a global-active device pair, or perform operations on pairs when stopping either storage system for maintenance.

For a global-active device in a cross-path configuration (using a Fibre Channel connection), you can change the volume settings to enable the ALUA attribute or to set the priority levels of ALUA paths.

For determining the synchronous status of data between global-active device paired volumes, the quorum is used. For details on global-active device, see the Global-Active Device User Guide.

Workflow for operating global-active device pairs

The global-active device pair operation, which is performed in an environment that uses the REST API, is divided into normal operation and maintenance operation.
Important

If you perform operations on or get information about global-active device pairs, specify Remote-Authorization for the request header.

Normal operation

The following figure shows the workflow for the normal operation.

GUID-C7562C3E-A778-4FF4-9770-E8E37CC2AF81-low.gif
  • Creating a pair

    Create a pair, and then copy all of the data in the P-VOL to the S-VOL. The pair is duplicated. Create a pair in a new copy group (mirror), or add a pair to an existing copy group (mirror). A copy group is a group made up of copy pairs. Each copy group consists of a device group made up of P-VOLs, and a device group made up of S-VOLs.

  • Getting information about a copy group or pair

    You can perform operations on the pair in units of copy groups or pairs.

  • Deleting a pair

    Suspend the pair in advance, and then dissolve the pair status of the volumes.

Maintenance operation

You can use the REST API to stop the storage systems used by global-active device as planned and to perform maintenance work.

The following figure shows the workflow for performing maintenance work of the primary site.

GUID-35814D9B-B555-4F90-B543-156B86C63773-low.gif
  • Suspending a pair (by specifying the S-VOL)

    Suspend the status of a pair that is duplicated. I/O is switched to the secondary site.

  • Stopping I/O for the P-VOL as planned

    Stop I/O for the P-VOL.

  • Maintenance work

    At the primary site, upgrade the micro version or perform other maintenance work.

  • Resynchronizing a pair (by specifying the S-VOL) (swap resync)

    After the maintenance work, resynchronize the differential data generated during stop of the P-VOL. Switch the P-VOL and the S-VOL, and then copy the data of the switched P-VOL to the S-VOL to resynchronize the pair.

    Note

    Resynchronization can be performed in units of copy groups or pairs. If you want to register pairs to a consistency group during resynchronization, perform resynchronization in units of copy groups. Do not perform resynchronization in units of pairs.

  • Resynchronizing a pair (by specifying the P-VOL) (swap resync)

    If necessary, switch the switched P-VOL and S-VOL.

  • Restarting I/O for the P-VOL

    Restart I/O for the P-VOL.

Specifying Job-Mode-Wait-Configuration-Change in the request header

During the creation, splitting, and resynchronizing of pairs, if multiple asynchronous processing requests are issued at the same time, jobs might get stuck and the job status might not change to Completed because data copying takes a long time. In such cases, specify Job-Mode-Wait-Configuration-Change:NoWait in the request header so that the job status changes to Completed without waiting for data copying to finish, and the next job starts. At this time, data copying continues even after job execution ends. To check whether data copying has finished, check the pair status of the target resource instead of the job status. For details about the pair status, see the description of the pair status transitions.

Pair status (global-active device)

The following explains the operations and status transitions for global-active device pairs.
GUID-6BA4975E-E76F-4C66-BB6D-B77A83B210E5-low.gif
Management of the status for global-active device pairs

Global-active device pairs are managed based on the following statuses and mode:

  • GAD status

    Status of a global-active device pair. The value is determined by the combination of the pair status and I/O mode, and is not output anywhere.

  • Pair status

    Pair statuses for the primary volume and the secondary volume

  • I/O mode

    I/O modes for the primary volume and the secondary volume

The following table shows GAD status values.

GAD status

Description

Simplex

Status before creating a pair

Mirroring

The status is being changed to the mirrored status.

This status indicates either of the following cases:

  • A Quorum disk is being prepared.
  • Data in the P-VOL is being copied to the S-VOL.

Mirrored

The pair is running normally.

Data is duplicated.

Suspended

The pair is suspended by operation or due to a failure.

The latest data is stored in either the P-VOL or the S-VOL. I/O from the host targets only the volume that contains the latest data.

Blocked

Multiple failures occurred at the same time, and neither the P-VOL nor the S-VOL accepts I/O from the host.

This status indicates either of the following cases:

  • The latest data is stored in both the P-VOL and the S-VOL, and one of the volumes can accept I/O from the host if the pair is forcibly deleted. However, the REST API cannot be used to forcibly delete the pair.
  • A failure occurred on the local storage system or the remote storage system, and the volume on the other storage system also blocks I/O from the host.

The following table shows pair status values. The primary volume and the secondary volume each have the pair status.

Pair status

Description

SMPL

Unpaired volumes

COPY

A pair is being created.

An initial copy or resynchronization is being performed.

PAIR

Paired volumes

The initial copy is completed, and data is duplicated.

PSUS

The pair is suspended by operation.

(This value is output for the P-VOL.)

SSUS

The pair is suspended by operation, and the S-VOL is not updated.

(This value is output for the S-VOL.)

PSUE

The pair is suspended and blocked due to a failure.

SSWS

The pair is suspended by operation or due to a failure, and the P-VOL is not updated.

(This value is output for the S-VOL.)

The following table shows I/O mode values. I/O mode indicates the I/O operations for the primary and secondary volumes that make up a global-active device pair.

I/O mode

Status

Read processing

Write processing

L/M

Mirror (RL)

Data in the volume on the local storage system is sent to the host.

Data is written to the volumes on the local storage system and the remote storage system, in this order.

L/L

Local

Data in the volume on the local storage system is sent to the host.

Data is written to the volume on the local storage system only.

B/B

Block

Denied. (An illegal request is returned.)

Denied. (An illegal request is returned.)

"L" indicates "local". "M" indicates "Mirror". "B" indicates "Block".

The following table shows the relationships of the GAD status, pair status, and I/O mode.

GAD status

Trigger of suspension

P-VOL

S-VOL

Volume that contains the latest data

Pair status

I/O mode

Pair status

I/O mode

Simplex

--

SMPL

--

SMPL

--

--

Mirroring

--

COPY

L/M

COPY

B/B

P-VOL

Mirrored

--

PAIR

L/M

PAIR

L/M

P-VOL

S-VOL

Suspended (P-LOCAL)

Operation for the pair

PSUS

L/L

SSUS

B/B

P-VOL

Failure

PSUE

L/L

PSUE

B/B

SMPL

--

N

N

Suspended (S-LOCAL)

Operation for the pair

PSUS

B/B

SSWS

L/L

S-VOL

Failure

PSUE

B/B

SSWS

L/L

SMPL

--

N

N

Blocked

--

PSUE

B/B

PSUE

B/B

P-VOL

S-VOL

N

N

N

N

PSUE

B/B

(Legend)

--: Not applied.

N: The I/O mode and pair status cannot be confirmed due to a storage system failure.

Note

In the following cases, if you perform an operation on a pair, the request successfully returns a response, but the details specified in the request body are not actually applied:

  • When you perform a pair suspending operation on a pair for which the status is PSUS or SSUS
  • When you perform a pair resynchronization operation on a pair for which the status is COPY or PAIR

Getting a list of remote copy groups

The following request gets a list of all the remote copy groups in which the remote copy pairs (TrueCopy, Universal Replicator, and global-active device) of the target storage system are registered. If the device group name or copy group name contains single-byte spaces, copy group information cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-mirror-copygroups
Request message
  • Object ID

    None.

  • Query parameters

    You can get only a list of remote copy groups, or you can get detailed information about remote copy pairs in addition to a list of remote copy groups.

    • To get a list of remote copy groups only:

      Parameter

      Type

      Filter condition

      remoteStorageDeviceId

      string

      (Required) Storage device ID of the remote storage system

      If a failure occurs in a remote storage system and you then specify NotSpecified, only the information about the local storage system is obtained. In this situation (when a failure occurs and you specify NotSpecified), you do not need to specify the Remote-Authorization header.

      If you specify NotSpecified for this parameter, you cannot specify the detailInfoType parameter.

    • To obtain additional detailed information:

      Parameter

      Type

      Description

      detailInfoType

      string

      (Optional) Type of detailed information to be obtained

      • pair

        Gets additional detailed information# about remote copy pairs.

        You can specify this item for VSP 5000 series.

        To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

      If you specify NotSpecified for the remoteStorageDeviceId parameter, you cannot specify this parameter.

      #: If the remote storage system is a VSP E series, VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900 model storage system, you might not be able to get some of the information about the remote storage system.

      For other storage systems, if the remote storage system's microcode version meets the following conditions, you might not be able to get some of the information about the remote storage system.

      • For a VSP 5000 series storage system:

        The microcode version is earlier than 90-01-42-XX/XX.

      • For a VSP G1000, VSP G1500, VSP F1500 model storage system:

        The microcode version is earlier than 80-06-71-XX/XX.

  • Body

    None.

Response message
  • Body

    {
      "data" : [ {
        "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1S_,remoteCopyGroup1P_",
        "copyGroupName" : "remoteCopyGroup1",
        "muNumber" : 0,
        "remoteStorageDeviceId" : "886000123789",
        "localDeviceGroupName" : "remoteCopyGroup1S_",
        "remoteDeviceGroupName" : "remoteCopyGroup1P_"
      }, {
        "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_",
        "copyGroupName" : "remoteCopyGroup2",
        "muNumber" : 0,
        "remoteStorageDeviceId" : "886000123789",
        "localDeviceGroupName" : "remoteCopyGroup2P_",
        "remoteDeviceGroupName" : "remoteCopyGroup2S_"
      }, {
        "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_",
        "copyGroupName" : "remoteCopyGroup3",
        "muNumber" : 0,
        "remoteStorageDeviceId" : "886000123789",
        "localDeviceGroupName" : "remoteCopyGroup3P_",
        "remoteDeviceGroupName" : "remoteCopyGroup3S_"
      } ]
    }

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    Storage device ID of the remote storage system

    If you specify NotSpecified for remoteStorageDeviceId, NotSpecified is output.

    copyGroupName

    string

    Copy group name

    localDeviceGroupName

    string

    Device group name in the local storage system

    remoteDeviceGroupName

    string

    Device group name in the remote storage system

    If you specify NotSpecified for remoteStorageDeviceId, NotSpecified is output.

    muNumber

    int

    MU (mirror unit) number

    If the MU number cannot be obtained, information is not output.

    remoteMirrorCopyGroupId

    string

    Object ID of the remote copy group

    The following attributes are output, separated by commas:

    • remoteStorageDeviceId
    • copyGroupName
    • localDeviceGroupName
    • remoteDeviceGroupName

    If you run the request with pair specified for the query parameter detailInfoType, you can get the following information, in addition to information about remote copy groups:

    Attribute

    Type

    Description

    copyPairs

    object[]

    Detailed information about the remote copy pair is output.

    If information cannot be acquired, the attributes under the copyPairs object are not output.

    • copyGroupName (string)

      Copy group name

    • copyPairName (string)

      Copy pair name

    • replicationType (string)

      Pair type

      • TC: TrueCopy
      • UR: Universal Replicator
      • GAD: global-active device

      If the pair status is SMPL, information is not output.

    • pvolLdevId (int)

      LDEV number of P-VOL

    • svolLdevId (int)

      LDEV number of S-VOL

    • fenceLevel (string)

      Fence level

      • DATA: S-VOL data
      • STATUS: S-VOL status
      • NEVER: None
      • ASYNC: Asynchronous

      If the fence level cannot be obtained, information is not output.

    • pvolJournalId (int)

      Journal ID of the P-VOL

      A value from 0 to 255 is output only in the case of Universal Replicator. This information is not output if the pair type cannot be obtained.

    • svolJournalId (int)

      Journal ID of the S-VOL

      A value from 0 to 255 is output only in the case of Universal Replicator. This information is not output if the pair type cannot be obtained.

    • quorumDiskId (int)

      ID of the Quorum disk

      A value from 0 to 31 is output only in the case of global-active device. This information is not output if the pair type cannot be obtained.

    • pvolStatus (string)

      Pair status of the P-VOL

      For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

      If the pair status cannot be obtained, information is not output.

      In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

    • svolStatus (string)

      Pair status of the S-VOL

      For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

      If the pair status cannot be obtained, information is not output.

      In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

    • consistencyGroupId (int)

      Consistency group ID

      If no consistency group consists, information is not output.

    • pvolIOMode (string)

      I/O mode of the P-VOL

      • L/M: Mirror (RL)
      • L/L: Local
      • B/B: Block

      Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

    • svolIOMode (string)

      I/O mode of the S-VOL

      • L/M: Mirror (RL)
      • L/L: Local
      • B/B: Block

      Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

    • pvolStorageDeviceId (string)

      Storage device ID of the storage system on the P-VOL

    • svolStorageDeviceId (string)

      Storage device ID of the storage system on the S-VOL

    • remoteMirrorCopyPairId (string)

      Object ID of the remote copy pair

      The following attributes are output, separated by commas:

      • remoteStorageDeviceId
      • copyGroupName
      • localDeviceGroupName
      • remoteDeviceGroupName
      • copyPairName
    • transitionStatus (string)

      The transition status of a pair is output for a Universal Replicator pair.

      • None: The pair is not in transition.
      • Suspending: The pair is being split.
      • Deleting: The pair is being deleted.

      This is not output if the copy pair is not a Universal Replicator pair.

    • copyPace (int)

      Copy speed

      This is not output if copy pair is Universal Replicator.

    • pathGroupId (int)

      ID of the RCU path group

      This is not output if CU is specified for the remote path connection setting.

      This is not output if the pair status of the P-VOL or the S-VOL is SMPL.

    • deltaStatus (string)

      Status of the 3DC multi-target configuration that uses delta resync

      This is output if the pair type is Universal Replicator and the 3DC multi-target configuration that uses delta resync is used.

      • HOLD: Universal Replicator delta resync pair (normal)
      • HLDE: Universal Replicator delta resync pair (failed)
      • HOLDING: In the process of being changed to a Universal Replicator delta resync pair
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 "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups?remoteStorageDeviceId=886000123789

Getting information about a specific remote copy group

The following request gets information about the specified copy group. This request also gets information about the pairs (TrueCopy, Universal Replicator, or global-active device) included in the copy group. If the copy group name or copy pair name contains single-byte spaces, pair information cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-mirror-copygroups/object-ID
Request message
  • Object ID

    Specify the value of remoteMirrorCopyGroupId that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system#

    Specify a decimal (base 10) number equal to or greater than 0.

    copyGroupName

    string

    (Required) Copy group name

    Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system#

    Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

    #: If you specify NotSpecified in cases such as when a failure occurs in a remote storage system, only information about the local storage system can be acquired. If you specify NotSpecified, copy pair information about attributes of volumes that belong to the remote storage system will not be output. In this case, you do not need to specify the Remote-Authorization header.

  • Query parameters

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of detailed information to be obtained

    • class

      Adds additional information# from the storage system's cache.

      You can specify this item for VSP 5000 series.

      To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

    #: If the remote storage system is a VSP E series, VSP G350, G370, G700, G900 or VSP F350, F370, F700, F900 model storage system, you might not be able to get some of the information about the remote storage system.

    For other storage systems, if the remote storage system's microcode version meets the following conditions, you might not be able to get some of the information about the remote storage system.

    • For a VSP 5000 series storage system:

      The microcode version is earlier than 90-01-42-XX/XX.

    • For a VSP G1000, VSP G1500, VSP F1500 model storage system:

      The microcode version is earlier than 80-06-71-XX/XX.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when information about TrueCopy pairs is obtained:

    {
      "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_",
      "copyGroupName" : "remoteCopyGroup1",
      "copyPairs" : [ {
        "copyGroupName" : "remoteCopyGroup1",
        "copyPairName" : "pair1",
        "replicationType" : "TC",
        "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1",
        "pvolLdevId" : 2108,
        "svolLdevId" : 1581,
        "fenceLevel" : "DATA",
        "pvolStatus" : "PAIR",
        "svolStatus" : "PAIR",
        "consistencyGroupId": 5,
        "pvolStorageDeviceId" : "886000123456",
        "svolStorageDeviceId" : "886000123789",
        "pvolDifferenceDataManagement": "S",
        "svolDifferenceDataManagement": "S",
        "pvolProcessingStatus": "N",
        "svolProcessingStatus": "N"
      }, {
        "copyGroupName" : "remoteCopyGroup1",
        "copyPairName" : "pair2",
        "replicationType" : "TC",
        "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair2",
        "pvolLdevId" : 2109,
        "svolLdevId" : 1582,
        "fenceLevel" : "DATA",
        "pvolStatus" : "PSUS",
        "svolStatus" : "SMPL",
        "consistencyGroupId": 5,
        "pvolStorageDeviceId" : "886000123456",
        "svolStorageDeviceId" : "886000123789",
        "pvolDifferenceDataManagement": "S",
        "svolDifferenceDataManagement": "S",
        "pvolProcessingStatus": "N",
        "svolProcessingStatus": "N"
      } ],
      "remoteStorageDeviceId" : "886000123789",
      "localDeviceGroupName" : "remoteCopyGroup1P_",
      "remoteDeviceGroupName" : "remoteCopyGroup1S_"
    }

    The following is an example of the output when information about Universal Replicator pairs is obtained:

    {
      "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_",
      "copyGroupName" : "remoteCopyGroup2",
      "copyPairs" : [ {
        "copyGroupName" : "remoteCopyGroup2",
        "copyPairName" : "pair1",
        "replicationType" : "UR",
        "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1",
        "consistencyGroupId" : 10,
        "pvolLdevId" : 1569,
        "pvolJournalId" : 13,
        "svolLdevId" : 2835,
        "svolJournalId" : 36,
        "fenceLevel" : "ASYNC",
        "pvolStatus" : "PAIR",
        "svolStatus" : "PAIR",
        "pvolStorageDeviceId" : "886000123456",
        "svolStorageDeviceId" : "886000123789",
        "pvolDifferenceDataManagement": "S",
        "svolDifferenceDataManagement": "S",
        "pvolProcessingStatus": "N",
        "svolProcessingStatus": "N"
      } ],
      "remoteStorageDeviceId" : "886000123789",
      "localDeviceGroupName" : "remoteCopyGroup2P_",
      "remoteDeviceGroupName" : "remoteCopyGroup2S_"
    }

    The following is an example of the output when information about global-active device pairs is obtained:

    {
      "remoteMirrorCopyGroupId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_",
      "copyGroupName" : "remoteCopyGroup3",
      "copyPairs" : [ {
        "copyGroupName" : "remoteCopyGroup3",
        "copyPairName" : "pair1",
        "replicationType" : "GAD",
        "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1",
        "quorumDiskId" : 14,
        "pvolLdevId" : 1580,
        "svolLdevId" : 2128,
        "fenceLevel" : "NEVER",
        "pvolStatus" : "PAIR",
        "svolStatus" : "PAIR",
        "pvolIOMode" : "L/M",
        "svolIOMode" : "L/M",
        "pvolStorageDeviceId" : "886000123456",
        "svolStorageDeviceId" : "886000123789",
        "pvolDifferenceDataManagement": "S",
        "svolDifferenceDataManagement": "S",
        "pvolProcessingStatus": "N",
        "svolProcessingStatus": "N"
      } ],
      "remoteStorageDeviceId" : "886000123789",
      "localDeviceGroupName" : "remoteCopyGroup3P_",
      "remoteDeviceGroupName" : "remoteCopyGroup3S_"
    }

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    Storage device ID of the remote storage system

    If you specify a value that includes NotSpecified for the object ID, NotSpecified is output.

    copyGroupName

    string

    Copy group name

    localDeviceGroupName

    string

    Device group name in the local storage system

    remoteDeviceGroupName

    string

    Device group name in the remote storage system

    If you specify a value that includes NotSpecified for the object ID, NotSpecified is output.

    remoteMirrorCopyGroupId

    string

    Object ID of the remote copy group

    The following attributes are output, separated by commas:

    • remoteStorageDeviceId
    • copyGroupName
    • localDeviceGroupName
    • remoteDeviceGroupName

    copyPairs

    object[]

    The detailed information about the copy pair is output.

    • copyGroupName (string)

      Copy group name

    • copyPairName (string)

      Copy pair name

    • replicationType (string)

      Pair type

      • TC: TrueCopy
      • UR: Universal Replicator
      • GAD: global-active device

      If the pair status is SMPL, information is not output.

    • pvolLdevId (int)

      LDEV number of P-VOL

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    • svolLdevId (int)

      LDEV number of S-VOL

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    • fenceLevel (string)

      Fence level

      • DATA: S-VOL data
      • STATUS: S-VOL status
      • NEVER: None
      • ASYNC: Asynchronous

      If the fence level cannot be obtained, information is not output.

    • pvolJournalId (int)

      Journal ID of the P-VOL

      A value from 0 to 255 is output only in the case of Universal Replicator. If the pair status is SMPL, information is not output.

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    • svolJournalId (int)

      Journal ID of the S-VOL

      A value from 0 to 255 is output only in the case of Universal Replicator. If the pair status is SMPL, information is not output.

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    • quorumDiskId (int)

      ID of the Quorum disk

      A value from 0 to 31 is output only in the case of global-active device. If the pair status is SMPL, information is not output.

    • pvolStatus (string)

      Pair status of the P-VOL

      For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

      If the pair status cannot be obtained, information is not output.

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    • svolStatus (string)

      Pair status of the S-VOL

      For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

      If the pair status cannot be obtained, information is not output.

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    • consistencyGroupId (int)

      Consistency group ID

      If no consistency group consists, information is not output.

    • pvolIOMode (string)

      I/O mode of the P-VOL

      • L/M: Mirror (RL)
      • L/L: Local
      • B/B: Block

      Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    • svolIOMode (string)

      I/O mode of the S-VOL

      • L/M: Mirror (RL)
      • L/L: Local
      • B/B: Block

      Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    • pvolStorageDeviceId (string)

      Storage device ID of the storage system on the P-VOL

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    • svolStorageDeviceId (string)

      Storage device ID of the storage system on the S-VOL

      If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    • copyProgressRate (int)

      Copy progress rate

      Information is output only when the pair status of the P-VOL is COPY (a pair is being created or resynchronized).

      This attribute is not output if you specify a value that includes NotSpecified for the object ID.

    • remoteMirrorCopyPairId (string)

      Object ID of the remote copy pair#

      The following attributes are output, separated by commas:

      • remoteStorageDeviceId
      • copyGroupName
      • localDeviceGroupName
      • remoteDeviceGroupName
      • copyPairName
    • pvolDifferenceDataManagement (string)

      Method for managing difference data about the P-VOL

      • S: Difference data based on the shared memory
      • D: Hierarchical difference data (difference data based on drives)
    • svolDifferenceDataManagement (string)

      Method for managing difference data about the S-VOL

      • S: Difference data based on the shared memory
      • D: Hierarchical difference data (difference data based on drives)
    • pvolProcessingStatus (string)

      Processing status of the pair of P-VOLs

      • E: Processing to expand the P-VOLs is being performed
      • N: Processing to expand the P-VOLs is not being performed
    • svolProcessingStatus (string)

      Processing status of the pair of S-VOLs

      • E: Processing to expand the S-VOLs is being performed
      • N: Processing to expand the S-VOLs is not being performed

    #: We recommend that you save the object ID information you obtain in case a failure occurs. When you need to perform a takeover to recover the system, you can use the saved information to identify the pair that you need to work on, even if you cannot get information about the failed storage system.

    If you run this request with class specified for detailInfoType in the query parameters, additional information from the storage system's cache is also obtained.

    Type

    Attribute

    Description

    object[]

    copyPairs

    Attributes related to the detailed information about the copy pair

    • transitionStatus (string)

      The transition status of a pair is output for a Universal Replicator pair.

      • None: The pair is not in transition.
      • Suspending: The pair is being split.
      • Deleting: The pair is being deleted.

      This is not output if the copy pair is not a Universal Replicator pair.

    • copyPace (int)

      Copy speed

      This is not output for a Universal Replicator pair.

    • pathGroupId (int)

      ID of the RCU path group

      This is not output if CU is specified for the remote path connection setting.

      This is not output if the pair volume status of the P-VOL or S-VOL (the value of the pvolStatus attribute of the svolStatus attribute) is SMPL.

    • deltaStatus (string)

      Status of the 3DC multi-target configuration that uses delta resync

      This is output if the value of replicationType for the copyPairs attribute of the replicationType attribute, which is the pair type for the detailed information about the remote copy pairs, is Universal Replicator, and if you are using a 3DC multi-target configuration that uses delta resync.

      • HOLD: Universal Replicator delta resync pair (normal)
      • HLDE: Universal Replicator delta resync pair (failed)
      • HOLDING: In the process of being changed to a Universal Replicator delta resync pair
Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

For TrueCopy:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_

For Universal Replicator:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_

For global-active device:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_

Getting information about global-active device pairs

The following request acquires a list of volume information and storage system information about the P-VOLs and S-VOLs that make up a global-active device pair. You can get information about a pair without specifying information about the remote storage system in the request message.
Important

For a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system, pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

Execution permission

Administrator user group (built-in user group)

Request line
GET base-URL/v1/objects/remote-copypairs
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    replicationType

    string

    (Required) Specify the pair type.

    GAD: global-active device

    startLdevId

    int

    (Optional) Specify, as a decimal (base 10) number, the number of the first LDEV for which you want to acquire information about the pair.

    Specify a value in the range from 0 to 65279.

    If you specify this attribute, be sure to also specify the endLdevId attribute. The value of this attribute must be equal to or less than the value of endLdevId.

    If this attribute is omitted, 0 is set.

    endLdevId

    int

    (Optional) Specify, as a decimal (base 10) number, the number of the last LDEV for which you want to acquire information about the pair.

    Specify a value in the range from 0 to 65279.

    If you specify this attribute, be sure to also specify the startLdevId attribute. The value of this attribute must be equal to or greater than the value of startLdevId.

    Specify these values so that the range indicated by the startLdevId and endLdevId attributes consists of no more than 2048 LDEVs.

    If this attribute is omitted, 2047 will be set.

  • Body

    None.

Response message
  • Body

    {
      "data" : [ {
        "replicationType" : "GAD",
        "ldevId" : 8,
        "remoteSerialNumber" : "415008",
        "remoteStorageTypeId" : "M8",
        "remoteLdevId" : 22,
        "primaryOrSecondary" : "P-VOL",
        "muNumber" : 0,
        "status" : "PSUE",
        "isSSWS" : false,
        "createdLocalTime" : "2017-09-29T16:26:07",
        "quorumDiskId" : 1,
        "suspendedMode" : "BLOCK"
      }, {
        "replicationType" : "GAD",
        "ldevId" : 9,
        "remoteSerialNumber" : "415008",
        "remoteStorageTypeId" : "M8",
        "remoteLdevId" : 23,
        "primaryOrSecondary" : "P-VOL",
        "muNumber" : 2,
        "status" : "PSUS",
        "isSSWS" : false,
        "createdLocalTime" : "2017-10-02T09:46:36",
        "quorumDiskId" : 1,
        "suspendedMode" : "BLOCK"
      }, {
        "replicationType" : "GAD",
        "ldevId" : 73,
        "remoteSerialNumber" : "415008",
        "remoteStorageTypeId" : "M8",
        "remoteLdevId" : 2171,
        "primaryOrSecondary" : "P-VOL",
        "muNumber" : 0,
        "status" : "PAIR",
        "isSSWS" : false,
        "createdLocalTime" : "2018-11-04T01:12:39",
        "quorumDiskId" : 1,
        "suspendedMode" : "BLOCK"
      }, {
        "replicationType" : "GAD",
        "ldevId" : 93,
        "remoteSerialNumber" : "415008",
        "remoteStorageTypeId" : "M8",
        "remoteLdevId" : 25,
        "primaryOrSecondary" : "P-VOL",
        "muNumber" : 0,
        "status" : "PSUE",
        "isSSWS" : false,
        "createdLocalTime" : "2017-10-27T17:42:33",
        "quorumDiskId" : 1,
        "suspendedMode" : "BLOCK"
      }, {
        "replicationType" : "GAD",
        "ldevId" : 99,
        "remoteSerialNumber" : "415008",
        "remoteStorageTypeId" : "M8",
        "remoteLdevId" : 2163,
        "primaryOrSecondary" : "P-VOL",
        "muNumber" : 0,
        "status" : "PAIR",
        "isSSWS" : false,
        "createdLocalTime" : "2018-03-11T03:10:22",
        "quorumDiskId" : 1,
        "suspendedMode" : "BLOCK"
      } ]
    }

    Attribute

    Type

    Description

    replicationType

    string

    Pair type

    GAD: global-active device

    ldevId

    int

    LDEV number of the volume on the local storage system.

    remoteSerialNumber

    string

    Serial number of the remote storage system

    remoteStorageTypeId

    string

    ID corresponding to 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

    remoteLdevId

    int

    LDEV number of the volume on the remote storage system

    primaryOrSecondary

    string

    Attribute of the volume on the local storage system

    • P-VOL
    • S-VOL

    muNumber

    int

    MU number

    status

    string

    Pair status of the volume on the local storage system

    For details, see the section about pair status transition (global-active device).

    isSSWS

    boolean

    Indicates whether the state of the volume on the local storage system is SSWS.

    • true: The state of the volume is SSWS.
    • false: The state of the volume is not SSWS.

    createdLocalTime

    string

    Time at which the pair was created.

    The local time of the storage system is displayed in YYYY-MM-DDThh:mm:ss format.

    quorumDiskId

    int

    Quorum disk ID

    suspendedMode

    string

    Block or Remote instructions when a pair is suspended

    • BLOCK_IO: Block with I/O check

    • BLOCK: Block without I/O check

    • REMOTE: Remote

Status codes

For details on the status codes for the request that performs this operation, see the description of 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/remote-copypairs?replicationType=GAD

Getting information about a specific remote copy pair

The following request gets information about the specified copy pair (TrueCopy, Universal Replicator, or global-active device). Use this information to get the information that is necessary for performing pair operations (for example, the pair status). If the copy group name or copy pair name contains single-byte spaces, pair information cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/remote-mirror-copypairs/object-ID
Request message
  • Object ID

    Specify the value of remoteMirrorCopyPairId that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system #

    Specify a decimal (base 10) number equal to or greater than 0.

    copyGroupName

    string

    (Required) Copy group name

    Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system #

    Specify a character string consisting of 1 to 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Copy pair name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    #: If you specify NotSpecified in cases such as when a failure occurs in a remote storage system, only information about the local storage system can be acquired. If you specify NotSpecified, copy pair information about attributes of volumes that belong to the remote storage system will not be output. In this case, you do not need to specify the Remote-Authorization header.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when information about TrueCopy pairs is obtained:

    {
      "copyGroupName" : "remoteCopyGroup1",
      "copyPairName" : "pair1",
      "replicationType" : "TC",
      "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1",
      "pvolLdevId" : 2108,
      "svolLdevId" : 1581,
      "fenceLevel" : "DATA",
      "pvolStatus" : "PAIR",
      "svolStatus" : "PAIR",
      "pvolStorageDeviceId" : "886000123456",
      "svolStorageDeviceId" : "886000123789",
      "pvolDifferenceDataManagement": "S", 
      "svolDifferenceDataManagement": "S", 
      "pvolProcessingStatus": "N", 
      "svolProcessingStatus": "N" 
    }

    The following is an example of the output when information about Universal Replicator pairs is obtained:

    {
      "copyGroupName" : "remoteCopyGroup2",
      "copyPairName" : "pair1",
      "replicationType" : "UR",
      "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1",
      "consistencyGroupId" : 10,
      "pvolLdevId" : 1569,
      "pvolJournalId" : 13,
      "svolLdevId" : 2835,
      "svolJournalId" : 36,
      "fenceLevel" : "ASYNC",
      "pvolStatus" : "PAIR",
      "svolStatus" : "PAIR",
      "pvolStorageDeviceId" : "886000123456",
      "svolStorageDeviceId" : "886000123789",
      "pvolDifferenceDataManagement": "S", 
      "svolDifferenceDataManagement": "S", 
      "pvolProcessingStatus": "N", 
      "svolProcessingStatus": "N" 
    }
    

    The following is an example of the output when information about global-active device pairs is obtained:

    {
      "copyGroupName" : "remoteCopyGroup3",
      "copyPairName" : "pair1",
      "replicationType" : "GAD",
      "remoteMirrorCopyPairId" : "886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1",
      "quorumDiskId" : 14,
      "pvolLdevId" : 1580,
      "svolLdevId" : 2128,
      "fenceLevel" : "NEVER",
      "pvolStatus" : "PAIR",
      "svolStatus" : "PAIR",
      "pvolIOMode" : "L/M",
      "svolIOMode" : "L/M",
      "pvolStorageDeviceId" : "886000123456",
      "svolStorageDeviceId" : "886000123789",
      "pvolDifferenceDataManagement": "S", 
      "svolDifferenceDataManagement": "S", 
      "pvolProcessingStatus": "N", 
      "svolProcessingStatus": "N" 
    }

    Attribute

    Type

    Description

    copyGroupName

    string

    Copy group name

    copyPairName

    string

    Copy pair name

    replicationType

    string

    Pair type

    • TC: TrueCopy
    • UR: Universal Replicator
    • GAD: global-active device

    If the pair status is SMPL, information is not output.

    pvolLdevId

    int

    LDEV number of P-VOL

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    svolLdevId

    int

    LDEV number of S-VOL

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    fenceLevel

    string

    Fence level

    • DATA: S-VOL data
    • STATUS: S-VOL status
    • NEVER: None
    • ASYNC: Asynchronous

    If the fence level cannot be obtained, information is not output.

    pvolJournalId

    int

    Journal ID of the P-VOL

    A value from 0 to 255 is output only in the case of UR. If the pair status is SMPL, information is not output.

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    svolJournalId

    int

    Journal ID of the S-VOL

    A value from 0 to 255 is output only in the case of UR. If the pair status is SMPL, information is not output.

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    quorumDiskId

    int

    ID of the Quorum disk

    A value from 0 to 31 is output only in the case of global-active device. If the pair status is SMPL, information is not output.

    pvolStatus

    string

    Pair status of the P-VOL

    For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

    If the pair status cannot be obtained, information is not output.

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    svolStatus

    string

    Pair status of the S-VOL

    For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

    If the pair status cannot be obtained, information is not output.

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    consistencyGroupId

    int

    Consistency group ID

    If no consistency group consists, information is not output.

    pvolIOMode

    string

    I/O mode of the P-VOL

    • L/M: Mirror (RL)
    • L/L: Local
    • B/B: Block

    Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    svolIOMode

    string

    I/O mode of the S-VOL

    • L/M: Mirror (RL)
    • L/L: Local
    • B/B: Block

    Information is output only in the case of global-active device. If the pair status is SMPL, information is not output.

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    pvolStorageDeviceId

    string

    Storage device ID of the storage system on the P-VOL

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the P-VOL is a volume in the local storage system.

    svolStorageDeviceId

    string

    Storage device ID of the storage system on the S-VOL

    If you specify a value that includes NotSpecified for the object ID, this attribute is output only if the S-VOL is a volume in the local storage system.

    copyProgressRate

    int

    Copy progress rate

    Information is output only when the pair status of the P-VOL is COPY (a pair is being created or resynchronized).

    This attribute is not output if you specify a value that includes NotSpecified for the object ID.

    remoteMirrorCopyPairId

    string

    Object ID of the remote copy pair#

    The following attributes are output, separated by commas:

    • remoteStorageDeviceId
    • copyGroupName
    • localDeviceGroupName
    • remoteDeviceGroupName
    • copyPairName

    pvolDifferenceDataManagement

    string

    Method for managing difference data about the P-VOL

    • S: Difference data based on the shared memory
    • D: Hierarchical difference data (difference data based on drives)

    svolDifferenceDataManagement

    string

    Method for managing difference data about the S-VOL

    • S: Difference data based on the shared memory
    • D: Hierarchical difference data (difference data based on drives)

    pvolProcessingStatus

    string

    Processing status of the pair of P-VOLs

    • E: Processing to expand the P-VOLs is being performed
    • N: Processing to expand the P-VOLs is not being performed

    svolProcessingStatus

    string

    Processing status of the pair of S-VOLs

    • E: Processing to expand the S-VOLs is being performed
    • N: Processing to expand the S-VOLs is not being performed

    #: We recommend that you save the object ID information you obtain in case a failure occurs. When you need to perform a takeover to recover the system, you can use the saved information to identify the pair that you need to work on, even if you cannot get information about the failed storage system.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

For TrueCopy:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup1,remoteCopyGroup1P_,remoteCopyGroup1S_,pair1

For Universal Replicator:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup2,remoteCopyGroup2P_,remoteCopyGroup2S_,pair1

For global-active device:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup3,remoteCopyGroup3P_,remoteCopyGroup3S_,pair1

Getting information about all of remote copy pairs

The following request gets a list of information about the remote copy pairs (TrueCopy, Universal Replicator, or global-active device) registered in the target storage system. You can obtain information about all such pairs from the cache of the storage system, regardless of whether they are managed by using copy groups. You do not need to specify the information about the remote storage system in the request message.
Note
  • This API can be used when the storage system is the VSP 5000 series.

  • To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/storages/remote-replications
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter condition

    startLdevId

    int

    (Optional) To specify a range of LDEVs, specify the LDEV number of the first LDEV in the range.

    The P-VOLs and S-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.

    Specify a value in the range from 0 to 65279.

    The value of this parameter must be smaller than that of the endLdevId parameter.

    If this attribute is omitted, 0 is set.

    endLdevId

    int

    (Optional) To specify a range of LDEVs, specify the LDEV number of the last LDEV in the range.

    The P-VOLs and S-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.

    Specify a value in the range from 0 to 65279.

    The value of this parameter must be greater than that of the startLdevId parameter.

    If this attribute is omitted, the maximum LDEV number in the storage system is set.

    replicationType

    string

    (Optional) Specify the pair type of the pairs about which information is to be obtained.

    • TC: TrueCopy
    • UR: Universal Replicator
    • GAD: global-active device
  • Body

    None.

Response message
  • Body

    {
        "data": [
            {
                "remoteReplicationId": "R9,10088,375,R9,10011,969",
                "muNumber": 2,
                "replicationType": "UR",
                "pvolLdevId": 375,
                "svolLdevId": 969,
                "fenceLevel": "ASYNC",
                "pvolJournalId": 10,
                "svolJournalId": 0,
                "pvolStatus": "PAIR",
                "consistencyGroupId": 17,
                "pvolStorageType": "R9",
                "pvolStorageSerial": "10088",
                "svolStorageType": "R9",
                "svolStorageSerial": "10011",
                "transitionStatus": "None",
                "pathGroupId": 0
            },
            {
                "remoteReplicationId": "R9,10088,378,R9,10011,765",
                "replicationType": "TC",
                "pvolLdevId": 378,
                "svolLdevId": 765,
                "fenceLevel": "DATA",
                "pvolStatus": "PAIR",
                "pvolStorageType": "R9",
                "pvolStorageSerial": "10088",
                "svolStorageType": "R9",
                "svolStorageSerial": "10011", 
                "copyPace": 3,
                "pathGroupId": 0
            },
            {
                "remoteReplicationId": "R9,10088,400,R9,10011,567",
                "muNumber": 0,
                "replicationType": "GAD",
                "pvolLdevId": 400,
                "svolLdevId": 567,
                "fenceLevel": "NEVER",
                "quorumDiskId": 4,
                "pvolStatus": "PAIR",
                "consistencyGroupId": 11,
                "pvolIOMode": "L/M",
                "pvolStorageType": "R9",
                "pvolStorageSerial": "10088",
                "svolStorageType": "R9",
                "svolStorageSerial": "10011",
                "copyPace": 7,
                "pathGroupId": 0
            }
        ]
    }

    Attribute

    Type

    Description

    remoteReplicationId

    string

    Object ID of the remote copy pair

    The following attributes are output, separated by commas:

    • pvolStorageType
    • pvolStorageSerial
    • pvolLdevId
    • svolStorageType
    • svolStorageSerial
    • svolLdevId

    If the value of remoteReplicationId includes Unknown or -1, the pair might not be in a normal state. Check the status of the storage system.

    muNumber

    int

    MU (mirror unit) number

    replicationType

    string

    Pair type

    • TC: TrueCopy
    • UR: Universal Replicator
    • GAD: global-active device

    pvolLdevId

    int

    LDEV number of P-VOL

    svolLdevId

    int

    LDEV number of S-VOL

    fenceLevel

    string

    Fence level

    • DATA: S-VOL data
    • STATUS: S-VOL status
    • NEVER: None
    • ASYNC: Asynchronous

    If the fence level cannot be obtained, information is not output.

    pvolJournalId

    int

    Journal ID of the P-VOL

    A value from 0 to 255 is output only in the case of Universal Replicator.

    svolJournalId

    int

    Journal ID of the S-VOL

    A value from 0 to 255 is output only in the case of Universal Replicator.

    quorumDiskId

    int

    ID of the Quorum disk

    A value from 0 to 31 is output only in the case of global-active device.

    pvolStatus

    string

    Pair volume status of the P-VOL

    This attribute is output only if the specified storage system contains the P-VOL.

    For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

    In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

    svolStatus

    string

    Pair volume status of the S-VOL

    This attribute is output only if the specified storage system contains the S-VOL.

    For details, see the section explaining on pair status (TrueCopy and Universal Replicator) or pair status (global-active device).

    In the case of Universal Replicator, if the transition status of the Universal Replicator pair is Suspending or Deleting, information is not output.

    consistencyGroupId

    int

    Consistency group ID

    This attribute is not output if no consistency group consists.

    pvolIOMode

    string

    I/O mode of the P-VOL

    • L/M: Mirror (RL)
    • L/L: Local
    • B/B: Block

    This is output only if the volume is a global-active device and the specified storage system is on the P-VOL.

    svolIOMode

    string

    I/O mode of the S-VOL

    • L/M: Mirror (RL)
    • L/L: Local
    • B/B: Block

    This is output only if the volume is a global-active device and the specified storage system is on the S-VOL.

    pvolStorageType

    string

    ID indicating the model of the storage system on the P-VOL

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

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

    pvolStorageSerial

    string

    Serial number of the storage system on the P-VOL

    svolStorageType

    string

    ID indicating the model of the storage system on the S-VOL

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

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

    svolStorageSerial

    string

    Serial number of the storage system on the S-VOL

    transitionStatus

    string

    The transition status of a pair is output for a Universal Replicator pair.

    • None: The pair is not in transition.
    • Suspending: The pair is being split.
    • Deleting: The pair is being deleted.

    This is not output if the copy pair is not a Universal Replicator pair.

    copyPace

    int

    Copy speed

    If the pair type is TrueCopy, this attribute is output only if the specified storage system contains the P-VOL.

    If the pair type is global-active device, this attribute is output regardless of whether the specified storage system contains the P-VOL or contains the S-VOL.

    This is not output if the pair type is Universal Replicator.

    pathGroupId

    int

    Path group ID of the RCU

    This is not output if CU is specified for the remote path connection setting.

    deltaStatus

    string

    Status of the 3DC multi-target configuration that uses delta resync

    This is output if the pair type is Universal Replicator and the 3DC multi-target configuration that uses delta resync is used.

    • HOLD: Universal Replicator delta resync pair (normal)
    • HLDE: Universal Replicator delta resync pair (failed)
    • HOLDING: In the process of being changed to a Universal Replicator delta resync pair
Status codes

For details on the status codes for the request that performs this operation, see the description of HTTP status codes.

Coding example
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-replications

Creating a global-active device pair

The following request creates a global-active device pair in the storage systems of the primary and secondary sites. The global-active device pair is either added to a new copy group or to an existing copy group. If you create a copy group, a device group is also created. Before creating a pair, lock the resources or make sure that the resources have not been locked by another user.
Tip
  • Before creating the pair, set the reserved attribute of global-active device for the secondary volume by using the API that sets a virtual LDEV number.
  • We recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)

Request line

POST base-URL/v1/objects/remote-mirror-copypairs
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following is a coding example for creating a new copy group and adding a pair to the copy group:

    {
      "copyGroupName": "remoteCopyGroup3",
      "copyPairName": "pair1",
      "replicationType": "GAD",
      "remoteStorageDeviceId": "886000123789",
      "pvolLdevId": 1580,
      "svolLdevId": 2128,
      "localDeviceGroupName": "remoteCopyGroup3P_",
      "remoteDeviceGroupName": "remoteCopyGroup3S_",
      "muNumber": 0,
      "quorumDiskId": 14,
      "isNewGroupCreation": true,
      "fenceLevel": "NEVER",
      "copyPace": 10,
      "doInitialCopy": true,
      "isDataReductionForceCopy": true
    }
    

    The following is a coding example for adding a pair to an existing copy group:

    {
      "copyGroupName": "remoteCopyGroup3",
      "copyPairName": "pair2",
      "replicationType": "GAD",
      "remoteStorageDeviceId": "886000123789",
      "pvolLdevId": 1581,
      "svolLdevId": 2129,
      "localDeviceGroupName": "remoteCopyGroup3P_",
      "remoteDeviceGroupName": "remoteCopyGroup3S_",
      "quorumDiskId": 14,
      "isNewGroupCreation": false,
      "fenceLevel": "NEVER",
      "copyPace": 10,
      "doInitialCopy": true,
      "isDataReductionForceCopy": false
    }

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify a copy group name consisting of 1 to 29 characters. The name is case sensitive.

    Set a unique name that is the same for the storage systems on both the local and remote sides.

    copyPairName

    string

    (Required) Specify a copy pair name consisting of 1 to 31 characters. The name is case sensitive.

    Set a unique name that is the same for the storage systems in the copy group.

    replicationType

    string

    (Required) Specify the pair type.

    GAD: global-active device

    remoteStorageDeviceId

    string

    (Required) Specify the storage device ID of the remote storage system in which the pair is to be created.

    pvolLdevId

    int

    (Required) Specify the LDEV number of the P-VOL with a decimal (base 10) number.

    svolLdevId

    int

    (Required) Specify the LDEV number of the S-VOL for which the reserved attribute of global-active device is set. Specify it with a decimal (base 10) number.

    Specify the reserved attribute of global-active device by using the API that sets a virtual LDEV number.

    pathGroupId

    int

    (Optional) Specify the path group ID by using a decimal (base 10) number in the range from 0 to 255.

    If you omit this value or specify 0, the lowest path group ID in the specified path group is used.

    localDeviceGroupName

    string

    (Optional) Specify the device group name in the local storage system by using 1 to 31 characters. The name is case sensitive.

    If you add the pair to an existing copy group, specify the same device group name as that of the existing local storage system. The name needs to be unique in the local storage system. If this value is omitted, copyGroupNameP_ is assumed.

    remoteDeviceGroupName

    string

    (Optional) Specify the device group name in the remote storage system by using 1 to 31 characters. The name is case sensitive.

    If you add the pair to an existing copy group, specify the same device group name as that of the existing remote storage system. The name needs to be unique in the remote storage system. If this value is omitted, copyGroupNameS_ is assumed.

    isNewGroupCreation

    boolean

    (Required) Depending on the value, this attribute specifies whether to add the pair to a new copy group or to an existing copy group.

    • true: Adds the pair to a new copy group.
    • false: Adds the pair to an existing copy group.

    muNumber

    int

    (Required) Specify the MU (mirror unit) number by using a number from 0 to 3.

    This value is used by the P-VOL and the S-VOL. You can specify this attribute only if you add the pair to a new copy group.

    quorumDiskId

    int

    (Required) Specify the quorum disk ID by using a decimal (base 10) number in the range from 0 to 31.

    isConsistencyGroup

    boolean

    (Optional) Depending on the value, this attribute specifies whether to register the new pair in a consistency group.

    • true: Registers the pair in a consistency group.
    • false: Does not register the pair in a consistency group.

    If you add the pair to an existing copy group, specify the same value as that of the existing copy pair. If a copy group includes both pairs that are registered in a consistency group and pairs that are not registered in a consistency group, pair operations by consistency group cannot be correctly performed. If this value is omitted, false is assumed.

    consistencyGroupId

    int

    (Optional) Specify the consistency group ID by using a decimal (base 10) number.

    If you omit this value when registering the new pair in a consistency group, the value is automatically assigned.

    If you add the pair to an existing copy group, specify the same value as that of the existing copy pair. If a copy group includes a pair whose consistency group ID differs, pair operations by consistency group cannot be correctly performed.

    When specifying this attribute, make sure to specify true for the isConsistencyGroup attribute.

    fenceLevel

    string

    (Optional) Fence level

    NEVER is automatically set.

    copyPace

    int

    (Optional) Copy speed

    Specify a decimal (base 10) number in the range from 1 to 15 for the size of tracks to be copied. The larger the value you specify, the faster the copy speed.

    If this value is omitted, 3 is assumed.

    doInitialCopy

    boolean

    (Optional) Specify whether to perform initial copy when creating a pair.

    • true: Performs initial copy.
    • false: Does not perform initial copy.

    If this value is omitted, true is assumed.

    isDataReductionForceCopy

    boolean

    (Optional) Specify whether to forcibly create a pair for the volume for which the capacity saving function (dedupe and compression) is enabled.

    • true: Forcibly create a pair #
    • false: Do not forcibly create a pair

    When the attribute is omitted, false is assumed.

    #: If you create a pair by using volumes for which the capacity saving function (compression or deduplication) is enabled, data that has been compressed or deduplicated will be copied and, as a result, the performance of the copying processing or the I/O performance of the host might decrease.

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 for accessing the created global-active device pair

Status codes

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

Coding example
curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs

Deleting global-active device pairs in units of copy groups

The following request deletes global-active device pairs by using the specified copy group. When the pairs are all deleted, the device groups are also deleted. You can specify a copy group on the primary volume side to delete pairs. Alternatively, you can specify a copy group on the secondary volume side to delete pairs. Before deleting pairs, specify the copy group to suspend the pairs, and then change the statuses of the pairs to suspension. If a copy group includes the primary volume and the secondary volume, you cannot specify a copy group to delete pairs. Before deleting a pair, lock the resources or make sure that the resources have not been locked by another user.
Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)

Request line

DELETE base-URL/v1/objects/remote-mirror-copygroups/object-ID
Request message
  • Object ID

    Specify the value of remoteMirrorCopyGroupId that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    copyGroupName

    string

    (Required) Copy group name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    The following is a coding example of continuing to use the S-VOL after a suspended (S-LOCAL) pair is deleted:

    {
      "isSvolToKeepUsing" : true
    }

    Attribute

    Type

    Description

    isSvolToKeepUsing

    boolean

    (Optional) Specify the volume that continues I/O after pairs are deleted.

    • true: Deletes the pairs by specifying the S-VOL.

      The S-VOL continues I/O, and the reserved attribute of global-active device is set for the P-VOL. If you set true, you must suspend pairs in advance by specifying the S-VOL.

    • false: Deletes the pairs by specifying the P-VOL.

      The P-VOL continues I/O, and the reserved attribute of global-active device is set for the S-VOL. If you set false, you must suspend pairs in advance by specifying the P-VOL.

    If this value is omitted, false is set.

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 copy group of the deleted global-active device pairs

Status codes

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

Coding example
curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_

Deleting a global-active device pair

The following request deletes the specified global-active device pair. As a result of deleting a pair, if there is no pair in the copy group, the copy group and the device group are also deleted. You can specify the primary volume to delete a pair. Alternatively, you can specify the secondary volume to delete a pair. Before deleting a pair, suspend the pair, and then change the status of the pair to suspension. Before deleting a pair, lock the resources or make sure that the resources have not been locked by another user.
Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Remote Copy)

Request line

DELETE base-URL/v1/objects/remote-mirror-copypairs/object-ID
Request message
  • Object ID

    Specify the value of remoteMirrorCopyPairId that was obtained by the processing to get information about the remote copy pair. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    copyGroupName

    string

    (Required) Copy group name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Copy pair name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    The following is a coding example of continuing to use the S-VOL after a suspended (S-LOCAL) pair is deleted:

    {
      "isSvolToKeepUsing" : true
    }
    

    Attribute

    Type

    Description

    isSvolToKeepUsing

    boolean

    (Optional) Specify the volume that continues I/O after the pair is deleted.

    • true: Deletes the pair by specifying the S-VOL.

      The S-VOL continues I/O, and the reserved attribute of global-active device is set for the P-VOL. If you set true, you must suspend pairs in advance by specifying the S-VOL.

    • false: Deletes the pair by specifying the P-VOL.

      The P-VOL continues I/O, and the reserved attribute of global-active device is set for the S-VOL. If you set false, you must suspend pairs in advance by specifying the P-VOL.

    If this value is omitted, false is set.

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 deleted global-active device pair

Status codes

For details on the status codes of the request for this operation, see the section explaining HTTP status codes.

Coding example
curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1

Suspending global-active device pairs in units of copy groups

The following request suspends global-active device pairs by using the specified copy group. You can specify a copy group on the primary volume side to suspend pairs. Alternatively, you can specify a copy group on the secondary volume side to suspend pairs. If a copy group includes the primary volume and the secondary volume, you cannot specify the copy group to suspend pairs. Also, when suspending pairs by copy group, do not simultaneously perform other operations on the copy group or the pairs in that copy group on which a pair suspending operation is performed.
TipWe recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
Execution permission

Storage Administrator (Remote Copy)

Request line
POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split/invoke
Request message
  • Object ID

    Specify the value of remoteMirrorCopyGroupId that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    copyGroupName

    string

    (Required) Copy group name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    The following coding example is for simply suspending pairs. After pairs are suspended, I/O is continued on the P-VOL.

    {
      "parameters": {
        "replicationType": "GAD"
      }
    }

    The following coding example is for suspending pairs by specifying the S-VOL. After pairs are suspended, I/O is continued on the S-VOL.

    {
      "parameters": {
        "replicationType": "GAD",
        "svolOperationMode": "SSWS"
      }
    }

    Attribute

    Type

    Description

    replicationType

    string

    (Required) Specify the pair type.

    GAD: global-active device

    svolOperationMode

    string

    (Optional) Specify the volume that continues I/O after pairs are suspended. Specify the following value.

    • SSWS: The S-VOL continues I/O.

      Specify the S-VOL to suspend a pair.

    If this attribute is omitted, the P-VOL continues I/O. In this case, specify the P-VOL to suspend a pair.

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 copy group of the suspended global-active device pairs

Action template

GET base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/split

This action template returns only the specifiable attributes, depending on the following: the type of the pairs of the copy group specified for the object ID, and whether the volume in the local storage system is the primary volume or the secondary volume.

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

This object indicates that operations on the pairs of the specified copy group cannot be performed.

Coding example

To get an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/actions/split

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/split

To run the request after getting an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/actions/split/invoke

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/split/invoke

Suspending a global-active device pair

The following request suspends the specified global-active device pair. You can specify the primary volume to suspend a pair. Alternatively, you can specify the secondary volume to suspend a pair. Also, when suspending a pair, do not simultaneously perform other operations on the copy group or the pairs in that copy group on which a pair suspending operation is performed.
TipWe recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
Execution permission

Storage Administrator (Remote Copy)

Request line
POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/split/invoke
Request message
  • Object ID

    Specify the value of remoteMirrorCopyPairId that was obtained by the processing to get information about the remote copy pair. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    copyGroupName

    string

    (Required) Copy group name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Copy pair name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    The following coding example is for simply suspending pairs. After pairs are suspended, I/O is continued on the P-VOL.

    {
      "parameters": {
        "replicationType": "GAD"
      }
    }

    The following coding example is for suspending pairs by specifying the S-VOL. After pairs are suspended, I/O is continued on the S-VOL.

    {
      "parameters": {
        "replicationType": "GAD",
        "svolOperationMode": "SSWS"
      }
    }

    Attribute

    Type

    Description

    replicationType

    string

    (Required) Specify the pair type.

    GAD: global-active device

    svolOperationMode

    string

    (Optional) Specify the volume that continues I/O after pairs are suspended. Specify the following value.

    • SSWS: The S-VOL continues I/O.

      Specify the S-VOL to suspend a pair.

    If this attribute is omitted, the P-VOL continues I/O. In this case, specify the P-VOL to suspend a pair.

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 suspended global-active device pair

Action template

GET base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/split

This action template returns only the specifiable attributes, depending on the following: the type of the copy pair specified for the object ID, and whether the volume in the local storage system is the primary volume or the secondary volume.

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

This object indicates that operations on the specified pair cannot be performed.

Coding example

To get an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1/actions/split

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_,pair1/actions/split

To run the request after getting an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1/actions/split/invoke

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_,pair1/actions/split/invoke

Resynchronizing global-active device pairs in units of copy groups

The following request resynchronizes global-active device pairs by using the specified copy groups. You can specify a copy group on the primary volume side to resynchronize pairs. Alternatively, you can specify a copy group on the secondary volume side to resynchronize pairs. If a copy group includes the primary volume and the secondary volume, you cannot specify the copy group to resynchronize pairs. Also, when resynchronizing pairs by copy group, do not simultaneously perform other operations on the copy group or the pairs in that copy group on which a pair resynchronization operation is performed.
TipWe recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
Note

If the model of either or both of the storage systems is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, to register pairs in a consistency group when performing a pair resynchronization operation, the number of pairs in the target copy group must be 1,000 or less. If the number of pairs exceeds 1,000, delete all pairs in the copy group, and then register pairs in a consistency group when you re-create the pairs. Alternatively, delete some pairs so that the number of pairs decreases to 1,000 or less, perform a pair resynchronization operation, and then register the pairs in a consistency group when you re-create the pairs that you deleted.

Execution permission

Storage Administrator (Remote Copy)

Request line
POST base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/resync/invoke
Request message
  • Object ID

    Specify the value of remoteMirrorCopyGroupId that was obtained by the processing to get information about the remote copy group. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    copyGroupName

    string

    (Required) Copy group name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    The following is a coding example for simply resynchronizing pairs:

    {
      "parameters": {
        "replicationType": "GAD"
      }
    }

    The following is a coding example for reversing and resynchronizing pairs by specifying the S-VOL:

    {
      "parameters": {
        "replicationType": "GAD",
        "doSwapSvol": true
      }
    }

    Attribute

    Type

    Description

    replicationType

    string

    (Required) Specify the pair type.

    GAD: global-active device

    doSwapSvol

    boolean

    (Optional) Specify the copy group to be used for a pair resynchronization operation. Use this attribute when the S-VOL side is used as the local storage system.

    • true: Resynchronize pairs by specifying the copy group on the S-VOL side (swap resync).

      You can use this value if the pairs in the specified copy group on the S-VOL side are suspended. Reverse the P-VOL and the S-VOL, and then copy data of the new P-VOL to the new S-VOL.

    • false: Resynchronize pairs by specifying the copy group on the P-VOL side.

    If the value is not specified, false will be set.

    If this attribute is set to true, you cannot specify true for the doSwapPvol and isConsistencyGroup attributes.

    doSwapPvol

    boolean

    (Optional) Specify the copy group to be used for a pair resynchronization operation. Use this attribute when the P-VOL side is used as the local storage system.

    • true: Resynchronize pairs by specifying the copy group on the P-VOL side (swap resync).

      You can use this value if the pairs in the specified copy group on the P-VOL side are suspended. Reverse the P-VOL and the S-VOL, and then copy data of the new P-VOL to the new S-VOL.

    • false: Resynchronize pairs by specifying the copy group on the P-VOL side.

    If the value is not specified, false will be set.

    If this attribute is set to true, you cannot specify true for the doSwapSvol and isConsistencyGroup attributes.

    isConsistencyGroup

    boolean

    (Optional) If the pair is not registered in a consistency group, you can specify the value as follows:

    • true: Registers the copy group in a consistency group.#
    • false: Leaves the copy group as it is without registering it in a consistency group.

    If the pair is already registered in a consistency group, you do not need to specify this attribute to maintain the registered state, regardless of the value specified for this attribute. Note that, if false is specified, registration of the consistency group cannot be canceled.

    To register the copy group in a consistency group, you must also specify the consistencyGroupId attribute.

    Make sure that each copy group contains either only pairs that are registered to a consistency group or only pairs that are not registered to a consistency group. If a copy group includes both pairs that are registered in a consistency group and pairs that are not registered in a consistency group, pair operations by consistency group cannot be correctly performed.

    If you specify true for this attribute, you cannot specify the doSwapSvol and doSwapPvol attributes.

    consistencyGroupId

    int

    (Optional) Specify the consistency group ID by using a decimal (base 10) number.

    Be sure to specify this attribute when registering the copy group in a consistency group.

    fenceLevel

    string

    (Optional) Specify NEVER for the fence level.

    If you specify true for the isConsistencyGroup attribute, NEVER is automatically set.

    copyPace

    int

    (Optional) Copy speed

    Specify a decimal (base 10) number in the range from 1 to 15 for the size of tracks to be copied. The larger the value you specify, the faster the copy speed.

    #: If the model of either or both of the storage systems is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, this value can be specified only if the number of pairs in the copy group is 1,000 or less.

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 copy group of the resynchronized global-active device pairs

Action template
GET base-URL/v1/objects/remote-mirror-copygroups/object-ID/actions/resync

This action template returns only the specifiable attributes, depending on the following: the type of the pairs of the copy group specified for the object ID, and whether the volume in the local storage system is the primary volume or the secondary volume.

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 description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

This object indicates that operations on the specified pair cannot be performed.

Coding example

To get an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/actions/resync

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/resync

To run the request after getting an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_/actions/resync/invoke

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copygroups/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_/actions/resync/invoke

Resynchronizing a global-active device pair

The following request resynchronizes the specified global-active device pair. You can specify the primary volume to resynchronize pairs. Alternatively, you can specify the secondary volume to resynchronize pairs. Also, when resynchronizing pairs, do not simultaneously perform other operations on the copy group or pairs on which a pair resynchronization operation is performed.
TipWe recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the flow of operations for the pairs.
Note

If the model of either or both of the storage systems is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, to register pairs in a consistency group when performing a pair resynchronization operation, the number of pairs in the target copy group must be 1,000 or less. If the number of pairs exceeds 1,000, delete all pairs in the copy group, and then register pairs in a consistency group when you re-create the pairs. Alternatively, delete some pairs so that the number of pairs decreases to 1,000 or less, perform a pair resynchronization operation, and then register the pairs in a consistency group when you re-create the pairs that you deleted.

Execution permission

Storage Administrator (Remote Copy)

Request line
POST base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync/invoke
Request message
  • Object ID

    Specify the value of remoteMirrorCopyPairId that was obtained by the processing to get information about the remote copy pair. You can also specify the attributes and connect them with commas as follows:

    remoteStorageDeviceId,copyGroupName,localDeviceGroupName,remoteDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    remoteStorageDeviceId

    string

    (Required) Storage device ID of the remote storage system

    copyGroupName

    string

    (Required) Copy group name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    localDeviceGroupName

    string

    (Required) Device group name in the local storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    remoteDeviceGroupName

    string

    (Required) Device group name in the remote storage system

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Copy pair name

    Specify a name consisting of 1 to 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    The following is a coding example for simply resynchronizing pairs:

    {
      "parameters": {
        "replicationType": "GAD"
      }
    }

    The following is a coding example for reversing and resynchronizing pairs by specifying the P-VOL:

    {
      "parameters": {
        "replicationType": "GAD",
        "doSwapPvol": true
      }
    }

    Attribute

    Type

    Description

    replicationType

    string

    (Required) Specify the pair type.

    GAD: global-active device

    doSwapSvol

    boolean

    (Optional) Specify the volume to be specified for a pair resynchronization operation. Use this attribute when the S-VOL side is used as the local storage system.

    • true: Resynchronize pairs by specifying the S-VOL (swap resync).

      You can use this value if the pairs in the specified S-VOL are suspended. Reverse the P-VOL and the S-VOL, and then copy data of the new P-VOL to the new S-VOL.

    • false: Resynchronize pairs by specifying the P-VOL.

    If the value is not specified, false will be set.

    If this attribute is set to true, you cannot specify true for the doSwapPvol and isConsistencyGroup attributes.

    doSwapPvol

    boolean

    (Optional) Specify the volume to be specified for a pair resynchronization operation. Use this attribute when the P-VOL side is used as the local storage system.

    • true: Resynchronize pairs by specifying the P-VOL (swap resync).

      You can use this value if the pairs in the specified P-VOL are suspended. Reverse the P-VOL and the S-VOL, and then copy data of the new P-VOL to the new S-VOL.

    • false: Resynchronize pairs by specifying the P-VOL.

    If the value is not specified, false will be set.

    If this attribute is set to true, you cannot specify true for the doSwapSvol and isConsistencyGroup attributes.

    isConsistencyGroup

    boolean

    (Optional) If the pair is not registered in a consistency group, you can specify the value as follows:

    • true: Registers the pair in a consistency group. #
    • false: Leaves the pair as it is without registering it in a consistency group.

    If the pair is already registered in a consistency group, you do not need to specify this attribute to maintain the registered state, regardless of the value specified for this attribute. Note that, if false is specified, registration of the consistency group cannot be canceled.

    To register the pair in a consistency group, you must also specify the consistencyGroupId attribute.

    Make sure that each copy group contains either only pairs that are registered to a consistency group or only pairs that are not registered to a consistency group. If a copy group includes both pairs that are registered in a consistency group and pairs that are not registered in a consistency group, pair operations by consistency group cannot be correctly performed.

    If you specify true for this attribute, you cannot specify the doSwapSvol and doSwapPvol attributes.

    consistencyGroupId

    int

    (Optional) Specify the consistency group ID by using a decimal (base 10) number.

    Be sure to specify this attribute when registering the pair in a consistency group.

    Unify the consistency group ID within the copy group. If a copy group includes a pair whose consistency group ID differs, pair operations by consistency group cannot be correctly performed.

    fenceLevel

    string

    (Optional) Specify NEVER for the fence level.

    If you specify true for the isConsistencyGroup attribute, NEVER is automatically set.

    copyPace

    int

    (Optional) Copy speed

    Specify a decimal (base 10) number in the range from 1 to 15 for the size of tracks to be copied. The larger the value you specify, the faster the copy speed.

    #: If the model of either or both of the storage systems is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, this value can be specified only if the number of pairs in the copy group is 1,000 or less.

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 resynchronized global-active device pairs

Action template
GET base-URL/v1/objects/remote-mirror-copypairs/object-ID/actions/resync

This action template returns only the specifiable attributes, depending on the following: the type of the copy pair specified for the object ID, and whether the volume in the local storage system is the primary volume or the secondary volume.

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 description on HTTP status codes.

Status code

Message

Description

412

Precondition Failed

This object indicates that operations on the specified pair cannot be performed.

Coding example

To get an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1/actions/resync

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_,pair1/actions/resync

To run the request after getting an action template:

When the storage system of the P-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123789,remoteCopyGroup,remoteCopyGroupP_,remoteCopyGroupS_,pair1/actions/resync/invoke

When the storage system of the S-VOL is specified:

curl -v -H "Accept: application/json" -H "Remote-Authorization:Session 10399a1ffce3489b9c3a823017462396" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/remote-mirror-copypairs/886000123456,remoteCopyGroup,remoteCopyGroupS_,remoteCopyGroupP_,pair1/actions/resync/invoke