← Back to all articles

This guide covers creating a Hyper-V backup set in the backup software, for both cluster and non-cluster environments, along with the limitations that decide whether Hyper-V guest backup is the right approach at all.

Contents
  1. Cluster and non-cluster environments
  2. Creating the backup set
  3. Setting up the remaining cluster nodes
  4. Appendix: Hyper-V limitations
  5. Troubleshooting

Read the limitations first. Several common Hyper-V configurations — pass-through disks, VMs on SMB 3.0 shares, and VMs with replication enabled — cannot be backed up at guest level at all. Checking the appendix before you build the set will save you discovering it on the first backup run.

Cluster and non-cluster environments

There are two kinds of Hyper-V backup set, cluster and non-cluster. Which one you create is determined by the Version you select in step 3, so decide before you start. The screenshots throughout this guide are from a non-cluster set.

Non-cluster — a single Hyper-V host. The backup software runs on the host and backs up its guest VMs to your chosen destinations.

Cluster — two or more Hyper-V nodes sharing a Cluster Shared Volume. The software is installed on every node and the same backup set is configured on each, so that whichever node owns a VM at the time can back it up. There are two configurations: Active/Passive, where at least one node sits idle running no VMs or resources, and Active/Active, where all nodes are running VMs. Both are set up the same way.

Creating the backup set

  1. Click Backup Sets on the main interface of the backup software.

    Hyper-V backup set step

  2. Create a backup set by clicking the + icon beside “Add new backup set”.

    Hyper-V backup set step

  3. Enter a Name, then select MS Hyper-V Backup as the backup set type and choose the Version. Click Next to proceed.

    Hyper-V backup set step

    The Version is what determines whether this is a cluster or non-cluster backup set. Select the version marked (Failover Cluster) for a cluster environment, or the regular version for a single host.

    Hyper-V version selection showing the Failover Cluster option

    Note: the software detects the Hyper-V version installed on the host automatically, so the list reflects what is actually there. If the version you expect is missing, check that the Hyper-V role is installed and running on the machine where the software is installed.

  4. In the Backup Source window, select the guest VMs you want to back up. Click Next to proceed.

    Hyper-V backup set step

    You can select whole VMs or individual virtual disks. Selecting whole VMs is strongly preferred — restoring from an individual virtual disk backup carries significant restrictions, described in the appendix.

  5. In the Schedule window, edit the existing schedule or click Add to create one so backup jobs run automatically.

    Hyper-V backup set step

    Hyper-V backup set step

    Click OK when you are done with the settings, then Next to proceed.

  6. In the Destination window, click the + icon to add a storage destination, then select the Destination storage.

    Hyper-V backup set step

    Hyper-V backup set step

    Complete the settings for the destination you chose, click Test to validate it, then click OK.

    Hyper-V backup set step

    You can add multiple storage destinations. Backup data is uploaded to all of them, in the order you added them. Click Next to proceed.

  7. In the Encryption window, Encrypt Backup Data is enabled by default with an encryption key preset by the system, which provides the most secure protection. Click Next when you are done.

    Hyper-V backup set step

  8. If you enabled the encryption key feature in the previous step, the following pop-up window is shown, whichever encryption type you selected.

    Encryption key pop-up with the key masked

    • Unmask encryption key — the key is masked by default; click to show it.
    • Copy to clipboard — copies the encryption key so you can paste it somewhere of your choice.
    • Confirm — exits the pop-up and proceeds to the next step.

    Encryption key pop-up with the key shown

    Important: write the encryption key down and keep it somewhere safe. Without it your backup data cannot be restored, and we cannot recover it for you.

  9. Enter the Windows login credentials the software will use to authenticate the scheduled backup job.

    Hyper-V backup set step

    Note: if the backup schedule is turned off for this backup set, this screen is skipped. The credentials can be added or updated after the backup set has been created.

  10. Select the temporary directory for storing temporary files, then click Next to finish the setting.

    Hyper-V backup set step

    By default this is set to C:\Users\Administrator\.obm\temp. We strongly recommend changing it to another available drive — drive E: for example — and not the Windows system drive.

    In a cluster, do not point the temporary directory at the ClusterStorage disk. It will appear to work for backups, but granular restore fails with an error that cannot be worked around without changing this setting. Use a local directory on the node.

  11. This screen is displayed when the new backup set is created successfully.

    Hyper-V backup set step

  12. Optional: select your preferred compression type. Go to Others > Compressions, then choose from No Compression, Normal, Fast (compressed size larger than normal) or Fast with optimisation for local.

    Hyper-V backup set step

    Click Save to apply the changes.

Setting up the remaining cluster nodes

Skip this section for a non-cluster backup set. For a cluster, the backup set must now be configured on every other node in the cluster, otherwise VMs will only be backed up while they happen to be owned by the node you set up first.

  1. Click Close, then click on the Hyper-V backup set to complete the setup.

    Hyper-V backup set step

  2. Go to General and verify that the node has been added — the Owner field shows which node currently owns the set.

    General settings showing the cluster node owner

  3. On the next Hyper-V node, start the backup software and select the same Hyper-V backup set.

  4. Go to Backup Schedule, enable Run scheduled backup for this backup set, set the schedule time, and click Save.

    Enabling the backup schedule on the second cluster node

  5. Go to General and verify the node has been added.

    Repeat these steps for every node in the Hyper-V cluster.

Appendix: Hyper-V limitations

These are constraints of Hyper-V and the Microsoft VSS provider rather than of the backup software, so they apply however the backup is run. Check them before designing the backup set.

Backup limitations

LimitationDetail and workaround
VMs on SMB 3.0 sharesNot supported. Guest VMs whose files live on an SMB 3.0 share cannot be backed up at host level.
Pass-through disksNot supported. Where a physical disk is attached directly to a guest VM, the Microsoft Software Shadow Copy Provider cannot supply the VSS snapshot that a guest VM backup requires. Workaround: install the backup software inside the guest VM and back it up as an ordinary machine instead.
Replication enabledReplication must be disabled on any VM selected for backup. If it is left on, the backup job fails when it tries to take the VM snapshot — see Troubleshooting for the exact error.

Restore limitations

LimitationDetail
Hyper-V version must matchA guest VM can only be restored to a Hyper-V server running the same version. A VM backed up from Hyper-V 2012 R2 cannot be restored to Hyper-V 2008 R2, or the other way round.
The OS disk must be includedThe VM will not start if the virtual disk containing the guest operating system was not restored. When backing up selectively, make sure the system disk is always in the selection.
Individual virtual disksRestore of an individual virtual disk is only supported through the Restore raw file option, and only for a disk with no snapshots. It also requires editing the Hyper-V guest configuration files by hand — only attempt this with a solid understanding of Hyper-V, or the guest VM may not start properly.
Snapshot reversionWhere individual virtual disks were backed up, the restored VM cannot revert to a previous snapshot if that snapshot contains disks which were not themselves backed up.
Run DirectRun Direct restore is not supported for a VM containing VHDS shared virtual disks.

Taken together, these are a strong argument for backing up whole VMs rather than selected virtual disks. Most of the restrictions above only apply to individual-disk backups.

Granular restore limitations

Granular restore mounts a virtual disk so individual files and folders can be retrieved without restoring the whole VM. It has its own constraints:

Troubleshooting

SymptomCause and fix
Failed to take VM snapshot. Error = [CreateVirtualSystemSnapshotV2] Error="The method call failed." (32775)Replication is enabled on the VM being backed up. Disable replication for that VM and re-run the job.
A VM is missing from the Backup Source listUsually a pass-through disk or an SMB 3.0 share — neither can be backed up at host level. Install the backup software inside the guest instead.
The Hyper-V version you expect is not in the Version listThe software reads the version from the host. Check that the Hyper-V role is installed and running on the machine where the software is installed.
Granular restore fails immediately on a clusterThe temporary directory is set to the ClusterStorage disk. Change it to a local directory on the node.
Granular restore cannot see files inside the diskThe disk or the files are encrypted, or the guest is Linux or Unix. Restore the whole VM or disk instead.
VMs stop being backed up after a failoverThe backup set has not been configured on every cluster node. See Setting up the remaining cluster nodes.
A restored VM will not startEither the disk holding the guest operating system was not included in the restore, or the target Hyper-V version differs from the source.
Backups fail with insufficient disk spaceThe temporary directory is still on drive C. See step 10.

If you need a hand with any of the above, contact us at support@bobcloud.net.