New-ScheduledJobOption

Syntax

New-ScheduledJobOption
   [-RunElevated]
   [-HideInTaskScheduler]
   [-RestartOnIdleResume]
   [-MultipleInstancePolicy <TaskMultipleInstancePolicy>]
   [-DoNotAllowDemandStart]
   [-RequireNetwork]
   [-StopIfGoingOffIdle]
   [-WakeToRun]
   [-ContinueIfGoingOnBattery]
   [-StartIfOnBattery]
   [-IdleTimeout <TimeSpan>]
   [-IdleDuration <TimeSpan>]
   [-StartIfIdle]
   [<CommonParameters>]

Description

Cmdleten New-ScheduledJobOption skapar ett objekt som innehåller avancerade alternativ för ett schemalagt jobb.

Du kan använda objektet ScheduledJobOptions som New-ScheduledJobOption returnerar för att ange jobbalternativ för ett nytt eller befintligt schemalagt jobb. Du kan också ange jobbalternativ med hjälp av cmdleten Get-ScheduledJobOption för att hämta jobbalternativen för ett befintligt schemalagt jobb eller genom att använda ett hashtabellvärde för att representera jobbalternativen.

Utan parametrar genererar New-ScheduledJobOption ett objekt som innehåller standardvärdena för alla alternativ. Eftersom alla egenskaper förutom egenskapen JobDefinition kan redigeras kan du använda det resulterande objektet som en mall och skapa standardalternativobjekt för företaget.

När du skapar schemalagda jobb och anger alternativ för schemalagt jobb granskar du standardvärdena för alla schemalagda jobbalternativ. Schemalagda jobb körs endast när alla villkor som angetts för körningen är uppfyllda.

New-ScheduledJobOption är en av en samling cmdletar för jobbschemaläggning i modulen PSScheduledJob som ingår i Windows PowerShell.

Mer information om schemalagda jobb finns i Avsnittet om i modulen PSScheduledJob. Importera modulen PSScheduledJob och skriv sedan: Get-Help about_Scheduled* eller se about_Scheduled_Jobs.

Den här cmdleten introducerades i Windows PowerShell 3.0.

Exempel

Exempel 1: Skapa ett schemalagt jobbalternativobjekt med standardvärden

PS C:\> New-ScheduledJobOption
StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : True
DoNotAllowDemandStart  : False
MultipleInstancePolicy : Ignore
NewJobDefinition       :

Det här kommandot skapar ett schemalagt jobbalternativobjekt som har alla standardvärden.

Exempel 2: Skapa ett schemalagt jobbalternativobjekt med anpassade värden

PS C:\> New-ScheduledJobOption -RequireNetwork -StartIfOnBattery
StartIfOnBatteries     : True
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : False
DoNotAllowDemandStart  : False
MultipleInstancePolicy : Ignore
NewJobDefinition       :

Följande kommando skapar ett schemalagt jobbobjekt som kräver nätverket och kör det schemalagda jobbet även om datorn inte är ansluten till växelström.

Utdata visar att parametern RequireNetwork ändrade värdet för egenskapen RunWithoutNetwork till $False och parametern StartIfOnBattery ändrade värdet för egenskapen StartIfOnBatteries till $True.

Exempel 3: Ange alternativ för ett nytt schemalagt jobb

The first command creates a **ScheduledJobOptions** object with the *RunElevated* parameter. It saves the object in the $RunAsAdmin variable.
PS C:\> $RunAsAdmin = New-ScheduledJobOption -RunElevated

The second command uses the Register-ScheduledJob cmdlet to create a new scheduled job. The value of the *ScheduledJobOption* parameter is the option object in the value of the $RunAsAdmin variable.
PS C:\> Register-ScheduledJob -Name Backup -FilePath D:\Scripts\Backup.ps1 -Trigger $Mondays -ScheduledJobOption $RunAsAdmin

The third command uses the Get-ScheduledJobOption cmdlet to get the job options of the Backup scheduled job.The cmdlet output shows that the RunElevated property is set to $True and the JobDefinition property of the job option object is now populated with the scheduled job object for the Backup scheduled job.
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 : IgnoreNew
JobDefinition          : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Det här exemplet visar hur du använder objektet ScheduledJobOptions som New-ScheduledJobOption returnerar för att ange alternativen för ett nytt schemalagt jobb.

Exempel 4: Sortera egenskaperna för ett schemalagt jobbalternativobjekt

PS C:\> $Options = New-ScheduledJobOption -WakeToRun
PS C:\> $Options.PSObject.Properties | Sort-Object -Property Name | Format-Table -Property Name, Value -Autosize
Name                       Value
----                       -----
DoNotAllowDemandStart      False
IdleDuration            00:10:00
IdleTimeout             01:00:00
JobDefinition
MultipleInstancePolicy IgnoreNew
RestartOnIdleResume        False
RunElevated                False
RunWithoutNetwork           True
ShowInTaskScheduler         True
StartIfNotIdle              True
StartIfOnBatteries         False
StopIfGoingOffIdle         False
StopIfGoingOnBatteries      True
WakeToRun                   True

Det här exemplet visar hur du sorterar egenskaperna för ett ScheduledJobOptions objekt i alfabetisk ordning för enkel läsning.

Det första kommandot använder cmdleten New-ScheduledJobOption för att skapa ett ScheduledJobOptions-objekt. Kommandot använder parametern WakeToRun och sparar det resulterande objektet i variabeln $Options.

För att hämta egenskaperna för $Options som objekt använder det andra kommandot egenskapen PSObject för alla Windows PowerShell-objekt och dess egenskap Egenskaper. Kommandot dirigerar sedan egenskapsobjekten till cmdleten Sort-Object, som sorterar egenskaperna i alfabetisk ordning efter namn och sedan till cmdleten Format-Table, som visar egenskapernas namn och värden i en tabell.

Det här formatet gör det mycket enklare att hitta egenskapen WakeToRun för objektet ScheduledJobOptions i $Options och kontrollera att dess värde har ändrats från $False till $True.

Parametrar

-ContinueIfGoingOnBattery

-DoNotAllowDemandStart

-HideInTaskScheduler

-IdleDuration

-IdleTimeout

-MultipleInstancePolicy

-RequireNetwork

-RestartOnIdleResume

-RunElevated

-StartIfIdle

-StartIfOnBattery

-StopIfGoingOffIdle

-WakeToRun

Indata

None

Du kan inte skicka indata till den här cmdleten.

Utdata

ScheduledJobOptions

Kommentarer

• Du kan använda objektet ScheduledJobOptions som New-ScheduledJobOption skapar som värdet för parametern ScheduledJobOption i cmdleten Register-ScheduledJob. Parametern ScheduledJobOption kan dock också ha ett hash-tabellvärde som anger egenskaperna för objektet ScheduledJobOptions och deras värden, till exempel:

  @{ShowInTaskScheduler=$False; RunElevated=$True; IdleDuration="00:05"}

Relaterade länkar

• 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