Stop-StmScheduledTask
SYNOPSIS
Stops a running scheduled task on a local or remote computer.
SYNTAX
Stop-StmScheduledTask [-TaskName] <String> [[-TaskPath] <String>] [[-ComputerName] <String>]
[[-Credential] <PSCredential>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Stop-StmScheduledTask function stops a running scheduled task on a local or remote computer using the Windows Task Scheduler. This function wraps the built-in Stop-ScheduledTask cmdlet to provide credential support and enhanced error handling across the ScheduledTasksManager module.
The function performs the following operations: 1. Connects to the specified computer using credentials if provided 2. Stops the specified scheduled task 3. Provides detailed verbose output for troubleshooting
This function requires appropriate permissions to manage scheduled tasks on the target computer.
EXAMPLES
EXAMPLE 1
Stop-StmScheduledTask -TaskName "MyBackupTask"
Stops the scheduled task named "MyBackupTask" on the local computer.
EXAMPLE 2
Stop-StmScheduledTask -TaskName "MaintenanceTask" -TaskPath "\Custom\Maintenance\"
Stops the scheduled task named "MaintenanceTask" located in the "\Custom\Maintenance\" path on the local computer.
EXAMPLE 3
Stop-StmScheduledTask -TaskName "DatabaseBackup" -ComputerName "Server01"
Stops the scheduled task named "DatabaseBackup" on the remote computer "Server01" using the current user's credentials.
EXAMPLE 4
$credentials = Get-Credential
Stop-StmScheduledTask -TaskName "ReportGeneration" -ComputerName "Server02" -Credential $credentials
Stops the scheduled task named "ReportGeneration" on the remote computer "Server02" using the specified credentials.
EXAMPLE 5
Stop-StmScheduledTask -TaskName "CriticalTask" -WhatIf
Shows what would happen if the cmdlet runs without actually performing the operation. This is useful for testing the command before execution.
PARAMETERS
-TaskName
Specifies the name of the scheduled task to stop. This parameter is mandatory and must match the exact name of the task as it appears in the Task Scheduler.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TaskPath
Specifies the path of the scheduled task to stop. The task path represents the folder structure in the Task Scheduler where the task is located (e.g., '\Microsoft\Windows\PowerShell\'). If not specified, the root path ('\') will be used.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: \
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName
Specifies the name of the computer on which to stop the scheduled task. If not specified, the local computer ('localhost') is used. This parameter accepts computer names, IP addresses, or fully qualified domain names.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Localhost
Accept pipeline input: False
Accept wildcard characters: False
-Credential
Specifies credentials to use when connecting to a remote computer. If not specified, the current user's credentials are used for the connection. This parameter is only relevant when connecting to remote computers.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None. You cannot pipe objects to Stop-StmScheduledTask.
OUTPUTS
None. This cmdlet does not generate any output.
NOTES
This function requires: - Appropriate permissions to manage scheduled tasks on the target computer - Network connectivity to remote computers when using the ComputerName parameter - The Task Scheduler service to be running on the target computer
The function uses CIM sessions internally for remote connections and includes proper error handling with detailed error messages and recommended actions.
Stopping a task that is not running will have no effect and will not cause an error.
The function supports the -WhatIf and -Confirm parameters for safe operation in automated environments.