v3.2 release updates

dsccommunity · Feb 19, 2019 · c2ba666 · c2ba666
1 parent e57a147
commit c2ba666
Show file tree

Hide file tree

Showing 29 changed files with 432 additions and 161 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 * Changes to SharePointDsc unit testing
   * Implemented Strict Mode version 1 for all code run during unit tests.
-  * Changed InstallAccount into PSDscRunAsCredential parameter
+  * Changed InstallAccount into PSDscRunAsCredential parameter in examples
 * SPAuthenticationRealm
   * New resource for setting farm authentication realm
 * SPConfigWizard

diff --git a/Modules/SharePointDsc/SharePointDsc.psd1 b/Modules/SharePointDsc/SharePointDsc.psd1
@@ -130,7 +130,7 @@ PrivateData = @{
         ReleaseNotes = "
       * Changes to SharePointDsc unit testing
         * Implemented Strict Mode version 1 for all code run during unit tests.
-        * Changed InstallAccount into PSDscRunAsCredential parameter
+        * Changed InstallAccount into PSDscRunAsCredential parameter in examples
       * SPAuthenticationRealm
         * New resource for setting farm authentication realm
       * SPConfigWizard

diff --git a/Modules/SharePointDsc/en-US/about_SPAuthenticationRealm.help.txt b/Modules/SharePointDsc/en-US/about_SPAuthenticationRealm.help.txt
@@ -0,0 +1,56 @@
+.NAME
+    SPAuthenticationRealm
+
+# Description
+
+    **Type:** Distributed
+    **Requires CredSSP:** No
+
+    This resource is used to set the authentication realm for a farm.
+    By default the authentication realm for a new farm installation
+    is the same as the farm id.
+
+    Note:
+
+    SharePoint automatically converts the realm to lower case ASCII printable characters.
+    The specified authentication realm must therefore conform to this for the test
+    method to be able to detect a correct configuration.
+
+.PARAMETER IsSingleInstance
+    Key - String
+    Allowed values: Yes
+    Specifies the resource is a single instance, the value must be 'Yes'
+
+.PARAMETER AuthenticationRealm
+    Required - String
+    The authentication realm to be set
+
+.PARAMETER InstallAccount
+    Write - String
+    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
+
+
+.EXAMPLE
+    This example sets the farm atuhentication realm.
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPAuthenticationRealm AuthenticationRealm
+            {
+                IsSingleInstance     = "Yes"
+                AuthenticationRealm  = "14757a87-4d74-4323-83b9-fb1e77e8f22f"
+                PsDscRunAsCredential = $SetupAccount
+            }
+        }
+    }
+
+
diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt
@@ -50,10 +50,10 @@
 
 .EXAMPLE
     This example shows how to deploy a Business Connectivity Services application to the
-    local SharePoint farm. 
+    local SharePoint farm.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -65,11 +65,11 @@
         node localhost {
             SPBCSServiceApp BCSServiceApp
             {
-                Name            = "BCS Service Application"
-                ApplicationPool = "SharePoint Service Applications"
-                DatabaseName    = "SP_BCS"
-                DatabaseServer  = "SQL.contoso.local\SQLINSTANCE"
-                InstallAccount  = $SetupAccount
+                Name                 = "BCS Service Application"
+                ApplicationPool      = "SharePoint Service Applications"
+                DatabaseName         = "SP_BCS"
+                DatabaseServer       = "SQL.contoso.local\SQLINSTANCE"
+                PsDscRunAsCredential = $SetupAccount
             }
         }
     }

diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt
@@ -65,7 +65,7 @@
     other cache hosts.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -80,7 +80,7 @@
                 Name                 = "AppFabricCachingService"
                 CacheSizeInMB        = 8192
                 ServiceAccount       = "DEMO\ServiceAccount"
-                InstallAccount       = $SetupAccount
+                PsDscRunAsCredential = $SetupAccount
                 CreateFirewallRules  = $true
             }
         }
@@ -89,12 +89,12 @@
 
 .EXAMPLE
     This example applies the distributed cache service to the current server,
-    but will not apply the rules to allow it to communicate with other cache 
+    but will not apply the rules to allow it to communicate with other cache
     hosts to the Windows Firewall. Use this approach if you have an alternate
     firewall solution.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -109,7 +109,7 @@
                 Name                 = "AppFabricCachingService"
                 CacheSizeInMB        = 8192
                 ServiceAccount       = "DEMO\ServiceAccount"
-                InstallAccount       = $SetupAccount
+                PsDscRunAsCredential = $SetupAccount
                 CreateFirewallRules  = $false
             }
         }
@@ -119,7 +119,7 @@
 .EXAMPLE
     This example applies the distributed cache service to both "server1" and
     "server2". The ServerProvisionOrder will ensure that it applies it to
-    server1 first and then server2, making sure they don't both attempt to 
+    server1 first and then server2, making sure they don't both attempt to
     create the cache at the same time, resuling in errors.
 
     Note: Do not allow plain text passwords in production environments.
@@ -138,16 +138,16 @@
         )
     }
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
             [PSCredential]
             $SetupAccount
         )
         Import-DscResource -ModuleName SharePointDsc
-        
-        node "Server1" 
+
+        node "Server1"
         {
             SPDistributedCacheService EnableDistributedCache
             {
@@ -156,7 +156,7 @@
                 ServiceAccount       = "DEMO\ServiceAccount"
                 ServerProvisionOrder = @("Server1","Server2")
                 CreateFirewallRules  = $true
-                InstallAccount       = $SetupAccount
+                PsDscRunAsCredential = $SetupAccount
             }
         }
 
@@ -169,7 +169,7 @@
                 ServiceAccount       = "DEMO\ServiceAccount"
                 ServerProvisionOrder = @("Server1","Server2")
                 CreateFirewallRules  = $true
-                InstallAccount       = $SetupAccount
+                PsDscRunAsCredential = $SetupAccount
             }
         }
     }

diff --git a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt
@@ -106,7 +106,7 @@
     This example shows how to deploy Excel Services to the local SharePoint farm.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -118,9 +118,9 @@
         node localhost {
             SPExcelServiceApp ExcelServices
             {
-                Name            = "Excel Services Service Application"
-                ApplicationPool = "SharePoint Service Applications"
-                InstallAccount  = $SetupAccount
+                Name                 = "Excel Services Service Application"
+                ApplicationPool      = "SharePoint Service Applications"
+                PsDscRunAsCredential = $SetupAccount
             }
         }
     }
@@ -129,10 +129,10 @@
 .EXAMPLE
     This example shows how to remove Excel Services from the local SharePoint farm.
     Here application pool is a required parameter, but it is not actually used when
-    removing a service app and as such can be ignored and set to any value. 
+    removing a service app and as such can be ignored and set to any value.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -144,10 +144,10 @@
         node localhost {
             SPExcelServiceApp ExcelServices
             {
-                Name            = "Excel Services Service Application"
-                ApplicationPool = "n/a"
-                Ensure          = "Absent"
-                InstallAccount  = $SetupAccount
+                Name                 = "Excel Services Service Application"
+                ApplicationPool      = "n/a"
+                Ensure               = "Absent"
+                PsDscRunAsCredential = $SetupAccount
             }
         }
     }

diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt
@@ -37,13 +37,21 @@
     specified, it defaults to NTLM. If using Kerberos, make sure to have
     appropriate SPNs setup for Farm account and Central Administration URI.
 
+    DeveloperDashboard can be specified as "On", "Off" and (only when using
+    SharePoint 2013) to "OnDemand".
+
+    NOTE:
+    When using SharePoint 2016 and later and enabling the Developer Dashboard,
+    please make sure you also provision the Usage and Health service application
+    to make sure the Developer Dashboard works properly.
+
 .PARAMETER IsSingleInstance
     Key - String
     Allowed values: Yes
     Specifies the resource is a single instance, the value must be 'Yes'
 
 .PARAMETER Ensure
-    Write - string
+    Write - String
     Allowed values: Present, Absent
     Present to create/join the farm. Absent is currently not supported
 
@@ -72,7 +80,7 @@
     Should the central admin site run on this specific server?
 
 .PARAMETER CentralAdministrationPort
-    Write - uint32
+    Write - Uint32
     What port will Central Admin be provisioned to - default is 9999
 
 .PARAMETER CentralAdministrationAuth
@@ -81,10 +89,15 @@
     The authentication provider of the CentralAdministration web application
 
 .PARAMETER ServerRole
-    Write - string
+    Write - String
     Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache
     SharePoint 2016 & 2019 only - the MinRole role to enroll this server as
 
+.PARAMETER DeveloperDashboard
+    Write - String
+    Allowed values: Off, On, OnDemand
+    Specifies the state of the Developer Dashboard ('OnDemand' is SP2013 only)
+
 .PARAMETER InstallAccount
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5