DSCResources/MSFT_xClusterProperty/MSFT_xClusterProperty.psm1

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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
$script:resourceHelperModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\DscResource.Common'

Import-Module -Name $script:resourceHelperModulePath

$script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'

<#
    .SYNOPSIS
        Configures cluster properties.
 
    .PARAMETER Name
        Name of the cluster.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name
    )

    Write-Verbose -Message ($script:localizedData.GettingClusterProperties -f $Name)

    $cluster = Get-Cluster -Name $Name
    $returnValue = @{
        Name                     = $Name
        AddEvictDelay            = $cluster.AddEvictDelay
        BlockCacheSize           = $cluster.BlockCacheSize
        ClusterLogLevel          = $cluster.ClusterLogLevel
        ClusterLogSize           = $cluster.ClusterLogSize
        CrossSiteDelay           = $cluster.CrossSiteDelay
        CrossSiteThreshold       = $cluster.CrossSiteThreshold
        Description              = $cluster.Description
        CrossSubnetDelay         = $cluster.CrossSubnetDelay
        CrossSubnetThreshold     = $cluster.CrossSubnetThreshold
        DatabaseReadWriteMode    = $cluster.DatabaseReadWriteMode
        DefaultNetworkRole       = $cluster.DefaultNetworkRole
        DrainOnShutdown          = $cluster.DrainOnShutdown
        DynamicQuorum            = $cluster.DynamicQuorum
        NetftIPSecEnabled        = $cluster.NetftIPSecEnabled
        QuarantineDuration       = $cluster.QuarantineDuration
        PreferredSite            = $cluster.PreferredSite
        QuarantineThreshold      = $cluster.QuarantineThreshold
        SameSubnetDelay          = $cluster.SameSubnetDelay
        SameSubnetThreshold      = $cluster.SameSubnetThreshold
        ShutdownTimeoutInMinutes = $cluster.ShutdownTimeoutInMinutes
    }

    return $returnValue
}
<#
    .SYNOPSIS
        Configures cluster properties.
 
    .PARAMETER AddEvictDelay
        Specifies how many seconds after a node is evicted that the failover cluster service will wait before adding a new node.
 
    .PARAMETER BlockCacheSize
        Controls the size of the Cluster Shared Volume Memory Cache in MB.
 
    .PARAMETER ClusterLogLevel
        Controls the level of cluster logging.
 
    .PARAMETER ClusterLogSize
        Controls the maximum size of the cluster log files on each of the nodes.
 
    .PARAMETER CrossSiteDelay
        Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across sites.
 
    .PARAMETER CrossSiteThreshold
        Controls how many Cluster Service heartbeats can be missed across sites before it determines that Cluster Service has stopped responding.
 
    .PARAMETER CrossSubnetDelay
        Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across subnets.
 
    .PARAMETER CrossSubnetThreshold
        Controls how many Cluster Service heartbeats can be missed across subnets before it determines that Cluster Service has stopped responding.
 
    .PARAMETER DatabaseReadWriteMode
        Specifies the read/write mode for the cluster database.
 
    .PARAMETER DefaultNetworkRole
        Specifies the role that the cluster automatically assigns to any newly discovered or created network.
 
    .PARAMETER Description
        Stores administrative comments about the cluster. The following table summarizes the attributes of the Description property.
 
    .PARAMETER DrainOnShutdown
        Specifies whether to enable Node Drain for a cluster.
 
    .PARAMETER DynamicQuorum
        Enables the cluster to change the required number of nodes that need to participate in quorum when nodes shut down or crash.
 
    .PARAMETER Name
        Name of the cluster.
 
    .PARAMETER NetftIPSecEnabled
        Specifies whether Internet Protocol Security (IPSec) encryption is enabled for inter-node cluster communication.
 
    .PARAMETER PreferredSite
        Specifies the preferred site for a site-aware cluster.
 
    .PARAMETER QuarantineDuration
        Specifies the quarantine duration for a node, in seconds.
 
    .PARAMETER QuarantineThreshold
        Specifies the quarantine threshold for a node, in minutes.
 
    .PARAMETER SameSubnetDelay
        Controls the delay, in milliseconds, between netft heartbeats.
 
    .PARAMETER SameSubnetThreshold
        Controls how many heartbeats can be missed on the same subnet before the route is declared as unreachable.
 
    .PARAMETER ShutdownTimeoutInMinutes
        Specifies how many minutes after a system shutdown is initiated that the failover cluster service will wait for resources to go offline.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [System.UInt32]
        $AddEvictDelay,

        [Parameter()]
        [System.UInt32]
        $BlockCacheSize,

        [Parameter()]
        [System.UInt32]
        $ClusterLogLevel,

        [Parameter()]
        [System.UInt32]
        $ClusterLogSize,

        [Parameter()]
        [System.UInt32]
        $CrossSiteDelay,

        [Parameter()]
        [System.UInt32]
        $CrossSiteThreshold,

        [Parameter()]
        [System.UInt32]
        $CrossSubnetDelay,

        [Parameter()]
        [System.UInt32]
        $CrossSubnetThreshold,

        [Parameter()]
        [System.UInt32]
        $DatabaseReadWriteMode,

        [Parameter()]
        [System.UInt32]
        $DefaultNetworkRole,

        [Parameter()]
        [System.String]
        $Description,

        [Parameter()]
        [System.UInt32]
        $DrainOnShutdown,

        [Parameter()]
        [System.UInt32]
        $DynamicQuorum,

        [Parameter()]
        [System.UInt32]
        $NetftIPSecEnabled,

        [Parameter()]
        [System.String]
        $PreferredSite,

        [Parameter()]
        [System.UInt32]
        $QuarantineDuration,

        [Parameter()]
        [System.UInt32]
        $QuarantineThreshold,

        [Parameter()]
        [System.UInt32]
        $SameSubnetDelay,

        [Parameter()]
        [System.UInt32]
        $SameSubnetThreshold,

        [Parameter()]
        [System.UInt32]
        $ShutdownTimeoutInMinutes
    )

    Write-Verbose -Message ($script:localizedData.SettingClusterProperties)

    $boundParameters = $PSBoundParameters
    $boundParameters.Remove('Name') | Out-Null
    $boundParameters.Remove('Verbose') | Out-Null

    $cluster = Get-Cluster -Name $Name
    foreach ($boundParameter in $boundParameters.GetEnumerator())
    {
        Write-Verbose -Message ($script:localizedData.SettingClusterProperty -f $($boundParameter.Key), $boundParameter.Value)
        $cluster.$($boundParameter.Key) = $boundParameter.Value
    }
}
<#
    .SYNOPSIS
        Configures cluster properties.
 
    .PARAMETER AddEvictDelay
        Specifies how many seconds after a node is evicted that the failover cluster service will wait before adding a new node.
 
    .PARAMETER BlockCacheSize
        Controls the size of the Cluster Shared Volume Memory Cache in MB.
 
    .PARAMETER ClusterLogLevel
        Controls the level of cluster logging.
 
    .PARAMETER ClusterLogSize
        Controls the maximum size of the cluster log files on each of the nodes.
 
    .PARAMETER CrossSiteDelay
        Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across sites.
 
    .PARAMETER CrossSiteThreshold
        Controls how many Cluster Service heartbeats can be missed across sites before it determines that Cluster Service has stopped responding.
 
    .PARAMETER CrossSubnetDelay
        Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across subnets.
 
    .PARAMETER CrossSubnetThreshold
        Controls how many Cluster Service heartbeats can be missed across subnets before it determines that Cluster Service has stopped responding.
 
    .PARAMETER DatabaseReadWriteMode
        Specifies the read/write mode for the cluster database.
 
    .PARAMETER DefaultNetworkRole
        Specifies the role that the cluster automatically assigns to any newly discovered or created network.
 
    .PARAMETER Description
        Stores administrative comments about the cluster. The following table summarizes the attributes of the Description property.
 
    .PARAMETER DrainOnShutdown
        Specifies whether to enable Node Drain for a cluster.
 
    .PARAMETER DynamicQuorum
        Enables the cluster to change the required number of nodes that need to participate in quorum when nodes shut down or crash.
 
    .PARAMETER Name
        Name of the cluster.
 
    .PARAMETER NetftIPSecEnabled
        Specifies whether Internet Protocol Security (IPSec) encryption is enabled for inter-node cluster communication.
 
    .PARAMETER PreferredSite
        Specifies the preferred site for a site-aware cluster.
 
    .PARAMETER QuarantineDuration
        Specifies the quarantine duration for a node, in seconds.
 
    .PARAMETER QuarantineThreshold
        Specifies the quarantine threshold for a node, in minutes.
 
    .PARAMETER SameSubnetDelay
        Controls the delay, in milliseconds, between netft heartbeats.
 
    .PARAMETER SameSubnetThreshold
        Controls how many heartbeats can be missed on the same subnet before the route is declared as unreachable.
 
    .PARAMETER ShutdownTimeoutInMinutes
        Specifies how many minutes after a system shutdown is initiated that the failover cluster service will wait for resources to go offline.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [System.UInt32]
        $AddEvictDelay,

        [Parameter()]
        [System.UInt32]
        $BlockCacheSize,

        [Parameter()]
        [System.UInt32]
        $ClusterLogLevel,

        [Parameter()]
        [System.UInt32]
        $ClusterLogSize,

        [Parameter()]
        [System.UInt32]
        $CrossSiteDelay,

        [Parameter()]
        [System.UInt32]
        $CrossSiteThreshold,

        [Parameter()]
        [System.UInt32]
        $CrossSubnetDelay,

        [Parameter()]
        [System.UInt32]
        $CrossSubnetThreshold,

        [Parameter()]
        [System.UInt32]
        $DatabaseReadWriteMode,

        [Parameter()]
        [System.UInt32]
        $DefaultNetworkRole,

        [Parameter()]
        [System.String]
        $Description,

        [Parameter()]
        [System.UInt32]
        $DrainOnShutdown,

        [Parameter()]
        [System.UInt32]
        $DynamicQuorum,

        [Parameter()]
        [System.UInt32]
        $NetftIPSecEnabled,

        [Parameter()]
        [System.String]
        $PreferredSite,

        [Parameter()]
        [System.UInt32]
        $QuarantineDuration,

        [Parameter()]
        [System.UInt32]
        $QuarantineThreshold,

        [Parameter()]
        [System.UInt32]
        $SameSubnetDelay,

        [Parameter()]
        [System.UInt32]
        $SameSubnetThreshold,

        [Parameter()]
        [System.UInt32]
        $ShutdownTimeoutInMinutes
    )

    Write-Verbose -Message ($script:localizedData.GettingClusterProperties -f $Name)

    $boundParameters = $PSBoundParameters
    $boundParameters.Remove('Name') | Out-Null
    $boundParameters.Remove('Result') | Out-Null
    $boundParameters.Remove('Verbose') | Out-Null
    $boundParameters.Remove('Debug') | Out-Null

    $cluster = Get-Cluster -Name $Name

    $output = $true

    foreach ($boundParameter in $boundParameters.GetEnumerator())
    {
        if ($cluster.$($boundParameter.Key) -ne $boundParameter.Value)
        {
            Write-Debug -Message ($script:localizedData.IncorrectClusterProperty -f $($boundParameter.Key), $cluster.$($boundParameter.Key), $boundParameter.Value)
            Write-Verbose -Message ($script:localizedData.IncorrectClusterProperty -f $($boundParameter.Key), $cluster.$($boundParameter.Key), $boundParameter.Value)
            $output = $false
        }
    }

    return $output
}

Export-ModuleMember -Function *-TargetResource