< Back
Remove-DbaAgentJob
Post
NAME Remove-DbaAgentJob
SYNOPSIS
Remove-DbaAgentJob removes a job.
SYNTAX
Remove-DbaAgentJob [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Job] <System.Object[]>] [-KeepHistory <Switch>] [-KeepUnusedSchedule <Switch>] [[-Mode]
<DbaMode>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Agent.Job[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Remove-DbaAgentJob removes a job in the SQL Server Agent.
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
-InputObject [<Microsoft.SqlServer.Management.Smo.Agent.Job[]>]
Accepts piped input from Get-DbaAgentJob
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.Object[]>]
The name of the job. Can be null if the the job id is being used.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-KeepHistory [<Switch>]
Specifies to keep the history for the job. By default history is deleted.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-KeepUnusedSchedule [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Mode [<DbaMode>]
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.
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. This can be a collection and receive pipeline input to allow the
function to be executed against multiple SQL Server instances.
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: Agent, Job
Author: Sander Stad (@sqlstad, sqlstad.nl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Remove-DbaAgentJob
SYNOPSIS
Remove-DbaAgentJob removes a job.
SYNTAX
Remove-DbaAgentJob [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Job] <System.Object[]>] [-KeepHistory <Switch>] [-KeepUnusedSchedule <Switch>] [[-Mode]
<DbaMode>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Agent.Job[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Remove-DbaAgentJob removes a job in the SQL Server Agent.
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
-InputObject [<Microsoft.SqlServer.Management.Smo.Agent.Job[]>]
Accepts piped input from Get-DbaAgentJob
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Job [<System.Object[]>]
The name of the job. Can be null if the the job id is being used.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-KeepHistory [<Switch>]
Specifies to keep the history for the job. By default history is deleted.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-KeepUnusedSchedule [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Mode [<DbaMode>]
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.
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. This can be a collection and receive pipeline input to allow the
function to be executed against multiple SQL Server instances.
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: Agent, Job
Author: Sander Stad (@sqlstad, sqlstad.nl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Remove-DbaAgentJob