Edit

Unregister-ScheduledTask

  • Reference
Module:
ScheduledTasks

Unregisters a scheduled task.

Syntax

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

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.

Example 2: Unregister a task in the Event Viewer Tasks

PS C:\> Unregister-ScheduledTask -TaskPath '\Event Viewer Tasks\' -TaskName 'ForwardedEvents' -Confirm:$false

This command unregisters a task named ForwardedEvents in the Event Viewer Tasks folder. You won't have to confirm on this action.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:True
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:Named
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TaskName

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

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

-TaskPath

Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace. You can use "*" for a wildcard character query. You can use \* for the root folder. To specify a full TaskPath you need to include the leading and trailing \. If you do not specify a path, the cmdlet uses the root folder.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
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

-WhatIf

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

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