DSCResources/DSC_SqlTraceFlag/en-US/about_SqlTraceFlag.help.txt

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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
.NAME
    SqlTraceFlag
 
.DESCRIPTION
    The `SqlTraceFlag` DSC resource will remove or set one or more trace flags on a sql server engine.
 
    ## Requirements
 
    * Target machine must be running Windows Server 2012 or later.
    * Target machine must be running SQL Server Database Engine 2012 or later.
 
    ## Security Requirements
 
    * The account running this resource must have admin access to the Windows Server.
 
    ## Known issues
 
    All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlTraceFlag).
 
.PARAMETER ServerName
    Write - String
    The host name of the SQL Server to be configured. Default value is the current computer name.
 
.PARAMETER InstanceName
    Key - String
    The name of the SQL Server instance to be configured.
 
.PARAMETER TraceFlags
    Write - UInt32Array
    An array of trace flags that startup options should have. This parameter will replace all the current trace flags with the specified trace flags.
 
.PARAMETER TraceFlagsToInclude
    Write - UInt32Array
    An array of trace flags to be added to the existing trace flags.
 
.PARAMETER TraceFlagsToExclude
    Write - UInt32Array
    An array of trace flags to be removed from the existing trace flags.
 
.PARAMETER RestartService
    Write - Boolean
    Forces a restart of the Database Engine service and dependent services after the desired state is set. Default values is $false.
 
.PARAMETER RestartTimeout
    Write - UInt32
    The time the resource waits while the sql server services are restarted. Defaults to 120 seconds
 
.EXAMPLE 1
 
This example shows how to set TraceFlags where all existing
TraceFlags are overwriten by these
 
Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $SqlAdministratorCredential
    )
 
    Import-DscResource -ModuleName 'SqlServerDsc'
 
    node localhost
    {
        SqlTraceFlag 'Set_SqlTraceFlags'
        {
            ServerName = 'sqltest.company.local'
            InstanceName = 'DSC'
            TraceFlags = 834, 1117, 1118, 2371, 3226
            RestartService = $true
 
            PsDscRunAsCredential = $SqlAdministratorCredential
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to set TraceFlags while keeping all existing
traceflags. Also one existing traceflag is removed.
 
Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $SqlAdministratorCredential
    )
 
    Import-DscResource -ModuleName 'SqlServerDsc'
 
    node localhost
    {
        SqlTraceFlag 'Set_SqlTraceFlagsIncludeExclude'
        {
            ServerName = 'sqltest.company.local'
            InstanceName = 'DSC'
            TraceFlagsToInclude = 834, 1117, 1118, 2371, 3226
            TraceFlagsToExclude = 1112
            RestartService = $true
 
            PsDscRunAsCredential = $SqlAdministratorCredential
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to clear all TraceFlags.
 
Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $SqlAdministratorCredential
    )
 
    Import-DscResource -ModuleName 'SqlServerDsc'
 
    node localhost
    {
        SqlTraceFlag 'Remove_SqlTraceFlags'
        {
            ServerName = 'sqltest.company.local'
            InstanceName = 'DSC'
            RestartService = $true
            TraceFlags = @()
 
            PsDscRunAsCredential = $SqlAdministratorCredential
        }
    }
}