diff --git a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt index d05a000bc..8f8278fd9 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt @@ -45,12 +45,13 @@ The SharePoint prerequisites can be downloaded from the following locations: SharePoint 2013: - https://technet.microsoft.com/library/a88d3f72-7ac3-4f08-b302-c4ca0a796268%28v=office.16%29.aspx?#section5 + https://docs.microsoft.com/en-us/SharePoint/install/hardware-and-software-requirements-0#section5 SharePoint 2016: - https://technet.microsoft.com/en-us/library/cc262485(v=office.16).aspx#section5 + 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 .PARAMETER IsSingleInstance Key - String diff --git a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt index 5f0463e09..c18c047a2 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt @@ -17,6 +17,10 @@ The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned. + NOTE: The WindowsServiceAccount parameter is deprecated and no longer does + anything. The functionality for changing this account has been moved to + SPSearchServiceSettings. + .PARAMETER Name Key - string The name of the search service application @@ -56,7 +60,7 @@ .PARAMETER WindowsServiceAccount Write - string - Sets the windows services for search to run as this account + This setting is moved to SPSearchServiceSettings and deprecated here. .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-US/about_SPSearchServiceSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchServiceSettings.help.txt new file mode 100644 index 000000000..1ae6932f5 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchServiceSettings.help.txt @@ -0,0 +1,66 @@ +.NAME + SPSearchServiceSettings + +# Description + + **Type:** Distributed + **Requires CredSSP:** No + + This resource is responsible for configuring settings for the search + service, like the crawler performance level. All settings are farm + wide settings, which is why this resource should only be used once + in each configuration. + +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + +.PARAMETER PerformanceLevel + Write - string + Allowed values: Reduced, PartlyReduced, Maximum + Specifies the performance level of the crawler + +.PARAMETER ContactEmail + Write - string + Specifies the contact email used by the crawler + +.PARAMETER WindowsServiceAccount + Write - string + Sets the windows services for search to run as this account + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new search service app in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SearchAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchServiceSettings SearchServiceSettings + { + IsSingleInstance = "Yes" + PerformanceLevel = "Maximum" + ContactEmail = "sharepoint@contoso.com" + WindowsServiceAccount = $SearchAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt index 9303edc25..7504a3caf 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt @@ -60,6 +60,11 @@ Allowed values: ActiveDirectory, BusinessDataCatalog The type of the connection - currently only Active Directory is supported +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the connection should exist, absent if it should not + .PARAMETER InstallAccount Write - string POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5