New-VBRJobScriptOptions
Short Description
Creates a new VBRJobScriptOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRJobScriptOptions [-PreScriptEnabled] [-PreCommand <string>] [-PostScriptEnabled] [-PostCommand <string>] [-Day <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-Periodicity <VBRPeriodicityType> {Cycles | Days}] [-Frequency <uint32>] [<CommonParameters>] |
Related Commands
None
Return Type
Detailed Description
This cmdlet creates a new VBRJobScriptOptions object. This object contains settings for running pre-job and post-job scripts and is used further to apply these settings to an existing job.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
PreScript | Indicates that running a script before the job is enabled (true) or disables (false). Use the PreCommand parameter to set the path to the script. | False | Named | False | False |
PreCommand | Specifies the path to the script that must run before the job. | False | Named | False | False |
PostScript | Indicates that running a script after the job is enabled (true) or disables (false). Use the PostCommand parameter to set the path to the script. | False | Named | False | False |
PostCommand | Specifies the path to the script that must run after the job. | False | Named | False | False |
Day | Used to set value for the Periodicity parameter (the Days mode). The days of week when the script must run. | False | Named | False | False |
Periodicity | Specifies the script run mode: after a set number of job runs (Cycles) or on set days (Days). Use the Day and the Frequency parameters to set the values. | False | Named | False | False |
Frequency | Used to set value for the Periodicity parameter (the Cycles mode). The number of job runs after which the script must run. | False | 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.