Set‑SqlDscStartupParameter

SYNOPSIS

Sets startup parameters on a Database Engine instance.

SYNTAX

ByServerName (Default)

Set-SqlDscStartupParameter [-ServerName <String>] [-InstanceName <String>] [-TraceFlag <UInt32[]>]
 [-InternalTraceFlag <UInt32[]>] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ByServiceObject

Set-SqlDscStartupParameter -ServiceObject <Service> [-TraceFlag <UInt32[]>] [-InternalTraceFlag <UInt32[]>]
 [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets startup parameters on a Database Engine instance.

EXAMPLES

EXAMPLE 1

Set-SqlDscStartupParameters -TraceFlag 4199

Replaces the trace flags with 4199 on the Database Engine default instance on the server where the command in run.

EXAMPLE 2

$serviceObject = Get-SqlDscManagedComputerService -ServiceType 'DatabaseEngine'
Set-SqlDscTraceFlag -ServiceObject $serviceObject -TraceFlag 4199

Replaces the trace flags with 4199 on the Database Engine default instance on the server where the command in run.

EXAMPLE 3

Set-SqlDscTraceFlag -InstanceName 'SQL2022' -TraceFlag @()

Removes all the trace flags from the Database Engine instance 'SQL2022' on the server where the command in run.

PARAMETERS

-Force

Specifies that the startup parameters should be set without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-InstanceName

Specifies the instance name on which to set the startup parameters.

Type: String
Parameter Sets: ByServerName
Aliases:

Required: False
Position: Named
Default value: MSSQLSERVER
Accept pipeline input: False
Accept wildcard characters: False

-InternalTraceFlag

Specifies the internal trace flags to set.

From the Database Engine Service Startup Options documentation: "...this sets other internal trace flags that are required only by SQL Server support engineers."

Type: UInt32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ServerName

Specifies the server name where the instance exist.

Type: String
Parameter Sets: ByServerName
Aliases:

Required: False
Position: Named
Default value: (Get-ComputerName)
Accept pipeline input: False
Accept wildcard characters: False

-ServiceObject

Specifies the Service object on which to set the startup parameters.

Type: Service
Parameter Sets: ByServiceObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TraceFlag

Specifies the trace flags to set.

Type: UInt32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

None.

NOTES

This command should support setting the values according to this documentation: https://learn.microsoft.com/en-us/sql/database-engine/configure-windows/database-engine-service-startup-options

RELATED LINKS