Skip to content

SPInstallPrereqs

Jump to bottom
dscbot edited this page Mar 17, 2023 · 18 revisions

SPInstallPrereqs

Parameters

Parameter Attribute DataType Description Allowed Values
IsSingleInstance Key String Specifies the resource is a single instance, the value must be 'Yes' Yes
InstallerPath Required String The full path to prerequisiteinstaller.exe
OnlineMode Required Boolean Should the installer download prerequisites from the internet or not
SXSpath Write String The path to the Windows Server Operating System SXS source files, for use in closed environments without access to Windows Update
SQLNCli Write String The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
PowerShell Write String The path to the installer for this prerequisite (SP2013 only)
NETFX Write String The path to the installer for this prerequisite (SP2013 only)
IDFX Write String The path to the installer for this prerequisite (SP2013 only)
Sync Write String The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
AppFabric Write String The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
IDFX11 Write String The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
MSIPCClient Write String The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
WCFDataServices Write String The path to the installer for this prerequisite (SP2013 only)
KB2671763 Write String The path to the installer for this prerequisite (SP2013 only)
WCFDataServices56 Write String The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
MSVCRT11 Write String The path to the installer for this prerequisite (SP2016 and SP2019)
MSVCRT14 Write String The path to the installer for this prerequisite (SP2016 only)
KB3092423 Write String The path to the installer for this prerequisite (SP2016 and SP2019)
ODBC Write String The path to the installer for this prerequisite (SP2016 only)
DotNetFx Write String The path to the installer for this prerequisite (SP2016 only)
DotNet472 Write String The path to the installer for this prerequisite (SP2019 only)
DotNet48 Write String The path to the installer for this prerequisite (SP Subscription Edition only)
MSVCRT141 Write String The path to the installer for this prerequisite (SP2019 only)
MSVCRT142 Write String The path to the installer for this prerequisite (SP Subscription Edition only)
Ensure Write String Present to install the prerequisites. Absent is currently not supported Present, Absent

Description

Type: Common Requires CredSSP: No

This resource is responsible for ensuring the installation of all SharePoint prerequisites. It makes use of the PrerequisiteInstaller.exe file that is part of the SharePoint binaries, and will install the required Windows features as well as additional software. The OnlineMode boolean will tell the prerequisite installer which mode to run in, if it is online you do not need to list any other parameters for this resource. If you do not use online mode, you must include all other parameters to specify where the installation files are located. These additional parameters map directly to the options passed to prerequisiteinstaller.exe. For installations with no connectivity to Windows Update, use the SXSpath parameter to specify the path to the SXS store of your Windows Server install media.

Additionally, the process of installing the prerequisites on a Windows Server usually results in 2-3 restarts of the system being required. To ensure the DSC configuration is able to restart the server when needed, ensure the below settings for the local configuration manager are included in your DSC file.

LocalConfigurationManager
{
    RebootNodeIfNeeded = $true
}

Installing from network locations

If you wish to install the prerequisites from a network location this can be done, however you must disable User Account Control (UAC) on the server to allow DSC to run the executable from a remote location, and also set the PsDscRunAsCredential value to run as an account with local admin permissions as well as read access to the network location.

It is not recommended to disable UAC for security reasons. The recommended approach is to copy the installation media to the local nodes first and then execute the installation from there.

Downloading prerequisites

The SharePoint prerequisites can be downloaded from the following locations:

SharePoint 2013: https://docs.microsoft.com/en-us/SharePoint/install/hardware-and-software-requirements-0#section5

SharePoint 2016: https://docs.microsoft.com/en-us/SharePoint/install/hardware-and-software-requirements#section5

SharePoint 2019: https://docs.microsoft.com/en-us/sharepoint/install/hardware-and-software-requirements-2019#links-to-applicable-software

Examples

Example 1

This module will install the prerequisites for SharePoint. This resource will run in online mode, looking to download all prerequisites from the internet.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPInstallPrereqs 'InstallPrerequisitesOnline'
        {
            IsSingleInstance = "Yes"
            InstallerPath    = "C:\SPInstall\Prerequisiteinstaller.exe"
            OnlineMode       = $true
        }
    }
}

Example 2

This module will install the prerequisites for SharePoint 2013. This resource will run in offline mode, running all prerequisite installations from the specified paths.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPInstallPrereqs 'InstallPrerequisites2013'
        {
            IsSingleInstance  = "Yes"
            InstallerPath     = "C:\SPInstall\Prerequisiteinstaller.exe"
            OnlineMode        = $false
            SXSpath           = "c:\SPInstall\Windows2012r2-SXS"
            SQLNCli           = "C:\SPInstall\prerequisiteinstallerfiles\sqlncli.msi"
            PowerShell        = "C:\SPInstall\prerequisiteinstallerfiles\Windows6.1-KB2506143-x64.msu"
            NETFX             = "C:\SPInstall\prerequisiteinstallerfiles\dotNetFx45_Full_setup.exe"
            IDFX              = "C:\SPInstall\prerequisiteinstallerfiles\Windows6.1-KB974405-x64.msu"
            Sync              = "C:\SPInstall\prerequisiteinstallerfiles\Synchronization.msi"
            AppFabric         = "C:\SPInstall\prerequisiteinstallerfiles\WindowsServerAppFabricSetup_x64.exe"
            IDFX11            = "C:\SPInstall\prerequisiteinstallerfiles\MicrosoftIdentityExtensions-64.msi"
            MSIPCClient       = "C:\SPInstall\prerequisiteinstallerfiles\setup_msipc_x64.msi"
            WCFDataServices   = "C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices.exe"
            KB2671763         = "C:\SPInstall\prerequisiteinstallerfiles\AppFabric1.1-RTM-KB2671763-x64-ENU.exe"
            WCFDataServices56 = "C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices56.exe"
        }
    }
}

Example 3

This module will install the prerequisites for SharePoint 2016/2019. This resource will run in offline mode, running all prerequisite installations from the specified paths.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPInstallPrereqs 'InstallPrerequisites2016'
        {
            IsSingleInstance  = "Yes"
            InstallerPath     = "C:\SPInstall\Prerequisiteinstaller.exe"
            OnlineMode        = $false
            SXSpath           = "C:\SPInstall\Windows2012r2-SXS"
            SQLNCli           = "C:\SPInstall\prerequisiteinstallerfiles\sqlncli.msi"
            Sync              = "C:\SPInstall\prerequisiteinstallerfiles\Synchronization.msi"
            AppFabric         = "C:\SPInstall\prerequisiteinstallerfiles\WindowsServerAppFabricSetup_x64.exe"
            IDFX11            = "C:\SPInstall\prerequisiteinstallerfiles\MicrosoftIdentityExtensions-64.msi"
            MSIPCClient       = "C:\SPInstall\prerequisiteinstallerfiles\setup_msipc_x64.msi"
            WCFDataServices56 = "C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices56.exe"
            MSVCRT11          = "C:\SPInstall\prerequisiteinstallerfiles\vcredist_x64.exe"
            MSVCRT14          = "C:\SPInstall\prerequisiteinstallerfiles\vc_redist.x64.exe"
            KB3092423         = "C:\SPInstall\prerequisiteinstallerfiles\AppFabric-KB3092423-x64-ENU.exe"
            ODBC              = "C:\SPInstall\prerequisiteinstallerfiles\msodbcsql.msi"
            DotNetFx          = "C:\SPInstall\prerequisiteinstallerfiles\NDP46-KB3045557-x86-x64-AllOS-ENU.exe"
        }
    }
}

Example 4

This module will install the prerequisites for SharePoint 2016/2019. This resource will run in offline mode, running all prerequisite installations from the specified paths.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPInstallPrereqs 'InstallPrerequisites2019'
        {
            IsSingleInstance  = "Yes"
            InstallerPath     = "C:\SPInstall\Prerequisiteinstaller.exe"
            OnlineMode        = $false
            SXSpath           = "C:\SPInstall\Windows2012r2-SXS"
            AppFabric         = 'C:\SPInstall\prerequisiteinstallerfiles\WindowsServerAppFabricSetup_x64.exe'
            DotNet472         = 'C:\SPInstall\prerequisiteinstallerfiles\NDP472-KB4054530-x86-x64-AllOS-ENU.exe'
            KB3092423         = 'C:\SPInstall\prerequisiteinstallerfiles\AppFabric-KB3092423-x64-ENU.exe'
            IDFX11            = 'C:\SPInstall\prerequisiteinstallerfiles\MicrosoftIdentityExtensions-64.msi'
            MSIPCClient       = 'C:\SPInstall\prerequisiteinstallerfiles\setup_msipc_x64.exe'
            MSVCRT11          = 'C:\SPInstall\prerequisiteinstallerfiles\vcredist_x64.exe'
            MSVCRT141         = 'C:\SPInstall\prerequisiteinstallerfiles\vc_redist.x64.exe'
            SQLNCli           = 'C:\SPInstall\prerequisiteinstallerfiles\sqlncli.msi'
            Sync              = 'C:\SPInstall\prerequisiteinstallerfiles\Synchronization.msi'
            WCFDataServices56 = 'C:\SPInstall\prerequisiteinstallerfiles\WcfDataServices.exe'
        }
    }
}

Example 5

This module will install the prerequisites for SharePoint 2016/2019. This resource will run in offline mode, running all prerequisite installations from the specified paths.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPInstallPrereqs 'InstallPrerequisitesSPSE'
        {
            IsSingleInstance  = "Yes"
            InstallerPath     = "C:\SPInstall\Prerequisiteinstaller.exe"
            OnlineMode        = $false
            SXSpath           = "C:\SPInstall\Windows2012r2-SXS"
            DotNet48          = 'C:\SPInstall\ndp48-x86-x64-allos-enu.exe'
            MSVCRT142         = 'C:\SPInstall\VC_redist.x64.exe'
        }
    }
}

SharePointDSC

SharePointDsc Module

Clone this wiki locally