< Back
Stop-RSJob
Post
NAME Stop-RSJob
SYNOPSIS
Stops a Windows PowerShell runspace job.
SYNTAX
Stop-RSJob [[-Job] <RSJob[]>] [<CommonParameters>]
Stop-RSJob [[-Name] <String[]>] [<CommonParameters>]
Stop-RSJob [[-Id] <Int32[]>] [<CommonParameters>]
Stop-RSJob [-InstanceID <String[]>] [<CommonParameters>]
Stop-RSJob [-Batch <String[]>] [<CommonParameters>]
DESCRIPTION
Stops a Windows PowerShell background job that has been started using Start-RSJob
PARAMETERS
-Job <RSJob[]>
The job object to stop.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Name <String[]>
The name of the jobs to stop..
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Id <Int32[]>
The ID of the jobs to stop.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-InstanceID <String[]>
The GUID of the jobs to stop.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Batch <String[]>
Name of the set of jobs to stop.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Name: Stop-RSJob
Author: Boe Prox/Max Kozlov
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-RSJob -State Completed | Stop-RSJob
Description
-----------
Stop all jobs with a State of Completed.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Stop-RSJob -ID 1,5,78
Description
-----------
Stop jobs with IDs 1,5,78.
RELATED LINKS
SYNOPSIS
Stops a Windows PowerShell runspace job.
SYNTAX
Stop-RSJob [[-Job] <RSJob[]>] [<CommonParameters>]
Stop-RSJob [[-Name] <String[]>] [<CommonParameters>]
Stop-RSJob [[-Id] <Int32[]>] [<CommonParameters>]
Stop-RSJob [-InstanceID <String[]>] [<CommonParameters>]
Stop-RSJob [-Batch <String[]>] [<CommonParameters>]
DESCRIPTION
Stops a Windows PowerShell background job that has been started using Start-RSJob
PARAMETERS
-Job <RSJob[]>
The job object to stop.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Name <String[]>
The name of the jobs to stop..
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Id <Int32[]>
The ID of the jobs to stop.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-InstanceID <String[]>
The GUID of the jobs to stop.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Batch <String[]>
Name of the set of jobs to stop.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Name: Stop-RSJob
Author: Boe Prox/Max Kozlov
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-RSJob -State Completed | Stop-RSJob
Description
-----------
Stop all jobs with a State of Completed.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Stop-RSJob -ID 1,5,78
Description
-----------
Stop jobs with IDs 1,5,78.
RELATED LINKS