functions/Get-DbaTraceFlag.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
function Get-DbaTraceFlag {
    <#
  .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.
 
  .PARAMETER SqlInstance
   SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.
 
  .PARAMETER SqlCredential
   SqlCredential object to connect as. If not specified, current Windows login will be used.
 
  .PARAMETER TraceFlag
   Use this switch to filter to a specific Trace Flag.
 
  .PARAMETER Silent
   Use this switch to disable any kind of verbose messages.
 
  .NOTES
   Tags: TraceFlag
   Author: Kevin Bullen (@sqlpadawan)
 
   References: https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-traceon-trace-flags-transact-sql
 
   Website: https://dbatools.io
   Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
   License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
  .LINK
   https://dbatools.io/Get-DbaTraceFlag
 
  .EXAMPLE
   Get-DbaTraceFlag -SqlInstance localhost
 
   Returns all Trace Flag information on the local default SQL Server instance
 
  .EXAMPLE
   Get-DbaTraceFlag -SqlInstance localhost, sql2016
 
   Returns all Trace Flag(s) for the local and sql2016 SQL Server instances
 
  .EXAMPLE
   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.
 #>

    [CmdletBinding()]
    param (
        [parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [PSCredential]
        $SqlCredential,
        [int[]]$TraceFlag,
        [switch]$Silent
    )

    process {
        foreach ($instance in $SqlInstance) {
            try {
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }

            $tflags = $server.EnumActiveGlobalTraceFlags()
            
            if ($tFlags.Rows.Count -eq 0) {
                Write-Message -Level Output -Message "No global trace flags enabled"
                return
            }

            if ($TraceFlag) {
                $tflags = $tflags | Where-Object TraceFlag -In $TraceFlag
            }
                   
                foreach ($tflag in $tflags) {
                    [pscustomobject]@{
                        ComputerName = $server.NetName
                        InstanceName = $server.ServiceName
                        SqlInstance  = $server.DomainInstanceName
                        TraceFlag    = $tflag.TraceFlag
                        Global       = $tflag.Global
                        Session      = $tflag.Session
                        Status       = $tflag.Status
                } | Select-DefaultView -ExcludeProperty 'Session'
            }
        }
    }
}