Merge branch '4.19'

Author: weizhouapache

api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMsCmd.java

@@ -96,8 +96,8 @@ public class ListVMsCmd extends BaseListRetrieveOnlyResourceCountCmd implements
     @Parameter(name = ApiConstants.DETAILS,
                type = CommandType.LIST,
                collectionType = CommandType.STRING,
-               description = "comma separated list of host details requested, "
-                   + "value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]."
+               description = "comma separated list of vm details requested, "
+                   + "value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]."
                    + " If no parameter is passed in, the details will be defaulted to all")
     private List<String> viewDetails;
 

core/src/main/java/org/apache/cloudstack/backup/PrepareForBackupRestorationCommand.java

@@ -0,0 +1,43 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+package org.apache.cloudstack.backup;
+
+import com.cloud.agent.api.Command;
+
+public class PrepareForBackupRestorationCommand extends Command {
+
+    private String vmName;
+
+    protected PrepareForBackupRestorationCommand() {
+    }
+
+    public PrepareForBackupRestorationCommand(String vmName) {
+        this.vmName = vmName;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return true;
+    }
+}

engine/schema/src/main/java/org/apache/cloudstack/backup/BackupVO.java

@@ -17,6 +17,8 @@
 
 package org.apache.cloudstack.backup;
 
+import com.cloud.utils.db.GenericDao;
+
 import java.util.Date;
 import java.util.UUID;
 
@@ -55,6 +57,9 @@ public class BackupVO implements Backup {
     @Temporal(value = TemporalType.DATE)
     private Date date;
 
+    @Column(name = GenericDao.REMOVED_COLUMN)
+    private Date removed;
+
     @Column(name = "size")
     private Long size;
 
@@ -196,4 +201,12 @@ public Class<?> getEntityType() {
     public String getName() {
         return null;
     }
+
+    public Date getRemoved() {
+        return removed;
+    }
+
+    public void setRemoved(Date removed) {
+        this.removed = removed;
+    }
 }

plugins/backup/veeam/pom.xml

@@ -28,6 +28,21 @@
   </parent>
 
   <dependencies>
+    <dependency>
+      <groupId>org.apache.cloudstack</groupId>
+      <artifactId>cloud-core</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.cloudstack</groupId>
+      <artifactId>cloud-engine-api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.cloudstack</groupId>
+      <artifactId>cloud-engine-components-api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.apache.cloudstack</groupId>
       <artifactId>cloud-plugin-hypervisor-vmware</artifactId>

plugins/backup/veeam/src/main/java/org/apache/cloudstack/backup/VeeamBackupProvider.java

@@ -29,6 +29,7 @@
 
 import javax.inject.Inject;
 
+import org.apache.cloudstack.api.ApiCommandResourceType;
 import org.apache.cloudstack.api.InternalIdentity;
 import org.apache.cloudstack.backup.Backup.Metric;
 import org.apache.cloudstack.backup.dao.BackupDao;
@@ -40,11 +41,17 @@
 import org.apache.commons.lang3.BooleanUtils;
 import org.apache.log4j.Logger;
 
+import com.cloud.agent.AgentManager;
+import com.cloud.agent.api.Answer;
+import com.cloud.event.ActionEventUtils;
+import com.cloud.event.EventTypes;
+import com.cloud.event.EventVO;
 import com.cloud.hypervisor.Hypervisor;
 import com.cloud.dc.VmwareDatacenter;
 import com.cloud.hypervisor.vmware.VmwareDatacenterZoneMap;
 import com.cloud.dc.dao.VmwareDatacenterDao;
 import com.cloud.hypervisor.vmware.dao.VmwareDatacenterZoneMapDao;
+import com.cloud.user.User;
 import com.cloud.utils.Pair;
 import com.cloud.utils.component.AdapterBase;
 import com.cloud.utils.db.Transaction;
@@ -53,6 +60,7 @@
 import com.cloud.utils.exception.CloudRuntimeException;
 import com.cloud.vm.VMInstanceVO;
 import com.cloud.vm.VirtualMachine;
+import com.cloud.vm.VirtualMachineManager;
 import com.cloud.vm.dao.VMInstanceDao;
 
 public class VeeamBackupProvider extends AdapterBase implements BackupProvider, Configurable {
@@ -64,6 +72,10 @@ public class VeeamBackupProvider extends AdapterBase implements BackupProvider,
             "backup.plugin.veeam.url", "https://localhost:9398/api/",
             "The Veeam backup and recovery URL.", true, ConfigKey.Scope.Zone);
 
+    public ConfigKey<Integer> VeeamVersion = new ConfigKey<>("Advanced", Integer.class,
+            "backup.plugin.veeam.version", "0",
+            "The version of Veeam backup and recovery. CloudStack will get Veeam server version via PowerShell commands if it is 0 or not set", true, ConfigKey.Scope.Zone);
+
     private ConfigKey<String> VeeamUsername = new ConfigKey<>("Advanced", String.class,
             "backup.plugin.veeam.username", "administrator",
             "The Veeam backup and recovery username.", true, ConfigKey.Scope.Zone);
@@ -81,6 +93,12 @@ public class VeeamBackupProvider extends AdapterBase implements BackupProvider,
     private static ConfigKey<Integer> VeeamRestoreTimeout = new ConfigKey<>("Advanced", Integer.class, "backup.plugin.veeam.restore.timeout", "600",
             "The Veeam B&R API restore backup timeout in seconds.", true, ConfigKey.Scope.Zone);
 
+    private static ConfigKey<Integer> VeeamTaskPollInterval = new ConfigKey<>("Advanced", Integer.class, "backup.plugin.veeam.task.poll.interval", "5",
+            "The time interval in seconds when the management server polls for Veeam task status.", true, ConfigKey.Scope.Zone);
+
+    private static ConfigKey<Integer> VeeamTaskPollMaxRetry = new ConfigKey<>("Advanced", Integer.class, "backup.plugin.veeam.task.poll.max.retry", "120",
+            "The max number of retrying times when the management server polls for Veeam task status.", true, ConfigKey.Scope.Zone);
+
     @Inject
     private VmwareDatacenterZoneMapDao vmwareDatacenterZoneMapDao;
     @Inject
@@ -89,11 +107,16 @@ public class VeeamBackupProvider extends AdapterBase implements BackupProvider,
     private BackupDao backupDao;
     @Inject
     private VMInstanceDao vmInstanceDao;
+    @Inject
+    private AgentManager agentMgr;
+    @Inject
+    private VirtualMachineManager virtualMachineManager;
 
     protected VeeamClient getClient(final Long zoneId) {
         try {
-            return new VeeamClient(VeeamUrl.valueIn(zoneId), VeeamUsername.valueIn(zoneId), VeeamPassword.valueIn(zoneId),
-                    VeeamValidateSSLSecurity.valueIn(zoneId), VeeamApiRequestTimeout.valueIn(zoneId), VeeamRestoreTimeout.valueIn(zoneId));
+            return new VeeamClient(VeeamUrl.valueIn(zoneId), VeeamVersion.valueIn(zoneId), VeeamUsername.valueIn(zoneId), VeeamPassword.valueIn(zoneId),
+                    VeeamValidateSSLSecurity.valueIn(zoneId), VeeamApiRequestTimeout.valueIn(zoneId), VeeamRestoreTimeout.valueIn(zoneId),
+                    VeeamTaskPollInterval.valueIn(zoneId), VeeamTaskPollMaxRetry.valueIn(zoneId));
         } catch (URISyntaxException e) {
             throw new CloudRuntimeException("Failed to parse Veeam API URL: " + e.getMessage());
         } catch (NoSuchAlgorithmException | KeyManagementException e) {
@@ -189,6 +212,7 @@ public boolean removeVMFromBackupOffering(final VirtualMachine vm) {
             LOG.warn("Failed to remove Veeam job and backup for job: " + clonedJobName);
             throw new CloudRuntimeException("Failed to delete Veeam B&R job and backup, an operation may be in progress. Please try again after some time.");
         }
+        client.syncBackupRepository();
         return true;
     }
 
@@ -222,6 +246,8 @@ public boolean deleteBackup(Backup backup, boolean forced) {
             return false;
         }
 
+        client.syncBackupRepository();
+
         List<Backup> allBackups = backupDao.listByVmId(backup.getZoneId(), backup.getVmId());
         for (Backup b : allBackups) {
             if (b.getId() != backup.getId()) {
@@ -234,7 +260,36 @@ public boolean deleteBackup(Backup backup, boolean forced) {
     @Override
     public boolean restoreVMFromBackup(VirtualMachine vm, Backup backup) {
         final String restorePointId = backup.getExternalId();
-        return getClient(vm.getDataCenterId()).restoreFullVM(vm.getInstanceName(), restorePointId);
+        try {
+            return getClient(vm.getDataCenterId()).restoreFullVM(vm.getInstanceName(), restorePointId);
+        } catch (Exception ex) {
+            LOG.error(String.format("Failed to restore Full VM due to: %s. Retrying after some preparation", ex.getMessage()));
+            prepareForBackupRestoration(vm);
+            return getClient(vm.getDataCenterId()).restoreFullVM(vm.getInstanceName(), restorePointId);
+        }
+    }
+
+    private void prepareForBackupRestoration(VirtualMachine vm) {
+        if (!Hypervisor.HypervisorType.VMware.equals(vm.getHypervisorType())) {
+            return;
+        }
+        LOG.info("Preparing for restoring VM " + vm);
+        PrepareForBackupRestorationCommand command = new PrepareForBackupRestorationCommand(vm.getInstanceName());
+        Long hostId = virtualMachineManager.findClusterAndHostIdForVm(vm.getId()).second();
+        if (hostId == null) {
+            throw new CloudRuntimeException("Cannot find a host to prepare for restoring VM " + vm);
+        }
+        try {
+            Answer answer = agentMgr.easySend(hostId, command);
+            if (answer != null && answer.getResult()) {
+                LOG.info("Succeeded to prepare for restoring VM " + vm);
+            } else {
+                throw new CloudRuntimeException(String.format("Failed to prepare for restoring VM %s. details: %s", vm,
+                        (answer != null ? answer.getDetails() : null)));
+            }
+        } catch (Exception e) {
+            throw new CloudRuntimeException(String.format("Failed to prepare for restoring VM %s due to exception %s", vm, e));
+        }
     }
 
     @Override
@@ -330,6 +385,10 @@ public void doInTransactionWithoutResult(TransactionStatus status) {
                                         + "domain_id: %s, zone_id: %s].", backup.getUuid(), backup.getVmId(), backup.getExternalId(), backup.getType(), backup.getDate(),
                                 backup.getBackupOfferingId(), backup.getAccountId(), backup.getDomainId(), backup.getZoneId()));
                         backupDao.persist(backup);
+
+                        ActionEventUtils.onCompletedActionEvent(User.UID_SYSTEM, vm.getAccountId(), EventVO.LEVEL_INFO, EventTypes.EVENT_VM_BACKUP_CREATE,
+                                String.format("Created backup %s for VM ID: %s", backup.getUuid(), vm.getUuid()),
+                                vm.getId(), ApiCommandResourceType.VirtualMachine.toString(),0);
                     }
                 }
                 for (final Long backupIdToRemove : removeList) {
@@ -349,11 +408,14 @@ public String getConfigComponentName() {
     public ConfigKey<?>[] getConfigKeys() {
         return new ConfigKey[]{
                 VeeamUrl,
+                VeeamVersion,
                 VeeamUsername,
                 VeeamPassword,
                 VeeamValidateSSLSecurity,
                 VeeamApiRequestTimeout,
-                VeeamRestoreTimeout
+                VeeamRestoreTimeout,
+                VeeamTaskPollInterval,
+                VeeamTaskPollMaxRetry
         };
     }