Set-VBRJobAdvancedHvOptions

In this article

    Short Description

    Customizes Hyper-V job settings.

    Applies to

    Platform: Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

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

    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 array of jobs. The cmdlet will modify advanced Hyper-V backup options of these jobs.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    CanDoCrashConsistent

    Indicates that the job will be able to create crash consistent backup.

    False

    Named

    False

    False

    EnableHvQuiescence

    Indicates that the job will use the Hyper-V quiescence mechanism.

    False

    Named

    False

    False

    UseChangeTracking

    Indicates that the job will use the changed block tracking.

    False

    Named

    False

    False

    ExcludeSwapFile

    Indicates that the job will exclude the swap file from backup.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    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.

    Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedHvOptions -EnableHvQuiescence $True -CanDoCrashConsistent $True -UseChangeTracking $True -ExcludeSwapFile $True

    Related Commands

    Get-VBRJob