| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
PS_ClusteredScheduledTask_v1.0.cdxml-help.xml |
ScheduledTasks |
12/20/2016 |
2.0.0 |
Set-ClusteredScheduledTask |
Changes settings for a clustered scheduled task.
Set-ClusteredScheduledTask [-TaskName] <String> [[-Cluster] <String>] [-Xml] <String>
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
Set-ClusteredScheduledTask [-TaskName] <String> [[-Cluster] <String>] [[-Action] <CimInstance[]>]
[[-Settings] <CimInstance>] [[-Trigger] <CimInstance[]>] [[-Description] <String>]
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
Set-ClusteredScheduledTask [-TaskName] <String> [[-Cluster] <String>] [-InputObject] <CimInstance>
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
The Set-ClusteredScheduledTask cmdlet changes settings for a clustered scheduled task. For instance, you can change the actions or triggers associated with a task.
You can make changes to a task even if an instance of the task is currently running. Any changes do not affect any actions already initiated.
For more information about the Task Scheduler, see the Task Scheduler Overview topic in the TechNet Library at http://technet.microsoft.com/en-us/library/cc721871.aspx.
PS C:\> $Action01 = New-ScheduledTaskAction -Execute "Notepad"
PS C:\> $Action02 = New-ScheduledTaskAction -Execute "Calc"
PS C:\> Set-ClusteredScheduledTask -TaskName "Task03" -Action $Action01,$Action02
This example changes the task actions for a scheduled task.
The first command uses the New-ScheduledTaskAction cmdlet to create a task action and stores that action in the $Action01 variable.
The second command uses the New-ScheduledTaskAction cmdlet to create a task action and stores that action in the $Action02 variable.
The final command changes the action assigned to the task named Task03 to the two actions stored in $Action01 and $Action02. The cluster runs more than one action in sequence.
Specifies an array of action objects to use in the task. To obtain a task action object, use the New-ScheduledTaskAction cmdlet.
A task can have a single action or up to 32 actions. If you specify more than one action, the cluster runs them in sequence.
Type: CimInstance[]
Parameter Sets: Params
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of a failover cluster. If you do not specify a cluster, the cmdlet uses the current node cluster name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a description of a task.
Type: String
Parameter Sets: Params
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the input object that is used in a pipeline command.
Type: CimInstance
Parameter Sets: Object
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a CimInstance object that contains properties that Windows Task Scheduler uses to configure running of a task. To obtain a settings object, use the New-ScheduledTaskSettingsSet cmdlet.
Type: CimInstance
Parameter Sets: Params
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a name of a scheduled task.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies an array of trigger objects to use in the task. To obtain a task trigger object, use the New-ScheduledTaskTrigger cmdlet.
A trigger is a set of criteria that starts the running of a task. You can use both time-based and event-based triggers. One or more triggers can start a task. You can specify up to 48 triggers.
Type: CimInstance[]
Parameter Sets: Params
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies an XML-formatted string that contains a task definition. You can export a task definition from Task Scheduler.
The string represents the triggers, actions, and other settings for a task. The string uses the Task Scheduler Schema.
Type: String
Parameter Sets: Xml
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.