Skip to main content

We've Moved!

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

Performing Volume Migration operations

You can perform Volume Migraion operations. Volume Migration is used to move data on a volume to another volume within the storage system (including a volume on an external storage system). Moving data to another volume is called migration.

Overview of Volume Migration

Volume Migration is used to move data on a volume to another volume within the storage system (including a volume on an external storage system). Moving data to another volume is called migration.

Use Volume Migration to perform migration in situations such as the following:

  • When you want to migrate data from the old storage system when a new storage system is installed
  • When you want to migrate data with a low frequency of I/O operations to an external storage system
  • When you want to relocate data with a high frequency of I/O operations to a volume on a drive with a low usage rate or to a volume on a drive with high performance

The host can access data during migration. When migration is complete, the LDEV ID and the host I/O of the migration source volume are automatically swapped with those of the migration target volume. For this reason, the host can continue to access data after the migration by using the same path settings.

The following figures show the flow of data when migration is performed by using Volume Migration.

  • Before migration

    I/O from the host is directed to the migration source volume. From the source volume and the target volume (the volume that was created for the purpose of migration), create a pair to be used for Volume Migration.

    GUID-07D39DE7-DC42-4F46-A9DB-1564BA4D1597-low.gif
  • During migration

    When migration is performed, data is copied from the source volume to the target volume. During migration, the host can read and write data online. If a write I/O operation from the host is performed while the data is being copied, only the differential data is copied to the target volume. Copy operations continue to be performed until all differential data has been copied.

    GUID-720A544E-0FB8-4B98-BF06-B93F3DAB0D44-low.gif
    Note

    There is an upper limit to the number of copy operations that can be performed, and the upper limit varies depending on the capacity of the source volume. If differential data still exists after the upper limit for the number of copy operations is exceeded, migration will fail. In this case, reduce the load from the host, and then perform migration again. Use a value of 50 IOPS or less as a reference value for the update I/O operations from the host.

  • When migration is complete

    After the data is copied and the data on the source volume and the data on the target volume are fully synchronized, the LDEV ID and the host I/O of the source volume are swapped with those of the target volume. From the host, the volume and the path settings are the same as before the migration. The actual data, however, has been migrated to the volume that was prepared for migration.

    GUID-FBAA79F4-E4E1-4492-A7A7-CE4D6879BF85-low.gif

Workflow for performing Volume Migration

The following explains how to perform migrations by using Volume Migration, which is executed by the REST API.
Preparing for migration

Before starting migration, prepare a volume as the migration destination (target volume). You must set an LU path for the target volume.

The following figure shows the workflow.

GUID-A19C1C72-70D7-49BF-A8C6-A17BD96BD33D-low.gif
  • Creating volumes (target volumes)

    Create target volumes to which data is to be migrated.

  • Creating a host group

    Create a host group so that LU paths can be set for the target volumes. The host group does not need to be allocated to the host. You can use an existing host group, but it must not include the volumes to be migrated (source volumes).

  • Setting LU paths

    Specify the host group that you created for the target volumes, and then set LU paths.

Migrating data

Create Volume Migration pairs by specifying the source volumes as the P-VOLs and the target volumes as the S-VOLs, and then copy the data. You can perform operations on copy pairs in units of copy groups. A copy group is a group made up of copy pairs. Each copy group consists of a device group that is made up of P-VOLs and a device group made up of S-VOLs.

The following figure shows the workflow.

GUID-FF5F7C88-8384-4781-A1E3-7F16DE591202-low.gif
  • Creating pairs (Volume Migration)

    Use the source volumes and the target volumes to create Volume Migration pairs. When a Volume Migration pair is created, the pair status is SMPL. Data is not copied until migration is performed.

  • Migrating data

    Copy data from the source volumes to the target volumes in units of pairs or copy groups. When data copying is complete, the LDEV IDs and the path settings of the source volumes and the target volumes are switched, and the I/O from the host switches to the target volumes.

  • Deleting pairs (Volume Migration)

    After the migration job is complete, if migration was successful, delete the pairs for migration.

  • Canceling migration

    Cancel migration to stop the migration processing or if a migration job fails. When the migration of a pair is canceled, the pair status changes to SMPL, and you can then perform migration again.

Performing post-migration tasks

Delete the volumes and the host group that were created for migration.

The following figure shows the workflow.

GUID-46A5B202-2E03-4928-A297-FBCB4A67A412-low.gif
  • Deleting LU paths

    Delete the LU paths that were set for the source volumes. Note that the path settings of source volumes and target volumes are switched when migration finishes. For this reason, be sure to delete the paths set for the host group that was created for volume migration (the host group that is not allocated to the host).

  • Deleting volumes (source volumes)

    Delete the source volumes. Note that the LDEV IDs are switched when migration finishes. For this reason, when specifying the LDEV IDs of the volumes to be deleted, be sure to specify the LDEV IDs of the volumes that were created as the target volumes (volumes that do not receive I/O from the host).

  • Deleting the host group

    If the host group to which the source volumes belong is no longer necessary, delete the host group.

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

With respect to operations to perform or cancel migration, data copying might take a long time. As a result, the job status might not change to Completed and other jobs might become delayed if you execute multiple asynchronous processes at the same 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. In other words, data copying will continue even after the job execution ends. To check whether data copying has finished, check the status of the applicable pair, instead of checking the job status. For details about pair statuses, see the description of pair status transitions.

Pair status transitions (Volume Migration)

The following figure shows how pair statuses transition when certain pair operations are performed.
GUID-47450325-27DE-4ABC-BFE9-00E7CDEFA74D-low.gif

Pair status

Copy mode

Description

Access to the P-VOL

Access to the S-VOL

SMPL

NotSynchronized

Volume Migration can be performed.

R/W enabled

R/W enabled

COPY

VolumeMigration

The pair status is being migrated.

R/W enabled

-

PSUS

VolumeMigration

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

R/W enabled

R/W enabled

SSUS

VolumeMigration

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

R/W enabled

R/W enabled

PSUE

VolumeMigration

Migration was interrupted, or migration failed.

R/W enabled

R enabled

Creating a pair to be used for Volume Migration

To perform migration by using the REST API, create a pair of volumes from the source volume (P-VOL) and the target volume (S-VOL). When the pair is created, the status of the pair is SMPL.
Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Local Copy)

Request line
POST base-URL/v1/objects/local-clone-copypairs
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    {
      "copyGroupName": "vm-cg",
      "pvolDeviceGroupName": "dgp",
      "svolDeviceGroupName": "dgs",
      "copyPairName": "pair",
      "svolLdevId": 40970,
      "pvolLdevId": 40960,
      "replicationType": "SI",
      "copyMode": "NotSynchronized",
      "isNewGroupCreation": true
    }

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 29 characters. The name is case sensitive.

    isNewGroupCreation

    boolean

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

    Make sure that the Volume Migration pair is not added to a copy group that includes ShadowImage pairs.

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

    copyPairName

    string

    (Required) Specify the pair name. Value should not exceed 31 characters. The name is case sensitive.

    copyMode

    string

    (Required) Copy mode

    Specify NotSynchronized.

    replicationType

    string

    (Required) Specify SI.

    pvolLdevId

    int

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

    svolLdevId

    int

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

    pvolDeviceGroupName

    string

    (Optional) Specify the device group name for the P-VOL. Value should not exceed 31 characters. The name is case sensitive.

    Specify a device group name that differs from the device group name for the S-VOL. In addition, to add a pair to an existing copy group, specify the device group name for an existing P-VOL.

    If this value is omitted, copyGroupNameP_ is assumed.

    svolDeviceGroupName

    string

    (Optional) Specify the device group name for the S-VOL. Value should not exceed 31 characters. The name is case sensitive.

    Specify a device group name that differs from the device group name for the P-VOL. To add a pair to an existing copy group, specify the device group name for an existing S-VOL.

    If this value is omitted, copyGroupNameS_ is assumed.

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 created 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 "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs

Performing migration for an entire copy group

The following request performs migration to copy the data in the source volume (P-VOL) to the target volume (S-VOL) for the entire specified copy group. When the copy operation is complete, the host switches from accessing the target volume to accessing the source volume.
Note

After copying the data by successfully executing the API request for performing migration, execute the API request for deleting a pair to change the pair status of the source volume and the target volume to SMPL.

TipWe recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the workflow for performing Volume Migration.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/local-clone-copygroups/object-ID/actions/migrate/invoke
Request message
  • Object ID

    Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    A job object is returned. See the description for the job object. affectedResources is not displayed for this API. To check whether the migration was successful, execute the API request for obtaining information about a copy group. The possible pair statuses are as follows:

    • If the migration was successful: PSUS
    • If the migration failed: PSUE
Action template

None.

Status codes

For details on the status codes of the API, see the description on HTTP status codes.

Coding example
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST -d "" https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/vm-cg,dgp,dgs/actions/migrate/invoke

Performing migration

The following request performs migration to copy the data of the source volume (P-VOL) to the target volume (S-VOL). When the copy operation is complete, the host switches from accessing the target volume to accessing the source volume.
Note

After copying the data by successfully executing the API request for performing migration, execute the API request for deleting a pair to change the pair status of the source volume and the target volume to SMPL.

TipWe recommend specifying Job-Mode-Wait-Configuration-Change:NoWait in the request header of this API function. For details, see the description of the workflow for performing Volume Migration.
Execution permission

Storage Administrator (Provisioning)

Request line
POST base-URL/v1/objects/local-clone-copypairs/object-ID/actions/migrate/invoke
Request message
  • Object ID

    Specify the localCloneCopypairId value obtained by getting the pair information. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Specify the name of the pair. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    A job object is returned. See the description for the job object. affectedResources is not displayed for this API. To check whether the migration was successful, execute the API request for obtaining information about a pair. The possible pair statuses are as follows:

    • If the migration was successful: PSUS
    • If the migration failed: PSUE
Action template

None.

Status codes

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

Coding example
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST -d "" https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/vm-cg,dgp,dgs,p1/actions/migrate/invoke

Getting a list of copy groups (Volume Migration)

The following request gets information about the copy groups containing pairs in the storage system.
Important

If the copy group name or device group name contains spaces, the copy group information cannot be obtained.

Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/local-clone-copygroups
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of detailed information to be obtained

    • pair

      Specify this parameter to get detailed information about the pairs in each copy group in addition to a list of copy groups.

      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".

  • Body

    None.

Response message
  • Body

    {
      "data": [
        {
          "copyGroupName": "localCopyGroup1",
          "pvolDeviceGroupName": "localCopyGroup1P_",
          "svolDeviceGroupName": "localCopyGroup1S_",
          "localCloneCopygroupId": "localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_"
        },
        {
          "copyGroupName": "localCopyGroup2",
          "pvolDeviceGroupName": "localCopyGrouppvol",
          "svolDeviceGroupName": "localCopyGroupsvol",
          "localCloneCopygroupId": "localCopyGroup2,localCopyGrouppvol,localCopyGroupsvol"
        }
      ]
    }
    

    Attribute

    Type

    Description

    copyGroupName

    string

    Copy group name

    pvolDeviceGroupName

    string

    Device group name for the P-VOL (source volume)

    svolDeviceGroupName

    string

    Device group name for the S-VOL (target volume)

    localCloneCopygroupId

    string

    Object ID of the copy group that contains a pair

    The following attributes are output, separated by commas:

    • copyGroupName
    • pvolDeviceGroupName
    • svolDeviceGroupName

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

    Attribute

    Type

    Description

    copyPairs

    object[]

    The following attributes about the pairs included in the copy group:

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

    • copyGroupName (string)

      Copy group name

    • copyPairName (string)

      Pair name

    • replicationType (string)

      Pair type

      Outputs SI .

    • copyMode (string)

      Copy mode

      • NotSynchronized: Pairs created for the purpose of performing migration
      • VolumeMigration: Pairs for which migration is in progress or for which migration is complete

      Other values are displayed for pairs that do not meet either of the preceding conditions.

    • pvolLdevId (int)

      LDEV number of the P-VOL

    • svolLdevId (int)

      LDEV number of the S-VOL

    • pvolStatus (string)

      Pair volume status of the P-VOL

      For details, see the section describing the pair status (Volume Migration).

      This attribute is not output if no information can be obtained.

    • svolStatus (string)

      Pair volume status of the S-VOL

      For details, see the section describing the pair status (Volume Migration).

      This attribute is not output if no information can be obtained.

    • localCloneCopypairId (string)

      Object ID of the pair

    • pvolMuNumber (int)

      MU number of the P-VOL

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 "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups

Getting information about a specific copy group (Volume Migration)

The following request acquires information about the specified copy group and about the pairs within that copy group that are to be used for Volume Migration. This operation allows you to check the status of the pairs and to acquire their pair configuration information.
Important
  • If the target copy group contains a pair that was created or deleted by using another REST API server or software other than the REST API, correct information about that pair might not be obtained. To obtain the most recent information about such pairs, use the API for obtaining a list of pairs.
  • If the copy group name, device group name, or copy pair name contains spaces, the information cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/local-clone-copygroups/object-ID
Request message
  • Object ID

    Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specifies the device group name for the P-VOL (source volume). Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specifies the device group name for the S-VOL (target volume). Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "localCloneCopygroupId" : "vm-cg,dgp,dgs",
      "copyGroupName" : "vm-cg",
      "pvolDeviceGroupName" : "dgp",
      "svolDeviceGroupName" : "dgs",
      "copyPairs" : [ {
        "localCloneCopypairId" : "vm-cg,dgp,dgs,p0",
        "copyGroupName" : "vm-cg",
        "copyPairName" : "p0",
        "replicationType" : "SI",
        "copyMode" : "NotSynchronized",
        "pvolLdevId" : 40970,
        "pvolStatus" : "SMPL",
        "svolLdevId" : 40960,
        "svolStatus" : "SMPL",
        "pvolMuNumber" : 0,
        "pvolProcessingStatus": "N",
        "svolProcessingStatus": "N"
      }, {
        "localCloneCopypairId" : "vm-cg,dgp,dgs,p1",
        "copyGroupName" : "vm-cg",
        "copyPairName" : "p1",
        "replicationType" : "SI",
        "copyMode" : "NotSynchronized",
        "pvolLdevId" : 40971,
        "pvolStatus" : "SMPL",
        "svolLdevId" : 40961,
        "svolStatus" : "SMPL",
        "pvolMuNumber" : 0,
        "pvolProcessingStatus": "N",
        "svolProcessingStatus": "N"
      } ]
    }

    Attribute

    Type

    Description

    copyGroupName

    string

    Copy group name

    pvolDeviceGroupName

    string

    Device group name for the P-VOL

    svolDeviceGroupName

    string

    Device group name for the S-VOL

    localCloneCopygroupId

    string

    Object ID of the copy group that contains a pair

    The following attributes are output, separated by commas:

    • copyGroupName
    • pvolDeviceGroupName
    • svolDeviceGroupName

    copyPairs

    object[]

    The following attributes about the pairs included in the copy group:

    • copyGroupName (string)

      Copy group name

    • copyPairName (string)

      Pair name

    • replicationType (string)

      Pair type

      Outputs SI .

    • copyMode (string)

      Copy mode

      • NotSynchronized: Pairs created for the purpose of performing migration
      • VolumeMigration: Pairs for which migration is in progress or for which migration is complete

      Other values are displayed for pairs that do not meet either of the preceding conditions.

    • copyProgressRate (int)

      Copy progress rate (%)

      This attribute is not output if no information can be obtained.

    • pvolLdevId (int)

      LDEV number of the P-VOL

    • svolLdevId (int)

      LDEV number of the S-VOL

    • pvolStatus (string)

      Pair volume status of the P-VOL

      For details, see the section describing the pair status (Volume Migration).

      This attribute is not output if no information can be obtained.

    • svolStatus (string)

      Pair volume status of the S-VOL

      For details, see the section describing the pair status (Volume Migration).

      This attribute is not output if no information can be obtained.

    • localCloneCopypairId (string)

      Object ID of the pair

    • pvolMuNumber (int)

      MU number of the P-VOL

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

404

Not Found

No copy group can be obtained, or no pair was included in the copy group that was obtained.

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/local-clone-copypairs?localCloneCopyGroupId=vm-cg,dgp,dgs

Getting a list of pairs (Volume Migration)

The following request obtains information about the pairs in a copy group specified by using query parameters. You can also update the pair information when you obtain information about pairs.
Important
  • If the target copy group contains a pair that was created or deleted by using another REST API server or software other than the REST API, information about that pair might not be obtained. To obtain the most recent information about such pairs, run the API with refresh=true specified for the query parameter. Note that such processing takes time because the information about the pairs in the specified copy group is updated, and then information is obtained.
  • If the copy group name, device group name, or copy pair name contains spaces, the information cannot be obtained.
Execution permission

Storage Administrator (View Only)

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

    None.

  • Query parameters

    Parameter

    Type

    Filter condition

    localCloneCopyGroupId

    string

    (Required) Object ID of the copy group that contains a pair

    Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes, separated by a comma:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName
    • copyGroupName (string)

      Copy group name

      Value should not exceed 31 characters.

    • pvolDeviceGroupName (string)

      Device group name for the P-VOL (source volume)

      Value should not exceed 31 characters.

    • svolDeviceGroupName (string)

      Device group name for the S-VOL (target volume)

      Value should not exceed 31 characters.

    refresh

    boolean

    (Optional) Whether to update the pair information to the most recent:

    • true: Pair information will be updated.
    • false: Pair information will not be updated.

    If you specify true, processing takes time because the information about the pairs in the specified copy group is updated and then information is obtained. If this parameter is omitted, false is assumed.

  • Body

    None.

Response message
  • Body

    Information about the pairs in the specified copy group is obtained in a list. For details about the response body, see the section describing the API for obtaining information about a specific 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 "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs?localCloneCopyGroupId=localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_&refresh=true"

Getting information about a specific pair (Volume Migration)

The following request gets information about specific pairs to be used for Volume Migration. This operation allows you to obtain information about the status and the configuration information of the pairs.
Important
  • If the target pair was created or deleted by using another REST API server or software other than the REST API, correct information about that pair might not be obtained. To obtain the most recent information about the pairs, use the API for obtaining a list of pairs.
  • If the copy group name, device group name, or pair name contains spaces, information cannot be obtained.
Execution permission

Storage Administrator (View Only)

Request line
GET base-URL/v1/objects/local-clone-copypairs/object-ID
Request message
  • Object ID

    Specify the localCloneCopypairId value obtained by getting the pair information. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Specify the name of the pair. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    {
      "localCloneCopypairId" : "vm-cg,dgp,dgs,p1",
      "copyGroupName" : "vm-cg",
      "copyPairName" : "p1",
      "replicationType" : "SI",
      "copyMode" : "NotSynchronized",
      "pvolLdevId" : 40971,
      "pvolStatus" : "SMPL",
      "svolLdevId" : 40961,
      "svolStatus" : "SMPL",
      "pvolMuNumber" : 0,
      "pvolProcessingStatus": "N",
      "svolProcessingStatus": "N"
    }

    Attribute

    Type

    Description

    copyGroupName

    string

    Copy group name

    copyPairName

    string

    Pair name

    replicationType

    string

    Pair type

    Outputs SI

    copyMode

    string

    Copy mode

    • NotSynchronized: Pairs created to be used for migration
    • VolumeMigration: Pairs for which migration is being performed or complete

    Other values are displayed for pairs other than the above.

    copyProgressRate

    int

    Copy progress rate (%)

    This attribute is not output if no information can be obtained.

    pvolLdevId

    int

    LDEV number of the P-VOL

    svolLdevId

    int

    LDEV number of the S-VOL

    pvolStatus

    string

    Pair volume status of the P-VOL

    For details, see the section describing the pair status (Volume Migration).

    This attribute is not output if no information can be obtained.

    svolStatus

    string

    Pair volume status of the S-VOL

    For details, see the section describing the pair status (Volume Migration).

    This attribute is not output if no information can be obtained.

    localCloneCopypairId

    string

    Object ID of the pair

    pvolMuNumber

    int

    MU number of the P-VOL

    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
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 "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/vm-cg,dgp,dgs,p1

Deleting a pair (Volume Migration)

The following request deletes the specified pair. If there is no pair in the copy group, the copy group and the device group that make up the copy group are also deleted.
Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Local Copy)

Request line
DELETE base-URL/v1/objects/local-clone-copypairs/object-ID
Request message
  • Object ID

    Specify the localCloneCopypairId value obtained by getting the pair information. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Specify the name of the pair. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    None.

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 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 "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_,pair1

Deleting a copy group (Volume Migration)

The following request deletes pairs by using the specified copy group. When the pairs are all deleted, the device groups are also deleted.
Execution permission

Storage Administrator (Provisioning) and Storage Administrator (Local Copy)

Request line
DELETE base-URL/v1/objects/local-clone-copygroups/object-ID
Request message
  • Object ID

    Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    None.

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 copy group

Coding example
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/localCopyGroup1,localCopyGroup1P_,localCopyGroup1S_
When forcibly deleting a copy group

When a copy group cannot be deleted because the device group in a local storage system remains or because the configuration is not normal, you can forcibly delete the copy group by specifying the forceDelete attribute for the request body. The following shows a coding example of using the forceDelete attribute:

{
  "forceDelete" : true
}

Attribute

Type

Description

forceDelete

boolean

(Optional) Specify whether to delete the copy group forcibly.

  • true: Forcibly delete the copy group.
  • false: Do not forcibly delete the copy group.

When the attribute is omitted, false is assumed.

Canceling migration for an entire copy group

The following request cancels migration of the pairs in a specified copy group. You can use this request if you want to cancel a migration that is in progress, or if an attempted migration fails. If migration is canceled, the status of the pairs included in the target copy group reverts to SMPL.
Execution permission

Storage Administrator (Local Copy)

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

    Specify the localCloneCopygroupId value obtained by getting the list of copy groups. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    {
      "parameters":{
        "forceSplit": true
      }
    }

    Attribute

    Type

    Description

    forceSplit

    boolean

    (Optional) Specify whether to cancel migration.

    • true: Cancel migration.
    • false: Do not cancel migration.

    If this attribute is omitted, false is assumed.

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 for which migration was canceled

Status codes

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

Coding example
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copygroups/vm-cg,dgp,dgs/actions/split/invoke

Canceling migration

The following request cancels migration of the specified pair. You can use this request if you want to cancel a migration that is in progress, or if an attempted migration fails. If migration is canceled, the status of the pair reverts to SMPL.
Execution permission

Storage Administrator (Local Copy)

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

    Specify the localCloneCopypairId value obtained by getting the pair information. You can also specify the following attributes and connect them with commas:

    copyGroupName,pvolDeviceGroupName,svolDeviceGroupName,copyPairName

    Attribute

    Type

    Description

    copyGroupName

    string

    (Required) Specify the copy group name. Value should not exceed 31 characters. The name is case sensitive.

    pvolDeviceGroupName

    string

    (Required) Specify the P-VOL (source volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    svolDeviceGroupName

    string

    (Required) Specify the S-VOL (target volume) device group name. Value should not exceed 31 characters. The name is case sensitive.

    copyPairName

    string

    (Required) Specify the name of the pair. Value should not exceed 31 characters. The name is case sensitive.

  • Query parameters

    None.

  • Body

    {
      "parameters":{
        "forceSplit": true
      }
    }

    Attribute

    Type

    Description

    forceSplit

    boolean

    (Optional) Specify whether to cancel migration.
    • true: Cancel migration.
    • false: Do not cancel migration.

    If this attribute is omitted, false is assumed.

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 pair for which migration was canceled

Status codes

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

Coding example
curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/local-clone-copypairs/vm-cg,dgp,dgs,p1/actions/split/invoke