Get-ScheduledJobOption

Gets the job options of scheduled jobs.

Parameter Set: JobDefinition
Get-ScheduledJobOption [-InputObject] <ScheduledJobDefinition> [ <CommonParameters>]

Parameter Set: JobDefinitionId
Get-ScheduledJobOption [-Id] <Int32> [ <CommonParameters>]

Parameter Set: JobDefinitionName
Get-ScheduledJobOption [-Name] <String> [ <CommonParameters>]

The Get-ScheduledJobOption cmdlet gets the job options of scheduled jobs. You can use this command to examine the job options or to pipe the job options to other cmdlets.

Job options are not saved to disk independently; they are part of a scheduled job. To get the job options of a scheduled job, specify the scheduled job.

Use the parameters of the Get-ScheduledJobOption cmdlet to identify the scheduled job. You can identify scheduled jobs by their names or identification numbers, or by entering or piping ScheduledJob objects, such as the those that are returned by the Get-ScheduledJob cmdlet, to Get-ScheduledJobOption.

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

This cmdlet is introduced in Windows PowerShell 3.0.

-Id<Int32>

Specifies the identification number of a scheduled job. Get-ScheduledJobOption gets the job options of the specified scheduled job.

To get the identification numbers of scheduled jobs on the local computer or a remote computer, use the Get-ScheduledJob cmdlet.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InputObject<ScheduledJobDefinition>

Specifies a scheduled job. Enter a variable that contains a ScheduledJob object or type a command or expression that gets a ScheduledJob object, such as a Get-ScheduledJob command. You can also pipe a ScheduledJob object to Get-ScheduledJobOption.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Name<String>

Specifies the names of scheduled jobs. Get-ScheduledJobOption gets the job options of the specified scheduled job. Wildcards are supported.

To get the names of scheduled jobs on the local computer or a remote computer, use the Get-ScheduledJob cmdlet.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	true

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

The input type is the type of the objects that you can pipe to the cmdlet.

Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition
You can pipe a scheduled job from Get-ScheduledJob to Get-ScheduledJobOption.

The output type is the type of the objects that the cmdlet emits.

Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Example 1: Get job options

This command gets the job options of scheduled jobs that have "BackUp" in their names. The results show the job options object that Get-ScheduledJobOption returned.

PS C:\> Get-ScheduledJobOption -Name *Backup*

StartIfOnBatteries     : False

StopIfGoingOnBatteries : True

WakeToRun              : False

StartIfNotIdle         : True

StopIfGoingOffIdle     : False

RestartOnIdleResume    : False

IdleDuration           : 00:10:00

IdleTimeout            : 01:00:00

ShowInTaskScheduler    : True

RunElevated            : True

RunWithoutNetwork      : True

DoNotAllowDemandStart  : False

MultipleInstancePolicy : Ignore

NewJobDefinition       : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Example 2: Get all job options

This command gets the job options of all scheduled jobs on the local computer.

It uses the Get-ScheduledJob cmdlet to get the scheduled jobs on the local computer. A pipeline operator (|) sends the scheduled jobs to the Get-ScheduledJobOptions cmdlet, which gets the job options of each scheduled job.

PS C:\> Get-ScheduledJob | Get-ScheduledJobOptions

Example 3: Get selected job options

This example shows how to find job options object with particular values.

The first command gets job options in which the RunElevated property has a value of "True" ($true) and the RunWithoutNetwork property has a value of "False" ($false) The output shows the job options object that was selected.

PS C:\> Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun}

StartIfOnBatteries     : False

StopIfGoingOnBatteries : True

WakeToRun              : True

StartIfNotIdle         : True

StopIfGoingOffIdle     : False

RestartOnIdleResume    : False

IdleDuration           : 00:10:00

IdleTimeout            : 01:00:00

ShowInTaskScheduler    : True

RunElevated            : True

RunWithoutNetwork      : True

DoNotAllowDemandStart  : False

MultipleInstancePolicy : Ignore

NewJobDefinition       : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

The second command shows how to find to which scheduled job the job options belong. This command uses a pipeline operator (|) to send the selected job options to the ForEach-Object cmdlet which gets the JobDefinition property of each options object. The JobDefinition property contains the originating job object.

The results show that the selected options came from the "DeployPkg" scheduled job.

PS C:\> Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun} | ForEach-Object {$_.JobDefinition}

Id         Name            Triggers        Command                                  Enabled

--         ----            --------        -------                                  -------

2          DeployPkg         {1, 2}        DeployPackage.ps1                        True

Example 4: Use job options to create a new job

This example shows how to use the job options that Get-ScheduledJobOptions gets in a new scheduled job.

The first command uses Get-ScheduledJobOptions to get the jobs options of the BackupTestLogs scheduled job. The command saves the options in the $Opts variable.

The second command uses Register-ScheduledJob cmdlet to create a new scheduled job. The value of the ScheduledJobOption parameter is the options object in the $Opts variable.

PS C:\> $Opts = Get-ScheduledJobOption -Name BackupTestLogs
PS C:\>Register-ScheduledJob –Name Archive-Scripts -FilePath \\Srv01\Scripts\ArchiveScripts.ps1 -ScheduledJobOption $Opts

Example 5: Get job options from a remote computer

This command uses the Invoke-Command cmdlet to get the scheduled job options of the DataDemon job on the Srv01 computer. The command saves the options in the $o variable.

PS C:\> $o = Invoke-Command -ComputerName Srv01 -ScriptBlock {Get-ScheduledJob -Name DataDemon }

about_Scheduled_Jobs

Add-JobTrigger

Disable-JobTrigger

Disable-ScheduledJob

Enable-JobTrigger

Enable-ScheduledJob

Get-JobTrigger

Get-ScheduledJob

Get-ScheduledJobOption

New-JobTrigger

New-ScheduledJobOption

Register-ScheduledJob

Remove-JobTrigger

Set-JobTrigger

Set-ScheduledJob

Set-ScheduledJobOption

Unregister-ScheduledJob

Get-ScheduledJobOption