Merge pull request #1325 from Yvand/Yvand/add-param-to-spfarm

Add parameter SkipRegisterAsDistributedCacheHost to SPFarm
dsccommunity · Jun 26, 2021 · 2fc3d9d · 2fc3d9d
2 parents 1b7c1e1 + 70ddb1c
commit 2fc3d9d
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- SPFarm
+  - Added parameter SkipRegisterAsDistributedCacheHost
+
+### Fixed
+
 - SPInstallLanguagePack
   - Fixed detection of Norwegian language pack
 
@@ -29,8 +36,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Added ability to configure generic authentication settings per zone, like allow
     anonymous authentication or a custom signin page
 
-### Fixed
-
 - SharePointDsc
   - Fixed code coverage in pipeline
 - SPConfigWizard

diff --git a/SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.psm1 b/SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.psm1
@@ -90,6 +90,10 @@ function Get-TargetResource
         [System.Management.Automation.PSCredential]
         $ApplicationCredentialKey,
 
+        [Parameter()]
+        [System.Boolean]
+        $SkipRegisterAsDistributedCacheHost = $true,
+
         [Parameter()]
         [System.Management.Automation.PSCredential]
         $InstallAccount
@@ -449,6 +453,10 @@ function Set-TargetResource
         [System.Management.Automation.PSCredential]
         $ApplicationCredentialKey,
 
+        [Parameter()]
+        [System.Boolean]
+        $SkipRegisterAsDistributedCacheHost = $true,
+
         [Parameter()]
         [System.Management.Automation.PSCredential]
         $InstallAccount
@@ -467,6 +475,8 @@ function Set-TargetResource
         throw $message
     }
 
+    $PSBoundParameters.SkipRegisterAsDistributedCacheHost = $SkipRegisterAsDistributedCacheHost
+
     if ($PSBoundParameters.ContainsKey("CentralAdministrationUrl"))
     {
         if ([string]::IsNullOrEmpty($CentralAdministrationUrl))
@@ -828,7 +838,7 @@ function Set-TargetResource
                 DatabaseServer                     = $params.DatabaseServer
                 DatabaseName                       = $params.FarmConfigDatabaseName
                 Passphrase                         = $params.Passphrase.Password
-                SkipRegisterAsDistributedCacheHost = $true
+                SkipRegisterAsDistributedCacheHost = $params.SkipRegisterAsDistributedCacheHost
             }
 
             $supportsSettingApplicationCredentialKey = $false
@@ -1306,6 +1316,10 @@ function Test-TargetResource
         [System.Management.Automation.PSCredential]
         $ApplicationCredentialKey,
 
+        [Parameter()]
+        [System.Boolean]
+        $SkipRegisterAsDistributedCacheHost = $true,
+
         [Parameter()]
         [System.Management.Automation.PSCredential]
         $InstallAccount

diff --git a/SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.schema.mof b/SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.schema.mof
@@ -15,6 +15,7 @@ class MSFT_SPFarm : OMI_BaseResource
     [Write, Description("SharePoint 2016 & 2019 only - the MinRole role to enroll this server as"), ValueMap{"Application","ApplicationWithSearch","Custom","DistributedCache","Search","SingleServerFarm","WebFrontEnd","WebFrontEndWithDistributedCache"}, Values{"Application","ApplicationWithSearch","Custom","DistributedCache","Search","SingleServerFarm","WebFrontEnd","WebFrontEndWithDistributedCache"}] String ServerRole;
     [Write, Description("Specifies the state of the Developer Dashboard ('OnDemand' is SP2013 only)"), ValueMap{"Off","On","OnDemand"}, Values{"Off","On","OnDemand"}] String DeveloperDashboard;
     [Write, Description("Specifies the application credential key on the local server. Only supported for SP2019."), EmbeddedInstance("MSFT_Credential")] String ApplicationCredentialKey;
+    [Write, Description("Set to true to not register the server computer as a distributed cache host")] Boolean SkipRegisterAsDistributedCacheHost;
     [Write, Description("POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5"), EmbeddedInstance("MSFT_Credential")] String InstallAccount;
     [Write, Description("Should SQL Server authentication be used to connect to the database?")] Boolean UseSQLAuthentication;
     [Write, Description("If using SQL authentication, the SQL login to use to connect to the instance"), EmbeddedInstance("MSFT_Credential")] String DatabaseCredentials;

diff --git a/SharePointDsc/DSCResources/MSFT_SPFarm/Readme.md b/SharePointDsc/DSCResources/MSFT_SPFarm/Readme.md
@@ -57,6 +57,9 @@ The application credential key will only be set during initial farm creation and
 when joining the farm. The ApplicationCredentialKey needs to be the same on each
 server in the farm. ApplicationCredentialKey is only supported for SharePoint 2019.
 
+If SkipRegisterAsDistributedCacheHost is set to true, the server is not registered
+as a distributed cache host.
+
 NOTE:
 When using SharePoint 2016 and later and enabling the Developer Dashboard,
 please make sure you also provision the Usage and Health service application