Unregister-ClusteredScheduledTask
Unregister-ClusteredScheduledTask
Removes a scheduled task from a failover cluster.
Syntax
Parameter Set: Name
Unregister-ClusteredScheduledTask [-TaskName] <String> [[-Cluster] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: Object
Unregister-ClusteredScheduledTask [[-InputObject] <CimInstance> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Unregister-ClusteredScheduledTask cmdlet removes a clustered scheduled task from all nodes of a failover cluster.
For more information about the Windows Server® 2012 Task Scheduler, see the Task Scheduler Overview topic in the TechNet Library at https://technet.microsoft.com/en-us/library/cc721871.aspx.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Cluster<String>
Specifies the name of a failover cluster. If you do not specify a cluster, the cmdlet uses the current node cluster name.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
"." |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. This is a clustered scheduled task object. To obtain a clustered scheduled task object, use the Get-ClusteredScheduledTask cmdlet.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-TaskName<String>
Specifies a name of a scheduled task.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Unregister a task
This command removes the task named Task01 from the cluster named Cluster07.
PS C:\> Unregister-ClusteredScheduledTask -TaskName "Task01" -Cluster "Cluster07"