--- title: "Set-DbaAgentJobStep" description: "Modifies properties of existing SQL Agent job steps or creates new ones with Force parameter." url: "https://dbatools.io/Set-DbaAgentJobStep/" availability: "Windows, Linux, macOS" tags: ["Agent", "Job", "JobStep"] author: "Sander Stad (@sqlstad), sqlstad.nl" source: "https://github.com/dataplat/dbatools/blob/master/public/Set-DbaAgentJobStep.ps1" last_updated: "2024-01-01" --- # Set-DbaAgentJobStep ## Synopsis Modifies properties of existing SQL Agent job steps or creates new ones with Force parameter. ## Description Modifies SQL Agent job step properties including commands, subsystems, retry logic, success/failure actions, and execution context. Updates existing job steps by name or creates new steps when using the -Force parameter, eliminating the need to manually edit job steps through SSMS. Common use cases include changing job step commands during deployments, updating database contexts when moving jobs between environments, modifying retry settings for intermittent failures, and adjusting success/failure flow logic. The function supports all major subsystems including T-SQL, PowerShell, SSIS, CmdExec, and Analysis Services commands. Note: ActiveScripting (ActiveX scripting) was discontinued in SQL Server 2016: https://docs.microsoft.com/en-us/sql/database-engine/discontinued-database-engine-functionality-in-sql-server ## Syntax ```powershell Set-DbaAgentJobStep [[-SqlInstance] ] [[-SqlCredential] ] [[-Job] ] [[-StepName] ] [[-NewName] ] [[-Subsystem] ] [[-SubsystemServer] ] [[-Command] ] [[-CmdExecSuccessCode] ] [[-OnSuccessAction] ] [[-OnSuccessStepId] ] [[-OnFailAction] ] [[-OnFailStepId] ] [[-Database] ] [[-DatabaseUser] ] [[-RetryAttempts] ] [[-RetryInterval] ] [[-OutputFileName] ] [[-Flag] ] [[-ProxyName] ] [[-InputObject] ] [-EnableException] [-Force] [-WhatIf] [-Confirm] [] ``` ## Examples ### Example 1: Changes the name of the step in "Job1" with the name Step1 to Step2 ```powershell PS C:\> Set-DbaAgentJobStep -SqlInstance sql1 -Job Job1 -StepName Step1 -NewName Step2 ``` ### Example 2: Changes the database of the step in "Job1" with the name Step1 to msdb ```powershell PS C:\> Set-DbaAgentJobStep -SqlInstance sql1 -Job Job1 -StepName Step1 -Database msdb ``` ### Example 3: Changes job steps in multiple jobs with the name Step1 to msdb ```powershell PS C:\> Set-DbaAgentJobStep -SqlInstance sql1 -Job Job1, Job2 -StepName Step1 -Database msdb ``` ### Example 4: Changes job steps in multiple jobs on multiple servers with the name Step1 to msdb ```powershell PS C:\> Set-DbaAgentJobStep -SqlInstance sql1, sql2, sql3 -Job Job1, Job2 -StepName Step1 -Database msdb ``` ### Example 5: Changes the database of the step in "Job1" with the name Step1 to msdb for multiple servers ```powershell PS C:\> Set-DbaAgentJobStep -SqlInstance sql1, sql2, sql3 -Job Job1 -StepName Step1 -Database msdb ``` ### Example 6: Changes the database of the step in "Job1" with the name Step1 to msdb for multiple servers using pipeline ```powershell PS C:\> sql1, sql2, sql3 | Set-DbaAgentJobStep -Job Job1 -StepName Step1 -Database msdb ``` ### Example 7: SqlInstance = sqldev01 Job = dbatools1 StepName = "Step 2" Subsystem = "CmdExec" Command = "enter command... ```powershell PS C:\> $jobStep = @{ PS C:\> $newJobStep = Set-DbaAgentJobStep @jobStep ``` SqlInstance = sqldev01 Job = dbatools1 StepName = "Step 2" Subsystem = "CmdExec" Command = "enter command text here" CmdExecSuccessCode = 0 OnSuccessAction = "GoToStep" OnSuccessStepId = 1 OnFailAction = "GoToStep" OnFailStepId = 1 Database = TestDB RetryAttempts = 2 RetryInterval = 5 OutputFileName = "logCmdExec.txt" Flag = [Microsoft.SqlServer.Management.Smo.Agent.JobStepFlags]::AppendAllCmdExecOutputToJobHistory ProxyName = "dbatoolsci_proxy_1" Force = $true } Updates or creates a new job step named Step 2 in the dbatools1 job on the sqldev01 instance. The subsystem is set to CmdExec and uses a proxy. ### Optional Parameters ##### -SqlInstance The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2000 or greater. | Property | Value | | --- | --- | | 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. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -Job The name of the job or the job object itself. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -StepName The name of the step. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -NewName The new name for the step in case it needs to be renamed. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -Subsystem The subsystem used by the SQL Server Agent service to execute command. Allowed values 'ActiveScripting','AnalysisCommand','AnalysisQuery','CmdExec','Distribution','LogReader','Merge','PowerShell','QueueReader','Snapshot','Ssis','TransactSql' | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | | Accepted Values | ActiveScripting,AnalysisCommand,AnalysisQuery,CmdExec,Distribution,LogReader,Merge,PowerShell,QueueReader,Snapshot,Ssis,TransactSql | ##### -SubsystemServer The subsystems AnalysisScripting, AnalysisCommand, AnalysisQuery require a server. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -Command The commands to be executed by the SQLServerAgent service through the subsystem. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -CmdExecSuccessCode The value returned by a CmdExec subsystem command to indicate that command executed successfully. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | 0 | ##### -OnSuccessAction The action to perform if the step succeeds. Allowed values "QuitWithSuccess" (default), "QuitWithFailure", "GoToNextStep", "GoToStep". The text value van either be lowercase, uppercase or something in between as long as the text is correct. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | | Accepted Values | QuitWithSuccess,QuitWithFailure,GoToNextStep,GoToStep | ##### -OnSuccessStepId The ID of the step in this job to execute if the step succeeds and OnSuccessAction is "GoToNextStep". | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | 0 | ##### -OnFailAction The action to perform if the step fails. Allowed values "QuitWithFailure" (default), "QuitWithSuccess", "GoToNextStep", "GoToStep". The text value van either be lowercase, uppercase or something in between as long as the text is correct. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | | Accepted Values | QuitWithSuccess,QuitWithFailure,GoToNextStep,GoToStep | ##### -OnFailStepId The ID of the step in this job to execute if the step fails and OnFailAction is "GoToNextStep". | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | 0 | ##### -Database The name of the database in which to execute a Transact-SQL step. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -DatabaseUser The name of the user account to use when executing a Transact-SQL step. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -RetryAttempts The number of retry attempts to use if this step fails. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | 0 | ##### -RetryInterval The amount of time in minutes between retry attempts. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | 0 | ##### -OutputFileName The name of the file in which the output of this step is saved. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -Flag Sets the flag(s) for the job step. Flag Description ---------------------------------------------------------------------------- AppendAllCmdExecOutputToJobHistory Job history, including command output, is appended to the job history file. AppendToJobHistory Job history is appended to the job history file. AppendToLogFile Job history is appended to the SQL Server log file. AppendToTableLog Job history is appended to a log table. LogToTableWithOverwrite Job history is written to a log table, overwriting previous contents. None Job history is not appended to a file. ProvideStopProcessEvent Job processing is stopped. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | | Accepted Values | AppendAllCmdExecOutputToJobHistory,AppendToJobHistory,AppendToLogFile,AppendToTableLog,LogToTableWithOverwrite,None,ProvideStopProcessEvent | ##### -ProxyName The name of the proxy that the job step runs as. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | | ##### -InputObject Allows pipeline input from Connect-DbaInstance. | Property | Value | | --- | --- | | 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. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | False | ##### -Force The force parameter will ignore some errors in the parameters and assume defaults. | Property | Value | | --- | --- | | Alias | | | Required | False | | Pipeline | false | | Default Value | False | ##### -WhatIf Shows what would happen if the command were to run. No actions are actually performed. | Property | Value | | --- | --- | | Alias | wi | | Required | False | | Pipeline | false | | Default Value | | ##### -Confirm Prompts you for confirmation before executing any changing operations within the command. | Property | Value | | --- | --- | | Alias | cf | | Required | False | | Pipeline | false | | Default Value | | ## Outputs **Microsoft.SqlServer.Management.Smo.Agent.JobStep** Returns one modified JobStep object for each job step updated or created. The object is returned after all changes have been committed to the SQL Server instance. When using -Force, creates new job steps if they don't exist. When updating existing steps, returns the modified JobStep with all changes applied. **All SMO JobStep object properties are accessible and reflect the modifications made by this function, including:** - Name: Job step name - ID: Job step ID within the job - Subsystem: Type of subsystem used (TransactSql, CmdExec, PowerShell, Ssis, etc.) - Command: Command or script to execute - DatabaseName: Database context for T-SQL steps - DatabaseUserName: User account for T-SQL step execution - CommandExecutionSuccessCode: Expected return code for success (CmdExec subsystem) - OnSuccessAction: Action to perform if step succeeds (QuitWithSuccess, QuitWithFailure, GoToNextStep, GoToStep) - OnSuccessStep: Target step ID for GoToStep success action - OnFailAction: Action to perform if step fails (QuitWithFailure, QuitWithSuccess, GoToNextStep, GoToStep) - OnFailStep: Target step ID for GoToStep failure action - RetryAttempts: Number of retry attempts on failure - RetryInterval: Minutes between retry attempts - OutputFileName: File path for step output - ProxyName: SQL Agent proxy account name - JobStepFlags: Output flags (AppendToJobHistory, AppendToLogFile, etc.) - CreateDate: DateTime when step was created - LastModifiedDate: DateTime when step was last modified --- Part of [dbatools](https://dbatools.io/), a free and open source PowerShell module for SQL Server administration. Full command index: https://dbatools.io/commands/