Set-ScheduledJobOption

Změní možnosti úlohy naplánované úlohy.

Syntax

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

Description

Rutina Set-ScheduledJobOptions změní možnosti úlohy naplánovaných úloh.

Pokud chcete změnit možnosti naplánované úlohy, začněte pomocí Get-ScheduledJobOption rutiny a získejte možnosti úlohy naplánované úlohy. Potom pomocí parametru InputObject rutiny určete možnosti Set-ScheduledJobOption nebo je uložte do proměnné a pomocí parametru Set-ScheduledJobOptionInputObject rutiny identifikujte tyto možnosti. Ke změně možností úlohy použijte zbývající parametry Set-ScheduledJobOption .

Pokud chcete zapnout možnost úlohy, použijte parametr, který tuto možnost nastaví. Pokud chcete možnost vypnout, zadejte název parametru, dvojtečku (:) a $false. Pokud chcete například vypnout možnost RunElevated , zadejte -RunElevated:$false.

Každý objekt možností úlohy obsahuje vlastnost JobDefinition, která obsahuje naplánovanou úlohu, takže přidružení k naplánované úloze se zachová při změně možností úlohy.

Možnosti naplánované úlohy určují, jak se úloha spouští při spuštění plánovačem úloh. Tyto možnosti se neaplikují při spuštění naplánované úlohy pomocí Start-Job rutiny.

Set-ScheduledJobOptionje jednou z kolekcí rutin plánování úloh v modulu PSScheduledJob, který je součástí Windows PowerShell.

Další informace o naplánovaných úlohách najdete v tématu Témata v modulu PSScheduledJob. Importujte modul PSScheduledJob a zadejte: Get-Help about_Scheduled* nebo si prohlédněte about_Scheduled_Jobs.

Tato rutina byla zavedena v Windows PowerShell 3.0.

Příklady

Příklad 1: Změna možností úlohy

Get-ScheduledJobOption -Name "DeployPackage"

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      : False
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNew
JobDefinition          :

Get-ScheduledJobOption -Name "DeployPackage" |
    Set-ScheduledJobOption -WakeToRun -RequireNetwork:$false -Passthru

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : True
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : True
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNewJobDefinition          :

Tento příklad ukazuje, jak změnit možnosti naplánované úlohy na místním počítači.

První příkaz použije rutinu Get-ScheduledJobOption k získání možností úlohy naplánované úlohy DeployPackage. Výstup ukazuje, že vlastnosti WakeToRun a RunElevated jsou nastaveny na $false.

Druhý příkaz používá rutinu Set-ScheduledJobOpton ke změně možností úlohy, aby hodnoty vlastností WakeToRun a RunWithoutNetwork byly $True. Příkaz použije parametr Passthru k vrácení triggeru po změně.

Tento příkaz není povinný; je zahrnuta pouze k zobrazení efektu změny možnosti.

Příklad 2: Změna možnosti u všech vzdálených naplánovaných úloh

Invoke-Command -Computer "Server01" -ScriptBlock {
    Get-ScheduledJob |
        Get-ScheduledJobOption |
        Set-ScheduledJobOption -IdleTimeout 2:00:00
}

Tento příkaz změní hodnotu IdleTimeout z jedné hodiny (výchozí hodnota) na dvě hodiny u všech naplánovaných úloh na počítači Server01.

Příkaz používá Invoke-Command rutinu ke spuštění příkazu na počítači Serveru01.

Vzdálený příkaz začíná příkazem Get-ScheduledJob , který získá všechny naplánované úlohy v počítači. Naplánované úlohy se předávají rutině Get-ScheduledJobOption , což získá možnosti úlohy naplánovaných úloh. Každý objekt možností úlohy obsahuje vlastnost JobDefinition, která obsahuje naplánovanou úlohu, takže objekt možností zůstává přidružený k naplánované úloze i v případě změny.

Aktivační události úlohy se přesouvají do Set-ScheduledJobOption rutiny, která změní hodnotu možnosti IdleTimeout na dvě hodiny (2:00:00).

Parametry

-ContinueIfGoingOnBattery

Nezastavujte naplánovanou úlohu, pokud počítač při spuštění úlohy přepne na napájení baterie (odpojí se od napájecího proudu). Ve výchozím nastavení se naplánované úlohy zastaví, když se počítač odpojí od napájení AC.

Parametr ContinueIfGoingOnBattery nastaví hodnotu StopIfGoingOnBatteries vlastnosti naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DoNotAllowDemandStart

Spusťte úlohu jenom v případě, že se aktivuje. Uživatelé nemohou úlohu spustit ručně, například pomocí funkce Spustit v Plánovači úloh.

Tento parametr má vliv pouze na Plánovač úloh. Nebrání uživatelům v používání Start-Job rutiny ke spuštění úlohy.

Parametr DoNotAllowDemandStart nastaví hodnotu vlastnosti DoNotAllowDemandStart naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-HideInTaskScheduler

Nezobrazovat úlohu v Plánovači úloh. Tato hodnota ovlivňuje pouze počítač, na kterém se úloha spouští. Ve výchozím nastavení se naplánované úkoly zobrazí v Plánovači úloh.

I když je úkol skrytý, můžou uživatelé úkol zobrazit výběrem možnosti Zobrazit skryté úkoly v Plánovači úkolů.

Parametr HideInTaskScheduler nastaví hodnotu Vlastnosti ShowInTaskScheduler naplánovaných úloh na $false.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-IdleDuration

Určuje, jak dlouho musí být počítač nečinný před spuštěním úlohy. Výchozí hodnota je 10 minut. Pokud počítač není nečinný po zadanou dobu před vypršením platnosti hodnoty IdleTimeout , naplánovaná úloha se nespustí až do příštího naplánovaného času, pokud existuje.

Zadejte objekt časového rozsahu New-TimeSpan , například objekt vygenerovaný rutinou, nebo zadejte hodnotu ve <hours>:<minutes>:<seconds> formátu, který se automaticky převede na objekt TimeSpan .

Chcete-li tuto hodnotu povolit, použijte parametr StartIfIdle . Ve výchozím nastavení je vlastnost StartIfNotIdle naplánovaných úloh nastavena na $true a Windows PowerShell ignoruje hodnoty IdleDuration a IdleTimeout.

Type:TimeSpan
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-IdleTimeout

Určuje, jak dlouho musí být počítač nečinný před spuštěním úlohy. Výchozí hodnota je 10 minut. Pokud počítač není nečinný po zadanou dobu před vypršením platnosti hodnoty IdleTimeout , naplánovaná úloha se nespustí až do příštího naplánovaného času, pokud existuje.

Zadejte objekt časového rozsahu New-TimeSpan , například objekt vygenerovaný rutinou, nebo zadejte hodnotu ve <hours>:<minutes>:<seconds> formátu, který se automaticky převede na objekt TimeSpan .

Chcete-li tuto hodnotu povolit, použijte parametr StartIfIdle . Ve výchozím nastavení je vlastnost StartIfNotIdle naplánovaných úloh nastavena na $True a Windows PowerShell ignoruje hodnoty IdleDuration a IdleTimeout.

Type:TimeSpan
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Určuje možnosti úlohy. Zadejte proměnnou obsahující objekty ScheduledJobOptions nebo zadejte příkaz nebo výraz, který získá objekty ScheduledJobOptions , například Get-ScheduledJobOption příkaz. Do objektu ScheduledJobOptions můžete také řaditSet-ScheduledJobOptionobjekt .

Type:Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-MultipleInstancePolicy

Určuje, jak systém reaguje na požadavek na spuštění instance naplánované úlohy, zatímco je spuštěná jiná instance úlohy. Tento parametr přijímá tyto hodnoty:

  • IgnoreNew – Nová instance úlohy se ignoruje. Toto je výchozí hodnota.
  • Parallel – Nová instance úlohy se spustí okamžitě.
  • Queue – Nová instance úlohy se spustí hned po dokončení aktuální instance.
  • StopExisting – Aktuální instance zastavení úlohy a spuštění nové instance.

Pokud chcete úlohu spustit, musí být splněny všechny podmínky pro plán úlohy. Pokud například nejsou splněné podmínky nastavené parametrem RequireNetwork, IdleDuration a IdleTimeout , instance úlohy není spuštěna bez ohledu na hodnotu tohoto parametru.

Type:Microsoft.PowerShell.ScheduledJob.TaskMultipleInstancePolicy
Accepted values:None, IgnoreNew, Parallel, Queue, StopExisting
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Vrátí objekt představující položku, se kterou pracujete. Ve výchozím nastavení tato rutina negeneruje žádný výstup.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-RequireNetwork

Spustí naplánovanou úlohu jenom v případě, že jsou dostupná síťová připojení.

Pokud zadáte tento parametr a síť není k dispozici v naplánovaném čase zahájení, úloha se nespustí až do dalšího naplánovaného času spuštění, pokud existuje.

Parametr RequireNetwork nastaví hodnotu RunWithoutNetwork vlastnost naplánovaných úloh na $false.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-RestartOnIdleResume

Restartuje naplánovanou úlohu, když se počítač stane nečinnou. Tento parametr funguje s parametrem StopIfGoingOffIdle , který pozastaví spuštěnou naplánovanou úlohu, pokud se počítač stane aktivní (opustí stav nečinnosti).

Parametr RestartOnIdleResume nastaví hodnotu Vlastnosti RestartOnIdleResume naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-RunElevated

Spustí naplánovanou úlohu s oprávněními člena skupiny Administrators na počítači, na kterém se úloha spouští.

Pokud chcete povolit spuštění naplánované úlohy s oprávněními správce, použijte parametr Credential k Register-ScheduledJob zadání explicitních přihlašovacích údajů pro úlohu.

Parametr RunElevated nastaví hodnotu Vlastnosti RunElevated naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-StartIfIdle

Spustí naplánovanou úlohu, pokud byl počítač nečinný po dobu určenou parametrem IdleDuration před vypršením času určeného parametrem IdleTimeout .

Ve výchozím nastavení se parametry IdleDuration a IdleTimeout ignorují a úloha se spustí v naplánovaném čase spuštění, i když je počítač zaneprázdněný.

Pokud zadáte tento parametr a počítač je zaneprázdněn (není nečinný) v naplánovaném čase spuštění, úloha se nespustí až do příštího naplánovaného času spuštění, pokud existuje.

Parametr StartIfIdle nastaví hodnotu vlastnosti StartIfNotIdle naplánovaných úloh na $false.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-StartIfOnBattery

Spustí naplánovanou úlohu i v případě, že počítač běží na bateriích v naplánovaném čase spuštění. Výchozí hodnota je $false.

Parametr StartIfOnBattery nastaví hodnotu vlastnosti StartIfOnBatteries naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-StopIfGoingOffIdle

Pozastaví spuštěnou naplánovanou úlohu, pokud se počítač během běhu úlohy aktivuje (není nečinný).

Ve výchozím nastavení se naplánovaná úloha, která se pozastaví, když se počítač změní na aktivní, obnoví se při opětovném nečinnosti počítače. Chcete-li změnit toto výchozí chování, použijte parametr RestartOnIdleResume .

Parametr StopIfGoingOffIdle nastaví hodnotu vlastnosti StopIfGoingOffIdle naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WakeToRun

Probouzí počítač ze stavu hibernace nebo režimu spánku v naplánovaném čase spuštění, aby mohl úlohu spustit. Pokud je počítač ve stavu Hibernate nebo Sleep ve výchozím nastavení v naplánovaném čase spuštění, úloha se nespustí.

Parametr WakeToRun nastaví hodnotu Vlastnosti WakeToRun naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Objekt možností naplánované úlohy můžete převést na Set-ScheduledJobOption.

Výstupy

None or Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Při použití parametru Set-ScheduledJobOptionPassthru vrátí změněné možnosti úlohy. Jinak tato rutina negeneruje žádný výstup.