Get-DbaTraceFlag

Synopsis

Retrieves currently enabled global trace flags from SQL Server instances.

Description

Queries SQL Server instances to identify which global trace flags are currently active, returning detailed status information for monitoring and compliance purposes. This is essential for auditing server configurations, troubleshooting performance issues, and ensuring trace flag consistency across environments. You can filter results to specific trace flag numbers or retrieve all enabled flags across multiple instances.

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.

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.

-TraceFlag

Specifies one or more trace flag numbers to filter the results. Only returns information for the specified trace flags if they are currently enabled.
Use this when you need to check the status of specific trace flags rather than reviewing all enabled flags on the instance.

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

Outputs

PSCustomObject

Returns one object per enabled global trace flag on the SQL Server instance. If -TraceFlag is specified, only those specific trace flags (if currently enabled) are returned. If no global trace flags are enabled, nothing is returned.

Default display properties (via Select-DefaultView):

• ComputerName: The computer name of the SQL Server instance
• InstanceName: The SQL Server instance name
• SqlInstance: The full SQL Server instance name (computer\instance)
• TraceFlag: The trace flag number (integer, e.g., 4199, 3205, 1118)
• Global: Boolean indicating if the trace flag is enabled globally on the server
• Status: Status value for the trace flag (typically 1 for enabled, 0 for disabled) The property Session (indicating session-level flag status) is available but excluded from default view. Use Select-Object * to access all properties including Session.