INCLUDE.VMSNAPSHOTATTEMPTS

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.

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.

Only one virtual machine can be specified on each INCLUDE.VMSNAPSHOTATTEMPTS statement. However, to configure the total snapshot attempts for other virtual machines, you can use the following methods:

• For each virtual machine that you want this option to apply to, specify as many INCLUDE.VMSNAPSHOTATTEMPTS statements as needed to reattempt snapshots that failed.
• Use wildcard characters for the vmname parameter value to specify virtual machine names that match the wildcard pattern. An asterisk (*) matches any character string. A question mark (?) matches a single character. If the virtual machine name contains a space character, enclose the name in double quotation marks (").

Tip: If the virtual machine name contains special characters, type the question mark wildcard (?) in place of the special characters when you specify the virtual machine 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. An include.vmsnapshotattempts 0 0 entry is not valid. Backup operations require at least one snapshot.