Delen via

Set-ScheduledJobOption

  • Referentie
Module:
PSScheduledJob

Hiermee wijzigt u de taakopties van een geplande taak.

Syntax

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

Description

De cmdlet Set-ScheduledJobOptions wijzigt de taakopties van geplande taken.

Als u de opties van een geplande taak wilt wijzigen, gebruikt u eerst de cmdlet Get-ScheduledJobOption om de taakopties van een geplande taak op te halen. Vervolgens sluist u de opties door naar Set-ScheduledJobOption of slaat u de opties op in een variabele en gebruikt u de parameter InputObject van de cmdlet Set-ScheduledJobOption om de opties te identificeren. Gebruik de resterende parameters van Set-ScheduledJobOption om de taakopties te wijzigen.

Als u een taakoptie wilt inschakelen, gebruikt u de parameter waarmee deze optie wordt ingesteld. Als u een optie wilt uitschakelen, typt u de parameternaam, een dubbele punt (:) en $False. Als u bijvoorbeeld de optie RunElevated wilt uitschakelen, typt u -RunElevated:$False.

Elk taakoptiesobject bevat een eigenschap JobDefinition die de geplande taak bevat, zodat de koppeling met de geplande taak behouden blijft wanneer de taakopties worden gewijzigd.

De geplande taakopties bepalen hoe de taak wordt uitgevoerd wanneer deze wordt gestart door Task Scheduler. Deze opties zijn niet van toepassing wanneer u de cmdlet Start-Job gebruikt om een geplande taak te starten.

Set-ScheduledJobOption is een verzameling cmdlets voor taakplanning in de module PSScheduledJob die is opgenomen in Windows PowerShell.

Zie de onderwerpen Over in de module PSScheduledJob voor meer informatie over geplande taken. Importeer de module PSScheduledJob en typ: Get-Help about_Scheduled* of zie about_Scheduled_Jobs.

Deze cmdlet is geïntroduceerd in Windows PowerShell 3.0.

Voorbeelden

Voorbeeld 1: Taakopties wijzigen

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          :

In dit voorbeeld ziet u hoe u de opties van een geplande taak op de lokale computer wijzigt.

De eerste opdracht maakt gebruik van de cmdlet Get-ScheduledJobOption om de taakopties van de geplande DeployPackage-taak op te halen. In de uitvoer ziet u dat de eigenschappen WakeToRun en RunElevated zijn ingesteld op $False.

Deze opdracht is niet vereist; het is alleen opgenomen om het effect van de optiewijziging weer te geven.

Voorbeeld 2: Een optie wijzigen voor alle externe geplande taken

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

Met deze opdracht wordt de waarde van de IdleTimeout gewijzigd van één uur (de standaardwaarde) in twee uur voor alle geplande taken op de Server01-computer.

De opdracht gebruikt de cmdlet Invoke-Command om een opdracht uit te voeren op de Server01-computer.

De externe opdracht begint met een Get-ScheduledJob opdracht waarmee alle geplande taken op de computer worden uitgevoerd. De geplande taken worden doorgesluisd naar de cmdlet Get-ScheduledJobOption, waarmee de taakopties van de geplande taken worden opgehaald. Elk taakoptiesobject bevat een eigenschap JobDefinition die de geplande taak bevat, zodat het object options gekoppeld blijft aan de geplande taak, zelfs wanneer deze wordt gewijzigd.

De taaktriggers worden doorgesluisd naar de cmdlet Set-ScheduledJobOption , waardoor de waarde van de optie IdleTimeout wordt gewijzigd in twee uur (2:00:00).

Parameters

-ContinueIfGoingOnBattery

Stop de geplande taak niet als de computer overschakelt naar accustroom (de verbinding met netstroom wordt verbroken) terwijl de taak wordt uitgevoerd. Geplande taken stoppen standaard wanneer de computer de verbinding met netstroom verbreekt.

De parameter ContinueIfGoingOnBattery stelt de waarde van de eigenschap StopIfGoingOnBatteries van geplande taken in op $True.

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

-DoNotAllowDemandStart

Start de taak alleen wanneer deze wordt geactiveerd. Gebruikers kunnen de taak niet handmatig starten, bijvoorbeeld met behulp van de functie Uitvoeren in Task Scheduler.

Deze parameter is alleen van invloed op Task Scheduler. Het voorkomt niet dat gebruikers de cmdlet Start-Job gebruiken om de taak te starten.

De parameter DoNotAllowDemandStart stelt de waarde van de eigenschap DoNotAllowDemandStart van geplande taken in op $True.

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

-HideInTaskScheduler

Geef de taak niet weer in Taakplanner. Deze waarde is alleen van invloed op de computer waarop de taak wordt uitgevoerd. Geplande taken worden standaard weergegeven in Taakplanner.

Zelfs als een taak verborgen is, kunnen gebruikers de taak weergeven door de optie Weergave verborgen taken weergeven in Task Scheduler te selecteren.

Met de parameter HideInTaskScheduler wordt de waarde van de eigenschap ShowInTaskScheduler van geplande taken ingesteld op $False.

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

-IdleDuration

Hiermee geeft u op hoe lang de computer inactief moet zijn voordat de taak wordt gestart. De standaardwaarde is 10 minuten. Als de computer niet inactief is gedurende de opgegeven duur voordat de waarde van IdleTimeout verloopt, wordt de geplande taak pas uitgevoerd op het volgende geplande tijdstip, indien van toepassing.

Voer een tijdsperiodeobject in, zoals een object dat wordt gegenereerd door de cmdlet New-TimeSpan, of voer een waarde in de notatie uren>:<minuten>:<seconden> in <die automatisch wordt geconverteerd naar een TimeSpan-object.

Gebruik de parameter StartIfIdle om deze waarde in te schakelen. De eigenschap StartIfNotIdle van geplande taken is standaard ingesteld op $True en Windows PowerShell negeert de waarden IdleDuration en IdleTimeout.

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

-IdleTimeout

Hiermee geeft u op hoe lang de computer inactief moet zijn voordat de taak wordt gestart. De standaardwaarde is 10 minuten. Als de computer niet inactief is gedurende de opgegeven duur voordat de waarde van IdleTimeout verloopt, wordt de geplande taak pas uitgevoerd op het volgende geplande tijdstip, indien van toepassing.

Voer een tijdsperiodeobject in, zoals een object dat wordt gegenereerd door de cmdlet New-TimeSpan, of voer een waarde in de notatie uren>:<minuten>:<seconden> in <die automatisch wordt geconverteerd naar een TimeSpan-object.

Gebruik de parameter StartIfIdle om deze waarde in te schakelen. De eigenschap StartIfNotIdle van geplande taken is standaard ingesteld op $True en Windows PowerShell negeert de waarden IdleDuration en IdleTimeout.

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

-InputObject

Hiermee geeft u de taakopties op. Voer een variabele in die ScheduledJobOptions-objecten bevat of typ een opdracht of expressie waarmee ScheduledJobOptions-objecten worden opgehaald, zoals een Get-ScheduledJobOption opdracht. U kunt ook een ScheduledJobOptions-object doorsluisen naar Set-ScheduledJobOption.

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

-MultipleInstancePolicy

Bepaalt hoe het systeem reageert op een aanvraag om een exemplaar van een geplande taak te starten terwijl een ander exemplaar van de taak wordt uitgevoerd. De aanvaardbare waarden voor deze parameter zijn:

  • IgnoreNew. Het nieuwe taakexemplaar wordt genegeerd. Dit is de standaardwaarde.
  • Parallel. Het nieuwe taakexemplaar wordt onmiddellijk gestart.
  • Wachtrij. Het nieuwe taakexemplaar wordt gestart zodra het huidige exemplaar is voltooid.
  • Stop met bestaan. Het huidige exemplaar van de taak stopt en het nieuwe exemplaar wordt gestart.

Als u de taak wilt uitvoeren, moet aan alle voorwaarden voor de taakplanning worden voldaan. Als bijvoorbeeld niet wordt voldaan aan de voorwaarden die zijn ingesteld door de parameters RequireNetwork, IdleDuration en IdleTimeout , wordt het taakexemplaar niet gestart, ongeacht de waarde van deze parameter.

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

Retourneert een object dat het item vertegenwoordigt waarmee u werkt. Deze cmdlet genereert standaard geen uitvoer.

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

-RequireNetwork

Hiermee wordt de geplande taak alleen uitgevoerd wanneer er netwerkverbindingen beschikbaar zijn.

Als u deze parameter opgeeft en het netwerk niet beschikbaar is op de geplande begintijd, wordt de taak niet uitgevoerd tot de volgende geplande begintijd, indien van toepassing.

Met de parameter RequireNetwork wordt de waarde van de eigenschap RunWithoutNetwork van geplande taken ingesteld op $False.

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

-RestartOnIdleResume

Start een geplande taak opnieuw op wanneer de computer inactief wordt. Deze parameter werkt met de parameter StopIfGoingOffIdle , die een actieve geplande taak onderbreekt als de computer actief wordt (de niet-actieve status verlaat).

De parameter RestartOnIdleResume stelt de waarde van de eigenschap RestartOnIdleResume van geplande taken in op $True.

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

-RunElevated

Hiermee wordt de geplande taak uitgevoerd met de machtigingen van een lid van de groep Administrators op de computer waarop de taak wordt uitgevoerd.

Als u wilt dat een geplande taak kan worden uitgevoerd met beheerdersmachtigingen, gebruikt u de referentieparameter van Register-ScheduledJob om expliciete referenties voor de taak op te geven.

De parameter RunElevated stelt de waarde van de eigenschap RunElevated van geplande taken in op True.

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

-StartIfIdle

Hiermee start u de geplande taak als de computer inactief is geweest gedurende de tijd die is opgegeven door de parameter IdleDuration voordat de tijd die is opgegeven door de parameter IdleTimeout is verlopen.

Standaard worden de parameters IdleDuration en IdleTimeout genegeerd en wordt de taak gestart op de geplande begintijd, zelfs als de computer bezet is.

Als u deze parameter opgeeft en de computer bezet is (niet inactief) op de geplande begintijd, wordt de taak niet uitgevoerd tot de volgende geplande begintijd, indien van toepassing.

De parameter StartIfIdle stelt de waarde van de eigenschap StartIfNotIdle van geplande taken in op False.

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

-StartIfOnBattery

Hiermee start u de geplande taak, zelfs als de computer op batterijen werkt op de geplande begintijd. De standaardwaarde is False.

De parameter StartIfOnBattery stelt de waarde van de eigenschap StartIfOnBatteries van geplande taken in op $True.

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

-StopIfGoingOffIdle

Hiermee wordt een actieve geplande taak onderbroken als de computer actief (niet-inactief) wordt terwijl de taak wordt uitgevoerd.

Een geplande taak die wordt onderbroken wanneer de computer actief wordt, wordt standaard hervat wanneer de computer weer inactief is. Als u dit standaardgedrag wilt wijzigen, gebruikt u de parameter RestartOnIdleResume .

De parameter StopIfGoingOffIdle stelt de waarde van de eigenschap StopIfGoingOffIdle van geplande taken in op $True.

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

-WakeToRun

Haalt de computer uit de sluimerstand of slaapstand op de geplande begintijd, zodat de taak kan worden uitgevoerd. Als de computer zich op de geplande begintijd in de sluimerstand of slaapstand bevindt, wordt de taak standaard niet uitgevoerd.

De wakeToRun parameter stelt de waarde van de eigenschap WakeToRun van geplande taken in op $True.

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

Invoerwaarden

ScheduledJobOptions

U kunt een object met geplande taakopties doorsluisen naar Set-ScheduledJobOption.

Uitvoerwaarden

None or Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

Wanneer u de parameter Passthru gebruikt, retourneert Set-ScheduledJobOption de taakopties die zijn gewijzigd. Anders genereert deze cmdlet geen uitvoer.