Platform: WindowsProducts: Managed Backup (Agent), Managed Backup (Web)
Article ID: m0099Last Modified: 14-Nov-2024

VMware Backup Plan in Backup Agent (New Backup Format)

Backup Agent virtual edition supports vSphere ESXi virtual machine backup and restore.

To perform VMware backups and, you need a special license. Learn more about license in the Licenses section

The following requirements apply to vSphere ESXi:

Component Requirement
Operating System 64-bit, Windows 10/11, Windows Server 2008/2008R2/2012/2012R2/2016/2019/2022
vSphere version 6.0 to 8.0

This chapter cover the following topics:

Learn Backup Wizard steps:

Create Backup Plan

To create a new VMware backup plan , click the VMware icon in the horizontal menu bar. To create a plan in the new backup format, select VMware Backup. To continue using the current backup format, select VMware Backup (Legacy).

The Backup Wizard starts.

Select Backup Storage

Select a storage account for the backup plan from the list of available backup storage. If no storage is available, click Add new Storage Account.

Once you selected backup storage, click Next.

| Top |

Plan Name

Specify the name for the backup plan.

Click Next.

| Top |

Advanced Options

Specify advanced options for the backup plan. Advanced option set depends on the selected backup storage.

The following options are available:

  • Use synthetic full backup. Select this option for cloud storages to enable the synthetic full backup usage for the backup plan. If a long-term storage class is selected as the bsckup destination, this will result in high storage costs.

Additional Advanced Options for Amazon S3

  1. If your backup storage destination is Amazon S3, select the S3 storage class for the backup plan:

Usage of different storage classes for different backups is the subject of optimizing your storage costs.

Learn more about Amazon S3 storage classes here

  1. Select Use S3 Transfer Acceleration to accelerate file transfer for an extra fee. The target bucket must have this feature enabled. Select this checkbox if you want to use the data transfer acceleration service provided by Amazon. To learn more, refer to the Amazon S3 Transfer Acceleration.

Additional Advanced Options for Microsoft Azure

If your backup storage destination is Microsoft Azure, and you have the General Purpose v2 Azure account, select the required storage class (access tier).

The following options are available:

  • Hot tier. An online tier optimized for storing data that is accessed or modified frequently. The hot tier has the highest storage costs, but the lowest access costs.
  • Cool tier. An online tier optimized for storing data that is infrequently accessed or modified. Data in the cool tier should be stored for a minimum of 30 days. The cool tier has lower storage costs and higher access costs compared to the hot tier.
  • Cold tier.An online tier optimized for storing data that is rarely accessed or modified, but still requires fast retrieval. Data in the cold tier should be stored for a minimum of 90 days. The cold tier has lower storage costs and higher access costs compared to the cool tier.
  • Archive tier. An offline tier optimized for storing data that is rarely accessed, and that has flexible latency requirements, on the order of hours. Data in the archive tier should be stored for a minimum of 180 days.

Note that this feature is only supported for General Purpose v2 Azure accounts. If you are using another kind of account, you need to upgrade your account to be able to use this feature

Be aware of the additional charges and increased blob access rates after your Azure account upgrade

To learn more about the difference between Azure storage tiers, refer to the Azure Blob Storage - Hot, cool,cold, and archive storage tiers article at docs.microsoft.com.

Click Next.

Select VMware Host Server

Specify VMware server credentials.

Click Next.

In case credentials are invalid or the VMware server cannot be accessed, you will not be able to proceed to the next Backup Wizard step

| Top |

Select Virtual Machines

Select virtual machines for the backup plan.

The following options are available:

  • Back up all Virtual Machines. Select this option to include all virtual machines from the server in the backup plan
  • Back up only running Virtual Machines. Select this option to back only those virtual machines that are running at the moment of the backup plan execution
  • Back up selected Virtual Machines. Select this option to make a manual selection of virtual machines to back up

Note that if you switch the backup option from the Back up selected Virtual Machines to any other, the previously made selection is kept for the case if you change your mind and select back the Back up selected Virtual Machines option, but the selected option will be applied regardless the VM selection

  • Select the Use Changed Block Tracking check box to apply the changed block tracking feature. In most cases, this feature increases the backup speed

Changed Block Tracking is an incremental backup technology for VMware virtual machines. To learn more about CBT, refer to Change Block Tracking on Virtual Machines article at vmware.com.

  • To use quiesced snapshots for your backup plan, select the Quiesce guest file system check box. In this case, you must have VMware Tools installed.

Quiescing a file system is a process of bringing the on-disk data of a physical or virtual computer into a state suitable for backups. This process might include such operations as flushing dirty buffers from the operating system's in-memory cache to disk, or other higher-level, application-specific tasks. To learn more about quiesced snapshotting, refer to Understanding VM snapshots in ESXi article at vmware.com

Click Next.

| Top |

Configure Application-Consistent Backups (BETA)

You can configure the Application processing options after the Select Virtual Machines step of the VMware backup wizard. These options can be configured separately for each virtual machine.

By default, the Try application processing setting is set. You can change it, if necessary.

The following options are available:

  • Try application processing. Back up virtual machines 'as is' if failed. Once this option is selected, virtual machines are backed up one by one. Using the installed VMware Tools, the state of applications running on virtual machines is checked, then a snapshot is made and an application-consistent backup is performed. In case an application-consistent snapshot is not made for some reason, a regular snapshot is done for this virtual machine.
  • Require successful application processing. Skip virtual machines if failed. Once this option is selected, virtual machines with applications that did not flush pending I/O operations from memory to disks, are skipped and an appropriate warning is displayed for a user.
  • Disable application processing. Back up virtual machines 'as is'. Once this option is selected, regular VM snapshots are done without quiescing.

Click Next.

Compression and Encryption Options

Compression

Managed Backup offers compression to reduce the storage space required for your backup and to speed up the upload process to the target storage.

Encryption

You can protect your backup by encrypting its contents. Managed Backup supports AES encryption with key sizes of 128, 192, and 256 bits. A larger key size provides stronger encryption but may increase the time required for processing your backup. For more details on AES encryption, refer to the Advanced Encryption Standard.

If you choose to save your backup plan configuration to the destination storage, be aware that the encryption password is not stored in the configuration file for security reasons. Ensure that you save this password securely, as it will be required to restore the backup's contents.

If you change any encryption settings (algorithm or password) for an existing backup plan, a full backup will be executed the next time the backup plan runs.

Note that the encryption password will NOT be stored in the backup plan configuration for security reasons. Keep this password in a safe place to be able to restore the backup contents afterwards

Click Next.

| Top |

Consistency Check

Select whether to run the full consistency for this backup plan.

To learn more about consistency checks, refer to the Mandatory and Full Consistency Checks chapter

Click Next.

| Top |

Schedule

Specify the backup plan schedule settings.

The following options are available:

  • Select the No schedule option to run the backup plan manually.
  • Select the Simple (Forever Forward) option to apply the Forever Forward Incremental (FFI) schedule.
  • Select the **Advanced (GFS, Object Lock) option to apply the recurring schedule and, if necessary, use Grandfather-Father-Son and Object Lock (Immutability).
  • To set the time limit for plan execution, select the Stop the plan if it runs for checkbox, then specify the backup plan duration limit.
  • To run the backup plan after the computer is on in case the backup plan run has been missed, select the Run missed scheduled backup immediately when computer starts up checkbox.

Click Next.

Simple Schedule

Select the Simple (Forever Forward) option to use the Forever Forward Incremental (FFI). This schedule offers one full backup followed by a limited number of incrementals. Once the limit is exceeded, a new full backup is created using in-cloud copying (synthetic full backup. Once you select this option, specify the FFI schedule for the backup plan. You can select the Daily or Monthly schedule type, depending on how often the incremental backups will be performed.

This schedule is unavailable if the selected storage account does not support synthetic full backups.

Advanced Schedule

Select the Advanced (GFS, Object Lock) option to set up a flexible, recurring schedule with generations. Every generation contains one full backup followed by incrementals.

The advanced schedule allows configuring a flexible schedule according to your requirements. To use this schedule you should add schedules for full and incremental backup runs:

  • To create incremental backups by schedule, select the Recurring (Incremental) checkbox, then configure the schedule for incremental backups on a daily or monthly basis.
  • To create full backups by schedule, select the Execute full backup (Synthetic full if possible) checkbox, then configure the schedule for full backups on a daily or monthly basis.

It is recommended to schedule full backup at least once every 3 months for selected schedule

| Top |

Retention Policy, GFS and Object Lock

Specify the retention policy settings for the backup plan. The retention policy depends on the schedule selected on the previous step.

Retention Policy with Simple Schedule

If you selected the Simple (Forever Forward Incremental) schedule, the Retention Policy step offers the following settings:

  • Keep backup for. Select this option to limit the number of restore points. The Keep backup for value defines the period Restore Points with the Forever Forward Incremental schedule are kept. If their retention period expires, these restore points are merged into a full backup (with Forever Forward Incremental only one full backup is kept on the backup storage).

For backup storages with a minimum storage duration limit and early deletion fees, this value can be exceeded to avoid the fees

  • Intelligent Retention: Each time the backup plan is executed, the backup storage parameters are analyzed automatically, setting the retention period based on storage provider data deletion conditions. This feature is enabled by default.

Learn more about the retention policy in the Retention Policy chapter chapter

Retention Policy with Advanced Schedule / No Schedule

If you selected the Advanced (GFS, Object Lock) schedule or to run backup manually without the schedule, the Retention Policy step offers the following settings:

  • Do not purge (Keep backup forever). Select this option to keep all your backup runs.
  • Keep backup for. Select this option to limit the period while backup contents are kept in the backup storage, then specify the period.

Learn more about the retention policy in the Retention Policy chapter chapter

To apply the GFS retention policy for the backup plan, select the Enable GFS checkbox, then customize the GFS retention policy by enabling the required keeping periods (weekly, monthly and yearly purge delays).

To learn more about the GFS retention policy, refer to the About GFS chapter

If backup data is required to be locked, enable the Object Lock (Immutability) checkbox. Before enabling Object Lock, you need to allow this feature for the backup destination.

To learn more about the Object Lock (Immutability) feature, refer to the Object Lock (Immutability) chapter

Click Next.

| Top |

Pre / Post Actions

Customize actions before and/or after the backup plan run.

Custom Scripts

You can execute custom scripts before or after running the backup plan.

  • To specify the script execution before the backup plan starts, select the Pre-backup action check box, then specify the path to the script in the field below. To open a standard Windows dialog box, click the ... button
  • Select the pre-backup script execution options:
    • Exit backup plan if pre-backup action failed. Select this option to cancel the backup plan in case the specified script fails
    • Continue backup plan if pre-backup action failed. Select this option to run the backup plan regardless of the specified script execution results
  • To specify the script execution after the backup plan terminates, select the Post-backup action check box, then specify the path to the script in the field below. To open a standard Windows dialog box, click the ... button
  • Select the post-backup script execution options:
    • Execute post-backup action only if backup plan has been successfully completed. Select this option to execute the post-backup script only in case of a backup plan success
    • Execute post-backup action regardless of the backup result. Select this option to execute the post-backup script in any case

Note that an absolute path to a script is required, i.e. if you specify the path to a script, it should be as follows:

c:\scripts\prebackup-script.bat

In case the absolute path to a script file is not specified, the default directory for script is "C:\Windows\System32"

The following script formats are supported: EXE, COM, BAT, CMD, or PIF

Mind that Backup Agent supports EXE files with several restrictions: EXE files must not use GUI and must close automatically upon termination.

For example, the following script will not succeed:

cmd.exe /F:ON

In this case, this command must be used with the /C parameter, as shown below:

cmd.exe /F:ON /C

The same restriction applies to applications executed by PowerShell scripts:

PowerShell.exe Start-Process cmd.exe exit

It is highly recommended to perform a test run for the created backup plan to ensure that Backup Agent properly executes specified scripts

Backup Plan Chains

In case you need to run another backup or restore plan once the backup plan is finished, use the Backup Chain feature. To create a backup chain, select the Backup chain check box, then select a backup or restore plan to be chained.

  • Execute the specified backup plan only if backup plan has been successfully completed. Select this option to execute the chained backup plan only in case of a backup plan success
  • Execute the specified backup plan regardless of the backup result. Select this option to execute the chained backup plan in any case
  • In case you chained a backup plan, you can enable the full backup for it regardless of the contents in the backup storage. To do this, select the Force full backup for the chained plan.

Click Next.

| Top |

Notification and Logging

Specify notification settings.

  • To receive the notification after the backup plan completion, select the I want to receive notification email when backup completes check box.
    • Select When backup fails option if you want to receive the notification message only in case of the backup plan failure
    • Select In all cases option if you want to receive the notification message in any case.
  • In the fields Username, Email, Email subject specify the notification email details. You can specify one or more email recipients. Separate them by semicolon or comma, the recipient name (one for all of them). The email subject can also contain any of the following variables:
  • %COMPUTER_NAME% Indicates the name of a computer on which the routine was running
  • %RESULT% Indicates whether the routine was finished successfully or failed

%RESULT% variable has the following values:

  • Completed. This value is assigned when the plan is terminated with success
  • Completed with warnings. This value is assigned when the plan is terminated with errors, warnings or has been interrupted
  • %PLAN_NAME% Indicates the backup plan's name.
  • If you want to use own SMTP server for notification emails, select the I want to use my SMTP server for email notifications check box, then specify the settings for the SMTP server
  • If you want the backup plan record to be added to Windows Event Log, select on Add entry to Windows Event Log when backup completes check box
    • Select When backup fails option if you want to receive the notification message only in case of the backup plan failure
    • Select In all cases option if you want the entry to be put in Windows Event Log in any case.

Click Next.

| Top |

Summary

Review the configuration of the backup plan.

Click Next to proceed to the last wizard page.

Select the Run backup now check box to run the backup plan immediately.

If you want to run the backup plan later, leave the Run backup now check box unselected, then click Finish.

Edit a Backup Plan

To edit the backup plan, proceed as follows:

  1. Switch to the Backup Plans tab.
  2. Open the backup plan you want to edit by expanding it, then click Edit.
  3. Proceed through the Backup Wizard steps to adjust settings as needed.
  4. If the plan is currently running, you'll need to select one of the following options:
    • Apply changes after the backup plan completes
    • Stop the plan and apply changes.
  5. After choosing the desired option for the running backup plan, click Apply.
  6. Save the edited plan configuration.

You can edit certain backup plan parameters directly, without using the backup wizard, as long as the backup plan is not currently running. Editable parameters are marked with a pencil icon. To make a quick edit, simply click the pencil icon next to the parameter

Delete a Backup Plan

To delete the backup plan, proceed as follows:

  1. Switch to the Backup Plans tab.
  2. Open the plan to delete, expand it, then click Delete.
  3. Confirm the backup plan deletion.

| Top |

https://git.cloudberrylab.com/egor.m/doc-help-mbs.git