INCLUDE.VMSNAPSHOTATTEMPTS
Use the INCLUDE.VMSNAPSHOTATTEMPTS option to determine the total number of snapshot attempts to try for a virtual machine (VM) backup operation that fails due to snapshot failure.
Supported Clients
This option can be used with supported Windows clients that are configured to back up VMs on Hyper-V hosts that run on Windows Server 2016 operating systems.
Options File
This option is valid in the client options file (dsm.opt). It can also be included on the server in a client option set. It is not valid on the command line.
Syntax
Parameters
- vmname
- A required positional parameter that specifies the name of the virtual machine to attempt the total number of snapshots for, if a backup attempt fails due to snapshot failure. The name is the virtual machine display name.
- num_with_quiescing
-
A positional parameter that specifies the following action:
- For Hyper-V RCT backup operations:
- The num_with_quiescing parameter specifies the number of times to attempt
snapshots with quiescing to create application-consistent backups.
You can specify a value in the range 0 - 10. The default value is 2.
- num_without_quiescing
-
- For Hyper-V RCT backup operations:
- The num_without_quiescing option specifies the number of times to attempt
snapshots without quiescing after the specified number of attempts in the
num_with_quiescing option are completed.
You can specify a value in the range 0 - 10. The default value is 0.
Important: When this parameter is applied to a VM backup, the backup is considered crash-consistent. As a result, operating system, file system, and application consistency are not guaranteed. Aninclude.vmsnapshotattempts 0 0
entry is not valid. Backup operations require at least one snapshot.
Examples
Hyper-V examples:
- Example 1
- Specify the following statement in the client options file to make two total snapshot attempts
at crash-consistent backups for all Hyper-V VMs that begin with
LinuxVM
:INCLUDE.VMSNAPSHOTATTEMPTS LinuxVM* 0 2
- Example 2
- Specify the following statement in the client options file to try three snapshot attempts for
virtual machine VM1: two application-consistent snapshot attempts, and if they fail, to try one
crash-consistent snapshot attempt:
INCLUDE.VMSNAPSHOTATTEMPTS VM1 2 1