Creating a snapshot, restoring a snapshot, and cloning a volume in Power® Virtual Server

IBM Power Virtual Server in IBM data center

IBM Power Virtual Server Private Cloud in Client location

You can capture full, point-in-time copies of the logical volumes or data sets by using IBM® Power® Virtual Server. You can create delta snapshots, volumes-clones, and restore your disks by using FlashCopy feature by IBM, Power® Virtual Server APIs.

Creating a snapshot

With snapshots, you can create a relationship between your source disks and a target disk at a defined time, for example T1. Target disks are created as part of creating a snapshot operation. The snapshot operation tracks the changes that are made to the source disk after T1 time. Thus, you can restore the source disks to their T1 state at a later time.

You can create and manage snapshots in your Power Virtual Server workspace by using the GUI, API, or CLI. Snapshot names must be unique for your workspace.

Creating a snapshot: A use case

You can create a snapshot for different scenarios. Consider the following use case:

An administrator plans to upgrade the middleware. If the upgrade fails, the administrator must restore the source disk to its original state. The administrator completes the following steps:

Starts a snapshot of the source disk that contains the middleware by using the GUI, API, or CLI. A snapshot of the source disk is created.
Upgrade the middleware.

If the upgrade fails, the administrator restores the source disk by using the snapshot. If the upgrade succeeds, deletes the snapshot.

You can start multiple snapshot operations. These concurrent snapshot operations occur on different sets of disks.

Prerequisites for creating a snapshot

Before you take a snapshot of a volume, it is recommended that you quiesce all the applications that access the volume. This action is required to ensure that all the data is moved to the disk to prevent loss of data.
If you are creating a snapshot of a volume that is shared among multiple virtual server instances, you must quiesce all the applications on all these virtual server instances. If you are not sure how to quiesce your applications, it is recommended to shut down any virtual server instances that are attached to the volumes included in the snapshot.
To reuse a snapshot name, delete the existing snapshot with that name first.
You can include a volume in the snapshot if the volume belongs to the same storage pool.
You can include a volume in the snapshot if the volume is not in the error state and the health state of the volume is in the ok state.

Creating a snapshot by using the Power Virtual Server user interface

To create a snapshot by using the Power Virtual Server user interface, complete the following steps:

Open the Power Virtual Server user interface in IBM Cloud and log in with your credentials.
Click Workspaces in the navigation panel. The Workspaces page is displayed with a list of existing workspaces.
Select a workspace in which you want to create the snapshot. The Workspace details panel is displayed.
Click View virtual servers. The Virtual server instances page is displayed.
In the navigation panel, click Storage > Instance snapshots. The Instance snapshots page is displayed with a list of any existing snapshots.
Click Create instance snapshot. The Create instance snapshot page is displayed.
In the General section, enter a name for the snapshot in the Name field.
Optional: Enter user tags and description for the snapshot in the User tags (optional) and Description fields.
Click Continue.
In the Volumes section, select the required virtual server instance from the Select virtual server instance list. Any storage volumes that are attached to the selected virtual server instance are displayed.
Select the storage volumes to include in the snapshot and click Finish. The summary of the selected snapshot configuration and its total estimated cost is displayed in the Summary panel.

You can select multiple storage volumes to include in the snapshot. However, all the selected volumes must belong to the same storage pool.
Optional: Click Add to estimate to add the cost information to an existing estimate or to create a new estimate.
Click the terms and conditions link to read the IBM Cloud Terms of Use. To continue, select the I agree to the Terms and conditions checkbox and click Create.

After the snapshot is successfully created, a success message is displayed on the screen.

The snapshot that you created is displayed in the Instance snapshots page with the following details:

Name: Snapshot name.
Volumes: Number of storage volumes that are included in the snapshot.
Description: Snapshot description.
Virtual server instance: Name of the virtual server instance to which the selected storage volumes were attached at the time of the snapshot creation.
Created: Timestamp that indicates when the snapshot was created.
Status and Status details: These two columns display the current status of a snapshot. A snapshot can have one of the following statuses:
- Available: The snapshot was successfully created and is available for restore operations.
- Error: An error has occurred while creating the snapshot. The snapshot cannot be recovered and must be deleted.
- Restoring: A restore operation is in progress.
- Restore error: An error has occurred during the restore process. You can use the Restore option from the overflow menu to retry the restore process. To revert a snapshot with Restore error status to its last working state, you can use the Rollback option from the Actions menu on the snapshot's details page.
- Restore reverted: The restore attempt was reverted. A storage volume that is included in the snapshot might be involved in another snapshot operation. You can retry the restore once the other snapshot operation is complete.
- Rolling back: A rollback operation is in progress. The rollback operation reverts the virtual server instance to its last working state.
- Rollback error: An error has occurred during the rollback process.
Last update: Timestamp that indicates when the snapshot was last updated.

Creating a snapshot by using API or CLI

You can create a snapshot by using the following API and CLI:

API: Create a PVM Instance snapshot
CLI: ibmcloud pi snapshot create

You must provide values for the following parameters in the API and CLI:

name: Required. Specifies the name of the snapshot. The name must be a unique value for each snapshot in the workspace.
description: (Optional) Describes the snapshot.
volumeIDs: (Optional) Includes a list of one or more volumes that you must include in the snapshot. If the parameter is not specified, all the volumes that are attached to the virtual server instance (VSI) are included in the snapshot.

You can use the Get a list of flashcopy mappings of a given volume API to confirm that the operation to create a snapshot of a volume is completed before you retry the resize operation.

Considerations for creating a snapshot

You must consider the following considerations when you create a snapshot to avoid the operation failure:

You must attach all the volumes that are included in the snapshot to the same virtual server instance.
When you create a snapshot by using the API or CLI, the volumeIDs parameter is optional. If the volumeIDs option is not specified, all the volumes that are attached to the virtual server instance are included in the snapshot.
If the volumes that are attached to the virtual server instance are not in the same storage pool, you must create the snapshot for each storage pool. You must add the volume IDs in a storage pool to the volumeIDs option when you create the snapshot for the storage pool.

If the create a snapshot operation fails, the snapshot state is set to the error state on the Instance snapshots page. You can delete the snapshot so that you do not perform any operations on it.

Restrictions for creating a snapshot

You must consider the following restrictions when you create a snapshot to avoid the operation failure:

You cannot create a snapshot of a virtual server instance if its attached volumes are currently undergoing cloning or snapshot operations.
You cannot modify the shareable or bootable properties of any volume that is included in an existing snapshot.
You cannot run a snapshot operation from different virtual server instances at the same time for the same shared volume.
You cannot resize a volume if the volume is included in a virtual server instance snapshot. To resize the volume, you must delete all the snapshots that contains the volume.
You cannot detach the volumes from the virtual server instance if the volumes are included in an instance snapshot. To detach the volumes, you must delete all the snapshots that contains the volumes.

Restoring a snapshot

The restore operation restores the volumes that are included in a virtual server instance snapshot to the source disks. When the restore operation is in progress, Power Virtual Server creates a backup snapshot, which can be used if the restore operation fails. If the restore operation succeeds, the backup snapshots are deleted. If the restore operation fails, the snapshot status is set to restore-error. You can use the restore or rollback operations to restore the snapshot to its original state. Use the restore_fail_action query parameter with the retry value to retry the restore operation. To roll back the snapshot to a previous disk state, use the restore_fail_action query parameter with the rollback value. When the restore operation fails, the virtual server instance enters the Error state. For more information about restore_fail_action query parameter, see Restoring a snapshot by using API or CLI.

Prerequisites for restoring a snapshot

Ensure that you meet the following prerequisites before you start the restore operation:

By default, you must shut down the virtual server instance before you start the restore operation.
To restore the data on a live virtual server instance, use the force restore operations. The following conditions must be met:
- Quiesce the applications.
- Do not run I/O operations on the volume disks.

If you do not meet the conditions for force restore operation, it results in data corruption.

If you are restoring an instance snapshot of a volume that is shared among multiple virtual server instances, you must quiesce all the applications on all the virtual server instances. When the restore operation is in progress ensure that I/O operations are not running on the shared volumes.
If you are not sure how to quiesce your applications, shut down any virtual server instances that are attached to the volumes that you want to include in the snapshot.

Restoring a snapshot by using the Power Virtual Server user interface

To restore a snapshot by using the Power Virtual Server user interface, complete the following steps:

Open the Power Virtual Server user interface in IBM Cloud and log in with your credentials.
Click Workspaces in the navigation panel. The Workspaces page is displayed with a list of existing workspaces.
Select the workspace which contains the snapshot that you want to restore. The Workspace details panel is displayed.
Click View virtual servers. The Virtual server instances page is displayed.
In the navigation panel, click Storage > Instance snapshots. The Instance snapshots page is displayed with a list of the existing snapshots.
From the list of available snapshots, select the snapshot that you want to restore. The snapshot details page is displayed.
Select Restore. The Confirm restore dialog is displayed.

To restore an instance snapshot, you must first shut down all the related virtual server instances, including the source and any shared volumes that are attached to the instance snapshot. If you cannot shut down the virtual server instances, quiesce all the related applications and set Force restore to Enabled.
Click Restore.

When the restore begins, a notification is displayed to indicate that the restore process has started and a progress bar displays the completion percentage. After the snapshot is restored successfully, the Status details column displays the Restore successfully completed status.

A failed restore operation changes the snapshot status to Restore error. You can use the Restore option from the overflow menu to retry the restore process. To revert a snapshot with Restore error status to its last working state, select Rollback from the Actions menu on the snapshot's details page.

Restoring a snapshot by using API or CLI

You can restore a snapshot by using the following API and CLI:

API: Restore a PVM Instance snapshot.
CLI: ibmcloud pi snapshot-restore

You must provide values for the following parameters in the API and CLI:

SNAPSHOT_ID: Required. Specify a unique identifier for the snapshot
force: (Optional) Specify the value of the flag as True or False. By default, the flag is set to False. This flag is set to true only if the virtual server instance is shut down. By default, the virtual server instance must be shut down before you start a snapshot restore operation. When the force flag is set to True, the prerequisite of the virtual server instance being shut down is relaxed.
restore: (Optional) Use the restore_fail_action query parameter only if a previous restore operation results in setting the snapshot to the restore-error status. The restore_fail_action query parameter accepts the following retry or rollback values:
- If the snapshot status is set to retry, then again the failed restore operation is attempted.
- If the snapshot status is set to rollback, then the volumes that were failed to be restored are rolled back to their original state.

If you are using the force option, you must ensure that all the applications that access the volumes in the instance snapshot are quiesced and no I/O operations are running on the volume disk.

Use cases for restoring a snapshot

Consider the following scenarios to restore a snapshot:

Restoring all of the volumes that are included in a virtual server instance snapshot
Running multiple virtual server instance restore operations
Retrying a virtual server instance restore operation if it originally failed
Rolling back a virtual server instance to its original volume state

Considerations for restoring a snapshot

Before the system begins the restore operation of the snapshot, a temporary backup snapshot of the volumes is created for internal use only. If the snapshot restore operation fails, the temporary backup is used by the system to restore the virtual server instance to the state before the restore operation failed.
When restore operation on a virtual server instance snapshot fails, the virtual server instance status changes to restore-Error state. You can retry the restore operation or you can request to roll back the virtual server instance to its original state it was in before the restore operation failed.
If you perform a restore operation on the shared volume, all the virtual machines that are sharing the volume are restored.
After successful restore retry operation, the virtual server instance state might not reset from Error state. Use Reset State feature on the GUI to reset the virtual server instance state.

Restrictions for restoring a snapshot

Volume restore operation is not allowed if any copy operations are running on the target volume. The volumes in the instance snapshot are validated to ensure that no copy operations are running against them. Use the API to get a list of FlashCopy mappings for a volume or the CLI to get a list of FlashCopy mappings for a volume.
When you perform a restore operation, the snapshot task status changes to restoring, the volume status is changed to reverting, and no other snapshot operations are allowed.
If you perform a restore operation on the shared volume on one virtual machine, you cannot perform the snapshot, restore, clone, or capture operations on other virtual machines that use the shared volume.
Before you perform a restore operation on a boot disk, the virtual machine must be shut down and the status must change to shutoff state.
You cannot restore a virtual server instance snapshot if the snapshot was recently created and the FlashCopy operations are still running in the background. The FlashCopy operations must first get completed. Use the API to get a list of FlashCopy mappings for a volume or the CLI to get a list of FlashCopy mappings for a volume.

Deleting a snapshot

You can delete a snapshot by using the GUI, API, or CLI.

You cannot delete a virtual server instance if it has one or more associated snapshots. You must delete all the associated snapshots before you can delete the virtual server instance.

Deleting a snapshot by using the Power Virtual Server user interface

To delete a snapshot using the Power Virtual Server user interface, complete the following steps:

Open the Power Virtual Server user interface in IBM Cloud and log in with your credentials.
Click Workspaces in the navigation panel. The Workspaces page is displayed with a list of existing workspaces.
Select the workspace which contains the snapshot that you want to delete. The Workspace details panel is displayed.
Click View virtual servers. The Virtual server instances page is displayed.
In the navigation panel, click Storage > Instance snapshots. The Instance snapshots page is displayed with a list of the existing snapshots.
From the list of available snapshots, select the snapshot that you want to delete. The snapshot details page is displayed.
Select Delete from the Actions menu. The Confirm delete dialog is displayed.
Type the snapshot name that is displayed in the Confirm delete dialog and click Delete.

You cannot recover a snapshot after it is successfully deleted.

Deleting a snapshot by using API or CLI

You can delete a snapshot by using the following API and CLI:

API: Delete a PVM instance snapshot of a cloud instance.
CLI: ibmcloud pi snapshot-delete.

You must provide values for the following parameters in the API and CLI:

SNAPSHOT_ID: Required. Specify a unique identifier for the snapshot

Metering and pricing of snapshot

Each snapshot that you create is monitored during every hour and charged depending on the disk space that is requested for the snapshot. The space that is used by a snapshot is charged at 30% of the base rate.

For example, consider that you have M disks on a virtual server instance that add up to 600 GB of space. The M disks are used as source disks for snapshots. The following charges are applicable on M disks:

If you create one snapshot, you are charged for the disk space that is used by the base 600 GB of M disks plus 30% of 600 GB of disk space. That is, 600 GB (space of M disks) + 180 GB (30% of 600 GB) = 780 GB of disk space.
If you create another snapshot by using same disks, you are charged for the disk space that is used by M disks. That is, 600 GB (space of M disks) + (30% of 600 GB) + (30% of 600 GB) = 960 GB of disk space.
The pricing of a snapshot is calculated based on the volume size and storage tier of the individual source volumes that are present in the snapshot. For example, consider the following table to calculate the cost of a snapshot that has volume A and volume B.

An example to calculate the cost of a snapshot
Volume name	Volume size	Tier type	Cost of a volume
Volume A	100 GB	Tier 1	30% of 100 GB
Volume B	30 GB	Tier 0	30% of 30 GB

The cost of the snapshot is the sum of the costs of volume A and volume B.

Creating a volumes-clone

Creating a volumes-clone request

The clone operation creates a full copy of the volume. You can select multiple volumes and start a group clone operation. When multiple volumes are selected, the clone operation ensures that a consistent data copy is created.

The clone operation continues to copy data from the source disks to target disks in the background. Depending on the size of the source disks and the amount of data to be copied, the clone operation can take a significant amount of time.

Prerequisites for creating a volume-clone request

Ensure that you meet the following prerequisites before you start to create a volumes-clone request:

A volumes-clone request name must be unique for your workspace. If you want to reuse a volumes-clone request name, delete the existing volumes-clone request with that name, and then reuse the name.
Volumes to be included in the volumes-clone request must be located in the same storage pool.
Volumes to be included in the volumes-clone request must not be in the error state and the health state of the volume must be ok.
Quiesce the applications that access the set of volumes that you want to include in the volumes-clone request.

Creating the volumes-clone request by using API and CLI

The Prepare action operation completes the preparatory work for creating the group snapshot of volumes that are getting cloned.

Prerequisites for creating a volume-clone request by using API and CLI

Ensure that you meet the following prerequisites before you start the Prepare action operation:

A minimum of two volumes
A minimum of one volume to be in the in-use state
A unique volumes-clone name

When a Prepare action operation is in progress, you cannot trigger another Prepare action operation for the same set of volumes. A Prepare action operation must be followed by Start and Execute operations. If you are not using the existing Prepare action operation, you must cancel the existing operation before you start the next Prepare action operation.

You can initiate the Prepare action operation by using the following API and CLI:

API: Create a new volumes clone request and initiates the Prepare action
CLI: ibmcloud pi volume clone create

You must provide values for the following parameters in the API and CLI:

name: Required. Provide a name to be assigned to the volumes-clone request. The name must be a unique value for each of the existing volumes-clone requests.
volumeIDs: Provide the list of volume identifiers or names to be cloned. A minimum of two volume IDs are required and at least one of the volumes must be in the in-use state. All the volumes to be included in the volumes-clone request must be in the same storage pool.

When the Prepare action operation progresses to 100%, the Prepare status changes depending on the following conditions:

If Prepare action completes successfully, the status changes to prepared.
If Prepare action fails to complete successfully, the status changes to failed.

To check the status of the Prepare action operation, use the API or CLI with volumesCloneID option.

Considerations for creating the volumes-clone request by using API and CLI

When a clone operation is performed on a volume that is in the in-use state, Power Virtual Server creates a consistent group snapshot and re-creates the copy of the cloned volume by using the group snapshot.

Restrictions for creating the volumes-clone request by using API and CLI

A minimum of 2 volume IDs are required and at least one of them must be in the in-use state.

To clone a single volume, you can use the Create a volume clone for specified volumes API or the ibmcloud pi volume clone-async CLI. To check on the status of the single volumes-clone, you can use the Get the status of a volumes clone request for the specified clone task ID API or the ibmcloud pi volume clone-async get CLI.

You cannot modify the source or target disk attributes such as disk size, while the clone operation is in progress.
You cannot attempt to clone a volume if the volume belongs to a consistency group. A volume belongs to a consistency group after you run the volumes-clone start request, or the volume is included in a snapshot create operation where the flash copying in the background is completed.
A volume cannot be cloned from one storage pool to a different storage pool.

Starting a volumes-clone request

This step allows the consistency group to start the FlashCopy operation.

As a prerequisite, the volumes-clone request must be in the Prepared state.

Starting a volumes-clone request by using API and CLI

The initial status of the volume-clone request is set to Starting.

You can start the volumes-clone request by using the following API and CLI:

API: Initiate the Start action for a volumes-clone request
CLI: ibmcloud pi volume clone start

You must provide the unique identifier of a volumes-clone request in the volume_clones_id parameter. The identifier can be the volumes-clone ID or the volumes-clone name.

When you start the volumes-clone request, the initial status is set to Starting. When the group snapshot is created, the request status changes to Available. The start operation of the volumes-clone request is synchronous. When the API call returns to the client, the volumes-clone request status changes to Available unless an error occurs. If an error occurs during the start operation, the status of the volumes-clone request changes to Failed. The reason for failure is specified in the error that is returned with the start operation response. The prepared snapshot data is removed so that you can clone the same set of volumes again. If you cancel the start operation of a volumes-clone request, the status of the volumes-clone request changes to Cancelling. You can cancel a volumes-clone request when the volumes-clone request is in the Available state.

Considerations for starting a volume-clone request

Restrictions for starting a volume-clone request

You must consider the following restrictions before you start the volumes-clone request:

A minimum of two volume IDs are required and at least one of them must be in the in-use state.
When a clone operation is in progress, you cannot modify the source or target disk attributes, such as disk size.

Executing a volumes-clone request

This step performs the remaining execution operation to create the cloned volumes from the available group snapshot.

Prerequisites for executing a volumes-clone request

The volumes-clone request must be in the Available state.

Executing volumes-clone request by using API and CLI

After you start the execute operation, the initial percentComplete will be 0% and the status is set to executing.

You can execute the volumes-clone request by using the following API and CLI:

API: Initiate the Execute action for a volumes-clone request
CLI: ibmcloud pi volume clone execute

You must provide values for the following parameters in the API and CLI:

volume-clones-id: Required. The unique identifier of a volumes-clone request. The identifier can be the volumes-clone ID or the volumes-clone name.
name: Required. The base name of the new cloned volumes. Cloned volume names are prefixed with clone- and suffixed with -#####-N. In the suffix, ##### is a five-digit random number and N is an incremental number that starts with 1.
rollbackPrepare: (Optional) Default value is False. When the flag is set to False, the system runs the failed rolls back clone activity but the prepared snapshot is left as-is. When the flag is set to True, the system runs the failure rollback clone activity and removes the prepared snapshot.
userTags: (Optional) Provide the list of user tags to be attached to the cloned volumes.
targetReplicationEnabled: (Optional) Use this flag to enable or disable replication for the cloned volumes. By default, the flag uses the replication status of the source volumes that are getting cloned. When set to False the cloned volumes are not enabled for replication. When set to True the cloned volumes are enabled for replication.

The storage pool where the source volumes reside must be enabled for replication, if the source volumes are not enabled for replication and you are enabling replication for the cloned volumes.

targetStorageTier: Provide the name of the storage tier for the cloned volumes. Use this field to clone a set of volumes from one storage tier to a different storage tier. Cloned volumes must remain in the same storage pool as the source volumes.

Considerations for executing a volumes-clone request

You must consider the following restrictions and considerations before you start the volumes-clone request:

A volumes-clone request is considered complete when the status of the volumes-clone request is changed to one of the completed, failed, or cancelled state.
When you start the volumes-clone execute request, the initial status is set to executing.
When the execute operation is completed successfully, the volumes-clone request status changes to completed.
If an error occurs during the volume cloning process, any artifacts that are created by the cloning process are removed. The group snapshot is returned to the available state so that you can retry the execute operation.
You can cancel a volumes-clone request when it is in the executing state.
If you cancel the execute operation of a volumes-clone request, the status of the volumes-clone request is changed to cancelling.

Restrictions for executing a volumes-clone request

You can control the behavior of a failed execute operation by using the rollbackPrepare option. The default value of the rollbackPrepare option is false. The default value leads the failed execute operation to roll back the clone activity and does not remove the prepared snapshot. If the rollbackPrepare option is set to true, it leads the failed execute operation to roll back the clone activity and removes the prepared snapshot.

Cancelling a volumes-clone request

The Cancel a volumes-clone request operation starts the cleanup activity that performs the cleanup of the preparatory clones and snapshot volumes.

Prerequisites for cancelling a volume-clone request

The volumes-clone request must be in the Available state.

Cancelling volumes-clone request by using API and CLI

After you start the cancel operation, the initial percentComplete will be 0% and the status is set to cancelling.

You can cancel the volumes-clone request by using the following API and CLI:

API: Cancel a volumes-clone request
CLI: ibmcloud pi volume clone cancel

You must provide values for the following parameters in the API and CLI:

volume-clones-id: Required. The unique identifier of a volumes-clone request. The identifier can be the volumes-clone ID or the volumes-clone name
Force: (Optional) Default status is False. The cancel operation is allowed only if the status is set to prepared or available. When the status is set to True, the cancel operation is allowed when the status is set to NOT completed, cancelling, cancelled, or failed.

Considerations for cancelling volumes-clone request

You must consider the following considerations before you cancel the volumes-clone request:

If you cancel the volumes-clone request, the initial status of the volumes-clone request is set to Cancelling. The status changes to Cancelled state when all the clean-up work is completed successfully.
You can cancel a volumes-clone request when the volumes-clone request is in the executing state. The force option must be set to True in the cancel volumes-clone request.
If the volumes-clone request is in the Executing state, any artifacts that are created by the clone operation process are removed.

Deleting a volumes-clone request

When a volumes-clone request is no longer required, you can delete the request by initiating the volumes-clone delete operation.

Prerequisites for deleting a volumes-clone request

The volumes-clone request must be in one of these final statuses: Completed, Failed, or Cancelled.

Deleting a volumes-clone request by using API and CLI

You can delete the volumes-clone request by using the following API and CLI:

API: Delete a volumes-clone request
CLI: ibmcloud pi volume clone delete

You must provide values for the following parameters in the API and CLI:

volume-clones-id: Required. The unique identifier of a volumes-clone request. The identifier can be the volumes-clone ID or the volumes-clone name.
Force: (Optional) Force the cancellation of a volumes-clone request. The cancel operation is allowed only if the status is set to prepared or available. When the status is set to True, the cancel operation is allowed when the status is set to NOT completed, cancelling, cancelled, or failed.

Considerations for deleting a volumes-clone request

If the volumes-clone request is not in one of the final statuses that is required for deletion, you can cancel the request, do any remaining cleanup, and transition the status to Cancelled. If the volumes-clone request is in the Cancelled status, the request can be deleted.

Getting the status for a volumes-clone request

This API request returns detailed information about the status of the volumes-clone request. For example, the list of source volumes that are getting cloned and the list of cloned volumes when the execute operation is successfully completed.

Prerequisites for getting the status for a volumes-clone request

None.

Getting the status of volumes-clone request by using API and CLI

You can get the status of volumes-clone request by using the following API and CLI:

API: Get the status of a volumes clone request for the specified clone task ID
CLI: ibmcloud pi volume clone get

Provide a value for the volume-clones-id field. The value is the unique identifier of a volumes-clone request. The identifier can be the volumes-clone ID or the volumes-clone name.

Considerations for gettting the status of volumes-clone request by using API and CLI

None.

Restrictions for gettting the status of volumes-clone request by using API and CLI

None.

Getting the list of volumes-clone request

The API request provides a list of all the volumes-clone requests in a workspace and the status of each request.

Prerequisites for getting the list of volumes-clone request

None.

Getting a list of volumes-clone request by using API and CLI

You can get a list of volumes-clone request by using the following API and CLI:

API: Get the list of volumes-clone request for a cloud instance
CLI: ibmcloud pi volume clone list

Provide one of the values to the filter parameter from the following list:

prepare - includes status values (preparing, prepared)
start - includes status values (starting, available)
execute - includes status values (executing, available-rollback)
cancel - includes status values (cancelling)
completed - includes status values (completed)
failed - includes status values (failed)
cancelled - includes status values (cancelled)
finalized - included status values (completed, failed, cancelled)

Restrictions for getting a list of volumes-clone request by using API and CLI

You must consider the following restrictions and considerations before you get the list of volumes-clone requests:

The detailed information about the source volumes or cloned volumes is not provided.
The list can be limited by using the filter parameter. The filter is based on the status of the ‘filter’ parameter.

Frequently asked questions about creating a snapshot, restoring a snapshot, and cloning a volume in Power® Virtual Server

The following are some of the frequently asked questions on snapshots and cloning that are documented on the FAQ page: