Get-DbaStartupProcedure

Want to see the source code for this command? Check out Get-DbaStartupProcedure on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaStartupProcedure.

Synopsis

Retrieves stored procedures configured to run automatically when SQL Server starts up.

Description

This function returns stored procedures from the master database that are configured to execute automatically during SQL Server startup. Startup procedures are useful for initializing application settings, populating cache tables, or performing other tasks that need to run every time the SQL Server service starts. The function returns SMO StoredProcedure objects with details about each startup procedure, including creation dates, schemas, and implementation types. You can filter results to check if specific procedures are configured as startup procedures, which is helpful for auditing server configurations or troubleshooting startup issues.

Syntax

Get-DbaStartupProcedure
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-StartupProcedure] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaStartupProcedure -SqlInstance SqlBox1\Instance2

Returns an object with all startup procedures for the Instance2 instance on SqlBox1

Example: 2

PS C:\> Get-DbaStartupProcedure -SqlInstance SqlBox1\Instance2 -StartupProcedure 'dbo.StartupProc'

Returns an object with a startup procedure named 'dbo.StartupProc' for the Instance2 instance on SqlBox1

Example: 3

PS C:\> Get-DbaRegServer -SqlInstance sql2014 | Get-DbaStartupProcedure

Returns an object with all startup procedures for every server listed in the Central Management Server on sql2014

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

Filters results to check if specific stored procedures are configured as startup procedures. Accepts procedure names in 'schema.procedurename' format or just 'procedurename' for dbo schema.
Use this when auditing server configurations or verifying that critical initialization procedures are properly configured to run at startup.

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