Adding help files for release

Modules/xSharePoint/en-us/about_xSPAntivirusSettings.help.txt

@@ -0,0 +1,28 @@
+NAME
+    xSPAntivirusSettings
+
+PARAMETERS
+    ScanOnDownload (Key, Boolean)
+    ScanOnUpload (Write, Boolean)
+    AllowDownloadInfected (Write, Boolean)
+    AttemptToClean (Write, Boolean)
+    TimeoutDuration (Write, Uint16)
+    NumberOfThreads (Write, Uint16)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is used to set the global antivirus settings for the local farm.
+These settings will be used to control the behavior of an external anti-virus scanning tool that is able to integrate with SharePoint.
+Note that this will not scan documents for viruses on it's own, an external tool still needs to be installed on the servers that integrates with SharePoint.
+
+EXAMPLE
+
+    xSPAntivirusSettings AVSettings
+    {
+        ScanOnDownload        = $true
+        ScanOnUpload          = $true
+        AllowDownloadInfected = $false
+        AttemptToClean        = $false
+    }
+

Modules/xSharePoint/en-us/about_xSPAppCatalog.help.txt

@@ -0,0 +1,21 @@
+NAME
+    xSPAppCatalog
+
+PARAMETERS
+    SiteUrl (Key, string)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource will ensure that a specific site collection is marked as the app catalog for the web application that the site is in.
+The catalog site needs to have been created using the correct template (APPCATALOG#0).
+
+EXAMPLE
+
+    xSPAppCatalog MainAppCatalog
+    {
+        SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog"
+        PsDscRunAsCredential = $SPSetupAccount
+    }
+
+

Modules/xSharePoint/en-us/about_xSPAppDomain.help.txt

@@ -0,0 +1,24 @@
+NAME
+    xSPAppDomain
+
+PARAMETERS
+    AppDomain (Key, string)
+    Prefix (Required, string)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource will set the value for the app domain settings at the farm level.
+You can set the domain name and the prefix that is to be used for app URLs.
+
+
+EXAMPLE
+
+    xSPAppDomain LocalFarmAppUrls
+    {
+        AppDomain = "contosointranetapps.com"
+        Prefix = "app"
+        PsDscRunAsCredential = $InstallAccount
+    }
+
+

Modules/xSharePoint/en-us/about_xSPAppManagementServiceApp.help.txt

@@ -0,0 +1,27 @@
+NAME
+    xSPAppManagementServiceApp
+
+PARAMETERS
+    Name (Key, string)
+    ApplicationPool (Required, String)
+    DatabaseName (Write, string)
+    DatabaseServer (Write, String)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is used to provision and manage an instance of the App Management Services Service Application.
+It will identify an instance of the app management service application through the application display name.
+Currently the resource will provision the app if it does not yet exist, and will change the application pool associated to the app if it does not match the configuration.
+Database names or server name will not be changed if the configuration does not match, these parameters are only used for the initial provisioning of the service application.
+
+EXAMPLE
+
+   xSPAppManagementServiceApp AppManagementServiceApp
+    {
+        Name = "App Management Service Application"
+        AppPool = "SharePoint web services"
+        DatabaseServer = "SQL01.contoso.com"
+        DatabaseName = "SP_ManagedMetadata"
+}
+

Modules/xSharePoint/en-us/about_xSPBCSServiceApp.help.txt

@@ -0,0 +1,28 @@
+NAME
+    xSPBCSServiceApp
+
+PARAMETERS
+    Name (Key, string)
+    ApplicationPool (Required, String)
+    DatabaseName (Write, string)
+    DatabaseServer (Write, String)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is used to provision and manage an instance of the Business Connectivity Services Service Application.
+It will identify an instance of the BCS app through the application display name.
+Currently the resource will provision the app if it does not yet exist, and will change the service account associated to the app if it does not match the configuration.
+Database names or server name will not be changed if the configuration does not match, these parameters are only used for the initial provisioning of the service application.
+
+EXAMPLE
+
+    xSPBCSServiceApp BCSServiceApp
+    {
+        Name            = "BCS Service Application"
+        ApplicationPool = "SharePoint Service Applications"
+        DatabaseName    = "SP_BCS"
+        DatabaseServer  = $DatabaseServer
+        InstallAccount  = $InstallAccount
+    }
+

Modules/xSharePoint/en-us/about_xSPCacheAccounts.help.txt

@@ -0,0 +1,23 @@
+NAME
+    xSPCacheAccounts
+
+PARAMETERS
+    WebAppUrl (Key, string)
+    SuperUserAlias (Required, string)
+    SuperReaderAlias (Required, string)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is used to set the "super user" and "super reader" cache accounts for the specified web application object (as described in the TechNet article [Configure object cache user accounts in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/ff758656.aspx)).
+
+EXAMPLE
+
+    xSPCacheAccounts SetCacheAccounts
+    {
+        WebAppUrl            = "http://sharepoint.contoso.com"
+        SuperUserAlias       = "DEMO\svcSPSuperUser"
+        SuperReaderAlias     = "DEMO\svcSPReader"
+        PsDscRunAsCredential = $InstallAccount
+    }
+

Modules/xSharePoint/en-us/about_xSPCreateFarm.help.txt

@@ -0,0 +1,38 @@
+NAME
+    xSPCreateFarm
+
+PARAMETERS
+    FarmConfigDatabaseName (Key, String)
+    DatabaseServer (Key, String)
+    FarmAccount (Required, String)
+    InstallAccount (Write, String)
+    Passphrase (Required, String)
+    AdminContentDatabaseName (Required, String)
+    CentralAdministrationPort (Write, uint32)
+    ServerRole (Write, string, Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd)
+
+DESCRIPTION
+
+This resource is used to provision a new SharePoint farm.
+It should only be used on the first server in the farm to create the configuration database, all servers to join the farm after the first server creates the configuration database should use [xSPJoinFarm](xSPJoinFarm). 
+Once the config DB has been created, the resource will install local help collections, secure resources, activate features and provision the central admin site.
+
+The port of the Central Admin website can be set by using the CentralAdministrationPort property, if this is not defined the site will be provisioned on port 9999.
+However this setting will not impact existing deployments that already have Central Admin provisioned on another port.
+Also when a farm is created, the current behavior is to not enroll the server as a cache server (which is the default behavior of SharePoint).
+This means you need to use [xSPDistributedCacheService](xSPDistributedCacheService) on at least one server in the farm to designate it as a cache server.
+
+EXAMPLE
+
+    xSPCreateFarm CreateSPFarm
+    {
+        DatabaseServer            = "SQL.contoso.local\SQLINSTANCE"
+        FarmConfigDatabaseName    = "SP_Config"
+        Passphrase                = "Example Passphrase"
+        FarmAccount               = $FarmAccount
+        PsDscRunAsCredential      = $SetupAccount
+        AdminContentDatabaseName  = "SP_AdminContent"
+        CentralAdministrationPort = 2000
+        ServerRole                = Custom
+    }
+

Modules/xSharePoint/en-us/about_xSPDesignerSettings.help.txt

@@ -0,0 +1,45 @@
+NAME
+    xSPDesignerSettings
+
+PARAMETERS
+    Url (Key, string)
+    SettingsScope (Required, string, Allowed values: WebApplication, SiteCollection)
+    AllowSharePointDesigner (Write, Boolean)
+    AllowDetachPagesFromDefinition (Write, Boolean)
+    AllowCustomiseMasterPage (Write, Boolean)
+    AllowManageSiteURLStructure (Write, Boolean)
+    AllowCreateDeclarativeWorkflow (Write, Boolean)
+    AllowSavePublishDeclarativeWorkflow (Write, Boolean)
+    AllowSaveDeclarativeWorkflowAsTemplate (Write, Boolean)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is used to set the SharePoint Designer settings for the local farm or site collections.
+These settings will be used to control if users are allowed to make changes using SharePoint Designer.
+Note that this will not prevent users from installing SharePoint Designer, just from using SharePoint Designer to connect to the farm.
+
+Settings can be applied against an entire web application, or a specific site collection. 
+Use the "SettingsScope" property to set it to either "WebApplication" or "SiteCollection" to define which you are targetting.
+
+Known issue:
+When using PowerShell v4 or PowerShell v5 with the InstallAccount switch (instead of PsDscRunAsCredential), you cannot use the SettingsScope "SiteCollection".
+Due to an issue with Remote PowerShell and SharePoint, changing the Site Collection settings results in an Access Denied error.
+Consider implementing PowerShell v5 and switching to the PsDscRunAsCredential configuration.
+
+EXAMPLE
+
+    xSPDesignerSettings MainWebAppSPDSettings
+    {
+        Url                                     = "https://intranet.sharepoint.contoso.com"
+        SettingsScope                           = "WebApplication"
+        AllowSharePointDesigner                 = $false
+        AllowDetachPagesFromDefinition          = $false
+        AllowCustomiseMasterPage                = $false
+        AllowManageSiteURLStructure             = $false
+        AllowCreateDeclarativeWorkflow          = $false
+        AllowSavePublishDeclarativeWorkflow     = $false
+        AllowSaveDeclarativeWorkflowAsTemplate  = $false
+        PsDscRunAsCredential                    = $InstallAccount
+    }
+

Modules/xSharePoint/en-us/about_xSPDiagnosticLoggingSettings.help.txt

@@ -0,0 +1,54 @@
+NAME
+    xSPDiagnosticLoggingSettings
+
+PARAMETERS
+    LogPath (Key, string)
+    LogSpaceInGB (Required, uint32)
+    AppAnalyticsAutomaticUploadEnabled (Write, boolean)
+    CustomerExperienceImprovementProgramEnabled (Write, boolean)
+    DaysToKeepLogs (Write, uint32)
+    DownloadErrorReportingUpdatesEnabled (Write, boolean)
+    ErrorReportingAutomaticUploadEnabled (Write, boolean)
+    ErrorReportingEnabled (Write, boolean)
+    EventLogFloodProtectionEnabled (Write, boolean)
+    EventLogFloodProtectionNotifyInterval (Write, uint32)
+    EventLogFloodProtectionQuietPeriod (Write, uint32)
+    EventLogFloodProtectionThreshold (Write, uint32)
+    EventLogFloodProtectionTriggerPeriod (Write, uint32)
+    LogCutInterval (Write, uint32)
+    LogMaxDiskSpaceUsageEnabled (Write, boolean)
+    ScriptErrorReportingDelay (Write, uint32)
+    ScriptErrorReportingEnabled (Write, boolean)
+    ScriptErrorReportingRequireAuth (Write, boolean)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is responsible for configuring settings to do with the diagnostic (ULS) logging on servers in the farm.
+These settings are applied to the diagnostic logging service for the farm and do not need to be applied to each server individually, the settings will be propagated throughout the farm when they are set. 
+
+EXAMPLE
+
+    xSPDiagnosticLoggingSettings ApplyDiagnosticLogSettings
+    {
+        PsDscRunAsCredential                        = $InstallAccount
+        LogPath                                     = "L:\ULSLogs"
+        LogSpaceInGB                                = 10
+        AppAnalyticsAutomaticUploadEnabled          = $false
+        CustomerExperienceImprovementProgramEnabled = $true
+        DaysToKeepLogs                              = 7
+        DownloadErrorReportingUpdatesEnabled        = $false
+        ErrorReportingAutomaticUploadEnabled        = $false
+        ErrorReportingEnabled                       = $false
+        EventLogFloodProtectionEnabled              = $true
+        EventLogFloodProtectionNotifyInterval       = 5
+        EventLogFloodProtectionQuietPeriod          = 2
+        EventLogFloodProtectionThreshold            = 5
+        EventLogFloodProtectionTriggerPeriod        = 2
+        LogCutInterval                              = 15
+        LogMaxDiskSpaceUsageEnabled                 = $true
+        ScriptErrorReportingDelay                   = 30
+        ScriptErrorReportingEnabled                 = $true
+        ScriptErrorReportingRequireAuth             = $true
+    }
+

Modules/xSharePoint/en-us/about_xSPDistributedCacheService.help.txt

@@ -0,0 +1,30 @@
+NAME
+    xSPDistributedCacheService
+
+PARAMETERS
+    Name (Key, String)
+    Ensure (Required, string, Allowed values: Present, Absent)
+    CacheSizeInMB (Required, UInt32)
+    ServiceAccount (Required, String)
+    InstallAccount (Write, String)
+    CreateFirewallRules (Required, Boolean)
+
+DESCRIPTION
+
+This resource is responsible for provisioning the distributed cache to the service it runs on. 
+This is required in your farm on at least one server (as the behavior of [xSPCreateFarm](xSPCreateFarm) and [xSPJoinFarm](xSPJoinFarm) is to not enroll every server as a cache server). 
+The service will be provisioned or de-provisioned based on the Ensure property, and when provisioned the CacheSizeInMB property and ServiceAccount property will be used to configure it.
+The property createFirewallRules is used to determine if exceptions should be added to the windows firewall to allow communication between servers on the appropriate ports.
+
+EXAMPLE
+
+    xSPDistributedCacheService EnableDistributedCache
+    {
+        Name                = "AppFabricCachingService"
+        Ensure              = "Present"
+        CacheSizeInMB       = 8192
+        ServiceAccount      = "DEMO\ServiceAccount"
+        InstallAccount      = $InstallAccount
+        CreateFirewallRules = $true
+    }
+

Modules/xSharePoint/en-us/about_xSPFarmAdministrators.help.txt

@@ -0,0 +1,25 @@
+NAME
+    xSPFarmAdministrators
+
+PARAMETERS
+    Name (Key, String)
+    Members (Write, String)
+    MembersToInclude (Write, String)
+    MembersToExclude (Write, String)
+    InstallAccount (Write, String)
+
+DESCRIPTION
+
+This resource is used to manage the membership of the farm administrators group.
+There are a number of approaches to how this can be implemented.
+The "members" property will set a specific list of members for the group, making sure that every user/group in the list is in the group and all others that are members and who are not in this list will be removed.
+The "MembersToInclude" and "MembersToExclude" properties will allow you to control a specific set of users to add or remove, without changing any other members that are in the group already that may not be specified here, allowing for some manual management outside of this configuration resource.
+
+EXAMPLE
+
+    xSPFarmAdministrators LocalFarmAdmins
+    {
+        Name            = "Farm Administrators"
+        Members         = @("CONTOSO\user1", "CONTOSO\user2")
+    }
+

Modules/xSharePoint/en-us/about_xSPFeature.help.txt

@@ -0,0 +1,27 @@
+NAME
+    xSPFeature
+
+PARAMETERS
+    Name (Key, string)
+    FeatureScope (Required, string, Allowed values: Farm, WebApplication, Site, Web)
+    Url (Key, string)
+    InstallAccount (Write, String)
+    Ensure (Required, string, Allowed values: Present, Absent)
+
+DESCRIPTION
+
+This resource is used to make sure that a specific feature is either enabled or disabled at a given URL/scope.
+The Ensure property will dictate if the feature should be on or off. 
+The name property is the name of the feature based on its folder name in the FEATURES folder in the SharePoint hive directory. 
+
+EXAMPLE
+
+    xSPFeature EnableViewFormsLockDown
+    {
+        Name                 = "ViewFormPagesLockDown"
+        Url                  = "http://www.contoso.com"
+        Ensure               = "Present"
+        Scope                = "Site"
+        PsDscRunAsCredential = $SetupAccuount     
+    }
+