Set-VBRJobScriptOptions

Short Description

Modifies job script options.

Applies to

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

Syntax

Set-VBRJobScriptOptions [-Day {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-Frequency <UInt32>] -JobScriptOptions <VBRJobScriptOptions> [-Periodicity {Cycles | Days}] [-PostCommand <String>] [-PostScriptEnabled] [-PreCommand <String>] [-PreScriptEnabled]  [<CommonParameters>]

Detailed Description

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

To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

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

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

JobScriptOptions

Specifies the script options that you want to modify.

Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet.

True

Named

False

PreScriptEnabled

Indicates that you want to run a script before the job.

SwitchParameter

False

Named

False

PreCommand

For the PreScriptEnabled parameter.

Specifies the path to the pre-job script.

String

False

Named

False

PostScriptEnabled

Indicates that you want to run a script after the job.

SwitchParameter

False

Named

False

PostCommand

For the PostScriptEnabled parameter.

Specifies the path to the post-job script.

String

False

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

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

<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:

  1. Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Save the ScriptOptions property of the $job variable to the $scriptOptions variable.
  3. Run the Set-VBRJobScriptOptions cmdlet. Specify the following settings:
  • Set the $scriptOptions variable as the JobScriptOptions parameter value.
  • Specify the Periodicity parameter value.
  • Specify the Day parameter value.

Save the result to the $newScriptOptions variable.

  1. Run the Set-VBRComputerBackupJob cmdlet. Set the $job variable as the Job parameter value. Set the $newScriptOptions variable as the ScriptOptions parameter value.

Related Commands