Udostępnij za pośrednictwem

Set-ScheduledJobOption

  • Odwołanie
Moduł:
PSScheduledJob

Zmienia opcje zadania zaplanowanego zadania.

Składnia

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

Opis

Polecenie cmdlet Set-ScheduledJobOptions zmienia opcje zadania zaplanowanych zadań.

Aby zmienić opcje zaplanowanego zadania, zacznij od użycia polecenia cmdlet Get-ScheduledJobOption, aby uzyskać opcje zadania zaplanowanego zadania. Następnie należy przekazać potok opcji do polecenia cmdlet Set-ScheduledJobOption lub zapisać opcje w zmiennej i użyć parametru InputObject polecenia cmdlet Set-ScheduledJobOption , aby zidentyfikować opcje. Użyj pozostałych parametrów polecenia Set-ScheduledJobOption , aby zmienić opcje zadania.

Aby włączyć opcję zadania, użyj parametru, który ustawia tę opcję. Aby wyłączyć opcję, wpisz nazwę parametru, dwukropek (:) i $False. Aby na przykład wyłączyć opcję RunElevated , wpisz -RunElevated:$False.

Każdy obiekt opcji zadania zawiera właściwość JobDefinition zawierającą zaplanowane zadanie, więc skojarzenie z zaplanowanym zadaniem jest zachowywane po zmianie opcji zadania.

Opcje zaplanowanego zadania określają, jak zadanie jest uruchamiane po uruchomieniu przez harmonogram zadań. Te opcje nie mają zastosowania podczas uruchamiania zaplanowanego zadania za pomocą polecenia cmdlet Start-Job.

Set-ScheduledJobOption jest jedną z kolekcji poleceń cmdlet planowania zadań w module PSScheduledJob, który jest uwzględniony w Windows PowerShell.

Aby uzyskać więcej informacji na temat zaplanowanych zadań, zobacz temat Informacje w module PSScheduledJob. Zaimportuj moduł PSScheduledJob, a następnie wpisz polecenie: Get-Help about_Scheduled* lub zobacz about_Scheduled_Jobs.

To polecenie cmdlet zostało wprowadzone w Windows PowerShell 3.0.

Przykłady

Przykład 1. Zmienianie opcji zadania

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          :

W tym przykładzie pokazano, jak zmienić opcje zaplanowanego zadania na komputerze lokalnym.

Pierwsze polecenie używa polecenia cmdlet Get-ScheduledJobOption, aby uzyskać opcje zadania zaplanowanego zadania DeployPackage. Dane wyjściowe pokazują, że właściwości WakeToRun i RunElevated mają wartość $False.

To polecenie nie jest wymagane; jest uwzględniana tylko w celu pokazania efektu zmiany opcji.

Przykład 2. Zmiana opcji we wszystkich zaplanowanych zadaniach zdalnych

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

To polecenie zmienia wartość elementu IdleTimeout z jednej godziny (wartość domyślna) na dwie godziny na wszystkich zaplanowanych zadaniach na komputerze Server01.

Polecenie używa polecenia cmdlet Invoke-Command do uruchomienia polecenia na komputerze Server01.

Polecenie zdalne rozpoczyna się od polecenia Get-ScheduledJob, które pobiera wszystkie zaplanowane zadania na komputerze. Zaplanowane zadania są przesyłane potokami do polecenia cmdlet Get-ScheduledJobOption, które pobiera opcje zadań zaplanowanych zadań. Każdy obiekt opcji zadania zawiera właściwość JobDefinition zawierającą zaplanowane zadanie, więc obiekt options pozostaje skojarzony z zaplanowanym zadaniem nawet wtedy, gdy zostanie zmieniony.

Wyzwalacze zadania są przesyłane potokowo do polecenia cmdlet Set-ScheduledJobOption , które zmienia wartość opcji IdleTimeout na dwie godziny (2:00:00).

Parametry

-ContinueIfGoingOnBattery

Nie należy zatrzymywać zaplanowanego zadania, jeśli komputer przełącza się na zasilanie baterii (odłącza się od zasilania prądu zasilającego), gdy zadanie jest uruchomione. Domyślnie zaplanowane zadania są zatrzymywane, gdy komputer rozłącza się z zasilaniem ac.

Parametr ContinueIfGoingOnBattery ustawia wartość właściwości StopIfGoingOnBatteries zaplanowanych zadań na $True.

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

-DoNotAllowDemandStart

Uruchom zadanie tylko wtedy, gdy zostanie wyzwolone. Użytkownicy nie mogą ręcznie uruchomić zadania, na przykład za pomocą funkcji Uruchom w harmonogramie zadań.

Ten parametr ma wpływ tylko na harmonogram zadań. Nie uniemożliwia użytkownikom korzystania z polecenia cmdlet Start-Job uruchamiania zadania.

Parametr DoNotAllowDemandStart ustawia wartość właściwości DoNotAllowDemandStart zaplanowanych zadań na $True.

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

-HideInTaskScheduler

Nie wyświetlaj zadania w harmonogramie zadań. Ta wartość wpływa tylko na komputer, na którym jest uruchamiane zadanie. Domyślnie zaplanowane zadania są wyświetlane w harmonogramie zadań.

Nawet jeśli zadanie jest ukryte, użytkownicy mogą wyświetlać zadanie, wybierając opcję Pokaż ukryte zadania w harmonogramie zadań.

Parametr HideInTaskScheduler ustawia wartość właściwości ShowInTaskScheduler zaplanowanych zadań na $False.

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

-IdleDuration

Określa, jak długo komputer musi być bezczynny przed uruchomieniem zadania. Wartość domyślna to 10 minut. Jeśli komputer nie jest bezczynny przez określony czas przed wygaśnięciem wartości IdleTimeout , zaplanowane zadanie nie zostanie uruchomione do następnego zaplanowanego czasu, jeśli istnieje.

Wprowadź obiekt przedziału czasu, taki jak jeden wygenerowany przez polecenie cmdlet New-TimeSpan, lub wprowadź wartość w <formacie hours>:minutes>:<<seconds>, który jest automatycznie konwertowany na obiekt TimeSpan.

Aby włączyć tę wartość, użyj parametru StartIfIdle . Domyślnie właściwość StartIfNotIdle zaplanowanych zadań jest ustawiona na $True i Windows PowerShell ignoruje wartości IdleDuration i IdleTimeout.

Type:TimeSpan
Position:Named
Default value:10 minutes
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdleTimeout

Określa, jak długo komputer musi być bezczynny przed uruchomieniem zadania. Wartość domyślna to 10 minut. Jeśli komputer nie jest bezczynny przez określony czas przed wygaśnięciem wartości IdleTimeout , zaplanowane zadanie nie zostanie uruchomione do następnego zaplanowanego czasu, jeśli istnieje.

Wprowadź obiekt przedziału czasu, taki jak jeden wygenerowany przez polecenie cmdlet New-TimeSpan, lub wprowadź wartość w <formacie hours>:minutes>:<<seconds>, który jest automatycznie konwertowany na obiekt TimeSpan.

Aby włączyć tę wartość, użyj parametru StartIfIdle . Domyślnie właściwość StartIfNotIdle zaplanowanych zadań jest ustawiona na $True i Windows PowerShell ignoruje wartości IdleDuration i IdleTimeout.

Type:TimeSpan
Position:Named
Default value:10 minutes
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Określa opcje zadania. Wprowadź zmienną zawierającą obiekty ScheduledJobOptions lub wpisz polecenie lub wyrażenie, które pobiera obiekty ScheduledJobOptions , takie jak polecenie Get-ScheduledJobOption. Możesz również przekazać potok obiektu ScheduledJobOptions do polecenia Set-ScheduledJobOption.

Type:ScheduledJobOptions
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MultipleInstancePolicy

Określa, w jaki sposób system odpowiada na żądanie uruchomienia wystąpienia zaplanowanego zadania, gdy jest uruchomione inne wystąpienie zadania. Dopuszczalne wartości dla tego parametru to:

  • IgnorujNowy. Nowe wystąpienie zadania jest ignorowane. Jest to wartość domyślna.
  • Równoległe. Nowe wystąpienie zadania jest uruchamiane natychmiast.
  • Kolejki. Nowe wystąpienie zadania jest uruchamiane zaraz po zakończeniu bieżącego wystąpienia.
  • Przestań istnieć. Bieżące wystąpienie zadania zostanie zatrzymane i uruchomione nowe wystąpienie.

Aby uruchomić zadanie, należy spełnić wszystkie warunki harmonogramu zadań. Jeśli na przykład warunki ustawione przez parametry RequireNetwork, IdleDuration i IdleTimeout nie są spełnione, wystąpienie zadania nie zostanie uruchomione, niezależnie od wartości tego parametru.

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

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet nie generuje żadnego wyniku.

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

-RequireNetwork

Uruchamia zaplanowane zadanie tylko wtedy, gdy połączenia sieciowe są dostępne.

Jeśli określisz ten parametr i sieć nie jest dostępna w zaplanowanym czasie rozpoczęcia, zadanie nie zostanie uruchomione do następnego zaplanowanego czasu rozpoczęcia, jeśli istnieje.

Parametr RequireNetwork ustawia wartość właściwości RunWithoutNetwork zaplanowanych zadań na $False.

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

-RestartOnIdleResume

Uruchamia zaplanowane zadanie, gdy komputer stanie się bezczynny. Ten parametr działa z parametrem StopIfGoingOffIdle , który zawiesza uruchomione zaplanowane zadanie, jeśli komputer stanie się aktywny (pozostawia stan bezczynności).

Parametr RestartOnIdleResume ustawia wartość właściwości RestartOnIdleResume zaplanowanych zadań na $True.

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

-RunElevated

Uruchamia zaplanowane zadanie z uprawnieniami członka grupy Administratorzy na komputerze, na którym jest uruchamiane zadanie.

Aby włączyć zaplanowane zadanie do uruchomienia z uprawnieniami administratora, użyj parametru Credential Register-ScheduledJob, aby podać jawne poświadczenia dla zadania.

Parametr RunElevated ustawia wartość właściwości RunElevated zaplanowanych zadań na true.

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

-StartIfIdle

Uruchamia zaplanowane zadanie, jeśli komputer był bezczynny przez czas określony przez parametr IdleDuration przed upływem czasu określonego przez parametr IdleTimeout .

Domyślnie parametry IdleDuration i IdleTimeout są ignorowane, a zadanie rozpoczyna się w zaplanowanym czasie rozpoczęcia, nawet jeśli komputer jest zajęty.

Jeśli określisz ten parametr, a komputer jest zajęty (nie bezczynny) w zaplanowanym czasie rozpoczęcia, zadanie nie zostanie uruchomione do następnego zaplanowanego czasu rozpoczęcia, jeśli istnieje.

Parametr StartIfIdle ustawia wartość właściwości StartIfNotIdle zaplanowanych zadań na False.

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

-StartIfOnBattery

Uruchamia zaplanowane zadanie, nawet jeśli komputer jest uruchomiony na bateriach w zaplanowanym czasie rozpoczęcia. Wartość domyślna to False.

Parametr StartIfOnBattery ustawia wartość właściwości StartIfOnBatteries zaplanowanych zadań na $True.

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

-StopIfGoingOffIdle

Zawiesza uruchomione zaplanowane zadanie, jeśli komputer stanie się aktywny (nie bezczynny), gdy zadanie jest uruchomione.

Domyślnie zaplanowane zadanie, które jest zawieszone, gdy komputer staje się aktywny wznawia, gdy komputer ponownie stanie się bezczynny. Aby zmienić to domyślne zachowanie, użyj parametru RestartOnIdleResume .

Parametr StopIfGoingOffIdle ustawia wartość właściwości StopIfGoingOffIdle zaplanowanych zadań na $True.

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

-WakeToRun

Wznawia komputer ze stanu hibernacji lub uśpienia w zaplanowanym czasie rozpoczęcia, aby mógł uruchomić zadanie. Domyślnie, jeśli komputer jest w stanie Hibernacji lub Uśpienia w zaplanowanym czasie rozpoczęcia, zadanie nie jest uruchamiane.

Parametr WakeToRun ustawia wartość właściwości WakeToRun zaplanowanych zadań na $True.

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

Dane wejściowe

ScheduledJobOptions

Obiekt opcji zaplanowanego zadania można potokować do opcji Set-ScheduledJobOption.

Dane wyjściowe

None or Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

W przypadku użycia parametru Passthrufunkcja Set-ScheduledJobOption zwraca zmienione opcje zadania. W przeciwnym razie to polecenie cmdlet nie generuje żadnych danych wyjściowych.