This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRJobAdvancedHvOptions

On This Page

Short Description
Applies to
Syntax
Detailed Description
Parameters
Example

Short Description

Customizes Hyper-V job settings.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRJobAdvancedHvOptions -Job <CBackupJob[]> [-CanDoCrashConsistent <bool>] [-EnableHvQuiescence <bool>] [-UseChangeTracking <bool>] [-ExcludeSwapFile <bool>] [<CommonParameters>]

Related Commands

Get-VBRJob

Detailed Description

This cmdlet sets special options for the selected Hyper-V job.

In case you cannot use application-aware image processing, you can enable a Hyper-V quiescence mechanism to backup data that can be changed during the backup.

Read more about Hyper-V job settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Job	Specifies the job you want to edit. You can assign multiple jobs to this object.	True	Named	True (ByValue, ByProperty Name)	False
CanDoCrash Consistent	If set to TRUE, the crash consistent backup will be enabled. Otherwise the VM will be suspended for a short period of time. Default: FALSE.	False	Named	False	False
EnableHv Quiescence	If set to TRUE, the Hyper-V quiescence mechanism will be enabled. Use this mechanism if the application-aware image processing cannot be used. Default: FALSE.	False	Named	False	False
UseChange Tracking	If set to TRUE, the changed block tracking will be enabled. Default: TRUE.	False	Named	False	False
Exclude SwapFile	If set to TRUE, the swap file will be excluded from backup. Default: TRUE.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example

This command edits advanced job settings to backup job named "Backup Job 01":

The Hyper-V quiescence is enabled.
The crash consistent backup is enabled.
The changed block data is enabled.
The swap file is excluded form backup.

The job is obtained with Get-VBRJob and piped down.

PS C:\PS> Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedHvOptions -EnableHvQuiescence -CanDoCrashConsistent -UseChangeTracking -ExcludeSwapFile