commands

^

Disable-DbaStartupProcedure

Author Patrick Flynn (@sqllensman)
Availability Windows, Linux, macOS

 

Synopsis

Disables the automatic execution of procedure(s) that are set to execute automatically each time the SQL Server service is started

Description

Used to revoke the designation of one or more stored procedures to automatically execute when the SQL Server service is started. Equivalent to running the system stored procedure sp_procoption with @OptionValue = off Returns the SMO StoredProcedure object for procedures affected.

Syntax

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

 

Examples

 

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

Attempts to clear the automatic execution of the procedure '[dbo].[StartUpProc1]' in the master database of SqlBox1\Instance2 when the instance is started.

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

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

Example: 3
PS C:\> Get-DbaStartupProcedure -SqlInstance sql2016 | Disable-DbaStartupProcedure

Get all startup procedures for the sql2016 instance and disables them by piping to Disable-DbaStartupProcedure

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

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.

Alias
Required False
Pipeline false
Default Value
-StartupProcedure

The Procedure(s) to process.

Alias
Required False
Pipeline false
Default Value
-InputObject

Piped objects from Get-DbaStartup

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.

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 Disable-DbaStartupProcedure on GitHub.
Want to see the Bill Of Health for this command? Check out Disable-DbaStartupProcedure.