Set-VBRJobVssOptions

Short Description

Applies custom VSS settings to a selected job.

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides the following parameter sets:

Manual (Default)

Set-VBRJobVssOptions [-Job] <CBackupJob[]> [-Options] <CGuestProcessingOptions> [<CommonParameters>]
Credentials

Set-VBRJobVssOptions [-Job] <CBackupJob[]> -Credentials <CCredentials> [<CommonParameters>]

Detailed Description

This cmdlet applies a set of customized VSS settings to a selected job.

To apply the set of customized settings you need to first create a CVssOptions object. This object unifies all the VSS options you want to apply to the job.

Run the New-VBRJobVssOptions cmdlet to create the CVssOptions object.

Run the Set-VBRJobObjectVssOptions cmdlet to apply VSS settings to specific VMs in job.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials you want to use for authenticating with the guest VM. Accepts the `CCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	True	Named	False
Job	Specifies the job you want to edit. Accepts the `CObjectInJob[]` object. To get this object, run the `Get-VBRJobObject` cmdlet.	`CBackupJob[]`	True	0	True (ByPropertyName, ByValue)
Options	Specifies the set of parameters you want to apply to the job. Accepts the `CGuestProcessingOptions` object. To get this object, run the `New-VBRJobVssOptions` cmdlet.	`CGuestProcessingOptions`	True	1	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Set-VBRJobVssOptions Example 1. Applying Custom VSS Options to Backup Job [Using Pipeline]

This example shows how to apply custom VSS options to the backup job named Backup Job 01.

$options = New-VBRJobVssOptions -ForJob

Get-VBRJob -Name "Backup Job 01" | Set-VBRJobVssOptions -Options $options

Perform the following steps:

Run the New-VBRJobVssOptions cmdlet. Provide the ForJob parameter. Save the result to the $options variable.
Run the Get-VBRJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Set-VBRJobVssOptions cmdlet. Set the $options variable as the Options parameter value.

Set-VBRJobVssOptions Example 2. Applying Custom VSS Options to Job [Using Variable]

This example shows how to apply custom VSS options to the job represented by the $job variable.

$job = Get-VBRJob

$options = New-VBRJobVssOptions

Set-VBRJobVssOptions -Job $job -Options $options

Perform the following steps:

Run the Get-VBRJob cmdlet. Save the result to the $job variable.
Run the New-VBRJobVssOptions cmdlet. Save the result to the $options variable.
Run the Set-VBRJobVssOptions cmdlet. Set the $job variable as the Job parameter value. Set the $options variable as the Options parameter value.