Contact Info

Crumbtrail » Administration » Powershell » Powershell 3.0 » Set-ScheduledJobOption

Set-ScheduledJobOption - Powershell 3.0 CmdLet

ActiveXperts Network Monitor ships with integrated Powershell scripts to monitor complex network. The scripts run out of the box
Download the ActiveXperts Network Monitor FREE version now »


Short description
Changes the job options of a scheduled job.

Set-ScheduledJobOption [-InputObject] <ScheduledJobOptions> [-ContinueIfGoingOnBattery] [-DoNotAllowDemandStart] [-Hide
InTaskScheduler] [-IdleDuration <TimeSpan>] [-IdleTimeout <TimeSpan>] [-MultipleInstancePolicy <TaskMultipleInstancePol
icy>] [-PassThru] [-RequireNetwork] [-RestartOnIdleResume] [-RunElevated] [-StartIfIdle] [-StartIfOnBattery] [-StopIfGo
ingOffIdle] [-WakeToRun] [<CommonParameters>]

The Set-ScheduledJobOptions cmdlet changes the job options of scheduled jobs.

To change the options of a scheduled job, begin by using the Get-ScheduledJobOption cmdlet to get the job options of a 
scheduled job. Then, pipe the options to Set-ScheduledJobOption or save the options in a variable and use the InputObje
ct parameter of Set-ScheduledJobOption cmdlet to identify the options. Use the remaining parameters of Set-ScheduledJob
Option to change the job options.

To turn on a job option, use the parameter that sets that option. To turn off an option, type the parameter name, a col
on (:), and $false. For example, to turn off the RunElevated option, type -RunElevated:$false.

Each job options object includes a JobDefinition property that contains the scheduled job, so the association with the 
scheduled job is retained when the job options are changed.

The scheduled job options determine how the job runs when it is started by Task Scheduler. These options to not apply w
hen you use the Start-Job cmdlet to start a scheduled job.

Set-ScheduledJobOption is one of a collection of job scheduling cmdlets in the PSScheduledJob module that is included i
n Windows PowerShell.

For more information about Scheduled Jobs, see the About topics in the PSScheduledJob module. Import the PSScheduledJob
 module and then type: Get-Help about_Scheduled* or see about_Scheduled_Jobs.

This cmdlet is introduced in Windows PowerShell 3.0.