Set-VBRJobScriptOptions

Short Description

Modifies job script options.

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

Syntax

Set-VBRJobScriptOptions -JobScriptOptions <VBRJobScriptOptions> [-PreScriptEnabled] [-PreCommand <String>]

[-PostScriptEnabled] [-PostCommand <String>] [-Day <DayOfWeek[]>] [-Periodicity <VBRPeriodicityType>]

[-Frequency <UInt32>] [<CommonParameters>]

Detailed Description

This cmdlet modifies pre-job and post-job script settings for backup jobs and for replication jobs.

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
Day	For the `Days` option. Specifies the days of the week when the script must run.	`DayOfWeek[]`	False	Named	False
Frequency	For the `Cycles` option. Specifies the number of backup sessions after which the script must run.	`UInt32`	False	Named	False
JobScriptOptions	Specifies the script options that you want to modify. Accepts the `VBRJobScriptOptions` object. To create this object, run the `New-VBRJobScriptOptions` cmdlet.	`VBRJobScriptOptions`	True	Named	False
Periodicity	Specifies the script run schedule: `Cycles`: use this option to run scripts after the specified number of backup sessions. `Days`: use this option to run scripts on the selected days. Use the `Day` and the `Frequency` parameters to set the values.	`VBRPeriodicityType`	False	Named	False
PostCommand	For the `PostScriptEnabled` parameter. Specifies the path to the post-job script.	`String`	False	Named	False
PostScriptEnabled	Defines that you want to run a script after the job.	`SwitchParameter`	False	Named	False
PreCommand	For the `PreScriptEnabled` parameter. Specifies the path to the pre-job script.	`String`	False	Named	False
PreScriptEnabled	Defines that you want to run a script before the job.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRJobScriptOptions object that contains job script options.

Examples

Modifying Script Options [Using Variable]

This example shows how to get the script options for a computer backup job, save them to a variable, then modify the script options and re-save them to the variable.

$job = Get-VBRComputerBackupJob -Name "Backup Job"

$scriptOptions = $job.ScriptOptions

$newScriptOptions = Set-VBRJobScriptOptions -JobScriptOptions $scriptOptions -Periodicity Days -Day Thursday

Set-VBRComputerBackupJob -Job $job -ScriptOptions $newScriptOptions

Perform the following steps:

Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Save the ScriptOptions property of the $job variable to the $scriptOptions variable.
Run the Set-VBRJobScriptOptions cmdlet. Specify the following settings:
- Set the $scriptOptions variable as the JobScriptOptions parameter value.
- Set the Days option for the Periodicity parameter.
- Specify the Day parameter value.
Save the result to the $newScriptOptions variable.
Run the Set-VBRComputerBackupJob cmdlet. Set the $job variable as the Job parameter value. Set the $newScriptOptions variable as the ScriptOptions parameter value.