commands

^

Remove-DbaAgentJob

Author Sander Stad (@sqlstad, sqlstad.nl)
Availability Windows, Linux, macOS

 

Synopsis

Remove-DbaAgentJob removes a job.

Description

Remove-DbaAgentJob removes a job in the SQL Server Agent.

Syntax

Remove-DbaAgentJob
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Job] <Object[]>]
    [-KeepHistory]
    [-KeepUnusedSchedule]
    [[-Mode] {Strict | Lazy | Report}]
    [[-InputObject] <Job[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaAgentJob -SqlInstance sql1 -Job Job1

Removes the job from the instance with the name Job1

Example: 2
PS C:\> GetDbaAgentJob -SqlInstance sql1 -Job Job1 | Remove-DbaAgentJob -KeepHistory

Removes the job but keeps the history

Example: 3
PS C:\> Remove-DbaAgentJob -SqlInstance sql1 -Job Job1 -KeepUnusedSchedule

Removes the job but keeps the unused schedules

Example: 4
PS C:\> Remove-DbaAgentJob -SqlInstance sql1, sql2, sql3 -Job Job1

Removes the job from multiple servers

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Alias
Required False
Pipeline false
Default Value
-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 name of the job. Can be null if the the job id is being used.

Alias
Required False
Pipeline false
Default Value
-KeepHistory

Specifies to keep the history for the job. By default history is deleted.

Alias
Required False
Pipeline false
Default Value False
-KeepUnusedSchedule

Specifies to keep the schedules attached to this job if they are not attached to any other job. By default the unused schedule is deleted.

Alias
Required False
Pipeline false
Default Value False
-Mode

Default: Strict How strict does the command take lesser issues? Strict: Interrupt if the job specified doesn't exist. Lazy: Silently skip over jobs that don't exist.

Alias
Required False
Pipeline false
Default Value (Get-DbatoolsConfigValue -FullName 'message.mode.default' -Fallback "Strict")
-InputObject

Accepts piped input from Get-DbaAgentJob

Alias
Required False
Pipeline true (ByValue)
Default Value
-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

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

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