DSCResources/MSFT_SPInstallPrereqs/MSFT_SPInstallPrereqs.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 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 |
$Script:SP2013Features = @("Application-Server", "AS-NET-Framework", "AS-TCP-Port-Sharing", "AS-Web-Support", "AS-WAS-Support", "AS-HTTP-Activation", "AS-Named-Pipes", "AS-TCP-Activation", "Web-Server", "Web-WebServer", "Web-Common-Http", "Web-Default-Doc", "Web-Dir-Browsing", "Web-Http-Errors", "Web-Static-Content", "Web-Http-Redirect", "Web-Health", "Web-Http-Logging", "Web-Log-Libraries", "Web-Request-Monitor", "Web-Http-Tracing", "Web-Performance", "Web-Stat-Compression", "Web-Dyn-Compression", "Web-Security", "Web-Filtering", "Web-Basic-Auth", "Web-Client-Auth", "Web-Digest-Auth", "Web-Cert-Auth", "Web-IP-Security", "Web-Url-Auth", "Web-Windows-Auth", "Web-App-Dev", "Web-Net-Ext", "Web-Net-Ext45", "Web-Asp-Net", "Web-Asp-Net45", "Web-ISAPI-Ext", "Web-ISAPI-Filter", "Web-Mgmt-Tools", "Web-Mgmt-Console", "Web-Mgmt-Compat", "Web-Metabase", "Web-Lgcy-Scripting", "Web-WMI", "Web-Scripting-Tools", "NET-Framework-Features", "NET-Framework-Core", "NET-Framework-45-ASPNET", "NET-WCF-HTTP-Activation45", "NET-WCF-Pipe-Activation45", "NET-WCF-TCP-Activation45", "Server-Media-Foundation", "Windows-Identity-Foundation", "PowerShell-V2", "WAS", "WAS-Process-Model", "WAS-NET-Environment", "WAS-Config-APIs", "XPS-Viewer") $Script:SP2016Win19Features = @("Web-Server", "Web-WebServer", "Web-Common-Http", "Web-Default-Doc", "Web-Dir-Browsing", "Web-Http-Errors", "Web-Static-Content", "Web-Health", "Web-Http-Logging", "Web-Log-Libraries", "Web-Request-Monitor", "Web-Http-Tracing", "Web-Performance", "Web-Stat-Compression", "Web-Dyn-Compression", "Web-Security", "Web-Filtering", "Web-Basic-Auth", "Web-Digest-Auth", "Web-Windows-Auth", "Web-App-Dev", "Web-Net-Ext", "Web-Net-Ext45", "Web-Asp-Net", "Web-Asp-Net45", "Web-ISAPI-Ext", "Web-ISAPI-Filter", "Web-Mgmt-Tools", "Web-Mgmt-Console", "Web-Mgmt-Compat", "Web-Metabase", "Web-Lgcy-Scripting", "Web-WMI", "NET-Framework-Features", "NET-HTTP-Activation", "NET-Non-HTTP-Activ", "NET-Framework-45-ASPNET", "NET-WCF-Pipe-Activation45", "Windows-Identity-Foundation", "WAS", "WAS-Process-Model", "WAS-NET-Environment", "WAS-Config-APIs", "XPS-Viewer") $Script:SP2016Win16Features = @("Web-Server", "Web-WebServer", "Web-Common-Http", "Web-Default-Doc", "Web-Dir-Browsing", "Web-Http-Errors", "Web-Static-Content", "Web-Health", "Web-Http-Logging", "Web-Log-Libraries", "Web-Request-Monitor", "Web-Http-Tracing", "Web-Performance", "Web-Stat-Compression", "Web-Dyn-Compression", "Web-Security", "Web-Filtering", "Web-Basic-Auth", "Web-Digest-Auth", "Web-Windows-Auth", "Web-App-Dev", "Web-Net-Ext", "Web-Net-Ext45", "Web-Asp-Net", "Web-Asp-Net45", "Web-ISAPI-Ext", "Web-ISAPI-Filter", "Web-Mgmt-Tools", "Web-Mgmt-Console", "Web-Mgmt-Compat", "Web-Metabase", "Web-Lgcy-Scripting", "Web-WMI", "NET-Framework-Features", "NET-HTTP-Activation", "NET-Non-HTTP-Activ", "NET-Framework-45-ASPNET", "NET-WCF-Pipe-Activation45", "Windows-Identity-Foundation", "WAS", "WAS-Process-Model", "WAS-NET-Environment", "WAS-Config-APIs", "XPS-Viewer") $Script:SP2016Win12r2Features = @("Application-Server", "AS-NET-Framework", "AS-Web-Support", "Web-Server", "Web-WebServer", "Web-Common-Http", "Web-Default-Doc", "Web-Dir-Browsing", "Web-Http-Errors", "Web-Static-Content", "Web-Http-Redirect", "Web-Health", "Web-Http-Logging", "Web-Log-Libraries", "Web-Request-Monitor", "Web-Performance", "Web-Stat-Compression", "Web-Dyn-Compression", "Web-Security", "Web-Filtering", "Web-Basic-Auth", "Web-Client-Auth", "Web-Digest-Auth", "Web-Cert-Auth", "Web-IP-Security", "Web-Url-Auth", "Web-Windows-Auth", "Web-App-Dev", "Web-Net-Ext", "Web-Net-Ext45", "Web-Asp-Net45", "Web-ISAPI-Ext", "Web-ISAPI-Filter", "Web-Mgmt-Tools", "Web-Mgmt-Console", "Web-Mgmt-Compat", "Web-Metabase", "Web-Lgcy-Mgmt-Console", "Web-Lgcy-Scripting", "Web-WMI", "Web-Scripting-Tools", "NET-Framework-Features", "NET-Framework-Core", "NET-HTTP-Activation", "NET-Non-HTTP-Activ", "NET-Framework-45-ASPNET", "NET-WCF-HTTP-Activation45", "Windows-Identity-Foundation", "PowerShell-V2", "WAS", "WAS-Process-Model", "WAS-NET-Environment", "WAS-Config-APIs") $Script:SP2019Win16Features = @("Web-Server", "Web-WebServer", "Web-Common-Http", "Web-Default-Doc", "Web-Dir-Browsing", "Web-Http-Errors", "Web-Static-Content", "Web-Health", "Web-Http-Logging", "Web-Log-Libraries", "Web-Request-Monitor", "Web-Http-Tracing", "Web-Performance", "Web-Stat-Compression", "Web-Dyn-Compression", "Web-Security", "Web-Filtering", "Web-Basic-Auth", "Web-Windows-Auth", "Web-App-Dev", "Web-Net-Ext", "Web-Net-Ext45", "Web-Asp-Net", "Web-Asp-Net45", "Web-ISAPI-Ext", "Web-ISAPI-Filter", "Web-Mgmt-Tools", "Web-Mgmt-Console", "NET-Framework-Features", "NET-HTTP-Activation", "NET-Non-HTTP-Activ", "NET-Framework-45-ASPNET", "NET-WCF-Pipe-Activation45", "Windows-Identity-Foundation", "WAS", "WAS-Process-Model", "WAS-NET-Environment", "WAS-Config-APIs", "XPS-Viewer") $Script:SP2019Win19Features = @("Web-Server", "Web-WebServer", "Web-Common-Http", "Web-Default-Doc", "Web-Dir-Browsing", "Web-Http-Errors", "Web-Static-Content", "Web-Health", "Web-Http-Logging", "Web-Log-Libraries", "Web-Request-Monitor", "Web-Http-Tracing", "Web-Performance", "Web-Stat-Compression", "Web-Dyn-Compression", "Web-Security", "Web-Filtering", "Web-Basic-Auth", "Web-Windows-Auth", "Web-App-Dev", "Web-Net-Ext", "Web-Net-Ext45", "Web-Asp-Net", "Web-Asp-Net45", "Web-ISAPI-Ext", "Web-ISAPI-Filter", "Web-Mgmt-Tools", "Web-Mgmt-Console", "NET-Framework-Features", "NET-HTTP-Activation", "NET-Non-HTTP-Activ", "NET-Framework-45-ASPNET", "NET-WCF-Pipe-Activation45", "Windows-Identity-Foundation", "WAS", "WAS-Process-Model", "WAS-NET-Environment", "WAS-Config-APIs", "XPS-Viewer") function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter(Mandatory = $true)] [System.String] $InstallerPath, [Parameter(Mandatory = $true)] [System.Boolean] $OnlineMode, [Parameter()] [System.String] $SXSpath, [Parameter()] [System.String] $SQLNCli, [Parameter()] [System.String] $PowerShell, [Parameter()] [System.String] $NETFX, [Parameter()] [System.String] $IDFX, [Parameter()] [System.String] $Sync, [Parameter()] [System.String] $AppFabric, [Parameter()] [System.String] $IDFX11, [Parameter()] [System.String] $MSIPCClient, [Parameter()] [System.String] $WCFDataServices, [Parameter()] [System.String] $KB2671763, [Parameter()] [System.String] $WCFDataServices56, [Parameter()] [System.String] $MSVCRT11, [Parameter()] [System.String] $MSVCRT14, [Parameter()] [System.String] $MSVCRT141, [Parameter()] [System.String] $KB3092423, [Parameter()] [System.String] $ODBC, [Parameter()] [System.String] $DotNetFx, [Parameter()] [System.String] $DotNet472, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present" ) Write-Verbose -Message "Getting installation status of SharePoint prerequisites" Write-Verbose -Message "Check if InstallerPath folder exists" if (-not(Test-Path -Path $InstallerPath)) { $message = "PrerequisitesInstaller cannot be found: {$InstallerPath}" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "Checking file status of $InstallerPath" $checkBlockedFile = $true if (Split-Path -Path $InstallerPath -IsAbsolute) { $driveLetter = (Split-Path -Path $InstallerPath -Qualifier).TrimEnd(":") Write-Verbose -Message "InstallerPath refers to drive $driveLetter" $volume = Get-Volume -DriveLetter $driveLetter -ErrorAction SilentlyContinue if ($null -ne $volume) { if ($volume.DriveType -ne "CD-ROM") { Write-Verbose -Message "Volume is a fixed drive: Perform Blocked File test" } else { Write-Verbose -Message "Volume is a CD-ROM drive: Skipping Blocked File test" $checkBlockedFile = $false } } else { Write-Verbose -Message "Volume not found. Unable to determine the type. Continuing." } } if ($checkBlockedFile -eq $true) { Write-Verbose -Message "Checking status now" try { $zone = Get-Item -Path $InstallerPath -Stream "Zone.Identifier" -EA SilentlyContinue } catch { Write-Verbose -Message 'Encountered error while reading file stream. Ignoring file stream.' } if ($null -ne $zone) { $message = ("PrerequisitesInstaller is blocked! Please use 'Unblock-File -Path " + ` "$InstallerPath' to unblock the file before continuing.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "File not blocked, continuing." } $majorVersion = (Get-SPDscAssemblyVersion -PathToAssembly $InstallerPath) $buildVersion = (Get-SPDscBuildVersion -PathToAssembly $InstallerPath) if ($majorVersion -eq 15) { Write-Verbose -Message "Version: SharePoint 2013" } if ($majorVersion -eq 16) { if ($buildVersion -lt 5000) { Write-Verbose -Message "Version: SharePoint 2016" } elseif ($buildVersion -ge 5000) { Write-Verbose -Message "Version: SharePoint 2019" } } Write-Verbose -Message "Getting installed windows features" $osVersion = Get-SPDscOSVersion if ($majorVersion -eq 15) { if ($osVersion.Major -ne 6) { $message = "SharePoint 2013 only supports Windows Server 2012 R2 and below" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2013Features } elseif ($majorVersion -eq 16) { if ($buildVersion -lt 5000) { if ($osVersion.Major -eq 10) { if ($osVersion.Build -lt 17763) { Write-Verbose -Message "OS Version: Windows Server 2016" $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2016Win16Features } else { Write-Verbose -Message "OS Version: Windows Server 2019" $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2016Win19Features } } elseif ($osVersion.Major -eq 6 -and $osVersion.Minor -eq 3) { Write-Verbose -Message "OS Version: Windows Server 2012 R2" $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2016Win12r2Features } else { $message = "SharePoint 2016 only supports Windows Server 2019, 2016 or 2012 R2" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } # SharePoint 2019 elseif ($buildVersion -ge 5000) { if ($osVersion.Major -eq 10) { if ($osVersion.Build -lt 17763) { Write-Verbose -Message "OS Version: Windows Server 2016" $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2019Win16Features } else { Write-Verbose -Message "OS Version: Windows Server 2019" $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2019Win19Features } } else { $message = "SharePoint 2019 only supports Windows Server 2016 or Windows Server 2019" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } } $windowsFeaturesInstalled = $true foreach ($feature in $WindowsFeatures) { if ($feature.Installed -eq $false) { $windowsFeaturesInstalled = $false Write-Verbose -Message "Windows feature $($feature.Name) is not installed" } } Write-Verbose -Message "Checking windows packages from the registry" $x86Path = "HKLM:\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*" $installedItemsX86 = Get-ItemProperty -Path $x86Path | Select-Object -Property DisplayName, BundleUpgradeCode, DisplayVersion $x64Path = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*" $installedItemsX64 = Get-ItemProperty -Path $x64Path | Select-Object -Property DisplayName, BundleUpgradeCode, DisplayVersion $installedItems = $installedItemsX86 + $installedItemsX64 | Select-Object -Property DisplayName, BundleUpgradeCode, DisplayVersion -Unique # Common prereqs $prereqsToTest = @( [PSObject]@{ Name = "AppFabric 1.1 for Windows Server" SearchType = "Equals" SearchValue = "AppFabric 1.1 for Windows Server" }, [PSObject]@{ Name = "Microsoft CCR and DSS Runtime 2008 R3" SearchType = "Equals" SearchValue = "Microsoft CCR and DSS Runtime 2008 R3" }, [PSObject]@{ Name = "Microsoft Identity Extensions" SearchType = "Equals" SearchValue = "Microsoft Identity Extensions" }, [PSObject]@{ Name = "Microsoft Sync Framework Runtime v1.0 SP1 (x64)" SearchType = "Equals" SearchValue = "Microsoft Sync Framework Runtime v1.0 SP1 (x64)" }, [PSObject]@{ Name = "WCF Data Services 5.6.0 Runtime" SearchType = "Equals" SearchValue = "WCF Data Services 5.6.0 Runtime" } ) #SP2013 prereqs if ($majorVersion -eq 15) { $prereqsToTest += @( [PSObject]@{ Name = "Active Directory Rights Management Services Client 2.*" SearchType = "Like" SearchValue = "Active Directory Rights Management Services Client 2.*" }, [PSObject]@{ Name = "Microsoft SQL Server Native Client (2008 R2 or 2012)" SearchType = "Match" SearchValue = "SQL Server (2008 R2|2012) Native Client" }, [PSObject]@{ Name = "WCF Data Services 5.0 (for OData v3) Primary Components" SearchType = "Equals" SearchValue = "WCF Data Services 5.0 (for OData v3) Primary Components" } ) } #SP2016/SP2019 prereqs if ($majorVersion -eq 16) { if ($buildVersion -lt 5000) { #SP2016 prereqs $prereqsToTest += @( [PSObject]@{ Name = "Active Directory Rights Management Services Client 2.1" SearchType = "Equals" SearchValue = "Active Directory Rights Management Services Client 2.1" }, [PSObject]@{ Name = "Microsoft SQL Server 2012 Native Client" SearchType = "Equals" SearchValue = "Microsoft SQL Server 2012 Native Client" }, [PSObject]@{ Name = "Microsoft ODBC Driver 11 for SQL Server" SearchType = "Equals" SearchValue = "Microsoft ODBC Driver 11 for SQL Server" }, [PSObject]@{ Name = "Microsoft Visual C++ 2012 x64 Minimum Runtime - 11.0" SearchType = "Like" SearchValue = "Microsoft Visual C++ 2012 x64 Minimum Runtime - 11.0.*" }, [PSObject]@{ Name = "Microsoft Visual C++ 2012 x64 Additional Runtime - 11.0" SearchType = "Like" SearchValue = "Microsoft Visual C++ 2012 x64 Additional Runtime - 11.0.*" }, [PSObject]@{ Name = "Microsoft Visual C++ 2015 Redistributable (x64)" SearchType = "BundleUpgradeCode" SearchValue = "{C146EF48-4D31-3C3D-A2C5-1E91AF8A0A9B}" MinimumRequiredVersion = "14.0.23026.0" } ) } elseif ($buildVersion -ge 5000) { #SP2019 prereqs $prereqsToTest += @( [PSObject]@{ Name = "Active Directory Rights Management Services Client 2.1" SearchType = "Equals" SearchValue = "Active Directory Rights Management Services Client 2.1" }, [PSObject]@{ Name = "Microsoft SQL Server 2012 Native Client" SearchType = "Equals" SearchValue = "Microsoft SQL Server 2012 Native Client" }, [PSObject]@{ Name = "Microsoft Visual C++ 2017 Redistributable (x64)" SearchType = "BundleUpgradeCode" SearchValue = "{C146EF48-4D31-3C3D-A2C5-1E91AF8A0A9B}" MinimumRequiredVersion = "14.13.26020.0" } ) } } $prereqsInstalled = Test-SPDscPrereqInstallStatus -InstalledItems $installedItems ` -PrereqsToCheck $prereqsToTest $results = @{ IsSingleInstance = "Yes" InstallerPath = $InstallerPath OnlineMode = $OnlineMode SXSpath = $SXSpath SQLNCli = $SQLNCli PowerShell = $PowerShell NETFX = $NETFX IDFX = $IDFX Sync = $Sync AppFabric = $AppFabric IDFX11 = $IDFX11 MSIPCClient = $MSIPCClient WCFDataServices = $WCFDataServices KB2671763 = $KB2671763 WCFDataServices56 = $WCFDataServices56 MSVCRT11 = $MSVCRT11 MSVCRT14 = $MSVCRT14 MSVCRT141 = $MSVCRT141 KB3092423 = $KB3092423 ODBC = $ODBC DotNetFx = $DotNetFx DotNet472 = $DotNet472 } if ($prereqsInstalled -eq $true -and $windowsFeaturesInstalled -eq $true) { $results.Ensure = "Present" } else { $results.Ensure = "Absent" } return $results } 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('Yes')] [String] $IsSingleInstance, [Parameter(Mandatory = $true)] [System.String] $InstallerPath, [Parameter(Mandatory = $true)] [System.Boolean] $OnlineMode, [Parameter()] [System.String] $SXSpath, [Parameter()] [System.String] $SQLNCli, [Parameter()] [System.String] $PowerShell, [Parameter()] [System.String] $NETFX, [Parameter()] [System.String] $IDFX, [Parameter()] [System.String] $Sync, [Parameter()] [System.String] $AppFabric, [Parameter()] [System.String] $IDFX11, [Parameter()] [System.String] $MSIPCClient, [Parameter()] [System.String] $WCFDataServices, [Parameter()] [System.String] $KB2671763, [Parameter()] [System.String] $WCFDataServices56, [Parameter()] [System.String] $MSVCRT11, [Parameter()] [System.String] $MSVCRT14, [Parameter()] [System.String] $MSVCRT141, [Parameter()] [System.String] $KB3092423, [Parameter()] [System.String] $ODBC, [Parameter()] [System.String] $DotNetFx, [Parameter()] [System.String] $DotNet472, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present" ) Write-Verbose -Message "Setting installation status of SharePoint prerequisites" if ($Ensure -eq "Absent") { $message = ("SharePointDsc does not support uninstalling SharePoint or its " + ` "prerequisites. Please remove this manually.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "Check if InstallerPath folder exists" if (-not(Test-Path -Path $InstallerPath)) { $message = "PrerequisitesInstaller cannot be found: {$InstallerPath}" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "Checking file status of $InstallerPath" $checkBlockedFile = $true if (Split-Path -Path $InstallerPath -IsAbsolute) { $driveLetter = (Split-Path -Path $InstallerPath -Qualifier).TrimEnd(":") Write-Verbose -Message "InstallerPath refers to drive $driveLetter" $volume = Get-Volume -DriveLetter $driveLetter -ErrorAction SilentlyContinue if ($null -ne $volume) { if ($volume.DriveType -ne "CD-ROM") { Write-Verbose -Message "Volume is a fixed drive: Perform Blocked File test" } else { Write-Verbose -Message "Volume is a CD-ROM drive: Skipping Blocked File test" $checkBlockedFile = $false } } else { Write-Verbose -Message "Volume not found. Unable to determine the type. Continuing." } } if ($checkBlockedFile -eq $true) { Write-Verbose -Message "Checking status now" try { $zone = Get-Item -Path $InstallerPath -Stream "Zone.Identifier" -EA SilentlyContinue } catch { Write-Verbose -Message 'Encountered error while reading file stream. Ignoring file stream.' } if ($null -ne $zone) { $message = ("PrerequisitesInstaller is blocked! Please use 'Unblock-File -Path " + ` "$InstallerPath' to unblock the file before continuing.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "File not blocked, continuing." } Write-Verbose -Message "Detecting SharePoint version from binaries" $majorVersion = Get-SPDscAssemblyVersion -PathToAssembly $InstallerPath $buildVersion = Get-SPDscBuildVersion -PathToAssembly $InstallerPath $osVersion = Get-SPDscOSVersion switch ($osVersion.Major) { 6 { switch ($osVersion.Minor) { 0 { Write-Verbose -Message "Operating System: Windows Server 2008" } 1 { Write-Verbose -Message "Operating System: Windows Server 2008 R2" } 2 { Write-Verbose -Message "Operating System: Windows Server 2012" } 3 { Write-Verbose -Message "Operating System: Windows Server 2012 R2" } } } 10 { if ($osVersion.Build -lt 17763) { Write-Verbose -Message "Operating System: Windows Server 2016" } else { Write-Verbose -Message "Operating System: Windows Server 2019" } } } if ($majorVersion -eq 15) { if ($osVersion.Major -ne 6) { $message = "SharePoint 2013 only supports Windows Server 2012 R2 and below" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $BinaryDir = Split-Path -Path $InstallerPath $svrsetupDll = Join-Path -Path $BinaryDir -ChildPath "updates\svrsetup.dll" $checkDotNet = $true if (Test-Path -Path $svrsetupDll) { $svrsetupDllFileInfo = Get-ItemProperty -Path $svrsetupDll $fileVersion = $svrsetupDllFileInfo.VersionInfo.FileVersion if ($fileVersion -ge "15.0.4709.1000") { $checkDotNet = $false } } if ($checkDotNet -eq $true) { $ndpKey = "HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4" $dotNet46Installed = $false if (Test-Path -Path $ndpKey) { $dotNetv4Keys = Get-ChildItem -Path $ndpKey foreach ($dotnetInstance in $dotNetv4Keys) { if ($dotnetInstance.GetValue("Release") -ge 390000) { $dotNet46Installed = $true break } } } if ($dotNet46Installed -eq $true) { $message = ("A known issue prevents installation of SharePoint 2013 on " + ` "servers that have .NET 4.6 already installed. See details " + ` "at https://support.microsoft.com/en-us/kb/3087184") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } Write-Verbose -Message "Version: SharePoint 2013" $requiredParams = @("SQLNCli", "PowerShell", "NETFX", "IDFX", "Sync", "AppFabric", "IDFX11", "MSIPCClient", "WCFDataServices", "KB2671763", "WCFDataServices56") $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2013Features } elseif ($majorVersion -eq 16) { if ($buildVersion -lt 5000) { Write-Verbose -Message "Version: SharePoint 2016" $requiredParams = @("SQLNCli", "Sync", "AppFabric", "IDFX11", "MSIPCClient", "KB3092423", "WCFDataServices56", "DotNetFx", "MSVCRT11", "MSVCRT14", "ODBC") if ($osVersion.Major -eq 10) { if ($osVersion.Build -lt 17763) { # Server 2016 $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2016Win16Features } else { # Server 2019 $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2016Win19Features } } elseif ($osVersion.Major -eq 6 -and $osVersion.Minor -eq 3) { # Server 2012 R2 $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2016Win12r2Features } else { $message = "SharePoint 2016 only supports Windows Server 2016 or 2012 R2" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } # SharePoint 2019 elseif ($buildVersion -ge 5000) { Write-Verbose -Message "Version: SharePoint 2019" $requiredParams = @("SQLNCli", "Sync", "AppFabric", "IDFX11", "MSIPCClient", "KB3092423", "WCFDataServices56", "DotNet472", "MSVCRT11", "MSVCRT141") if ($osVersion.Major -eq 10) { if ($osVersion.Build -lt 17763) { # Server 2016 $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2019Win16Features } else { # Server 2019 $WindowsFeatures = Get-WindowsFeature -Name $Script:SP2019Win19Features } } else { $message = "SharePoint 2019 only supports Windows Server 2016 or Windows Server 2019" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } } # SXSstore for feature install specified, we will manually install features from the # store, rather then relying on the prereq installer to download them if ($SXSpath) { Write-Verbose -Message "Getting installed windows features" foreach ($feature in $WindowsFeatures) { if ($feature.Installed -ne $true) { Write-Verbose "Installing $($feature.name)" $installResult = Install-WindowsFeature -Name $feature.Name -Source $SXSpath if ($installResult.restartneeded -eq "yes") { $global:DSCMachineStatus = 1 } if ($installResult.Success -ne $true) { $message = "Error installing $($feature.name)" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } } # see if we need to reboot after feature install if ($global:DSCMachineStatus -eq 1) { return } } $prereqArgs = "/unattended" if ($OnlineMode -eq $false) { $requiredParams | ForEach-Object -Process { if (($PSBoundParameters.ContainsKey($_) -eq $true ` -and [string]::IsNullOrEmpty($PSBoundParameters.$_)) ` -or (-not $PSBoundParameters.ContainsKey($_))) { $message = "In offline mode for version $majorVersion parameter $_ is required" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ((Test-Path -Path $PSBoundParameters.$_) -eq $false) { $message = ("The $_ parameter has been passed but the file cannot be found at the " + ` "path supplied: `"$($PSBoundParameters.$_)`"") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } $requiredParams | ForEach-Object -Process { $prereqArgs += " /$_`:`"$($PSBoundParameters.$_)`"" } } Write-Verbose -Message "Checking if Path is an UNC path" $uncInstall = $false if ($InstallerPath.StartsWith("\\")) { Write-Verbose -Message ("Specified InstallerPath is an UNC path. Adding servername to Local " + "Intranet Zone") $uncInstall = $true if ($InstallerPath -match "\\\\(.*?)\\.*") { $serverName = $Matches[1] } else { $message = "Cannot extract servername from UNC path. Check if it is in the correct format." Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Set-SPDscZoneMap -Server $serverName } Write-Verbose -Message "Calling the SharePoint Pre-req installer" Write-Verbose -Message "Args for prereq installer are: $prereqArgs" $process = Start-Process -FilePath $InstallerPath -ArgumentList $prereqArgs -Wait -PassThru if ($uncInstall -eq $true) { Write-Verbose -Message "Removing added path from the Local Intranet Zone" Remove-SPDscZoneMap -ServerName $serverName } switch ($process.ExitCode) { 0 { Write-Verbose -Message "Prerequisite installer completed successfully." } 1 { $message = "Another instance of the prerequisite installer is already running" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } 2 { $message = "Invalid command line parameters passed to the prerequisite installer" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } 1001 { Write-Verbose -Message ("A pending restart is blocking the prerequisite " + ` "installer from running. Scheduling a reboot.") $global:DSCMachineStatus = 1 } 3010 { Write-Verbose -Message ("The prerequisite installer has run correctly and needs " + ` "to reboot the machine before continuing.") $global:DSCMachineStatus = 1 } default { $message = ("The prerequisite installer ran with the following unknown " + ` "exit code $($process.ExitCode)") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } $rebootKey1 = "HKLM:\Software\Microsoft\Windows\CurrentVersion\" + ` "Component Based Servicing\RebootPending" $rebootTest1 = Get-Item -Path $rebootKey1 -ErrorAction SilentlyContinue $rebootKey2 = "HKLM:\Software\Microsoft\Windows\CurrentVersion\WindowsUpdate\" + ` "Auto Update\RebootRequired" $rebootTest2 = Get-Item -Path $rebootKey2 -ErrorAction SilentlyContinue $sessionManagerKey = "HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager" $sessionManager = Get-Item -Path $sessionManagerKey | Get-ItemProperty $pendingFileRenames = $sessionManager.PendingFileRenameOperations.Count if (($null -ne $rebootTest1) -or ($null -ne $rebootTest2) -or ($pendingFileRenames -gt 0)) { Write-Verbose -Message ("SPInstallPrereqs has detected the server has pending a " + ` "reboot. Flagging to the DSC engine that the server should " + ` "reboot before continuing.") $global:DSCMachineStatus = 1 } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter(Mandatory = $true)] [System.String] $InstallerPath, [Parameter(Mandatory = $true)] [System.Boolean] $OnlineMode, [Parameter()] [System.String] $SXSpath, [Parameter()] [System.String] $SQLNCli, [Parameter()] [System.String] $PowerShell, [Parameter()] [System.String] $NETFX, [Parameter()] [System.String] $IDFX, [Parameter()] [System.String] $Sync, [Parameter()] [System.String] $AppFabric, [Parameter()] [System.String] $IDFX11, [Parameter()] [System.String] $MSIPCClient, [Parameter()] [System.String] $WCFDataServices, [Parameter()] [System.String] $KB2671763, [Parameter()] [System.String] $WCFDataServices56, [Parameter()] [System.String] $MSVCRT11, [Parameter()] [System.String] $MSVCRT14, [Parameter()] [System.String] $MSVCRT141, [Parameter()] [System.String] $KB3092423, [Parameter()] [System.String] $ODBC, [Parameter()] [System.String] $DotNetFx, [Parameter()] [System.String] $DotNet472, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present" ) Write-Verbose -Message "Testing installation status of SharePoint prerequisites" $PSBoundParameters.Ensure = $Ensure if ($Ensure -eq "Absent") { $message = ("SharePointDsc does not support uninstalling SharePoint or its " + ` "prerequisites. Please remove this manually.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" $result = Test-SPDscParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck @("Ensure") Write-Verbose -Message "Test-TargetResource returned $result" return $result } function Test-SPDscPrereqInstallStatus { param ( [Parameter()] [Object] $InstalledItems, [Parameter(Mandatory = $true)] [psobject[]] $PrereqsToCheck ) if ($null -eq $InstalledItems) { return $false } $itemsInstalled = $true $PrereqsToCheck | ForEach-Object -Process { $itemToCheck = $_ switch ($itemToCheck.SearchType) { "Equals" { $prereq = $InstalledItems | Where-Object -FilterScript { $null -ne $_.DisplayName -and $_.DisplayName.Trim() -eq $itemToCheck.SearchValue } if ($null -eq $prereq) { $itemsInstalled = $false Write-Verbose -Message ("Prerequisite $($itemToCheck.Name) was not found " + ` "on this system") } } "Match" { $prereq = $InstalledItems | Where-Object -FilterScript { $null -ne $_.DisplayName -and $_.DisplayName.Trim() -match $itemToCheck.SearchValue } if ($null -eq $prereq) { $itemsInstalled = $false Write-Verbose -Message ("Prerequisite $($itemToCheck.Name) was not found " + ` "on this system") } } "Like" { $prereq = $InstalledItems | Where-Object -FilterScript { $null -ne $_.DisplayName -and $_.DisplayName.Trim() -like $itemToCheck.SearchValue } if ($null -eq $prereq) { $itemsInstalled = $false Write-Verbose -Message ("Prerequisite $($itemToCheck.Name) was not found " + ` "on this system") } } "BundleUpgradeCode" { $installedItem = $InstalledItems | Where-Object -FilterScript { $null -ne $_.BundleUpgradeCode -and ($null -eq ($_.BundleUpgradeCode.Trim() | Compare-Object $itemToCheck.SearchValue)) } if ($null -eq $installedItem) { $itemsInstalled = $false Write-Verbose -Message ("Prerequisite $($itemToCheck.Name) was not found " + ` "on this system") } else { $isRequiredVersionInstalled = $true; [System.Version]$minimumRequiredVersion = $itemToCheck.MinimumRequiredVersion [System.Version]$installedVersion = $installedItem.DisplayVersion if ($minimumRequiredVersion -gt $installedVersion) { $isRequiredVersionInstalled = $false; } if ($installedVersion.Length -eq 0 -or -not $isRequiredVersionInstalled) { $itemsInstalled = $false Write-Verbose -Message ("Prerequisite $($itemToCheck.Name) was found but had " + ` "unexpected version. Expected minimum version $($itemToCheck.MinimumVersion) " + ` "but found version $($installedItem.DisplayVersion).") } } } Default { $message = ("Unable to search for a prereq with mode '$($itemToCheck.SearchType)'. " + ` "please use either 'Equals', 'Like' or 'Match', or 'BundleUpgradeCode'") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } } return $itemsInstalled } Export-ModuleMember -Function *-TargetResource |