Edit

Share via

Unregister-ClusteredScheduledTask

  • Reference
Module:
ScheduledTasks

Removes a scheduled task from a failover cluster.

Syntax

Unregister-ClusteredScheduledTask
          [[-Cluster] <String>]
          [-TaskName] <String>
          [-CimSession <CimSession[]>]
          [-ThrottleLimit <Int32>]
          [-AsJob]
          [<CommonParameters>]
Unregister-ClusteredScheduledTask
          [[-InputObject] <CimInstance>]
          [-CimSession <CimSession[]>]
          [-ThrottleLimit <Int32>]
          [-AsJob]
          [<CommonParameters>]

Description

The Unregister-ClusteredScheduledTask cmdlet removes a clustered scheduled task from all nodes of a failover cluster.

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.

Examples

Example 1: Unregister a task

PS C:\> Unregister-ClusteredScheduledTask -TaskName "Task01" -Cluster "Cluster07"

This command removes the task named Task01 from the cluster named Cluster07.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

-CimSession

Runs 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[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Cluster

Specifies the name of a failover cluster. If you do not specify a cluster, the cmdlet uses the current node cluster name.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

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

-TaskName

Specifies a name of a scheduled task.

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

-ThrottleLimit

Specifies 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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False