< Back
Stop-DbaAgentJob
Post
NAME Stop-DbaAgentJob
SYNOPSIS
Stops a running SQL Server Agent Job.
SYNTAX
Stop-DbaAgentJob [-SqlCredential <Pscredential>] [-Job <System.String[]>] [-ExcludeJob <System.String[]>] [-Wait
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
Stop-DbaAgentJob -SqlInstance <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential
<Pscredential>] [-Job <System.String[]>] [-ExcludeJob <System.String[]>] [-Wait <Switch>] [-EnableException
<Switch>] [<CommonParameters>]
Stop-DbaAgentJob [-SqlCredential <Pscredential>] [-Job <System.String[]>] [-ExcludeJob <System.String[]>]
-InputObject <Microsoft.SqlServer.Management.Smo.Agent.Job[]> [-Wait <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
This command stops a job then returns connected SMO object for SQL Agent Job information for each instance(s) of
SQL Server.
PARAMETERS
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeJob [<System.String[]>]
The job(s) to exclude - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Agent.Job[]>]
Internal parameter that enables piping
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.String[]>]
The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be
processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Wait [<Switch>]
Wait for output until the job has completely stopped
Required? false
Position? named
Default value
Accept pipeline input? False
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
Tags: Job, Agent
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Stop-DbaAgentJob -SqlInstance localhost
Stops all running SQL Agent Jobs on the local SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance sql2016 -Job cdc.DBWithCDC_capture | Stop-DbaAgentJob
Stops the cdc.DBWithCDC_capture SQL Agent Job on sql2016
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Stop-DbaAgentJob -SqlInstance sql2016 -Job cdc.DBWithCDC_capture
Stops the cdc.DBWithCDC_capture SQL Agent Job on sql2016
RELATED LINKS
https://dbatools.io/Stop-DbaAgentJob
SYNOPSIS
Stops a running SQL Server Agent Job.
SYNTAX
Stop-DbaAgentJob [-SqlCredential <Pscredential>] [-Job <System.String[]>] [-ExcludeJob <System.String[]>] [-Wait
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
Stop-DbaAgentJob -SqlInstance <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-SqlCredential
<Pscredential>] [-Job <System.String[]>] [-ExcludeJob <System.String[]>] [-Wait <Switch>] [-EnableException
<Switch>] [<CommonParameters>]
Stop-DbaAgentJob [-SqlCredential <Pscredential>] [-Job <System.String[]>] [-ExcludeJob <System.String[]>]
-InputObject <Microsoft.SqlServer.Management.Smo.Agent.Job[]> [-Wait <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
This command stops a job then returns connected SMO object for SQL Agent Job information for each instance(s) of
SQL Server.
PARAMETERS
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeJob [<System.String[]>]
The job(s) to exclude - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Agent.Job[]>]
Internal parameter that enables piping
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.String[]>]
The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be
processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Wait [<Switch>]
Wait for output until the job has completely stopped
Required? false
Position? named
Default value
Accept pipeline input? False
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
Tags: Job, Agent
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Stop-DbaAgentJob -SqlInstance localhost
Stops all running SQL Agent Jobs on the local SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAgentJob -SqlInstance sql2016 -Job cdc.DBWithCDC_capture | Stop-DbaAgentJob
Stops the cdc.DBWithCDC_capture SQL Agent Job on sql2016
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Stop-DbaAgentJob -SqlInstance sql2016 -Job cdc.DBWithCDC_capture
Stops the cdc.DBWithCDC_capture SQL Agent Job on sql2016
RELATED LINKS
https://dbatools.io/Stop-DbaAgentJob