This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRJobOptions
Short Description
Applies custom job settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobOptions [-Job] <CBackupJob[]> [-Options] <CJobOptions> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet applies a set of customized settings to a selected job.
To apply the set of customized settings you need to first create a CJobOptions object which unifies all the options you want to apply to the job. The CJobOptions object is created with the New-VBRJobOptions cmdlet.
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 |
<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 command applies custom settings 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 options is obtained with New-VBRJobOptions and assigned to the $options variable beforehand.
PS C:\PS> Get-VBRJob -Name "Backup Job 01" | Set-VBRJobOptions -Options $options |
Example 2
This command applies custom settings to the backup job represented by the $job variable. The job object is obtained with Get-VBRJob andassigned to the variable beforehand. The object containing the set of customized options is obtained with New-VBRJobOptions and assigned to the $options variable beforehand.
PS C:\PS> Set-VBRJobOptions -Job $job -Options $options |