Unregister-ScheduledTask

Unregisters a scheduled task.

Syntax

Unregister-ScheduledTask
          [[-TaskName] <String[]>]
          [[-TaskPath] <String[]>]
          [-AsJob]
          [-CimSession <CimSession[]>]
          [-PassThru]
          [-ThrottleLimit <Int32>]
          [-Confirm]
          [-WhatIf]
Unregister-ScheduledTask
          [-AsJob]
          [-CimSession <CimSession[]>]
          [-PassThru]
          [-ThrottleLimit <Int32>]
          -InputObject <CimInstance[]>
          [-Confirm]
          [-WhatIf]

Description

The Unregister-ScheduledTask cmdlet unregisters a scheduled task from the Windows Task Scheduler service on a local computer.

Examples

Example 1: Unregister a task in the root folder

PS C:\> Unregister-ScheduledTask -TaskName "HardwareInventory"

This command unregisters a task named HardwareInventory in the root folder. You must confirm the action before the command performs it.

Required Parameters

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

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

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

Specifies an array of one or more names for a scheduled task.

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TaskPath

Specifies an array of one or more file paths for a scheduled task. You can use \ for the root folder. If you do not specify a path, the cmdlet uses the root folder.

Type:String[]
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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