Set-VBRJobAdvancedViOptions

In this article

    Short Description

    Customizes VMware job settings.

    Applies to

    Platform: VMware

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

    Syntax

    Set-VBRJobAdvancedViOptions -Job <CBackupJob[]> [-ExcludeSwapFile [<Boolean>]] [-VmAttributeName <String>] [-SetResultsToVmAttribute [<Boolean>]] [-EnableChangeTracking [<Boolean>]] [-UseChangeTracking [<Boolean>]] [-VMToolsQuiesce [<Boolean>]] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet sets special options for the selected VMware job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the array of jobs. The cmdlet will modify advanced VMware backup options of these jobs.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    ExcludeSwapFile

    If set to TRUE, the swap file will be excluded from backup.

    Default: TRUE.

    False

    Named

    False

    False

    VmAttributeName

    Specifies the custom attributes field name.

    False

    Named

    False

    False

    SetResultsToVmAttribute

    If set to TRUE, the job results will be written to custom attributes field of the VM.

    False

    Named

    False

    False

    EnableChangeTracking

    If set to TRUE, the changed block tracking will be enabled.

    Default: TRUE.

    False

    Named

    False

    False

    UseChangeTracking

    If set to TRUE, the changed block tracking will be used even if CBT is disabled on the ESXi host.

    Default: TRUE.

    False

    Named

    False

    False

    VMToolsQuiesce

    If set to TRUE, the VMware quiescence mechanism will be enabled. Use this mechanism if the application-aware processing cannot be used.

    Default: FALSE.

    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 VMware quiescence is enabled.
    • The changed block data is enabled.
    • The CBT is forced to use despite the ESX host settings.
    • The swap file is excluded form backup.

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

    Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedViOptions -VMToolsQuiesce $True -EnableChangeTracking $True -UseChangeTracking $True -ExcludeSwapFile $True

    Related Commands

    Get-VBRJob