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

Set-VBRJobVssOptions

Short Description

Applies custom VSS settings to a selected job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

-OR-

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

Detailed Description

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

This cmdlet provides two parameter sets:

Applying changes to the job VSS settings.

To apply the set of customized settings you need to first create a CVssOptions object which unifies all the VSS options you want to apply to the job. The CVssOptions object is created with the help of the New-VBRJobVssOptions cmdlet.

Set credentials for the guest OS.

To set the credentials, specify the credentials you want to use for the VMs in the job. The credentials will be used for all VMs in the job.

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

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Job	Specifies the job you want to edit.	True	1	True (ByValue, ByProperty Name)	False
Options	Specifies the set of parameters you want to apply to the job.	True	2	False	False
Credential	Specifies the credentials you want to use for authenticating with the guest VM.	True	Named	False	False

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

Example 1

This command applies custom VSS options to the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions and assigned to the $options variable beforehand.

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

Example 2

This command applies custom VSS options to the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions and assigned to the $options variable beforehand.

Set-VBRJobVssOptions -Job $job -Options $options

Related Commands

Get-VBRJob

New-VBRJobVssOptions

Get-VBRCredentials