< Back
Remove-DbaAgentJobStep
Post
NAME Remove-DbaAgentJobStep
SYNOPSIS
Removes a step from the specified SQL Agent job.
SYNTAX
Remove-DbaAgentJobStep [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [-Job] <System.Object[]> [-StepName] <String> [[-Mode] <DbaMode>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes a job step from a SQL Server Agent job.
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
-Job [<System.Object[]>]
The name of the job.
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 configuration already has the same value as the one specified.
Lazy: Silently skip over instances that already have this configuration at the specified value.
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
-StepName [<String>]
The name of the job step.
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, JobStep
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-DbaAgentJobStep -SqlInstance sql1 -Job Job1 -StepName Step1
Remove 'Step1' from job 'Job1' on sql1.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-DbaAgentJobStep -SqlInstance sql1 -Job Job1, Job2, Job3 -StepName Step1
Remove the job step from multiple jobs.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Remove-DbaAgentJobStep -SqlInstance sql1, sql2, sql3 -Job Job1 -StepName Step1
Remove the job step from the job on multiple servers.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>sql1, sql2, sql3 | Remove-DbaAgentJobStep -Job Job1 -StepName Step1
Remove the job step from the job on multiple servers using pipeline.
RELATED LINKS
https://dbatools.io/Remove-DbaAgentJobStep
SYNOPSIS
Removes a step from the specified SQL Agent job.
SYNTAX
Remove-DbaAgentJobStep [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [-Job] <System.Object[]> [-StepName] <String> [[-Mode] <DbaMode>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes a job step from a SQL Server Agent job.
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
-Job [<System.Object[]>]
The name of the job.
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 configuration already has the same value as the one specified.
Lazy: Silently skip over instances that already have this configuration at the specified value.
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
-StepName [<String>]
The name of the job step.
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, JobStep
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-DbaAgentJobStep -SqlInstance sql1 -Job Job1 -StepName Step1
Remove 'Step1' from job 'Job1' on sql1.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-DbaAgentJobStep -SqlInstance sql1 -Job Job1, Job2, Job3 -StepName Step1
Remove the job step from multiple jobs.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Remove-DbaAgentJobStep -SqlInstance sql1, sql2, sql3 -Job Job1 -StepName Step1
Remove the job step from the job on multiple servers.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>sql1, sql2, sql3 | Remove-DbaAgentJobStep -Job Job1 -StepName Step1
Remove the job step from the job on multiple servers using pipeline.
RELATED LINKS
https://dbatools.io/Remove-DbaAgentJobStep