Enable-DbaStartupProcedure

Synopsis

Configures stored procedures in the master database to execute automatically when SQL Server service starts

Description

Marks stored procedures in the master database for automatic execution during SQL Server startup, eliminating the need to manually run initialization scripts after service restarts.
This is essential for DBAs who need to ensure critical maintenance procedures, monitoring setup, or custom configurations are applied consistently every time the instance starts.
The function modifies the procedure’s Startup property using SMO, which is equivalent to running sp_procoption with @OptionValue = ‘on’.
Returns detailed information about each procedure processed, including success status and any error conditions encountered.

Syntax

Enable-DbaStartupProcedure
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-StartupProcedure] <Object[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Enable-DbaStartupProcedure -SqlInstance SqlBox1\Instance2 -StartupProcedure '[dbo].[StartUpProc1]'

Attempts to set the procedure ‘[dbo].[StartUpProc1]’ in the master database of SqlBox1\Instance2 for automatic execution when the instance is started.

Example: 2

PS C:\> $cred = Get-Credential sqladmin
PS C:\> Enable-DbaStartupProcedure -SqlInstance winserver\sqlexpress, sql2016 -SqlCredential $cred -StartupProcedure '[dbo].[StartUpProc1]'

Attempts to set the procedure ‘[dbo].[StartUpProc1]’ in the master database of winserver\sqlexpress and sql2016 for automatic execution when the instance is started. Connects using sqladmin credential

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

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.

-StartupProcedure

Specifies the stored procedure(s) in the master database to enable for automatic startup execution. Accepts schema-qualified names like ‘[dbo].[MyStartupProc]’ or simple names.
Use this when you need specific procedures to run automatically after SQL Server service restarts, such as initialization scripts, monitoring setup, or custom configuration procedures.
Multiple procedures can be specified as an array to enable several startup procedures in a single operation.

-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.

-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.

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Outputs

Microsoft.SqlServer.Management.Smo.StoredProcedure

Returns one StoredProcedure object per procedure that was processed, with the Startup property updated and additional status properties added.

Default display properties (via Select-DefaultView):

• ComputerName: The computer name of the SQL Server instance
• InstanceName: The SQL Server instance name
• SqlInstance: The full SQL Server instance name (computer\instance)
• Database: The database containing the stored procedure (always ‘master’)
• Schema: The schema containing the stored procedure
• Name: The name of the stored procedure
• Startup: Boolean indicating if the procedure will run at SQL Server startup (always $true after successful enable)
• Action: The action performed (‘Enable’)
• Status: Boolean indicating if the enable operation succeeded ($true for success, $false for skipped or failed)
• Note: A string message describing the result (‘Action Enable already performed’, ‘Enable succeeded’, ‘Enable skipped’, or ‘Enable failed’)

Additional properties available (from SMO StoredProcedure object):

• IsSystemObject: Boolean indicating if this is a system object
• CreateDate: DateTime when the procedure was created
• DateLastModified: DateTime when the procedure was last modified
• Text: The T-SQL source code of the stored procedure
• Parent: The Database object containing the procedure All properties from the base SMO StoredProcedure object are accessible via Select-Object *.