commands

^

Stop-DbaAgentJob

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Stops a running SQL Server Agent Job.

Description

This command stops a job then returns connected SMO object for SQL Agent Job information for each instance(s) of SQL Server.

Syntax

Stop-DbaAgentJob
    [-SqlCredential <PSCredential>]
    [-Job <String[]>]
    [-ExcludeJob <String[]>]
    [-Wait]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-DbaAgentJob -SqlInstance <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-Job <String[]>]
    [-ExcludeJob <String[]>]
    [-Wait]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-DbaAgentJob
    [-SqlCredential <PSCredential>]
    [-Job <String[]>]
    [-ExcludeJob <String[]>] -InputObject <Job[]>
    [-Wait]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required True
Pipeline false
Default Value
-InputObject

Internal parameter that enables piping

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-SqlCredential

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.

Alias
Required False
Pipeline false
Default Value
-Job

The job(s) to process - this list is auto-populated from the server. If unspecified, all jobs will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeJob

The job(s) to exclude - this list is auto-populated from the server.

Alias
Required False
Pipeline false
Default Value
-Wait

Wait for output until the job has completely stopped

Alias
Required False
Pipeline false
Default Value False
-EnableException

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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Stop-DbaAgentJob on GitHub.
Want to see the Bill Of Health for this command? Check out Stop-DbaAgentJob.