< Back
Enable-DbaStartupProcedure
Post
NAME Enable-DbaStartupProcedure
SYNOPSIS
Sets a procedure to execute automatically each time the SQL Server service is started
SYNTAX
Enable-DbaStartupProcedure [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-StartupProcedure] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Used to designate 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 = on
Returns the SMO StoredProcedure object for procedures affected.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-StartupProcedure [<System.Object[]>]
The Procedure(s) to process.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Procedure, Startup, StartupProcedure
Author: Patrick Flynn (@sqllensman)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Enable-DbaStartupProcedure
SYNOPSIS
Sets a procedure to execute automatically each time the SQL Server service is started
SYNTAX
Enable-DbaStartupProcedure [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-StartupProcedure] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Used to designate 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 = on
Returns the SMO StoredProcedure object for procedures affected.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-StartupProcedure [<System.Object[]>]
The Procedure(s) to process.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Procedure, Startup, StartupProcedure
Author: Patrick Flynn (@sqllensman)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Enable-DbaStartupProcedure