DSCResources/MSFT_SPFarm/MSFT_SPFarm.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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure,

        [Parameter(Mandatory = $true)]
        [System.String]
        $FarmConfigDatabaseName,

        [Parameter(Mandatory = $true)]
        [System.String]
        $DatabaseServer,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $FarmAccount,

        [Parameter()]
        [System.Management.Automation.PSCredential]
        $InstallAccount,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $Passphrase,

        [Parameter(Mandatory = $true)]
        [System.String]
        $AdminContentDatabaseName,

        [Parameter(Mandatory = $true)]
        [System.Boolean]
        $RunCentralAdmin,

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

        [Parameter()]
        [System.String]
        [ValidateSet("NTLM","Kerberos")]
        $CentralAdministrationAuth,

        [Parameter()]
        [System.String]
        [ValidateSet("Application",
                     "ApplicationWithSearch",
                     "Custom",
                     "DistributedCache",
                     "Search",
                     "SingleServer",
                     "SingleServerFarm",
                     "WebFrontEnd",
                     "WebFrontEndWithDistributedCache")]
        $ServerRole
    )

    Write-Verbose -Message "Getting the settings of the current local SharePoint Farm (if any)"

    if ($Ensure -eq "Absent")
    {
        throw ("SharePointDsc does not support removing a server from a farm, please set the " + `
               "ensure property to 'present'")
    }

    $installedVersion = Get-SPDSCInstalledProductVersion
    switch ($installedVersion.FileMajorPart)
    {
        15 {
            Write-Verbose -Message "Detected installation of SharePoint 2013"
        }
        16 {
            Write-Verbose -Message "Detected installation of SharePoint 2016"
        }
        default {
            throw ("Detected an unsupported major version of SharePoint. SharePointDsc only " + `
                   "supports SharePoint 2013 or 2016.")
        }
    }

    if (($PSBoundParameters.ContainsKey("ServerRole") -eq $true) `
        -and $installedVersion.FileMajorPart -ne 16)
    {
        throw [Exception] "Server role is only supported in SharePoint 2016."
    }

    if (($PSBoundParameters.ContainsKey("ServerRole") -eq $true) `
        -and $installedVersion.FileMajorPart -eq 16 `
        -and $installedVersion.FileBuildPart -lt 4456 `
        -and ($ServerRole -eq "ApplicationWithSearch" `
             -or $ServerRole -eq "WebFrontEndWithDistributedCache"))
    {
        throw [Exception] ("ServerRole values of 'ApplicationWithSearch' or " + `
                           "'WebFrontEndWithDistributedCache' require the SharePoint 2016 " + `
                           "Feature Pack 1 to be installed. See " + `
                           "https://support.microsoft.com/en-au/kb/3127940")
    }


    # Determine if a connection to a farm already exists
    $majorVersion = $installedVersion.FileMajorPart
    $regPath = "hklm:SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\$majorVersion.0\Secure\ConfigDB"
    $dsnValue = Get-SPDSCRegistryKey -Key $regPath -Value "dsn" -ErrorAction SilentlyContinue

    if ($null -ne $dsnValue)
    {
        # This node has already been connected to a farm
        $result = Invoke-SPDSCCommand -Credential $InstallAccount `
                                  -Arguments $PSBoundParameters `
                                  -ScriptBlock {
            $params = $args[0]

            try
            {
                $spFarm = Get-SPFarm
            }
            catch
            {
                Write-Verbose -Message "Unable to detect local farm."
                return $null
            }

            if ($null -eq $spFarm)
            {
                return $null
            }

            $configDb = Get-SPDatabase | Where-Object -FilterScript {
                $_.Name -eq $spFarm.Name -and $_.Type -eq "Configuration Database"
            }
            $centralAdminSite = Get-SPWebApplication -IncludeCentralAdministration `
                                | Where-Object -FilterScript {
                $_.IsAdministrationWebApplication -eq $true
            }

            if ($params.FarmAccount.UserName -eq $spFarm.DefaultServiceAccount.Name)
            {
                $farmAccount = $params.FarmAccount
            }
            else
            {
                $farmAccount = $spFarm.DefaultServiceAccount.Name
            }

            $centralAdminSite = Get-SPWebApplication -IncludeCentralAdministration `
                                | Where-Object -FilterScript {
                                    $_.IsAdministrationWebApplication -eq $true
                                }

            $centralAdminProvisioned = $false
            $ca = Get-SPServiceInstance -Server $env:ComputerName `
                  | Where-Object -Filterscript {
                        $_.TypeName -eq "Central Administration" -and $_.Status -eq "Online"
                    }
            if ($null -ne $ca)
            {
                $centralAdminProvisioned = $true
            }

            if ($centralAdminSite.IisSettings[0].DisableKerberos -eq $false)
            {
                $centralAdminAuth = "Kerberos"
            }
            else
            {
                $centralAdminAuth = "NTLM"
            }

            $returnValue = @{
                FarmConfigDatabaseName = $spFarm.Name
                DatabaseServer = $configDb.NormalizedDataSource
                FarmAccount = $farmAccount # Need to return this as a credential to match the type expected
                InstallAccount = $null
                Passphrase = $null
                AdminContentDatabaseName = $centralAdminSite.ContentDatabases[0].Name
                RunCentralAdmin = $centralAdminProvisioned
                CentralAdministrationPort = (New-Object -TypeName System.Uri $centralAdminSite.Url).Port
                CentralAdministrationAuth = $centralAdminAuth
            }
            $installedVersion = Get-SPDSCInstalledProductVersion
            if($installedVersion.FileMajorPart -eq 16)
            {
                $server = Get-SPServer -Identity $env:COMPUTERNAME -ErrorAction SilentlyContinue
                if($null -ne $server -and $null -ne $server.Role)
                {
                    $returnValue.Add("ServerRole", $server.Role)
                }
                else
                {
                    $domain = (Get-CimInstance -ClassName Win32_ComputerSystem).Domain
                    $currentServer = "$($env:COMPUTERNAME).$domain"

                    $server = Get-SPServer -Identity $currentServer -ErrorAction SilentlyContinue
                    if($null -ne $server -and $null -ne $server.Role)
                    {
                        $returnValue.Add("ServerRole", $server.Role)
                    }
                }
            }
            return $returnValue
        }

        if ($null -eq $result)
        {
            # The node is currently connected to a farm but was unable to retrieve the values
            # of current farm settings, most likely due to connectivity issues with the SQL box
            Write-Verbose -Message ("This server appears to be connected to a farm already, " + `
                                    "but the configuration database is currently unable to be " + `
                                    "accessed. Values returned from the get method will be " + `
                                    "incomplete, however the 'Ensure' property should be " + `
                                    "considered correct")
            return @{
                FarmConfigDatabaseName = $null
                DatabaseServer = $null
                FarmAccount = $null
                InstallAccount = $null
                Passphrase = $null
                AdminContentDatabaseName = $null
                RunCentralAdmin = $null
                CentralAdministrationPort = $null
                CentralAdministrationAuth = $null
                Ensure = "Present"
            }
        }
        else
        {
            $result.Add("Ensure", "Present")
            return $result
        }
    }
    else
    {
        # This node has never been connected to a farm, return the null return object
        return @{
            FarmConfigDatabaseName = $null
            DatabaseServer = $null
            FarmAccount = $null
            InstallAccount = $null
            Passphrase = $null
            AdminContentDatabaseName = $null
            RunCentralAdmin = $null
            CentralAdministrationPort = $null
            CentralAdministrationAuth = $null
            Ensure = "Absent"
        }
    }
}

function Set-TargetResource
{
    # Supressing the global variable use to allow passing DSC the reboot message
    [CmdletBinding()]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidGlobalVars", "")]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure,

        [Parameter(Mandatory = $true)]
        [System.String]
        $FarmConfigDatabaseName,

        [Parameter(Mandatory = $true)]
        [System.String]
        $DatabaseServer,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $FarmAccount,

        [Parameter()]
        [System.Management.Automation.PSCredential]
        $InstallAccount,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $Passphrase,

        [Parameter(Mandatory = $true)]
        [System.String]
        $AdminContentDatabaseName,

        [Parameter(Mandatory = $true)]
        [System.Boolean]
        $RunCentralAdmin,

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

        [Parameter()]
        [System.String]
        [ValidateSet("NTLM","Kerberos")]
        $CentralAdministrationAuth,

        [Parameter()]
        [System.String]
        [ValidateSet("Application",
                     "ApplicationWithSearch",
                     "Custom",
                     "DistributedCache",
                     "Search",
                     "SingleServer",
                     "SingleServerFarm",
                     "WebFrontEnd",
                     "WebFrontEndWithDistributedCache")]
        $ServerRole
    )

    Write-Verbose -Message "Setting local SP Farm settings"

    if ($Ensure -eq "Absent")
    {
        throw ("SharePointDsc does not support removing a server from a farm, please set the " + `
               "ensure property to 'present'")
    }

    $CurrentValues = Get-TargetResource @PSBoundParameters

    if ($CurrentValues.Ensure -eq "Present")
    {
        throw ("This server is already connected to a farm. " + `
               "Please manually remove it to apply this change.")
    }


    # Set default values to ensure they are passed to Invoke-SPDSCCommand
    if (-not $PSBoundParameters.ContainsKey("CentralAdministrationPort"))
    {
        $PSBoundParameters.Add("CentralAdministrationPort", 9999)
    }
    if (-not $PSBoundParameters.ContainsKey("CentralAdministrationAuth"))
    {
        $PSBoundParameters.Add("CentralAdministrationAuth", "NTLM")
    }

    $actionResult = Invoke-SPDSCCommand -Credential $InstallAccount `
                                        -Arguments @($PSBoundParameters, $PSScriptRoot) `
                                        -ScriptBlock {
        $params = $args[0]
        $scriptRoot = $args[1]

        $modulePath = "..\..\Modules\SharePointDsc.Farm\SPFarm.psm1"
        Import-Module -Name (Join-Path -Path $scriptRoot -ChildPath $modulePath -Resolve)
        $dbStatus = Get-SPDSCConfigDBStatus -SQLServer $params.DatabaseServer `
                                            -Database $params.FarmConfigDatabaseName

        while ($dbStatus.Locked -eq $true)
        {
            Write-Verbose -Message ("[$([DateTime]::Now.ToShortTimeString())] The configuration " + `
                                    "database is currently being provisioned by a remote " + `
                                    "server, this server will wait for this to complete")
            Start-Sleep -Seconds 30
            $dbStatus = Get-SPDSCConfigDBStatus -SQLServer $params.DatabaseServer `
                                                -Database $params.FarmConfigDatabaseName
        }

        if ($dbStatus.ValidPermissions -eq $false)
        {
            throw "The current user does not have sufficient permissions to SQL Server"
            return
        }

        $executeArgs = @{
            DatabaseServer = $params.DatabaseServer
            DatabaseName = $params.FarmConfigDatabaseName
            Passphrase = $params.Passphrase.Password
            SkipRegisterAsDistributedCacheHost = $true
        }

        switch((Get-SPDSCInstalledProductVersion).FileMajorPart)
        {
            15 {
                Write-Verbose -Message "Detected Version: SharePoint 2013"
            }
            16 {
                if ($params.ContainsKey("ServerRole") -eq $true)
                {
                    Write-Verbose -Message ("Detected Version: SharePoint 2016 - " + `
                                            "configuring server as $($params.ServerRole)")
                    $executeArgs.Add("LocalServerRole", $params.ServerRole)
                }
                else
                {
                    Write-Verbose -Message ("Detected Version: SharePoint 2016 - no server " + `
                                            "role provided, configuring server without a " + `
                                            "specific role")
                    $executeArgs.Add("ServerRoleOptional", $true)
                }
            }
            Default {
                throw [Exception] ("An unknown version of SharePoint (Major version $_) " + `
                                    "was detected. Only versions 15 (SharePoint 2013) or " + `
                                    "16 (SharePoint 2016) are supported.")
            }
        }

        if ($dbStatus.DatabaseExists -eq $true)
        {
            Write-Verbose -Message ("The SharePoint config database " + `
                                    "'$($params.FarmConfigDatabaseName)' already exists, so " + `
                                    "this server will join the farm.")
            $createFarm = $false
        }
        elseif ($dbStatus.DatabaseExists -eq $false -and $params.RunCentralAdmin -eq $false)
        {
            # Only allow the farm to be created by a server that will run central admin
            # to avoid a ghost CA site appearing on this server and causing issues
            Write-Verbose -Message ("The SharePoint config database " + `
                                    "'$($params.FarmConfigDatabaseName)' does not exist, but " + `
                                    "this server will not be running the central admin " + `
                                    "website, so it will wait to join the farm rather than " + `
                                    "create one.")
            $createFarm = $false
        }
        else
        {
            Write-Verbose -Message ("The SharePoint config database " + `
                                    "'$($params.FarmConfigDatabaseName)' does not exist, so " + `
                                    "this server will create the farm.")
            $createFarm = $true
        }

        $farmAction = ""
        if ($createFarm -eq $false)
        {
            # The database exists, so attempt to join the farm to the server


            # Remove the server role optional attribute as it is only used when creating
            # a new farm
            if ($executeArgs.ContainsKey("ServerRoleOptional") -eq $true)
            {
                $executeArgs.Remove("ServerRoleOptional")
            }

            Write-Verbose -Message ("The server will attempt to join the farm now once every " + `
                                    "60 seconds for the next 15 minutes.")
            $loopCount = 0
            $connectedToFarm = $false
            $lastException = $null
            while ($connectedToFarm -eq $false -and $loopCount -lt 15)
            {
                try
                {
                    $joinObject = Connect-SPConfigurationDatabase @executeArgs
                    $connectedToFarm = $true
                }
                catch
                {
                    $lastException = $_.Exception
                    Write-Verbose -Message ("$([DateTime]::Now.ToShortTimeString()) - An error " + `
                                            "occured joining config database " + `
                                            "'$($params.FarmConfigDatabaseName)' on " + `
                                            "'$($params.DatabaseServer)'. This resource will " + `
                                            "wait and retry automatically for up to 15 minutes. " + `
                                            "(waited $loopCount of 15 minutes)")
                    $loopCount++
                    Start-Sleep -Seconds 60
                }
            }

            if ($connectedToFarm -eq $false)
            {
                Write-Verbose -Message ("Unable to join config database. Throwing exception.")
                throw $lastException
                return
            }
            $farmAction = "JoinedFarm"
        }
        else
        {
            Add-SPDscConfigDBLock -SQLServer $params.DatabaseServer `
                                  -Database $params.FarmConfigDatabaseName

            try
            {
                $executeArgs += @{
                    FarmCredentials = $params.FarmAccount
                    AdministrationContentDatabaseName = $params.AdminContentDatabaseName
                }

                New-SPConfigurationDatabase @executeArgs

                $farmAction = "CreatedFarm"
            }
            finally
            {
                Remove-SPDscConfigDBLock -SQLServer $params.DatabaseServer `
                                         -Database $params.FarmConfigDatabaseName
            }
        }

        # Run common tasks for a new server
        Install-SPHelpCollection -All | Out-Null
        Initialize-SPResourceSecurity | Out-Null
        Install-SPService | Out-Null
        Install-SPFeature -AllExistingFeatures -Force | Out-Null

        # Provision central administration
        if ($params.RunCentralAdmin -eq $true)
        {
            $centralAdminSite = Get-SPWebApplication -IncludeCentralAdministration `
                                | Where-Object -FilterScript {
                                    $_.IsAdministrationWebApplication -eq $true
                                }


            $centralAdminProvisioned = $false
            if ((New-Object -TypeName System.Uri $centralAdminSite.Url).Port -eq $params.CentralAdministrationPort)
            {
                $centralAdminProvisioned = $true
            }

            if ($centralAdminProvisioned -eq $false)
            {
                New-SPCentralAdministration -Port $params.CentralAdministrationPort `
                                            -WindowsAuthProvider $params.CentralAdministrationAuth
            }
            else
            {
                $serviceInstance = Get-SPServiceInstance -Server $env:COMPUTERNAME `
                                        | Where-Object -FilterScript {
                                            $_.TypeName -eq "Central Administration"
                                        }
                if ($null -eq $serviceInstance)
                {
                    $domain = (Get-CimInstance -ClassName Win32_ComputerSystem).Domain
                    $fqdn = "$($env:COMPUTERNAME).$domain"
                    $serviceInstance = Get-SPServiceInstance -Server $fqdn `
                                        | Where-Object -FilterScript {
                                            $_.TypeName -eq "Central Administration"
                                        }
                }
                if ($null -eq $serviceInstance)
                {
                    throw [Exception] "Unable to locate Central Admin service instance on this server"
                }
                Start-SPServiceInstance -Identity $serviceInstance
            }
        }

        Install-SPApplicationContent | Out-Null

        return $farmAction
    }

    if ($actionResult -eq "JoinedFarm")
    {
        Write-Verbose -Message "Starting timer service"
        Start-Service -Name sptimerv4

        Write-Verbose -Message ("Pausing for 5 minutes to allow the timer service to " + `
                                "fully provision the server")
        Start-Sleep -Seconds 300
        Write-Verbose -Message ("Join farm complete. Restarting computer to allow " + `
                                "configuration to continue")

        $global:DSCMachineStatus = 1
    }
}

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet("Present","Absent")]
        [System.String]
        $Ensure,

        [Parameter(Mandatory = $true)]
        [System.String]
        $FarmConfigDatabaseName,

        [Parameter(Mandatory = $true)]
        [System.String]
        $DatabaseServer,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $FarmAccount,

        [Parameter()]
        [System.Management.Automation.PSCredential]
        $InstallAccount,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $Passphrase,

        [Parameter(Mandatory = $true)]
        [System.String]
        $AdminContentDatabaseName,

        [Parameter(Mandatory = $true)]
        [System.Boolean]
        $RunCentralAdmin,

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

        [Parameter()]
        [System.String]
        [ValidateSet("NTLM","Kerberos")]
        $CentralAdministrationAuth,

        [Parameter()]
        [System.String]
        [ValidateSet("Application",
                     "ApplicationWithSearch",
                     "Custom",
                     "DistributedCache",
                     "Search",
                     "SingleServer",
                     "SingleServerFarm",
                     "WebFrontEnd",
                     "WebFrontEndWithDistributedCache")]
        $ServerRole
    )

    Write-Verbose -Message "Testing local SP Farm settings"

    $CurrentValues = Get-TargetResource @PSBoundParameters

    return Test-SPDscParameterState -CurrentValues $CurrentValues `
                                    -DesiredValues $PSBoundParameters `
                                    -ValuesToCheck @("Ensure")
}

Export-ModuleMember -Function *-TargetResource