commands

^

Remove-DbaAgentJobStep

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

 

Synopsis

Removes a step from the specified SQL Agent job.

Description

Removes a job step from a SQL Server Agent job.

Syntax

Remove-DbaAgentJobStep
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-Job] <Object[]>
    [-StepName] <String>
    [[-Mode] {Strict | Lazy | Report}]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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.

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

The name of the job.

Alias
Required True
Pipeline false
Default Value
-StepName

The name of the job step.

Alias
Required True
Pipeline false
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
-Mode

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.

Alias
Required False
Pipeline false
Default Value (Get-DbatoolsConfigValue -Name 'message.mode.default' -Fallback "Strict")
-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 Remove-DbaAgentJobStep on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaAgentJobStep.