en-US/about_SPDistributedCacheClientSettings.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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
.NAME
    SPDistributedCacheClientSettings

# Description
    
    **Type:** Distributed
    
    This resource is responsible for configuring the distributed cache client
    settings. It only accepts Ensure='Present' as a key. The resource can
    configure the following cache components: DistributedLogonTokenCache,
    DistributedViewStateCache, DistributedAccessCache,
    DistributedActivityFeedCache, DistributedActivityFeedLMTCache,
    DistributedBouncerCache, DistributedDefaultCache, DistributedSearchCache,
    DistributedSecurityTrimmingCache, and DistributedServerToAppServerAccessTokenCache.
    
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Unique key for the resource. Set to 'Yes' to apply configuration.

.PARAMETER DLTCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Logon Token Cache

.PARAMETER DLTCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Logon Token Cache

.PARAMETER DLTCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Logon Token Cache

.PARAMETER DVSCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed View State Cache

.PARAMETER DVSCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed View State Cache

.PARAMETER DVSCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed View State Cache

.PARAMETER DACMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Access Cache

.PARAMETER DACRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Access Cache

.PARAMETER DACChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Access Cache

.PARAMETER DAFMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Activity Feed Cache

.PARAMETER DAFRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Activity Feed Cache

.PARAMETER DAFChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Activity Feed Cache

.PARAMETER DAFCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Activity Feed LMT Cache

.PARAMETER DAFCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Activity Feed LMT Cache

.PARAMETER DAFCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Activity Feed LMT Cache

.PARAMETER DBCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Bouncer Cache

.PARAMETER DBCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Bouncer Cache

.PARAMETER DBCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Bouncer Cache

.PARAMETER DDCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Default Cache

.PARAMETER DDCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Default Cache

.PARAMETER DDCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Default Cache

.PARAMETER DSCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Search Cache

.PARAMETER DSCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Search Cache

.PARAMETER DSCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Search Cache

.PARAMETER DTCMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Security Trimming Cache

.PARAMETER DTCRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Security Trimming Cache

.PARAMETER DTCChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Security Trimming Cache

.PARAMETER DSTACMaxConnectionsToServer
    Write - UInt32
    Maximum number of connections to the Distributed Server to Application Server Cache

.PARAMETER DSTACRequestTimeout
    Write - UInt32
    Request timeout for the Distributed Server to Application Server Cache

.PARAMETER DSTACChannelOpenTimeOut
    Write - UInt32
    Channel timeout for the Distributed Server to Application Server Cache

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example configures the distributed cache client settings.


    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPDistributedCacheClientSettings Settings
            {
                IsSingleInstance            = "Yes"
                DLTCMaxConnectionsToServer  = 3
                DLTCRequestTimeout          = 1000
                DLTCChannelOpenTimeOut      = 1000
                DVSCMaxConnectionsToServer  = 3
                DVSCRequestTimeout          = 1000
                DVSCChannelOpenTimeOut      = 1000
                DACMaxConnectionsToServer   = 3
                DACRequestTimeout           = 1000
                DACChannelOpenTimeOut       = 1000
                DAFMaxConnectionsToServer   = 3
                DAFRequestTimeout           = 1000
                DAFChannelOpenTimeOut       = 1000
                DAFCMaxConnectionsToServer  = 3
                DAFCRequestTimeout          = 1000
                DAFCChannelOpenTimeOut      = 1000
                DBCMaxConnectionsToServer   = 3
                DBCRequestTimeout           = 1000
                DBCChannelOpenTimeOut       = 1000
                DDCMaxConnectionsToServer   = 3
                DDCRequestTimeout           = 1000
                DDCChannelOpenTimeOut       = 1000
                DSCMaxConnectionsToServer   = 3
                DSCRequestTimeout           = 1000
                DSCChannelOpenTimeOut       = 1000
                DTCMaxConnectionsToServer   = 3
                DTCRequestTimeout           = 1000
                DTCChannelOpenTimeOut       = 1000
                DSTACMaxConnectionsToServer = 3
                DSTACRequestTimeout         = 1000
                DSTACChannelOpenTimeOut     = 1000
                PsDscRunAscredential        = $SetupAccount
            }
        }
    }