Set-ScheduledJobOption

  • Reference
Modul:
PSScheduledJob

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 předejte možnosti do Set-ScheduledJobOption proměnné nebo je uložte do proměnné a pomocí parametru Set-ScheduledJobOption InputObject rutiny identifikujte možnosti. Pomocí zbývajících parametrů Set-ScheduledJobOption změňte možnosti úlohy.

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. Chcete-li 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 neužijí, když použijete rutinu Start-Job ke spuštění naplánované úlohy.

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

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

Tato rutina byla zavedena ve Windows PowerShellu 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 v místním počítači.

První příkaz pomocí rutiny Get-ScheduledJobOption získá možnosti úlohy naplánované úlohy DeployPackage. Výstup ukazuje, že WakeToRun a RunElevated vlastnosti jsou nastaveny na $false.

Druhý příkaz pomocí rutiny Set-ScheduledJobOpton změní možnosti úlohy tak, 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 nečinného časového limitu 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 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 Get-ScheduledJobOption rutiny, 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.

Aktivační události úlohy se předávají 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č 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 vlastnosti naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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žívání rutiny Start-Job ke spuštění úlohy.

DoNotAllowDemandStart parametr nastaví hodnotu DoNotAllowDemandStart vlastnost naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 v Plánovači úloh.

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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í do další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
Required:False
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í do další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 Prostředí Windows PowerShell ignoruje hodnoty IdleDuration a IdleTimeout .

Type:TimeSpan
Position:Named
Default value:None
Required:False
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. Objekt ScheduledJobOptions můžete také nasouovat na Set-ScheduledJobOption.

Type:Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions
Position:0
Default value:None
Required:True
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ěna jiná instance úlohy. Tento parametr přijímá tyto hodnoty:

  • IgnoreNew – Nová instance úlohy se ignoruje. Tato hodnota je výchozí.
  • Parallel – Nová instance úlohy se spustí okamžitě.
  • Queue – Nová instance úlohy se spustí, jakmile se aktuální instance dokončí.
  • StopExisting – Aktuální instance zastavení úlohy a spustí se nová instance.

Pokud chcete úlohu spustit, musí být splněny všechny podmínky pro plán úlohy. Pokud například nejsou splněny 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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters: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 RunWithoutNetwork vlastnost naplánovaných úloh na $false.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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í (ponechá stav nečinnosti).

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

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

-RunElevated

Spustí naplánovanou úlohu s oprávněními člena skupiny Správa istrators v 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áva istrator, použijte parametr Register-ScheduledJob Credential pro zadání explicitních přihlašovacích údajů pro úlohu.

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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 (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 Vlastnosti StartIfNotIdle naplánovaných úloh na $false.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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 StartIfOnBatteries vlastnost naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 vlastnost naplánovaných úloh na $true.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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 výchozím nastavení ve stavu Hibernate nebo Sleep v naplánovaném čase spuštění, úloha se nespustí.

WakeToRun parametr nastaví hodnotu WakeToRun vlastnost Naplánované úlohy na $true.

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

Vstupy

Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Do této rutiny můžete připojit objekt možností naplánované úlohy.

Výstupy

None

Ve výchozím nastavení tato rutina nevrací žádný výstup.

Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Když použijete parametr PassThru , vrátí tato rutina možnosti úlohy, které byly změněny.