Support of snapshot copy to primary storage in different zones.

api/src/main/java/com/cloud/storage/VolumeApiService.java

@@ -113,10 +113,10 @@ public interface VolumeApiService {
 
  Volume detachVolumeFromVM(DetachVolumeCmd cmd);
 
- Snapshot takeSnapshot(Long volumeId, Long policyId, Long snapshotId, Account account, boolean quiescevm, Snapshot.LocationType locationType, boolean asyncBackup, Map<String, String> tags, List<Long> zoneIds)
+ Snapshot takeSnapshot(Long volumeId, Long policyId, Long snapshotId, Account account, boolean quiescevm, Snapshot.LocationType locationType, boolean asyncBackup, Map<String, String> tags, List<Long> zoneIds, List<Long> poolIds, Boolean useStorageReplication)
  throws ResourceAllocationException;
 
- Snapshot allocSnapshot(Long volumeId, Long policyId, String snapshotName, Snapshot.LocationType locationType, List<Long> zoneIds) throws ResourceAllocationException;
+ Snapshot allocSnapshot(Long volumeId, Long policyId, String snapshotName, Snapshot.LocationType locationType, List<Long> zoneIds, List<Long> storagePoolIds, Boolean useStorageReplication) throws ResourceAllocationException;
 
  Volume updateVolume(long volumeId, String path, String state, Long storageId,
  Boolean displayVolume, Boolean deleteProtection,

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -536,6 +536,9 @@ public class ApiConstants {
  public static final String SNAPSHOT_POLICY_ID = "snapshotpolicyid";
  public static final String SNAPSHOT_TYPE = "snapshottype";
  public static final String SNAPSHOT_QUIESCEVM = "quiescevm";
+
+ public static final String USE_STORAGE_REPLICATION = "usestoragereplication";
+
  public static final String SOURCE_CIDR_LIST = "sourcecidrlist";
  public static final String SOURCE_ZONE_ID = "sourcezoneid";
  public static final String SSL_VERIFICATION = "sslverification";
@@ -1156,6 +1159,7 @@ public class ApiConstants {
 
  public static final String ZONE_ID_LIST = "zoneids";
  public static final String DESTINATION_ZONE_ID_LIST = "destzoneids";
+ public static final String STORAGE_ID_LIST = "storageids";
  public static final String ADMIN = "admin";
  public static final String CHECKSUM_PARAMETER_PREFIX_DESCRIPTION = "The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n"
  + " and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n"

api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CopySnapshotCmd.java

@@ -17,9 +17,13 @@
 
 package org.apache.cloudstack.api.command.user.snapshot;
 
-import java.util.ArrayList;
-import java.util.List;
-
+import com.cloud.dc.DataCenter;
+import com.cloud.event.EventTypes;
+import com.cloud.exception.ResourceAllocationException;
+import com.cloud.exception.ResourceUnavailableException;
+import com.cloud.exception.StorageUnavailableException;
+import com.cloud.storage.Snapshot;
+import com.cloud.user.Account;
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiCommandResourceType;
@@ -31,26 +35,24 @@
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.command.user.UserCmd;
 import org.apache.cloudstack.api.response.SnapshotResponse;
+import org.apache.cloudstack.api.response.StoragePoolResponse;
 import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.cloudstack.context.CallContext;
 import org.apache.commons.collections.CollectionUtils;
-
-import com.cloud.dc.DataCenter;
-import com.cloud.event.EventTypes;
-import com.cloud.exception.ResourceAllocationException;
-import com.cloud.exception.ResourceUnavailableException;
-import com.cloud.exception.StorageUnavailableException;
-import com.cloud.storage.Snapshot;
-import com.cloud.user.Account;
+import org.apache.commons.lang3.BooleanUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
+import java.util.ArrayList;
+import java.util.List;
+
 @APICommand(name = "copySnapshot", description = "Copies a snapshot from one zone to another.",
  responseObject = SnapshotResponse.class, responseView = ResponseObject.ResponseView.Restricted,
  requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.19.0",
  authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
 public class CopySnapshotCmd extends BaseAsyncCmd implements UserCmd {
  public static final Logger logger = LogManager.getLogger(CopySnapshotCmd.class.getName());
+ private Snapshot snapshot;
 
  /////////////////////////////////////////////////////
  //////////////// API parameters /////////////////////
@@ -84,6 +86,20 @@ public class CopySnapshotCmd extends BaseAsyncCmd implements UserCmd {
  "Do not specify destzoneid and destzoneids together, however one of them is required.")
  protected List<Long> destZoneIds;
 
+ @Parameter(name = ApiConstants.STORAGE_ID_LIST,
+ type=CommandType.LIST,
+ collectionType = CommandType.UUID,
+ entityType = StoragePoolResponse.class,
+ required = false,
+ authorized = RoleType.Admin,
+ since = "4.21.0",
+ description = "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. " +
+ "The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only")
+ protected List<Long> storagePoolIds;
+
+ @Parameter (name = ApiConstants.USE_STORAGE_REPLICATION, type=CommandType.BOOLEAN, required = false, since = "4.21.0", description = "This parameter enables the option the snapshot to be copied to supported primary storage")
+ protected Boolean useStorageReplication;
+
  /////////////////////////////////////////////////////
  /////////////////// Accessors ///////////////////////
  /////////////////////////////////////////////////////
@@ -106,7 +122,15 @@ public List<Long> getDestinationZoneIds() {
  destIds.add(destZoneId);
  return destIds;
  }
- return null;
+ return new ArrayList<>();
+ }
+
+ public List<Long> getStoragePoolIds() {
+ return storagePoolIds;
+ }
+
+ public Boolean useStorageReplication() {
+ return BooleanUtils.toBoolean(useStorageReplication);
  }
 
  @Override
@@ -152,7 +176,7 @@ public long getEntityOwnerId() {
  @Override
  public void execute() throws ResourceUnavailableException {
  try {
- if (destZoneId == null && CollectionUtils.isEmpty(destZoneIds))
+ if (destZoneId == null && CollectionUtils.isEmpty(destZoneIds) && useStorageReplication())
  throw new ServerApiException(ApiErrorCode.PARAM_ERROR,
  "Either destzoneid or destzoneids parameters have to be specified.");
 
@@ -161,7 +185,7 @@ public void execute() throws ResourceUnavailableException {
  "Both destzoneid and destzoneids cannot be specified at the same time.");
 
  CallContext.current().setEventDetails(getEventDescription());
-Snapshot snapshot = _snapshotService.copySnapshot(this);
+ snapshot = _snapshotService.copySnapshot(this);
 
  if (snapshot != null) {
  SnapshotResponse response = _queryService.listSnapshot(this);
@@ -177,6 +201,13 @@ public void execute() throws ResourceUnavailableException {
  logger.warn("Exception: ", ex);
  throw new ServerApiException(ApiErrorCode.RESOURCE_ALLOCATION_ERROR, ex.getMessage());
  }
+ }
+
+ public Snapshot getSnapshot() {
+ return snapshot;
+ }
 
+ public void setSnapshot(Snapshot snapshot) {
+ this.snapshot = snapshot;
  }
 }

api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java

@@ -16,11 +16,13 @@
 // under the License.
 package org.apache.cloudstack.api.command.user.snapshot;
 
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiCommandResourceType;
 import org.apache.cloudstack.api.ApiConstants;
@@ -32,6 +34,7 @@
 import org.apache.cloudstack.api.response.DomainResponse;
 import org.apache.cloudstack.api.response.SnapshotPolicyResponse;
 import org.apache.cloudstack.api.response.SnapshotResponse;
+import org.apache.cloudstack.api.response.StoragePoolResponse;
 import org.apache.cloudstack.api.response.VolumeResponse;
 import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.commons.collections.MapUtils;
@@ -99,6 +102,19 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
  since = "4.19.0")
  protected List<Long> zoneIds;
 
+ @Parameter(name = ApiConstants.STORAGE_ID_LIST,
+ type=CommandType.LIST,
+ collectionType = CommandType.UUID,
+ entityType = StoragePoolResponse.class,
+ authorized = RoleType.Admin,
+ description = "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. " +
+ "The snapshot will always be made available in the zone in which the volume is present.",
+ since = "4.21.0")
+ protected List<Long> storagePoolIds;
+
+ @Parameter (name = ApiConstants.USE_STORAGE_REPLICATION, type=CommandType.BOOLEAN, required = false, description = "This parameter enables the option the snapshot to be copied to supported primary storage")
+ protected Boolean useStorageReplication;
+
  private String syncObjectType = BaseAsyncCmd.snapshotHostSyncObject;
 
  // ///////////////////////////////////////////////////
@@ -161,6 +177,17 @@ public List<Long> getZoneIds() {
  return zoneIds;
  }
 
+ public List<Long> getStoragePoolIds() {
+ return storagePoolIds == null ? new ArrayList<>() : storagePoolIds;
+ }
+
+ public Boolean useStorageReplication() {
+ if (useStorageReplication == null) {
+ return false;
+ }
+ return useStorageReplication;
+ }
+
  // ///////////////////////////////////////////////////
  // ///////////// API Implementation///////////////////
  // ///////////////////////////////////////////////////
@@ -209,7 +236,7 @@ public ApiCommandResourceType getApiResourceType() {
 
  @Override
  public void create() throws ResourceAllocationException {
- Snapshot snapshot = _volumeService.allocSnapshot(getVolumeId(), getPolicyId(), getSnapshotName(), getLocationType(), getZoneIds());
+ Snapshot snapshot = _volumeService.allocSnapshot(getVolumeId(), getPolicyId(), getSnapshotName(), getLocationType(), getZoneIds(), getStoragePoolIds(), useStorageReplication());
  if (snapshot != null) {
  setEntityId(snapshot.getId());
  setEntityUuid(snapshot.getUuid());
@@ -223,7 +250,7 @@ public void execute() {
  Snapshot snapshot;
  try {
  snapshot =
- _volumeService.takeSnapshot(getVolumeId(), getPolicyId(), getEntityId(), _accountService.getAccount(getEntityOwnerId()), getQuiescevm(), getLocationType(), getAsyncBackup(), getTags(), getZoneIds());
+ _volumeService.takeSnapshot(getVolumeId(), getPolicyId(), getEntityId(), _accountService.getAccount(getEntityOwnerId()), getQuiescevm(), getLocationType(), getAsyncBackup(), getTags(), getZoneIds(), getStoragePoolIds(), useStorageReplication());
 
  if (snapshot != null) {
  SnapshotResponse response = _responseGenerator.createSnapshotResponse(snapshot);
@@ -243,7 +270,7 @@ public void execute() {
  }
  }
 
-private Snapshot.LocationType getLocationType() {
+public Snapshot.LocationType getLocationType() {
 
  if (Snapshot.LocationType.values() == null || Snapshot.LocationType.values().length == 0 || locationType == null) {
  return null;

api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotPolicyCmd.java

@@ -16,11 +16,13 @@
 // under the License.
 package org.apache.cloudstack.api.command.user.snapshot;
 
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
+import com.cloud.exception.InvalidParameterValueException;
+import com.cloud.exception.PermissionDeniedException;
+import com.cloud.projects.Project;
+import com.cloud.storage.Volume;
+import com.cloud.storage.snapshot.SnapshotPolicy;
+import com.cloud.user.Account;
+import java.util.ArrayList;
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiCommandResourceType;
@@ -30,16 +32,16 @@
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.response.SnapshotPolicyResponse;
+import org.apache.cloudstack.api.response.StoragePoolResponse;
 import org.apache.cloudstack.api.response.VolumeResponse;
 import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.commons.collections.MapUtils;
 
-import com.cloud.exception.InvalidParameterValueException;
-import com.cloud.exception.PermissionDeniedException;
-import com.cloud.projects.Project;
-import com.cloud.storage.Volume;
-import com.cloud.storage.snapshot.SnapshotPolicy;
-import com.cloud.user.Account;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import org.apache.commons.lang3.BooleanUtils;
 
 @APICommand(name = "createSnapshotPolicy", description = "Creates a snapshot policy for the account.", responseObject = SnapshotPolicyResponse.class,
  requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
@@ -83,6 +85,17 @@ public class CreateSnapshotPolicyCmd extends BaseCmd {
  "The snapshots will always be made available in the zone in which the volume is present.")
  protected List<Long> zoneIds;
 
+ @Parameter(name = ApiConstants.STORAGE_ID_LIST,
+ type=CommandType.LIST,
+ collectionType = CommandType.UUID,
+ entityType = StoragePoolResponse.class,
+ description = "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. " +
+ "The snapshot will always be made available in the zone in which the volume is present.",
+ since = "4.21.0")
+ protected List<Long> storagePoolIds;
+
+ @Parameter (name = ApiConstants.USE_STORAGE_REPLICATION, type=CommandType.BOOLEAN, required = false, since = "4.21.0", description = "This parameter enables the option the snapshot to be copied to supported primary storage")
+ protected Boolean useStorageReplication;
  /////////////////////////////////////////////////////
  /////////////////// Accessors ///////////////////////
  /////////////////////////////////////////////////////
@@ -119,6 +132,14 @@ public List<Long> getZoneIds() {
  return zoneIds;
  }
 
+ public List<Long> getStoragePoolIds() {
+ return storagePoolIds == null ? new ArrayList<>() : storagePoolIds;
+ }
+
+ public Boolean useStorageReplication() {
+ return BooleanUtils.toBoolean(useStorageReplication);
+ }
+
  /////////////////////////////////////////////////////
  /////////////// API Implementation///////////////////
  /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/response/SnapshotPolicyResponse.java

@@ -16,17 +16,16 @@
 // under the License.
 package org.apache.cloudstack.api.response;
 
-import java.util.LinkedHashSet;
-import java.util.Set;
-
+import com.cloud.serializer.Param;
+import com.cloud.storage.snapshot.SnapshotPolicy;
+import com.google.gson.annotations.SerializedName;
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.BaseResponseWithTagInformation;
 import org.apache.cloudstack.api.EntityReference;
 
-import com.cloud.serializer.Param;
-import com.cloud.storage.snapshot.SnapshotPolicy;
-import com.google.gson.annotations.SerializedName;
+import java.util.LinkedHashSet;
+import java.util.Set;
 
 @EntityReference(value = SnapshotPolicy.class)
 public class SnapshotPolicyResponse extends BaseResponseWithTagInformation {
@@ -62,9 +61,14 @@ public class SnapshotPolicyResponse extends BaseResponseWithTagInformation {
  @Param(description = "The list of zones in which snapshot backup is scheduled", responseObject = ZoneResponse.class, since = "4.19.0")
  protected Set<ZoneResponse> zones;
 
+ @SerializedName(ApiConstants.STORAGE)
+ @Param(description = "The list of pools in which snapshot backup is scheduled", responseObject = StoragePoolResponse.class, since = "4.21.0")
+ protected Set<StoragePoolResponse> storagePools;
+
  public SnapshotPolicyResponse() {
  tags = new LinkedHashSet<ResourceTagResponse>();
  zones = new LinkedHashSet<>();
+ storagePools = new LinkedHashSet<>();
  }
 
  public String getId() {
@@ -130,4 +134,6 @@ public void setTags(Set<ResourceTagResponse> tags) {
  public void setZones(Set<ZoneResponse> zones) {
  this.zones = zones;
  }
+
+ public void setStoragePools(Set<StoragePoolResponse> pools) { this.storagePools = pools; }
 }

api/src/test/java/org/apache/cloudstack/api/command/test/CreateSnapshotCmdTest.java

@@ -93,7 +93,7 @@ public void testCreateSuccess() {
  Snapshot snapshot = Mockito.mock(Snapshot.class);
  try {
  Mockito.when(volumeApiService.takeSnapshot(nullable(Long.class), nullable(Long.class), isNull(),
- nullable(Account.class), nullable(Boolean.class), nullable(Snapshot.LocationType.class), nullable(Boolean.class), nullable(Map.class), nullable(List.class))).thenReturn(snapshot);
+ nullable(Account.class), nullable(Boolean.class), nullable(Snapshot.LocationType.class), nullable(Boolean.class), nullable(Map.class), nullable(List.class), nullable(List.class), Mockito.anyBoolean())).thenReturn(snapshot);
 
  } catch (Exception e) {
  Assert.fail("Received exception when success expected " + e.getMessage());
@@ -126,7 +126,7 @@ public void testCreateFailure() {
 
  try {
  Mockito.when(volumeApiService.takeSnapshot(nullable(Long.class), nullable(Long.class), nullable(Long.class),
- nullable(Account.class), nullable(Boolean.class), nullable(Snapshot.LocationType.class), nullable(Boolean.class), any(), Mockito.anyList())).thenReturn(null);
+ nullable(Account.class), nullable(Boolean.class), nullable(Snapshot.LocationType.class), nullable(Boolean.class), any(), Mockito.anyList(), Mockito.anyList(), Mockito.anyBoolean())).thenReturn(null);
  } catch (Exception e) {
  Assert.fail("Received exception when success expected " + e.getMessage());
  }

api/src/test/java/org/apache/cloudstack/api/command/user/snapshot/CopySnapshotCmdTest.java

@@ -87,7 +87,12 @@ public void testGetDestZoneIdWithBothParams() {
 
  @Test (expected = ServerApiException.class)
  public void testExecuteWrongNoParams() {
+ UUIDManager uuidManager = Mockito.mock(UUIDManager.class);
+ SnapshotApiService snapshotApiService = Mockito.mock(SnapshotApiService.class);
  final CopySnapshotCmd cmd = new CopySnapshotCmd();
+ cmd._uuidMgr = uuidManager;
+ cmd._snapshotService = snapshotApiService;
+
  try {
  cmd.execute();
  } catch (ResourceUnavailableException e) {