Sdílet prostřednictvím

Set-ScheduledJobOption

  • Reference
Modul:
PSScheduledJob

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

Syntaxe

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í rutiny Get-ScheduledJobOption a získejte možnosti úlohy naplánované úlohy. Potom předejte možnosti Set-ScheduledJobOption nebo uložte možnosti do proměnné a pomocí parametru InputObject rutiny Set-ScheduledJobOption identifikujte 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 SpustitElevated, 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 neplatí, když ke spuštění naplánované úlohy použijete rutinu Start-Job.

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

Další informace o naplánovaných úlohách naleznete v tématu o tématech v modulu PSScheduledJob. Importujte modul PSScheduledJob a zadejte: Get-Help about_Scheduled* nebo viz about_Scheduled_Jobs.

Tato rutina byla zavedena ve Windows PowerShellu 3.0.

Příklady

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

PS C:\> 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          :

The second command uses the **Set-ScheduledJobOpton** cmdlet to change the job options so the values of the WakeToRun and RunWithoutNetwork properties are $True. The command uses the *Passthru* parameter to return the trigger after the change.
PS C:\> 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 v místním počítači.

První příkaz používá 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.

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

PS C:\> 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 ve všech naplánovaných úlohách na počítači Server01.

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

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í do rutiny Get-ScheduledJobOption, která 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žnosti zůstává přidružený k naplánované úloze i v případě, že je změněn.

Triggery úloh se předávají do rutiny Set-ScheduledJobOption, která změní hodnotu IdleTimeout na dvě hodiny (2:00:00).

Parametry

-ContinueIfGoingOnBattery

Nezastavujte naplánovanou úlohu, pokud počítač během běhu úlohy přepne na napájení baterie (odpojí se od napájení střídavého proudu). Ve výchozím nastavení se naplánované úlohy zastaví, když se počítač odpojí od napájení střídavého proudu.

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

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DoNotAllowDemandStart

Spusťte úlohu pouze v případech, kdy se aktivuje. Uživatelé nemůžou úlohu spustit ručně, například pomocí funkce Spustit v Plánovači úloh.

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

Parametr DoNotAllowDemandStart nastaví hodnotu Vlastnosti DoNotAllowDemandStart naplánovaných úloh na $True.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-HideInTaskScheduler

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

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

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

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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, než vyprší hodnota IdleTimeout vyprší, naplánovaná úloha se nespustí až do dalšího naplánovaného času, pokud existuje.

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

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

Typ:TimeSpan
Position:Named
Default value:10 minutes
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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, než vyprší hodnota IdleTimeout vyprší, naplánovaná úloha se nespustí až do dalšího naplánovaného času, pokud existuje.

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

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

Typ:TimeSpan
Position:Named
Default value:10 minutes
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-InputObject

Určuje možnosti úlohy. Zadejte proměnnou, která obsahuje ScheduledJobOptions objekty nebo zadejte příkaz nebo výraz, který získá ScheduledJobOptions objekty, například příkaz Get-ScheduledJobOption. Můžete také ScheduledJobOptions objekt Set-ScheduledJobOption.

Typ:ScheduledJobOptions
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-MultipleInstancePolicy

Určuje, jak systém reaguje na požadavek na spuštění instance naplánované úlohy, zatímco je spuštěna jiná instance úlohy. Přijatelné hodnoty pro tento parametr jsou:

  • IgnoreNew. Nová instance úlohy se ignoruje. Toto je výchozí hodnota.
  • Rovnoběžný. Nová instance úlohy se spustí okamžitě.
  • Fronta. Nová instance úlohy se spustí, jakmile se aktuální instance dokončí.
  • Přestat existovat. Aktuální instance úlohy se zastaví a spustí se nová instance.

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

Typ:TaskMultipleInstancePolicy
Přípustné hodnoty:None, IgnoreNew, Parallel, Queue, StopExisting
Position:Named
Default value:IgnoreNew
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PassThru

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

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-RequireNetwork

Spustí naplánovanou úlohu jenom v případech, kdy jsou k dispozici síťová připojení.

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

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

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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í (ponechá stav nečinnosti).

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

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-RunElevated

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

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

Parametr RunElevated nastaví hodnotu RunElevated vlastnost naplánovaných úloh na Hodnotu True.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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í jsou parametry IdleDuration a IdleTimeout ignorovány 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 (nečinný) v naplánovaném čase spuštění, úloha se nespustí až do dalšího naplánovaného času spuštění, pokud existuje.

Parametr StartIfIdle nastaví hodnotu StartIfNotIdle vlastnost naplánovaných úloh na False.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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 StartIfOnBatteries vlastnost naplánovaných úloh na $True.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-StopIfGoingOffIdle

Pozastaví spuštěnou naplánovanou úlohu, pokud se počítač stane aktivní (nečinný), když je úloha spuštěná.

Ve výchozím nastavení se naplánovaná úloha, která je pozastavena, když se počítač stane aktivní, obnoví, když se počítač znovu stane nečinným. Pokud chcete toto výchozí chování změnit, použijte parametr RestartOnIdleResume.

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

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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 výchozím nastavení ve stavu Hibernate nebo Sleep v naplánovaném čase spuštění, úloha se nespustí.

Parametr WakeToRun nastaví hodnotu vlastnosti WakeToRun naplánovaných úloh na $True.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

ScheduledJobOptions

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

Výstupy

None or Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Když použijete parametr Passthru, Set-ScheduledJobOption vrátí změněné možnosti úlohy. Jinak tato rutina negeneruje žádný výstup.