DocsKnowledge BaseAPI Explorer
Documentation›Explore more›ZStack ZSphere›User GuideZVF
Document navigation

Virtual Machine Backup

The backup service in ZSphere is based on periodic scheduled backups. To perform backups, configure a backup plan first. For more information, see Create a Backup Plan.

During backup plan execution, the backup mode, backup chain length, backup data retention policy, and backup QoS depend on the configured backup policy. For more information, see Backup Policy.

When a full or incremental backup is created for a VM with VM encryption or disk encryption enabled, the corresponding backup data remains encrypted. Before creating encrypted backup data, make sure that the default key provider is connected and available.

After backups are generated, you can use backup data to recover virtual machines. For more information, see Data Recovery.

Backup Policy

Backup Policy

Backup Mode
ZSphere provides two backup modes:
  • Default incremental backup

    You only need to customize the incremental backup policy. The full backup policy is configured by the system. After 63 incremental backups are performed, the system automatically performs one full backup, and the maximum backup chain length is 64.

  • Custom incremental backup

    You need to customize both the incremental backup policy and the full backup policy. By customizing the full backup policy, you can shorten the full backup interval. More full backups shorten the backup chain and reduce the amount of backup data to merge during recovery.

Backup Cycle
The backup cycle determines how frequently backups are performed.
  • For incremental backup policies, ZSphere provides multiple options, including monthly, weekly, daily, hourly, and minutely backups.
  • For full backup policies, ZSphere supports monthly and weekly backups.
Execution Time
You can configure a more granular backup execution time down to the minute. If the backup cycle of an incremental backup policy is monthly, weekly, or daily, you can set the incremental backup execution time. If the backup cycle of a full backup policy is monthly or weekly, you can set the full backup execution time.
  • Monthly backup: If the execution time is set to 00:00 on the 1st day of every month, the backup starts at 00:00:00 on the first day of each month.
  • Weekly backup: If the execution time is set to Sunday Tuesday 00:00, the backup starts at 00:00:00 every Sunday and Tuesday.
  • Daily backup: If the execution time is set to 00:30, the backup starts at 00:30:00 every day.
Start Time

The backup plan starts at the start time and performs backups based on the configured backup cycle and execution time.

Retention Policy

Each successful backup generates backup data that can be used to restore VM data to an earlier point in time. To control the amount of backup data, specify a backup data retention policy. Based on the backup scenario, ZSphere can set retention policies separately for local backup data and remote backup data.
  • Local retention policy:
    • Retain by quantity: Retain at least the latest local incremental backup data and the latest local full backup data.
    • Retain by time: Retain local backup data for at least the latest 1 day.
  • Remote retention policy:
    • Permanent retention: Remote backup data is not automatically cleaned up.
    • Retain by quantity: Retain at least the latest remote incremental backup data and the latest remote full backup data.
    • Retain by time: Retain remote backup data for at least the latest 1 day.
Note: Backup data outside the retention policy is removed only from the records. Data security is not affected.

Create a Backup Plan

Before you begin

  • Make sure the platform has sufficient authorized backup quota.
  • Make sure the virtual machines to be backed up are in the running or paused state and are not associated with any other backup plans.
  • If the data storage where a virtual machine resides is ZHPS distributed storage, the virtual machine cannot be associated with a backup plan.

Procedure

  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. On the Backup Plan page, click New Backup Plan.
  3. In the New Backup Plan dialog, complete the basic configuration and backup configuration.
  4. For Basic Configuration, configure the following options:

    Basic Information

    Option Description
    Name Name of the backup plan.
    Description Enter a brief description for the backup plan.
    Data Center Select a data center.

    Backup Storage

    Option Description
    Local Backup Storage Add local backup storage. You can specify up to two backup storage resources for seamless failover.
    Sync to Remote Backup Storage Disabled by default. Choose whether to synchronize local backup data to remote backup storage.
    Note: If this option is enabled, add remote backup storage to the platform in advance. For more information, see Add Remote Backup Storage.
    Remote Backup Storage After Sync to Remote Backup Storage is enabled, displays the name and available capacity of the remote backup storage.

    Backup Object

    Option Description
    Backup Object Type Select Virtual Machine.
    Virtual Machine Add virtual machines to be backed up and set the backup priority as needed.
    Note:
    • The number of selected virtual machines must not exceed the authorized backup quota.
    • If a selected virtual machine already has backup data, creating a new backup plan does not consume additional authorized backup quota.
    • By default, an entire VM is backed up. If the VM has shared disks or RDM disks attached, the shared disks and RDM disks are not backed up.
  5. Review the basic configuration and click Next.
  6. For Backup Configuration, configure the following options:

    Backup Policy

    Option Description
    Backup Mode Select default incremental backup or custom incremental backup as needed.
    Incremental Backup Policy Customize the incremental backup policy, including the backup cycle and execution time.
    Full Backup Policy When the backup mode is custom incremental backup, customize the full backup policy, including the backup cycle and execution time.
    Maximum Backup Chain Length Displays the backup chain length under the current backup policy. The maximum length cannot exceed 64.
    Start Time Set the start time of the backup plan.
    Disk Read Speed Set the disk read speed limit. If this parameter is left empty, the speed is unlimited by default. Unit: MB/s or GB/s. Value range: 1 MB/s to 100 GB/s.
    Note: Configure QoS based on the physical network bandwidth and the bandwidth consumed by concurrent backups.

    For more information about backup policies, see Backup Policy.

    Retention Policy

    Option Description
    Local Retention Policy Set the local backup retention policy by quantity or by time.
    Remote Retention Policy Set this parameter after Sync to Remote Backup Storage is enabled. Set the remote backup retention policy to permanent retention, retention by quantity, or retention by time.

    For more information about retention policies, see Backup Policy.

  7. Review the configuration and click OK.

What to do next

After backups are generated, you can use backup data to recover virtual machines. For more information, see Data Recovery.

View Backup Plans and Data

During backup plan execution, you can view the execution status of backup plans to monitor backup activity in real time. For more information, see View Backup Plan Executions.

During backup plan execution, backup data is generated. You can view backup data for protected resources. For more information, see View VM Backup Data.

View Backup Plan Executions

View the Latest Backup Result

Procedure:
  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. In the list, view the latest backup result from Latest Backup Job Result.

Check Backup Execution Status of Protected Resources

If you start a large backup plan that involves multiple virtual machines, you can view the backup result of each virtual machine to identify which virtual machines succeeded, failed, or are waiting to be backed up.

Procedure:
  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. On the Backup Plan page, click the backup plan name to go to the details page.
  3. On the backup plan details page, click Backup Resources.
  4. On the Backup Resources tab, view the backup execution status of all protected resources in the backup plan.

View Backup Job Details in a Backup Plan

You can view details of each backup job, including the backup object, backup mode, number of backup resources, total backup capacity, backup job result, backup duration, start and completion time, and backup details.

Procedure:
  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. On the Backup Plan page, click the virtual machine backup plan name to go to the details page.
  3. On the backup plan details page, click Backup Job.
  4. On the Backup Job tab, select the backup job that you want to view, and then click View Backup Details.
  5. In the Backup Job Details dialog, view details of the backup job.

View VM Backup Data

Backup plan execution generates a series of backup data records, which are stored in the specified backup storage. ZSphere provides a unified entry for viewing backup data of protected resources so that important protected workloads are not missed.

Procedure

  1. In the navigation pane, choose Data Protection > Protected Resources.
  2. On the Protected Resources page, select the Virtual Machine tab.
  3. View VM backup data.
    The VM backup data page displays backup data by virtual machine in a tree folder structure. Under each VM folder, all backup data for that VM is listed by creation time, with the latest backup data displayed first.
    • After selecting a VM, you can view the VM power state, total backup data capacity, associated backup plan, UUID, and all backup data of the VM.
    • Backup data that contains an encrypted VM or encrypted disk is identified by an encryption icon next to its name.
    • After selecting backup data of the VM, you can view basic information and backup information about the backup data, including the source VM, backup capacity, backup type, backup storage, synchronization status to remote backup storage, owner, UUID, creation time, and detailed backup information.

Run a Backup Now

Use manual backup if you want to create an additional backup restore point for one or more virtual machines in a backup plan, do not want to create a new backup plan or modify an existing one, or have associated a backup plan with the VMs to be protected but backup data has not yet been generated based on the scheduled time.

Procedure

  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. On the Backup Plan page, select the backup plan for which you want to manually run a backup, and then click Actions > Backup Now.
  3. In the Backup Now dialog, choose whether to enable Full Backup.
    Note: If enabled, a full backup is manually performed for the backup objects. If disabled, the backup mode is the same as that of the next scheduled backup.
  4. Review the information and click OK.
    If the backup plan contains multiple virtual machines and you want to generate backup data for only one specific virtual machine, go to the Backup Resources tab on the backup plan details page, select the virtual machines that you do not want to back up, and then click Actions > Backup Job State > Disable. After they are disabled, manually run the backup plan.

Create an On-Demand Backup

In addition to backing up a VM by adding it to a backup plan, you can create an on-demand backup for the VM.

Before you begin

  • If the data storage where the VM resides is ZHPS distributed storage, backup creation is not supported.
  • If the VM has an RDM disk attached, you cannot create an on-demand backup. To create a backup, detach the RDM disk first.
  • If the VM has a shared disk attached, the shared disk is not backed up.

Procedure

  1. In the navigation pane, choose Inventory > Hosts and VMs.
  2. In the left navigation tree, right-click the VM and choose Backup > Create Backup.
  3. In the Create Backup dialog, enter a backup name, select a backup type, specify local backup storage, and choose whether to synchronize the backup to remote backup storage.
    Note: If VM or disk encryption is enabled, Sync to Remote Backup Storage is unavailable.
  4. Review the information and click OK.

What to do next

After the backup is created, go to the Protected Resources page to view the backup data of the VM.
PreviousAdd Backup StorageNextPlatform Database Backup
User Guide | ZStack ZSphere · ZVF | ZStack Resource Center