Short Description
Modifies VSS settings for the selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets:
- For modifying the job VSS settings
Set-VBRJobVssOptions [-Job] <CBackupJob[]> [-Options] <CGuestProcessingOptions> [<CommonParameters>] |
- For modifying the guest OS credentials
Set-VBRJobVssOptions [-Job] <CBackupJob[]> -Credentials <CCredentials> [<CommonParameters>] |
Detailed Description
This cmdlet modifies VSS settings for the selected job.
Run Set-VBRJobObjectVssOptions to apply VSS settings to specific VMs in job.
To modify settings enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Job | Specifies the job you want to edit. | True | 1 | True (ByValue, | 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 |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This example shows how to apply new VSS settings for an existing backup job.
- Run Get-VBRJob to specify the job. Save the result to the $job variable.
- Run New-VBRJobVssOptions to specify the VSS options. Save the result to the $options variable.
- Run Set-VBRJobVssOptions with the $job and $options variables.
PS C:\PS> $job = Get-VBRJob -Name "Backup Job 01" PS C:\PS> $options = New-VBRJobVssOptions -ForJob PS C:\PS> Set-VBRJobVssOptions -Job $job -Options $options |
Example 2
This example shows how to apply new guest OS credentials for an existing backup job.
- Run Get-VBRJob to specify the job. Save the result to the $job variable.
- Run Get-VBRCredentials to specify the new credentials you want to use for authenticating with the guest VMs. Save the result to the $ccreds variable.
- Run Set-VBRJobVssOptions with the $job and $options variables.
PS C:\PS> $job = Get-VBRJob -Name "Backup Job 01" PS C:\PS> $ccreds = Get-VBRCredentials PS C:\PS> Set-VBRJobVssOptions -Job $job -Credential $ccreds |
Related Commands
