commands

^

Get-DbaTraceFlag

Author Kevin Bullen (@sqlpadawan)
Availability Windows, Linux, macOS

 

Synopsis

Get global Trace Flag(s) information for each instance(s) of SQL Server.

Description

Returns Trace Flags that are enabled globally on each instance(s) of SQL Server as an object.

Syntax

Get-DbaTraceFlag
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-TraceFlag] <Int32[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaTraceFlag -SqlInstance localhost

Returns all Trace Flag information on the local default SQL Server instance

Example: 2
PS C:\> Get-DbaTraceFlag -SqlInstance localhost, sql2016

Returns all Trace Flag(s) for the local and sql2016 SQL Server instances

Example: 3
PS C:\> Get-DbaTraceFlag -SqlInstance localhost -TraceFlag 4199,3205

Returns Trace Flag status for TF 4199 and 3205 for the local SQL Server instance if they are enabled.

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Alias
Required True
Pipeline true (ByValue)
Default Value

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.

Alias
Required False
Pipeline false
Default Value
-TraceFlag

Use this switch to filter to a specific Trace Flag.

Alias
Required False
Pipeline false
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

 

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