From 6c9d79d310faa4e1d1177b651283f4e5635702ac Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Wed, 27 Jul 2016 13:12:05 +1000 Subject: [PATCH 01/18] Added doco --- .../en-us/about_SPAccessServiceApp.help.txt | 41 +++++ .../en-us/about_SPAlternateUrl.help.txt | 41 +++++ .../en-us/about_SPAntivirusSettings.help.txt | 48 ++++++ .../en-us/about_SPAppCatalog.help.txt | 26 ++++ .../en-us/about_SPAppDomain.help.txt | 32 ++++ .../about_SPAppManagementServiceApp.help.txt | 48 ++++++ .../en-us/about_SPBCSServiceApp.help.txt | 48 ++++++ .../en-us/about_SPBlobCacheSettings.help.txt | 66 ++++++++ .../en-us/about_SPCacheAccounts.help.txt | 38 +++++ .../en-us/about_SPContentDatabase.help.txt | 56 +++++++ .../en-us/about_SPCreateFarm.help.txt | 72 +++++++++ .../en-us/about_SPDatabaseAAG.help.txt | 43 ++++++ .../en-us/about_SPDesignerSettings.help.txt | 75 +++++++++ ...about_SPDiagnosticLoggingSettings.help.txt | 110 +++++++++++++ .../about_SPDistributedCacheService.help.txt | 59 +++++++ .../en-us/about_SPExcelServiceApp.help.txt | 36 +++++ .../en-us/about_SPFarmAdministrators.help.txt | 39 +++++ .../en-us/about_SPFarmSolution.help.txt | 64 ++++++++ .../en-us/about_SPFeature.help.txt | 48 ++++++ .../about_SPHealthAnalyzerRuleState.help.txt | 47 ++++++ .../en-us/about_SPInstall.help.txt | 55 +++++++ .../en-us/about_SPInstallPrereqs.help.txt | 131 ++++++++++++++++ .../en-us/about_SPIrmSettings.help.txt | 34 ++++ .../en-us/about_SPJoinFarm.help.txt | 41 +++++ .../en-us/about_SPManagedAccount.help.txt | 49 ++++++ ...about_SPManagedMetaDataServiceApp.help.txt | 50 ++++++ .../en-us/about_SPManagedPath.help.txt | 48 ++++++ ...about_SPOfficeOnlineServerBinding.help.txt | 41 +++++ .../about_SPOutgoingEmailSettings.help.txt | 46 ++++++ .../about_SPPasswordChangeSettings.help.txt | 41 +++++ ...bout_SPPerformancePointServiceApp.help.txt | 41 +++++ .../en-us/about_SPQuotaTemplate.help.txt | 50 ++++++ .../en-us/about_SPRemoteFarmTrust.help.txt | 40 +++++ .../about_SPSearchContentSource.help.txt | 124 +++++++++++++++ .../en-us/about_SPSearchCrawlRule.help.txt | 72 +++++++++ .../about_SPSearchIndexPartition.help.txt | 49 ++++++ .../en-us/about_SPSearchResultSource.help.txt | 47 ++++++ .../en-us/about_SPSearchServiceApp.help.txt | 58 +++++++ .../en-us/about_SPSearchTopology.help.txt | 68 ++++++++ .../about_SPSecureStoreServiceApp.help.txt | 76 +++++++++ .../en-us/about_SPServiceAppPool.help.txt | 36 +++++ .../about_SPServiceAppProxyGroup.help.txt | 60 ++++++++ .../en-us/about_SPServiceAppSecurity.help.txt | 58 +++++++ .../en-us/about_SPServiceInstance.help.txt | 38 +++++ .../about_SPSessionStateService.help.txt | 41 +++++ .../en-us/about_SPShellAdmins.help.txt | 76 +++++++++ .../SharePointDsc/en-us/about_SPSite.help.txt | 79 ++++++++++ .../en-us/about_SPStateServiceApp.help.txt | 44 ++++++ ..._SPSubscriptionSettingsServiceApp.help.txt | 47 ++++++ .../en-us/about_SPTimerJobState.help.txt | 52 +++++++ .../en-us/about_SPUsageApplication.help.txt | 67 ++++++++ .../about_SPUserProfileProperty.help.txt | 145 ++++++++++++++++++ .../about_SPUserProfileServiceApp.help.txt | 82 ++++++++++ ...PUserProfileServiceAppPermissions.help.txt | 42 +++++ ...about_SPUserProfileSyncConnection.help.txt | 70 +++++++++ .../about_SPUserProfileSyncService.help.txt | 43 ++++++ .../en-us/about_SPVisioServiceApp.help.txt | 34 ++++ .../SharePointDsc/en-us/about_SPWeb.help.txt | 68 ++++++++ .../about_SPWebAppBlockedFileTypes.help.txt | 44 ++++++ .../about_SPWebAppGeneralSettings.help.txt | 106 +++++++++++++ .../en-us/about_SPWebAppPermissions.help.txt | 56 +++++++ .../en-us/about_SPWebAppPolicy.help.txt | 83 ++++++++++ .../en-us/about_SPWebAppProxyGroup.help.txt | 39 +++++ .../about_SPWebAppSiteUseAndDeletion.help.txt | 45 ++++++ .../about_SPWebAppThrottlingSettings.help.txt | 80 ++++++++++ .../about_SPWebAppWorkflowSettings.help.txt | 40 +++++ .../en-us/about_SPWebApplication.help.txt | 84 ++++++++++ .../about_SPWebApplicationAppDomain.help.txt | 49 ++++++ .../about_SPWordAutomationServiceApp.help.txt | 127 +++++++++++++++ .../about_SPWorkManagementServiceApp.help.txt | 67 ++++++++ 70 files changed, 4100 insertions(+) create mode 100644 Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPFeature.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPInstall.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSite.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWeb.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt diff --git a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt new file mode 100644 index 000000000..a2b3040f7 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt @@ -0,0 +1,41 @@ +.NAME + SPAccessServiceApp + +.SYNOPSIS + +This resource is responsible for creating Access Services Application instances within the local SharePoint farm. +The resource will provision and configure the Access Services Service Application. + +.EXAMPLE + + SPAccessServiceApp AccessServices + { + Name = "Access Services Service Application" + ApplicationPool = "SharePoint Web Services" + DatabaseServer = "sql.contoso.local" + InstallAccount = $InstallAccount + } + + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER DatabaseServer + Required - string + The name of the database server to host Access Services databases + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt new file mode 100644 index 000000000..e6f03d83c --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt @@ -0,0 +1,41 @@ +.NAME + SPAlternateUrl + +.SYNOPSIS + +This resource is used to define an alternate access mapping URL for a specified web application. + + +.EXAMPLE + + SPAlternateUrl CentralAdminAAM + { + WebAppUrl = "http://sharepoint1:9999" + Zone = "Intranet" + Url = "https://admin.sharepoint.contoso.com" + PsDscRunAsCredential = $SPSetupAccount + } + +.PARAMETER WebAppUrl + Key - String + The URL of the web application to apply the alternate URL to + +.PARAMETER Zone + Key - String + Allowed values: Default, Intranet, Extranet, Custom, Internet + The Zone to use for the alternate URL + +.PARAMETER Url + Write - String + The new alternate URL + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures the URL is set for this zone on this web app, Absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt new file mode 100644 index 000000000..7564a50fd --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt @@ -0,0 +1,48 @@ +.NAME + SPAntivirusSettings + +.SYNOPSIS + +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 + + SPAntivirusSettings AVSettings + { + ScanOnDownload = $true + ScanOnUpload = $true + AllowDownloadInfected = $false + AttemptToClean = $false + } + +.PARAMETER ScanOnDownload + Key - Boolean + Should documents be scanned before being downloaded + +.PARAMETER ScanOnUpload + Write - Boolean + Should documents be scanned on upload + +.PARAMETER AllowDownloadInfected + Write - Boolean + Should documents that are infected be allowed to be downloaded + +.PARAMETER AttemptToClean + Write - Boolean + Should infected documents be handed to the AV engine to attempt cleaning + +.PARAMETER TimeoutDuration + Write - Uint16 + What is the timeout for an AV scan in seconds + +.PARAMETER NumberOfThreads + Write - Uint16 + How many concurrent threads should the AV engine be able to run on a server + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt new file mode 100644 index 000000000..50642f165 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt @@ -0,0 +1,26 @@ +.NAME + SPAppCatalog + +.SYNOPSIS + +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 + + SPAppCatalog MainAppCatalog + { + SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" + PsDscRunAsCredential = $SPSetupAccount + } + + +.PARAMETER SiteUrl + Key - string + The URL of the site collection that will be the app catalog for the web app that it is in + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt new file mode 100644 index 000000000..b1e1d8c38 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt @@ -0,0 +1,32 @@ +.NAME + SPAppDomain + +.SYNOPSIS + +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 + + SPAppDomain LocalFarmAppUrls + { + AppDomain = "contosointranetapps.com" + Prefix = "app" + PsDscRunAsCredential = $InstallAccount + } + + +.PARAMETER AppDomain + Key - string + The domain name for apps to use in this farm + +.PARAMETER Prefix + Required - string + The prefix to go on to app URLs + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt new file mode 100644 index 000000000..3046886e6 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt @@ -0,0 +1,48 @@ +.NAME + SPAppManagementServiceApp + +.SYNOPSIS + +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 + + SPAppManagementServiceApp AppManagementServiceApp + { + Name = "App Management Service Application" + ApplicationPool = "SharePoint web services" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_AppManagement" + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the app management service application + +.PARAMETER ApplicationPool + Required - String + The app pool that should be used to run the service app + +.PARAMETER DatabaseName + Write - string + The name of the database for the service application + +.PARAMETER DatabaseServer + Write - String + The name of the server for the database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt new file mode 100644 index 000000000..892d20809 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt @@ -0,0 +1,48 @@ +.NAME + SPBCSServiceApp + +.SYNOPSIS + +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 + + SPBCSServiceApp BCSServiceApp + { + Name = "BCS Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseName = "SP_BCS" + DatabaseServer = $DatabaseServer + InstallAccount = $InstallAccount + Ensure = "Present" + } + +.PARAMETER Name + Key - string + The name of the BCS service app + +.PARAMETER ApplicationPool + Required - String + The application pool it should run in + +.PARAMETER DatabaseName + Write - string + Name of the database to create for the service app + +.PARAMETER DatabaseServer + Write - String + Name of the database server to host the database on + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt new file mode 100644 index 000000000..ca37f7379 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt @@ -0,0 +1,66 @@ +.NAME + SPBlobCacheSettings + +.SYNOPSIS + +This resource is used to configure the Blob Cache settings for a web application. + +Important: +This resource only configures the local server. +It changes the web.config file directly and is NOT using the SPWebConfigModifications class. +In order to configure all WFE servers in the farm, you have to apply this resource to all servers. + +Note: +- In order to prevent inconsistancy between different web front end servers, make sure you configure this setting on all servers equally. +- If the specified folder does not exist, the resource will create the folder. + +Best practice: +Specify a directory that is not on the same drive as where either the server operating system swap files or server log files are stored. + +.EXAMPLE + + SPBlobCacheSettings BlobCacheSettings + { + WebAppUrl = "http://intranet.contoso.com" + Zone = "Default" + EnableCache = $true + Location = "F:\BlobCache" + MaxSizeInGB = 10 + FileTypes = "\.(gif|jpg|png|css|js)$" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER Zone + Required - string + Allowed values: Default, Intranet, Internet, Custom, Extranet + The zone of the web application for which blob cache has to be configured + +.PARAMETER EnableCache + Required - Boolean + Specify if the blob cache has to be enabled + +.PARAMETER Location + Write - string + The location where the blob cache has to store its files + +.PARAMETER MaxSizeInGB + Write - Uint16 + The maximum size (in GB) of disk space the blob cache is allowed to use + +.PARAMETER MaxAgeInSeconds + Write - Uint32 + The maximum age (in seconds) that a browser caches a blob + +.PARAMETER FileTypes + Write - string + Specify the file types that must be stored by the blob cache + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt new file mode 100644 index 000000000..d72823d23 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt @@ -0,0 +1,38 @@ +.NAME + SPCacheAccounts + +.SYNOPSIS + +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 + + SPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER WebAppUrl + Key - string + The URL of the web application to set the accounts for + +.PARAMETER SuperUserAlias + Required - string + The account name for the super user + +.PARAMETER SuperReaderAlias + Required - string + The account name for the super reader + +.PARAMETER SetWebAppPolicy + Write - boolean + Should the web app policy be set for these accounts? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt new file mode 100644 index 000000000..55293baf1 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt @@ -0,0 +1,56 @@ +.NAME + SPContentDatabase + +.SYNOPSIS + +This resource is used to add and remove Content Databases to web applications and and configure these databases. +Note: The resource cannot be used to move the database to a different SQL instance. +It will throw an error when it detects that the specified SQL instance is a different instance that is currently in use. + +.EXAMPLE + + SPContentDatabase ContentDB { + Name = "SharePoint_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + WebAppUrl = "http://sharepoint.contoso.com" + Enabled = $true + WarningSiteCount = 2000 + MaximumSiteCount = 5000 + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - String + Specifies the name of the content database + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the content DB + +.PARAMETER WebAppUrl + Required - string + The URL of the web application + +.PARAMETER Enabled + Write - Boolean + Should the database be enabled + +.PARAMETER WarningSiteCount + Write - Uint16 + Specify the site collection warning limit for the content database + +.PARAMETER MaximumSiteCount + Write - Uint16 + Specify the site collection maximum limit for the content database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to create this database, absent to ensure it does not exist + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt new file mode 100644 index 000000000..651eeaf50 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt @@ -0,0 +1,72 @@ +.NAME + SPCreateFarm + +.SYNOPSIS + +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 [SPJoinFarm](SPJoinFarm). +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 passphrase is passed as a Credential object. The username of this credential is ignored, only the value of the password is used as the farm passphrase. + +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 [SPDistributedCacheService](SPDistributedCacheService) on at least one server in the farm to designate it as a cache server. + +CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not specified, it defaults to NTLM. If using Kerberos, make sure to have appropriate SPNs setup for Farm account and Central Administration URI. + +.EXAMPLE + + SPCreateFarm CreateSPFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + Passphrase = $FarmPassPhrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + AdminContentDatabaseName = "SP_AdminContent" + CentralAdministrationPort = 2000 + CentralAdministrationAuth = "Kerberos" + ServerRole = Custom + } + +.PARAMETER FarmConfigDatabaseName + Key - String + Name of the configuration database + +.PARAMETER DatabaseServer + Key - String + Server that will host the configuration and admin content databases + +.PARAMETER FarmAccount + Required - String + The account to use as the main farm account + +.PARAMETER Passphrase + Required - String + The passphrase to use to allow servers to join this farm + +.PARAMETER AdminContentDatabaseName + Required - String + The name of the admin content database + +.PARAMETER CentralAdministrationPort + Write - uint32 + What port will Central Admin be provisioned to - default is 9999 + +.PARAMETER CentralAdministrationAuth + Write - String + Allowed values: NTLM, Kerberos + The authentication provider of the CentralAdministration web application + +.PARAMETER ServerRole + Write - string + Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd + SharePoint 2016 only - the MinRole role to enroll this server as + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt new file mode 100644 index 000000000..793f86259 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt @@ -0,0 +1,43 @@ +.NAME + SPDatabaseAAG + +.SYNOPSIS + +This resource will allow specifying which SQL Server AlwaysOn Availability group a resource should be in. +This resource does not configure the Availability Groups on SQL Server, they must already exist. +It simply adds the specified database to the group. + + +.EXAMPLE + + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "SP_Config" + AGName = "MyAvailabilityGroup" + FileShare = "\\SQL\Backups" + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + }s + +.PARAMETER DatabaseName + Key - string + The name of the database to put in the AlwaysOn group + +.PARAMETER AGName + Required - string + Name of the AlwaysOn group on the SQL server - this must already exist + +.PARAMETER FileShare + Write - string + The fileshare to use for the SQL backup when adding to the group + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the database should be in this AlwaysOn group, or Absent if it should not be in the group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt new file mode 100644 index 000000000..fee03f6b3 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt @@ -0,0 +1,75 @@ +.NAME + SPDesignerSettings + +.SYNOPSIS + +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 + + SPDesignerSettings 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 + } + +.PARAMETER Url + Key - string + The URL of the web application or site collection to configure + +.PARAMETER SettingsScope + Required - string + Allowed values: WebApplication, SiteCollection + Define the scope of the configuration - either WebApplication or SiteCollection + +.PARAMETER AllowSharePointDesigner + Write - Boolean + Allow the use of SharePoint Designer + +.PARAMETER AllowDetachPagesFromDefinition + Write - Boolean + Allow pages to be un-ghosted by SharePoint Designer + +.PARAMETER AllowCustomiseMasterPage + Write - Boolean + Allow masterpages to be changed by SharePoint Designer + +.PARAMETER AllowManageSiteURLStructure + Write - Boolean + Allow site URL structure to be changed by SharePoint Designer + +.PARAMETER AllowCreateDeclarativeWorkflow + Write - Boolean + Allow users to create declarative workflows with SharePoint Designer + +.PARAMETER AllowSavePublishDeclarativeWorkflow + Write - Boolean + Allow users to save and re-publish declarative workflows with SharePoint Designer + +.PARAMETER AllowSaveDeclarativeWorkflowAsTemplate + Write - Boolean + Allow users to save declarative workflows as a template from SharePoint Designer + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt new file mode 100644 index 000000000..61b39ab56 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt @@ -0,0 +1,110 @@ +.NAME + SPDiagnosticLoggingSettings + +.SYNOPSIS + +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 + + SPDiagnosticLoggingSettings 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 + } + +.PARAMETER LogPath + Key - string + The physical path on each server to store ULS logs + +.PARAMETER LogSpaceInGB + Required - uint32 + The space in GB that should be used to store ULS logs + +.PARAMETER AppAnalyticsAutomaticUploadEnabled + Write - boolean + Should app analytics automatically be uploaded + +.PARAMETER CustomerExperienceImprovementProgramEnabled + Write - boolean + Should the customer experience program be enabled in this farm + +.PARAMETER DaysToKeepLogs + Write - uint32 + How many days should ULS logs be kept for + +.PARAMETER DownloadErrorReportingUpdatesEnabled + Write - boolean + Should updates to error reporting tools be automatically downloaded + +.PARAMETER ErrorReportingAutomaticUploadEnabled + Write - boolean + Should error reports be automatically uploaded + +.PARAMETER ErrorReportingEnabled + Write - boolean + Should reporting of errors be enabled + +.PARAMETER EventLogFloodProtectionEnabled + Write - boolean + Protect event logs with Event Log Flood Protection + +.PARAMETER EventLogFloodProtectionNotifyInterval + Write - uint32 + What interval should the event logs report a flood event + +.PARAMETER EventLogFloodProtectionQuietPeriod + Write - uint32 + What quiet period should reset the event log flood protection thresholds + +.PARAMETER EventLogFloodProtectionThreshold + Write - uint32 + What is the event log flood protection threshold + +.PARAMETER EventLogFloodProtectionTriggerPeriod + Write - uint32 + What is the time period that will trigger event log flood protection + +.PARAMETER LogCutInterval + Write - uint32 + How many minutes of activity will a ULS log file leep in an individual file + +.PARAMETER LogMaxDiskSpaceUsageEnabled + Write - boolean + Will the maximum disk space setting be enabled + +.PARAMETER ScriptErrorReportingDelay + Write - uint32 + What delay will be set before script error reporting is triggered + +.PARAMETER ScriptErrorReportingEnabled + Write - boolean + Is script error reporting enabled in this farm + +.PARAMETER ScriptErrorReportingRequireAuth + Write - boolean + Require users to be authenticated to allow script errors to be reported + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt new file mode 100644 index 000000000..2185448ef --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt @@ -0,0 +1,59 @@ +.NAME + SPDistributedCacheService + +.SYNOPSIS + +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 [SPCreateFarm](SPCreateFarm) and [SPJoinFarm](SPJoinFarm) 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. + +The ServerProvisionOrder optional property is used when a pull server is handing out configurations to nodes in order to tell this resource about a specific order of enabling the caches. +This allows for multiple servers to receive the same configuration, but they will always check for the server before them in the list first to ensure that it is running distributed cache. +By doing this you can ensure that you do not create conflicts with two or more servers provisioning a cache at the same time. +Note, this approach only makes a server check the others for distributed cache, it does not provision the cache automatically on all servers. +If a previous server in the sequence does not appear to be running distributed cache after 30 minutes, the local server that was waiting will begin anyway. + +.EXAMPLE + + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + Ensure = "Present" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + InstallAccount = $InstallAccount + ServerProvisionOrder = @("server1", "server2") + CreateFirewallRules = $true + } + +.PARAMETER Name + Key - String + A name to assign to this resource - not really used. For example - AppFabricCachingService + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the current server should be running distributed cache, absent to ensure that it isn't running + +.PARAMETER CacheSizeInMB + Required - UInt32 + How many MB should be used for the cache. The maximum supported is 16384 + +.PARAMETER ServiceAccount + Required - String + The name of the service account to run the service as. This should already be registered as a managed account in SharePoint + +.PARAMETER ServerProvisionOrder + Write - String + A list of servers which specifies the order they should provision the cache in to ensure that two servers do not do it at the same time + +.PARAMETER CreateFirewallRules + Required - Boolean + Should the Windows Firewall rules for distributed cache be created? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt new file mode 100644 index 000000000..f5552c1ab --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt @@ -0,0 +1,36 @@ +.NAME + SPExcelServiceApp + +.SYNOPSIS + +This resource is responsible for creating Excel Services Application instances within the local SharePoint farm. +The resource will provision and configure the Excel Services Service Application. + +.EXAMPLE + + SPExcelServiceApp ExcelServices + { + Name = "Excel Services Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $InstallAccount + } + + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt new file mode 100644 index 000000000..3afdc0892 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt @@ -0,0 +1,39 @@ +.NAME + SPFarmAdministrators + +.SYNOPSIS + +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 + + SPFarmAdministrators LocalFarmAdmins + { + Name = "Farm Administrators" + Members = @("CONTOSO\user1", "CONTOSO\user2") + } + +.PARAMETER Name + Key - String + A generic name for this resource, its value is not important + +.PARAMETER Members + Write - String + A list of members to set the group to. Those not in this list will be removed + +.PARAMETER MembersToInclude + Write - String + A list of members to add. Members not in this list will be left in the group + +.PARAMETER MembersToExclude + Write - String + A list of members to remove. Members not in this list will be left in the group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt new file mode 100644 index 000000000..eaad1a40f --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt @@ -0,0 +1,64 @@ +.NAME + SPFarmSolution + + +.SYNOPSIS + +This resource is used to make sure that a specific farm solution is either present or absent in a farm. +The Ensure property will dictate if the solution should be present or absent. +The name property is the name of the solution including the wsp extension (i.e. MySolution.wsp). +The LiteralPath is required and points to the solution in the files system that is used to upload it if it does not exist. +The Version will be stored in the property bag to determine later if the correct version is installed. +I the version in the farm does not match the desired version an upgrade of the solution will be performed. + +The solution can be deployed to one or more web application passing an array of URL's to the WebApplications property. +If the solution contains resources scoped for web applications and no WebApplications are specified, the solution will be deployed to all web applications. +If the solution does not contain resources scoped for web applications the property is ignored and the solution is deployed globally. + +.EXAMPLE + + SPFarmSolution SampleWsp + { + Name = "MySolution.wsp" + LiteralPath = "C:\src\MySolution.wsp" + Ensure = "Present" + Version = "1.0.0" + WebApplications = @("http://collaboration", "http://mysites") + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The filename of the WSP package + +.PARAMETER LiteralPath + Required - string + The full path to the WSP file + +.PARAMETER WebApplications + Write - string + A list of the web applications to deploy this to + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the WSP should be deployed, or Absent if it should be removed + +.PARAMETER Version + Write - string + The version of the package that is being modified + +.PARAMETER Deployed + Write - Boolean + Should the solution be deployed to the farm, or just installed to the farm + +.PARAMETER SolutionLevel + Write - string + Allowed values: 14, 15, All + What compatability level should the WSP be deployed as? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt new file mode 100644 index 000000000..6e106bdef --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt @@ -0,0 +1,48 @@ +.NAME + SPFeature + +.SYNOPSIS + +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 + + SPFeature EnableViewFormsLockDown + { + Name = "ViewFormPagesLockDown" + Url = "http://www.contoso.com" + Ensure = "Present" + Scope = "Site" + PsDscRunAsCredential = $SetupAccuount + Version = "1.0.0.0" + } + +.PARAMETER Name + Key - string + The name of the feature + +.PARAMETER FeatureScope + Required - string + Allowed values: Farm, WebApplication, Site, Web + The scope to change the feature at - Farm, WebApplication, SiteCollection or Site + +.PARAMETER Url + Key - string + The URL to change the feature at + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the feature is to be enabled, Absent if it is to be disabled + +.PARAMETER Version + Write - string + The version of the feature to check against + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt new file mode 100644 index 000000000..9cb7df5ac --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt @@ -0,0 +1,47 @@ +.NAME + SPHealthAnalyzerRuleState + +.SYNOPSIS + +This resource is used to configure Health Analyzer rules for the local farm. +The resource is able to enable/disable and configure the specified rule. + +.EXAMPLE + + SPHealthAnalyzerRuleState DisableDiskSpaceRule + { + Name = "Drives are at risk of running out of free space." + Enabled = $true + RuleScope = "All Servers" + Schedule = "Daily" + FixAutomatically = $false + InstallAccount = $InstallAccount + } + +.PARAMETER Name + Key - String + The name of the rule exactly as it appears in central admin + +.PARAMETER Enabled + Required - Boolean + Should the rule be enabled? + +.PARAMETER RuleScope + Write - String + Allowed values: All Servers, Any Server + What is the scope of this rule + +.PARAMETER Schedule + Write - String + Allowed values: Hourly, Daily, Weekly, Monthly, OnDemandOnly + How often should the rule check + +.PARAMETER FixAutomatically + Write - Boolean + Should the rule fix itself automatically + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt new file mode 100644 index 000000000..bf627e178 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt @@ -0,0 +1,55 @@ +.NAME + SPInstall + +.SYNOPSIS + +This resource is used to install the SharePoint binaries. +The BinaryDir parameter should point to the path that setup.exe is located (not to setup.exe itself). +The ProductKey parameter is used to inject in to the configuration file and validate the license key during the installation process. +This module depends on the prerequisites already being installed, which can be done through the use of [SPInstallPreReqs](SPInstallPreReqs). + +.EXAMPLE + + SPInstall InstallBinaries + { + BinaryDir = "C:\SPInstall" + ProductKey = $ProductKey + } + +**Installing SharePoint Foundation 2013** + +SharePoint Foundation 2013 is not supported by SPInstall (see [Issue #81](https://github.com/PowerShell/xSharePoint/issues/81) for the details). +A workaround for this is to use the package resource as demonstrated below. + + Package InstallSharePointFoundation + { + Ensure = "Present" + Name = "Microsoft SharePoint Foundation 2013 Core" + Path = "E:\SharePoint2013\Setup.exe" + Arguments = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml" + ProductID = "90150000-1014-0000-1000-0000000FF1CE" + ReturnCode = 0 + } + +.PARAMETER BinaryDir + Key - String + The directory that contains all of the SharePoint binaries + +.PARAMETER ProductKey + Required - String + The product key to use during the installation + +.PARAMETER InstallPath + Write - String + The install directory to use in the installation, leave blank to use the setup defaults + +.PARAMETER DataPath + Write - String + The data directory to use in the installation, leave blank to use the setup defaults + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + + diff --git a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt new file mode 100644 index 000000000..97b89e980 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt @@ -0,0 +1,131 @@ +.NAME + SPInstallPrereqs + +.SYNOPSIS + +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 + } + +**Examples** + +Online example: + + SPInstallPrereqs InstallPrerequisites + { + InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" + OnlineMode = $true + } + +Offline example: + + SPInstallPrereqs InstallPrerequisites + { + 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" + } + +.PARAMETER InstallerPath + Key - String + The full path to prerequisiteinstaller.exe + +.PARAMETER OnlineMode + Required - Boolean + Should the installer download prerequisites from the internet or not + +.PARAMETER SXSpath + Write - String + The path to the Windows Server Operating System SXS source files, for use in closed environments without access to Windows Update + +.PARAMETER SQLNCli + Write - String + The path to the installer for this prerequisite + +.PARAMETER PowerShell + Write - String + The path to the installer for this prerequisite + +.PARAMETER NETFX + Write - String + The path to the installer for this prerequisite + +.PARAMETER IDFX + Write - String + The path to the installer for this prerequisite + +.PARAMETER Sync + Write - String + The path to the installer for this prerequisite + +.PARAMETER AppFabric + Write - String + The path to the installer for this prerequisite + +.PARAMETER IDFX11 + Write - String + The path to the installer for this prerequisite + +.PARAMETER MSIPCClient + Write - String + The path to the installer for this prerequisite + +.PARAMETER WCFDataServices + Write - String + The path to the installer for this prerequisite + +.PARAMETER KB2671763 + Write - String + The path to the installer for this prerequisite + +.PARAMETER WCFDataServices56 + Write - String + The path to the installer for this prerequisite + +.PARAMETER MSVCRT11 + Write - String + The path to the installer for this prerequisite + +.PARAMETER MSVCRT14 + Write - String + The path to the installer for this prerequisite + +.PARAMETER KB3092423 + Write - String + The path to the installer for this prerequisite + +.PARAMETER ODBC + Write - String + The path to the installer for this prerequisite + +.PARAMETER DotNetFx + Write - String + The path to the installer for this prerequisite + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install the prerequisites. Absent is currently not supported + + diff --git a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt new file mode 100644 index 000000000..337e2cb9d --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt @@ -0,0 +1,34 @@ +.NAME + SPIrmSettings + +.SYNOPSIS + +This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS + +.EXAMPLE + + SPIrmSettings ContosoRMS + { + Ensure = "Present" + RMSserver = "https://rms.contoso.com" + } + + +.PARAMETER Ensure + Key - String + Allowed values: Present, Absent + Enable or Disable IRM on this farm + +.PARAMETER UseADRMS + Write - Boolean + Use the RMS server published in this farm's Active Directory + +.PARAMETER RMSserver + Write - String + Use the specified RMS server, must provide in URL format + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt new file mode 100644 index 000000000..15664b4de --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt @@ -0,0 +1,41 @@ +.NAME + SPJoinFarm + +.SYNOPSIS + +This resource will be responsible for joining a server to an existing SharePoint farm. +To create a new farm use the [SPCreateFarm](SPCreateFarm) resource on a different server to begin with, and then pass the same database server and configuration database name parameters to the additional servers using this resource. +After the server has joined the farm, the process will wait for 5 minutes to allow farm specific configuration to take place on the server, before allowing further DSC configuration to take place. + +.EXAMPLE + + SPJoinFarm JoinSPFarm + { + DatabaseServer = $DatabaseServer + FarmConfigDatabaseName = "SP_Config" + Passphrase = $FarmPassPhrase + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER FarmConfigDatabaseName + Key - string + The name of the config database to connect to + +.PARAMETER DatabaseServer + Key - string + The server that hosts the config database + +.PARAMETER Passphrase + Required - string + The passphrase that should be used to join the farm + +.PARAMETER ServerRole + Write - string + Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd + SharePoint 2016 only - the MinRole role to enroll this server as + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt new file mode 100644 index 000000000..a76152999 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt @@ -0,0 +1,49 @@ +.NAME + SPManagedAccount + +.SYNOPSIS + +This resource will ensure a managed account is provisioned in to the SharePoint farm. +The Account object specific the credential to store (including username and password) to set as the managed account. +The settings for EmailNotification, PreExpireDays and Schedule all relate to enabling automatic password change for the managed account, leaving these option out of the resource will ensure that no automatic password changing from SharePoint occurs. + +.EXAMPLE + + SPManagedAccount WebPoolManagedAccount + { + AccountName = $WebPoolManagedAccount.UserName + Account = $WebPoolManagedAccount + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER AccountName + Key - string + The username of the account + +.PARAMETER Account + Write - String + The credential with password of the account + +.PARAMETER EmailNotification + Write - Uint32 + How many days before a password change should an email be sent + +.PARAMETER PreExpireDays + Write - Uint32 + How many days before a password expires should it be changed + +.PARAMETER Schedule + Write - string + What is the schedule for the password reset + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures managed account exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt new file mode 100644 index 000000000..3a0499deb --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt @@ -0,0 +1,50 @@ +.NAME + SPManagedMetaDataServiceApp + +.SYNOPSIS + +Creates a managed metadata service application. +The application pool property specifies which application pool it should use, and will reset the application back to this pool if it is changed after its initial provisioning. +The database server and database name properties are only used during provisioning, and will not be altered as part of the ongoing operation of the DSC resource. + +.EXAMPLE + + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $InstallAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = $DatabaseServer + DatabaseName = "SP_ManagedMetadata" + } + +.PARAMETER Name + Key - string + The name of the managed metadata service application + +.PARAMETER ApplicationPool + Required - string + The application pool that the service app will use + +.PARAMETER DatabaseServer + Write - string + The name of the database server which will host the application + +.PARAMETER DatabaseName + Write - string + The name of the database for the service application + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER ContentTypeHubUrl + Write - string + The URL of the content type hub for this app (only set when the app is provisioned) + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt new file mode 100644 index 000000000..519ef1b13 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt @@ -0,0 +1,48 @@ +.NAME + SPManagedPath + +.SYNOPSIS + +This resource is responsible for creating managed paths associated with a specific web application. +The WebAppUrl parameter is used to specify the web application to create the path against, and the RelativeUrl parameter lets you set the URL. +Explicit when set to true will create an explicit inclusion path, if set to false the path is created as wildcard inclusion. +If you are using host named site collections set HostHeader to true and the path will be created as a host header path to be applied for host named site collections. + +.EXAMPLE + + SPManagedPath TeamsManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $InstallAccount + RelativeUrl = "teams" + Explicit = $false + Ensure = "Present" + HostHeader = $true + } + +.PARAMETER WebAppUrl + Key - string + The URL of the web application to apply the managed path to - this is ignored for host header web applications + +.PARAMETER RelativeUrl + Key - string + The relative URL of the managed path + +.PARAMETER Explicit + Required - boolean + Should the host header be explicit? If false then it is a wildcard + +.PARAMETER HostHeader + Required - boolean + Is this a host header web application? + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures managed path exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt new file mode 100644 index 000000000..f3367b234 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt @@ -0,0 +1,41 @@ +.NAME + SPOfficeOnlineServerBinding + +.SYNOPSIS + +This resource will create a binding to an Office Online Server (formerly known as Office Web Apps). +The DnsName property can be a single server name, or a FQDN of a load balanced end point that will direct traffic to a farm. + +NOTE: This resource is designed to be used where all WOPI bindings will be targeted to the same Office Online Server farm. +If used on a clean environment, the new bindings will all point to the one DNS Name. +If used on an existing configuration that does not follow this rule, it will match only the first DNS name it finds in the list of bindings. + +.EXAMPLE + + SPOfficeOnlineServerBinding OosBinding + { + Zone = "internal-https" + DnsName = "webapps.contoso.com" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + +.PARAMETER Zone + Key - string + Allowed values: Internal-HTTP, Internal-HTTPS, External-HTTP, External-HTTPS + The zone for this binding + +.PARAMETER DnsName + Required - string + The DNS name of the server/s that are running Office Web Apps + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures the binding for this zone exists, absent ensures it doesn't + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt new file mode 100644 index 000000000..040505b22 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt @@ -0,0 +1,46 @@ +.NAME + SPOutgoingEmailSettings + +.SYNOPSIS + +This resource is used to set the outgoing email settings for either a single web application, or the whole farm. +To configure the resource for a specific web app, use the URL of the web application for the WebAppUrl property, to change the settings for the whole farm use the URL of the central admin website instead. +It is possible to set the outgoing server, from address, reply to address and the character set to be used for emails. + +.EXAMPLE + + SPOutgoingEmailSettings FarmWideEmailSettings + { + WebAppUrl = "http://sharepoint1:2013" + SMTPServer = "smtp.contoso.com" + FromAddress = "sharepoint@contoso.com" + ReplyToAddress = "noreply@contoso.com" + CharacterSet = "65001" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER WebAppUrl + key - string + The URL of the web application. If you want to set the global settings use the Central Admin URL + +.PARAMETER SMTPServer + Required - string + The SMTP server for outgoing mail + +.PARAMETER FromAddress + Required - string + The from address to put on messages + +.PARAMETER ReplyToAddress + Required - string + The email address that replies should be directed to + +.PARAMETER CharacterSet + Required - string + The character set to use on messages + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt new file mode 100644 index 000000000..49b23d483 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt @@ -0,0 +1,41 @@ +.NAME + SPPasswordChangeSettings + +.SYNOPSIS + +This resource is used to control settings that relate to the automatic changing of passwords for managed accounts (where they opt-in to be managed by SharePoint). +These settings can be manually controlled through central administration, or configured in this resource. +The settings relate to email notifications of when passwords are reset, as well as behavior when a reset occurs such as a time out and number of retries. + +.EXAMPLE + + SPPasswordChangeSettings ManagedAccountPasswordResetSettings + { + MailAddress = "sharepoint@contoso.com" + DaysBeforeExpiry = "14" + PasswordChangeWaitTimeSeconds = "60" + NumberOfRetries = "3" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER MailAddress + key - string + The email address to send notifications of password changes to + +.PARAMETER DaysBeforeExpiry + Write - Uint32 + The number of days before password expiry to send send emails + +.PARAMETER PasswordChangeWaitTimeSeconds + Write - Uint32 + The duration that a password reset will wait for before it times out + +.PARAMETER NumberOfRetries + Write - Uint32 + How many retries if the password change fails + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt new file mode 100644 index 000000000..c4b13a77a --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt @@ -0,0 +1,41 @@ +.NAME + SPPerformancePointServiceApp + +.SYNOPSIS + +This resource is responsible for creating Performance Point Service Application instances within the local SharePoint farm. +The resource will provision and configure the Performance Point Service Application. +.EXAMPLE + SPPerformancePointServiceApp PerformancePoint + { + Name = "Performance Point Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt new file mode 100644 index 000000000..b4007aedc --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt @@ -0,0 +1,50 @@ +.NAME + SPQuotaTemplate + +.SYNOPSIS + +This resource is used to configure quota templates in the farm. +These settings will be used to make sure a certain quota template exists or not. When it exists, it will also make sure the settings are configured as specified. + +.EXAMPLE + + SPQuotaTemplate TeamsiteTemplate + { + Name = "Teamsite" + StorageMaxInMB = 1024 + StorageWarningInMB = 512 + MaximumUsagePointsSolutions = 1000 + WarningUsagePointsSolutions = 800 + Ensure = "Present" + } + +.PARAMETER Name + Key - string + The name of the quota template + +.PARAMETER StorageMaxInMB + Write - uint32 + The maximum storage for sites of this template in MB + +.PARAMETER StorageWarningInMB + Write - uint32 + The amount of storage for sites of this template that triggers a warning + +.PARAMETER MaximumUsagePointsSolutions + Write - uint32 + The maximum number of performance points for sandbox solutions for this template + +.PARAMETER WarningUsagePointsSolutions + Write - uint32 + The warning number of performance points for sandbox solutions for this template + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to create this template, absent to ensure it does not exist + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt new file mode 100644 index 000000000..a45f47ba3 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt @@ -0,0 +1,40 @@ +.NAME + SPRemoteFarmTrust + +.SYNOPSIS + +This resource is used to trust a remote SharePoint farm. +This is used when federating search results between two different SharePoint farms. +The technique is described at https://technet.microsoft.com/en-us/library/dn133749.aspx + +.EXAMPLE + + SPRemoteFarmTrust TrustRemoteFarmForSearch + { + Name = "CentralSearchFarm" + RemoteWebAppUrl = "https://search.sharepoint.contoso.com" + LocalWebAppUrl = "https://local.sharepoint2.contoso.com" + } + +.PARAMETER Name + Key - string + A name of the remote farm, used to create token issuer and root authority + +.PARAMETER RemoteWebAppUrl + Required - string + The URL of a web app in the remote farm, must use HTTPS + +.PARAMETER LocalWebAppUrl + Required - string + The URL of a local web app to connect the remote farm to + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Set to present to ensure the trust exists, or absent to ensure it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt new file mode 100644 index 000000000..18189067e --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt @@ -0,0 +1,124 @@ +.NAME + SPSearchContentSource + +.SYNOPSIS + +This resource will deploy and configure a content source in a specified search service application. + +.EXAMPLE + +This example is for a SharePoint content source + + SPSearchContentSource LocalSharePointSites + { + Name = "Local SharePoint Sites" + ServiceAppName = "Search Service Application" + ContentSourceType = "SharePoint" + Addresses = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com") + CrawlSetting = "CrawlEverything" + ContinuousCrawl = $true + IncrementalSchedule = MSFT_SPSearchCrawlSchedule @{ + ScheduleType = "Daily" + StartHour = "0" + StartMinute = "0" + CrawlScheduleRepeatDuration = "1440" + CrawlScheduleRepeatInterval = "5" + } + FullSchedule = $null + Priority = "Normal" + Ensure = "Present" + PsDscRunAsCredential = $SPSetupAccount + DependsOn = "[SPSearchRoles]LocalSearchRoles" + } + +This example is for a website content source + + SPSearchContentSource LocalSharePointSites + { + Name = "Local SharePoint Sites" + ServiceAppName = "Search Service Application" + ContentSourceType = "Website" + Addresses = @("http://www.contoso.com") + CrawlSetting = "Custom" + LimitPageDepth = 5 + LimitServerHops = 0 + IncrementalSchedule = MSFT_SPSearchCrawlSchedule @{ + ScheduleType = "Daily" + StartHour = "0" + StartMinute = "0" + CrawlScheduleRepeatDuration = "1440" + CrawlScheduleRepeatInterval = "5" + } + FullSchedule = MSFT_SPSearchCrawlSchedule @{ + ScheduleType = "Weekly" + CrawlScheduleDaysOfWeek = @("Monday", "Wednesday", "Friday") + StartHour = "3" + StartMinute = "0" + } + Priority = "Normal" + Ensure = "Present" + PsDscRunAsCredential = $SPSetupAccount + DependsOn = "[SPSearchRoles]LocalSearchRoles" + } + +.PARAMETER Name + Key - String + The name of the content source + +.PARAMETER ServiceAppName + Key - String + The name of the search service app that this content source exists within + +.PARAMETER ContentSourceType + Required - String + Allowed values: SharePoint, Website, FileShare + The type of content source - currently only SharePoint, Website and File Shares are supported + +.PARAMETER Addresses + Required - String + A list of the addresses this content source includes + +.PARAMETER CrawlSetting + Required - String + Allowed values: CrawlEverything, CrawlFirstOnly, Custom + Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only) + +.PARAMETER ContinuousCrawl + Write - Boolean + Should this content source use continuous crawl (SharePoint sites only) + +.PARAMETER IncrementalSchedule + Write - String + What is the incremental schedule for this content source + +.PARAMETER FullSchedule + Write - String + What is the full schedule for this content source + +.PARAMETER Priority + Write - String + Allowed values: Normal, High + What is the priority on this content source + +.PARAMETER LimitPageDepth + Write - Uint32 + How many pages deep should the crawler go (-1 = unlimited, website sources only) + +.PARAMETER LimitServerHops + Write - Uint32 + How many server hops should the crawler make (-1 = unlimtied, website sources only) + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the source should exist, absent if it should not + +.PARAMETER Force + Write - Boolean + Specify true if DSC is allowed to delete and recreate a content source to apply the correct settings, otherwise false will just report errors if a change can not be applied. + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt new file mode 100644 index 000000000..540785750 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt @@ -0,0 +1,72 @@ +.NAME + SPSearchCrawlRule + +.SYNOPSIS + +This resource is responsible for managing the search crawl rules in the search service application. +You can create new rules, change existing rules and remove existing rules. + +.EXAMPLE + + SPSearchCrawlRule IntranetCrawlAccount + { + Path = "https://intranet.sharepoint.contoso.com" + ServiceAppName = "Search Service Application" + Ensure = "Present" + RuleType = "InclusionRule" + CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" + AuthenticationType = "DefaultRuleAccess" + } + + SPSearchCrawlRule IntranetCrawlAccountCertificate + { + Path = "https://intranet.sharepoint.contoso.com" + ServiceAppName = "Search Service Application" + Ensure = "Present" + RuleType = "InclusionRule" + CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" + AuthenticationType = "CertificateRuleAccess" + CertificateName = "Certificate Name" + } + +.PARAMETER Path + Key - string + The name of the search service application + +.PARAMETER ServiceAppName + Required - string + The name of the search service application + +.PARAMETER AuthenticationType + Write - string + Allowed values: DefaultRuleAccess, BasicAccountRuleAccess, CertificateRuleAccess, NTLMAccountRuleAccess, FormRuleAccess, CookieRuleAccess, AnonymousAccess + Authentication type used by the crawl rule + +.PARAMETER RuleType + Write - string + Allowed values: InclusionRule, ExclusionRule + The type of the rule + +.PARAMETER CrawlConfigurationRules + Write - string + Allowed values: FollowLinksNoPageCrawl, CrawlComplexUrls, CrawlAsHTTP + The configuration options for this rule + +.PARAMETER AuthenticationCredentials + Write - String + The credentials used for this crawl rule (used for types BasicAccountRuleAccess and NTLMAccountRuleAccess) + +.PARAMETER CertificateName + Write - string + The certificate used for this crawl rule (used for type CertificateRuleAccess) + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt new file mode 100644 index 000000000..ce6751510 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt @@ -0,0 +1,49 @@ +.NAME + SPSearchIndexPartition + +.SYNOPSIS + +This resource is responsible for creating search indexes. +It works by creating the index topology components and updating the topology from the server that runs this resource. +For this reason this resource only needs to run from one server and not from each server which will host the index component. +The search service application and existing search topology must be deployed before creating additional indexes. +The first index will be created through the use of the SPSearchRoles resource. +Additional search index partitions can be created through using this resource. + +Note that for the search topology to apply correctly, the path specified for RootDirectory needs to exist on the server that is executing this resource. +For example, if the below example was executed on "Server1" it would also need to ensure that it was able to create the index path at I:\. +If no disk labeled I: was available on server1, this would fail, even though it will not hold an actual index component. + +.EXAMPLE + + SPSearchIndexPartition MainSearchPartition + { + Servers = @("Server2", "Server3") + Index = 1 + RootDirectory = "I:\SearchIndexes\1" + ServiceAppName = "Search Service Application" + PsDscRunAsCredential = $SPSetupAccount + DependsOn = "[SPSearchRoles]LocalSearchRoles" + } + +.PARAMETER Index + Key - Uint32 + The number of the partition in this farm + +.PARAMETER Servers + Required - String + A list of the servers that this partition should exist on + +.PARAMETER RootDirectory + Write - String + The directory that the index should use locally on each server to store data + +.PARAMETER ServiceAppName + Required - String + The name of the search service application + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt new file mode 100644 index 000000000..17da64292 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt @@ -0,0 +1,47 @@ +.NAME + SPSearchResultSource + +.SYNOPSIS + +This resoruce +.EXAMPLE + + SPSearchResultSource RemoteSharePointFarm + { + Name = "External SharePoint results" + SearchServiceAppName = "Search Service Application" + Query = "{searchTerms}" + ProviderType = "Remote SharePoint Provider" + } + +.PARAMETER Name + Key - String + The name of the result source + +.PARAMETER SearchServiceAppName + Required - String + The name of the search service application to associate this result source with + +.PARAMETER Query + Required - String + The query to pass to the provider source + +.PARAMETER ProviderType + Required - String + Allowed values: Exchange Search Provider, Local People Provider, Local SharePoint Provider, OpenSearch Provider, Remote People Provider, Remote SharePoint Provider + The provider type to use for the result source + +.PARAMETER ConnectionUrl + Write - String + The URI to connect to the remote location + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the result source should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt new file mode 100644 index 000000000..5cc227786 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt @@ -0,0 +1,58 @@ +.NAME + SPSearchServiceApp + +.SYNOPSIS + +This resource is responsible for provisioning the search service application. +The current version lets you specify the database name and server, as well as the application pool. +If the application pool is changed the DSC resource will set it back as per what is set in the resource. +The database name parameter is used as the prefix for all search databases (so you will end up with one for the admin database which matches the name, and then "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well). + +.EXAMPLE + + SPSearchServiceApp SearchServiceApp + { + Name = "Search Service Application" + DatabaseName = "SP_Search" + ApplicationPool = "SharePoint Service Applications" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the search service application + +.PARAMETER ApplicationPool + Required - string + The application pool that it should run in + +.PARAMETER SearchCenterUrl + Write - string + The URL of the enterprise search center site collection + +.PARAMETER DatabaseName + Write - string + The name of the database (noting that some search databases will use this as a prefix) + +.PARAMETER DatabaseServer + Write - string + The server that host the databases for this service application + +.PARAMETER DefaultContentAccessAccount + Write - String + The default content access account for this search service app + +.PARAMETER CloudIndex + Write - boolean + Should this search service application be a cloud based service app + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt new file mode 100644 index 000000000..5165b5a54 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt @@ -0,0 +1,68 @@ +.NAME + SPSearchTopology + +.SYNOPSIS + +This resource is responsible for provisioning a search topology in to the current farm. +It allows the configuration to dictate the search topology roles that the current server should be running. +Any combination of roles can be specified and the topology will be upaded to reflect the current servers new roles. +If this is the first server to apply topology to a farm, then at least one search index must be provided. +To this end, the FirstPartitionIndex, FirstPartitionDirectory and FirstPartitionServers allow configuring where the first index partition will belong. +This will behave the same as the SPSearchIndexPartition resource. + +Note that for the search topology to apply correctly, the path specified for FirstPartitionDirectory needs to exist on the server that is executing this resource. +For example, if the below example was executed on "Server1" it would also need to ensure that it was able to create the index path at I:\. +If no disk labeled I: was available on server1, this would fail, even though it will not hold an actual index component. + +.EXAMPLE + + SPSearchTopology LocalSearchTopology + { + ServiceAppName = "Search Service Application" + Admin = @("Server1","Server2") + Crawler = @("Server1","Server2") + ContentProcessing = @("Server1","Server2") + AnalyticsProcessing = @("Server1","Server2") + QueryProcessing = @("Server3","Server4") + PsDscRunAsCredential = $SPSetupAccount + FirstPartitionDirectory = "I:\SearchIndexes\0" + IndexPartition = @("Server3","Server4") + } + +.PARAMETER ServiceAppName + Key - String + The name of the search service application for this topology + +.PARAMETER Admin + Required - String + A list of servers that will run the admin component + +.PARAMETER Crawler + Required - String + A list of servers that will run the crawler component + +.PARAMETER ContentProcessing + Required - String + A list of servers that will run the content processing component + +.PARAMETER AnalyticsProcessing + Required - String + A list of servers that will run the analytics processing component + +.PARAMETER QueryProcessing + Required - String + A list of servers that will run the query processing component + +.PARAMETER IndexPartition + Required - String + A list of servers that will host the first (0) index partition + +.PARAMETER FirstPartitionDirectory + Required - String + The local directory servers will use to store the first index partition + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt new file mode 100644 index 000000000..7196a95a7 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt @@ -0,0 +1,76 @@ +.NAME + SPSecureStoreServiceApp + +.SYNOPSIS + +This resource is responsible for provisioning and configuring the secure store service application. +The parameters passed in (except those related to database specifics) are validated and set when the resource is run, the database values are only used in provisioning of the service application. + +.EXAMPLE + + SPSecureStoreServiceApp SecureStoreServiceApp + { + Name = "Secure Store Service Application" + ApplicationPool = "SharePoint Service Applications" + AuditingEnabled = $true + AuditlogMaxSize = 30 + DatabaseName = "SP_SecureStore" + InstallAccount = $InstallAccount + Ensure = "Present" + } + +.PARAMETER Name + Key - string + The name of the secure store service app + +.PARAMETER ApplicationPool + Required - string + The name of the application pool it will run in + +.PARAMETER AuditingEnabled + Required - boolean + Is auditing enabled for this service app + +.PARAMETER AuditlogMaxSize + Write - uint32 + What is the maximum size of the audit log in MB + +.PARAMETER DatabaseCredentials + Write - String + What SQL credentials should be used to access the database + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the database + +.PARAMETER DatabaseAuthenticationType + Write - string + Allowed values: Windows, SQL + What type of authentication should be used to access the database + +.PARAMETER FailoverDatabaseServer + Write - string + The name of the database server hosting a failover instance of the database + +.PARAMETER PartitionMode + Write - boolean + Is partition mode enabled for this service app + +.PARAMETER Sharing + Write - boolean + Is sharing enabled for this service app + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt new file mode 100644 index 000000000..e27492dc1 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt @@ -0,0 +1,36 @@ +.NAME + SPServiceAppPool + +.SYNOPSIS + +This resource is used for provisioning an application pool that can be used for service applications. +The account used for the service account must already be registered as a managed account (which can be provisioned through [SPManagedAccount](SPManagedAccount)). + +.EXAMPLE + + SPServiceAppPool MainServiceAppPool + { + Name = "SharePoint Service Applications" + ServiceAccount = "Demo\ServiceAccount" + InstallAccount = $InstallAccount + Ensure = "Present" + } + +.PARAMETER Name + Key - string + The name of application pool + +.PARAMETER ServiceAccount + Required - string + The name of the managed account to run this service account as + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app pool should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt new file mode 100644 index 000000000..878a8d3f9 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt @@ -0,0 +1,60 @@ +.NAME + SPServiceAppProxyGroup + +.SYNOPSIS + +This resource is used to manage SharePoint Service Application Proxy Groups. +The "Ensure" parameter controls whether or not the Proxy Group should exist. A proxy group cannot be removed if a web application is using it. +The "ServiceAppProxies" property will set a specific list of Service App Proxies to be members of this Proxy Group. It will add and remove proxies to ensure the group matches this list exactly. +The "ServiceAppProxiesToInclude" and "ServiceAppProxiesToExclude" properties will allow you to add and remove proxies from the group, leaving other proxies that are in the group but not in either list intact. + +Use the proxy group name "Default" to manipulate the default proxy group. + + +Requirements: +At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or ServiceAppProxiesToExclude properties needs to be specified. +Do not combine the ServiceAppProxies property with the ServiceAppProxiesToInclude and ServiceAppProxiesToExclude properties. + +**Examples** + + SPServiceAppProxyGroup ProxyGroup1 + { + Name = "Proxy Group 1" + Ensure = "Present" + ServiceAppProxies = "Web 1 User Profile Service Application","Web 1 MMS Service Application","State Service Application" + } + + SPServiceAppProxyGroup ProxyGroup2 + { + Name = "Proxy Group 2" + Ensure = "Present" + ServiceAppProxiesToInclude = "Web 2 User Profile Service Application" + } + + +.PARAMETER Name + Key - String + Name of the Proxy Group to create + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present creates the proxy group if it does not already exist, Absent will delete the proxy group if it exists + +.PARAMETER ServiceAppProxies + Write - String + List of service application proxies that belong in this proxy group, all others will be removed + +.PARAMETER ServiceAppProxiesToInclude + Write - String + List of service application proxies to add to this proxy group, existing proxies will remain + +.PARAMETER ServiceAppProxiesToExclude + Write - String + List of service application proxies to remove from this proxy grop, all others will remain + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt new file mode 100644 index 000000000..0c9ffca9c --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt @@ -0,0 +1,58 @@ +.NAME + SPServiceAppSecurity + +.SYNOPSIS + +This resource is used to manage the sharing security settings of a specific service application. +There are a number of approaches to how this can be implemented. +Firstly you can set permissions for the app administrators, or for the sharing permission by specifying the SecurityType attribute. +These options correlate to the buttons seen in the ribbon on the "manage service applications" page in Central Administration after you select a specific service app. +The "Members" property will set a specific list of members for the service app, 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 + + $membersToInclude = @() + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointFarmAccount" + AccessLevel = "FullControl" + } + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointServiceApps" + AccessLevel = "FullControl" + } + SPServiceAppSecurity UserProfileServiceSecurity + { + ServiceAppName = "User Profile Service Application" + SecurityType = "SharingPermissions" + MembersToInclude = $membersToInclude + MembersToExclude = @("CONTOSO\BadAccount1", "CONTOSO\BadAccount2") + PsDscRunAsCredential = $SPSetupAccount + } + +.PARAMETER ServiceAppName + Key - String + The name of the service application you wish to apply security settings to + +.PARAMETER SecurityType + Key - string + Allowed values: Administrators, SharingPermissions + Administrators will set the administrators for the service app, SharingPermissions will set those granted access through the permissions button seen in the Sharing section of the ribbon in central admin + +.PARAMETER Members + Write - String + A list of members to set the group to. Those not in this list will be removed + +.PARAMETER MembersToInclude + Write - String + A list of members to add. Members not in this list will be left in the group + +.PARAMETER MembersToExclude + Write - String + A list of members to remove. Members not in this list will be left in the group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt new file mode 100644 index 000000000..125e15f4f --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt @@ -0,0 +1,38 @@ +.NAME + SPServiceInstance + +.SYNOPSIS + +This resource is used to specify if a specific service should be running (Ensure = "Present") or not running (Ensure = "Absent") on the current server. +The name is the display name of the service as shown in the Central Admin website. + +**Examples** + + SPServiceInstance ManagedMetadataServiceInstance + { + Name = "Managed Metadata Web Service" + Ensure = "Present" + InstallAccount = $InstallAccount + } + + SPServiceInstance StopBCSServiceInstance + { + Name = "Business Data Connectivity Service" + Ensure = "Absent" + InstallAccount = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the service instance to manage + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure it runs on this server, or absent to ensure it is stopped + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt new file mode 100644 index 000000000..3773db3fc --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt @@ -0,0 +1,41 @@ +.NAME + SPSessionStateService + +.SYNOPSIS + +This resource will provision a state service app to the local farm. +Specify the name of the database server and database name to provision the app with, and optionally include the session timeout value. +If session timeout is not provided it will default to 60. + +.EXAMPLE + + SPSessionStateService StateServiceApp + { + DatabaseName = "SP_StateService" + DatabaseServer = "SQL.test.domain" + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER DatabaseName + Key - string + The name of the database for the service + +.PARAMETER DatabaseServer + Key - string + The name of the database server for the database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present is the state service should be enabled, absent if it should be disabled + +.PARAMETER SessionTimeout + Write - uint32 + What is the timeout on sessions + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt new file mode 100644 index 000000000..239ee35cc --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt @@ -0,0 +1,76 @@ +.NAME + SPShellAdmins + +.SYNOPSIS + +This resource is used to manage the users with Shell Admin permissions. +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. +The "ContentDatabases" and "AllContentDatabases" properties will allow you to control the permissions on Content Databases. + +Requirements: +At least one of the Members, MemberToInclude or MembersToExclude properties needs to be specified. +Do not combine the Members property with the MemberToInclude and MembersToExclude properties. +Do not combine the ContentDatabase property with the AllContentDatabases property. + +Notes: +1.) If a content database is created using the Central Admin, the farm account is the owner of that content database in SQL Server. +When this is true, you cannot add it to the Shell Admins (common for AllContentDatabases parameter) and the resource will throw an error. +Workaround: Change database owner in SQL Server. + +.EXAMPLE + + SPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + AllContentDatabases = $true + } + + SPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + ContentDatabases = @( + @(MSFT_SPContentDatabasePermissions { + Name = "SharePoint_Content_1" + Members = "CONTOSO\user2", "CONTOSO\user3" + }) + @(MSFT_SPContentDatabasePermissions { + Name = "SharePoint_Content_2" + Members = "CONTOSO\user3", "CONTOSO\user4" + }) + ) + } + + +.PARAMETER Name + Key - String + Name for the config, used for administration purposes + +.PARAMETER Members + Write - String + Exact list of accounts that will have to get Shell Admin permissions + +.PARAMETER MembersToInclude + Write - String + List of all accounts that must be in the Shell Admins group + +.PARAMETER MembersToExclude + Write - String + List of all accounts that are not allowed to have Shell Admin permissions + +.PARAMETER ContentDatabases + Write - String + Shell Admin configuration of Content Databases + +.PARAMETER AllContentDatabases + Write - Boolean + Specify if all content databases must get the same config as the general config + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSite.help.txt b/Modules/SharePointDsc/en-us/about_SPSite.help.txt new file mode 100644 index 000000000..d3588bdd4 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSite.help.txt @@ -0,0 +1,79 @@ +.NAME + SPSite + +.SYNOPSIS + +This resource will provision a site collection to the current farm, based on the settings that are passed through. +These settings map to the New-SPSite cmdlet and accept the same values and types. + +The current version of SharePointDsc is only able to check for the existence of a site collection, the additional parameters are not checked for yet, but will be in a later release + +.EXAMPLE + + SPSite TeamSite + { + Url = "http://sharepoint.contoso.com" + OwnerAlias = "CONTOSO\ExampleUser" + HostHeaderWebApplication = "http://spsites.contoso.com" + Name = "Team Sites" + Template = "STS#0" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the site collection + +.PARAMETER OwnerAlias + Required - string + The username of the site collection administrator + +.PARAMETER CompatibilityLevel + Write - uint32 + The compatibility level of the site + +.PARAMETER ContentDatabase + Write - string + The name of the content database to create the site in + +.PARAMETER Description + Write - string + The description to apply to the site collection + +.PARAMETER HostHeaderWebApplication + Write - string + The URL of the host header web application to create this site in + +.PARAMETER Language + Write - uint32 + The language code of the site + +.PARAMETER Name + Write - string + The display name of the site collection + +.PARAMETER OwnerEmail + Write - string + The email address of the site collection administrator + +.PARAMETER QuotaTemplate + Write - string + The quota template to apply to the site collection + +.PARAMETER SecondaryEmail + Write - string + The secondary site collection admin email address + +.PARAMETER SecondaryOwnerAlias + Write - string + The secondary site collection admin username + +.PARAMETER Template + Write - string + The template to apply to the site collection + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt new file mode 100644 index 000000000..c7897d0d0 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt @@ -0,0 +1,44 @@ +.NAME + SPStateServiceApp + +.SYNOPSIS + +This resource provisions an instance of the state service in to the local farm. +The database specific parameters are only used during initial provisioning of the app, and will not change database settings beyond the initial deployment. + +.EXAMPLE + + SPStateServiceApp StateServiceApp + { + Name = "State Service Application" + DatabaseName = "SP_State" + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the state service app + +.PARAMETER DatabaseCredentials + Write - String + The database credentials for accessing the database + +.PARAMETER DatabaseName + Required - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt new file mode 100644 index 000000000..cc30e6fc9 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt @@ -0,0 +1,47 @@ +.NAME + SPSubscriptionSettingsServiceApp + +.SYNOPSIS + +This resource is used to provision and manage an instance of the App Management Services Service Application. +It will identify an instance of the subscription settings service 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 + + SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp + { + Name = "Subscription Settings Service Application" + ApplicationPool = "SharePoint web services" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_SubscriptionSettings" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the subscription settings service app + +.PARAMETER ApplicationPool + Required - String + The name of the application pool the service app runs in + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - String + The name of the database server + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt new file mode 100644 index 000000000..f50ef0d5f --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt @@ -0,0 +1,52 @@ +.NAME + SPTimerJobState + +.SYNOPSIS + +This resource is used to configure a timer job and make sure it is in a specific state. +The resource can be used to enable or disabled the job and configure the schedule of the job. + +The schedule parameter has to be written in the SPSchedule format (https://technet.microsoft.com/en-us/library/ff607916.aspx). +Examples are: + - Every 5 minutes between 0 and 59 + - Hourly between 0 and 59 + - Daily at 15:00:00 + - Weekly between Fri 22:00:00 and Sun 06:00:00 + - Monthly at 15 15:00:00 + - Yearly at Jan 1 15:00:00 + +NOTE: Make sure you use the internal timer job name, not the display name! +Use "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" to find the internal name for each Timer Job. + +.EXAMPLE + + SPTimerJobState DisableTimerJob_DeadSiteDelete + { + Name = "job-dead-site-delete" + WebApplication = "http://sites.sharepoint.contoso.com" + Enabled = $true + Schedule ="weekly at sat 5:00" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - String + The internal name of the timer job (not the display name) + +.PARAMETER WebApplication + Write - String + The name of the web application that the timer job belongs to + +.PARAMETER Enabled + Write - Boolean + Should the timer job be enabled or not + +.PARAMETER Schedule + Write - String + The schedule for the timer job to execute on + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt new file mode 100644 index 000000000..116ec0690 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt @@ -0,0 +1,67 @@ +.NAME + SPUsageApplication + +.SYNOPSIS + +This resource provisions an instance of the usage and health monitoring service application. +The database settings are only used for initial provisioning, but the usage settings can be changed and will be enforced as the resource is executed. + +.EXAMPLE + + SPUsageApplication UsageApplication + { + Name = "Usage Service Application" + DatabaseName = "SP_Usage" + UsageLogCutTime = 5 + UsageLogLocation = "L:\UsageLogs" + UsageLogMaxFileSizeKB = 1024 + Ensure = "Present" + InstallAccount = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server + +.PARAMETER DatabaseCredentials + Write - String + The credentials to use to access the database + +.PARAMETER FailoverDatabaseServer + Write - string + The name of the failover database server + +.PARAMETER UsageLogCutTime + Write - uint32 + The time in minutes to cut over to new log files + +.PARAMETER UsageLogLocation + Write - string + The location on each server to store the log files + +.PARAMETER UsageLogMaxFileSizeKB + Write - uint32 + The maximum file size for log files in KB + +.PARAMETER UsageLogMaxSpaceGB + Write - uint32 + The total space of all log files on disk in GB + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt new file mode 100644 index 000000000..25f89a302 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt @@ -0,0 +1,145 @@ +.NAME + SPUserProfileProperty + +.SYNOPSIS + +This resource will create a property in a user profile service application. +It creates, update or delete a property using the parameters that are passed in to it . + +The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the 5th field of section Bla, which has propertyName value of 5000 then your DisplayOrder needs to be 5005 +If no DisplayOrder is added then SharePoint adds it as the last property of section X. + +Length is only relevant if Field type is "String". + +This Resource doesn't currently support removing existing user profile properties + +.EXAMPLE +SPUserProfileProperty WorkEmailProperty +{ + Name = "WorkEmail2" + Ensure = "Present" + UserProfileService = "User Profile Service Application" + DisplayName = "Work Email" + Type = "Email" + Description = "" #implementation isn't using it yet + PolicySetting = "Mandatory" + PrivacySetting = "Public" + MappingConnectionName = "contoso.com" + MappingPropertyName = "mail" + MappingDirection = "Import" + Length = 10 + DisplayOrder =25 + IsEventLog =$false + IsVisibleOnEditor=$true + IsVisibleOnViewer = $true + IsUserEditable = $true + IsAlias = $false + IsSearchable = $false + TermStore = "" + TermGroup = "" + TermSet = "" + UserOverridePrivacy = $false +} + + +.PARAMETER Name + Key - string + The internal name of the user profile property + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the property should exist, absent if it should be removed + +.PARAMETER UserProfileService + Required - string + The name of the user profile service application + +.PARAMETER DisplayName + Write - string + The display name of the property + +.PARAMETER Type + Write - string + Allowed values: BigInteger, Binary, Boolean, Date, DateNoYear, DateTime, Email, Float, Guid, HTML, Integer, Person, String, StringMultiValue, TimeZone, URL + The type of the property + +.PARAMETER Description + Write - string + The description of the property + +.PARAMETER PolicySetting + Write - string + Allowed values: Mandatory, Optin, Optout, Disabled + The policy setting to apply to the property + +.PARAMETER PrivacySetting + Write - string + Allowed values: Public, Contacts, Organization, Manager, Private + The privacy setting for the property + +.PARAMETER MappingConnectionName + Write - string + The name of the UPS connect to map this property to + +.PARAMETER MappingPropertyName + Write - string + The name of the property from the UPS connection to map to + +.PARAMETER MappingDirection + Write - string + The direction of the mapping, either Import or Export + +.PARAMETER Length + Write - uint32 + The length of the field + +.PARAMETER DisplayOrder + Write - uint32 + The display order to put the property in to the list at + +.PARAMETER IsEventLog + Write - boolean + Is this field used for event logging + +.PARAMETER IsVisibleOnEditor + Write - boolean + Is this field visible when editing a users profile, or hidden from editing + +.PARAMETER IsVisibleOnViewer + Write - boolean + Is this field visible when viewing a users profile + +.PARAMETER IsUserEditable + Write - boolean + Is this field able to be edited by a user, or only an administrator + +.PARAMETER IsAlias + Write - boolean + Is this field an alias that can be used to refer to a user by + +.PARAMETER IsSearchable + Write - boolean + Is this field able to be searched upon + +.PARAMETER UserOverridePrivacy + Write - boolean + Can users override the default privacy policy + +.PARAMETER TermStore + Write - string + The name of the term store to look up managed terms from + +.PARAMETER TermGroup + Write - string + The name of the term store group that terms are in for this field + +.PARAMETER TermSet + Write - string + The name of the term set to allow values to be selected from + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt new file mode 100644 index 000000000..330ca8f82 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt @@ -0,0 +1,82 @@ +.NAME + SPUserProfileServiceApp + +.SYNOPSIS + +This resource will provision an instance of the user profile service to the farm. +It creates the required databases using the parameters that are passed in to it (although these are only used during the initial provisioning). +The farm account is used during the provisioning of the service only (in the set method), and the install account is used in the get and test methods. +This is done to ensure that the databases are created with the correct schema owners and allow the user profile sync service to operate correctly. + +.EXAMPLE + + SPUserProfileServiceApp UserProfileServiceApp + { + Name = "User Profile Service Application" + ApplicationPool = "SharePoint Service Applications" + MySiteHostLocation = "http://my.sharepoint.contoso.local" + ProfileDBName = "SP_UserProfiles" + ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" + SocialDBName = "SP_Social" + SocialDBServer = "SQL.contoso.local\SQLINSTANCE" + SyncDBName = "SP_ProfileSync" + SyncDBServer = "SQL.contoso.local\SQLINSTANCE" + EnableNetBIOS = $false + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + +.PARAMETER Name + Key - string + The name of the user profile service + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER FarmAccount + Write - String + The farm account to use when provisioning the app + +.PARAMETER MySiteHostLocation + Write - string + The URL of the my site host collection + +.PARAMETER ProfileDBName + Write - string + The name of the profile database + +.PARAMETER ProfileDBServer + Write - string + The name of the server to host the profile database + +.PARAMETER SocialDBName + Write - string + The name of the social database + +.PARAMETER SocialDBServer + Write - string + The name of the database server to host the social database + +.PARAMETER SyncDBName + Write - string + The name of the sync database + +.PARAMETER SyncDBServer + Write - string + The name of the database server to host the sync database + +.PARAMETER EnableNetBIOS + Write - boolean + Whether Farm should resolve NetBIOS domain names + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt new file mode 100644 index 000000000..314d1ada6 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt @@ -0,0 +1,42 @@ +.NAME + SPUserProfileServiceAppPermissions + +.SYNOPSIS + +This resource will apply permissions to a user profile service application. +These can control access to create my sites, use social features, and use tagging. +If you want to allow all users the ability to use a specific permisisons include "Everyone" as a user in the corresponding property. +To specify that there should be no permissions on a type, use "none" + +.EXAMPLE + + SPUserProfileServiceAppPermissions UPAPermissions + { + ProxyName = "User Profile Service Application Proxy" + CreatePersonalSite = @("DEMO\Group", "DEMO\User1") + FollowAndEditProfile = @("Everyone") + UseTagsAndNotes = @("None") + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER ProxyName + Key - string + The name of the proxy that is attached to the user profile service you wish to set permissions for + +.PARAMETER CreatePersonalSite + Required - string + A list of user principals that will have the Create personal site permission + +.PARAMETER FollowAndEditProfile + Required - string + A list of user principals that will have the Follow users and edit profile permission + +.PARAMETER UseTagsAndNotes + Required - string + A list of user principals that will have the Use tags and notes permission + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt new file mode 100644 index 000000000..6092dfe32 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt @@ -0,0 +1,70 @@ +.NAME + SPUserProfileSyncConnection + +.SYNOPSIS + +This resource will ensure a specifc user profile sync connection is in place and that it is configured accordingly to its definition + +This resource currently supports AD only. +.EXAMPLE + + SPUserProfileSyncConnection MainDomain + { + UserProfileService = "User Profile Service Application" + Forest = "contoso.com" + Name = "Contoso" + ConnectionCredentials = $connectionCredential + Server = "server.contoso.com" + UseSSL = $false + IncludedOUs = @("OU=SharePoint Users,DC=Contoso,DC=com") + ExcludedOUs = @("OU=Notes Usersa,DC=Contoso,DC=com") + Force = $false + ConnectionType = "ActiveDirectory" +} + +.PARAMETER Name + Key - string + The name of the connection + +.PARAMETER Forest + Required - string + The name of the AD forest to read from + +.PARAMETER UserProfileService + Required - string + The name of the user profile service that this connection is attached to + +.PARAMETER ConnectionCredentials + Required - string + The credentials to connect to Active Directory with + +.PARAMETER IncludedOUs + Required - string + A listo f the OUs to import users from + +.PARAMETER ExcludedOUs + Write - string + A list of the OUs to ignore users from + +.PARAMETER Server + Write - string + The specific AD server to connect to + +.PARAMETER UseSSL + Write - boolean + Should SSL be used for the connection + +.PARAMETER Force + Write - boolean + Set to true to run the set method on every call to this resource + +.PARAMETER ConnectionType + Write - string + Allowed values: ActiveDirectory, BusinessDataCatalog + The type of the connection - currently only Active Directory is supported + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt new file mode 100644 index 000000000..c2a50ffbd --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt @@ -0,0 +1,43 @@ +.NAME + SPUserProfileSyncService + +.SYNOPSIS + +This resource is responsible for ensuring that the user profile sync service has been provisioned (Ensure = "Present") or is not running (Ensure = "Absent") on the current server. +This resource uses the InstallAccount to validate the current state only, the set method which will do the provisioning uses the FarmAccount to do the actual work - this means that CredSSP authentication will need to be permitted to allow a connection to the local server. +To allow successful provisioning the farm account must be in the local administrators group, however it is not best practice to leave this account in the Administrators group. +Therefore this resource will add the FarmAccount credential to the local administrators group at the beginning of the set method, and then remove it once it has completed its work. + +.EXAMPLE + + SPUserProfileSyncService UserProfileSyncService + { + UserProfileServiceAppName = "User Profile Service Application" + Ensure = "Present" + FarmAccount = $FarmAccount + RunOnlyWhenWriteable = $true + InstallAccount = $InstallAccount + } + +.PARAMETER UserProfileServiceAppName + Key - string + The name of the user profile service for this sync instance + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the service is running, absent to ensure it is not + +.PARAMETER FarmAccount + Required - String + The farm account, which is needed to provision the service app + +.PARAMETER RunOnlyWhenWriteable + Write - Boolean + Should the sync service only run when the user profile database is in a writeable state? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt new file mode 100644 index 000000000..12eb617cb --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt @@ -0,0 +1,34 @@ +.NAME + SPVisioServiceApp + +.SYNOPSIS + +This resource is responsible for creating Visio Graphics Service Application instances within the local SharePoint farm. +The resource will provision and configure the Visio Graphics Service Application. +.EXAMPLE + SPVisioServiceApp VisioServices + { + Name = "Visio Graphics Service Application" + ApplicationPool = "SharePoint Web Services" + Ensure = "Present" + InstallAccount = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt new file mode 100644 index 000000000..6ade4c860 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt @@ -0,0 +1,68 @@ +.NAME + SPWeb + +.SYNOPSIS + +This resource will provision a SPWeb based on the settings that are passed through. +These settings map to the New-SPWeb cmdlet and accept the same values and types. + +.EXAMPLE + + SPWeb TeamSite + { + Url = "http://sharepoint.contoso.com/sites/site/subweb" + Name = "Team Sites" + Ensure = "Present" + Description = "A place to share documents with your team." + Template = "STS#0" + Language = 1033 + AddToTopNav = $true + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the web + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the web should exist or Absent if it should be removed + +.PARAMETER Description + Write - string + The description to apply to the web + +.PARAMETER Name + Write - string + The Name of the web + +.PARAMETER Language + Write - uint32 + The Lanhuage (LCID) of the web + +.PARAMETER Template + Write - string + The WebTemplate to use to create the web + +.PARAMETER UniquePermissions + Write - Boolean + True if the web should have unique permissions, otherwise false. + +.PARAMETER UseParentTopNav + Write - Boolean + True if the web should use the parent nav bar, otherwise false. + +.PARAMETER AddToQuickLaunch + Write - Boolean + True if the web should be in the quick launch of the parent web, otherwise false. + +.PARAMETER AddToTopNav + Write - Boolean + True if the web should be added to the top nav bar of the parent web, otherwise false. + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt new file mode 100644 index 000000000..09f92d3b4 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt @@ -0,0 +1,44 @@ +.NAME + SPWebAppBlockedFileTypes + +.SYNOPSIS + +This resource is responsible for controlling the blocked file type setting on a specific web application. +It has two modes of operation, the first is to use the "blocked" property, where you are able to define a specific list of file types that will be blocked. +In this mode when it is detected that the list does not match the local farm, it is set to match this list exactly. +The second mode is to use the "EnsureBlocked" and "EnsureAllowed" properties. +EnsureBlocked will check to make sure that the specified file types are on the list, and if not they will be added. +EnsureAllowed checks to make sure that a file type is not on the list, and if it is it will be removed. +Both of these properties will only make changes to the file types in their list and will leave the full list as it is otherwise, whereas the blocked property resets the list in full. + +.EXAMPLE + + SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes + { + Url = "Shttp://exmaple.contoso.local" + EnsureBlocked = @("exe", "dll", "msi") + EnsureAllowed = @("pdf", "docx", "xlsx") + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the web application to set blocked file types for + +.PARAMETER Blocked + write - string + This is a fixed list to use for blocked file types in this web app + +.PARAMETER EnsureBlocked + write - string + This list of file types that will always be added to the list for this web app. Types not in this list will be left in the list + +.PARAMETER EnsureAllowed + write - string + This list of file types that will always be removedfrom the list for this web app. Types not in this list will be left in the list + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt new file mode 100644 index 000000000..d77d8ba03 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt @@ -0,0 +1,106 @@ +.NAME + SPWebAppGeneralSettings + +.SYNOPSIS + +This resource is responsible for setting web application settings that are found under the "general settings" screen in central admin. +The web application is specified through the URL property, and then any combination of settings can be applied. +Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). + +.EXAMPLE + + SPWebAppGeneralSettings PrimaryWebAppGeneralSettings + { + Url = "Shttp://exmaple.contoso.local" + TimeZone = 76 + Alerts = $true + RSS = $false + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the web app to set the general settings for + +.PARAMETER TimeZone + Write - uint32 + The timezone code to use for this web app. A full list is at https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spregionalsettings.timezones.aspx + +.PARAMETER Alerts + Write - boolean + Should alerts be enabled for this web app + +.PARAMETER AlertsLimit + Write - uint32 + What is the maximum number of alerts that a user can create in this web app + +.PARAMETER RSS + Write - boolean + Should RSS feeds be enabled in this web app + +.PARAMETER BlogAPI + Write - boolean + Should the Blog API be enabled in this web app + +.PARAMETER BlogAPIAuthenticated + Write - boolean + Is authentication required for the blog API + +.PARAMETER BrowserFileHandling + Write - String + Allowed values: Strict, Permissive + What file handling mode should be used in this web app - strict or permissive + +.PARAMETER SecurityValidation + Write - boolean + Is security validation enforced in this web app + +.PARAMETER SecurityValidationExpires + Write - boolean + Does security validation expire after a set time + +.PARAMETER SecurityValidationTimeOutMinutes + Write - uint32 + Number of minutes security validation will expire if securityvalidationexpires is set + +.PARAMETER RecycleBinEnabled + Write - boolean + Is the recycle bin enabled in this web application + +.PARAMETER RecycleBinCleanupEnabled + Write - boolean + Is automatic cleanup of the recycle bin enabled in this web app + +.PARAMETER RecycleBinRetentionPeriod + Write - uint32 + How many days does the recycle bin keep content for + +.PARAMETER SecondStageRecycleBinQuota + Write - uint32 + How much content does the second stage recycle bin keep content for + +.PARAMETER MaximumUploadSize + Write - uint32 + What is the maximum file upload size for this web app (in MB) + +.PARAMETER CustomerExperienceProgram + Write - boolean + Should the customer experience program be enabled in this web app + +.PARAMETER AllowOnlineWebPartCatalog + Write - boolean + Should the Online WebPart Gallery be enabled for this web app + +.PARAMETER SelfServiceSiteCreationEnabled + Write - boolean + Should Self Service Site Creation be enabled + +.PARAMETER PresenceEnabled + Write - boolean + Is Skype for Business presence enabled for this web app + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt new file mode 100644 index 000000000..bf600590a --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt @@ -0,0 +1,56 @@ +.NAME + SPWebAppPermissions + +.SYNOPSIS + +This resource is responsible for managing the user permissions for a web application. +You can either specify to set all permissions or specify individual permissions per category. + +More info about the permission levels: https://technet.microsoft.com/en-us/library/cc721640.aspx + +.EXAMPLE + + SPWebAppPermissions WebApplicationPermissions + { + WebAppUrl = "https://intranet.sharepoint.contoso.com" + ListPermissions = "Manage Lists","Override List Behaviors","Add Items","Edit Items","Delete Items","View Items","Approve Items","Open Items","View Versions","Delete Versions","Create Alerts","View Application Pages" + SitePermissions = "Manage Permissions","View Web Analytics Data","Create Subsites","Manage Web Site","Add and Customize Pages","Apply Themes and Borders","Apply Style Sheets","Create Groups","Browse Directories","Use Self-Service Site Creation","View Pages","Enumerate Permissions","Browse User Information","Manage Alerts","Use Remote Interfaces","Use Client Integration Features","Open","Edit Personal User Information" + PersonalPermissions = "Manage Personal Views","Add/Remove Personal Web Parts","Update Personal Web Parts" + PsDscRunAsAccount = $InstallAccount + } + + SPWebAppPermissions WebApplicationPermissions + { + Path = "https://portal.sharepoint.contoso.com" + AllPermissions = $true + PsDscRunAsAccount = $InstallAccount + } + +.PARAMETER WebAppUrl + Key - string + The url of the web application + +.PARAMETER ListPermissions + Write - string + Allowed values: Manage Lists, Override List Behaviors, Add Items, Edit Items, Delete Items, View Items, Approve Items, Open Items, View Versions, Delete Versions, Create Alerts, View Application Pages + List permissions that need to be configured + +.PARAMETER SitePermissions + Write - string + Allowed values: Manage Permissions, View Web Analytics Data, Create Subsites, Manage Web Site, Add and Customize Pages, Apply Themes and Borders, Apply Style Sheets, Create Groups, Browse Directories, Use Self-Service Site Creation, View Pages, Enumerate Permissions, Browse User Information, Manage Alerts, Use Remote Interfaces, Use Client Integration Features, Open, Edit Personal User Information + Site permissions that need to be configured + +.PARAMETER PersonalPermissions + Write - string + Allowed values: Manage Personal Views, Add/Remove Personal Web Parts, Update Personal Web Parts + Personal permissions that need to be configured + +.PARAMETER AllPermissions + Write - boolean + Set all permissions + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt new file mode 100644 index 000000000..6747b73fe --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt @@ -0,0 +1,83 @@ +.NAME + SPWebAppPolicy + +.SYNOPSIS + +This resource is used to set the User Policies for web applications. +The usernames can be either specified in Classic or Claims format, both will be accepted. +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. + +Requirements: +At least one of the Members, MemberToInclude or MembersToExclude properties needs to be specified. +Do not combine the Members property with the MemberToInclude and MembersToExclude properties. +Do not set the ActAsSystemAccount property to $true without setting the permission level to Full Control. + +.EXAMPLE + + SPWebAppPolicy WebAppPolicy + { + WebAppUrl = "http://sharepoint.contoso.com" + Members = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user1" + PermissionLevel = "Full Control" + ActAsSystemAccount = $true + }) + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\Group 1" + PermissionLevel = "Full Read" + IdentityType = "Claims" + }) + ) + PsDscRunAsCredential = $InstallAccount + } + + SPWebAppPolicy WebAppPolicy + { + WebAppUrl = "http://sharepoint.contoso.com" + MembersToInclude = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user1" + PermissionLevel = "Full Control" + }) + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user2" + PermissionLevel = "Full Read" + }) + ) + MembersToExclude = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user3" + }) + ) + SetCacheAccountsPolicy = $true + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER Members + Write - String + Exact list of accounts that will have to get Web Policy permissions + +.PARAMETER MembersToInclude + Write - String + List of all accounts that must be in the Web Policy group + +.PARAMETER MembersToExclude + Write - String + List of all accounts that are not allowed to have any Web Policy permissions + +.PARAMETER SetCacheAccountsPolicy + Write - Boolean + Include the Cache Accounts in the policy or not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt new file mode 100644 index 000000000..635b3af1e --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt @@ -0,0 +1,39 @@ +.NAME + SPWebAppProxyGroup + +.SYNOPSIS + +This resource is used to associate a web application to a service application proxy group. +Use the proxy group name "Default" to associate the web application to the default proxy group. +A web applicaiton can only connect to a single service application proxy group. This resource will overright the existing service application proxy group association. + +This resource is used in conjunction with the SPServiceAppProxyGroup resource, which creates the proxy groups and associates the desired service application proxies with it. Within your configuration, that resource should be a dependancy for the SPWebAppProxyGroup resource. + +.EXAMPLE + + SPWebAppProxyGroup ContosoWeb + { + WebAppUrl = "https://web.contoso.com" + ServiceAppProxyGroup = "Proxy Group 1" + } + + SPWebAppProxyGroup DefaultPortal + { + WebAppUrl = "https://portal.contoso.com" + ServiceAppProxyGroup = "Default" + } + + +.PARAMETER WebAppUrl + Key - String + URL of the web application + +.PARAMETER ServiceAppProxyGroup + Required - string + Name of the Service Applicaiton Proxy Group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt new file mode 100644 index 000000000..d47f8838e --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt @@ -0,0 +1,45 @@ +.NAME + SPWebAppSiteUseAndDeletion + +.SYNOPSIS + +This resource is responsible for controlling the Site Use and Deletion settings on a specific web application. +You can enable or disable the Site Use and Deletion feature, specify the amount of days after which the alerts are being send, if sites have to be deleted automatically and if so after how many days this has to be done. + +.EXAMPLE + + SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion + { + Url = "http://example.contoso.local" + SendUnusedSiteCollectionNotifications = $true + UnusedSiteNotificationPeriod = 90 + AutomaticallyDeleteUnusedSiteCollections = $true + UnusedSiteNotificationsBeforeDeletion = 24 + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the web application + +.PARAMETER SendUnusedSiteCollectionNotifications + Write - boolean + Should emails be sent to notify site owners of unused site collections + +.PARAMETER UnusedSiteNotificationPeriod + Write - uint32 + How many days should pass before a site is flagged as unused + +.PARAMETER AutomaticallyDeleteUnusedSiteCollections + Write - boolean + Should unused site collection be automatically deleted + +.PARAMETER UnusedSiteNotificationsBeforeDeletion + Write - uint32 + How many days before an unused site is deleted should an email be sent to the owner + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt new file mode 100644 index 000000000..ab11f5eed --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt @@ -0,0 +1,80 @@ +.NAME + SPWebAppThrottlingSettings + +.SYNOPSIS + +This resource is responsible for setting web application settings that are found under the "resource throttling" screen in central admin. +The web application is specified through the URL property, and then any combination of settings can be applied. +Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). +Happy hour is the setting used to control the window where threshold do not apply throughout the day. +You can specify the start time of this window as well as how many hours it will last. + +.EXAMPLE + + SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings + { + Url = "Shttp://exmaple.contoso.local" + ListViewThreshold = 5000 + AllowObjectModelOverride = $false + HappyHourEnabled = $true + HappyHour = MSFT_SPWebApplicationHappyHour { + Hour = 3 + Minute = 0 + Duration = 1 + } + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the web application + +.PARAMETER ListViewThreshold + Write - uint32 + What should the list view threshold for this site be set to + +.PARAMETER AllowObjectModelOverride + Write - boolean + Should object model code be able to be override the list view threshold + +.PARAMETER AdminThreshold + Write - uint32 + What is the list view threshold for site administrators + +.PARAMETER ListViewLookupThreshold + Write - uint32 + What is the maximum number of lookup fields in a single list view + +.PARAMETER HappyHourEnabled + Write - boolean + Should the happy hour window be enabled for this web app + +.PARAMETER HappyHour + Write - string + The time window for happy hour + +.PARAMETER UniquePermissionThreshold + Write - uint32 + What is the limit for unique permissions on a single object in this web app + +.PARAMETER RequestThrottling + Write - boolean + Is request throttling enabled on this web app + +.PARAMETER ChangeLogEnabled + Write - boolean + Is the change log enabled for this web app + +.PARAMETER ChangeLogExpiryDays + Write - uint32 + How many days does the change log store data for + +.PARAMETER EventHandlersEnabled + Write - boolean + Are event handlers enabled in the web application + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt new file mode 100644 index 000000000..d51ad8702 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt @@ -0,0 +1,40 @@ +.NAME + SPWebAppWorkflowSettings + +.SYNOPSIS + +This resource is responsible for setting web application settings that are found under the "workflow settings" screen in central admin. +The web application is specified through the URL property, and then any combination of settings can be applied. +Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). + +.EXAMPLE + + SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings + { + Url = "Shttp://exmaple.contoso.local" + ExternalWorkflowParticipantsEnabled = $false + EmailToNoPermissionWorkflowParticipantsEnable = $false + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Url + Key - string + The URL of the web application + +.PARAMETER ExternalWorkflowParticipantsEnabled + Write - boolean + Are external workflow participants enabled in the web app + +.PARAMETER UserDefinedWorkflowsEnabled + Write - boolean + Are user defined workflows enabled in this web app + +.PARAMETER EmailToNoPermissionWorkflowParticipantsEnable + Write - boolean + Are documents sent via email to external participants of workflow + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt new file mode 100644 index 000000000..b76cfe717 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt @@ -0,0 +1,84 @@ +.NAME + SPWebApplication + +.SYNOPSIS + +This resource is responsible for creating a web application within the local SharePoint farm. +The resource will provision the web application with all of the current settings, and then ensure that it stays part of the correct application pool beyond that (additional checking and setting of properties will be added in future releases). + +.EXAMPLE + + SPWebApplication HostNameSiteCollectionWebApp + { + Name = "SharePoint Sites" + ApplicationPool = "SharePoint Sites" + ApplicationPoolAccount = "CONTOSO\svcSPWebApp" + AllowAnonymous = $false + AuthenticationMethod = "NTLM" + DatabaseName = "SP_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + Url = "http://example.contoso.local" + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the web application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run this site in + +.PARAMETER ApplicationPoolAccount + Required - string + The name of the managed account to run the app pool with + +.PARAMETER Url + Required - string + The URL of the web application + +.PARAMETER AllowAnonymous + Write - boolean + Should anonymous access be enabled for this web app + +.PARAMETER AuthenticationMethod + Write - string + Allowed values: NTLM, Kerberos + What authentication mode should be used for the web app + +.PARAMETER DatabaseName + Write - string + The name of the first content database to be created with this web app + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the default content DB + +.PARAMETER HostHeader + Write - string + The host header to use for the web app + +.PARAMETER Path + Write - string + The path on the local servers to host the IIS web site from + +.PARAMETER Port + Write - string + The port to run the site on + +.PARAMETER UseSSL + Write - boolean + Should this web app use SSL + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the web app should exist, absent if it should not + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt new file mode 100644 index 000000000..bdd6daa9c --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt @@ -0,0 +1,49 @@ +.NAME + SPWebApplicationAppDomain + +.SYNOPSIS + +This resource will configure the App Domain at a specific zone for the given Web Application. +The configuration is done per zone on the specified web application, allowing for the setting of unique app domains for each extension of a web application. +The app prefix should still be set using the SPAppDomain resource before this is applied to customise a specific zone. + + +.EXAMPLE + + SPWebApplicationAppDomain Domain + { + AppDomain = "contosointranetapps.com" + WebApplication ="http://portal.contoso.com"; + Zone = "Default"; + Port = 80; + SSL = $false; + PsDscRunAsCredential = $InstallAccount + } + + +.PARAMETER WebApplication + Key - string + The URL of the web application to set the app domain for + +.PARAMETER Zone + Key - string + Allowed values: Default, Internet, Intranet, Extranet, Custom + The zone that this app domain applies to + +.PARAMETER AppDomain + Required - string + The domain for apps in this web app zone + +.PARAMETER Port + Write - string + The port to run apps on + +.PARAMETER SSL + Write - boolean + Should apps run under SSL + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt new file mode 100644 index 000000000..c94d9ada0 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt @@ -0,0 +1,127 @@ +.NAME + SPWordAutomationServiceApp + +.SYNOPSIS + +The resource is able to provision, unprovision and configure the Word Automation Service Application. +All settings that you can configure on the Service Application administration page are configurable using this resource. + +Important: +When you specify Ensure=Present, the Application Pool and DatabaseName parameters are required. +When you specify Ensure=Absent, no other parameters are allowed (with the exception of Name, InstallAccount or PsDscRunAsCredential). + +.EXAMPLE + +Make sure the service application exists and has a specific configuration + + SPWordAutomationServiceApp Word Automation + { + Name = "Word Automation Service Application" + Ensure = "Present" + ApplicationPool = "SharePoint Web Services" + DatabaseName = "WordAutomation_DB" + DatabaseServer = "SQLServer" + SupportedFileFormats = "docx", "doc", "mht", "rtf", "xml" + DisableEmbeddedFonts = $false + MaximumMemoryUsage = 100 + RecycleThreshold = 100 + DisableBinaryFileScan = $false + ConversionProcesses = 8 + JobConversionFrequency = 15 (in minutes) + NumberOfConversionsPerProcess = 12 + TimeBeforeConversionIsMonitored = 5 (in minutes) + MaximumConversionAttempts = 2 + MaximumSyncConversionRequests = 25 + KeepAliveTimeout = 30 (in seconds) + MaximumConversionTime = 300 (in seconds) + PsDscRunAsCredential = $InstallAccount + } + +Make sure the service application does not exist and remove when it does + + SPWordAutomationServiceApp Word Automation + { + Name = "Word Automation Service Application" + Ensure = "Absent" + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + THe name of the service application + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the app exists, absent to ensure that it does not + +.PARAMETER ApplicationPool + Write - string + The name of the application pool to run the service app in + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the server that will host the database + +.PARAMETER SupportedFileFormats + Write - string + Allowed values: docx, doc, mht, rtf, xml + The list of supported file types + +.PARAMETER DisableEmbeddedFonts + Write - boolean + Should embedded fonts be disabled + +.PARAMETER MaximumMemoryUsage + Write - uint32 + What is the maximum amount of memory the service app should use (in MB) + +.PARAMETER RecycleThreshold + Write - uint32 + What is the recycle threshold for this service app + +.PARAMETER DisableBinaryFileScan + Write - boolean + Should binary file scans be disabled + +.PARAMETER ConversionProcesses + Write - uint32 + How many conversion processes can be run at once + +.PARAMETER JobConversionFrequency + Write - uint32 + How frequently should new jobs be started from the queue (in minutes) + +.PARAMETER NumberOfConversionsPerProcess + Write - uint32 + How many document conversions should be included in a single process + +.PARAMETER TimeBeforeConversionIsMonitored + Write - uint32 + How long can a conversion be run before it becomes monitored + +.PARAMETER MaximumConversionAttempts + Write - uint32 + What is the maximum number of attempts to convert a document + +.PARAMETER MaximumSyncConversionRequests + Write - uint32 + What is the maximum number of sync conversion requests for the service app + +.PARAMETER KeepAliveTimeout + Write - uint32 + How long is the keep alive timeout set to for the service app + +.PARAMETER MaximumConversionTime + Write - uint32 + What is the maximum time in seconds for a document conversion to be allowed to run + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt new file mode 100644 index 000000000..83b77cad4 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt @@ -0,0 +1,67 @@ +.NAME + SPWorkManagementServiceApp + +.SYNOPSIS + +This resource is used to provision and manage an instance of the Work Management Services Service Application. +It will identify an instance of the work 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. + + +Remarks +- Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in Minutes + + + +.EXAMPLE + + SPWorkManagementServiceApp WorkManagementServiceApp + { + Name = "Work Management Service Application" + ApplicationPool = "SharePoint web services" + MinimumTimeBetweenEwsSyncSubscriptionSearches = 10 + PsDscRunAsCredential = $InstallAccount + } + +.PARAMETER Name + Key - string + The name of the work management service application + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the app exists, Absent to ensure it is removed + +.PARAMETER ApplicationPool + Write - String + The name of the application pool this will run in + +.PARAMETER MinimumTimeBetweenEwsSyncSubscriptionSearches + Write - uint32 + The minimum amount of time bween EWS sync subscription searches + +.PARAMETER MinimumTimeBetweenProviderRefreshes + Write - uint32 + The minimum time between provider refreshes + +.PARAMETER MinimumTimeBetweenSearchQueries + Write - uint32 + The minimum time between search queries + +.PARAMETER NumberOfSubscriptionSyncsPerEwsSyncRun + Write - uint32 + The number of subscription syncronisations per EWS sync run + +.PARAMETER NumberOfUsersEwsSyncWillProcessAtOnce + Write - uint32 + How many users will EWS calls include at once + +.PARAMETER NumberOfUsersPerEwsSyncBatch + Write - uint32 + How many users are included in a batch for EWS + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + From 869d9b6c6575864ba695d936bc73bf59307b7d2f Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Wed, 27 Jul 2016 13:12:36 +1000 Subject: [PATCH 02/18] Removed preview --- Modules/SharePointDsc/SharePointDsc.psd1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Modules/SharePointDsc/SharePointDsc.psd1 b/Modules/SharePointDsc/SharePointDsc.psd1 index f98b9b6ef..e1633bb9b 100644 --- a/Modules/SharePointDsc/SharePointDsc.psd1 +++ b/Modules/SharePointDsc/SharePointDsc.psd1 @@ -110,7 +110,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = @('DesiredStateConfiguration', 'DSC', 'DSCResourceKit', 'DSCResource', 'preview') + Tags = @('DesiredStateConfiguration', 'DSC', 'DSCResourceKit', 'DSCResource') # A URL to the license for this module. LicenseUri = 'https://github.com/PowerShell/SharePointDsc/blob/master/LICENSE' From b6ba5320b00357365fa87a2fdd36c614fdb1a7d0 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Thu, 22 Sep 2016 08:39:01 +1000 Subject: [PATCH 03/18] Updated documentation --- .../en-us/about_SPAccessServiceApp.help.txt | 79 ++++++-- .../en-us/about_SPAlternateUrl.help.txt | 74 ++++++-- .../en-us/about_SPAntivirusSettings.help.txt | 50 +++-- .../en-us/about_SPAppCatalog.help.txt | 45 +++-- .../en-us/about_SPAppDomain.help.txt | 47 +++-- .../about_SPAppManagementServiceApp.help.txt | 88 +++++++-- .../en-us/about_SPBCSServiceApp.help.txt | 84 +++++++-- .../en-us/about_SPBlobCacheSettings.help.txt | 78 +++++--- .../en-us/about_SPCacheAccounts.help.txt | 76 ++++++-- .../en-us/about_SPConfigWizard.help.txt | 77 ++++++++ .../en-us/about_SPContentDatabase.help.txt | 84 +++++++-- .../en-us/about_SPCreateFarm.help.txt | 174 ++++++++++++++---- .../en-us/about_SPDatabaseAAG.help.txt | 77 ++++++-- .../en-us/about_SPDesignerSettings.help.txt | 82 +++++---- ...about_SPDiagnosticLoggingSettings.help.txt | 81 ++++---- .../about_SPDistributedCacheService.help.txt | 149 ++++++++++++--- .../en-us/about_SPExcelServiceApp.help.txt | 74 ++++++-- .../en-us/about_SPFarmAdministrators.help.txt | 82 +++++++-- .../en-us/about_SPFarmSolution.help.txt | 64 ++++--- .../en-us/about_SPFeature.help.txt | 80 ++++++-- .../about_SPHealthAnalyzerRuleState.help.txt | 51 +++-- .../en-us/about_SPInstall.help.txt | 116 +++++++++--- .../about_SPInstallLanguagePack.help.txt | 85 +++++++++ .../en-us/about_SPInstallPrereqs.help.txt | 128 ++++++++----- .../en-us/about_SPIrmSettings.help.txt | 44 +++-- .../en-us/about_SPJoinFarm.help.txt | 88 +++++++-- .../en-us/about_SPManagedAccount.help.txt | 87 +++++++-- ...about_SPManagedMetaDataServiceApp.help.txt | 86 +++++++-- .../en-us/about_SPManagedPath.help.txt | 110 +++++++++-- ...about_SPOfficeOnlineServerBinding.help.txt | 83 +++++++-- .../about_SPOutgoingEmailSettings.help.txt | 84 +++++++-- .../about_SPPasswordChangeSettings.help.txt | 53 ++++-- ...bout_SPPerformancePointServiceApp.help.txt | 75 ++++++-- .../en-us/about_SPProductUpdate.help.txt | 122 ++++++++++++ ...about_SPPublishServiceApplication.help.txt | 83 +++++++++ .../en-us/about_SPQuotaTemplate.help.txt | 52 ++++-- .../en-us/about_SPRemoteFarmTrust.help.txt | 48 +++-- .../about_SPSearchContentSource.help.txt | 148 +++++++++------ .../en-us/about_SPSearchCrawlRule.help.txt | 93 +++++++--- .../about_SPSearchIndexPartition.help.txt | 70 ++++--- .../en-us/about_SPSearchResultSource.help.txt | 54 ++++-- .../en-us/about_SPSearchServiceApp.help.txt | 84 +++++++-- .../en-us/about_SPSearchTopology.help.txt | 78 +++++--- .../about_SPSecureStoreServiceApp.help.txt | 86 +++++++-- .../en-us/about_SPServiceAppPool.help.txt | 48 +++-- .../about_SPServiceAppProxyGroup.help.txt | 83 +++++---- .../en-us/about_SPServiceAppSecurity.help.txt | 81 +++++--- .../en-us/about_SPServiceInstance.help.txt | 79 +++++--- .../about_SPSessionStateService.help.txt | 49 +++-- .../en-us/about_SPShellAdmins.help.txt | 131 ++++++++----- .../SharePointDsc/en-us/about_SPSite.help.txt | 58 ++++-- .../en-us/about_SPStateServiceApp.help.txt | 48 +++-- ..._SPSubscriptionSettingsServiceApp.help.txt | 84 +++++++-- .../en-us/about_SPTimerJobState.help.txt | 76 +++++--- ...bout_SPTrustedIdentityTokenIssuer.help.txt | 112 +++++++++++ .../en-us/about_SPUsageApplication.help.txt | 54 ++++-- .../about_SPUserProfileProperty.help.txt | 104 ++++++----- .../en-us/about_SPUserProfileSection.help.txt | 64 +++++++ .../about_SPUserProfileServiceApp.help.txt | 78 +++++--- ...PUserProfileServiceAppPermissions.help.txt | 53 ++++-- ...about_SPUserProfileSyncConnection.help.txt | 66 ++++--- .../about_SPUserProfileSyncService.help.txt | 63 +++++-- .../en-us/about_SPVisioServiceApp.help.txt | 72 ++++++-- .../SharePointDsc/en-us/about_SPWeb.help.txt | 55 ++++-- .../about_SPWebAppBlockedFileTypes.help.txt | 88 ++++++--- .../about_SPWebAppGeneralSettings.help.txt | 54 ++++-- .../en-us/about_SPWebAppPermissions.help.txt | 85 ++++++--- .../en-us/about_SPWebAppPolicy.help.txt | 151 +++++++++------ .../en-us/about_SPWebAppProxyGroup.help.txt | 60 +++--- .../about_SPWebAppSiteUseAndDeletion.help.txt | 53 ++++-- .../about_SPWebAppThrottlingSettings.help.txt | 67 ++++--- .../about_SPWebAppWorkflowSettings.help.txt | 51 +++-- .../en-us/about_SPWebApplication.help.txt | 63 ++++--- .../about_SPWebApplicationAppDomain.help.txt | 57 +++--- .../about_SPWordAutomationServiceApp.help.txt | 122 +++++++----- .../about_SPWorkManagementServiceApp.help.txt | 66 ++++--- 76 files changed, 4401 insertions(+), 1627 deletions(-) create mode 100644 Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt create mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt diff --git a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt index a2b3040f7..05cb6156a 100644 --- a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt @@ -1,22 +1,12 @@ .NAME SPAccessServiceApp -.SYNOPSIS - -This resource is responsible for creating Access Services Application instances within the local SharePoint farm. -The resource will provision and configure the Access Services Service Application. - -.EXAMPLE - - SPAccessServiceApp AccessServices - { - Name = "Access Services Service Application" - ApplicationPool = "SharePoint Web Services" - DatabaseServer = "sql.contoso.local" - InstallAccount = $InstallAccount - } - - +.DESCRIPTION + + This resource is responsible for creating Access Services Application instances within the local + SharePoint farm. The resource will provision and configure the Access Services Service + Application. + .PARAMETER Name Key - string The name of the service application @@ -36,6 +26,61 @@ The resource will provision and configure the Access Services Service Applicatio .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy Access Services 2013 to the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAccessServiceApp AccessServices + { + Name = "Access Services Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + + This example shows how to remove a specific Access Services 2013 from the local + SharePoint farm. Because Application pool and database server are both required + parameters, but are not acutally needed to remove the app, any text value can + be supplied for these as they will be ignored. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAccessServiceApp AccessServices + { + Name = "Access Services Service Application" + ApplicationPool = "n/a" + DatabaseServer = "n/a" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt index e6f03d83c..38241556d 100644 --- a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt @@ -1,21 +1,12 @@ .NAME SPAlternateUrl -.SYNOPSIS - -This resource is used to define an alternate access mapping URL for a specified web application. - - -.EXAMPLE - - SPAlternateUrl CentralAdminAAM - { - WebAppUrl = "http://sharepoint1:9999" - Zone = "Intranet" - Url = "https://admin.sharepoint.contoso.com" - PsDscRunAsCredential = $SPSetupAccount - } - +.DESCRIPTION + + This resource is used to define an alternate access mapping URL for a specified web application. + These can be assigned to specific zones for each web application. Alternatively a URL can be + removed from a zone to ensure that it will remain empty and have no alternate URL. + .PARAMETER WebAppUrl Key - String The URL of the web application to apply the alternate URL to @@ -36,6 +27,57 @@ This resource is used to define an alternate access mapping URL for a specified .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to add a new alternate URL to a specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAlternateUrl CentralAdminAAM + { + WebAppUrl = "http://sharepoint1:9999" + Zone = "Intranet" + Url = "https://admin.sharepoint.contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove an alternate URL from a specified zone for a specific + web application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAlternateUrl CentralAdminAAM + { + WebAppUrl = "http://sharepoint1:9999" + Zone = "Intranet" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt index 7564a50fd..12596784b 100644 --- a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt @@ -1,22 +1,13 @@ .NAME SPAntivirusSettings -.SYNOPSIS - -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 - - SPAntivirusSettings AVSettings - { - ScanOnDownload = $true - ScanOnUpload = $true - AllowDownloadInfected = $false - AttemptToClean = $false - } - +.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. + .PARAMETER ScanOnDownload Key - Boolean Should documents be scanned before being downloaded @@ -43,6 +34,31 @@ Note that this will not scan documents for viruses on it's own, an external tool .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply specific anti-virus configuration to the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAntivirusSettings AVSettings + { + ScanOnDownload = $true + ScanOnUpload = $true + AllowDownloadInfected = $false + AttemptToClean = $false + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt index 50642f165..576b5e336 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt @@ -1,26 +1,41 @@ .NAME SPAppCatalog -.SYNOPSIS - -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 - - SPAppCatalog MainAppCatalog - { - SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" - PsDscRunAsCredential = $SPSetupAccount - } - - +.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). + .PARAMETER SiteUrl Key - string The URL of the site collection that will be the app catalog for the web app that it is in .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply specific anti-virus configuration to the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppCatalog MainAppCatalog + { + SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt index b1e1d8c38..249705dcd 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt @@ -1,22 +1,11 @@ .NAME SPAppDomain -.SYNOPSIS - -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 - - SPAppDomain LocalFarmAppUrls - { - AppDomain = "contosointranetapps.com" - Prefix = "app" - PsDscRunAsCredential = $InstallAccount - } - - +.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. + .PARAMETER AppDomain Key - string The domain name for apps to use in this farm @@ -27,6 +16,30 @@ You can set the domain name and the prefix that is to be used for app URLs. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply app URLs to the current farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppDomain LocalFarmAppUrls + { + AppDomain = "contosointranetapps.com" + Prefix = "app" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt index 3046886e6..adc96454f 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt @@ -1,29 +1,23 @@ .NAME SPAppManagementServiceApp -.SYNOPSIS - -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 - - SPAppManagementServiceApp AppManagementServiceApp - { - Name = "App Management Service Application" - ApplicationPool = "SharePoint web services" - DatabaseServer = "SQL01.contoso.com" - DatabaseName = "SP_AppManagement" - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - } - +.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. + .PARAMETER Name Key - string The name of the app management service application +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER ApplicationPool Required - String The app pool that should be used to run the service app @@ -43,6 +37,60 @@ Database names or server name will not be changed if the configuration does not .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new app management service application in the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppManagementServiceApp AppManagementServiceApp + { + Name = "App Management Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_AppManagement" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove a specific app management service application in the + local SharePoint farm. The application pool property is still mandatory but it is not + used so therefore the value is not important. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppManagementServiceApp AppManagementServiceApp + { + Name = "App Management Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt index 892d20809..5ffa7d311 100644 --- a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt @@ -1,25 +1,15 @@ .NAME SPBCSServiceApp -.SYNOPSIS - -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 - - SPBCSServiceApp BCSServiceApp - { - Name = "BCS Service Application" - ApplicationPool = "SharePoint Service Applications" - DatabaseName = "SP_BCS" - DatabaseServer = $DatabaseServer - InstallAccount = $InstallAccount - Ensure = "Present" - } - +.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. + .PARAMETER Name Key - string The name of the BCS service app @@ -43,6 +33,60 @@ Database names or server name will not be changed if the configuration does not .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy a Business Connectivity Services application to the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPBCSServiceApp BCSServiceApp + { + Name = "BCS Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseName = "SP_BCS" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to deploy a Business Connectivity Services application to the + local SharePoint farm. The application pool account is mandatory but the value is + ignored when removing a service app, so the value entered here does not matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPBCSServiceApp BCSServiceApp + { + Name = "BCS Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt index ca37f7379..8a416d7e6 100644 --- a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt @@ -1,35 +1,24 @@ .NAME SPBlobCacheSettings -.SYNOPSIS - -This resource is used to configure the Blob Cache settings for a web application. - -Important: -This resource only configures the local server. -It changes the web.config file directly and is NOT using the SPWebConfigModifications class. -In order to configure all WFE servers in the farm, you have to apply this resource to all servers. - -Note: -- In order to prevent inconsistancy between different web front end servers, make sure you configure this setting on all servers equally. -- If the specified folder does not exist, the resource will create the folder. - -Best practice: -Specify a directory that is not on the same drive as where either the server operating system swap files or server log files are stored. - -.EXAMPLE - - SPBlobCacheSettings BlobCacheSettings - { - WebAppUrl = "http://intranet.contoso.com" - Zone = "Default" - EnableCache = $true - Location = "F:\BlobCache" - MaxSizeInGB = 10 - FileTypes = "\.(gif|jpg|png|css|js)$" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to configure the Blob Cache settings for a web application. + + Important: + This resource only configures the local server. It changes the web.config file directly + and is NOT using the SPWebConfigModifications class. In order to configure all WFE servers + in the farm, you have to apply this resource to all servers. + + Note: + - In order to prevent inconsistancy between different web front end servers, make sure you + configure this setting on all servers equally. + - If the specified folder does not exist, the resource will create the folder. + + Best practice: + Specify a directory that is not on the same drive as where either the server operating system + swap files or server log files are stored. + .PARAMETER WebAppUrl Key - string The URL of the web application @@ -61,6 +50,35 @@ Specify a directory that is not on the same drive as where either the server ope .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the blob cache settings on the local server for the + specified web application and zone + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPBlobCacheSettings BlobCacheSettings + { + WebAppUrl = "http://intranet.contoso.com" + Zone = "Default" + EnableCache = $true + Location = "F:\BlobCache" + MaxSizeInGB = 10 + FileTypes = "\.(gif|jpg|png|css|js)$" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt index d72823d23..407091fc6 100644 --- a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt @@ -1,20 +1,12 @@ .NAME SPCacheAccounts -.SYNOPSIS - -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 - - SPCacheAccounts SetCacheAccounts - { - WebAppUrl = "http://sharepoint.contoso.com" - SuperUserAlias = "DEMO\svcSPSuperUser" - SuperReaderAlias = "DEMO\svcSPReader" - PsDscRunAsCredential = $InstallAccount - } - +.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)). + .PARAMETER WebAppUrl Key - string The URL of the web application to set the accounts for @@ -33,6 +25,60 @@ This resource is used to set the "super user" and "super reader" cache accounts .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example sets the super use and reader accounts for the specified web app. It will + also set the appropriate web app policies by default for these accounts. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example sets the super use and reader accounts for the specified web app. It will + not set the web app policies for these accounts though, allowing them to be controlled + elsewhere (either manually or with SPWebAppPolicy) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + SetWebAppPolicy = $false + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt new file mode 100644 index 000000000..e5a65e2de --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt @@ -0,0 +1,77 @@ +.NAME + SPConfigWizard + +.DESCRIPTION + + This resource is used to perform the upgrade step of installing SharePoint updates, like Cumulative Updates, Service Packs and Language Packs. + The DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in which the update can be installed. + This module has to be used to complete the update installation step, performed by SPProductUpdate. + +.PARAMETER Ensure + Key - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + +.PARAMETER DatabaseUpgradeDays + Write - String + Allowed values: mon, tue, wed, thu, fri, sat, sun + Specify on which dates running the Configuration Wizard is allowed + +.PARAMETER DatabaseUpgradeTime + Write - String + Specify in which time frame running the Configuration Wizard is allowed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example runs the Configuration Wizard as soon as it is applied. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPConfigWizard RunConfigWizard + { + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example only runs the Configuration Wizard in the specified window: + - Saturday and Sunday night between 3am and 5am. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPConfigWizard RunConfigWizard + { + Ensure = "Present" + DatabaseUpgradeDays = "sat", "sun" + DatabaseUpgradeTime = "3:00am to 5:00am" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt index 55293baf1..9494478cd 100644 --- a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt @@ -1,25 +1,13 @@ .NAME SPContentDatabase -.SYNOPSIS - -This resource is used to add and remove Content Databases to web applications and and configure these databases. -Note: The resource cannot be used to move the database to a different SQL instance. -It will throw an error when it detects that the specified SQL instance is a different instance that is currently in use. - -.EXAMPLE - - SPContentDatabase ContentDB { - Name = "SharePoint_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - WebAppUrl = "http://sharepoint.contoso.com" - Enabled = $true - WarningSiteCount = 2000 - MaximumSiteCount = 5000 - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to add and remove Content Databases to web applications and configure + these databases. Note: The resource cannot be used to move the database to a different + SQL instance. It will throw an error when it detects that the specified SQL instance is a + different instance that is currently in use. + .PARAMETER Name Key - String Specifies the name of the content database @@ -51,6 +39,62 @@ It will throw an error when it detects that the specified SQL instance is a diff .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new content database for the specified web application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPContentDatabase ContentDB + { + Name = "SharePoint_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + WebAppUrl = "http://sharepoint.contoso.com" + Enabled = $true + WarningSiteCount = 2000 + MaximumSiteCount = 5000 + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example dismounts a content database from the specified web application. This + will not remove the database from SQL server however, only taking it out of the + web applications configuration. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPContentDatabase ContentDB + { + Name = "SharePoint_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + WebAppUrl = "http://sharepoint.contoso.com" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt index 651eeaf50..55d41388a 100644 --- a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt @@ -1,36 +1,28 @@ .NAME SPCreateFarm -.SYNOPSIS - -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 [SPJoinFarm](SPJoinFarm). -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 passphrase is passed as a Credential object. The username of this credential is ignored, only the value of the password is used as the farm passphrase. - -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 [SPDistributedCacheService](SPDistributedCacheService) on at least one server in the farm to designate it as a cache server. - -CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not specified, it defaults to NTLM. If using Kerberos, make sure to have appropriate SPNs setup for Farm account and Central Administration URI. - -.EXAMPLE - - SPCreateFarm CreateSPFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - Passphrase = $FarmPassPhrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - AdminContentDatabaseName = "SP_AdminContent" - CentralAdministrationPort = 2000 - CentralAdministrationAuth = "Kerberos" - ServerRole = Custom - } - +.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 SPJoinFarm. 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 passphrase is passed as a Credential object.The username of this credential is ignored, only + the value of the password is used as the farm passphrase. + + 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 SPDistributedCacheService on at + least one server in the farm to designate it as a cache server. + + CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not specified, it defaults + to NTLM. If using Kerberos, make sure to have appropriate SPNs setup for Farm account and Central + Administration URI. + .PARAMETER FarmConfigDatabaseName Key - String Name of the configuration database @@ -67,6 +59,126 @@ CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not speci .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCreateFarm CreateFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. Here the port for the central admin site to + run on, as well as the authentication mode for the site are also specified. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCreateFarm CreateFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + CentralAdministrationPort = 5000 + CentralAdministrationAuth = "Kerberos" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. In this example we also see + the server role defined as "Application" which tells SharePoint 2016 the role to apply to + this server as soon as the farm is created. This property is not supported for SharePoint 2013 + and so this specific example would fail if used against that verison. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCreateFarm CreateFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + ServerRole = "Application" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt index 793f86259..3e6224eff 100644 --- a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt @@ -1,24 +1,12 @@ .NAME SPDatabaseAAG -.SYNOPSIS - -This resource will allow specifying which SQL Server AlwaysOn Availability group a resource should be in. -This resource does not configure the Availability Groups on SQL Server, they must already exist. -It simply adds the specified database to the group. - - -.EXAMPLE - - SPDatabaseAAG ConfigDBAAG - { - DatabaseName = "SP_Config" - AGName = "MyAvailabilityGroup" - FileShare = "\\SQL\Backups" - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - }s - +.DESCRIPTION + + This resource will allow specifying which SQL Server AlwaysOn Availability group a + resource should be in. This resource does not configure the Availability Groups on + SQL Server, they must already exist. It simply adds the specified database to the group. + .PARAMETER DatabaseName Key - string The name of the database to put in the AlwaysOn group @@ -38,6 +26,57 @@ It simply adds the specified database to the group. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example takes an existing SharePoint database and puts it in to the specified + AlwaysOn Availability Group (AAG). + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "SP_Config" + AGName = "MyAvailabilityGroup" + FileShare = "\\SQL\Backups" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a database from the specified AlwaysOn Availability Group (AAG) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "SP_Config" + AGName = "MyAvailabilityGroup" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt index fee03f6b3..85679ed9a 100644 --- a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt @@ -1,36 +1,24 @@ .NAME SPDesignerSettings -.SYNOPSIS - -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 - - SPDesignerSettings 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 - } - +.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. + .PARAMETER Url Key - string The URL of the web application or site collection to configure @@ -70,6 +58,38 @@ Consider implementing PowerShell v5 and switching to the PsDscRunAsCredential co .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies settings to disable SharePoint Designer access to the + specified web application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDesignerSettings MainWebAppSPDSettings + { + Url = "https://intranet.sharepoint.contoso.com" + SettingsScope = "WebApplication" + AllowSharePointDesigner = $false + AllowDetachPagesFromDefinition = $false + AllowCustomiseMasterPage = $false + AllowManageSiteURLStructure = $false + AllowCreateDeclarativeWorkflow = $false + AllowSavePublishDeclarativeWorkflow = $false + AllowSaveDeclarativeWorkflowAsTemplate = $false + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt index 61b39ab56..c664698f4 100644 --- a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt @@ -1,36 +1,13 @@ .NAME SPDiagnosticLoggingSettings -.SYNOPSIS - -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 - - SPDiagnosticLoggingSettings 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 - } - +.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. + .PARAMETER LogPath Key - string The physical path on each server to store ULS logs @@ -105,6 +82,48 @@ These settings are applied to the diagnostic logging service for the farm and do .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies the specified diagnostic logging settings to the local + SharPoint farm. Any setting not defined will be left as it default, or to + whatever value has been manually configured outside of DSC. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDiagnosticLoggingSettings ApplyDiagnosticLogSettings + { + PsDscRunAsCredential = $SetupAccount + 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 + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt index 2185448ef..53f0d3a37 100644 --- a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt @@ -1,32 +1,26 @@ .NAME SPDistributedCacheService -.SYNOPSIS - -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 [SPCreateFarm](SPCreateFarm) and [SPJoinFarm](SPJoinFarm) 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. - -The ServerProvisionOrder optional property is used when a pull server is handing out configurations to nodes in order to tell this resource about a specific order of enabling the caches. -This allows for multiple servers to receive the same configuration, but they will always check for the server before them in the list first to ensure that it is running distributed cache. -By doing this you can ensure that you do not create conflicts with two or more servers provisioning a cache at the same time. -Note, this approach only makes a server check the others for distributed cache, it does not provision the cache automatically on all servers. -If a previous server in the sequence does not appear to be running distributed cache after 30 minutes, the local server that was waiting will begin anyway. - -.EXAMPLE - - SPDistributedCacheService EnableDistributedCache - { - Name = "AppFabricCachingService" - Ensure = "Present" - CacheSizeInMB = 8192 - ServiceAccount = "DEMO\ServiceAccount" - InstallAccount = $InstallAccount - ServerProvisionOrder = @("server1", "server2") - CreateFirewallRules = $true - } - +.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 + SPCreateFarm and SPJoinFarm 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. + + The ServerProvisionOrder optional property is used when a pull server is handing out + configurations to nodes in order to tell this resource about a specific order of enabling + the caches. This allows for multiple servers to receive the same configuration, but they + will always check for the server before them in the list first to ensure that it is running + distributed cache. By doing this you can ensure that you do not create conflicts with two + or more servers provisioning a cache at the same time. Note, this approach only makes a + server check the others for distributed cache, it does not provision the cache automatically + on all servers. If a previous server in the sequence does not appear to be running + distributed cache after 30 minutes, the local server that was waiting will begin anyway. + .PARAMETER Name Key - String A name to assign to this resource - not really used. For example - AppFabricCachingService @@ -54,6 +48,107 @@ If a previous server in the sequence does not appear to be running distributed c .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies the distributed cache service to the current server, + also setting the rules in Windows firewall to allow communication with + other cache hosts. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + InstallAccount = $SetupAccount + CreateFirewallRules = $true + } + } + } + + +.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 + hosts to the Windows Firewall. Use this approach if you have an alternate + firewall solution. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + InstallAccount = $SetupAccount + CreateFirewallRules = $false + } + } + } + + +.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 + create the cache at the same time, resuling in errors. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node "Server1" + { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + ServerProvisionOrder = @("Server1","Server2") + CreateFirewallRules = $true + InstallAccount = $SetupAccount + } + } + + node "Server2" + { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + ServerProvisionOrder = @("Server1","Server2") + CreateFirewallRules = $true + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt index f5552c1ab..c68fb3d8f 100644 --- a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt @@ -1,21 +1,12 @@ .NAME SPExcelServiceApp -.SYNOPSIS - -This resource is responsible for creating Excel Services Application instances within the local SharePoint farm. -The resource will provision and configure the Excel Services Service Application. - -.EXAMPLE - - SPExcelServiceApp ExcelServices - { - Name = "Excel Services Service Application" - ApplicationPool = "SharePoint Web Services" - InstallAccount = $InstallAccount - } - - +.DESCRIPTION + + This resource is responsible for creating Excel Services Application instances + within the local SharePoint farm. The resource will provision and configure the + Excel Services Service Application. + .PARAMETER Name Key - string The name of the service application @@ -31,6 +22,57 @@ The resource will provision and configure the Excel Services Service Application .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy Excel Services to the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPExcelServiceApp ExcelServices + { + Name = "Excel Services Service Application" + ApplicationPool = "SharePoint Service Applications" + InstallAccount = $SetupAccount + } + } + } + + +.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. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPExcelServiceApp ExcelServices + { + Name = "Excel Services Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt index 3afdc0892..63a364585 100644 --- a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt @@ -1,21 +1,18 @@ .NAME SPFarmAdministrators -.SYNOPSIS - -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 - - SPFarmAdministrators LocalFarmAdmins - { - Name = "Farm Administrators" - Members = @("CONTOSO\user1", "CONTOSO\user2") - } - +.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. + .PARAMETER Name Key - String A generic name for this resource, its value is not important @@ -34,6 +31,59 @@ The "MembersToInclude" and "MembersToExclude" properties will allow you to contr .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to set a specific list of members for the farm admins group. + Any members not in this list will be removed. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarmAdministrators LocalFarmAdmins + { + Name = "Farm Administrators" + Members = @("CONTOSO\user1", "CONTOSO\user2") + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how certain changes are made to the farm admins groups. Here any + members in the MembersToInclude property are added, and members in the MembersToExclude + property are removed. Any members that exist in the farm admins group that aren't listed + in either of these properties are left alone. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarmAdministrators LocalFarmAdmins + { + Name = "Farm Administrators" + MembersToInclude = @("CONTOSO\user1") + MembersToExclude = @("CONTOSO\user2") + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt index eaad1a40f..e12343f14 100644 --- a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt @@ -1,32 +1,15 @@ .NAME SPFarmSolution - -.SYNOPSIS - -This resource is used to make sure that a specific farm solution is either present or absent in a farm. -The Ensure property will dictate if the solution should be present or absent. -The name property is the name of the solution including the wsp extension (i.e. MySolution.wsp). -The LiteralPath is required and points to the solution in the files system that is used to upload it if it does not exist. -The Version will be stored in the property bag to determine later if the correct version is installed. -I the version in the farm does not match the desired version an upgrade of the solution will be performed. - -The solution can be deployed to one or more web application passing an array of URL's to the WebApplications property. -If the solution contains resources scoped for web applications and no WebApplications are specified, the solution will be deployed to all web applications. -If the solution does not contain resources scoped for web applications the property is ignored and the solution is deployed globally. - -.EXAMPLE - - SPFarmSolution SampleWsp - { - Name = "MySolution.wsp" - LiteralPath = "C:\src\MySolution.wsp" - Ensure = "Present" - Version = "1.0.0" - WebApplications = @("http://collaboration", "http://mysites") - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to make sure that a specific farm solution is either present or + absent in a farm. The solution can be deployed to one or more web application passing + an array of URL's to the WebApplications property. If the solution contains resources + scoped for web applications and no WebApplications are specified, the solution will be + deployed to all web applications. If the solution does not contain resources scoped for + web applications the property is ignored and the solution is deployed globally. + .PARAMETER Name Key - string The filename of the WSP package @@ -59,6 +42,33 @@ If the solution does not contain resources scoped for web applications the prope .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy a WSP to specific web applications. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarmSolution SampleWsp + { + Name = "MySolution.wsp" + LiteralPath = "C:\src\MySolution.wsp" + Ensure = "Present" + Version = "1.0.0" + WebApplications = @("http://collaboration", "http://mysites") + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt index 6e106bdef..84849413b 100644 --- a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt @@ -1,24 +1,13 @@ .NAME SPFeature -.SYNOPSIS - -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 - - SPFeature EnableViewFormsLockDown - { - Name = "ViewFormPagesLockDown" - Url = "http://www.contoso.com" - Ensure = "Present" - Scope = "Site" - PsDscRunAsCredential = $SetupAccuount - Version = "1.0.0.0" - } - +.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. + .PARAMETER Name Key - string The name of the feature @@ -43,6 +32,59 @@ The name property is the name of the feature based on its folder name in the FEA .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to enable a site collection scoped feature + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFeature EnableViewFormsLockDown + { + Name = "ViewFormPagesLockDown" + Url = "http://www.contoso.com" + FeatureScope = "Site" + PsDscRunAsCredential = $SetupAccount + Version = "1.0.0.0" + } + } + } + + +.EXAMPLE + This example shows how to disable a site collection scoped feature + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFeature EnableViewFormsLockDown + { + Name = "ViewFormPagesLockDown" + Url = "http://www.contoso.com" + FeatureScope = "Site" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + Version = "1.0.0.0" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt index 9cb7df5ac..8203345e4 100644 --- a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt @@ -1,23 +1,11 @@ .NAME SPHealthAnalyzerRuleState -.SYNOPSIS - -This resource is used to configure Health Analyzer rules for the local farm. -The resource is able to enable/disable and configure the specified rule. - -.EXAMPLE - - SPHealthAnalyzerRuleState DisableDiskSpaceRule - { - Name = "Drives are at risk of running out of free space." - Enabled = $true - RuleScope = "All Servers" - Schedule = "Daily" - FixAutomatically = $false - InstallAccount = $InstallAccount - } - +.DESCRIPTION + + This resource is used to configure Health Analyzer rules for the local farm. The + resource is able to enable/disable and configure the specified rule. + .PARAMETER Name Key - String The name of the rule exactly as it appears in central admin @@ -42,6 +30,33 @@ The resource is able to enable/disable and configure the specified rule. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to disable a health analyzer rule + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPHealthAnalyzerRuleState DisableDiskSpaceRule + { + Name = "Drives are at risk of running out of free space." + Enabled = $false + RuleScope = "All Servers" + Schedule = "Daily" + FixAutomatically = $false + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt index bf627e178..9c9656f0d 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt @@ -1,36 +1,14 @@ .NAME SPInstall -.SYNOPSIS - -This resource is used to install the SharePoint binaries. -The BinaryDir parameter should point to the path that setup.exe is located (not to setup.exe itself). -The ProductKey parameter is used to inject in to the configuration file and validate the license key during the installation process. -This module depends on the prerequisites already being installed, which can be done through the use of [SPInstallPreReqs](SPInstallPreReqs). - -.EXAMPLE - - SPInstall InstallBinaries - { - BinaryDir = "C:\SPInstall" - ProductKey = $ProductKey - } - -**Installing SharePoint Foundation 2013** - -SharePoint Foundation 2013 is not supported by SPInstall (see [Issue #81](https://github.com/PowerShell/xSharePoint/issues/81) for the details). -A workaround for this is to use the package resource as demonstrated below. - - Package InstallSharePointFoundation - { - Ensure = "Present" - Name = "Microsoft SharePoint Foundation 2013 Core" - Path = "E:\SharePoint2013\Setup.exe" - Arguments = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml" - ProductID = "90150000-1014-0000-1000-0000000FF1CE" - ReturnCode = 0 - } - +.DESCRIPTION + + This resource is used to install the SharePoint binaries. The BinaryDir parameter should + point to the path that setup.exe is located (not to setup.exe itself). The ProductKey + parameter is used to inject in to the configuration file and validate the license key + during the installation process. This module depends on the prerequisites already being + installed, which can be done through the use of SPInstallPreReqs. + .PARAMETER BinaryDir Key - String The directory that contains all of the SharePoint binaries @@ -53,3 +31,81 @@ A workaround for this is to use the package resource as demonstrated below. Present to install SharePoint. Absent is currently not supported +.EXAMPLE + This module will install SharePoint to the default locations. The binaries for + SharePoint in this scenario are stored at C:\SPInstall (so it will look to run + C:\SPInstall\Setup.exe) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstall InstallBinaries + { + BinaryDir = "C:\SPInstall" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + } + } + } + + +.EXAMPLE + This module will install SharePoint to the specific locations set for the + InstallPath and DataPath directories. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstall InstallBinaries + { + BinaryDir = "D:\SharePoint\Binaries" + InstallPath = "D:\SharePoint\Install" + DataPath = "D:\SharePoint\Data" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + } + } + } + + +.EXAMPLE + This module will install SharePoint Foundation 2013 to the local server + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName PSDesiredStateConfiguration + + node localhost { + Package InstallSharePointFoundation + { + Ensure = "Present" + Name = "Microsoft SharePoint Foundation 2013 Core" + Path = "E:\SharePoint2013\Setup.exe" + Arguments = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml" + ProductID = "90150000-1014-0000-1000-0000000FF1CE" + ReturnCode = 0 + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt new file mode 100644 index 000000000..925c9fb16 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt @@ -0,0 +1,85 @@ +.NAME + SPInstallLanguagePack + +.DESCRIPTION + + This resource is used to install the SharePoint Language Pack binaries. The BinaryDir parameter should + point to the path that setup.exe is located (not to setup.exe itself). + The BinaryInstallDays and BinaryInstallTime parameters specify a window in which the update can be installed. + This module depends on SharePoint already being installed, which can be done through the use of SPInstall. + +.PARAMETER BinaryDir + Key - String + The directory that contains all of the SharePoint binaries + +.PARAMETER BinaryInstallDays + Write - String + Allowed values: mon, tue, wed, thu, fri, sat, sun + Specify on which dates the installation is allowed + +.PARAMETER BinaryInstallTime + Write - String + Specify in which time frame the installation is allowed + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This module will install the SharePoint Language Pack. The binaries for + SharePoint in this scenario are stored at C:\SPInstall (so it will look to run + C:\SPInstall\Setup.exe) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstallLanguagePack InstallLPBinaries + { + BinaryDir = "C:\SPInstall" + Ensure = "Present" + } + } + } + + +.EXAMPLE + This module will install the SharePoint Language Pack in the specified timeframe. + The binaries for SharePoint in this scenario are stored at C:\SPInstall (so it + will look to run C:\SPInstall\Setup.exe) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstallLanguagePack InstallLPBinaries + { + BinaryDir = "C:\SPInstall" + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt index 97b89e980..909718ba8 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt @@ -1,52 +1,28 @@ .NAME SPInstallPrereqs -.SYNOPSIS - -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 - } - -**Examples** - -Online example: - - SPInstallPrereqs InstallPrerequisites - { - InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" - OnlineMode = $true - } - -Offline example: - - SPInstallPrereqs InstallPrerequisites - { - 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" - } - +.DESCRIPTION + + 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 + } + .PARAMETER InstallerPath Key - String The full path to prerequisiteinstaller.exe @@ -129,3 +105,63 @@ Offline example: Present to install the prerequisites. Absent is currently not supported +.EXAMPLE + 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 InstallPrerequisites + { + InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" + OnlineMode = $true + } + } + } + + +.EXAMPLE + 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 InstallPrerequisites + { + 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" + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt index 337e2cb9d..0be9f0de5 100644 --- a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt @@ -1,19 +1,10 @@ .NAME SPIrmSettings -.SYNOPSIS - -This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS - -.EXAMPLE - - SPIrmSettings ContosoRMS - { - Ensure = "Present" - RMSserver = "https://rms.contoso.com" - } - - +.DESCRIPTION + + This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS + .PARAMETER Ensure Key - String Allowed values: Present, Absent @@ -29,6 +20,31 @@ This resource is used to manipulate the IRM settings in SharePoint, integrating .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply the RMS settings to a local farm, pointing to + a specific RMS server + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPIrmSettings RMSSettings + { + Ensure = "Present" + RMSserver = "https://rms.contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt index 15664b4de..f7599d35d 100644 --- a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt @@ -1,22 +1,16 @@ .NAME SPJoinFarm -.SYNOPSIS - -This resource will be responsible for joining a server to an existing SharePoint farm. -To create a new farm use the [SPCreateFarm](SPCreateFarm) resource on a different server to begin with, and then pass the same database server and configuration database name parameters to the additional servers using this resource. -After the server has joined the farm, the process will wait for 5 minutes to allow farm specific configuration to take place on the server, before allowing further DSC configuration to take place. - -.EXAMPLE - - SPJoinFarm JoinSPFarm - { - DatabaseServer = $DatabaseServer - FarmConfigDatabaseName = "SP_Config" - Passphrase = $FarmPassPhrase - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource will be responsible for joining a server to an existing SharePoint + farm. To create a new farm use the SPCreateFarm resource on a different server + to begin with, and then pass the same database server and configuration database + name parameters to the additional servers using this resource. After the server has + joined the farm, the process will wait for 5 minutes to allow farm specific + configuration to take place on the server, before allowing further DSC configuration + to take place. + .PARAMETER FarmConfigDatabaseName Key - string The name of the config database to connect to @@ -36,6 +30,66 @@ After the server has joined the farm, the process will wait for 5 minutes to all .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to join an existing SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPJoinFarm JoinFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + Passphrase = $Passphrase + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to join an existing SharePoint farm using a specific + server role (applies to SharePoint 2016 only). + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPJoinFarm JoinFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + ServerRole = "WebFrontEnd" + Passphrase = $Passphrase + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt index a76152999..63dfbf259 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt @@ -1,22 +1,15 @@ .NAME SPManagedAccount -.SYNOPSIS - -This resource will ensure a managed account is provisioned in to the SharePoint farm. -The Account object specific the credential to store (including username and password) to set as the managed account. -The settings for EmailNotification, PreExpireDays and Schedule all relate to enabling automatic password change for the managed account, leaving these option out of the resource will ensure that no automatic password changing from SharePoint occurs. - -.EXAMPLE - - SPManagedAccount WebPoolManagedAccount - { - AccountName = $WebPoolManagedAccount.UserName - Account = $WebPoolManagedAccount - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource will ensure a managed account is provisioned in to the SharePoint + farm. The Account object specific the credential to store (including username + and password) to set as the managed account. The settings for EmailNotification, + PreExpireDays and Schedule all relate to enabling automatic password change for + the managed account, leaving these option out of the resource will ensure that + no automatic password changing from SharePoint occurs. + .PARAMETER AccountName Key - string The username of the account @@ -44,6 +37,66 @@ The settings for EmailNotification, PreExpireDays and Schedule all relate to ena .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new managed account in a local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $ManagedAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedAccount NewManagedAccount + { + AccountName = $ManagedAccount.UserName + Account = $ManagedAccount + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to create a new managed account in a local farm, using + the automatic password change schedule + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $ManagedAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedAccount NewManagedAccount + { + AccountName = $ManagedAccount.UserName + Account = $ManagedAccount + Ensure = "Present" + Schedule = "monthly between 7 02:00:00 and 7 03:00:00" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt index 3a0499deb..eb0031cdd 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt @@ -1,27 +1,22 @@ .NAME SPManagedMetaDataServiceApp -.SYNOPSIS - -Creates a managed metadata service application. -The application pool property specifies which application pool it should use, and will reset the application back to this pool if it is changed after its initial provisioning. -The database server and database name properties are only used during provisioning, and will not be altered as part of the ongoing operation of the DSC resource. - -.EXAMPLE - - SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { - Name = "Managed Metadata Service Application" - InstallAccount = $InstallAccount - ApplicationPool = "SharePoint Service Applications" - DatabaseServer = $DatabaseServer - DatabaseName = "SP_ManagedMetadata" - } - +.DESCRIPTION + + Creates a managed metadata service application. The application pool property specifies + which application pool it should use, and will reset the application back to this pool + if it is changed after its initial provisioning. The database server and database name + properties are only used during provisioning, and will not be altered as part of the + ongoing operation of the DSC resource. + .PARAMETER Name Key - string The name of the managed metadata service application +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER ApplicationPool Required - string The application pool that the service app will use @@ -45,6 +40,61 @@ The database server and database name properties are only used during provisioni .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $SetupAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "SP_ManagedMetadata" + } + } + } + + +.EXAMPLE + + This example shows how to remove a specific managed metadata service app from the + local SharePoint farm. Because Application pool parameter is required + but is not acutally needed to remove the app, any text value can + be supplied for these as it will be ignored. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $SetupAccount + ApplicationPool = "none" + Ensure = "Absent" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt index 519ef1b13..6db9a1286 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt @@ -1,25 +1,16 @@ .NAME SPManagedPath -.SYNOPSIS - -This resource is responsible for creating managed paths associated with a specific web application. -The WebAppUrl parameter is used to specify the web application to create the path against, and the RelativeUrl parameter lets you set the URL. -Explicit when set to true will create an explicit inclusion path, if set to false the path is created as wildcard inclusion. -If you are using host named site collections set HostHeader to true and the path will be created as a host header path to be applied for host named site collections. - -.EXAMPLE - - SPManagedPath TeamsManagedPath - { - WebAppUrl = "http://sharepoint.contoso.com" - InstallAccount = $InstallAccount - RelativeUrl = "teams" - Explicit = $false - Ensure = "Present" - HostHeader = $true - } - +.DESCRIPTION + + This resource is responsible for creating managed paths associated with a specific web + application. The WebAppUrl parameter is used to specify the web application to create + the path against, and the RelativeUrl parameter lets you set the URL. Explicit when set + to true will create an explicit inclusion path, if set to false the path is created as + wildcard inclusion. If you are using host named site collections set HostHeader to true + and the path will be created as a host header path to be applied for host named site + collections. + .PARAMETER WebAppUrl Key - string The URL of the web application to apply the managed path to - this is ignored for host header web applications @@ -43,6 +34,85 @@ If you are using host named site collections set HostHeader to true and the path .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy an explicit managed path to a specifici web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedPath TestManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $SetupAccount + RelativeUrl = "example" + Explicit = $true + HostHeader = $false + } + } + } + + +.EXAMPLE + This example shows how to add a wildcard managed path to a specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedPath TestManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $SetupAccount + RelativeUrl = "teams" + Explicit = $false + HostHeader = $true + } + } + } + + +.EXAMPLE + This example shows how to remove a wildcard managed path from a specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedPath TestManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $SetupAccount + RelativeUrl = "teams" + Explicit = $false + HostHeader = $true + Ensure = "Absent" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt index f3367b234..16f314a17 100644 --- a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt @@ -1,25 +1,17 @@ .NAME SPOfficeOnlineServerBinding -.SYNOPSIS - -This resource will create a binding to an Office Online Server (formerly known as Office Web Apps). -The DnsName property can be a single server name, or a FQDN of a load balanced end point that will direct traffic to a farm. - -NOTE: This resource is designed to be used where all WOPI bindings will be targeted to the same Office Online Server farm. -If used on a clean environment, the new bindings will all point to the one DNS Name. -If used on an existing configuration that does not follow this rule, it will match only the first DNS name it finds in the list of bindings. - -.EXAMPLE - - SPOfficeOnlineServerBinding OosBinding - { - Zone = "internal-https" - DnsName = "webapps.contoso.com" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - +.DESCRIPTION + + This resource will create a binding to an Office Online Server (formerly known as Office + Web Apps). The DnsName property can be a single server name, or a FQDN of a load balanced + end point that will direct traffic to a farm. + + NOTE: This resource is designed to be used where all WOPI bindings will be targeted to the + same Office Online Server farm. If used on a clean environment, the new bindings will all + point to the one DNS Name. If used on an existing configuration that does not follow this + rule, it will match only the first DNS name it finds in the list of bindings. + .PARAMETER Zone Key - string Allowed values: Internal-HTTP, Internal-HTTPS, External-HTTP, External-HTTPS @@ -36,6 +28,57 @@ If used on an existing configuration that does not follow this rule, it will mat .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create bindings to the internal-https zone for the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOfficeOnlineServerBinding OosBinding + { + Zone = "internal-https" + DnsName = "webapps.contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove bindings from the internal-http zone for the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOfficeOnlineServerBinding OosBinding + { + Zone = "Internal-HTTP" + DnsName = "webapps.contoso.com" + PsDscRunAsCredential = $SetupAccount + Ensure = "Absent" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt index 040505b22..3fc6d85ce 100644 --- a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt @@ -1,24 +1,15 @@ .NAME SPOutgoingEmailSettings -.SYNOPSIS - -This resource is used to set the outgoing email settings for either a single web application, or the whole farm. -To configure the resource for a specific web app, use the URL of the web application for the WebAppUrl property, to change the settings for the whole farm use the URL of the central admin website instead. -It is possible to set the outgoing server, from address, reply to address and the character set to be used for emails. - -.EXAMPLE - - SPOutgoingEmailSettings FarmWideEmailSettings - { - WebAppUrl = "http://sharepoint1:2013" - SMTPServer = "smtp.contoso.com" - FromAddress = "sharepoint@contoso.com" - ReplyToAddress = "noreply@contoso.com" - CharacterSet = "65001" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to set the outgoing email settings for either a single web + application, or the whole farm. To configure the resource for a specific web app, + use the URL of the web application for the WebAppUrl property, to change the + settings for the whole farm use the URL of the central admin website instead. It is + possible to set the outgoing server, from address, reply to address and the character + set to be used for emails. + .PARAMETER WebAppUrl key - string The URL of the web application. If you want to set the global settings use the Central Admin URL @@ -41,6 +32,61 @@ It is possible to set the outgoing server, from address, reply to address and th .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows to set outgoing email settings for the entire farm. Use the URL + of the central admin site for the web app URL to apply for the entire farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOutgoingEmailSettings FarmWideEmailSettings + { + WebAppUrl = "http://sharepoint1:2013" + SMTPServer = "smtp.contoso.com" + FromAddress = "sharepoint`@contoso.com" + ReplyToAddress = "noreply`@contoso.com" + CharacterSet = "65001" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows to set outgoing email settings for a specific web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOutgoingEmailSettings FarmWideEmailSettings + { + WebAppUrl = "http://site.contoso.com" + SMTPServer = "smtp.contoso.com" + FromAddress = "sharepoint`@contoso.com" + ReplyToAddress = "noreply`@contoso.com" + CharacterSet = "65001" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt index 49b23d483..42f8cb895 100644 --- a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt @@ -1,23 +1,14 @@ .NAME SPPasswordChangeSettings -.SYNOPSIS - -This resource is used to control settings that relate to the automatic changing of passwords for managed accounts (where they opt-in to be managed by SharePoint). -These settings can be manually controlled through central administration, or configured in this resource. -The settings relate to email notifications of when passwords are reset, as well as behavior when a reset occurs such as a time out and number of retries. - -.EXAMPLE - - SPPasswordChangeSettings ManagedAccountPasswordResetSettings - { - MailAddress = "sharepoint@contoso.com" - DaysBeforeExpiry = "14" - PasswordChangeWaitTimeSeconds = "60" - NumberOfRetries = "3" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to control settings that relate to the automatic changing of + passwords for managed accounts (where they opt-in to be managed by SharePoint). These + settings can be manually controlled through central administration, or configured in + this resource. The settings relate to email notifications of when passwords are reset, + as well as behavior when a reset occurs such as a time out and number of retries. + .PARAMETER MailAddress key - string The email address to send notifications of password changes to @@ -36,6 +27,32 @@ The settings relate to email notifications of when passwords are reset, as well .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example sets the password change settings for managed accounts in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPasswordChangeSettings ManagedAccountPasswordResetSettings + { + MailAddress = "sharepoint`@contoso.com" + DaysBeforeExpiry = "14" + PasswordChangeWaitTimeSeconds = "60" + NumberOfRetries = "3" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt index c4b13a77a..84f6a6a7a 100644 --- a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt @@ -1,22 +1,20 @@ .NAME SPPerformancePointServiceApp -.SYNOPSIS - -This resource is responsible for creating Performance Point Service Application instances within the local SharePoint farm. -The resource will provision and configure the Performance Point Service Application. -.EXAMPLE - SPPerformancePointServiceApp PerformancePoint - { - Name = "Performance Point Service Application" - ApplicationPool = "SharePoint Web Services" - InstallAccount = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for creating Performance Point Service Application + instances within the local SharePoint farm. The resource will provision and + configure the Performance Point Service Application. + .PARAMETER Name Key - string The name of the service application +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER ApplicationPool Required - string The name of the application pool to run the service app in @@ -36,6 +34,57 @@ The resource will provision and configure the Performance Point Service Applicat .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new performance point service app in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPerformancePointServiceApp PerformancePoint + { + Name = "Performance Point Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes the specific performance point service app from the local + farm. The ApplicationPool parameter is still mandatory but it is not used, so + the value can be anything. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPerformancePointServiceApp PerformancePoint + { + Name = "Performance Point Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt new file mode 100644 index 000000000..57decedb8 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt @@ -0,0 +1,122 @@ +.NAME + SPProductUpdate + +.DESCRIPTION + + This resource is used to perform the update step of installing SharePoint updates, like Cumulative Updates and Service Packs. + The SetupFile parameter should point to the update file. + The ShutdownServices parameter is used to indicate if some services (Timer, Search and IIS services) have to be stopped before installation of the update. This will speed up the installation. + The BinaryInstallDays and BinaryInstallTime parameters specify a window in which the update can be installed. + This module requires the Configuration Wizard resource to fully complete the installation of the update, which can be done through the use of SPConfigWizard. + +.PARAMETER SetupFile + Key - String + The name of the update setup file + +.PARAMETER ShutdownServices + Write - Boolean + Shutdown SharePoint services to speed up installation + +.PARAMETER BinaryInstallDays + Write - String + Allowed values: mon, tue, wed, thu, fri, sat, sun + Specify on which dates the installation is allowed + +.PARAMETER BinaryInstallTime + Write - String + Specify in which time frame the installation is allowed + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example installs the Cumulative Update only in the specified window. + It also shuts down services to speed up the installation process. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProductUpdate InstallCUMay2016 + { + SetupFile = "C:\Install\CUMay2016\ubersrv2013-kb3115029-fullfile-x64-glb.exe" + ShutdownServices = $true + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example installs the SharePoint 2013 Service Pack only in the specified window. + It also shuts down services to speed up the installation process. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProductUpdate InstallCUMay2016 + { + SetupFile = "C:\Install\SP2013SP1\officeserversp2013-kb2880552-fullfile-x64-en-us.exe" + ShutdownServices = $true + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example installs the SharePoint 2013 Dutch Language Pack Service Pack only in the specified window. + It also shuts down services to speed up the installation process. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProductUpdate InstallCUMay2016 + { + SetupFile = "C:\Install\SP2013-LP_NL-SP1\serverlpksp2013-kb2880554-fullfile-x64-nl-nl.exe" + ShutdownServices = $true + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt new file mode 100644 index 000000000..54c2ea7f8 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt @@ -0,0 +1,83 @@ +.NAME + SPPublishServiceApplication + +.DESCRIPTION + + This resource is used to specify if a specific service application should be published + (Ensure = "Present") or not published (Ensure = "Absent") on the current server. + The name is the display name of the service application as shown in the Central Admin website. + + You can publish the following service applications in a SharePoint Server 2013/2016 farm: + * Business Data Connectivity + * Machine Translation + * Managed Metadata + * User Profile + * Search + * Secure Store + + Source: https://technet.microsoft.com/en-us/library/ff621100(v=office.15).aspx + +.PARAMETER Name + Key - string + The name of the service application to publish + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure it runs on this server, or absent to ensure it is stopped + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure that the managed metadata service is published + within the farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPublishServiceApplication PublishManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + Ensure = "Present" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure that the Secure Store Service is not + published within the farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPublishServiceApplication UnpublishSecureStoreServiceApp + { + Name = "Secure Store Service Application" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt index b4007aedc..d371e4cfd 100644 --- a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt @@ -1,23 +1,12 @@ .NAME SPQuotaTemplate -.SYNOPSIS - -This resource is used to configure quota templates in the farm. -These settings will be used to make sure a certain quota template exists or not. When it exists, it will also make sure the settings are configured as specified. - -.EXAMPLE - - SPQuotaTemplate TeamsiteTemplate - { - Name = "Teamsite" - StorageMaxInMB = 1024 - StorageWarningInMB = 512 - MaximumUsagePointsSolutions = 1000 - WarningUsagePointsSolutions = 800 - Ensure = "Present" - } - +.DESCRIPTION + + This resource is used to configure quota templates in the farm. These settings will + be used to make sure a certain quota template exists or not. When it exists, it will + also make sure the settings are configured as specified. + .PARAMETER Name Key - string The name of the quota template @@ -45,6 +34,33 @@ These settings will be used to make sure a certain quota template exists or not. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a specific quota template in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPQuotaTemplate TeamsiteTemplate + { + Name = "Teamsite" + StorageMaxInMB = 1024 + StorageWarningInMB = 512 + MaximumUsagePointsSolutions = 1000 + WarningUsagePointsSolutions = 800 + Ensure = "Present" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt index a45f47ba3..1eeb5cb83 100644 --- a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt @@ -1,21 +1,12 @@ .NAME SPRemoteFarmTrust -.SYNOPSIS - -This resource is used to trust a remote SharePoint farm. -This is used when federating search results between two different SharePoint farms. -The technique is described at https://technet.microsoft.com/en-us/library/dn133749.aspx - -.EXAMPLE - - SPRemoteFarmTrust TrustRemoteFarmForSearch - { - Name = "CentralSearchFarm" - RemoteWebAppUrl = "https://search.sharepoint.contoso.com" - LocalWebAppUrl = "https://local.sharepoint2.contoso.com" - } - +.DESCRIPTION + + This resource is used to trust a remote SharePoint farm. This is used when federating + search results between two different SharePoint farms. The technique is described at + https://technet.microsoft.com/en-us/library/dn133749.aspx + .PARAMETER Name Key - string A name of the remote farm, used to create token issuer and root authority @@ -35,6 +26,31 @@ The technique is described at https://technet.microsoft.com/en-us/library/dn1337 .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a remote farm trust so that the local web app trusts calls + that will come from the remote web app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPRemoteFarmTrust TrustRemoteFarmForSearch + { + Name = "CentralSearchFarm" + RemoteWebAppUrl = "https://search.sharepoint.contoso.com" + LocalWebAppUrl = "https://local.sharepoint2.contoso.com" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt index 18189067e..d0f79b735 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt @@ -1,66 +1,10 @@ .NAME SPSearchContentSource -.SYNOPSIS - -This resource will deploy and configure a content source in a specified search service application. - -.EXAMPLE - -This example is for a SharePoint content source - - SPSearchContentSource LocalSharePointSites - { - Name = "Local SharePoint Sites" - ServiceAppName = "Search Service Application" - ContentSourceType = "SharePoint" - Addresses = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com") - CrawlSetting = "CrawlEverything" - ContinuousCrawl = $true - IncrementalSchedule = MSFT_SPSearchCrawlSchedule @{ - ScheduleType = "Daily" - StartHour = "0" - StartMinute = "0" - CrawlScheduleRepeatDuration = "1440" - CrawlScheduleRepeatInterval = "5" - } - FullSchedule = $null - Priority = "Normal" - Ensure = "Present" - PsDscRunAsCredential = $SPSetupAccount - DependsOn = "[SPSearchRoles]LocalSearchRoles" - } - -This example is for a website content source - - SPSearchContentSource LocalSharePointSites - { - Name = "Local SharePoint Sites" - ServiceAppName = "Search Service Application" - ContentSourceType = "Website" - Addresses = @("http://www.contoso.com") - CrawlSetting = "Custom" - LimitPageDepth = 5 - LimitServerHops = 0 - IncrementalSchedule = MSFT_SPSearchCrawlSchedule @{ - ScheduleType = "Daily" - StartHour = "0" - StartMinute = "0" - CrawlScheduleRepeatDuration = "1440" - CrawlScheduleRepeatInterval = "5" - } - FullSchedule = MSFT_SPSearchCrawlSchedule @{ - ScheduleType = "Weekly" - CrawlScheduleDaysOfWeek = @("Monday", "Wednesday", "Friday") - StartHour = "3" - StartMinute = "0" - } - Priority = "Normal" - Ensure = "Present" - PsDscRunAsCredential = $SPSetupAccount - DependsOn = "[SPSearchRoles]LocalSearchRoles" - } - +.DESCRIPTION + + This resource will deploy and configure a content source in a specified search service application. + .PARAMETER Name Key - String The name of the content source @@ -119,6 +63,88 @@ This example is for a website content source .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a SharePoint sites content source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchContentSource LocalSharePointSites + { + Name = "Local SharePoint Sites" + ServiceAppName = "Search Service Application" + ContentSourceType = "SharePoint" + Addresses = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com") + CrawlSetting = "CrawlEverything" + ContinuousCrawl = $true + IncrementalSchedule = MSFT_SPSearchCrawlSchedule { + ScheduleType = "Daily" + StartHour = "0" + StartMinute = "0" + CrawlScheduleRepeatDuration = "1440" + CrawlScheduleRepeatInterval = "5" + } + FullSchedule = $null + Priority = "Normal" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to create a website content source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchContentSource WebsiteSource + { + Name = "Contoso website" + ServiceAppName = "Search Service Application" + ContentSourceType = "Website" + Addresses = @("http://www.contoso.com") + CrawlSetting = "Custom" + LimitPageDepth = 5 + LimitServerHops = 0 + IncrementalSchedule = MSFT_SPSearchCrawlSchedule{ + ScheduleType = "Daily" + StartHour = "0" + StartMinute = "0" + CrawlScheduleRepeatDuration = "1440" + CrawlScheduleRepeatInterval = "5" + } + FullSchedule = MSFT_SPSearchCrawlSchedule{ + ScheduleType = "Weekly" + CrawlScheduleDaysOfWeek = @("Monday", "Wednesday", "Friday") + StartHour = "3" + StartMinute = "0" + } + Priority = "Normal" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt index 540785750..3a2b96ea9 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt @@ -1,34 +1,12 @@ .NAME SPSearchCrawlRule -.SYNOPSIS - -This resource is responsible for managing the search crawl rules in the search service application. -You can create new rules, change existing rules and remove existing rules. - -.EXAMPLE - - SPSearchCrawlRule IntranetCrawlAccount - { - Path = "https://intranet.sharepoint.contoso.com" - ServiceAppName = "Search Service Application" - Ensure = "Present" - RuleType = "InclusionRule" - CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" - AuthenticationType = "DefaultRuleAccess" - } - - SPSearchCrawlRule IntranetCrawlAccountCertificate - { - Path = "https://intranet.sharepoint.contoso.com" - ServiceAppName = "Search Service Application" - Ensure = "Present" - RuleType = "InclusionRule" - CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" - AuthenticationType = "CertificateRuleAccess" - CertificateName = "Certificate Name" - } - +.DESCRIPTION + + This resource is responsible for managing the search crawl rules in the search + service application. You can create new rules, change existing rules and remove + existing rules. + .PARAMETER Path Key - string The name of the search service application @@ -67,6 +45,63 @@ You can create new rules, change existing rules and remove existing rules. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply settings to a sepcific URL in search + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchCrawlRule IntranetCrawlAccount + { + Path = "https://intranet.sharepoint.contoso.com" + ServiceAppName = "Search Service Application" + Ensure = "Present" + RuleType = "InclusionRule" + CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" + AuthenticationType = "DefaultRuleAccess" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to set a certificate for authentication to a content source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchCrawlRule IntranetCrawlAccountCertificate + { + Path = "https://intranet.sharepoint.contoso.com" + ServiceAppName = "Search Service Application" + Ensure = "Present" + RuleType = "InclusionRule" + CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" + AuthenticationType = "CertificateRuleAccess" + CertificateName = "Certificate Name" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt index ce6751510..c7b8bf639 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt @@ -1,31 +1,23 @@ .NAME SPSearchIndexPartition -.SYNOPSIS - -This resource is responsible for creating search indexes. -It works by creating the index topology components and updating the topology from the server that runs this resource. -For this reason this resource only needs to run from one server and not from each server which will host the index component. -The search service application and existing search topology must be deployed before creating additional indexes. -The first index will be created through the use of the SPSearchRoles resource. -Additional search index partitions can be created through using this resource. - -Note that for the search topology to apply correctly, the path specified for RootDirectory needs to exist on the server that is executing this resource. -For example, if the below example was executed on "Server1" it would also need to ensure that it was able to create the index path at I:\. -If no disk labeled I: was available on server1, this would fail, even though it will not hold an actual index component. - -.EXAMPLE - - SPSearchIndexPartition MainSearchPartition - { - Servers = @("Server2", "Server3") - Index = 1 - RootDirectory = "I:\SearchIndexes\1" - ServiceAppName = "Search Service Application" - PsDscRunAsCredential = $SPSetupAccount - DependsOn = "[SPSearchRoles]LocalSearchRoles" - } - +.DESCRIPTION + + This resource is responsible for creating search indexes. It works by creating the + index topology components and updating the topology from the server that runs this + resource. For this reason this resource only needs to run from one server and not + from each server which will host the index component. The search service application + and existing search topology must be deployed before creating additional indexes. + The first index will be created through the use of the SPSearchRoles resource. + Additional search index partitions can be created through using this resource. + + Note that for the search topology to apply correctly, the path specified for + RootDirectory needs to exist on the server that is executing this resource. For + example, if the below example was executed on "Server1" it would also need to + ensure that it was able to create the index path at I:\. If no disk labeled I: + was available on server1, this would fail, even though it will not hold an + actual index component. + .PARAMETER Index Key - Uint32 The number of the partition in this farm @@ -44,6 +36,32 @@ If no disk labeled I: was available on server1, this would fail, even though it .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds an extra search partition to the local farms topology + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchIndexPartition AdditionalPartition + { + Servers = @("Server2", "Server3") + Index = 1 + RootDirectory = "I:\SearchIndexes\1" + ServiceAppName = "Search Service Application" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt index 17da64292..4a3e0ac01 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt @@ -1,19 +1,19 @@ .NAME SPSearchResultSource -.SYNOPSIS - -This resoruce -.EXAMPLE - - SPSearchResultSource RemoteSharePointFarm - { - Name = "External SharePoint results" - SearchServiceAppName = "Search Service Application" - Query = "{searchTerms}" - ProviderType = "Remote SharePoint Provider" - } - +** Description ** + + This resource is used to configure search result sources in the SharePoint search + service application. Result sources can be configured to be of the following + provider types: + + * Exchange Search Provider + * Local People Provider + * Local SharePoint Provider + * OpenSearch Provider + * Remote People Provider + * Remote SharePoint Provider + .PARAMETER Name Key - String The name of the result source @@ -42,6 +42,32 @@ This resoruce .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a remote sharepoint search result source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchResultSource RemoteSharePointFarm + { + Name = "External SharePoint results" + SearchServiceAppName = "Search Service Application" + Query = "{searchTerms}" + ProviderType = "Remote SharePoint Provider" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt index 5cc227786..16d2929e4 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt @@ -1,27 +1,24 @@ .NAME SPSearchServiceApp -.SYNOPSIS - -This resource is responsible for provisioning the search service application. -The current version lets you specify the database name and server, as well as the application pool. -If the application pool is changed the DSC resource will set it back as per what is set in the resource. -The database name parameter is used as the prefix for all search databases (so you will end up with one for the admin database which matches the name, and then "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well). - -.EXAMPLE - - SPSearchServiceApp SearchServiceApp - { - Name = "Search Service Application" - DatabaseName = "SP_Search" - ApplicationPool = "SharePoint Service Applications" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for provisioning the search service application. The + current version lets you specify the database name and server, as well as the + application pool. If the application pool is changed the DSC resource will set it + back as per what is set in the resource. The database name parameter is used as the + prefix for all search databases (so you will end up with one for the admin database + which matches the name, and then "_analyticsreportingstore", "_crawlstore" and + "_linkstore" databases as well). + .PARAMETER Name Key - string The name of the search service application +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER ApplicationPool Required - string The application pool that it should run in @@ -53,6 +50,57 @@ The database name parameter is used as the prefix for all search databases (so y .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + 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 + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchServiceApp SearchServiceApp + { + Name = "Search Service Application" + DatabaseName = "SP_Search" + ApplicationPool = "SharePoint Service Applications" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a search service app in the local farm. The ApplicationPool + parameter is still required but is not actually used, so its value does not matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchServiceApp SearchServiceApp + { + Name = "Search Service Application" + Ensure = "Absent" + ApplicationPool = "n/a" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt index 5165b5a54..a1955e4b4 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt @@ -1,34 +1,24 @@ .NAME SPSearchTopology -.SYNOPSIS - -This resource is responsible for provisioning a search topology in to the current farm. -It allows the configuration to dictate the search topology roles that the current server should be running. -Any combination of roles can be specified and the topology will be upaded to reflect the current servers new roles. -If this is the first server to apply topology to a farm, then at least one search index must be provided. -To this end, the FirstPartitionIndex, FirstPartitionDirectory and FirstPartitionServers allow configuring where the first index partition will belong. -This will behave the same as the SPSearchIndexPartition resource. - -Note that for the search topology to apply correctly, the path specified for FirstPartitionDirectory needs to exist on the server that is executing this resource. -For example, if the below example was executed on "Server1" it would also need to ensure that it was able to create the index path at I:\. -If no disk labeled I: was available on server1, this would fail, even though it will not hold an actual index component. - -.EXAMPLE - - SPSearchTopology LocalSearchTopology - { - ServiceAppName = "Search Service Application" - Admin = @("Server1","Server2") - Crawler = @("Server1","Server2") - ContentProcessing = @("Server1","Server2") - AnalyticsProcessing = @("Server1","Server2") - QueryProcessing = @("Server3","Server4") - PsDscRunAsCredential = $SPSetupAccount - FirstPartitionDirectory = "I:\SearchIndexes\0" - IndexPartition = @("Server3","Server4") - } - +.DESCRIPTION + + This resource is responsible for provisioning a search topology in to the current + farm. It allows the configuration to dictate the search topology roles that the + current server should be running. Any combination of roles can be specified and + the topology will be upaded to reflect the current servers new roles. If this is + the first server to apply topology to a farm, then at least one search index must + be provided. To this end, the FirstPartitionIndex, FirstPartitionDirectory and + FirstPartitionServers allow configuring where the first index partition will belong. + This will behave the same as the SPSearchIndexPartition resource. + + Note that for the search topology to apply correctly, the path specified for + FirstPartitionDirectory needs to exist on the server that is executing this resource. + For example, if the below example was executed on "Server1" it would also need to + ensure that it was able to create the index path at I:\. If no disk labeled I: was + available on server1, this would fail, even though it will not hold an actual index + component. + .PARAMETER ServiceAppName Key - String The name of the search service application for this topology @@ -63,6 +53,36 @@ If no disk labeled I: was available on server1, this would fail, even though it .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply a specific topology to the search service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchTopology LocalSearchTopology + { + ServiceAppName = "Search Service Application" + Admin = @("Server1","Server2") + Crawler = @("Server1","Server2") + ContentProcessing = @("Server1","Server2") + AnalyticsProcessing = @("Server1","Server2") + QueryProcessing = @("Server3","Server4") + PsDscRunAsCredential = $SetupAccount + FirstPartitionDirectory = "I:\SearchIndexes\0" + IndexPartition = @("Server3","Server4") + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt index 7196a95a7..01c1d0d56 100644 --- a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt @@ -1,28 +1,21 @@ .NAME SPSecureStoreServiceApp -.SYNOPSIS - -This resource is responsible for provisioning and configuring the secure store service application. -The parameters passed in (except those related to database specifics) are validated and set when the resource is run, the database values are only used in provisioning of the service application. - -.EXAMPLE - - SPSecureStoreServiceApp SecureStoreServiceApp - { - Name = "Secure Store Service Application" - ApplicationPool = "SharePoint Service Applications" - AuditingEnabled = $true - AuditlogMaxSize = 30 - DatabaseName = "SP_SecureStore" - InstallAccount = $InstallAccount - Ensure = "Present" - } - +.DESCRIPTION + + This resource is responsible for provisioning and configuring the secure store + service application. The parameters passed in (except those related to database + specifics) are validated and set when the resource is run, the database values + are only used in provisioning of the service application. + .PARAMETER Name Key - string The name of the secure store service app +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER ApplicationPool Required - string The name of the application pool it will run in @@ -71,6 +64,61 @@ The parameters passed in (except those related to database specifics) are valida .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new secure store service app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSecureStoreServiceApp SecureStoreServiceApp + { + Name = "Secure Store Service Application" + ApplicationPool = "SharePoint Service Applications" + AuditingEnabled = $true + AuditlogMaxSize = 30 + DatabaseName = "SP_SecureStore" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a secure store service app. The ApplicationPool and + AuditingEnabled parameters are required, but are not used so their values + are able to be set to anything. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSecureStoreServiceApp SecureStoreServiceApp + { + Name = "Secure Store Service Application" + ApplicationPool = "n/a" + AuditingEnabled = $false + InstallAccount = $SetupAccount + Ensure = "Absent" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt index e27492dc1..e0b4b8b17 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt @@ -1,21 +1,12 @@ .NAME SPServiceAppPool -.SYNOPSIS - -This resource is used for provisioning an application pool that can be used for service applications. -The account used for the service account must already be registered as a managed account (which can be provisioned through [SPManagedAccount](SPManagedAccount)). - -.EXAMPLE - - SPServiceAppPool MainServiceAppPool - { - Name = "SharePoint Service Applications" - ServiceAccount = "Demo\ServiceAccount" - InstallAccount = $InstallAccount - Ensure = "Present" - } - +.DESCRIPTION + + This resource is used for provisioning an application pool that can be used for + service applications. The account used for the service account must already be + registered as a managed account (which can be provisioned through SPManagedAccount. + .PARAMETER Name Key - string The name of application pool @@ -31,6 +22,31 @@ The account used for the service account must already be registered as a managed .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a service application pool for service apps to run in. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceAppPool MainServiceAppPool + { + Name = "SharePoint Service Applications" + ServiceAccount = "Demo\ServiceAccount" + PsDscRunAsCredential = $SetupAccount + Ensure = "Present" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt index 878a8d3f9..2b945a656 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt @@ -1,37 +1,24 @@ .NAME SPServiceAppProxyGroup -.SYNOPSIS - -This resource is used to manage SharePoint Service Application Proxy Groups. -The "Ensure" parameter controls whether or not the Proxy Group should exist. A proxy group cannot be removed if a web application is using it. -The "ServiceAppProxies" property will set a specific list of Service App Proxies to be members of this Proxy Group. It will add and remove proxies to ensure the group matches this list exactly. -The "ServiceAppProxiesToInclude" and "ServiceAppProxiesToExclude" properties will allow you to add and remove proxies from the group, leaving other proxies that are in the group but not in either list intact. - -Use the proxy group name "Default" to manipulate the default proxy group. - - -Requirements: -At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or ServiceAppProxiesToExclude properties needs to be specified. -Do not combine the ServiceAppProxies property with the ServiceAppProxiesToInclude and ServiceAppProxiesToExclude properties. - -**Examples** - - SPServiceAppProxyGroup ProxyGroup1 - { - Name = "Proxy Group 1" - Ensure = "Present" - ServiceAppProxies = "Web 1 User Profile Service Application","Web 1 MMS Service Application","State Service Application" - } - - SPServiceAppProxyGroup ProxyGroup2 - { - Name = "Proxy Group 2" - Ensure = "Present" - ServiceAppProxiesToInclude = "Web 2 User Profile Service Application" - } - - +.DESCRIPTION + + This resource is used to manage SharePoint Service Application Proxy Groups. The "Ensure" + parameter controls whether or not the Proxy Group should exist. A proxy group cannot be + removed if a web application is using it. The "ServiceAppProxies" property will set a + specific list of Service App Proxies to be members of this Proxy Group. It will add and + remove proxies to ensure the group matches this list exactly. The + "ServiceAppProxiesToInclude" and "ServiceAppProxiesToExclude" properties will allow you + to add and remove proxies from the group, leaving other proxies that are in the group + but not in either list intact. + + Use the proxy group name "Default" to manipulate the default proxy group. + + Requirements: + At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or ServiceAppProxiesToExclude + properties needs to be specified. Do not combine the ServiceAppProxies property with the + ServiceAppProxiesToInclude and ServiceAppProxiesToExclude properties. + .PARAMETER Name Key - String Name of the Proxy Group to create @@ -55,6 +42,38 @@ Do not combine the ServiceAppProxies property with the ServiceAppProxiesToInclud .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates two seperate proxy groups of service apps that can be + assigned to web apps in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceAppProxyGroup ProxyGroup1 + { + Name = "Proxy Group 1" + Ensure = "Present" + ServiceAppProxies = "Web 1 User Profile Service Application","Web 1 MMS Service Application","State Service Application" + } + + SPServiceAppProxyGroup ProxyGroup2 + { + Name = "Proxy Group 2" + Ensure = "Present" + ServiceAppProxiesToInclude = "Web 2 User Profile Service Application" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt index 0c9ffca9c..c91b45cd4 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt @@ -1,35 +1,21 @@ .NAME SPServiceAppSecurity -.SYNOPSIS - -This resource is used to manage the sharing security settings of a specific service application. -There are a number of approaches to how this can be implemented. -Firstly you can set permissions for the app administrators, or for the sharing permission by specifying the SecurityType attribute. -These options correlate to the buttons seen in the ribbon on the "manage service applications" page in Central Administration after you select a specific service app. -The "Members" property will set a specific list of members for the service app, 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 - - $membersToInclude = @() - $membersToInclude += MSFT_SPServiceAppSecurityEntry { - Username = "CONTOSO\SharePointFarmAccount" - AccessLevel = "FullControl" - } - $membersToInclude += MSFT_SPServiceAppSecurityEntry { - Username = "CONTOSO\SharePointServiceApps" - AccessLevel = "FullControl" - } - SPServiceAppSecurity UserProfileServiceSecurity - { - ServiceAppName = "User Profile Service Application" - SecurityType = "SharingPermissions" - MembersToInclude = $membersToInclude - MembersToExclude = @("CONTOSO\BadAccount1", "CONTOSO\BadAccount2") - PsDscRunAsCredential = $SPSetupAccount - } - +.DESCRIPTION + + This resource is used to manage the sharing security settings of a specific service + application. There are a number of approaches to how this can be implemented. Firstly + you can set permissions for the app administrators, or for the sharing permission by + specifying the SecurityType attribute. These options correlate to the buttons seen in + the ribbon on the "manage service applications" page in Central Administration after + you select a specific service app. The "Members" property will set a specific list of + members for the service app, 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. + .PARAMETER ServiceAppName Key - String The name of the service application you wish to apply security settings to @@ -56,3 +42,40 @@ The "MembersToInclude" and "MembersToExclude" properties will allow you to contr POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 +.EXAMPLE + This example shows how full control permission can be given to the farm + account and service app pool account to the user profile service app's + sharing permission. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + $membersToInclude = @() + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointFarmAccount" + AccessLevel = "Full Control" + } + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointServiceApps" + AccessLevel = "Full Control" + } + SPServiceAppSecurity UserProfileServiceSecurity + { + ServiceAppName = "User Profile Service Application" + SecurityType = "SharingPermissions" + MembersToInclude = $membersToInclude + MembersToExclude = @("CONTOSO\BadAccount1", "CONTOSO\BadAccount2") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt index 125e15f4f..0e06cb8b8 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt @@ -1,27 +1,12 @@ .NAME SPServiceInstance -.SYNOPSIS - -This resource is used to specify if a specific service should be running (Ensure = "Present") or not running (Ensure = "Absent") on the current server. -The name is the display name of the service as shown in the Central Admin website. - -**Examples** - - SPServiceInstance ManagedMetadataServiceInstance - { - Name = "Managed Metadata Web Service" - Ensure = "Present" - InstallAccount = $InstallAccount - } - - SPServiceInstance StopBCSServiceInstance - { - Name = "Business Data Connectivity Service" - Ensure = "Absent" - InstallAccount = $InstallAccount - } - +.DESCRIPTION + + This resource is used to specify if a specific service should be running + (Ensure = "Present") or not running (Ensure = "Absent") on the current server. + The name is the display name of the service as shown in the Central Admin website. + .PARAMETER Name Key - string The name of the service instance to manage @@ -33,6 +18,56 @@ The name is the display name of the service as shown in the Central Admin websit .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure that the managed metadata service is running + on the local server. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceInstance ManagedMetadataServiceInstance + { + Name = "Managed Metadata Web Service" + Ensure = "Present" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure that the Business Data Connectivity Service + is not running on the local server. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceInstance StopBCSServiceInstance + { + Name = "Business Data Connectivity Service" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt index 3773db3fc..ba36aa2bf 100644 --- a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt @@ -1,22 +1,12 @@ .NAME SPSessionStateService -.SYNOPSIS - -This resource will provision a state service app to the local farm. -Specify the name of the database server and database name to provision the app with, and optionally include the session timeout value. -If session timeout is not provided it will default to 60. - -.EXAMPLE - - SPSessionStateService StateServiceApp - { - DatabaseName = "SP_StateService" - DatabaseServer = "SQL.test.domain" - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource will provision a state service app to the local farm. Specify the name of + the database server and database name to provision the app with, and optionally include + the session timeout value. If session timeout is not provided it will default to 60. + .PARAMETER DatabaseName Key - string The name of the database for the service @@ -36,6 +26,31 @@ If session timeout is not provided it will default to 60. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new session state service on the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSessionStateService StateServiceApp + { + DatabaseName = "SP_StateService" + DatabaseServer = "SQL.test.domain" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt index 239ee35cc..d148c9deb 100644 --- a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt @@ -1,50 +1,32 @@ .NAME SPShellAdmins -.SYNOPSIS - -This resource is used to manage the users with Shell Admin permissions. -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. -The "ContentDatabases" and "AllContentDatabases" properties will allow you to control the permissions on Content Databases. - -Requirements: -At least one of the Members, MemberToInclude or MembersToExclude properties needs to be specified. -Do not combine the Members property with the MemberToInclude and MembersToExclude properties. -Do not combine the ContentDatabase property with the AllContentDatabases property. - -Notes: -1.) If a content database is created using the Central Admin, the farm account is the owner of that content database in SQL Server. -When this is true, you cannot add it to the Shell Admins (common for AllContentDatabases parameter) and the resource will throw an error. -Workaround: Change database owner in SQL Server. - -.EXAMPLE - - SPShellAdmins ShellAdmins - { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - AllContentDatabases = $true - } - - SPShellAdmins ShellAdmins - { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - ContentDatabases = @( - @(MSFT_SPContentDatabasePermissions { - Name = "SharePoint_Content_1" - Members = "CONTOSO\user2", "CONTOSO\user3" - }) - @(MSFT_SPContentDatabasePermissions { - Name = "SharePoint_Content_2" - Members = "CONTOSO\user3", "CONTOSO\user4" - }) - ) - } - - +.DESCRIPTION + + This resource is used to manage the users with Shell Admin permissions. 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. The "ContentDatabases" and + "AllContentDatabases" properties will allow you to control the permissions on Content + Databases. + + Requirements: + * At least one of the Members, MemberToInclude or MembersToExclude properties needs to + be specified. + * Do not combine the Members property with the MemberToInclude and MembersToExclude + properties. + * Do not combine the ContentDatabase property with the AllContentDatabases property. + + Notes: + 1.) If a content database is created using the Central Admin, the farm account is the + owner of that content database in SQL Server. When this is true, you cannot add it to + the Shell Admins (common for AllContentDatabases parameter) and the resource will throw + an error. Workaround: Change database owner in SQL Server. + .PARAMETER Name Key - String Name for the config, used for administration purposes @@ -71,6 +53,65 @@ Workaround: Change database owner in SQL Server. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example gives admin access to the specified users for the local farm as well as + all content databases in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + AllContentDatabases = $true + } + } + } + + +.EXAMPLE + This example gives admin access to the specified users for the local farm as well as + all content databases in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + ContentDatabases = @( + @(MSFT_SPContentDatabasePermissions { + Name = "SharePoint_Content_1" + Members = "CONTOSO\user2", "CONTOSO\user3" + }) + @(MSFT_SPContentDatabasePermissions { + Name = "SharePoint_Content_2" + Members = "CONTOSO\user3", "CONTOSO\user4" + }) + ) + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSite.help.txt b/Modules/SharePointDsc/en-us/about_SPSite.help.txt index d3588bdd4..04e4e9dc3 100644 --- a/Modules/SharePointDsc/en-us/about_SPSite.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSite.help.txt @@ -1,25 +1,16 @@ .NAME SPSite -.SYNOPSIS - -This resource will provision a site collection to the current farm, based on the settings that are passed through. -These settings map to the New-SPSite cmdlet and accept the same values and types. - -The current version of SharePointDsc is only able to check for the existence of a site collection, the additional parameters are not checked for yet, but will be in a later release - -.EXAMPLE - - SPSite TeamSite - { - Url = "http://sharepoint.contoso.com" - OwnerAlias = "CONTOSO\ExampleUser" - HostHeaderWebApplication = "http://spsites.contoso.com" - Name = "Team Sites" - Template = "STS#0" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource will provision a site collection to the current farm, based on + the settings that are passed through. These settings map to the New-SPSite + cmdlet and accept the same values and types. + + The current version of SharePointDsc is only able to check for the existence + of a site collection, the additional parameters are not checked for yet, but + will be in a later release + .PARAMETER Url Key - string The URL of the site collection @@ -74,6 +65,33 @@ The current version of SharePointDsc is only able to check for the existence of .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a site collection with the provided details + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSite TeamSite + { + Url = "http://sharepoint.contoso.com" + OwnerAlias = "CONTOSO\ExampleUser" + HostHeaderWebApplication = "http://spsites.contoso.com" + Name = "Team Sites" + Template = "STS#0" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt index c7897d0d0..0dd042cac 100644 --- a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt @@ -1,21 +1,12 @@ .NAME SPStateServiceApp -.SYNOPSIS - -This resource provisions an instance of the state service in to the local farm. -The database specific parameters are only used during initial provisioning of the app, and will not change database settings beyond the initial deployment. - -.EXAMPLE - - SPStateServiceApp StateServiceApp - { - Name = "State Service Application" - DatabaseName = "SP_State" - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource provisions an instance of the state service in to the local farm. + The database specific parameters are only used during initial provisioning of + the app, and will not change database settings beyond the initial deployment. + .PARAMETER Name Key - string The name of the state service app @@ -39,6 +30,31 @@ The database specific parameters are only used during initial provisioning of th .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a state service application in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPStateServiceApp StateServiceApp + { + Name = "State Service Application" + DatabaseName = "SP_State" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt index cc30e6fc9..6e0215242 100644 --- a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt @@ -1,24 +1,17 @@ .NAME SPSubscriptionSettingsServiceApp -.SYNOPSIS - -This resource is used to provision and manage an instance of the App Management Services Service Application. -It will identify an instance of the subscription settings service 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 - - SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp - { - Name = "Subscription Settings Service Application" - ApplicationPool = "SharePoint web services" - DatabaseServer = "SQL01.contoso.com" - DatabaseName = "SP_SubscriptionSettings" - PsDscRunAsCredential = $InstallAccount - } - +.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 subscription + settings service 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. + .PARAMETER Name Key - string The name of the subscription settings service app @@ -42,6 +35,59 @@ Database names or server name will not be changed if the configuration does not .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new subscription settings service app in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp + { + Name = "Subscription Settings Service Application" + ApplicationPool = "SharePoint web services" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_SubscriptionSettings" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a subscription settings service app in the local farm. + The ApplicationPool property is required, but is ignored when removing a + service app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp + { + Name = "Subscription Settings Service Application" + ApplicationPool = "n/a" + PsDscRunAsCredential = $SetupAccount + Ensure = "Absent" + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt index f50ef0d5f..521ddd0ec 100644 --- a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt @@ -1,34 +1,26 @@ .NAME SPTimerJobState -.SYNOPSIS - -This resource is used to configure a timer job and make sure it is in a specific state. -The resource can be used to enable or disabled the job and configure the schedule of the job. - -The schedule parameter has to be written in the SPSchedule format (https://technet.microsoft.com/en-us/library/ff607916.aspx). -Examples are: - - Every 5 minutes between 0 and 59 - - Hourly between 0 and 59 - - Daily at 15:00:00 - - Weekly between Fri 22:00:00 and Sun 06:00:00 - - Monthly at 15 15:00:00 - - Yearly at Jan 1 15:00:00 - -NOTE: Make sure you use the internal timer job name, not the display name! -Use "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" to find the internal name for each Timer Job. - -.EXAMPLE - - SPTimerJobState DisableTimerJob_DeadSiteDelete - { - Name = "job-dead-site-delete" - WebApplication = "http://sites.sharepoint.contoso.com" - Enabled = $true - Schedule ="weekly at sat 5:00" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to configure a timer job and make sure it is in a specific + state. The resource can be used to enable or disabled the job and configure the + schedule of the job. + + The schedule parameter has to be written in the SPSchedule format + (https://technet.microsoft.com/en-us/library/ff607916.aspx). + Examples are: + - Every 5 minutes between 0 and 59 + - Hourly between 0 and 59 + - Daily at 15:00:00 + - Weekly between Fri 22:00:00 and Sun 06:00:00 + - Monthly at 15 15:00:00 + - Yearly at Jan 1 15:00:00 + + NOTE: Make sure you use the internal timer job name, not the display name! Use + "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" + to find the internal name for each Timer Job. + .PARAMETER Name Key - String The internal name of the timer job (not the display name) @@ -47,6 +39,32 @@ Use "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayNa .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example show how to disable the dead site delete job in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTimerJobState DisableTimerJob_DeadSiteDelete + { + Name = "job-dead-site-delete" + WebApplication = "http://sites.sharepoint.contoso.com" + Enabled = $false + Schedule ="weekly at sat 5:00" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt new file mode 100644 index 000000000..171d147a3 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt @@ -0,0 +1,112 @@ +.NAME + SPTrustedIdentityTokenIssuer + +.DESCRIPTION + + This resource is used to create or remove SPTrustedIdentityTokenIssuer in a SharePoint + farm. + + The SigningCertificateThumbPrint must match the thumbprint of a certificate in the + store LocalMachine\My of the server that will run this resource. + Note that the private key of the certificate must not be available in the certiificate + store because SharePoint does not accept it. + Once the SPTrustedIdentityTokenIssuer is successfully created, the certificate can be + safely deleted from the certificate store as it won't be needed by SharePoint. + + ClaimsMappings is an array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping. + Each MSFT_SPClaimTypeMapping requires properties Name and IncomingClaimType. + Property LocalClaimType is not required if its value is identical to IncomingClaimType. + + The IdentifierClaim property must match an IncomingClaimType element in ClaimsMappings array. + + The ClaimProviderName property can be set to specify a custom claims provider. It must be + already installed in the SharePoint farm and returned by cmdlet Get-SPClaimProvider. + +.PARAMETER Name + Key - String + Name of the SPTrustedIdentityTokenIssuer + +.PARAMETER Description + Required - String + Description of the SPTrustedIdentityTokenIssuer + +.PARAMETER Realm + Required - String + Default Realm that is passed to identity provider + +.PARAMETER SignInUrl + Required - String + URL of the identity provider where user is redirected to for authentication + +.PARAMETER IdentifierClaim + Required - String + Identity claim type that uniquely identifies the user + +.PARAMETER ClaimsMappings + Required - String + Array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping + +.PARAMETER SigningCertificateThumbPrint + Required - String + Thumbprint of the signing certificate to use with this SPTrustedIdentityTokenIssuer. It must match the thumbprint of a certificate located in store LocalMachine\\My + +.PARAMETER ClaimProviderName + Write - String + Name of a claims provider to set with this SPTrustedIdentityTokenIssuer + +.PARAMETER ProviderSignOutUri + Write - String + Sign-out URL + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Present if the SPTrustedIdentityTokenIssuer should be created, or Absent if it should be removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys a trusted token issuer to the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt index 116ec0690..07cfe2288 100644 --- a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt @@ -1,24 +1,12 @@ .NAME SPUsageApplication -.SYNOPSIS - -This resource provisions an instance of the usage and health monitoring service application. -The database settings are only used for initial provisioning, but the usage settings can be changed and will be enforced as the resource is executed. - -.EXAMPLE - - SPUsageApplication UsageApplication - { - Name = "Usage Service Application" - DatabaseName = "SP_Usage" - UsageLogCutTime = 5 - UsageLogLocation = "L:\UsageLogs" - UsageLogMaxFileSizeKB = 1024 - Ensure = "Present" - InstallAccount = $InstallAccount - } - +.DESCRIPTION + + This resource provisions an instance of the usage and health monitoring service + application. The database settings are only used for initial provisioning, but + the usage settings can be changed and will be enforced as the resource is executed. + .PARAMETER Name Key - string The name of the service application @@ -62,6 +50,34 @@ The database settings are only used for initial provisioning, but the usage sett .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys a usage application to the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUsageApplication UsageApplication + { + Name = "Usage Service Application" + DatabaseName = "SP_Usage" + UsageLogCutTime = 5 + UsageLogLocation = "L:\UsageLogs" + UsageLogMaxFileSizeKB = 1024 + Ensure = "Present" + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt index 25f89a302..97fee52a0 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt @@ -1,47 +1,21 @@ .NAME SPUserProfileProperty -.SYNOPSIS - -This resource will create a property in a user profile service application. -It creates, update or delete a property using the parameters that are passed in to it . - -The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the 5th field of section Bla, which has propertyName value of 5000 then your DisplayOrder needs to be 5005 -If no DisplayOrder is added then SharePoint adds it as the last property of section X. - -Length is only relevant if Field type is "String". - -This Resource doesn't currently support removing existing user profile properties - -.EXAMPLE -SPUserProfileProperty WorkEmailProperty -{ - Name = "WorkEmail2" - Ensure = "Present" - UserProfileService = "User Profile Service Application" - DisplayName = "Work Email" - Type = "Email" - Description = "" #implementation isn't using it yet - PolicySetting = "Mandatory" - PrivacySetting = "Public" - MappingConnectionName = "contoso.com" - MappingPropertyName = "mail" - MappingDirection = "Import" - Length = 10 - DisplayOrder =25 - IsEventLog =$false - IsVisibleOnEditor=$true - IsVisibleOnViewer = $true - IsUserEditable = $true - IsAlias = $false - IsSearchable = $false - TermStore = "" - TermGroup = "" - TermSet = "" - UserOverridePrivacy = $false -} - - +.DESCRIPTION + + This resource will create a property in a user profile service application. It + creates, update or delete a property using the parameters that are passed in to + it. + + The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the + 5th field of section Bla, which has propertyName value of 5000 then your DisplayOrder + needs to be 5005. If no DisplayOrder is added then SharePoint adds it as the last + property of section X. + + Length is only relevant if Field type is "String". + + This Resource doesn't currently support removing existing user profile properties. + .PARAMETER Name Key - string The internal name of the user profile property @@ -140,6 +114,52 @@ SPUserProfileProperty WorkEmailProperty .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys/updates the WorkEmail2 property in the user profile service + app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileProperty WorkEmailProperty + { + Name = "WorkEmail2" + Ensure = "Present" + UserProfileService = "User Profile Service Application" + DisplayName = "Work Email" + Type = "Email" + Description = "" #implementation isn't using it yet + PolicySetting = "Mandatory" + PrivacySetting = "Public" + MappingConnectionName = "contoso.com" + MappingPropertyName = "mail" + MappingDirection = "Import" + Length = 10 + DisplayOrder =25 + IsEventLog =$false + IsVisibleOnEditor=$true + IsVisibleOnViewer = $true + IsUserEditable = $true + IsAlias = $false + IsSearchable = $false + TermStore = "" + TermGroup = "" + TermSet = "" + UserOverridePrivacy = $false + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt new file mode 100644 index 000000000..58cd1d240 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt @@ -0,0 +1,64 @@ +.NAME + SPUserProfileSection + +.DESCRIPTION + + This resource will create a section in a user profile service application. It + creates, update or delete a section using the parameters that are passed in to it. + + If no DisplayOrder is added then SharePoint will automatically assigned an ID to it. + +.PARAMETER Name + Key - string + The internal name of the user profile section + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the section should exist, absent if it should be removed + +.PARAMETER UserProfileService + Required - string + The name of the user profile service application this section exists in + +.PARAMETER DisplayName + Write - string + The display name of the section + +.PARAMETER DisplayOrder + Write - uint32 + A number used to sort sections by + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds a new section for profile properties to the specified + user profile service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileSection PersonalInformationSection + { + Name = "PersonalInformationSection" + UserProfileService = "User Profile Service Application" + DisplayName = "Personal Information" + DisplayOrder = 5000 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt index 330ca8f82..c1e84d353 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt @@ -1,35 +1,24 @@ .NAME SPUserProfileServiceApp -.SYNOPSIS - -This resource will provision an instance of the user profile service to the farm. -It creates the required databases using the parameters that are passed in to it (although these are only used during the initial provisioning). -The farm account is used during the provisioning of the service only (in the set method), and the install account is used in the get and test methods. -This is done to ensure that the databases are created with the correct schema owners and allow the user profile sync service to operate correctly. - -.EXAMPLE - - SPUserProfileServiceApp UserProfileServiceApp - { - Name = "User Profile Service Application" - ApplicationPool = "SharePoint Service Applications" - MySiteHostLocation = "http://my.sharepoint.contoso.local" - ProfileDBName = "SP_UserProfiles" - ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" - SocialDBName = "SP_Social" - SocialDBServer = "SQL.contoso.local\SQLINSTANCE" - SyncDBName = "SP_ProfileSync" - SyncDBServer = "SQL.contoso.local\SQLINSTANCE" - EnableNetBIOS = $false - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - +.DESCRIPTION + + This resource will provision an instance of the user profile service to the farm. It + creates the required databases using the parameters that are passed in to it (although + these are only used during the initial provisioning). The farm account is used during + the provisioning of the service only (in the set method), and the install account is + used in the get and test methods. This is done to ensure that the databases are created + with the correct schema owners and allow the user profile sync service to operate + correctly. + .PARAMETER Name Key - string The name of the user profile service +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER ApplicationPool Required - string The name of the application pool to run the service app in @@ -77,6 +66,43 @@ This is done to ensure that the databases are created with the correct schema ow .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds a new user profile service application to the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileServiceApp UserProfileServiceApp + { + Name = "User Profile Service Application" + ApplicationPool = "SharePoint Service Applications" + MySiteHostLocation = "http://my.sharepoint.contoso.local" + ProfileDBName = "SP_UserProfiles" + ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" + SocialDBName = "SP_Social" + SocialDBServer = "SQL.contoso.local\SQLINSTANCE" + SyncDBName = "SP_ProfileSync" + SyncDBServer = "SQL.contoso.local\SQLINSTANCE" + EnableNetBIOS = $false + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt index 314d1ada6..8bfd9d7ba 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt @@ -1,24 +1,14 @@ .NAME SPUserProfileServiceAppPermissions -.SYNOPSIS - -This resource will apply permissions to a user profile service application. -These can control access to create my sites, use social features, and use tagging. -If you want to allow all users the ability to use a specific permisisons include "Everyone" as a user in the corresponding property. -To specify that there should be no permissions on a type, use "none" - -.EXAMPLE - - SPUserProfileServiceAppPermissions UPAPermissions - { - ProxyName = "User Profile Service Application Proxy" - CreatePersonalSite = @("DEMO\Group", "DEMO\User1") - FollowAndEditProfile = @("Everyone") - UseTagsAndNotes = @("None") - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource will apply permissions to a user profile service application. + These can control access to create my sites, use social features, and use + tagging. If you want to allow all users the ability to use a specific + permisisons include "Everyone" as a user in the corresponding property. To + specify that there should be no permissions on a type, use "none" + .PARAMETER ProxyName Key - string The name of the proxy that is attached to the user profile service you wish to set permissions for @@ -40,3 +30,30 @@ To specify that there should be no permissions on a type, use "none" POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 +.EXAMPLE + This example applies permissions for the user profile service application to limit + access to specific features. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileServiceAppPermissions UPAPermissions + { + ProxyName = "User Profile Service Application Proxy" + CreatePersonalSite = @("DEMO\Group", "DEMO\User1") + FollowAndEditProfile = @("Everyone") + UseTagsAndNotes = @("None") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt index 6092dfe32..d1dea426c 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt @@ -1,27 +1,12 @@ .NAME SPUserProfileSyncConnection -.SYNOPSIS - -This resource will ensure a specifc user profile sync connection is in place and that it is configured accordingly to its definition - -This resource currently supports AD only. -.EXAMPLE - - SPUserProfileSyncConnection MainDomain - { - UserProfileService = "User Profile Service Application" - Forest = "contoso.com" - Name = "Contoso" - ConnectionCredentials = $connectionCredential - Server = "server.contoso.com" - UseSSL = $false - IncludedOUs = @("OU=SharePoint Users,DC=Contoso,DC=com") - ExcludedOUs = @("OU=Notes Usersa,DC=Contoso,DC=com") - Force = $false - ConnectionType = "ActiveDirectory" -} - +.DESCRIPTION + + This resource will ensure a specifc user profile sync connection is in place and + that it is configured accordingly to its definition + + This resource currently supports AD only. .PARAMETER Name Key - string The name of the connection @@ -65,6 +50,43 @@ This resource currently supports AD only. .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds a new user profile sync connection to the specified user + profile service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $ConnectionAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileSyncConnection MainDomain + { + UserProfileService = "User Profile Service Application" + Forest = "contoso.com" + Name = "Contoso" + ConnectionCredentials = $ConnectionAccount + Server = "server.contoso.com" + UseSSL = $false + IncludedOUs = @("OU=SharePoint Users,DC=Contoso,DC=com") + ExcludedOUs = @("OU=Notes Usersa,DC=Contoso,DC=com") + Force = $false + ConnectionType = "ActiveDirectory" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt index c2a50ffbd..c01b68f8e 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt @@ -1,24 +1,19 @@ .NAME SPUserProfileSyncService -.SYNOPSIS - -This resource is responsible for ensuring that the user profile sync service has been provisioned (Ensure = "Present") or is not running (Ensure = "Absent") on the current server. -This resource uses the InstallAccount to validate the current state only, the set method which will do the provisioning uses the FarmAccount to do the actual work - this means that CredSSP authentication will need to be permitted to allow a connection to the local server. -To allow successful provisioning the farm account must be in the local administrators group, however it is not best practice to leave this account in the Administrators group. -Therefore this resource will add the FarmAccount credential to the local administrators group at the beginning of the set method, and then remove it once it has completed its work. - -.EXAMPLE - - SPUserProfileSyncService UserProfileSyncService - { - UserProfileServiceAppName = "User Profile Service Application" - Ensure = "Present" - FarmAccount = $FarmAccount - RunOnlyWhenWriteable = $true - InstallAccount = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for ensuring that the user profile sync service has + been provisioned (Ensure = "Present") or is not running (Ensure = "Absent") on the + current server. This resource uses the InstallAccount to validate the current state + only, the set method which will do the provisioning uses the FarmAccount to do the + actual work - this means that CredSSP authentication will need to be permitted to + allow a connection to the local server. To allow successful provisioning the farm + account must be in the local administrators group, however it is not best practice + to leave this account in the Administrators group. Therefore this resource will add + the FarmAccount credential to the local administrators group at the beginning of the + set method, and then remove it once it has completed its work. + .PARAMETER UserProfileServiceAppName Key - string The name of the user profile service for this sync instance @@ -38,6 +33,36 @@ Therefore this resource will add the FarmAccount credential to the local adminis .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example provisions the user profile sync service to the local server + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileSyncService UserProfileSyncService + { + UserProfileServiceAppName = "User Profile Service Application" + Ensure = "Present" + FarmAccount = $FarmAccount + RunOnlyWhenWriteable = $true + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt index 12eb617cb..91afb8247 100644 --- a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt @@ -1,19 +1,12 @@ .NAME SPVisioServiceApp -.SYNOPSIS - -This resource is responsible for creating Visio Graphics Service Application instances within the local SharePoint farm. -The resource will provision and configure the Visio Graphics Service Application. -.EXAMPLE - SPVisioServiceApp VisioServices - { - Name = "Visio Graphics Service Application" - ApplicationPool = "SharePoint Web Services" - Ensure = "Present" - InstallAccount = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for creating Visio Graphics Service Application instances + within the local SharePoint farm. The resource will provision and configure the Visio + Graphics Service Application. + .PARAMETER Name Key - string The name of the service application @@ -29,6 +22,57 @@ The resource will provision and configure the Visio Graphics Service Application .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new visio services service app in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPVisioServiceApp VisioServices + { + Name = "Visio Graphics Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove a visio services service app in the local farm. + The ApplicationPool property is still requried but is not used when removing, so + the value used here doesn't matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPVisioServiceApp VisioServices + { + Name = "Visio Graphics Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt index 6ade4c860..689fe8b5d 100644 --- a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt @@ -1,25 +1,11 @@ .NAME SPWeb -.SYNOPSIS - -This resource will provision a SPWeb based on the settings that are passed through. -These settings map to the New-SPWeb cmdlet and accept the same values and types. - -.EXAMPLE - - SPWeb TeamSite - { - Url = "http://sharepoint.contoso.com/sites/site/subweb" - Name = "Team Sites" - Ensure = "Present" - Description = "A place to share documents with your team." - Template = "STS#0" - Language = 1033 - AddToTopNav = $true - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource will provision a SPWeb based on the settings that are passed through. + These settings map to the New-SPWeb cmdlet and accept the same values and types. + .PARAMETER Url Key - string The URL of the web @@ -63,6 +49,35 @@ These settings map to the New-SPWeb cmdlet and accept the same values and types. .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys a subsite in a specific location + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWeb TeamSite + { + Url = "http://sharepoint.contoso.com/sites/site/subweb" + Name = "Team Sites" + Ensure = "Present" + Description = "A place to share documents with your team." + Template = "STS#0" + Language = 1033 + AddToTopNav = $true + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt index 09f92d3b4..cdf57f442 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt @@ -1,26 +1,20 @@ .NAME SPWebAppBlockedFileTypes -.SYNOPSIS - -This resource is responsible for controlling the blocked file type setting on a specific web application. -It has two modes of operation, the first is to use the "blocked" property, where you are able to define a specific list of file types that will be blocked. -In this mode when it is detected that the list does not match the local farm, it is set to match this list exactly. -The second mode is to use the "EnsureBlocked" and "EnsureAllowed" properties. -EnsureBlocked will check to make sure that the specified file types are on the list, and if not they will be added. -EnsureAllowed checks to make sure that a file type is not on the list, and if it is it will be removed. -Both of these properties will only make changes to the file types in their list and will leave the full list as it is otherwise, whereas the blocked property resets the list in full. - -.EXAMPLE - - SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes - { - Url = "Shttp://exmaple.contoso.local" - EnsureBlocked = @("exe", "dll", "msi") - EnsureAllowed = @("pdf", "docx", "xlsx") - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for controlling the blocked file type setting on a + specific web application. It has two modes of operation, the first is to use the + "blocked" property, where you are able to define a specific list of file types that + will be blocked. In this mode when it is detected that the list does not match the + local farm, it is set to match this list exactly. The second mode is to use the + "EnsureBlocked" and "EnsureAllowed" properties. EnsureBlocked will check to make + sure that the specified file types are on the list, and if not they will be added. + EnsureAllowed checks to make sure that a file type is not on the list, and if it is + it will be removed. Both of these properties will only make changes to the file types + in their list and will leave the full list as it is otherwise, whereas the blocked + property resets the list in full. + .PARAMETER Url Key - string The URL of the web application to set blocked file types for @@ -39,6 +33,58 @@ Both of these properties will only make changes to the file types in their list .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure that specific file types are always blocked while + others will always be allowed. Any file types not mentioned in this config will be + able to be managed manually. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes + { + Url = "http://exmaple.contoso.local" + EnsureBlocked = @("exe", "dll", "msi") + EnsureAllowed = @("pdf", "docx", "xlsx") + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure that the blocked file type list always + specifically matches this list. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes + { + Url = "http://exmaple.contoso.local" + Blocked = @("exe", "dll", "msi") + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt index d77d8ba03..301c4a45f 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt @@ -1,23 +1,14 @@ .NAME SPWebAppGeneralSettings -.SYNOPSIS - -This resource is responsible for setting web application settings that are found under the "general settings" screen in central admin. -The web application is specified through the URL property, and then any combination of settings can be applied. -Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). - -.EXAMPLE - - SPWebAppGeneralSettings PrimaryWebAppGeneralSettings - { - Url = "Shttp://exmaple.contoso.local" - TimeZone = 76 - Alerts = $true - RSS = $false - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for setting web application settings that are found + under the "general settings" screen in central admin. The web application is + specified through the URL property, and then any combination of settings can be + applied. Any settings not included will be left as the default (or whatever they + have been manually changed to within SharePoint). + .PARAMETER Url Key - string The URL of the web app to set the general settings for @@ -101,6 +92,33 @@ Any settings not included will be left as the default (or whatever they have bee .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply some of the available general settings to the + specified web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppGeneralSettings PrimaryWebAppGeneralSettings + { + Url = "http://exmaple.contoso.local" + TimeZone = 76 + Alerts = $true + RSS = $false + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt index bf600590a..8e577b099 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt @@ -1,31 +1,14 @@ .NAME SPWebAppPermissions -.SYNOPSIS - -This resource is responsible for managing the user permissions for a web application. -You can either specify to set all permissions or specify individual permissions per category. - -More info about the permission levels: https://technet.microsoft.com/en-us/library/cc721640.aspx - -.EXAMPLE - - SPWebAppPermissions WebApplicationPermissions - { - WebAppUrl = "https://intranet.sharepoint.contoso.com" - ListPermissions = "Manage Lists","Override List Behaviors","Add Items","Edit Items","Delete Items","View Items","Approve Items","Open Items","View Versions","Delete Versions","Create Alerts","View Application Pages" - SitePermissions = "Manage Permissions","View Web Analytics Data","Create Subsites","Manage Web Site","Add and Customize Pages","Apply Themes and Borders","Apply Style Sheets","Create Groups","Browse Directories","Use Self-Service Site Creation","View Pages","Enumerate Permissions","Browse User Information","Manage Alerts","Use Remote Interfaces","Use Client Integration Features","Open","Edit Personal User Information" - PersonalPermissions = "Manage Personal Views","Add/Remove Personal Web Parts","Update Personal Web Parts" - PsDscRunAsAccount = $InstallAccount - } - - SPWebAppPermissions WebApplicationPermissions - { - Path = "https://portal.sharepoint.contoso.com" - AllPermissions = $true - PsDscRunAsAccount = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for managing the user permissions for a web application. + You can either specify to set all permissions or specify individual permissions per + category. + + More info about the permission levels: https://technet.microsoft.com/en-us/library/cc721640.aspx + .PARAMETER WebAppUrl Key - string The url of the web application @@ -51,6 +34,56 @@ More info about the permission levels: https://technet.microsoft.com/en-us/libra .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to limit the available permisions within a web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPermissions WebApplicationPermissions + { + WebAppUrl = "https://intranet.sharepoint.contoso.com" + ListPermissions = "Manage Lists","Override List Behaviors","Add Items","Edit Items","Delete Items","View Items","Approve Items","Open Items","View Versions","Delete Versions","Create Alerts","View Application Pages" + SitePermissions = "Manage Permissions","View Web Analytics Data","Create Subsites","Manage Web Site","Add and Customize Pages","Apply Themes and Borders","Apply Style Sheets","Create Groups","Browse Directories","Use Self-Service Site Creation","View Pages","Enumerate Permissions","Browse User Information","Manage Alerts","Use Remote Interfaces","Use Client Integration Features","Open","Edit Personal User Information" + PersonalPermissions = "Manage Personal Views","Add/Remove Personal Web Parts","Update Personal Web Parts" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure all permissions are available for a web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPermissions WebApplicationPermissions + { + WebAppUrl = "https://portal.sharepoint.contoso.com" + AllPermissions = $true + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt index 6747b73fe..ff529de9b 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt @@ -1,61 +1,24 @@ .NAME SPWebAppPolicy -.SYNOPSIS - -This resource is used to set the User Policies for web applications. -The usernames can be either specified in Classic or Claims format, both will be accepted. -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. - -Requirements: -At least one of the Members, MemberToInclude or MembersToExclude properties needs to be specified. -Do not combine the Members property with the MemberToInclude and MembersToExclude properties. -Do not set the ActAsSystemAccount property to $true without setting the permission level to Full Control. - -.EXAMPLE - - SPWebAppPolicy WebAppPolicy - { - WebAppUrl = "http://sharepoint.contoso.com" - Members = @( - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user1" - PermissionLevel = "Full Control" - ActAsSystemAccount = $true - }) - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\Group 1" - PermissionLevel = "Full Read" - IdentityType = "Claims" - }) - ) - PsDscRunAsCredential = $InstallAccount - } - - SPWebAppPolicy WebAppPolicy - { - WebAppUrl = "http://sharepoint.contoso.com" - MembersToInclude = @( - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user1" - PermissionLevel = "Full Control" - }) - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user2" - PermissionLevel = "Full Read" - }) - ) - MembersToExclude = @( - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user3" - }) - ) - SetCacheAccountsPolicy = $true - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to set the User Policies for web applications. The usernames + can be either specified in Classic or Claims format, both will be accepted. 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. + + Requirements: + At least one of the Members, MemberToInclude or MembersToExclude properties needs to be + specified. Do not combine the Members property with the MemberToInclude and + MembersToExclude properties. Do not set the ActAsSystemAccount property to $true without + setting the permission level to Full Control. + .PARAMETER WebAppUrl Key - string The URL of the web application @@ -78,6 +41,82 @@ Do not set the ActAsSystemAccount property to $true without setting the permissi .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example sets the specific web app policy for the specified web app to + match the provided list below. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPolicy WebAppPolicy + { + WebAppUrl = "http://sharepoint.contoso.com" + Members = @( + MSFT_SPWebPolicyPermissions { + Username = "contoso\user1" + PermissionLevel = "Full Control" + ActAsSystemAccount = $true + } + MSFT_SPWebPolicyPermissions { + Username = "contoso\Group 1" + PermissionLevel = "Full Read" + IdentityType = "Claims" + } + ) + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to include specific members while excluding other members + from the policy of the web app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPolicy WebAppPolicy + { + WebAppUrl = "http://sharepoint.contoso.com" + MembersToInclude = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user1" + PermissionLevel = "Full Control" + }) + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user2" + PermissionLevel = "Full Read" + }) + ) + MembersToExclude = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user3" + }) + ) + SetCacheAccountsPolicy = $true + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt index 635b3af1e..3a214faf9 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt @@ -1,29 +1,17 @@ .NAME SPWebAppProxyGroup -.SYNOPSIS - -This resource is used to associate a web application to a service application proxy group. -Use the proxy group name "Default" to associate the web application to the default proxy group. -A web applicaiton can only connect to a single service application proxy group. This resource will overright the existing service application proxy group association. - -This resource is used in conjunction with the SPServiceAppProxyGroup resource, which creates the proxy groups and associates the desired service application proxies with it. Within your configuration, that resource should be a dependancy for the SPWebAppProxyGroup resource. - -.EXAMPLE - - SPWebAppProxyGroup ContosoWeb - { - WebAppUrl = "https://web.contoso.com" - ServiceAppProxyGroup = "Proxy Group 1" - } - - SPWebAppProxyGroup DefaultPortal - { - WebAppUrl = "https://portal.contoso.com" - ServiceAppProxyGroup = "Default" - } - - +.DESCRIPTION + + This resource is used to associate a web application to a service application proxy group. + Use the proxy group name "Default" to associate the web application to the default proxy + group. A web applicaiton can only connect to a single service application proxy group. This + resource will overright the existing service application proxy group association. + + This resource is used in conjunction with the SPServiceAppProxyGroup resource, which creates + the proxy groups and associates the desired service application proxies with it. Within your + configuration, that resource should be a dependancy for the SPWebAppProxyGroup resource. + .PARAMETER WebAppUrl Key - String URL of the web application @@ -34,6 +22,30 @@ This resource is used in conjunction with the SPServiceAppProxyGroup resource, w .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to assign a specific proxy group to the specified web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppProxyGroup ContosoWeb + { + WebAppUrl = "https://web.contoso.com" + ServiceAppProxyGroup = "Proxy Group 1" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt index d47f8838e..db414ea67 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt @@ -1,23 +1,13 @@ .NAME SPWebAppSiteUseAndDeletion -.SYNOPSIS - -This resource is responsible for controlling the Site Use and Deletion settings on a specific web application. -You can enable or disable the Site Use and Deletion feature, specify the amount of days after which the alerts are being send, if sites have to be deleted automatically and if so after how many days this has to be done. - -.EXAMPLE - - SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion - { - Url = "http://example.contoso.local" - SendUnusedSiteCollectionNotifications = $true - UnusedSiteNotificationPeriod = 90 - AutomaticallyDeleteUnusedSiteCollections = $true - UnusedSiteNotificationsBeforeDeletion = 24 - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for controlling the Site Use and Deletion settings on a + specific web application. You can enable or disable the Site Use and Deletion feature, + specify the amount of days after which the alerts are being send, if sites have to be + deleted automatically and if so after how many days this has to be done. + .PARAMETER Url Key - string The URL of the web application @@ -40,6 +30,33 @@ You can enable or disable the Site Use and Deletion feature, specify the amount .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply site use and deletion settings to the specified web applicaiton + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion + { + Url = "http://example.contoso.local" + SendUnusedSiteCollectionNotifications = $true + UnusedSiteNotificationPeriod = 90 + AutomaticallyDeleteUnusedSiteCollections = $true + UnusedSiteNotificationsBeforeDeletion = 24 + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt index ab11f5eed..021a472d6 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt @@ -1,30 +1,16 @@ .NAME SPWebAppThrottlingSettings -.SYNOPSIS - -This resource is responsible for setting web application settings that are found under the "resource throttling" screen in central admin. -The web application is specified through the URL property, and then any combination of settings can be applied. -Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). -Happy hour is the setting used to control the window where threshold do not apply throughout the day. -You can specify the start time of this window as well as how many hours it will last. - -.EXAMPLE - - SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings - { - Url = "Shttp://exmaple.contoso.local" - ListViewThreshold = 5000 - AllowObjectModelOverride = $false - HappyHourEnabled = $true - HappyHour = MSFT_SPWebApplicationHappyHour { - Hour = 3 - Minute = 0 - Duration = 1 - } - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for setting web application settings that are found under the + "resource throttling" screen in central admin. The web application is specified through the + URL property, and then any combination of settings can be applied. Any settings not included + will be left as the default (or whatever they have been manually changed to within + SharePoint). Happy hour is the setting used to control the window where threshold do not + apply throughout the day. You can specify the start time of this window as well as how many + hours it will last. + .PARAMETER Url Key - string The URL of the web application @@ -75,6 +61,37 @@ You can specify the start time of this window as well as how many hours it will .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply throttling settings to a specific web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings + { + Url = "http://exmaple.contoso.local" + ListViewThreshold = 5000 + AllowObjectModelOverride = $false + HappyHourEnabled = $true + HappyHour = MSFT_SPWebApplicationHappyHour { + Hour = 3 + Minute = 0 + Duration = 1 + } + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt index d51ad8702..2522cb3b3 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt @@ -1,22 +1,14 @@ .NAME SPWebAppWorkflowSettings -.SYNOPSIS - -This resource is responsible for setting web application settings that are found under the "workflow settings" screen in central admin. -The web application is specified through the URL property, and then any combination of settings can be applied. -Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). - -.EXAMPLE - - SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings - { - Url = "Shttp://exmaple.contoso.local" - ExternalWorkflowParticipantsEnabled = $false - EmailToNoPermissionWorkflowParticipantsEnable = $false - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for setting web application settings that are found under the + "workflow settings" screen in central admin. The web application is specified through the + URL property, and then any combination of settings can be applied. Any settings not + included will be left as the default (or whatever they have been manually changed to within + SharePoint). + .PARAMETER Url Key - string The URL of the web application @@ -35,6 +27,31 @@ Any settings not included will be left as the default (or whatever they have bee .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply workflow settings to the specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings + { + Url = "Shttp://exmaple.contoso.local" + ExternalWorkflowParticipantsEnabled = $false + EmailToNoPermissionWorkflowParticipantsEnable = $false + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt index b76cfe717..4a116b94f 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt @@ -1,28 +1,13 @@ .NAME SPWebApplication -.SYNOPSIS - -This resource is responsible for creating a web application within the local SharePoint farm. -The resource will provision the web application with all of the current settings, and then ensure that it stays part of the correct application pool beyond that (additional checking and setting of properties will be added in future releases). - -.EXAMPLE - - SPWebApplication HostNameSiteCollectionWebApp - { - Name = "SharePoint Sites" - ApplicationPool = "SharePoint Sites" - ApplicationPoolAccount = "CONTOSO\svcSPWebApp" - AllowAnonymous = $false - AuthenticationMethod = "NTLM" - DatabaseName = "SP_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - Url = "http://example.contoso.local" - Port = 80 - Ensure = "Present" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is responsible for creating a web application within the local SharePoint + farm. The resource will provision the web application with all of the current settings, + and then ensure that it stays part of the correct application pool beyond that (additional + checking and setting of properties will be added in future releases). + .PARAMETER Name Key - string The name of the web application @@ -79,6 +64,38 @@ The resource will provision the web application with all of the current settings .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new web application in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebApplication HostNameSiteCollectionWebApp + { + Name = "SharePoint Sites" + ApplicationPool = "SharePoint Sites" + ApplicationPoolAccount = "CONTOSO\svcSPWebApp" + AllowAnonymous = $false + AuthenticationMethod = "NTLM" + DatabaseName = "SP_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + Url = "http://example.contoso.local" + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt index bdd6daa9c..1723fa314 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt @@ -1,26 +1,14 @@ .NAME SPWebApplicationAppDomain -.SYNOPSIS - -This resource will configure the App Domain at a specific zone for the given Web Application. -The configuration is done per zone on the specified web application, allowing for the setting of unique app domains for each extension of a web application. -The app prefix should still be set using the SPAppDomain resource before this is applied to customise a specific zone. - - -.EXAMPLE - - SPWebApplicationAppDomain Domain - { - AppDomain = "contosointranetapps.com" - WebApplication ="http://portal.contoso.com"; - Zone = "Default"; - Port = 80; - SSL = $false; - PsDscRunAsCredential = $InstallAccount - } - - +.DESCRIPTION + + This resource will configure the App Domain at a specific zone for the given Web + Application. The configuration is done per zone on the specified web application, + allowing for the setting of unique app domains for each extension of a web + application. The app prefix should still be set using the SPAppDomain resource + before this is applied to customise a specific zone. + .PARAMETER WebApplication Key - string The URL of the web application to set the app domain for @@ -44,6 +32,33 @@ The app prefix should still be set using the SPAppDomain resource before this is .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to set the app domain for a specified web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebApplicationAppDomain Domain + { + AppDomain = "contosointranetapps.com" + WebApplication ="http://portal.contoso.com"; + Zone = "Default"; + Port = 80; + SSL = $false; + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt index c94d9ada0..68dd5fbe6 100644 --- a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt @@ -1,51 +1,17 @@ .NAME SPWordAutomationServiceApp -.SYNOPSIS - -The resource is able to provision, unprovision and configure the Word Automation Service Application. -All settings that you can configure on the Service Application administration page are configurable using this resource. - -Important: -When you specify Ensure=Present, the Application Pool and DatabaseName parameters are required. -When you specify Ensure=Absent, no other parameters are allowed (with the exception of Name, InstallAccount or PsDscRunAsCredential). - -.EXAMPLE - -Make sure the service application exists and has a specific configuration - - SPWordAutomationServiceApp Word Automation - { - Name = "Word Automation Service Application" - Ensure = "Present" - ApplicationPool = "SharePoint Web Services" - DatabaseName = "WordAutomation_DB" - DatabaseServer = "SQLServer" - SupportedFileFormats = "docx", "doc", "mht", "rtf", "xml" - DisableEmbeddedFonts = $false - MaximumMemoryUsage = 100 - RecycleThreshold = 100 - DisableBinaryFileScan = $false - ConversionProcesses = 8 - JobConversionFrequency = 15 (in minutes) - NumberOfConversionsPerProcess = 12 - TimeBeforeConversionIsMonitored = 5 (in minutes) - MaximumConversionAttempts = 2 - MaximumSyncConversionRequests = 25 - KeepAliveTimeout = 30 (in seconds) - MaximumConversionTime = 300 (in seconds) - PsDscRunAsCredential = $InstallAccount - } - -Make sure the service application does not exist and remove when it does - - SPWordAutomationServiceApp Word Automation - { - Name = "Word Automation Service Application" - Ensure = "Absent" - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + The resource is able to provision, unprovision and configure the Word Automation Service + Application. All settings that you can configure on the Service Application administration + page are configurable using this resource. + + Important: + When you specify Ensure=Present, the Application Pool and DatabaseName parameters are + required. When you specify Ensure=Absent, no other parameters are allowed (with the exception + of Name, InstallAccount or PsDscRunAsCredential). + .PARAMETER Name Key - string THe name of the service application @@ -122,6 +88,70 @@ Make sure the service application does not exist and remove when it does .PARAMETER InstallAccount Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example makes sure the service application exists and has a specific configuration + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWordAutomationServiceApp WordAutomation + { + Name = "Word Automation Service Application" + Ensure = "Present" + ApplicationPool = "SharePoint Web Services" + DatabaseName = "WordAutomation_DB" + DatabaseServer = "SQLServer" + SupportedFileFormats = "docx", "doc", "mht", "rtf", "xml" + DisableEmbeddedFonts = $false + MaximumMemoryUsage = 100 + RecycleThreshold = 100 + DisableBinaryFileScan = $false + ConversionProcesses = 8 + JobConversionFrequency = 15 + NumberOfConversionsPerProcess = 12 + TimeBeforeConversionIsMonitored = 5 + MaximumConversionAttempts = 2 + MaximumSyncConversionRequests = 25 + KeepAliveTimeout = 30 + MaximumConversionTime = 300 + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a word automation service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWordAutomationServiceApp WordAutomation + { + Name = "Word Automation Service Application" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } diff --git a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt index 83b77cad4..7e30c2d5f 100644 --- a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt @@ -1,32 +1,27 @@ .NAME SPWorkManagementServiceApp -.SYNOPSIS - -This resource is used to provision and manage an instance of the Work Management Services Service Application. -It will identify an instance of the work 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. - - -Remarks -- Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in Minutes - - - -.EXAMPLE - - SPWorkManagementServiceApp WorkManagementServiceApp - { - Name = "Work Management Service Application" - ApplicationPool = "SharePoint web services" - MinimumTimeBetweenEwsSyncSubscriptionSearches = 10 - PsDscRunAsCredential = $InstallAccount - } - +.DESCRIPTION + + This resource is used to provision and manage an instance of the Work Management Services + Service Application. It will identify an instance of the work 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. + + + Remarks + - Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, MinimumTimeBetweenProviderRefreshes, + MinimumTimeBetweenSearchQueries are in Minutes + .PARAMETER Name Key - string The name of the work management service application +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -62,6 +57,31 @@ Remarks .PARAMETER InstallAccount Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates a new work management service app in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWorkManagementServiceApp WorkManagementServiceApp + { + Name = "Work Management Service Application" + ApplicationPool = "SharePoint web services" + MinimumTimeBetweenEwsSyncSubscriptionSearches = 10 + PsDscRunAsCredential = $SetupAccount + } + } + } From 80c192af69c5d63e13fecf3fd4ad0e33908d39aa Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Thu, 27 Oct 2016 09:56:41 +1100 Subject: [PATCH 04/18] Updated documentation --- .../en-us/about_SPAppCatalog.help.txt | 2 +- .../en-us/about_SPAppStoreSettings.help.txt | 98 +++++++++++++++++++ .../en-us/about_SPExcelServiceApp.help.txt | 71 ++++++++++++++ .../en-us/about_SPProductUpdate.help.txt | 9 ++ .../en-us/about_SPVisioServiceApp.help.txt | 4 + 5 files changed, 183 insertions(+), 1 deletion(-) create mode 100644 Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt diff --git a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt index 576b5e336..112ef45cf 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt @@ -17,7 +17,7 @@ .EXAMPLE - This example shows how to apply specific anti-virus configuration to the farm + This example shows how to configure the AppCatalog in the farm Configuration Example diff --git a/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt new file mode 100644 index 000000000..5ab234e60 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt @@ -0,0 +1,98 @@ +.NAME + SPAppStoreSettings + +.DESCRIPTION + + This resource will configure the ability to purchase apps for both SharePoint and Office apps. + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER AllowAppPurchases + Write - Boolean + Specifies if App Purchases from the SharePoint Store are allowed + +.PARAMETER AllowAppsForOffice + Write - Boolean + Specifies if App Purchases for Office applications are allowed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppStoreSettings EnableSharePointAppStore + { + WebAppUrl = "https://sharepoint.contoso.com" + AllowAppPurchases = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppStoreSettings EnableAppStores + { + WebAppUrl = "https://sharepoint.contoso.com" + AllowAppPurchases = $true + AllowAppsForOffice = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppStoreSettings DisableAppStores + { + WebAppUrl = "https://sharepoint.contoso.com" + AllowAppPurchases = $false + AllowAppsForOffice = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt index c68fb3d8f..0d8f16088 100644 --- a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt @@ -15,6 +15,77 @@ Required - string The name of the application pool to run the service app in +.PARAMETER TrustedFileLocations + Write - string + Trusted file locations for the service app + +.PARAMETER CachingOfUnusedFilesEnable + Write - Boolean + Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. + +.PARAMETER CrossDomainAccessAllowed + Write - Boolean + Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. + +.PARAMETER EncryptedUserConnectionRequired + Write - String + Allowed values: None, Connection + Requires that encryption is used between the end-user and the server running Excel Services Application. + +.PARAMETER ExternalDataConnectionLifetime + Write - Uint32 + Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. + +.PARAMETER FileAccessMethod + Write - String + Allowed values: UseImpersonation, UseFileAccessAccount + Specifies the authentication method that Excel Services Application uses to retrieve files. + +.PARAMETER LoadBalancingScheme + Write - String + Allowed values: RoundRobin, Local, WorkbookURL + Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers. + +.PARAMETER MemoryCacheThreshold + Write - Uint32 + Specifies the percentage of the maximum private bytes that can be allocated to inactive objects. + +.PARAMETER PrivateBytesMax + Write - Uint32 + Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. + +.PARAMETER SessionsPerUserMax + Write - Uint32 + Specifies the maximum number of sessions allowed for a user. + +.PARAMETER SiteCollectionAnonymousSessionsMax + Write - Uint32 + Specifies the maximum number of anonymous sessions allowed per site collection. + +.PARAMETER TerminateProcessOnAccessViolation + Write - Boolean + Terminates Excel Services Application when an access violation occurs in the process. + +.PARAMETER ThrottleAccessViolationsPerSiteCollection + Write - Uint32 + Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbook’s site collection are blocked from loading for the specified period (in seconds). + +.PARAMETER UnattendedAccountApplicationId + Write - String + Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter. + +.PARAMETER UnusedObjectAgeMax + Write - Uint32 + Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. + +.PARAMETER WorkbookCache + Write - String + Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application. + +.PARAMETER WorkbookCacheSizeMax + Write - Uint32 + Specifies the maximum allowable size, in megabytes, of an individual session. + .PARAMETER Ensure Write - string Allowed values: Present, Absent diff --git a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt index 57decedb8..3c4e2dc3f 100644 --- a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt @@ -9,6 +9,15 @@ The BinaryInstallDays and BinaryInstallTime parameters specify a window in which the update can be installed. This module requires the Configuration Wizard resource to fully complete the installation of the update, which can be done through the use of SPConfigWizard. + IMPORTANT: + This resource retrieves build information from the Configuration Database. Therefore it requires SharePoint to be installed and a farm created. + If you like to deploy a new farm and install updates automatically, you need to implement the following order: + 1. Install the SharePoint Binaries (SPInstall) + 2. (Optional) Install SharePoint Language Pack(s) Binaries (SPInstallLanguagePack) + 3. Create SPFarm (SPCreateFarm) + 4. Install Cumulative Updates (SPProductUpdate) + 5. Run the Configuration Wizard (SPConfigWizard) + .PARAMETER SetupFile Key - String The name of the update setup file diff --git a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt index 91afb8247..ca3ba5b38 100644 --- a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt @@ -15,6 +15,10 @@ Required - string The name of the application pool to run the service app in +.PARAMETER ProxyName + Write - string + The name of the Visio Service Application Proxy + .PARAMETER Ensure Write - string Allowed values: Present, Absent From 83e158415c8df671cdf449a92e3a59fd0dabbad5 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Mon, 31 Oct 2016 08:30:37 +1100 Subject: [PATCH 05/18] Fixed version number --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index fb4093509..179a0ba74 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,4 +1,4 @@ -version: 1.3.0.{build} +version: 1.4.0.{build} image: WMF 5 install: From 67accd43e17277b8422005556c996d6bb7dc9726 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Fri, 9 Dec 2016 14:01:15 +1100 Subject: [PATCH 06/18] Updates for release 1.5 --- Modules/SharePointDsc/SharePointDsc.psd1 | 50 ++++------ .../en-us/about_SPAccessServiceApp.help.txt | 8 +- .../en-us/about_SPAlternateUrl.help.txt | 9 +- .../en-us/about_SPAntivirusSettings.help.txt | 11 ++- .../en-us/about_SPAppCatalog.help.txt | 12 ++- .../en-us/about_SPAppDomain.help.txt | 6 +- .../about_SPAppManagementServiceApp.help.txt | 16 ++-- .../en-us/about_SPAppStoreSettings.help.txt | 5 +- .../en-us/about_SPBCSServiceApp.help.txt | 16 ++-- .../en-us/about_SPBlobCacheSettings.help.txt | 21 +++-- .../en-us/about_SPCacheAccounts.help.txt | 8 +- .../en-us/about_SPConfigWizard.help.txt | 10 +- .../en-us/about_SPContentDatabase.help.txt | 11 ++- .../en-us/about_SPCreateFarm.help.txt | 38 ++++---- .../en-us/about_SPDatabaseAAG.help.txt | 43 ++++++++- .../en-us/about_SPDesignerSettings.help.txt | 27 +++--- ...about_SPDiagnosticLoggingSettings.help.txt | 10 +- .../about_SPDistributedCacheService.help.txt | 36 +++---- .../en-us/about_SPExcelServiceApp.help.txt | 6 +- .../en-us/about_SPFarmAdministrators.help.txt | 20 ++-- .../en-us/about_SPFarmSolution.help.txt | 14 +-- .../en-us/about_SPFeature.help.txt | 10 +- .../about_SPHealthAnalyzerRuleState.help.txt | 6 +- .../en-us/about_SPInstall.help.txt | 12 +-- .../about_SPInstallLanguagePack.help.txt | 10 +- .../en-us/about_SPInstallPrereqs.help.txt | 30 +++--- .../en-us/about_SPIrmSettings.help.txt | 5 +- .../en-us/about_SPJoinFarm.help.txt | 18 ++-- .../en-us/about_SPManagedAccount.help.txt | 14 +-- ...about_SPManagedMetaDataServiceApp.help.txt | 12 +-- .../en-us/about_SPManagedPath.help.txt | 16 ++-- ...about_SPOfficeOnlineServerBinding.help.txt | 16 ++-- .../about_SPOutgoingEmailSettings.help.txt | 14 +-- .../about_SPPasswordChangeSettings.help.txt | 12 +-- ...bout_SPPerformancePointServiceApp.help.txt | 6 +- .../en-us/about_SPProductUpdate.help.txt | 26 +++-- ...about_SPPublishServiceApplication.help.txt | 25 ++--- .../en-us/about_SPQuotaTemplate.help.txt | 8 +- .../en-us/about_SPRemoteFarmTrust.help.txt | 8 +- .../about_SPSearchContentSource.help.txt | 5 +- .../en-us/about_SPSearchCrawlRule.help.txt | 6 +- .../en-us/about_SPSearchFileType.help.txt | 94 +++++++++++++++++++ .../about_SPSearchIndexPartition.help.txt | 27 +++--- .../en-us/about_SPSearchResultSource.help.txt | 20 ++-- .../en-us/about_SPSearchServiceApp.help.txt | 16 ++-- .../en-us/about_SPSearchTopology.help.txt | 31 +++--- .../about_SPSecureStoreServiceApp.help.txt | 10 +- .../en-us/about_SPServiceAppPool.help.txt | 8 +- .../about_SPServiceAppProxyGroup.help.txt | 25 ++--- .../en-us/about_SPServiceAppSecurity.help.txt | 26 ++--- .../en-us/about_SPServiceInstance.help.txt | 8 +- .../about_SPSessionStateService.help.txt | 8 +- .../en-us/about_SPShellAdmins.help.txt | 43 +++++---- .../SharePointDsc/en-us/about_SPSite.help.txt | 12 +-- .../en-us/about_SPStateServiceApp.help.txt | 6 +- ..._SPSubscriptionSettingsServiceApp.help.txt | 18 ++-- .../en-us/about_SPTimerJobState.help.txt | 28 +++--- ...bout_SPTrustedIdentityTokenIssuer.help.txt | 33 ++++--- .../en-us/about_SPUsageApplication.help.txt | 8 +- .../about_SPUserProfileProperty.help.txt | 16 ++-- .../en-us/about_SPUserProfileSection.help.txt | 9 +- .../about_SPUserProfileServiceApp.help.txt | 16 ++-- ...PUserProfileServiceAppPermissions.help.txt | 10 +- ...about_SPUserProfileSyncConnection.help.txt | 7 +- .../about_SPUserProfileSyncService.help.txt | 22 ++--- .../en-us/about_SPVisioServiceApp.help.txt | 8 +- .../SharePointDsc/en-us/about_SPWeb.help.txt | 6 +- .../about_SPWebAppBlockedFileTypes.help.txt | 24 ++--- .../about_SPWebAppGeneralSettings.help.txt | 12 +-- .../en-us/about_SPWebAppPermissions.help.txt | 10 +- .../en-us/about_SPWebAppPolicy.help.txt | 29 +++--- .../en-us/about_SPWebAppProxyGroup.help.txt | 17 ++-- .../about_SPWebAppSiteUseAndDeletion.help.txt | 10 +- .../about_SPWebAppThrottlingSettings.help.txt | 16 ++-- .../about_SPWebAppWorkflowSettings.help.txt | 12 +-- .../en-us/about_SPWebApplication.help.txt | 10 +- .../about_SPWebApplicationAppDomain.help.txt | 12 +-- .../about_SPWordAutomationServiceApp.help.txt | 15 +-- .../about_SPWorkManagementServiceApp.help.txt | 20 ++-- 79 files changed, 752 insertions(+), 586 deletions(-) create mode 100644 Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt diff --git a/Modules/SharePointDsc/SharePointDsc.psd1 b/Modules/SharePointDsc/SharePointDsc.psd1 index 76debd5fc..31fbaee1c 100644 --- a/Modules/SharePointDsc/SharePointDsc.psd1 +++ b/Modules/SharePointDsc/SharePointDsc.psd1 @@ -126,40 +126,22 @@ PrivateData = @{ # ReleaseNotes of this module ReleaseNotes = ' - * Set-TargetResource of Service Application now also removes all associated proxies - * Fixed issue with all SPServiceApplication for OS not in En-Us language, add GetType().FullName method in: - - SPAccessServiceApp - - SPAppManagementServiceApp - - SPBCSServiceApp - - SPExcelServiceApp - - SPManagedMetaDataServiceApp - - SPPerformancePointServiceApp - - SPSearchServiceApp - - SPSearchCrawlRule - - SPSecureStoreServiceApp - - SPSubscriptionSettingsServiceApp - - SPUsageApplication - - SPUserProfileServiceApp - - SPVisioServiceApp - - SPWordAutomationServiceApp - - SPWorkManagementServiceApp - * Fixed issue with SPServiceInstance for OS not in En-Us language, add GetType().Name method in: - - SPDistributedCacheService - - SPUserProfileSyncService - * Fixed issue with SPInstallLanguagePack to install before farm creation - * Fixed issue with mounting SPContentDatabase - * Fixed issue with SPShellAdmin and Content Database method - * Fixed issue with SPServiceInstance (Set-TargetResource) for OS not in En-Us language - * Added .Net 4.6 support check to SPInstall and SPInstallPrereqs - * Improved code styling - * SPVisioServiceapplication now creates proxy and lets you specify a name for it - * New resources: SPAppStoreSettings - * Fixed bug with SPInstallPrereqs to allow minor version changes to prereqs for SP2016 - * Refactored unit tests to consolidate and streamline test approaches - * Updated SPExcelServiceApp resource to add support for trusted file locations and most other properties of the service app - * Added support to SPMetadataServiceApp to allow changing content type hub URL on existing service apps - * Fixed a bug that would cause SPSearchResultSource to throw exceptions when the enterprise search centre URL has not been set - * Updated documentation of SPProductUpdate to reflect the required install order of product updates +* Fixed issue with SPManagedMetaDataServiceApp if ContentTypeHubUrl parameter is + null +* Added minimum PowerShell version to module manifest +* Added testing for valid markdown syntax to unit tests +* Added support for MinRole enhancements added in SP2016 Feature Pack 1 +* Fixed bug with search topology that caused issues with names of servers needing + to all be the same case +* Fixed bug in SPInstallLanguagePack where language packs could not be installed + on SharePoint 2016 +* Added new resource SPSearchFileType +* Updated SPDatabaseAAG to allow database name patterns +* Fixed a bug were PerformancePoint and Excel Services Service Application + proxies would not be added to the default proxy group when they are + provisioned +* Added an error catch to provide more detail about running SPAppCatalog with + accounts other than the farm account ' } # End of PSData hashtable diff --git a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt index 05cb6156a..97a87c451 100644 --- a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt @@ -1,11 +1,11 @@ .NAME SPAccessServiceApp -.DESCRIPTION +# Description - This resource is responsible for creating Access Services Application instances within the local - SharePoint farm. The resource will provision and configure the Access Services Service - Application. + This resource is responsible for creating Access Services Application instances + within the local SharePoint farm. The resource will provision and configure the + Access Services Service Application. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt index 38241556d..7b760f0c1 100644 --- a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt @@ -1,11 +1,12 @@ .NAME SPAlternateUrl -.DESCRIPTION +# Description - This resource is used to define an alternate access mapping URL for a specified web application. - These can be assigned to specific zones for each web application. Alternatively a URL can be - removed from a zone to ensure that it will remain empty and have no alternate URL. + This resource is used to define an alternate access mapping URL for a specified + web application. These can be assigned to specific zones for each web + application. Alternatively a URL can be removed from a zone to ensure that it + will remain empty and have no alternate URL. .PARAMETER WebAppUrl Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt index 12596784b..e5310458b 100644 --- a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt @@ -1,12 +1,13 @@ .NAME SPAntivirusSettings -.DESCRIPTION +# 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. + 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. .PARAMETER ScanOnDownload Key - Boolean diff --git a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt index 112ef45cf..7503bc167 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt @@ -1,11 +1,15 @@ .NAME SPAppCatalog -.DESCRIPTION +# 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). + 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). + + This resource should be run using the farm account, and not another specific + setup account. Running this with the setup account you have used in your + configuration may relate to access denied errors. .PARAMETER SiteUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt index 249705dcd..a0dd1da87 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt @@ -1,10 +1,10 @@ .NAME SPAppDomain -.DESCRIPTION +# 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. + 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. .PARAMETER AppDomain Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt index adc96454f..19a8de71d 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt @@ -1,14 +1,16 @@ .NAME SPAppManagementServiceApp -.DESCRIPTION +# 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. + 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. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt index 5ab234e60..20fc57d6c 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt @@ -1,9 +1,10 @@ .NAME SPAppStoreSettings -.DESCRIPTION +# Description - This resource will configure the ability to purchase apps for both SharePoint and Office apps. + This resource will configure the ability to purchase apps for both SharePoint + and Office apps. .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt index 5ffa7d311..ce665a340 100644 --- a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt @@ -1,14 +1,16 @@ .NAME SPBCSServiceApp -.DESCRIPTION +# 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. + 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. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt index 8a416d7e6..f1bf121a8 100644 --- a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt @@ -1,23 +1,26 @@ .NAME SPBlobCacheSettings -.DESCRIPTION +# Description - This resource is used to configure the Blob Cache settings for a web application. + This resource is used to configure the Blob Cache settings for a web + application. Important: - This resource only configures the local server. It changes the web.config file directly - and is NOT using the SPWebConfigModifications class. In order to configure all WFE servers - in the farm, you have to apply this resource to all servers. + This resource only configures the local server. It changes the web.config + file directly and is NOT using the SPWebConfigModifications class. In order + to configure all WFE servers in the farm, you have to apply this resource + to all servers. Note: - - In order to prevent inconsistancy between different web front end servers, make sure you - configure this setting on all servers equally. + + - In order to prevent inconsistancy between different web front end servers, + make sure you configure this setting on all servers equally. - If the specified folder does not exist, the resource will create the folder. Best practice: - Specify a directory that is not on the same drive as where either the server operating system - swap files or server log files are stored. + Specify a directory that is not on the same drive as where either the server + operating system swap files or server log files are stored. .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt index 407091fc6..cdc335f2d 100644 --- a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt @@ -1,11 +1,11 @@ .NAME SPCacheAccounts -.DESCRIPTION +# 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)). + 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)). .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt index e5a65e2de..c61bfe6e6 100644 --- a/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt @@ -1,11 +1,13 @@ .NAME SPConfigWizard -.DESCRIPTION +# Description - This resource is used to perform the upgrade step of installing SharePoint updates, like Cumulative Updates, Service Packs and Language Packs. - The DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in which the update can be installed. - This module has to be used to complete the update installation step, performed by SPProductUpdate. + This resource is used to perform the upgrade step of installing SharePoint + updates, like Cumulative Updates, Service Packs and Language Packs. The + DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in + which the update can be installed. This module has to be used to complete the + update installation step, performed by SPProductUpdate. .PARAMETER Ensure Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt index 9494478cd..3d4e5a760 100644 --- a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt @@ -1,12 +1,13 @@ .NAME SPContentDatabase -.DESCRIPTION +# Description - This resource is used to add and remove Content Databases to web applications and configure - these databases. Note: The resource cannot be used to move the database to a different - SQL instance. It will throw an error when it detects that the specified SQL instance is a - different instance that is currently in use. + This resource is used to add and remove Content Databases to web applications + and configure these databases. Note: The resource cannot be used to move the + database to a different SQL instance. It will throw an error when it detects + that the specified SQL instance is a different instance that is currently in + use. .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt index 55d41388a..9b4ee349a 100644 --- a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt @@ -1,27 +1,31 @@ .NAME SPCreateFarm -.DESCRIPTION +# 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 SPJoinFarm. Once the config DB has - been created, the resource will install local help collections, secure resources, activate + 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 SPJoinFarm. 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 passphrase is passed as a Credential object.The username of this credential is ignored, only - the value of the password is used as the farm passphrase. + The passphrase is passed as a Credential object.The username of this + credential is ignored, only the value of the password is used as the farm + passphrase. - 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 SPDistributedCacheService on at - least one server in the farm to designate it as a cache server. + 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 SPDistributedCacheService on at least one server in the farm to + designate it as a cache server. - CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not specified, it defaults - to NTLM. If using Kerberos, make sure to have appropriate SPNs setup for Farm account and Central - Administration URI. + CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not + specified, it defaults to NTLM. If using Kerberos, make sure to have + appropriate SPNs setup for Farm account and Central Administration URI. .PARAMETER FarmConfigDatabaseName Key - String @@ -54,7 +58,7 @@ .PARAMETER ServerRole Write - string - Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd + Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache SharePoint 2016 only - the MinRole role to enroll this server as .PARAMETER InstallAccount diff --git a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt index 3e6224eff..88c8d3578 100644 --- a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt @@ -1,11 +1,20 @@ .NAME SPDatabaseAAG -.DESCRIPTION +# Description - This resource will allow specifying which SQL Server AlwaysOn Availability group a - resource should be in. This resource does not configure the Availability Groups on - SQL Server, they must already exist. It simply adds the specified database to the group. + This resource will allow specifying which SQL Server AlwaysOn Availability + group a resource should be in. This resource does not configure the + Availability Groups on SQL Server, they must already exist. It simply adds + the specified database to the group. + + You can add a single database name by specifying the database name, or + multiple databases by specifying wildcards. For example: + SP_Content* or *Content* + + Important: + This resource requires the April 2014 CU to be installed. The required + cmdlets have been added in this CU: http://support.microsoft.com/kb/2880551 .PARAMETER DatabaseName Key - string @@ -55,6 +64,32 @@ } +.EXAMPLE + This example takes existing SharePoint databases, based on the database name pattern, and puts + them in to the specified AlwaysOn Availability Group (AAG). + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "*Content*" + AGName = "MyAvailabilityGroup" + FileShare = "\\SQL\Backups" + PsDscRunAsCredential = $SetupAccount + } + } + } + + .EXAMPLE This example removes a database from the specified AlwaysOn Availability Group (AAG) diff --git a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt index 85679ed9a..29abe027d 100644 --- a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt @@ -1,23 +1,24 @@ .NAME SPDesignerSettings -.DESCRIPTION +# 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. + 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. + 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. + 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 .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt index c664698f4..b66029c17 100644 --- a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt @@ -1,12 +1,12 @@ .NAME SPDiagnosticLoggingSettings -.DESCRIPTION +# 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. + 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 .PARAMETER LogPath Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt index 53f0d3a37..3efe3a103 100644 --- a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt @@ -1,25 +1,27 @@ .NAME SPDistributedCacheService -.DESCRIPTION +# 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 - SPCreateFarm and SPJoinFarm 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. + 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 SPCreateFarm and SPJoinFarm 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. - The ServerProvisionOrder optional property is used when a pull server is handing out - configurations to nodes in order to tell this resource about a specific order of enabling - the caches. This allows for multiple servers to receive the same configuration, but they - will always check for the server before them in the list first to ensure that it is running - distributed cache. By doing this you can ensure that you do not create conflicts with two - or more servers provisioning a cache at the same time. Note, this approach only makes a - server check the others for distributed cache, it does not provision the cache automatically - on all servers. If a previous server in the sequence does not appear to be running - distributed cache after 30 minutes, the local server that was waiting will begin anyway. + The ServerProvisionOrder optional property is used when a pull server is + handing out configurations to nodes in order to tell this resource about a + specific order of enabling the caches. This allows for multiple servers to + receive the same configuration, but they will always check for the server + before them in the list first to ensure that it is running distributed cache. + By doing this you can ensure that you do not create conflicts with two or more + servers provisioning a cache at the same time. Note, this approach only makes + a server check the others for distributed cache, it does not provision the + cache automatically on all servers. If a previous server in the sequence does .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt index 0d8f16088..c030f81a1 100644 --- a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt @@ -1,10 +1,10 @@ .NAME SPExcelServiceApp -.DESCRIPTION +# Description - This resource is responsible for creating Excel Services Application instances - within the local SharePoint farm. The resource will provision and configure the + This resource is responsible for creating Excel Services Application instances + within the local SharePoint farm. The resource will provision and configure the Excel Services Service Application. .PARAMETER Name diff --git a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt index 63a364585..96503b5a9 100644 --- a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt @@ -1,17 +1,17 @@ .NAME SPFarmAdministrators -.DESCRIPTION +# 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. + 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. .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt index e12343f14..9815b9600 100644 --- a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt @@ -1,14 +1,14 @@ .NAME SPFarmSolution -.DESCRIPTION +# Description - This resource is used to make sure that a specific farm solution is either present or - absent in a farm. The solution can be deployed to one or more web application passing - an array of URL's to the WebApplications property. If the solution contains resources - scoped for web applications and no WebApplications are specified, the solution will be - deployed to all web applications. If the solution does not contain resources scoped for - web applications the property is ignored and the solution is deployed globally. + This resource is used to make sure that a specific farm solution is either + present or absent in a farm. The solution can be deployed to one or more web + application passing an array of URL's to the WebApplications property. If the + solution contains resources scoped for web applications and no WebApplications + are specified, the solution will be deployed to all web applications. If the + solution does not contain resources scoped for web applications the property .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt index 84849413b..5098c5c39 100644 --- a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt @@ -1,12 +1,12 @@ .NAME SPFeature -.DESCRIPTION +# 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. + 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 .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt index 8203345e4..cf4d28a54 100644 --- a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt @@ -1,10 +1,10 @@ .NAME SPHealthAnalyzerRuleState -.DESCRIPTION +# Description - This resource is used to configure Health Analyzer rules for the local farm. The - resource is able to enable/disable and configure the specified rule. + This resource is used to configure Health Analyzer rules for the local farm. + The resource is able to enable/disable and configure the specified rule. .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt index 9c9656f0d..0c7987e6d 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt @@ -1,13 +1,13 @@ .NAME SPInstall -.DESCRIPTION +# Description - This resource is used to install the SharePoint binaries. The BinaryDir parameter should - point to the path that setup.exe is located (not to setup.exe itself). The ProductKey - parameter is used to inject in to the configuration file and validate the license key - during the installation process. This module depends on the prerequisites already being - installed, which can be done through the use of SPInstallPreReqs. + This resource is used to install the SharePoint binaries. The BinaryDir + parameter should point to the path that setup.exe is located (not to setup.exe + itself). The ProductKey parameter is used to inject in to the configuration + file and validate the license key during the installation process. This module + depends on the prerequisites already being installed, which can be done .PARAMETER BinaryDir Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt index 925c9fb16..3d194324d 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt @@ -1,12 +1,12 @@ .NAME SPInstallLanguagePack -.DESCRIPTION +# Description - This resource is used to install the SharePoint Language Pack binaries. The BinaryDir parameter should - point to the path that setup.exe is located (not to setup.exe itself). - The BinaryInstallDays and BinaryInstallTime parameters specify a window in which the update can be installed. - This module depends on SharePoint already being installed, which can be done through the use of SPInstall. + This resource is used to install the SharePoint Language Pack binaries. The + BinaryDir parameter should point to the path that setup.exe is located (not to + setup.exe itself). The BinaryInstallDays and BinaryInstallTime parameters + specify a window in which the update can be installed. This module depends on .PARAMETER BinaryDir Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt index 909718ba8..292d24023 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt @@ -1,22 +1,24 @@ .NAME SPInstallPrereqs -.DESCRIPTION +# Description - 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. + 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. + 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 { diff --git a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt index 0be9f0de5..e76d4df35 100644 --- a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt @@ -1,9 +1,10 @@ .NAME SPIrmSettings -.DESCRIPTION +# Description - This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS + This resource is used to manipulate the IRM settings in SharePoint, integrating + it with AD RMS .PARAMETER Ensure Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt index f7599d35d..26e0fd302 100644 --- a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt @@ -1,15 +1,15 @@ .NAME SPJoinFarm -.DESCRIPTION +# Description - This resource will be responsible for joining a server to an existing SharePoint - farm. To create a new farm use the SPCreateFarm resource on a different server - to begin with, and then pass the same database server and configuration database - name parameters to the additional servers using this resource. After the server has - joined the farm, the process will wait for 5 minutes to allow farm specific - configuration to take place on the server, before allowing further DSC configuration - to take place. + This resource will be responsible for joining a server to an existing + SharePoint farm. To create a new farm use the SPCreateFarm resource on a + different server to begin with, and then pass the same database server and + configuration database name parameters to the additional servers using this + resource. After the server has joined the farm, the process will wait for 5 + minutes to allow farm specific configuration to take place on the server, + before allowing further DSC configuration to take place. .PARAMETER FarmConfigDatabaseName Key - string @@ -25,7 +25,7 @@ .PARAMETER ServerRole Write - string - Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd + Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache SharePoint 2016 only - the MinRole role to enroll this server as .PARAMETER InstallAccount diff --git a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt index 63dfbf259..5a2c06a0a 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt @@ -1,14 +1,14 @@ .NAME SPManagedAccount -.DESCRIPTION +# Description - This resource will ensure a managed account is provisioned in to the SharePoint - farm. The Account object specific the credential to store (including username - and password) to set as the managed account. The settings for EmailNotification, - PreExpireDays and Schedule all relate to enabling automatic password change for - the managed account, leaving these option out of the resource will ensure that - no automatic password changing from SharePoint occurs. + This resource will ensure a managed account is provisioned in to the SharePoint + farm. The Account object specific the credential to store (including username + and password) to set as the managed account. The settings for + EmailNotification, PreExpireDays and Schedule all relate to enabling automatic + password change for the managed account, leaving these option out of the + resource will ensure that no automatic password changing from SharePoint occurs. .PARAMETER AccountName Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt index eb0031cdd..be5f54070 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt @@ -1,13 +1,13 @@ .NAME SPManagedMetaDataServiceApp -.DESCRIPTION +# Description - Creates a managed metadata service application. The application pool property specifies - which application pool it should use, and will reset the application back to this pool - if it is changed after its initial provisioning. The database server and database name - properties are only used during provisioning, and will not be altered as part of the - ongoing operation of the DSC resource. + Creates a managed metadata service application. The application pool property + specifies which application pool it should use, and will reset the application + back to this pool if it is changed after its initial provisioning. The + database server and database name properties are only used during + provisioning, and will not be altered as part of the ongoing operation of the .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt index 6db9a1286..801447909 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt @@ -1,15 +1,15 @@ .NAME SPManagedPath -.DESCRIPTION +# Description - This resource is responsible for creating managed paths associated with a specific web - application. The WebAppUrl parameter is used to specify the web application to create - the path against, and the RelativeUrl parameter lets you set the URL. Explicit when set - to true will create an explicit inclusion path, if set to false the path is created as - wildcard inclusion. If you are using host named site collections set HostHeader to true - and the path will be created as a host header path to be applied for host named site - collections. + This resource is responsible for creating managed paths associated with a + specific web application. The WebAppUrl parameter is used to specify the web + application to create the path against, and the RelativeUrl parameter lets you + set the URL. Explicit when set to true will create an explicit inclusion path, + if set to false the path is created as wildcard inclusion. If you are using + host named site collections set HostHeader to true and the path will be + created as a host header path to be applied for host named site collections. .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt index 16f314a17..aadeb9d63 100644 --- a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt @@ -1,16 +1,16 @@ .NAME SPOfficeOnlineServerBinding -.DESCRIPTION +# Description - This resource will create a binding to an Office Online Server (formerly known as Office - Web Apps). The DnsName property can be a single server name, or a FQDN of a load balanced - end point that will direct traffic to a farm. + This resource will create a binding to an Office Online Server (formerly known + as Office Web Apps). The DnsName property can be a single server name, or a + FQDN of a load balanced end point that will direct traffic to a farm. - NOTE: This resource is designed to be used where all WOPI bindings will be targeted to the - same Office Online Server farm. If used on a clean environment, the new bindings will all - point to the one DNS Name. If used on an existing configuration that does not follow this - rule, it will match only the first DNS name it finds in the list of bindings. + NOTE: This resource is designed to be used where all WOPI bindings will be + targeted to the same Office Online Server farm. If used on a clean + environment, the new bindings will all point to the one DNS Name. If used on + an existing configuration that does not follow this rule, it will match only .PARAMETER Zone Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt index 3fc6d85ce..5fb27d486 100644 --- a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt @@ -1,14 +1,14 @@ .NAME SPOutgoingEmailSettings -.DESCRIPTION +# Description - This resource is used to set the outgoing email settings for either a single web - application, or the whole farm. To configure the resource for a specific web app, - use the URL of the web application for the WebAppUrl property, to change the - settings for the whole farm use the URL of the central admin website instead. It is - possible to set the outgoing server, from address, reply to address and the character - set to be used for emails. + This resource is used to set the outgoing email settings for either a single + web application, or the whole farm. To configure the resource for a specific + web app, use the URL of the web application for the WebAppUrl property, to + change the settings for the whole farm use the URL of the central admin + website instead. It is possible to set the outgoing server, from address, + reply to address and the character set to be used for emails. .PARAMETER WebAppUrl key - string diff --git a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt index 42f8cb895..5a4e04213 100644 --- a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt @@ -1,13 +1,13 @@ .NAME SPPasswordChangeSettings -.DESCRIPTION +# Description - This resource is used to control settings that relate to the automatic changing of - passwords for managed accounts (where they opt-in to be managed by SharePoint). These - settings can be manually controlled through central administration, or configured in - this resource. The settings relate to email notifications of when passwords are reset, - as well as behavior when a reset occurs such as a time out and number of retries. + This resource is used to control settings that relate to the automatic + changing of passwords for managed accounts (where they opt-in to be managed by + SharePoint). These settings can be manually controlled through central + administration, or configured in this resource. The settings relate to email + notifications of when passwords are reset, as well as behavior when a reset .PARAMETER MailAddress key - string diff --git a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt index 84f6a6a7a..bdaa14871 100644 --- a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt @@ -1,10 +1,10 @@ .NAME SPPerformancePointServiceApp -.DESCRIPTION +# Description - This resource is responsible for creating Performance Point Service Application - instances within the local SharePoint farm. The resource will provision and + This resource is responsible for creating Performance Point Service Application + instances within the local SharePoint farm. The resource will provision and configure the Performance Point Service Application. .PARAMETER Name diff --git a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt index 3c4e2dc3f..d478fe6ff 100644 --- a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt @@ -1,19 +1,27 @@ .NAME SPProductUpdate -.DESCRIPTION +# Description - This resource is used to perform the update step of installing SharePoint updates, like Cumulative Updates and Service Packs. - The SetupFile parameter should point to the update file. - The ShutdownServices parameter is used to indicate if some services (Timer, Search and IIS services) have to be stopped before installation of the update. This will speed up the installation. - The BinaryInstallDays and BinaryInstallTime parameters specify a window in which the update can be installed. - This module requires the Configuration Wizard resource to fully complete the installation of the update, which can be done through the use of SPConfigWizard. + This resource is used to perform the update step of installing SharePoint + updates, like Cumulative Updates and Service Packs. The SetupFile parameter + should point to the update file. The ShutdownServices parameter is used to + indicate if some services (Timer, Search and IIS services) have to be stopped + before installation of the update. This will speed up the installation. The + BinaryInstallDays and BinaryInstallTime parameters specify a window in which + the update can be installed. This module requires the Configuration Wizard + resource to fully complete the installation of the update, which can be done + through the use of SPConfigWizard. IMPORTANT: - This resource retrieves build information from the Configuration Database. Therefore it requires SharePoint to be installed and a farm created. - If you like to deploy a new farm and install updates automatically, you need to implement the following order: + This resource retrieves build information from the Configuration Database. + Therefore it requires SharePoint to be installed and a farm created. If you + like to deploy a new farm and install updates automatically, you need to + implement the following order: + 1. Install the SharePoint Binaries (SPInstall) - 2. (Optional) Install SharePoint Language Pack(s) Binaries (SPInstallLanguagePack) + 2. (Optional) Install SharePoint Language Pack(s) Binaries + (SPInstallLanguagePack) 3. Create SPFarm (SPCreateFarm) 4. Install Cumulative Updates (SPProductUpdate) 5. Run the Configuration Wizard (SPConfigWizard) diff --git a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt index 54c2ea7f8..d8058bdae 100644 --- a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt @@ -1,21 +1,22 @@ .NAME SPPublishServiceApplication -.DESCRIPTION +# Description - This resource is used to specify if a specific service application should be published - (Ensure = "Present") or not published (Ensure = "Absent") on the current server. - The name is the display name of the service application as shown in the Central Admin website. + This resource is used to specify if a specific service application should be + published (Ensure = "Present") or not published (Ensure = "Absent") on the + current server. The name is the display name of the service application as + shown in the Central Admin website. - You can publish the following service applications in a SharePoint Server 2013/2016 farm: - * Business Data Connectivity - * Machine Translation - * Managed Metadata - * User Profile - * Search - * Secure Store + You can publish the following service applications in a SharePoint Server + 2013/2016 farm: - Source: https://technet.microsoft.com/en-us/library/ff621100(v=office.15).aspx + * Business Data Connectivity + * Machine Translation + * Managed Metadata + * User Profile + * Search + * Secure Store .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt index d371e4cfd..d4c7475b8 100644 --- a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt @@ -1,11 +1,11 @@ .NAME SPQuotaTemplate -.DESCRIPTION +# Description - This resource is used to configure quota templates in the farm. These settings will - be used to make sure a certain quota template exists or not. When it exists, it will - also make sure the settings are configured as specified. + This resource is used to configure quota templates in the farm. These settings + will be used to make sure a certain quota template exists or not. When it + exists, it will also make sure the settings are configured as specified. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt index 1eeb5cb83..6f722fab2 100644 --- a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt @@ -1,11 +1,11 @@ .NAME SPRemoteFarmTrust -.DESCRIPTION +# Description - This resource is used to trust a remote SharePoint farm. This is used when federating - search results between two different SharePoint farms. The technique is described at - https://technet.microsoft.com/en-us/library/dn133749.aspx + This resource is used to trust a remote SharePoint farm. This is used when + federating search results between two different SharePoint farms. The + technique is described at .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt index d0f79b735..86807fd28 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt @@ -1,9 +1,10 @@ .NAME SPSearchContentSource -.DESCRIPTION +# Description - This resource will deploy and configure a content source in a specified search service application. + This resource will deploy and configure a content source in a specified search + service application. .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt index 3a2b96ea9..a958ee022 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt @@ -1,10 +1,10 @@ .NAME SPSearchCrawlRule -.DESCRIPTION +# Description - This resource is responsible for managing the search crawl rules in the search - service application. You can create new rules, change existing rules and remove + This resource is responsible for managing the search crawl rules in the search + service application. You can create new rules, change existing rules and remove existing rules. .PARAMETER Path diff --git a/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt new file mode 100644 index 000000000..1fe356853 --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt @@ -0,0 +1,94 @@ +.NAME + SPSearchFileType + +# Description + + This resource is responsible for managing the search file types in the search + service application. You can create new file types, change existing types and + remove existing file types. + +.PARAMETER FileType + Key - string + The name of the file type + +.PARAMETER ServiceAppName + Required - string + The name of the search service application + +.PARAMETER Description + Write - string + The description of the file type + +.PARAMETER MimeType + Write - string + The mime type of the file type + +.PARAMETER Enabled + Write - boolean + The state of the file type + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example shows how to apply settings to a specific file type in search, using the required parameters + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchFileType PDF + { + FileType = "pdf" + ServiceAppName = "Search Service Application" + Description = "PDF" + MimeType = "application/pdf" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to disable a specific file type in search + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchFileType PDF + { + FileType = "pdf" + ServiceAppName = "Search Service Application" + Description = "PDF" + MimeType = "application/pdf" + Enabled = $false + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt index c7b8bf639..bfe0c8333 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt @@ -1,21 +1,22 @@ .NAME SPSearchIndexPartition -.DESCRIPTION +# Description - This resource is responsible for creating search indexes. It works by creating the - index topology components and updating the topology from the server that runs this - resource. For this reason this resource only needs to run from one server and not - from each server which will host the index component. The search service application - and existing search topology must be deployed before creating additional indexes. - The first index will be created through the use of the SPSearchRoles resource. - Additional search index partitions can be created through using this resource. + This resource is responsible for creating search indexes. It works by creating + the index topology components and updating the topology from the server that + runs this resource. For this reason this resource only needs to run from one + server and not from each server which will host the index component. The + search service application and existing search topology must be deployed + before creating additional indexes. The first index will be created through + the use of the SPSearchRoles resource. Additional search index partitions can + be created through using this resource. - Note that for the search topology to apply correctly, the path specified for - RootDirectory needs to exist on the server that is executing this resource. For - example, if the below example was executed on "Server1" it would also need to - ensure that it was able to create the index path at I:\. If no disk labeled I: - was available on server1, this would fail, even though it will not hold an + Note that for the search topology to apply correctly, the path specified for + RootDirectory needs to exist on the server that is executing this resource. For + example, if the below example was executed on "Server1" it would also need to + ensure that it was able to create the index path at I:\. If no disk labeled I: + was available on server1, this would fail, even though it will not hold an actual index component. .PARAMETER Index diff --git a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt index 4a3e0ac01..ff1a64d70 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt @@ -1,18 +1,18 @@ .NAME SPSearchResultSource -** Description ** +# Description - This resource is used to configure search result sources in the SharePoint search - service application. Result sources can be configured to be of the following - provider types: + This resource is used to configure search result sources in the SharePoint + search service application. Result sources can be configured to be of the + following provider types: - * Exchange Search Provider - * Local People Provider - * Local SharePoint Provider - * OpenSearch Provider - * Remote People Provider - * Remote SharePoint Provider + * Exchange Search Provider + * Local People Provider + * Local SharePoint Provider + * OpenSearch Provider + * Remote People Provider + * Remote SharePoint Provider .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt index 16d2929e4..3cc2c55a8 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt @@ -1,15 +1,15 @@ .NAME SPSearchServiceApp -.DESCRIPTION +# Description - This resource is responsible for provisioning the search service application. The - current version lets you specify the database name and server, as well as the - application pool. If the application pool is changed the DSC resource will set it - back as per what is set in the resource. The database name parameter is used as the - prefix for all search databases (so you will end up with one for the admin database - which matches the name, and then "_analyticsreportingstore", "_crawlstore" and - "_linkstore" databases as well). + This resource is responsible for provisioning the search service application. + The current version lets you specify the database name and server, as well as + the application pool. If the application pool is changed the DSC resource will + set it back as per what is set in the resource. The database name parameter is + used as the prefix for all search databases (so you will end up with one for + the admin database which matches the name, and then + "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well). .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt index a1955e4b4..7b415189f 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt @@ -1,23 +1,24 @@ .NAME SPSearchTopology -.DESCRIPTION +# Description - This resource is responsible for provisioning a search topology in to the current - farm. It allows the configuration to dictate the search topology roles that the - current server should be running. Any combination of roles can be specified and - the topology will be upaded to reflect the current servers new roles. If this is - the first server to apply topology to a farm, then at least one search index must - be provided. To this end, the FirstPartitionIndex, FirstPartitionDirectory and - FirstPartitionServers allow configuring where the first index partition will belong. - This will behave the same as the SPSearchIndexPartition resource. + This resource is responsible for provisioning a search topology in to the + current farm. It allows the configuration to dictate the search topology roles + that the current server should be running. Any combination of roles can be + specified and the topology will be upaded to reflect the current servers new + roles. If this is the first server to apply topology to a farm, then at least + one search index must be provided. To this end, the FirstPartitionIndex, + FirstPartitionDirectory and FirstPartitionServers allow configuring where the + first index partition will belong. This will behave the same as the + SPSearchIndexPartition resource. - Note that for the search topology to apply correctly, the path specified for - FirstPartitionDirectory needs to exist on the server that is executing this resource. - For example, if the below example was executed on "Server1" it would also need to - ensure that it was able to create the index path at I:\. If no disk labeled I: was - available on server1, this would fail, even though it will not hold an actual index - component. + Note that for the search topology to apply correctly, the path specified for + FirstPartitionDirectory needs to exist on the server that is executing this + resource. For example, if the below example was executed on "Server1" it would + also need to ensure that it was able to create the index path at I:\. If no + disk labeled I: was available on server1, this would fail, even though it will + not hold an actual index component. .PARAMETER ServiceAppName Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt index 01c1d0d56..578cb763b 100644 --- a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt @@ -1,12 +1,12 @@ .NAME SPSecureStoreServiceApp -.DESCRIPTION +# Description - This resource is responsible for provisioning and configuring the secure store - service application. The parameters passed in (except those related to database - specifics) are validated and set when the resource is run, the database values - are only used in provisioning of the service application. + This resource is responsible for provisioning and configuring the secure store + service application. The parameters passed in (except those related to database + specifics) are validated and set when the resource is run, the database values + are only used in provisioning of the service application. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt index e0b4b8b17..2e03efde4 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt @@ -1,11 +1,11 @@ .NAME SPServiceAppPool -.DESCRIPTION +# Description - This resource is used for provisioning an application pool that can be used for - service applications. The account used for the service account must already be - registered as a managed account (which can be provisioned through SPManagedAccount. + This resource is used for provisioning an application pool that can be used for + service applications. The account used for the service account must already be + registered as a managed account (which can be provisioned through .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt index 2b945a656..e8d98cc8a 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt @@ -1,23 +1,24 @@ .NAME SPServiceAppProxyGroup -.DESCRIPTION +# Description - This resource is used to manage SharePoint Service Application Proxy Groups. The "Ensure" - parameter controls whether or not the Proxy Group should exist. A proxy group cannot be - removed if a web application is using it. The "ServiceAppProxies" property will set a - specific list of Service App Proxies to be members of this Proxy Group. It will add and - remove proxies to ensure the group matches this list exactly. The - "ServiceAppProxiesToInclude" and "ServiceAppProxiesToExclude" properties will allow you - to add and remove proxies from the group, leaving other proxies that are in the group - but not in either list intact. + This resource is used to manage SharePoint Service Application Proxy Groups. + The "Ensure" parameter controls whether or not the Proxy Group should exist. A + proxy group cannot be removed if a web application is using it. The + "ServiceAppProxies" property will set a specific list of Service App Proxies + to be members of this Proxy Group. It will add and remove proxies to ensure + the group matches this list exactly. The "ServiceAppProxiesToInclude" and + "ServiceAppProxiesToExclude" properties will allow you to add and remove + proxies from the group, leaving other proxies that are in the group but not in + either list intact. Use the proxy group name "Default" to manipulate the default proxy group. Requirements: - At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or ServiceAppProxiesToExclude - properties needs to be specified. Do not combine the ServiceAppProxies property with the - ServiceAppProxiesToInclude and ServiceAppProxiesToExclude properties. + At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or + ServiceAppProxiesToExclude properties needs to be specified. Do not combine + the ServiceAppProxies property with the ServiceAppProxiesToInclude and .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt index c91b45cd4..01a0291ca 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt @@ -1,20 +1,20 @@ .NAME SPServiceAppSecurity -.DESCRIPTION +# Description - This resource is used to manage the sharing security settings of a specific service - application. There are a number of approaches to how this can be implemented. Firstly - you can set permissions for the app administrators, or for the sharing permission by - specifying the SecurityType attribute. These options correlate to the buttons seen in - the ribbon on the "manage service applications" page in Central Administration after - you select a specific service app. The "Members" property will set a specific list of - members for the service app, 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. + This resource is used to manage the sharing security settings of a specific + service application. There are a number of approaches to how this can be + implemented. Firstly you can set permissions for the app administrators, or + for the sharing permission by specifying the SecurityType attribute. These + options correlate to the buttons seen in the ribbon on the "manage service + applications" page in Central Administration after you select a specific + service app. The "Members" property will set a specific list of members for + the service app, 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 .PARAMETER ServiceAppName Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt index 0e06cb8b8..d060d6587 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt @@ -1,11 +1,11 @@ .NAME SPServiceInstance -.DESCRIPTION +# Description - This resource is used to specify if a specific service should be running - (Ensure = "Present") or not running (Ensure = "Absent") on the current server. - The name is the display name of the service as shown in the Central Admin website. + This resource is used to specify if a specific service should be running + (Ensure = "Present") or not running (Ensure = "Absent") on the current server. + The name is the display name of the service as shown in the Central Admin .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt index ba36aa2bf..3a4475ba3 100644 --- a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt @@ -1,11 +1,11 @@ .NAME SPSessionStateService -.DESCRIPTION +# Description - This resource will provision a state service app to the local farm. Specify the name of - the database server and database name to provision the app with, and optionally include - the session timeout value. If session timeout is not provided it will default to 60. + This resource will provision a state service app to the local farm. Specify + the name of the database server and database name to provision the app with, + and optionally include the session timeout value. If session timeout is not .PARAMETER DatabaseName Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt index d148c9deb..71eb6b65e 100644 --- a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt @@ -1,31 +1,34 @@ .NAME SPShellAdmins -.DESCRIPTION +# Description - This resource is used to manage the users with Shell Admin permissions. 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. The "ContentDatabases" and - "AllContentDatabases" properties will allow you to control the permissions on Content - Databases. + This resource is used to manage the users with Shell Admin permissions. 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. The "ContentDatabases" and + "AllContentDatabases" properties will allow you to control the permissions on + Content Databases. Requirements: - * At least one of the Members, MemberToInclude or MembersToExclude properties needs to - be specified. - * Do not combine the Members property with the MemberToInclude and MembersToExclude - properties. - * Do not combine the ContentDatabase property with the AllContentDatabases property. + + * At least one of the Members, MemberToInclude or MembersToExclude properties + needs to be specified. + * Do not combine the Members property with the MemberToInclude and + MembersToExclude properties. + * Do not combine the ContentDatabase property with the AllContentDatabases + property. Notes: - 1.) If a content database is created using the Central Admin, the farm account is the - owner of that content database in SQL Server. When this is true, you cannot add it to - the Shell Admins (common for AllContentDatabases parameter) and the resource will throw - an error. Workaround: Change database owner in SQL Server. + 1.) If a content database is created using the Central Admin, the farm account + is the owner of that content database in SQL Server. When this is true, you + cannot add it to the Shell Admins (common for AllContentDatabases parameter) + and the resource will throw an error. Workaround: Change database owner in SQL .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPSite.help.txt b/Modules/SharePointDsc/en-us/about_SPSite.help.txt index 04e4e9dc3..5200bcc96 100644 --- a/Modules/SharePointDsc/en-us/about_SPSite.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSite.help.txt @@ -1,14 +1,14 @@ .NAME SPSite -.DESCRIPTION +# Description - This resource will provision a site collection to the current farm, based on - the settings that are passed through. These settings map to the New-SPSite - cmdlet and accept the same values and types. + This resource will provision a site collection to the current farm, based on + the settings that are passed through. These settings map to the New-SPSite + cmdlet and accept the same values and types. - The current version of SharePointDsc is only able to check for the existence - of a site collection, the additional parameters are not checked for yet, but + The current version of SharePointDsc is only able to check for the existence + of a site collection, the additional parameters are not checked for yet, but will be in a later release .PARAMETER Url diff --git a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt index 0dd042cac..353665277 100644 --- a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt @@ -1,10 +1,10 @@ .NAME SPStateServiceApp -.DESCRIPTION +# Description - This resource provisions an instance of the state service in to the local farm. - The database specific parameters are only used during initial provisioning of + This resource provisions an instance of the state service in to the local farm. + The database specific parameters are only used during initial provisioning of the app, and will not change database settings beyond the initial deployment. .PARAMETER Name diff --git a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt index 6e0215242..8928a38f9 100644 --- a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt @@ -1,16 +1,16 @@ .NAME SPSubscriptionSettingsServiceApp -.DESCRIPTION +# 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 subscription - settings service 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. + This resource is used to provision and manage an instance of the App Management + Services Service Application. It will identify an instance of the subscription + settings service 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. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt index 521ddd0ec..ea2f5011a 100644 --- a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt @@ -1,24 +1,26 @@ .NAME SPTimerJobState -.DESCRIPTION +# Description - This resource is used to configure a timer job and make sure it is in a specific - state. The resource can be used to enable or disabled the job and configure the - schedule of the job. + This resource is used to configure a timer job and make sure it is in a + specific state. The resource can be used to enable or disabled the job and + configure the schedule of the job. - The schedule parameter has to be written in the SPSchedule format + The schedule parameter has to be written in the SPSchedule format (https://technet.microsoft.com/en-us/library/ff607916.aspx). + Examples are: - - Every 5 minutes between 0 and 59 - - Hourly between 0 and 59 - - Daily at 15:00:00 - - Weekly between Fri 22:00:00 and Sun 06:00:00 - - Monthly at 15 15:00:00 - - Yearly at Jan 1 15:00:00 - NOTE: Make sure you use the internal timer job name, not the display name! Use - "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" + - Every 5 minutes between 0 and 59 + - Hourly between 0 and 59 + - Daily at 15:00:00 + - Weekly between Fri 22:00:00 and Sun 06:00:00 + - Monthly at 15 15:00:00 + - Yearly at Jan 1 15:00:00 + + NOTE: Make sure you use the internal timer job name, not the display name! Use + "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" to find the internal name for each Timer Job. .PARAMETER Name diff --git a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt index 171d147a3..0b0259d25 100644 --- a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt @@ -1,26 +1,29 @@ .NAME SPTrustedIdentityTokenIssuer -.DESCRIPTION +# Description - This resource is used to create or remove SPTrustedIdentityTokenIssuer in a SharePoint - farm. + This resource is used to create or remove SPTrustedIdentityTokenIssuer in a + SharePoint farm. - The SigningCertificateThumbPrint must match the thumbprint of a certificate in the - store LocalMachine\My of the server that will run this resource. - Note that the private key of the certificate must not be available in the certiificate - store because SharePoint does not accept it. - Once the SPTrustedIdentityTokenIssuer is successfully created, the certificate can be - safely deleted from the certificate store as it won't be needed by SharePoint. + The SigningCertificateThumbPrint must match the thumbprint of a certificate in + the store LocalMachine\My of the server that will run this resource. + Note that the private key of the certificate must not be available in the + certiificate store because SharePoint does not accept it. + Once the SPTrustedIdentityTokenIssuer is successfully created, the certificate + can be safely deleted from the certificate store as it won't be needed by + SharePoint. - ClaimsMappings is an array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping. - Each MSFT_SPClaimTypeMapping requires properties Name and IncomingClaimType. - Property LocalClaimType is not required if its value is identical to IncomingClaimType. + ClaimsMappings is an array of MSFT_SPClaimTypeMapping to use with cmdlet + New-SPClaimTypeMapping. Each MSFT_SPClaimTypeMapping requires properties Name + and IncomingClaimType. Property LocalClaimType is not required if its value is + identical to IncomingClaimType. - The IdentifierClaim property must match an IncomingClaimType element in ClaimsMappings array. + The IdentifierClaim property must match an IncomingClaimType element in + ClaimsMappings array. - The ClaimProviderName property can be set to specify a custom claims provider. It must be - already installed in the SharePoint farm and returned by cmdlet Get-SPClaimProvider. + The ClaimProviderName property can be set to specify a custom claims provider. + It must be already installed in the SharePoint farm and returned by cmdlet .PARAMETER Name Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt index 07cfe2288..792833626 100644 --- a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt @@ -1,11 +1,11 @@ .NAME SPUsageApplication -.DESCRIPTION +# Description - This resource provisions an instance of the usage and health monitoring service - application. The database settings are only used for initial provisioning, but - the usage settings can be changed and will be enforced as the resource is executed. + This resource provisions an instance of the usage and health monitoring service + application. The database settings are only used for initial provisioning, but + the usage settings can be changed and will be enforced as the resource is .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt index 97fee52a0..5cbadf212 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt @@ -1,20 +1,20 @@ .NAME SPUserProfileProperty -.DESCRIPTION +# Description - This resource will create a property in a user profile service application. It - creates, update or delete a property using the parameters that are passed in to + This resource will create a property in a user profile service application. It + creates, update or delete a property using the parameters that are passed in to it. - The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the - 5th field of section Bla, which has propertyName value of 5000 then your DisplayOrder - needs to be 5005. If no DisplayOrder is added then SharePoint adds it as the last - property of section X. + The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the + 5th field of section Bla, which has propertyName value of 5000 then your + DisplayOrder needs to be 5005. If no DisplayOrder is added then SharePoint + adds it as the last property of section X. Length is only relevant if Field type is "String". - This Resource doesn't currently support removing existing user profile properties. + This Resource doesn't currently support removing existing user profile .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt index 58cd1d240..c0c703eb9 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt @@ -1,12 +1,13 @@ .NAME SPUserProfileSection -.DESCRIPTION +# Description - This resource will create a section in a user profile service application. It - creates, update or delete a section using the parameters that are passed in to it. + This resource will create a section in a user profile service application. It + creates, update or delete a section using the parameters that are passed in to + it. - If no DisplayOrder is added then SharePoint will automatically assigned an ID to it. + If no DisplayOrder is added then SharePoint will automatically assigned an ID .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt index c1e84d353..c480c99db 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt @@ -1,15 +1,15 @@ .NAME SPUserProfileServiceApp -.DESCRIPTION +# Description - This resource will provision an instance of the user profile service to the farm. It - creates the required databases using the parameters that are passed in to it (although - these are only used during the initial provisioning). The farm account is used during - the provisioning of the service only (in the set method), and the install account is - used in the get and test methods. This is done to ensure that the databases are created - with the correct schema owners and allow the user profile sync service to operate - correctly. + This resource will provision an instance of the user profile service to the + farm. It creates the required databases using the parameters that are passed + in to it (although these are only used during the initial provisioning). The + farm account is used during the provisioning of the service only (in the set + method), and the install account is used in the get and test methods. This is + done to ensure that the databases are created with the correct schema owners + and allow the user profile sync service to operate correctly. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt index 8bfd9d7ba..7730af844 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt @@ -1,12 +1,12 @@ .NAME SPUserProfileServiceAppPermissions -.DESCRIPTION +# Description - This resource will apply permissions to a user profile service application. - These can control access to create my sites, use social features, and use - tagging. If you want to allow all users the ability to use a specific - permisisons include "Everyone" as a user in the corresponding property. To + This resource will apply permissions to a user profile service application. + These can control access to create my sites, use social features, and use + tagging. If you want to allow all users the ability to use a specific + permisisons include "Everyone" as a user in the corresponding property. To specify that there should be no permissions on a type, use "none" .PARAMETER ProxyName diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt index d1dea426c..277f902fd 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt @@ -1,12 +1,13 @@ .NAME SPUserProfileSyncConnection -.DESCRIPTION +# Description - This resource will ensure a specifc user profile sync connection is in place and - that it is configured accordingly to its definition + This resource will ensure a specifc user profile sync connection is in place + and that it is configured accordingly to its definition This resource currently supports AD only. + .PARAMETER Name Key - string The name of the connection diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt index c01b68f8e..ece5ed05f 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt @@ -1,18 +1,18 @@ .NAME SPUserProfileSyncService -.DESCRIPTION +# Description - This resource is responsible for ensuring that the user profile sync service has - been provisioned (Ensure = "Present") or is not running (Ensure = "Absent") on the - current server. This resource uses the InstallAccount to validate the current state - only, the set method which will do the provisioning uses the FarmAccount to do the - actual work - this means that CredSSP authentication will need to be permitted to - allow a connection to the local server. To allow successful provisioning the farm - account must be in the local administrators group, however it is not best practice - to leave this account in the Administrators group. Therefore this resource will add - the FarmAccount credential to the local administrators group at the beginning of the - set method, and then remove it once it has completed its work. + This resource is responsible for ensuring that the user profile sync service + has been provisioned (Ensure = "Present") or is not running (Ensure = + "Absent") on the current server. This resource uses the InstallAccount to + validate the current state only, the set method which will do the provisioning + uses the FarmAccount to do the actual work - this means that CredSSP + authentication will need to be permitted to allow a connection to the local + server. To allow successful provisioning the farm account must be in the local + administrators group, however it is not best practice to leave this account in + the Administrators group. Therefore this resource will add the FarmAccount + credential to the local administrators group at the beginning of the set .PARAMETER UserProfileServiceAppName Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt index ca3ba5b38..056f4a873 100644 --- a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt @@ -1,11 +1,11 @@ .NAME SPVisioServiceApp -.DESCRIPTION +# Description - This resource is responsible for creating Visio Graphics Service Application instances - within the local SharePoint farm. The resource will provision and configure the Visio - Graphics Service Application. + This resource is responsible for creating Visio Graphics Service Application + instances within the local SharePoint farm. The resource will provision and + configure the Visio Graphics Service Application. .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt index 689fe8b5d..22e37e5ee 100644 --- a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt @@ -1,10 +1,10 @@ .NAME SPWeb -.DESCRIPTION +# Description - This resource will provision a SPWeb based on the settings that are passed through. - These settings map to the New-SPWeb cmdlet and accept the same values and types. + This resource will provision a SPWeb based on the settings that are passed + through. These settings map to the New-SPWeb cmdlet and accept the same values .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt index cdf57f442..bbc65b7eb 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt @@ -1,19 +1,19 @@ .NAME SPWebAppBlockedFileTypes -.DESCRIPTION +# Description - This resource is responsible for controlling the blocked file type setting on a - specific web application. It has two modes of operation, the first is to use the - "blocked" property, where you are able to define a specific list of file types that - will be blocked. In this mode when it is detected that the list does not match the - local farm, it is set to match this list exactly. The second mode is to use the - "EnsureBlocked" and "EnsureAllowed" properties. EnsureBlocked will check to make - sure that the specified file types are on the list, and if not they will be added. - EnsureAllowed checks to make sure that a file type is not on the list, and if it is - it will be removed. Both of these properties will only make changes to the file types - in their list and will leave the full list as it is otherwise, whereas the blocked - property resets the list in full. + This resource is responsible for controlling the blocked file type setting on a + specific web application. It has two modes of operation, the first is to use + the "blocked" property, where you are able to define a specific list of file + types that will be blocked. In this mode when it is detected that the list + does not match the local farm, it is set to match this list exactly. The + second mode is to use the "EnsureBlocked" and "EnsureAllowed" properties. + EnsureBlocked will check to make sure that the specified file types are on the + list, and if not they will be added. EnsureAllowed checks to make sure that a + file type is not on the list, and if it is it will be removed. Both of these + properties will only make changes to the file types in their list and will + leave the full list as it is otherwise, whereas the blocked property resets .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt index 301c4a45f..68659ed15 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt @@ -1,13 +1,13 @@ .NAME SPWebAppGeneralSettings -.DESCRIPTION +# Description - This resource is responsible for setting web application settings that are found - under the "general settings" screen in central admin. The web application is - specified through the URL property, and then any combination of settings can be - applied. Any settings not included will be left as the default (or whatever they - have been manually changed to within SharePoint). + This resource is responsible for setting web application settings that are + found under the "general settings" screen in central admin. The web + application is specified through the URL property, and then any combination of + settings can be applied. Any settings not included will be left as the default + (or whatever they have been manually changed to within SharePoint). .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt index 8e577b099..376f4e1be 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt @@ -1,13 +1,13 @@ .NAME SPWebAppPermissions -.DESCRIPTION +# Description - This resource is responsible for managing the user permissions for a web application. - You can either specify to set all permissions or specify individual permissions per - category. + This resource is responsible for managing the user permissions for a web + application. You can either specify to set all permissions or specify + individual permissions per category. - More info about the permission levels: https://technet.microsoft.com/en-us/library/cc721640.aspx + More info about the permission levels: .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt index ff529de9b..404dc14ba 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt @@ -1,23 +1,24 @@ .NAME SPWebAppPolicy -.DESCRIPTION +# Description - This resource is used to set the User Policies for web applications. The usernames - can be either specified in Classic or Claims format, both will be accepted. 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. + This resource is used to set the User Policies for web applications. The + usernames can be either specified in Classic or Claims format, both will be + accepted. 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. Requirements: - At least one of the Members, MemberToInclude or MembersToExclude properties needs to be - specified. Do not combine the Members property with the MemberToInclude and - MembersToExclude properties. Do not set the ActAsSystemAccount property to $true without - setting the permission level to Full Control. + At least one of the Members, MemberToInclude or MembersToExclude properties + needs to be specified. Do not combine the Members property with the + MemberToInclude and MembersToExclude properties. Do not set the + ActAsSystemAccount property to $true without setting the permission level to .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt index 3a214faf9..aa99691ff 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt @@ -1,16 +1,17 @@ .NAME SPWebAppProxyGroup -.DESCRIPTION +# Description - This resource is used to associate a web application to a service application proxy group. - Use the proxy group name "Default" to associate the web application to the default proxy - group. A web applicaiton can only connect to a single service application proxy group. This - resource will overright the existing service application proxy group association. + This resource is used to associate a web application to a service application + proxy group. Use the proxy group name "Default" to associate the web + application to the default proxy group. A web applicaiton can only connect to + a single service application proxy group. This resource will overright the + existing service application proxy group association. - This resource is used in conjunction with the SPServiceAppProxyGroup resource, which creates - the proxy groups and associates the desired service application proxies with it. Within your - configuration, that resource should be a dependancy for the SPWebAppProxyGroup resource. + This resource is used in conjunction with the SPServiceAppProxyGroup resource, + which creates the proxy groups and associates the desired service application + proxies with it. Within your configuration, that resource should be a .PARAMETER WebAppUrl Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt index db414ea67..2ef086db4 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt @@ -1,12 +1,12 @@ .NAME SPWebAppSiteUseAndDeletion -.DESCRIPTION +# Description - This resource is responsible for controlling the Site Use and Deletion settings on a - specific web application. You can enable or disable the Site Use and Deletion feature, - specify the amount of days after which the alerts are being send, if sites have to be - deleted automatically and if so after how many days this has to be done. + This resource is responsible for controlling the Site Use and Deletion + settings on a specific web application. You can enable or disable the Site Use + and Deletion feature, specify the amount of days after which the alerts are + being send, if sites have to be deleted automatically and if so after how many .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt index 021a472d6..c82635b35 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt @@ -1,15 +1,15 @@ .NAME SPWebAppThrottlingSettings -.DESCRIPTION +# Description - This resource is responsible for setting web application settings that are found under the - "resource throttling" screen in central admin. The web application is specified through the - URL property, and then any combination of settings can be applied. Any settings not included - will be left as the default (or whatever they have been manually changed to within - SharePoint). Happy hour is the setting used to control the window where threshold do not - apply throughout the day. You can specify the start time of this window as well as how many - hours it will last. + This resource is responsible for setting web application settings that are + found under the "resource throttling" screen in central admin. The web + application is specified through the URL property, and then any combination of + settings can be applied. Any settings not included will be left as the default + (or whatever they have been manually changed to within SharePoint). Happy hour + is the setting used to control the window where threshold do not apply + throughout the day. You can specify the start time of this window as well as .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt index 2522cb3b3..b0a3353dc 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt @@ -1,13 +1,13 @@ .NAME SPWebAppWorkflowSettings -.DESCRIPTION +# Description - This resource is responsible for setting web application settings that are found under the - "workflow settings" screen in central admin. The web application is specified through the - URL property, and then any combination of settings can be applied. Any settings not - included will be left as the default (or whatever they have been manually changed to within - SharePoint). + This resource is responsible for setting web application settings that are + found under the "workflow settings" screen in central admin. The web + application is specified through the URL property, and then any combination of + settings can be applied. Any settings not included will be left as the default + (or whatever they have been manually changed to within SharePoint). .PARAMETER Url Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt index 4a116b94f..ff3e67b1d 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt @@ -1,12 +1,12 @@ .NAME SPWebApplication -.DESCRIPTION +# Description - This resource is responsible for creating a web application within the local SharePoint - farm. The resource will provision the web application with all of the current settings, - and then ensure that it stays part of the correct application pool beyond that (additional - checking and setting of properties will be added in future releases). + This resource is responsible for creating a web application within the local + SharePoint farm. The resource will provision the web application with all of + the current settings, and then ensure that it stays part of the correct + application pool beyond that (additional checking and setting of properties .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt index 1723fa314..80c0a694b 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt @@ -1,13 +1,13 @@ .NAME SPWebApplicationAppDomain -.DESCRIPTION +# Description - This resource will configure the App Domain at a specific zone for the given Web - Application. The configuration is done per zone on the specified web application, - allowing for the setting of unique app domains for each extension of a web - application. The app prefix should still be set using the SPAppDomain resource - before this is applied to customise a specific zone. + This resource will configure the App Domain at a specific zone for the given + Web Application. The configuration is done per zone on the specified web + application, allowing for the setting of unique app domains for each extension + of a web application. The app prefix should still be set using the SPAppDomain + resource before this is applied to customise a specific zone. .PARAMETER WebApplication Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt index 68dd5fbe6..d45fe3fc8 100644 --- a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt @@ -1,16 +1,17 @@ .NAME SPWordAutomationServiceApp -.DESCRIPTION +# Description - The resource is able to provision, unprovision and configure the Word Automation Service - Application. All settings that you can configure on the Service Application administration - page are configurable using this resource. + The resource is able to provision, unprovision and configure the Word + Automation Service Application. All settings that you can configure on the + Service Application administration page are configurable using this resource. Important: - When you specify Ensure=Present, the Application Pool and DatabaseName parameters are - required. When you specify Ensure=Absent, no other parameters are allowed (with the exception - of Name, InstallAccount or PsDscRunAsCredential). + When you specify Ensure=Present, the Application Pool and DatabaseName + parameters are required. When you specify Ensure=Absent, no other parameters + are allowed (with the exception of Name, InstallAccount or + PsDscRunAsCredential). .PARAMETER Name Key - string diff --git a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt index 7e30c2d5f..4232f7cb6 100644 --- a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt @@ -1,18 +1,20 @@ .NAME SPWorkManagementServiceApp -.DESCRIPTION - - This resource is used to provision and manage an instance of the Work Management Services - Service Application. It will identify an instance of the work 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. +# Description + This resource is used to provision and manage an instance of the Work + Management Services Service Application. It will identify an instance of the + work 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. Remarks - - Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, MinimumTimeBetweenProviderRefreshes, - MinimumTimeBetweenSearchQueries are in Minutes + + - Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, + MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in + minutes. .PARAMETER Name Key - string From 3e6426f23b2d6c9d136a551d752209ce3364a515 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Wed, 8 Mar 2017 11:27:07 +1100 Subject: [PATCH 07/18] Updated module help --- .../SharePointDsc/en-US/about_SPFarm.help.txt | 210 ++++++++++++++++++ .../en-US/about_SPFarmPropertyBag.help.txt | 81 +++++++ .../en-us/about_SPCreateFarm.help.txt | 3 + .../about_SPDistributedCacheService.help.txt | 15 ++ .../en-us/about_SPInstall.help.txt | 12 + .../en-us/about_SPInstallPrereqs.help.txt | 12 + .../en-us/about_SPJoinFarm.help.txt | 3 + .../en-us/about_SPWebApplication.help.txt | 70 +++++- 8 files changed, 405 insertions(+), 1 deletion(-) create mode 100644 Modules/SharePointDsc/en-US/about_SPFarm.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt new file mode 100644 index 000000000..b433f1629 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt @@ -0,0 +1,210 @@ +.NAME + SPFarm + +# Description + + This resource is used to create a new SharePoint farm and allow servers to + join that farm. It will detect the presence of the configuration database + on the SQL server as a first step, and if it does not exist then the farm + will be created. If the database does exist, the server will join that + configuration database. Once the config DB has been created, the + resource will install local help collections, secure resources and activate + features. + + If the central admin site is to be running on the local server, the + RunCentralAdmin property should be set to true. In the event that the central + admin site has not been provisioned, this resource will first create it, + otherwise it will simply start the central admin service instance on the + local server. + + The passphrase is passed as a Credential object.The username of this + credential is ignored, only the value of the password is used as the farm + passphrase. + + 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 SPDistributedCacheService on at least one server in the farm to + designate it as a cache server. + + CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not + specified, it defaults to NTLM. If using Kerberos, make sure to have + appropriate SPNs setup for Farm account and Central Administration URI. + +.PARAMETER Ensure + Key - string + Allowed values: Present, Absent + Present to create/join the farm. Absent is currently not supported + +.PARAMETER FarmConfigDatabaseName + Required - String + Name of the configuration database + +.PARAMETER DatabaseServer + Required - String + Server that will host the configuration and admin content databases + +.PARAMETER FarmAccount + Required - String + The account to use as the main farm account + +.PARAMETER Passphrase + Required - String + The passphrase to use to allow servers to join this farm + +.PARAMETER AdminContentDatabaseName + Required - String + The name of the admin content database + +.PARAMETER RunCentralAdmin + Required - Boolean + Should the central admin site run on this specific server? + +.PARAMETER CentralAdministrationPort + Write - uint32 + What port will Central Admin be provisioned to - default is 9999 + +.PARAMETER CentralAdministrationAuth + Write - String + Allowed values: NTLM, Kerberos + The authentication provider of the CentralAdministration web application + +.PARAMETER ServerRole + Write - string + Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache + SharePoint 2016 only - the MinRole role to enroll this server as + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarm SharePointFarm + { + Ensure = "Present" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + RunCentralAdmin = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. Here the port for the central admin site to + run on, as well as the authentication mode for the site are also specified. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarm SharePointFarm + { + Ensure = "Present" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + CentralAdministrationPort = 5000 + CentralAdministrationAuth = "Kerberos" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + RunCentralAdmin = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. In this example we also see + the server role defined as "Application" which tells SharePoint 2016 the role to apply to + this server as soon as the farm is created. This property is not supported for SharePoint 2013 + and so this specific example would fail if used against that verison. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarm SharePointFarm + { + Ensure = "Present" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + ServerRole = "Application" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + RunCentralAdmin = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt new file mode 100644 index 000000000..a00b751a4 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt @@ -0,0 +1,81 @@ +.NAME + SPFarmPropertyBag + +# Description + + This resource is used to work with SharePoint Property Bags at the farm level. + The account that runs this resource must be a farm administrator. + +.PARAMETER Key + Key - string + The key of the SPFarm property bag + +.PARAMETER Value + Write - String + Value of the SPfarm property bag + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Set to present to ensure the SPfarm property exists, or absent to ensure it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how add property bag in the current farm. + + +Configuration Example +{ + param + ( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPFarmPropertyBag APPLICATION_APPCodeProperty + { + PsDscRunAsCredential = $SetupAccount + Key = "FARM_TYPE" + Value = "SearchFarm" + Ensure = "Present" + } + } +} + + +.EXAMPLE + This example shows how remove property bag in the current farm. + + +Configuration Example +{ + param + ( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPFarmPropertyBag APPLICATION_APPCodeProperty + { + PsDscRunAsCredential = $SetupAccount + Key = "KeyToRemove" + Ensure = "Absent" + } + } +} + + diff --git a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt index 9b4ee349a..49b7b24c2 100644 --- a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt @@ -3,6 +3,9 @@ # Description + WARNING: This resource is deprecated. Please use SPFarm instead as + this resource will be removed from version 2.0 of SharePointDsc + 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 diff --git a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt index 3efe3a103..0801e300f 100644 --- a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt @@ -116,6 +116,21 @@ 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. + + + $ConfigurationData = @{ + AllNodes = @( + @{ + NodeName = 'Server1' + PSDscAllowPlainTextPassword = $true + }, + @{ + NodeName = 'Server2' + PSDscAllowPlainTextPassword = $true + } + ) + } Configuration Example { diff --git a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt index 0c7987e6d..827c7b957 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt @@ -9,6 +9,18 @@ file and validate the license key during the installation process. This module depends on the prerequisites already being installed, which can be done + ## Installing from network locations + + If you wish to install SharePoint 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. + .PARAMETER BinaryDir Key - String The directory that contains all of the SharePoint binaries diff --git a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt index 292d24023..de5bdc813 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt @@ -25,6 +25,18 @@ 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. + .PARAMETER InstallerPath Key - String The full path to prerequisiteinstaller.exe diff --git a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt index 26e0fd302..2cb9a9b88 100644 --- a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt @@ -3,6 +3,9 @@ # Description + WARNING: This resource is deprecated. Please use SPFarm instead as + this resource will be removed from version 2.0 of SharePointDsc + This resource will be responsible for joining a server to an existing SharePoint farm. To create a new farm use the SPCreateFarm resource on a different server to begin with, and then pass the same database server and diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt index ff3e67b1d..fee145788 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt @@ -30,9 +30,13 @@ .PARAMETER AuthenticationMethod Write - string - Allowed values: NTLM, Kerberos + Allowed values: NTLM, Kerberos, Claims What authentication mode should be used for the web app +.PARAMETER AuthenticationProvider + Write - string + What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims + .PARAMETER DatabaseName Write - string The name of the first content database to be created with this web app @@ -99,3 +103,67 @@ } +.EXAMPLE + This example shows how to create a new web application in the local farm using a custom claim provider. + A SPTrustedIdentityTokenIssuer is created named Contoso, then this SPTrustedIdentityTokenIssuer is referenced + by the SPWebApplication as the AuthenticationProvider and the AuthenticationMethod is set to "Claims" value. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + + + SPWebApplication HostNameSiteCollectionWebApp + { + Name = "SharePoint Sites" + ApplicationPool = "SharePoint Sites" + ApplicationPoolAccount = "CONTOSO\svcSPWebApp" + AllowAnonymous = $false + AuthenticationMethod = "Claims" + AuthenticationProvider = "Contoso" + DatabaseName = "SP_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + Url = "http://example.contoso.local" + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" + } + } + } + + From f247aa5efa15c6087c36baa8222af0ffe2474ece Mon Sep 17 00:00:00 2001 From: Katie Keim Date: Wed, 8 Mar 2017 13:23:42 -0800 Subject: [PATCH 08/18] Update release notes in manifest for 1.6 --- Modules/SharePointDsc/SharePointDsc.psd1 | 40 ++++++++++++++---------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/Modules/SharePointDsc/SharePointDsc.psd1 b/Modules/SharePointDsc/SharePointDsc.psd1 index 006cbcb7b..44bf7c16d 100644 --- a/Modules/SharePointDsc/SharePointDsc.psd1 +++ b/Modules/SharePointDsc/SharePointDsc.psd1 @@ -126,22 +126,30 @@ PrivateData = @{ # ReleaseNotes of this module ReleaseNotes = ' -* Fixed issue with SPManagedMetaDataServiceApp if ContentTypeHubUrl parameter is - null -* Added minimum PowerShell version to module manifest -* Added testing for valid markdown syntax to unit tests -* Added support for MinRole enhancements added in SP2016 Feature Pack 1 -* Fixed bug with search topology that caused issues with names of servers needing - to all be the same case -* Fixed bug in SPInstallLanguagePack where language packs could not be installed - on SharePoint 2016 -* Added new resource SPSearchFileType -* Updated SPDatabaseAAG to allow database name patterns -* Fixed a bug were PerformancePoint and Excel Services Service Application - proxies would not be added to the default proxy group when they are - provisioned -* Added an error catch to provide more detail about running SPAppCatalog with - accounts other than the farm account +* Updated SPWebApplication to allow Claims Authentication configuration +* Updated documentation in regards to guidance on installing binaries from + network locations instead of locally +* New resources: SPFarmPropertyBag +* Bugfix in SPSite, which wasnt returing the quota template name in a correct way +* Bugfix in SPAppManagementServiceApp which wasnt returning the correct database + name +* Bugfix in SPAccessServiceApp which did not return the database server +* Bugfix in SPDesignerSettings which filtered site collections with an incorrect + parameter +* Updated the parameters in SPFarmSolution to use the full namespace +* Bugfix in SPFarmsolution where it returned non declared parameters +* Corrected typo in parameter name in Get method of SPFeature +* Added check in SPHealAnalyzerRuleState for incorrect default rule schedule of + one rule +* Improved check for CloudSSA in SPSearchServiceApp +* Bugfix in SPSearchServiceApp in which the database and dbserver were not + returned correctly +* Improved runtime of SPSearchTopology by streamlining wait processes +* Fixed bug with SPSearchServiceApp that would throw an error about SDDL string +* Improved output of test results for AppVeyor and VS Code based test runs +* Fixed issue with SPWebAppPolicy if OS language is not En-Us +* Added SPFarm resource, set SPCreateFarm and SPJoinFarm as deprecated to be + removed in version 2.0 ' } # End of PSData hashtable From 211c0f457325204e03c1bcc096a724ba4eeb86e6 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Thu, 11 May 2017 09:42:50 +1000 Subject: [PATCH 09/18] doco updates --- .../en-US/about_SPFarmPropertyBag.help.txt | 3 + .../en-us/about_SPAccessServiceApp.help.txt | 3 + .../en-us/about_SPAlternateUrl.help.txt | 3 + .../about_SPAppManagementServiceApp.help.txt | 3 + .../en-us/about_SPBCSServiceApp.help.txt | 3 + .../en-us/about_SPContentDatabase.help.txt | 3 + .../en-us/about_SPDatabaseAAG.help.txt | 3 + .../about_SPDistributedCacheService.help.txt | 3 + .../en-us/about_SPExcelServiceApp.help.txt | 3 + .../en-us/about_SPFarmSolution.help.txt | 3 + .../en-us/about_SPFeature.help.txt | 3 + .../about_SPInstallLanguagePack.help.txt | 10 +- .../en-us/about_SPIrmSettings.help.txt | 3 + .../en-us/about_SPManagedAccount.help.txt | 3 + ...about_SPManagedMetaDataServiceApp.help.txt | 38 +++++++ .../en-us/about_SPManagedPath.help.txt | 3 + ...about_SPOfficeOnlineServerBinding.help.txt | 3 + ...bout_SPPerformancePointServiceApp.help.txt | 3 + ...about_SPPublishServiceApplication.help.txt | 3 + .../en-us/about_SPQuotaTemplate.help.txt | 3 + .../en-us/about_SPRemoteFarmTrust.help.txt | 3 + .../about_SPSearchContentSource.help.txt | 3 + .../en-us/about_SPSearchCrawlRule.help.txt | 5 +- .../en-us/about_SPSearchFileType.help.txt | 7 +- .../about_SPSearchIndexPartition.help.txt | 2 +- .../en-us/about_SPSearchResultSource.help.txt | 3 + .../en-us/about_SPSearchServiceApp.help.txt | 3 + .../about_SPSecureStoreServiceApp.help.txt | 3 + .../en-us/about_SPServiceAppPool.help.txt | 3 + .../about_SPServiceAppProxyGroup.help.txt | 3 + .../en-us/about_SPServiceInstance.help.txt | 3 + .../about_SPSessionStateService.help.txt | 3 + .../SharePointDsc/en-us/about_SPSite.help.txt | 7 ++ .../en-us/about_SPStateServiceApp.help.txt | 3 + ..._SPSubscriptionSettingsServiceApp.help.txt | 3 + ...bout_SPTrustedIdentityTokenIssuer.help.txt | 81 +++++++++++--- .../en-us/about_SPUsageApplication.help.txt | 3 + .../about_SPUserProfileProperty.help.txt | 3 + .../en-us/about_SPUserProfileSection.help.txt | 3 + .../about_SPUserProfileServiceApp.help.txt | 3 + .../about_SPUserProfileSyncService.help.txt | 3 + .../en-us/about_SPVisioServiceApp.help.txt | 3 + .../SharePointDsc/en-us/about_SPWeb.help.txt | 3 + .../en-us/about_SPWebAppProxyGroup.help.txt | 2 +- .../en-us/about_SPWebApplication.help.txt | 10 ++ .../about_SPWebApplicationExtension.help.txt | 101 ++++++++++++++++++ .../about_SPWordAutomationServiceApp.help.txt | 3 + .../about_SPWorkManagementServiceApp.help.txt | 3 + 48 files changed, 356 insertions(+), 21 deletions(-) create mode 100644 Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt index a00b751a4..0644d0bb4 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt @@ -6,6 +6,9 @@ This resource is used to work with SharePoint Property Bags at the farm level. The account that runs this resource must be a farm administrator. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the property bag is configured. + .PARAMETER Key Key - string The key of the SPFarm property bag diff --git a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt index 97a87c451..af0142a8a 100644 --- a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt @@ -7,6 +7,9 @@ within the local SharePoint farm. The resource will provision and configure the Access Services Service Application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the service application diff --git a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt index 7b760f0c1..c19dcabd8 100644 --- a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt @@ -8,6 +8,9 @@ application. Alternatively a URL can be removed from a zone to ensure that it will remain empty and have no alternate URL. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the setting is configured. + .PARAMETER WebAppUrl Key - String The URL of the web application to apply the alternate URL to diff --git a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt index 19a8de71d..db0141d21 100644 --- a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt @@ -12,6 +12,9 @@ configuration does not match, these parameters are only used for the initial provisioning of the service application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the app management service application diff --git a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt index ce665a340..32597f9e7 100644 --- a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt @@ -12,6 +12,9 @@ these parameters are only used for the initial provisioning of the service application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the BCS service app diff --git a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt index 3d4e5a760..1ef44784b 100644 --- a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt @@ -9,6 +9,9 @@ that the specified SQL instance is a different instance that is currently in use. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the content database is provisioned. + .PARAMETER Name Key - String Specifies the name of the content database diff --git a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt index 88c8d3578..834c30c21 100644 --- a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt @@ -16,6 +16,9 @@ This resource requires the April 2014 CU to be installed. The required cmdlets have been added in this CU: http://support.microsoft.com/kb/2880551 + The default value for the Ensure parameter is Present. When not specifying this + parameter, the content database is added to the AAG. + .PARAMETER DatabaseName Key - string The name of the database to put in the AlwaysOn group diff --git a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt index 0801e300f..f68a80185 100644 --- a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt @@ -23,6 +23,9 @@ a server check the others for distributed cache, it does not provision the cache automatically on all servers. If a previous server in the sequence does + The default value for the Ensure parameter is Present. When not specifying this + parameter, the distributed cache is provisioned. + .PARAMETER Name Key - String A name to assign to this resource - not really used. For example - AppFabricCachingService diff --git a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt index c030f81a1..45dea7a37 100644 --- a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt @@ -7,6 +7,9 @@ within the local SharePoint farm. The resource will provision and configure the Excel Services Service Application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the service application diff --git a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt index 9815b9600..89c6517d3 100644 --- a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt @@ -10,6 +10,9 @@ are specified, the solution will be deployed to all web applications. If the solution does not contain resources scoped for web applications the property + The default value for the Ensure parameter is Present. When not specifying this + parameter, the solution is deployed. + .PARAMETER Name Key - string The filename of the WSP package diff --git a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt index 5098c5c39..11006c2ee 100644 --- a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt @@ -8,6 +8,9 @@ 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 + The default value for the Ensure parameter is Present. When not specifying this + parameter, the feature is enabled. + .PARAMETER Name Key - string The name of the feature diff --git a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt index 3d194324d..359d97f42 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt @@ -5,8 +5,14 @@ This resource is used to install the SharePoint Language Pack binaries. The BinaryDir parameter should point to the path that setup.exe is located (not to - setup.exe itself). The BinaryInstallDays and BinaryInstallTime parameters - specify a window in which the update can be installed. This module depends on + setup.exe itself). + + The BinaryInstallDays and BinaryInstallTime parameters specify a window in which + the update can be installed. + + With SharePoint 2016, the Language Packs are offered as an EXE package. You have + to extract this package before installing, using the following command: + .\serverlanguagepack.exe /extract:[Extract Folder] .PARAMETER BinaryDir Key - String diff --git a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt index e76d4df35..bb52a8c22 100644 --- a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt @@ -6,6 +6,9 @@ This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS + The default value for the Ensure parameter is Present. When not specifying this + parameter, IRM is configured. + .PARAMETER Ensure Key - String Allowed values: Present, Absent diff --git a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt index 5a2c06a0a..2db706949 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt @@ -10,6 +10,9 @@ password change for the managed account, leaving these option out of the resource will ensure that no automatic password changing from SharePoint occurs. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the managed account is created. + .PARAMETER AccountName Key - string The username of the account diff --git a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt index be5f54070..de3fc3233 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt @@ -9,6 +9,9 @@ database server and database name properties are only used during provisioning, and will not be altered as part of the ongoing operation of the + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the managed metadata service application @@ -29,6 +32,10 @@ Write - string The name of the database for the service application +.PARAMETER TermStoreAdministrators + Write - string + A list of the users/groups who are administrators of the term store + .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -98,3 +105,34 @@ } +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm + and also include a specific list of users to be the term store administrators. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $SetupAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "SP_ManagedMetadata" + TermStoreAdministrators = @( + "CONTOSO\user1", + "CONTOSO\user2" + ) + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt index 801447909..387889cd9 100644 --- a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt @@ -11,6 +11,9 @@ host named site collections set HostHeader to true and the path will be created as a host header path to be applied for host named site collections. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the managed path is created. + .PARAMETER WebAppUrl Key - string The URL of the web application to apply the managed path to - this is ignored for host header web applications diff --git a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt index aadeb9d63..ef9deab6c 100644 --- a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt @@ -12,6 +12,9 @@ environment, the new bindings will all point to the one DNS Name. If used on an existing configuration that does not follow this rule, it will match only + The default value for the Ensure parameter is Present. When not specifying this + parameter, the zone is configured. + .PARAMETER Zone Key - string Allowed values: Internal-HTTP, Internal-HTTPS, External-HTTP, External-HTTPS diff --git a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt index bdaa14871..f3eb083f8 100644 --- a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt @@ -7,6 +7,9 @@ instances within the local SharePoint farm. The resource will provision and configure the Performance Point Service Application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the service application diff --git a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt index d8058bdae..8ec9b8521 100644 --- a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt @@ -18,6 +18,9 @@ * Search * Secure Store + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the service application to publish diff --git a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt index d4c7475b8..e5c9a3473 100644 --- a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt @@ -7,6 +7,9 @@ will be used to make sure a certain quota template exists or not. When it exists, it will also make sure the settings are configured as specified. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the quota template is created. + .PARAMETER Name Key - string The name of the quota template diff --git a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt index 6f722fab2..18b12dcf4 100644 --- a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt @@ -7,6 +7,9 @@ federating search results between two different SharePoint farms. The technique is described at + The default value for the Ensure parameter is Present. When not specifying this + parameter, the remote farm trust is created. + .PARAMETER Name Key - string A name of the remote farm, used to create token issuer and root authority diff --git a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt index 86807fd28..da63318da 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt @@ -6,6 +6,9 @@ This resource will deploy and configure a content source in a specified search service application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the content source is created. + .PARAMETER Name Key - String The name of the content source diff --git a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt index a958ee022..b8ad9d357 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt @@ -7,6 +7,9 @@ service application. You can create new rules, change existing rules and remove existing rules. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the crawl rule is created. + .PARAMETER Path Key - string The name of the search service application @@ -41,7 +44,7 @@ .PARAMETER Ensure Write - string Allowed values: Present, Absent - Present if the service app should exist, absent if it should not + Present if the crawl rule should exist, absent if it should not .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt index 1fe356853..e90e7fa9b 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt @@ -7,12 +7,15 @@ service application. You can create new file types, change existing types and remove existing file types. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the file type is added. + .PARAMETER FileType Key - string The name of the file type .PARAMETER ServiceAppName - Required - string + Key - string The name of the search service application .PARAMETER Description @@ -30,7 +33,7 @@ .PARAMETER Ensure Write - string Allowed values: Present, Absent - Present if the service app should exist, absent if it should not + Present if the file type should exist, absent if it should not .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt index bfe0c8333..e6b3f15e0 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt @@ -32,7 +32,7 @@ The directory that the index should use locally on each server to store data .PARAMETER ServiceAppName - Required - String + Key - String The name of the search service application .PARAMETER InstallAccount diff --git a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt index ff1a64d70..87ce4c00a 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt @@ -14,6 +14,9 @@ * Remote People Provider * Remote SharePoint Provider + The default value for the Ensure parameter is Present. When not specifying this + parameter, the result source is created. + .PARAMETER Name Key - String The name of the result source diff --git a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt index 3cc2c55a8..fe9cf0f94 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt @@ -11,6 +11,9 @@ the admin database which matches the name, and then "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well). + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the search service application diff --git a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt index 578cb763b..dcd0d8d78 100644 --- a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt @@ -8,6 +8,9 @@ specifics) are validated and set when the resource is run, the database values are only used in provisioning of the service application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the secure store service app diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt index 2e03efde4..9f03c2ae0 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt @@ -7,6 +7,9 @@ service applications. The account used for the service account must already be registered as a managed account (which can be provisioned through + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application pool is provisioned. + .PARAMETER Name Key - string The name of application pool diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt index e8d98cc8a..c1e52446c 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt @@ -20,6 +20,9 @@ ServiceAppProxiesToExclude properties needs to be specified. Do not combine the ServiceAppProxies property with the ServiceAppProxiesToInclude and + The default value for the Ensure parameter is Present. When not specifying this + parameter, the proxy group is created. + .PARAMETER Name Key - String Name of the Proxy Group to create diff --git a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt index d060d6587..0b2342092 100644 --- a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt @@ -7,6 +7,9 @@ (Ensure = "Present") or not running (Ensure = "Absent") on the current server. The name is the display name of the service as shown in the Central Admin + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service instance is started. + .PARAMETER Name Key - string The name of the service instance to manage diff --git a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt index 3a4475ba3..8949c9c96 100644 --- a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt @@ -7,6 +7,9 @@ the name of the database server and database name to provision the app with, and optionally include the session timeout value. If session timeout is not + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER DatabaseName Key - string The name of the database for the service diff --git a/Modules/SharePointDsc/en-us/about_SPSite.help.txt b/Modules/SharePointDsc/en-us/about_SPSite.help.txt index 5200bcc96..fe3bb4a3b 100644 --- a/Modules/SharePointDsc/en-us/about_SPSite.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSite.help.txt @@ -11,6 +11,13 @@ of a site collection, the additional parameters are not checked for yet, but will be in a later release + Note: When creating Host Header Site Collections, do not use the HostHeader + parameter in SPWebApplication. This will set the specified host header on your + IIS site and prevent the site from listening for the URL of the Host Header + Site Collection. + If you want to change the IIS website binding settings, please use the xWebsite + resource in the xWebAdministration module. + .PARAMETER Url Key - string The URL of the site collection diff --git a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt index 353665277..98947110b 100644 --- a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt @@ -7,6 +7,9 @@ The database specific parameters are only used during initial provisioning of the app, and will not change database settings beyond the initial deployment. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the state service app diff --git a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt index 8928a38f9..5cfe78035 100644 --- a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt @@ -12,6 +12,9 @@ not match, these parameters are only used for the initial provisioning of the service application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the subscription settings service app diff --git a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt index 0b0259d25..d184884a5 100644 --- a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt @@ -6,18 +6,22 @@ This resource is used to create or remove SPTrustedIdentityTokenIssuer in a SharePoint farm. - The SigningCertificateThumbPrint must match the thumbprint of a certificate in - the store LocalMachine\My of the server that will run this resource. + Either parameter SigningCertificateThumbPrint or SigningCertificateFilePath + must be set, but not both. + + The SigningCertificateThumbPrint must be the thumbprint of the signing + certificate stored in the certificate store LocalMachine\My of the server + Note that the private key of the certificate must not be available in the certiificate store because SharePoint does not accept it. - Once the SPTrustedIdentityTokenIssuer is successfully created, the certificate - can be safely deleted from the certificate store as it won't be needed by - SharePoint. - ClaimsMappings is an array of MSFT_SPClaimTypeMapping to use with cmdlet - New-SPClaimTypeMapping. Each MSFT_SPClaimTypeMapping requires properties Name - and IncomingClaimType. Property LocalClaimType is not required if its value is - identical to IncomingClaimType. + The SigningCertificateFilePath must be the file path to the public key of + the signing certificate. + + The ClaimsMappings property is an array of MSFT_SPClaimTypeMapping to use + with cmdlet New-SPClaimTypeMapping. Each MSFT_SPClaimTypeMapping requires + properties Name and IncomingClaimType. Property LocalClaimType is not + required if its value is identical to IncomingClaimType. The IdentifierClaim property must match an IncomingClaimType element in ClaimsMappings array. @@ -25,6 +29,9 @@ The ClaimProviderName property can be set to specify a custom claims provider. It must be already installed in the SharePoint farm and returned by cmdlet + The default value for the Ensure parameter is Present. When not specifying this + parameter, the token issuer is created. + .PARAMETER Name Key - String Name of the SPTrustedIdentityTokenIssuer @@ -49,9 +56,13 @@ Required - String Array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping -.PARAMETER SigningCertificateThumbPrint - Required - String - Thumbprint of the signing certificate to use with this SPTrustedIdentityTokenIssuer. It must match the thumbprint of a certificate located in store LocalMachine\\My +.PARAMETER SigningCertificateThumbprint + Write - String + Specify the thumbprint of the signing certificate, which must be located in certificate store LocalMachine\\My + +.PARAMETER SigningCertificateFilePath + Write - String + Specify the file path to the signing certificate if it is not stored in the local certificate store already .PARAMETER ClaimProviderName Write - String @@ -92,7 +103,49 @@ Realm = "https://sharepoint.contoso.com" SignInUrl = "https://adfs.contoso.com/adfs/ls/" IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ClaimsMappings = @( + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateThumbPrint = "F0D3D9D8E38C1D55A3CEF3AAD1C18AD6A90D5628" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example deploys a trusted token issuer to the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( MSFT_SPClaimTypeMapping{ Name = "Email" IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" @@ -103,7 +156,7 @@ LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" } ) - SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" + SigningCertificateFilePath = "F:\Data\DSC\FakeSigning.cer" ClaimProviderName = "LDAPCP" ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" Ensure = "Present" diff --git a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt index 792833626..f072a5703 100644 --- a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt @@ -7,6 +7,9 @@ application. The database settings are only used for initial provisioning, but the usage settings can be changed and will be enforced as the resource is + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the service application diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt index 5cbadf212..6b170b01b 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt @@ -16,6 +16,9 @@ This Resource doesn't currently support removing existing user profile + The default value for the Ensure parameter is Present. When not specifying this + parameter, the user profile property is created. + .PARAMETER Name Key - string The internal name of the user profile property diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt index c0c703eb9..062bde77c 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt @@ -9,6 +9,9 @@ If no DisplayOrder is added then SharePoint will automatically assigned an ID + The default value for the Ensure parameter is Present. When not specifying this + parameter, the user profile section is created. + .PARAMETER Name Key - string The internal name of the user profile section diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt index c480c99db..d112b75f9 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt @@ -11,6 +11,9 @@ done to ensure that the databases are created with the correct schema owners and allow the user profile sync service to operate correctly. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the user profile service diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt index ece5ed05f..209cf882b 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt @@ -14,6 +14,9 @@ the Administrators group. Therefore this resource will add the FarmAccount credential to the local administrators group at the beginning of the set + The default value for the Ensure parameter is Present. When not specifying this + parameter, the user profile sync service is provisioned. + .PARAMETER UserProfileServiceAppName Key - string The name of the user profile service for this sync instance diff --git a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt index 056f4a873..fe74ec48b 100644 --- a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt @@ -7,6 +7,9 @@ instances within the local SharePoint farm. The resource will provision and configure the Visio Graphics Service Application. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the service application diff --git a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt index 22e37e5ee..79e332fab 100644 --- a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt @@ -6,6 +6,9 @@ This resource will provision a SPWeb based on the settings that are passed through. These settings map to the New-SPWeb cmdlet and accept the same values + The default value for the Ensure parameter is Present. When not specifying this + parameter, the web is created. + .PARAMETER Url Key - string The URL of the web diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt index aa99691ff..12151f76f 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt @@ -19,7 +19,7 @@ .PARAMETER ServiceAppProxyGroup Required - string - Name of the Service Applicaiton Proxy Group + Name of the Service Application Proxy Group .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt index fee145788..a37cb4587 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt @@ -8,6 +8,16 @@ the current settings, and then ensure that it stays part of the correct application pool beyond that (additional checking and setting of properties + The default value for the Ensure parameter is Present. When not specifying this + parameter, the web application is provisioned. + + Note: When using Host Header Site Collections, do not use the HostHeader + parameter in SPWebApplication. This will set the specified host header on your + IIS site and prevent the site from listening for the URL of the Host Header + Site Collection. + If you want to change the IIS website binding settings, please use the xWebsite + resource in the xWebAdministration module. + .PARAMETER Name Key - string The name of the web application diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt new file mode 100644 index 000000000..461b6a58c --- /dev/null +++ b/Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt @@ -0,0 +1,101 @@ +.NAME + SPWebApplicationExtension + +# Description + + This resource is responsible for extending an existing web application into a new + zone. The resource will provision the web application extension with all of + the current settings, and then ensure that it stays present and will ensure the + AllowAnonymous and Authentication methods remain consistent. Please note that this + currently does not support changing the claims provider on an existing claims + enabled web application externsion. + +.PARAMETER WebAppUrl + Key - string + The URL of the parent web application + +.PARAMETER Name + Required - string + The name of the web application extension + +.PARAMETER Url + Required - string + The URL of the web application extension + +.PARAMETER Zone + Key - string + Allowed values: Default, Intranet, Internet, Extranet, Custom + Specifies one of the five zones with which the internal URL of this new extension is to be associated. + +.PARAMETER AllowAnonymous + Write - boolean + Should anonymous access be enabled for this web app extension + +.PARAMETER AuthenticationMethod + Write - string + Allowed values: NTLM, Kerberos, Claims + What authentication mode should be used for the web app extension + +.PARAMETER AuthenticationProvider + Write - string + What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims + +.PARAMETER HostHeader + Write - string + The host header to use for the web app extension + +.PARAMETER Path + Write - string + The path on the local servers to host the IIS web site from + +.PARAMETER Port + Write - string + The port to run the site on + +.PARAMETER UseSSL + Write - boolean + Should this web app extension use SSL + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the web app 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 + + +.EXAMPLE + This example shows how to create a new web application extension in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebApplicationExtension IntranetZone + { + WebAppUrl = "http://example.contoso.local" + Name = "Contoso Intranet Zone" + AllowAnonymous = $false + AuthenticationMethod = "NTLM" + Url = "http://intranet.contoso.local" + Zone = "Intranet" + HostHeader = "intranet.contoso.local" + Path = "c:\inetpub\wwwroot\wss\VirtualDirectories\intranet" + UseSSL = $false + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt index d45fe3fc8..4f031c8e7 100644 --- a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt @@ -13,6 +13,9 @@ are allowed (with the exception of Name, InstallAccount or PsDscRunAsCredential). + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string THe name of the service application diff --git a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt index 4232f7cb6..979c2cf81 100644 --- a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt @@ -16,6 +16,9 @@ MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in minutes. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + .PARAMETER Name Key - string The name of the work management service application From e34bf79c07ad4374a770dcaa88d65f43dfa4ba4c Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Thu, 11 May 2017 09:46:35 +1000 Subject: [PATCH 10/18] Fixed version number in AppVeyor --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index c6e1c8748..57558be0b 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,4 +1,4 @@ -version: 1.6.0.{build} +version: 1.7.0.{build} image: WMF 5 install: From 4f5387f2d98c0e78b01856ae7c9681e68bd64b51 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Mon, 3 Jul 2017 11:38:10 +1000 Subject: [PATCH 11/18] Version 1.8 release --- Modules/SharePointDsc/SharePointDsc.psd1 | 74 +++++++------------ .../en-us/about_SPBlobCacheSettings.help.txt | 2 +- .../en-us/about_SPInstall.help.txt | 4 + .../about_SPOutgoingEmailSettings.help.txt | 8 ++ .../en-us/about_SPProductUpdate.help.txt | 8 +- .../en-us/about_SPSearchServiceApp.help.txt | 4 + .../about_SPUserProfileServiceApp.help.txt | 42 +++++++++++ ...about_SPUserProfileSyncConnection.help.txt | 2 +- .../en-us/about_SPWebApplication.help.txt | 2 +- 9 files changed, 96 insertions(+), 50 deletions(-) diff --git a/Modules/SharePointDsc/SharePointDsc.psd1 b/Modules/SharePointDsc/SharePointDsc.psd1 index ed0cd8ae4..4bcfa6465 100644 --- a/Modules/SharePointDsc/SharePointDsc.psd1 +++ b/Modules/SharePointDsc/SharePointDsc.psd1 @@ -126,52 +126,34 @@ PrivateData = @{ # ReleaseNotes of this module ReleaseNotes = " -* Update SPSearchIndexPartition made ServiceAppName as a Key -* New resouce: SPTrustedRootAuthority -* Update SPFarmSolution to eject from loop after 30m. -* New resource: SPMachineTranslationServiceApp -* New resource: SPPowerPointAutomationServiceApp -* Bugfix in SPSearchFileType made ServiceAppName a key property. -* New resource: SPWebApplicationExtension -* Added new resource SPAccessServices2010 -* Added MSFT_SPSearchCrawlMapping Resource to manage Crawl Mappings for - Search Service Application -* Added new resource SPSearchAuthoritativePage -* Bugfix in SPWebAppThrottlingSettings for setting large list window time. -* Fix typo in method Get-TargetResource of SPFeature -* Fix bug in SPManagedAccount not returning the correct account name value -* Fix typo in method Get-TargetResource of SPSearchIndexPartition -* Update documentation of SPInstallLanguagePack to add guidance on package - change in SP2016 -* Added returning the required RunCentralAdmin parameter to - Get-TargetResource in SPFarm -* Added web role check for SPBlobCacheSettings -* Improved error message when rule could not be found in - SPHealthAnalyzerRuleState -* Extended the documentation to specify that the default value of Ensure - is Present -* Added documentation about the user of Host Header Site Collections and - the HostHeader parameter in SPWebApplication -* Fixed missing brackets in SPWebAppPolicy module file -* Fixed issue with SPSecureStoreServiceApp not returning database information -* Fixed issue with SPManagedMetadataServiceApp not returning ContentTypeHubUrl - in SP2016 -* Updated SPTrustedIdentityTokenIssuer to allow to specify the signing - certificate from file path as an alternative to the certificate store -* New resource: SPSearchCrawlerImpactRule -* Fixed issue in SPSite where the used template wasn't returned properly -* Fixed issue in SPWebApplicationGeneralSettings which didn't return the - security validation timeout properly -* Fixed bug in SPCreateFarm and SPJoinFarm when a SharePoint Server is already - joined to a farm -* Bugfix in SPContentDatabase for setting WarningSiteCount as 0. -* Fixing verbose message that identifies SP2016 as 2013 in MSFT_SPFarm -* Fixed SPProductUpdate looking for OSearch15 in SP2016 when stopping services -* Added TermStoreAdministrators property to SPManagedMetadataServiceApp -* Fixed an issue in SPSearchTopology that would leave a corrupt topology in - place if a server was removed and re-added to a farm -* Fixed bug in SPFarm that caused issues with database names that have dashes - in the names +* Fixed issue in SPServiceAppProxyGroup causing some service names to return as null +* Added TLS and SMTP port support for SharePoint 2016 +* Fixed issue in SPWebApplication where the Get method didn't return Classic + web applications properly +* Fixed issue in SPSubscriptionSettingsServiceApp not returning database values +* Updated Readme of SPInstall to include SharePoint Foundation is not supported +* Fixed issue with Access Denied in SPDesignerSettings +* Fixed missing brackets in error message in SPExcelServiceApp +* Removed the requirement for the ConfigWizard in SPInstallLanguagePack +* Fixed Language Pack detection issue in SPInstallLanguagePack +* Added support to set Windows service accounts for search related services to + SPSearchServiceApp resource +* Fixed issue in SPCreateFarm and SPJoinFarm where an exception was not handled + correctly +* Fixed issue in SPSessionStateService not returning correct database server + and name +* Fixed missing Ensure property default in SPRemoteFarmTrust +* Fixed issue in SPWebAppGeneralSettings where -1 was returned for the TimeZone +* Fixed incorrect UsagePoint check in SPQuotaTemplate +* Fixed issue in SPWebAppPolicy module where verbose messages are causing errors +* Fixed incorrect parameter naming in Get method of SPUserProfilePropery +* Fixed issue in SPBlobCacheSettings when trying to declare same URL with + different zone +* Improve documentation on SPProductUpdate to specify the need to unblock downloaded + files +* Added check if file is blocked in SPProductUpdate to prevent endless wait +* Enhance SPUserProfileServiceApp to allow for NoILM to be enabled +* Fixed issue in SPUserProfileProperty where PropertyMapping was Null " } # End of PSData hashtable diff --git a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt index f1bf121a8..bc524e718 100644 --- a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt @@ -27,7 +27,7 @@ The URL of the web application .PARAMETER Zone - Required - string + Key - string Allowed values: Default, Intranet, Internet, Custom, Extranet The zone of the web application for which blob cache has to be configured diff --git a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt index 827c7b957..937fce5d5 100644 --- a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt @@ -9,6 +9,10 @@ file and validate the license key during the installation process. This module depends on the prerequisites already being installed, which can be done + NOTE: This resource only supports SharePoint Server. SharePoint Foundation + is not supported. For examples to install SharePoint Foundation using DSC, see: + https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3) + ## Installing from network locations If you wish to install SharePoint from a network location this can diff --git a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt index 5fb27d486..b09350b20 100644 --- a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt @@ -30,6 +30,14 @@ Required - string The character set to use on messages +.PARAMETER UseTLS + Write - boolean + Use TLS when connecting to the SMTP server (SharePoint 2016 only) + +.PARAMETER SMTPPort + Write - uint32 + The port which is used to connect to the SMTP server (SharePoint 2016 only) + .PARAMETER InstallAccount Write - String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 diff --git a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt index d478fe6ff..907f29fdc 100644 --- a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt @@ -13,6 +13,12 @@ resource to fully complete the installation of the update, which can be done through the use of SPConfigWizard. + NOTE: + When files are downloaded from the Internet, a Zone.Identifier alternate data + stream is added to indicate that the file is potentially from an unsafe source. + To use these files, make sure you first unblock them using Unblock-File. + SPProductUpdate will throw an error when it detects the file is blocked. + IMPORTANT: This resource retrieves build information from the Configuration Database. Therefore it requires SharePoint to be installed and a farm created. If you @@ -22,7 +28,7 @@ 1. Install the SharePoint Binaries (SPInstall) 2. (Optional) Install SharePoint Language Pack(s) Binaries (SPInstallLanguagePack) - 3. Create SPFarm (SPCreateFarm) + 3. Create SPFarm (SPFarm) 4. Install Cumulative Updates (SPProductUpdate) 5. Run the Configuration Wizard (SPConfigWizard) diff --git a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt index fe9cf0f94..d2e2bf507 100644 --- a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt @@ -51,6 +51,10 @@ Allowed values: Present, Absent Present if the service app should exist, absent if it should not +.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 diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt index d112b75f9..4aa51ed58 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt @@ -62,6 +62,10 @@ Write - boolean Whether Farm should resolve NetBIOS domain names +.PARAMETER NoILMUsed + Write - boolean + Specifies if the service application should be configured to use AD Import + .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -109,3 +113,41 @@ } +.EXAMPLE + This example adds a new user profile service application to the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileServiceApp UserProfileServiceApp + { + Name = "User Profile Service Application" + ApplicationPool = "SharePoint Service Applications" + MySiteHostLocation = "http://my.sharepoint.contoso.local" + ProfileDBName = "SP_UserProfiles" + ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" + SocialDBName = "SP_Social" + SocialDBServer = "SQL.contoso.local\SQLINSTANCE" + SyncDBName = "SP_ProfileSync" + SyncDBServer = "SQL.contoso.local\SQLINSTANCE" + EnableNetBIOS = $false + NoILMUsed = $true + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt index 277f902fd..8b4409e0a 100644 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt @@ -26,7 +26,7 @@ .PARAMETER IncludedOUs Required - string - A listo f the OUs to import users from + A list of the OUs to import users from .PARAMETER ExcludedOUs Write - string diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt index a37cb4587..42d76ab7f 100644 --- a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt @@ -40,7 +40,7 @@ .PARAMETER AuthenticationMethod Write - string - Allowed values: NTLM, Kerberos, Claims + Allowed values: NTLM, Kerberos, Claims, Classic What authentication mode should be used for the web app .PARAMETER AuthenticationProvider From 84a3bdb672ad0edc042beaeb485d09a0a22b17cc Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Thu, 7 Sep 2017 11:48:39 +0200 Subject: [PATCH 12/18] Hit issue with folder casing - Correcting --- .../SharePointDsc/en-US/about_SPFarm.help.txt | 210 ------------------ .../en-US/about_SPFarmPropertyBag.help.txt | 84 ------- .../en-us/about_SPAccessServiceApp.help.txt | 89 -------- .../en-us/about_SPAlternateUrl.help.txt | 87 -------- .../en-us/about_SPAntivirusSettings.help.txt | 65 ------ .../en-us/about_SPAppCatalog.help.txt | 45 ---- .../en-us/about_SPAppDomain.help.txt | 45 ---- .../about_SPAppManagementServiceApp.help.txt | 101 --------- .../en-us/about_SPAppStoreSettings.help.txt | 99 --------- .../en-us/about_SPBCSServiceApp.help.txt | 97 -------- .../en-us/about_SPBlobCacheSettings.help.txt | 87 -------- .../en-us/about_SPCacheAccounts.help.txt | 84 ------- .../en-us/about_SPConfigWizard.help.txt | 79 ------- .../en-us/about_SPContentDatabase.help.txt | 104 --------- .../en-us/about_SPCreateFarm.help.txt | 191 ---------------- .../en-us/about_SPDatabaseAAG.help.txt | 120 ---------- .../en-us/about_SPDesignerSettings.help.txt | 96 -------- ...about_SPDiagnosticLoggingSettings.help.txt | 129 ----------- .../about_SPDistributedCacheService.help.txt | 174 --------------- .../en-us/about_SPExcelServiceApp.help.txt | 152 ------------- .../en-us/about_SPFarmAdministrators.help.txt | 89 -------- .../en-us/about_SPFarmSolution.help.txt | 77 ------- .../en-us/about_SPFeature.help.txt | 93 -------- .../about_SPHealthAnalyzerRuleState.help.txt | 62 ------ .../en-us/about_SPInstall.help.txt | 127 ----------- .../about_SPInstallLanguagePack.help.txt | 91 -------- .../en-us/about_SPInstallPrereqs.help.txt | 181 --------------- .../en-us/about_SPIrmSettings.help.txt | 54 ----- .../en-us/about_SPJoinFarm.help.txt | 98 -------- .../en-us/about_SPManagedAccount.help.txt | 105 --------- ...about_SPManagedMetaDataServiceApp.help.txt | 138 ------------ .../en-us/about_SPManagedPath.help.txt | 121 ---------- ...about_SPOfficeOnlineServerBinding.help.txt | 87 -------- .../about_SPOutgoingEmailSettings.help.txt | 100 --------- .../about_SPPasswordChangeSettings.help.txt | 58 ----- ...bout_SPPerformancePointServiceApp.help.txt | 93 -------- .../en-us/about_SPProductUpdate.help.txt | 145 ------------ ...about_SPPublishServiceApplication.help.txt | 87 -------- .../en-us/about_SPQuotaTemplate.help.txt | 69 ------ .../en-us/about_SPRemoteFarmTrust.help.txt | 59 ----- .../about_SPSearchContentSource.help.txt | 154 ------------- .../en-us/about_SPSearchCrawlRule.help.txt | 110 --------- .../en-us/about_SPSearchFileType.help.txt | 97 -------- .../about_SPSearchIndexPartition.help.txt | 68 ------ .../en-us/about_SPSearchResultSource.help.txt | 76 ------- .../en-us/about_SPSearchServiceApp.help.txt | 113 ---------- .../en-us/about_SPSearchTopology.help.txt | 89 -------- .../about_SPSecureStoreServiceApp.help.txt | 127 ----------- .../en-us/about_SPServiceAppPool.help.txt | 55 ----- .../about_SPServiceAppProxyGroup.help.txt | 83 ------- .../en-us/about_SPServiceAppSecurity.help.txt | 81 ------- .../en-us/about_SPServiceInstance.help.txt | 76 ------- .../about_SPSessionStateService.help.txt | 59 ----- .../en-us/about_SPShellAdmins.help.txt | 120 ---------- .../SharePointDsc/en-us/about_SPSite.help.txt | 104 --------- .../en-us/about_SPStateServiceApp.help.txt | 63 ------ ..._SPSubscriptionSettingsServiceApp.help.txt | 96 -------- .../en-us/about_SPTimerJobState.help.txt | 72 ------ ...bout_SPTrustedIdentityTokenIssuer.help.txt | 168 -------------- .../en-us/about_SPUsageApplication.help.txt | 86 ------- .../about_SPUserProfileProperty.help.txt | 168 -------------- .../en-us/about_SPUserProfileSection.help.txt | 68 ------ .../about_SPUserProfileServiceApp.help.txt | 153 ------------- ...PUserProfileServiceAppPermissions.help.txt | 59 ----- ...about_SPUserProfileSyncConnection.help.txt | 93 -------- .../about_SPUserProfileSyncService.help.txt | 71 ------ .../en-us/about_SPVisioServiceApp.help.txt | 85 ------- .../SharePointDsc/en-us/about_SPWeb.help.txt | 86 ------- .../about_SPWebAppBlockedFileTypes.help.txt | 90 -------- .../about_SPWebAppGeneralSettings.help.txt | 124 ----------- .../en-us/about_SPWebAppPermissions.help.txt | 89 -------- .../en-us/about_SPWebAppPolicy.help.txt | 123 ---------- .../en-us/about_SPWebAppProxyGroup.help.txt | 52 ----- .../about_SPWebAppSiteUseAndDeletion.help.txt | 62 ------ .../about_SPWebAppThrottlingSettings.help.txt | 97 -------- .../about_SPWebAppWorkflowSettings.help.txt | 57 ----- .../en-us/about_SPWebApplication.help.txt | 179 --------------- .../about_SPWebApplicationAppDomain.help.txt | 64 ------ .../about_SPWebApplicationExtension.help.txt | 101 --------- .../about_SPWordAutomationServiceApp.help.txt | 161 -------------- .../about_SPWorkManagementServiceApp.help.txt | 92 -------- 81 files changed, 8043 deletions(-) delete mode 100644 Modules/SharePointDsc/en-US/about_SPFarm.help.txt delete mode 100644 Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPFeature.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPInstall.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSite.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWeb.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt delete mode 100644 Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt deleted file mode 100644 index b433f1629..000000000 --- a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt +++ /dev/null @@ -1,210 +0,0 @@ -.NAME - SPFarm - -# Description - - This resource is used to create a new SharePoint farm and allow servers to - join that farm. It will detect the presence of the configuration database - on the SQL server as a first step, and if it does not exist then the farm - will be created. If the database does exist, the server will join that - configuration database. Once the config DB has been created, the - resource will install local help collections, secure resources and activate - features. - - If the central admin site is to be running on the local server, the - RunCentralAdmin property should be set to true. In the event that the central - admin site has not been provisioned, this resource will first create it, - otherwise it will simply start the central admin service instance on the - local server. - - The passphrase is passed as a Credential object.The username of this - credential is ignored, only the value of the password is used as the farm - passphrase. - - 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 SPDistributedCacheService on at least one server in the farm to - designate it as a cache server. - - CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not - specified, it defaults to NTLM. If using Kerberos, make sure to have - appropriate SPNs setup for Farm account and Central Administration URI. - -.PARAMETER Ensure - Key - string - Allowed values: Present, Absent - Present to create/join the farm. Absent is currently not supported - -.PARAMETER FarmConfigDatabaseName - Required - String - Name of the configuration database - -.PARAMETER DatabaseServer - Required - String - Server that will host the configuration and admin content databases - -.PARAMETER FarmAccount - Required - String - The account to use as the main farm account - -.PARAMETER Passphrase - Required - String - The passphrase to use to allow servers to join this farm - -.PARAMETER AdminContentDatabaseName - Required - String - The name of the admin content database - -.PARAMETER RunCentralAdmin - Required - Boolean - Should the central admin site run on this specific server? - -.PARAMETER CentralAdministrationPort - Write - uint32 - What port will Central Admin be provisioned to - default is 9999 - -.PARAMETER CentralAdministrationAuth - Write - String - Allowed values: NTLM, Kerberos - The authentication provider of the CentralAdministration web application - -.PARAMETER ServerRole - Write - string - Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache - SharePoint 2016 only - the MinRole role to enroll this server as - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. By default the central admin site in this - example is provisioned to port 9999 using NTLM authentication. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFarm SharePointFarm - { - Ensure = "Present" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - RunCentralAdmin = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. Here the port for the central admin site to - run on, as well as the authentication mode for the site are also specified. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFarm SharePointFarm - { - Ensure = "Present" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - CentralAdministrationPort = 5000 - CentralAdministrationAuth = "Kerberos" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - RunCentralAdmin = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. By default the central admin site in this - example is provisioned to port 9999 using NTLM authentication. In this example we also see - the server role defined as "Application" which tells SharePoint 2016 the role to apply to - this server as soon as the farm is created. This property is not supported for SharePoint 2013 - and so this specific example would fail if used against that verison. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFarm SharePointFarm - { - Ensure = "Present" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - ServerRole = "Application" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - RunCentralAdmin = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt deleted file mode 100644 index 0644d0bb4..000000000 --- a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt +++ /dev/null @@ -1,84 +0,0 @@ -.NAME - SPFarmPropertyBag - -# Description - - This resource is used to work with SharePoint Property Bags at the farm level. - The account that runs this resource must be a farm administrator. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the property bag is configured. - -.PARAMETER Key - Key - string - The key of the SPFarm property bag - -.PARAMETER Value - Write - String - Value of the SPfarm property bag - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Set to present to ensure the SPfarm property exists, or absent to ensure it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how add property bag in the current farm. - - -Configuration Example -{ - param - ( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - - Import-DscResource -ModuleName SharePointDsc - - node localhost - { - SPFarmPropertyBag APPLICATION_APPCodeProperty - { - PsDscRunAsCredential = $SetupAccount - Key = "FARM_TYPE" - Value = "SearchFarm" - Ensure = "Present" - } - } -} - - -.EXAMPLE - This example shows how remove property bag in the current farm. - - -Configuration Example -{ - param - ( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - - Import-DscResource -ModuleName SharePointDsc - - node localhost - { - SPFarmPropertyBag APPLICATION_APPCodeProperty - { - PsDscRunAsCredential = $SetupAccount - Key = "KeyToRemove" - Ensure = "Absent" - } - } -} - - diff --git a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt deleted file mode 100644 index af0142a8a..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAccessServiceApp.help.txt +++ /dev/null @@ -1,89 +0,0 @@ -.NAME - SPAccessServiceApp - -# Description - - This resource is responsible for creating Access Services Application instances - within the local SharePoint farm. The resource will provision and configure the - Access Services Service Application. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the service application - -.PARAMETER ApplicationPool - Required - string - The name of the application pool to run the service app in - -.PARAMETER DatabaseServer - Required - string - The name of the database server to host Access Services databases - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures service app exists, absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to deploy Access Services 2013 to the local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAccessServiceApp AccessServices - { - Name = "Access Services Service Application" - ApplicationPool = "SharePoint Service Applications" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - - This example shows how to remove a specific Access Services 2013 from the local - SharePoint farm. Because Application pool and database server are both required - parameters, but are not acutally needed to remove the app, any text value can - be supplied for these as they will be ignored. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAccessServiceApp AccessServices - { - Name = "Access Services Service Application" - ApplicationPool = "n/a" - DatabaseServer = "n/a" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt deleted file mode 100644 index c19dcabd8..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAlternateUrl.help.txt +++ /dev/null @@ -1,87 +0,0 @@ -.NAME - SPAlternateUrl - -# Description - - This resource is used to define an alternate access mapping URL for a specified - web application. These can be assigned to specific zones for each web - application. Alternatively a URL can be removed from a zone to ensure that it - will remain empty and have no alternate URL. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the setting is configured. - -.PARAMETER WebAppUrl - Key - String - The URL of the web application to apply the alternate URL to - -.PARAMETER Zone - Key - String - Allowed values: Default, Intranet, Extranet, Custom, Internet - The Zone to use for the alternate URL - -.PARAMETER Url - Write - String - The new alternate URL - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures the URL is set for this zone on this web app, Absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to add a new alternate URL to a specific web application - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAlternateUrl CentralAdminAAM - { - WebAppUrl = "http://sharepoint1:9999" - Zone = "Intranet" - Url = "https://admin.sharepoint.contoso.com" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to remove an alternate URL from a specified zone for a specific - web application. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAlternateUrl CentralAdminAAM - { - WebAppUrl = "http://sharepoint1:9999" - Zone = "Intranet" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt deleted file mode 100644 index e5310458b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAntivirusSettings.help.txt +++ /dev/null @@ -1,65 +0,0 @@ -.NAME - SPAntivirusSettings - -# 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. - -.PARAMETER ScanOnDownload - Key - Boolean - Should documents be scanned before being downloaded - -.PARAMETER ScanOnUpload - Write - Boolean - Should documents be scanned on upload - -.PARAMETER AllowDownloadInfected - Write - Boolean - Should documents that are infected be allowed to be downloaded - -.PARAMETER AttemptToClean - Write - Boolean - Should infected documents be handed to the AV engine to attempt cleaning - -.PARAMETER TimeoutDuration - Write - Uint16 - What is the timeout for an AV scan in seconds - -.PARAMETER NumberOfThreads - Write - Uint16 - How many concurrent threads should the AV engine be able to run on a server - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply specific anti-virus configuration to the farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAntivirusSettings AVSettings - { - ScanOnDownload = $true - ScanOnUpload = $true - AllowDownloadInfected = $false - AttemptToClean = $false - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt deleted file mode 100644 index 7503bc167..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAppCatalog.help.txt +++ /dev/null @@ -1,45 +0,0 @@ -.NAME - SPAppCatalog - -# 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). - - This resource should be run using the farm account, and not another specific - setup account. Running this with the setup account you have used in your - configuration may relate to access denied errors. - -.PARAMETER SiteUrl - Key - string - The URL of the site collection that will be the app catalog for the web app that it is in - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to configure the AppCatalog in the farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppCatalog MainAppCatalog - { - SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt deleted file mode 100644 index a0dd1da87..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAppDomain.help.txt +++ /dev/null @@ -1,45 +0,0 @@ -.NAME - SPAppDomain - -# 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. - -.PARAMETER AppDomain - Key - string - The domain name for apps to use in this farm - -.PARAMETER Prefix - Required - string - The prefix to go on to app URLs - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply app URLs to the current farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppDomain LocalFarmAppUrls - { - AppDomain = "contosointranetapps.com" - Prefix = "app" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt deleted file mode 100644 index db0141d21..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAppManagementServiceApp.help.txt +++ /dev/null @@ -1,101 +0,0 @@ -.NAME - SPAppManagementServiceApp - -# 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. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the app management service application - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER ApplicationPool - Required - String - The app pool that should be used to run the service app - -.PARAMETER DatabaseName - Write - string - The name of the database for the service application - -.PARAMETER DatabaseServer - Write - String - The name of the server for the database - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures service app exists, absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to create a new app management service application in the - local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppManagementServiceApp AppManagementServiceApp - { - Name = "App Management Service Application" - ApplicationPool = "SharePoint Service Applications" - DatabaseServer = "SQL01.contoso.com" - DatabaseName = "SP_AppManagement" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to remove a specific app management service application in the - local SharePoint farm. The application pool property is still mandatory but it is not - used so therefore the value is not important. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppManagementServiceApp AppManagementServiceApp - { - Name = "App Management Service Application" - ApplicationPool = "n/a" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt deleted file mode 100644 index 20fc57d6c..000000000 --- a/Modules/SharePointDsc/en-us/about_SPAppStoreSettings.help.txt +++ /dev/null @@ -1,99 +0,0 @@ -.NAME - SPAppStoreSettings - -# Description - - This resource will configure the ability to purchase apps for both SharePoint - and Office apps. - -.PARAMETER WebAppUrl - Key - string - The URL of the web application - -.PARAMETER AllowAppPurchases - Write - Boolean - Specifies if App Purchases from the SharePoint Store are allowed - -.PARAMETER AllowAppsForOffice - Write - Boolean - Specifies if App Purchases for Office applications are allowed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to configure the AppCatalog in the farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppStoreSettings EnableSharePointAppStore - { - WebAppUrl = "https://sharepoint.contoso.com" - AllowAppPurchases = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to configure the AppCatalog in the farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppStoreSettings EnableAppStores - { - WebAppUrl = "https://sharepoint.contoso.com" - AllowAppPurchases = $true - AllowAppsForOffice = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to configure the AppCatalog in the farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPAppStoreSettings DisableAppStores - { - WebAppUrl = "https://sharepoint.contoso.com" - AllowAppPurchases = $false - AllowAppsForOffice = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt deleted file mode 100644 index 32597f9e7..000000000 --- a/Modules/SharePointDsc/en-us/about_SPBCSServiceApp.help.txt +++ /dev/null @@ -1,97 +0,0 @@ -.NAME - SPBCSServiceApp - -# 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. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the BCS service app - -.PARAMETER ApplicationPool - Required - String - The application pool it should run in - -.PARAMETER DatabaseName - Write - string - Name of the database to create for the service app - -.PARAMETER DatabaseServer - Write - String - Name of the database server to host the database on - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures service app exists, absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to deploy a Business Connectivity Services application to the - local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPBCSServiceApp BCSServiceApp - { - Name = "BCS Service Application" - ApplicationPool = "SharePoint Service Applications" - DatabaseName = "SP_BCS" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - InstallAccount = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to deploy a Business Connectivity Services application to the - local SharePoint farm. The application pool account is mandatory but the value is - ignored when removing a service app, so the value entered here does not matter. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPBCSServiceApp BCSServiceApp - { - Name = "BCS Service Application" - ApplicationPool = "n/a" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt deleted file mode 100644 index bc524e718..000000000 --- a/Modules/SharePointDsc/en-us/about_SPBlobCacheSettings.help.txt +++ /dev/null @@ -1,87 +0,0 @@ -.NAME - SPBlobCacheSettings - -# Description - - This resource is used to configure the Blob Cache settings for a web - application. - - Important: - This resource only configures the local server. It changes the web.config - file directly and is NOT using the SPWebConfigModifications class. In order - to configure all WFE servers in the farm, you have to apply this resource - to all servers. - - Note: - - - In order to prevent inconsistancy between different web front end servers, - make sure you configure this setting on all servers equally. - - If the specified folder does not exist, the resource will create the folder. - - Best practice: - Specify a directory that is not on the same drive as where either the server - operating system swap files or server log files are stored. - -.PARAMETER WebAppUrl - Key - string - The URL of the web application - -.PARAMETER Zone - Key - string - Allowed values: Default, Intranet, Internet, Custom, Extranet - The zone of the web application for which blob cache has to be configured - -.PARAMETER EnableCache - Required - Boolean - Specify if the blob cache has to be enabled - -.PARAMETER Location - Write - string - The location where the blob cache has to store its files - -.PARAMETER MaxSizeInGB - Write - Uint16 - The maximum size (in GB) of disk space the blob cache is allowed to use - -.PARAMETER MaxAgeInSeconds - Write - Uint32 - The maximum age (in seconds) that a browser caches a blob - -.PARAMETER FileTypes - Write - string - Specify the file types that must be stored by the blob cache - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to configure the blob cache settings on the local server for the - specified web application and zone - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPBlobCacheSettings BlobCacheSettings - { - WebAppUrl = "http://intranet.contoso.com" - Zone = "Default" - EnableCache = $true - Location = "F:\BlobCache" - MaxSizeInGB = 10 - FileTypes = "\.(gif|jpg|png|css|js)$" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt deleted file mode 100644 index cdc335f2d..000000000 --- a/Modules/SharePointDsc/en-us/about_SPCacheAccounts.help.txt +++ /dev/null @@ -1,84 +0,0 @@ -.NAME - SPCacheAccounts - -# 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)). - -.PARAMETER WebAppUrl - Key - string - The URL of the web application to set the accounts for - -.PARAMETER SuperUserAlias - Required - string - The account name for the super user - -.PARAMETER SuperReaderAlias - Required - string - The account name for the super reader - -.PARAMETER SetWebAppPolicy - Write - boolean - Should the web app policy be set for these accounts? - -.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 super use and reader accounts for the specified web app. It will - also set the appropriate web app policies by default for these accounts. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCacheAccounts SetCacheAccounts - { - WebAppUrl = "http://sharepoint.contoso.com" - SuperUserAlias = "DEMO\svcSPSuperUser" - SuperReaderAlias = "DEMO\svcSPReader" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example sets the super use and reader accounts for the specified web app. It will - not set the web app policies for these accounts though, allowing them to be controlled - elsewhere (either manually or with SPWebAppPolicy) - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCacheAccounts SetCacheAccounts - { - WebAppUrl = "http://sharepoint.contoso.com" - SuperUserAlias = "DEMO\svcSPSuperUser" - SuperReaderAlias = "DEMO\svcSPReader" - SetWebAppPolicy = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt deleted file mode 100644 index c61bfe6e6..000000000 --- a/Modules/SharePointDsc/en-us/about_SPConfigWizard.help.txt +++ /dev/null @@ -1,79 +0,0 @@ -.NAME - SPConfigWizard - -# Description - - This resource is used to perform the upgrade step of installing SharePoint - updates, like Cumulative Updates, Service Packs and Language Packs. The - DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in - which the update can be installed. This module has to be used to complete the - update installation step, performed by SPProductUpdate. - -.PARAMETER Ensure - Key - string - Allowed values: Present, Absent - Present to install SharePoint. Absent is currently not supported - -.PARAMETER DatabaseUpgradeDays - Write - String - Allowed values: mon, tue, wed, thu, fri, sat, sun - Specify on which dates running the Configuration Wizard is allowed - -.PARAMETER DatabaseUpgradeTime - Write - String - Specify in which time frame running the Configuration Wizard is allowed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example runs the Configuration Wizard as soon as it is applied. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPConfigWizard RunConfigWizard - { - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example only runs the Configuration Wizard in the specified window: - - Saturday and Sunday night between 3am and 5am. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPConfigWizard RunConfigWizard - { - Ensure = "Present" - DatabaseUpgradeDays = "sat", "sun" - DatabaseUpgradeTime = "3:00am to 5:00am" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt deleted file mode 100644 index 1ef44784b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPContentDatabase.help.txt +++ /dev/null @@ -1,104 +0,0 @@ -.NAME - SPContentDatabase - -# Description - - This resource is used to add and remove Content Databases to web applications - and configure these databases. Note: The resource cannot be used to move the - database to a different SQL instance. It will throw an error when it detects - that the specified SQL instance is a different instance that is currently in - use. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the content database is provisioned. - -.PARAMETER Name - Key - String - Specifies the name of the content database - -.PARAMETER DatabaseServer - Write - string - The name of the database server to host the content DB - -.PARAMETER WebAppUrl - Required - string - The URL of the web application - -.PARAMETER Enabled - Write - Boolean - Should the database be enabled - -.PARAMETER WarningSiteCount - Write - Uint16 - Specify the site collection warning limit for the content database - -.PARAMETER MaximumSiteCount - Write - Uint16 - Specify the site collection maximum limit for the content database - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to create this database, absent to ensure it does not exist - -.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 content database for the specified web application. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPContentDatabase ContentDB - { - Name = "SharePoint_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - WebAppUrl = "http://sharepoint.contoso.com" - Enabled = $true - WarningSiteCount = 2000 - MaximumSiteCount = 5000 - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example dismounts a content database from the specified web application. This - will not remove the database from SQL server however, only taking it out of the - web applications configuration. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPContentDatabase ContentDB - { - Name = "SharePoint_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - WebAppUrl = "http://sharepoint.contoso.com" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt deleted file mode 100644 index 49b7b24c2..000000000 --- a/Modules/SharePointDsc/en-us/about_SPCreateFarm.help.txt +++ /dev/null @@ -1,191 +0,0 @@ -.NAME - SPCreateFarm - -# Description - - WARNING: This resource is deprecated. Please use SPFarm instead as - this resource will be removed from version 2.0 of SharePointDsc - - 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 SPJoinFarm. 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 passphrase is passed as a Credential object.The username of this - credential is ignored, only the value of the password is used as the farm - passphrase. - - 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 SPDistributedCacheService on at least one server in the farm to - designate it as a cache server. - - CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not - specified, it defaults to NTLM. If using Kerberos, make sure to have - appropriate SPNs setup for Farm account and Central Administration URI. - -.PARAMETER FarmConfigDatabaseName - Key - String - Name of the configuration database - -.PARAMETER DatabaseServer - Key - String - Server that will host the configuration and admin content databases - -.PARAMETER FarmAccount - Required - String - The account to use as the main farm account - -.PARAMETER Passphrase - Required - String - The passphrase to use to allow servers to join this farm - -.PARAMETER AdminContentDatabaseName - Required - String - The name of the admin content database - -.PARAMETER CentralAdministrationPort - Write - uint32 - What port will Central Admin be provisioned to - default is 9999 - -.PARAMETER CentralAdministrationAuth - Write - String - Allowed values: NTLM, Kerberos - The authentication provider of the CentralAdministration web application - -.PARAMETER ServerRole - Write - string - Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache - SharePoint 2016 only - the MinRole role to enroll this server as - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. By default the central admin site in this - example is provisioned to port 9999 using NTLM authentication. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCreateFarm CreateFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. Here the port for the central admin site to - run on, as well as the authentication mode for the site are also specified. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCreateFarm CreateFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - CentralAdministrationPort = 5000 - CentralAdministrationAuth = "Kerberos" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. By default the central admin site in this - example is provisioned to port 9999 using NTLM authentication. In this example we also see - the server role defined as "Application" which tells SharePoint 2016 the role to apply to - this server as soon as the farm is created. This property is not supported for SharePoint 2013 - and so this specific example would fail if used against that verison. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCreateFarm CreateFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - ServerRole = "Application" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt deleted file mode 100644 index 834c30c21..000000000 --- a/Modules/SharePointDsc/en-us/about_SPDatabaseAAG.help.txt +++ /dev/null @@ -1,120 +0,0 @@ -.NAME - SPDatabaseAAG - -# Description - - This resource will allow specifying which SQL Server AlwaysOn Availability - group a resource should be in. This resource does not configure the - Availability Groups on SQL Server, they must already exist. It simply adds - the specified database to the group. - - You can add a single database name by specifying the database name, or - multiple databases by specifying wildcards. For example: - SP_Content* or *Content* - - Important: - This resource requires the April 2014 CU to be installed. The required - cmdlets have been added in this CU: http://support.microsoft.com/kb/2880551 - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the content database is added to the AAG. - -.PARAMETER DatabaseName - Key - string - The name of the database to put in the AlwaysOn group - -.PARAMETER AGName - Required - string - Name of the AlwaysOn group on the SQL server - this must already exist - -.PARAMETER FileShare - Write - string - The fileshare to use for the SQL backup when adding to the group - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the database should be in this AlwaysOn group, or Absent if it should not be in the group - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example takes an existing SharePoint database and puts it in to the specified - AlwaysOn Availability Group (AAG). - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDatabaseAAG ConfigDBAAG - { - DatabaseName = "SP_Config" - AGName = "MyAvailabilityGroup" - FileShare = "\\SQL\Backups" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example takes existing SharePoint databases, based on the database name pattern, and puts - them in to the specified AlwaysOn Availability Group (AAG). - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDatabaseAAG ConfigDBAAG - { - DatabaseName = "*Content*" - AGName = "MyAvailabilityGroup" - FileShare = "\\SQL\Backups" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example removes a database from the specified AlwaysOn Availability Group (AAG) - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDatabaseAAG ConfigDBAAG - { - DatabaseName = "SP_Config" - AGName = "MyAvailabilityGroup" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt deleted file mode 100644 index 29abe027d..000000000 --- a/Modules/SharePointDsc/en-us/about_SPDesignerSettings.help.txt +++ /dev/null @@ -1,96 +0,0 @@ -.NAME - SPDesignerSettings - -# 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 - -.PARAMETER Url - Key - string - The URL of the web application or site collection to configure - -.PARAMETER SettingsScope - Required - string - Allowed values: WebApplication, SiteCollection - Define the scope of the configuration - either WebApplication or SiteCollection - -.PARAMETER AllowSharePointDesigner - Write - Boolean - Allow the use of SharePoint Designer - -.PARAMETER AllowDetachPagesFromDefinition - Write - Boolean - Allow pages to be un-ghosted by SharePoint Designer - -.PARAMETER AllowCustomiseMasterPage - Write - Boolean - Allow masterpages to be changed by SharePoint Designer - -.PARAMETER AllowManageSiteURLStructure - Write - Boolean - Allow site URL structure to be changed by SharePoint Designer - -.PARAMETER AllowCreateDeclarativeWorkflow - Write - Boolean - Allow users to create declarative workflows with SharePoint Designer - -.PARAMETER AllowSavePublishDeclarativeWorkflow - Write - Boolean - Allow users to save and re-publish declarative workflows with SharePoint Designer - -.PARAMETER AllowSaveDeclarativeWorkflowAsTemplate - Write - Boolean - Allow users to save declarative workflows as a template from SharePoint Designer - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example applies settings to disable SharePoint Designer access to the - specified web application. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDesignerSettings MainWebAppSPDSettings - { - Url = "https://intranet.sharepoint.contoso.com" - SettingsScope = "WebApplication" - AllowSharePointDesigner = $false - AllowDetachPagesFromDefinition = $false - AllowCustomiseMasterPage = $false - AllowManageSiteURLStructure = $false - AllowCreateDeclarativeWorkflow = $false - AllowSavePublishDeclarativeWorkflow = $false - AllowSaveDeclarativeWorkflowAsTemplate = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt deleted file mode 100644 index b66029c17..000000000 --- a/Modules/SharePointDsc/en-us/about_SPDiagnosticLoggingSettings.help.txt +++ /dev/null @@ -1,129 +0,0 @@ -.NAME - SPDiagnosticLoggingSettings - -# 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 - -.PARAMETER LogPath - Key - string - The physical path on each server to store ULS logs - -.PARAMETER LogSpaceInGB - Required - uint32 - The space in GB that should be used to store ULS logs - -.PARAMETER AppAnalyticsAutomaticUploadEnabled - Write - boolean - Should app analytics automatically be uploaded - -.PARAMETER CustomerExperienceImprovementProgramEnabled - Write - boolean - Should the customer experience program be enabled in this farm - -.PARAMETER DaysToKeepLogs - Write - uint32 - How many days should ULS logs be kept for - -.PARAMETER DownloadErrorReportingUpdatesEnabled - Write - boolean - Should updates to error reporting tools be automatically downloaded - -.PARAMETER ErrorReportingAutomaticUploadEnabled - Write - boolean - Should error reports be automatically uploaded - -.PARAMETER ErrorReportingEnabled - Write - boolean - Should reporting of errors be enabled - -.PARAMETER EventLogFloodProtectionEnabled - Write - boolean - Protect event logs with Event Log Flood Protection - -.PARAMETER EventLogFloodProtectionNotifyInterval - Write - uint32 - What interval should the event logs report a flood event - -.PARAMETER EventLogFloodProtectionQuietPeriod - Write - uint32 - What quiet period should reset the event log flood protection thresholds - -.PARAMETER EventLogFloodProtectionThreshold - Write - uint32 - What is the event log flood protection threshold - -.PARAMETER EventLogFloodProtectionTriggerPeriod - Write - uint32 - What is the time period that will trigger event log flood protection - -.PARAMETER LogCutInterval - Write - uint32 - How many minutes of activity will a ULS log file leep in an individual file - -.PARAMETER LogMaxDiskSpaceUsageEnabled - Write - boolean - Will the maximum disk space setting be enabled - -.PARAMETER ScriptErrorReportingDelay - Write - uint32 - What delay will be set before script error reporting is triggered - -.PARAMETER ScriptErrorReportingEnabled - Write - boolean - Is script error reporting enabled in this farm - -.PARAMETER ScriptErrorReportingRequireAuth - Write - boolean - Require users to be authenticated to allow script errors to be reported - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example applies the specified diagnostic logging settings to the local - SharPoint farm. Any setting not defined will be left as it default, or to - whatever value has been manually configured outside of DSC. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDiagnosticLoggingSettings ApplyDiagnosticLogSettings - { - PsDscRunAsCredential = $SetupAccount - 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 - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt deleted file mode 100644 index f68a80185..000000000 --- a/Modules/SharePointDsc/en-us/about_SPDistributedCacheService.help.txt +++ /dev/null @@ -1,174 +0,0 @@ -.NAME - SPDistributedCacheService - -# 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 SPCreateFarm and SPJoinFarm 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. - - The ServerProvisionOrder optional property is used when a pull server is - handing out configurations to nodes in order to tell this resource about a - specific order of enabling the caches. This allows for multiple servers to - receive the same configuration, but they will always check for the server - before them in the list first to ensure that it is running distributed cache. - By doing this you can ensure that you do not create conflicts with two or more - servers provisioning a cache at the same time. Note, this approach only makes - a server check the others for distributed cache, it does not provision the - cache automatically on all servers. If a previous server in the sequence does - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the distributed cache is provisioned. - -.PARAMETER Name - Key - String - A name to assign to this resource - not really used. For example - AppFabricCachingService - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to ensure the current server should be running distributed cache, absent to ensure that it isn't running - -.PARAMETER CacheSizeInMB - Required - UInt32 - How many MB should be used for the cache. The maximum supported is 16384 - -.PARAMETER ServiceAccount - Required - String - The name of the service account to run the service as. This should already be registered as a managed account in SharePoint - -.PARAMETER ServerProvisionOrder - Write - String - A list of servers which specifies the order they should provision the cache in to ensure that two servers do not do it at the same time - -.PARAMETER CreateFirewallRules - Required - Boolean - Should the Windows Firewall rules for distributed cache be created? - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example applies the distributed cache service to the current server, - also setting the rules in Windows firewall to allow communication with - other cache hosts. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDistributedCacheService EnableDistributedCache - { - Name = "AppFabricCachingService" - CacheSizeInMB = 8192 - ServiceAccount = "DEMO\ServiceAccount" - InstallAccount = $SetupAccount - CreateFirewallRules = $true - } - } - } - - -.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 - hosts to the Windows Firewall. Use this approach if you have an alternate - firewall solution. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPDistributedCacheService EnableDistributedCache - { - Name = "AppFabricCachingService" - CacheSizeInMB = 8192 - ServiceAccount = "DEMO\ServiceAccount" - InstallAccount = $SetupAccount - CreateFirewallRules = $false - } - } - } - - -.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 - create the cache at the same time, resuling in errors. - - Note: Do not allow plain text passwords in production environments. - - - $ConfigurationData = @{ - AllNodes = @( - @{ - NodeName = 'Server1' - PSDscAllowPlainTextPassword = $true - }, - @{ - NodeName = 'Server2' - PSDscAllowPlainTextPassword = $true - } - ) - } - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node "Server1" - { - SPDistributedCacheService EnableDistributedCache - { - Name = "AppFabricCachingService" - CacheSizeInMB = 8192 - ServiceAccount = "DEMO\ServiceAccount" - ServerProvisionOrder = @("Server1","Server2") - CreateFirewallRules = $true - InstallAccount = $SetupAccount - } - } - - node "Server2" - { - SPDistributedCacheService EnableDistributedCache - { - Name = "AppFabricCachingService" - CacheSizeInMB = 8192 - ServiceAccount = "DEMO\ServiceAccount" - ServerProvisionOrder = @("Server1","Server2") - CreateFirewallRules = $true - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt deleted file mode 100644 index 45dea7a37..000000000 --- a/Modules/SharePointDsc/en-us/about_SPExcelServiceApp.help.txt +++ /dev/null @@ -1,152 +0,0 @@ -.NAME - SPExcelServiceApp - -# Description - - This resource is responsible for creating Excel Services Application instances - within the local SharePoint farm. The resource will provision and configure the - Excel Services Service Application. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the service application - -.PARAMETER ApplicationPool - Required - string - The name of the application pool to run the service app in - -.PARAMETER TrustedFileLocations - Write - string - Trusted file locations for the service app - -.PARAMETER CachingOfUnusedFilesEnable - Write - Boolean - Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. - -.PARAMETER CrossDomainAccessAllowed - Write - Boolean - Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. - -.PARAMETER EncryptedUserConnectionRequired - Write - String - Allowed values: None, Connection - Requires that encryption is used between the end-user and the server running Excel Services Application. - -.PARAMETER ExternalDataConnectionLifetime - Write - Uint32 - Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. - -.PARAMETER FileAccessMethod - Write - String - Allowed values: UseImpersonation, UseFileAccessAccount - Specifies the authentication method that Excel Services Application uses to retrieve files. - -.PARAMETER LoadBalancingScheme - Write - String - Allowed values: RoundRobin, Local, WorkbookURL - Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers. - -.PARAMETER MemoryCacheThreshold - Write - Uint32 - Specifies the percentage of the maximum private bytes that can be allocated to inactive objects. - -.PARAMETER PrivateBytesMax - Write - Uint32 - Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. - -.PARAMETER SessionsPerUserMax - Write - Uint32 - Specifies the maximum number of sessions allowed for a user. - -.PARAMETER SiteCollectionAnonymousSessionsMax - Write - Uint32 - Specifies the maximum number of anonymous sessions allowed per site collection. - -.PARAMETER TerminateProcessOnAccessViolation - Write - Boolean - Terminates Excel Services Application when an access violation occurs in the process. - -.PARAMETER ThrottleAccessViolationsPerSiteCollection - Write - Uint32 - Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbook’s site collection are blocked from loading for the specified period (in seconds). - -.PARAMETER UnattendedAccountApplicationId - Write - String - Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter. - -.PARAMETER UnusedObjectAgeMax - Write - Uint32 - Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. - -.PARAMETER WorkbookCache - Write - String - Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application. - -.PARAMETER WorkbookCacheSizeMax - Write - Uint32 - Specifies the maximum allowable size, in megabytes, of an individual session. - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures service app exists, absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to deploy Excel Services to the local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPExcelServiceApp ExcelServices - { - Name = "Excel Services Service Application" - ApplicationPool = "SharePoint Service Applications" - InstallAccount = $SetupAccount - } - } - } - - -.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. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPExcelServiceApp ExcelServices - { - Name = "Excel Services Service Application" - ApplicationPool = "n/a" - Ensure = "Absent" - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt deleted file mode 100644 index 96503b5a9..000000000 --- a/Modules/SharePointDsc/en-us/about_SPFarmAdministrators.help.txt +++ /dev/null @@ -1,89 +0,0 @@ -.NAME - SPFarmAdministrators - -# 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. - -.PARAMETER Name - Key - String - A generic name for this resource, its value is not important - -.PARAMETER Members - Write - String - A list of members to set the group to. Those not in this list will be removed - -.PARAMETER MembersToInclude - Write - String - A list of members to add. Members not in this list will be left in the group - -.PARAMETER MembersToExclude - Write - String - A list of members to remove. Members not in this list will be left in the group - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to set a specific list of members for the farm admins group. - Any members not in this list will be removed. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFarmAdministrators LocalFarmAdmins - { - Name = "Farm Administrators" - Members = @("CONTOSO\user1", "CONTOSO\user2") - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how certain changes are made to the farm admins groups. Here any - members in the MembersToInclude property are added, and members in the MembersToExclude - property are removed. Any members that exist in the farm admins group that aren't listed - in either of these properties are left alone. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFarmAdministrators LocalFarmAdmins - { - Name = "Farm Administrators" - MembersToInclude = @("CONTOSO\user1") - MembersToExclude = @("CONTOSO\user2") - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt deleted file mode 100644 index 89c6517d3..000000000 --- a/Modules/SharePointDsc/en-us/about_SPFarmSolution.help.txt +++ /dev/null @@ -1,77 +0,0 @@ -.NAME - SPFarmSolution - -# Description - - This resource is used to make sure that a specific farm solution is either - present or absent in a farm. The solution can be deployed to one or more web - application passing an array of URL's to the WebApplications property. If the - solution contains resources scoped for web applications and no WebApplications - are specified, the solution will be deployed to all web applications. If the - solution does not contain resources scoped for web applications the property - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the solution is deployed. - -.PARAMETER Name - Key - string - The filename of the WSP package - -.PARAMETER LiteralPath - Required - string - The full path to the WSP file - -.PARAMETER WebApplications - Write - string - A list of the web applications to deploy this to - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the WSP should be deployed, or Absent if it should be removed - -.PARAMETER Version - Write - string - The version of the package that is being modified - -.PARAMETER Deployed - Write - Boolean - Should the solution be deployed to the farm, or just installed to the farm - -.PARAMETER SolutionLevel - Write - string - Allowed values: 14, 15, All - What compatability level should the WSP be deployed as? - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to deploy a WSP to specific web applications. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFarmSolution SampleWsp - { - Name = "MySolution.wsp" - LiteralPath = "C:\src\MySolution.wsp" - Ensure = "Present" - Version = "1.0.0" - WebApplications = @("http://collaboration", "http://mysites") - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt b/Modules/SharePointDsc/en-us/about_SPFeature.help.txt deleted file mode 100644 index 11006c2ee..000000000 --- a/Modules/SharePointDsc/en-us/about_SPFeature.help.txt +++ /dev/null @@ -1,93 +0,0 @@ -.NAME - SPFeature - -# 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 - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the feature is enabled. - -.PARAMETER Name - Key - string - The name of the feature - -.PARAMETER FeatureScope - Required - string - Allowed values: Farm, WebApplication, Site, Web - The scope to change the feature at - Farm, WebApplication, SiteCollection or Site - -.PARAMETER Url - Key - string - The URL to change the feature at - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the feature is to be enabled, Absent if it is to be disabled - -.PARAMETER Version - Write - string - The version of the feature to check against - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to enable a site collection scoped feature - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFeature EnableViewFormsLockDown - { - Name = "ViewFormPagesLockDown" - Url = "http://www.contoso.com" - FeatureScope = "Site" - PsDscRunAsCredential = $SetupAccount - Version = "1.0.0.0" - } - } - } - - -.EXAMPLE - This example shows how to disable a site collection scoped feature - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPFeature EnableViewFormsLockDown - { - Name = "ViewFormPagesLockDown" - Url = "http://www.contoso.com" - FeatureScope = "Site" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - Version = "1.0.0.0" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt deleted file mode 100644 index cf4d28a54..000000000 --- a/Modules/SharePointDsc/en-us/about_SPHealthAnalyzerRuleState.help.txt +++ /dev/null @@ -1,62 +0,0 @@ -.NAME - SPHealthAnalyzerRuleState - -# Description - - This resource is used to configure Health Analyzer rules for the local farm. - The resource is able to enable/disable and configure the specified rule. - -.PARAMETER Name - Key - String - The name of the rule exactly as it appears in central admin - -.PARAMETER Enabled - Required - Boolean - Should the rule be enabled? - -.PARAMETER RuleScope - Write - String - Allowed values: All Servers, Any Server - What is the scope of this rule - -.PARAMETER Schedule - Write - String - Allowed values: Hourly, Daily, Weekly, Monthly, OnDemandOnly - How often should the rule check - -.PARAMETER FixAutomatically - Write - Boolean - Should the rule fix itself automatically - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to disable a health analyzer rule - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPHealthAnalyzerRuleState DisableDiskSpaceRule - { - Name = "Drives are at risk of running out of free space." - Enabled = $false - RuleScope = "All Servers" - Schedule = "Daily" - FixAutomatically = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt b/Modules/SharePointDsc/en-us/about_SPInstall.help.txt deleted file mode 100644 index 937fce5d5..000000000 --- a/Modules/SharePointDsc/en-us/about_SPInstall.help.txt +++ /dev/null @@ -1,127 +0,0 @@ -.NAME - SPInstall - -# Description - - This resource is used to install the SharePoint binaries. The BinaryDir - parameter should point to the path that setup.exe is located (not to setup.exe - itself). The ProductKey parameter is used to inject in to the configuration - file and validate the license key during the installation process. This module - depends on the prerequisites already being installed, which can be done - - NOTE: This resource only supports SharePoint Server. SharePoint Foundation - is not supported. For examples to install SharePoint Foundation using DSC, see: - https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3) - - ## Installing from network locations - - If you wish to install SharePoint 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. - -.PARAMETER BinaryDir - Key - String - The directory that contains all of the SharePoint binaries - -.PARAMETER ProductKey - Required - String - The product key to use during the installation - -.PARAMETER InstallPath - Write - String - The install directory to use in the installation, leave blank to use the setup defaults - -.PARAMETER DataPath - Write - String - The data directory to use in the installation, leave blank to use the setup defaults - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to install SharePoint. Absent is currently not supported - - -.EXAMPLE - This module will install SharePoint to the default locations. The binaries for - SharePoint in this scenario are stored at C:\SPInstall (so it will look to run - C:\SPInstall\Setup.exe) - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPInstall InstallBinaries - { - BinaryDir = "C:\SPInstall" - ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" - } - } - } - - -.EXAMPLE - This module will install SharePoint to the specific locations set for the - InstallPath and DataPath directories. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPInstall InstallBinaries - { - BinaryDir = "D:\SharePoint\Binaries" - InstallPath = "D:\SharePoint\Install" - DataPath = "D:\SharePoint\Data" - ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" - } - } - } - - -.EXAMPLE - This module will install SharePoint Foundation 2013 to the local server - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName PSDesiredStateConfiguration - - node localhost { - Package InstallSharePointFoundation - { - Ensure = "Present" - Name = "Microsoft SharePoint Foundation 2013 Core" - Path = "E:\SharePoint2013\Setup.exe" - Arguments = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml" - ProductID = "90150000-1014-0000-1000-0000000FF1CE" - ReturnCode = 0 - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt deleted file mode 100644 index 359d97f42..000000000 --- a/Modules/SharePointDsc/en-us/about_SPInstallLanguagePack.help.txt +++ /dev/null @@ -1,91 +0,0 @@ -.NAME - SPInstallLanguagePack - -# Description - - This resource is used to install the SharePoint Language Pack binaries. The - BinaryDir parameter should point to the path that setup.exe is located (not to - setup.exe itself). - - The BinaryInstallDays and BinaryInstallTime parameters specify a window in which - the update can be installed. - - With SharePoint 2016, the Language Packs are offered as an EXE package. You have - to extract this package before installing, using the following command: - .\serverlanguagepack.exe /extract:[Extract Folder] - -.PARAMETER BinaryDir - Key - String - The directory that contains all of the SharePoint binaries - -.PARAMETER BinaryInstallDays - Write - String - Allowed values: mon, tue, wed, thu, fri, sat, sun - Specify on which dates the installation is allowed - -.PARAMETER BinaryInstallTime - Write - String - Specify in which time frame the installation is allowed - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to install SharePoint. Absent is currently not supported - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This module will install the SharePoint Language Pack. The binaries for - SharePoint in this scenario are stored at C:\SPInstall (so it will look to run - C:\SPInstall\Setup.exe) - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPInstallLanguagePack InstallLPBinaries - { - BinaryDir = "C:\SPInstall" - Ensure = "Present" - } - } - } - - -.EXAMPLE - This module will install the SharePoint Language Pack in the specified timeframe. - The binaries for SharePoint in this scenario are stored at C:\SPInstall (so it - will look to run C:\SPInstall\Setup.exe) - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPInstallLanguagePack InstallLPBinaries - { - BinaryDir = "C:\SPInstall" - BinaryInstallDays = "sat", "sun" - BinaryInstallTime = "12:00am to 2:00am" - Ensure = "Present" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt deleted file mode 100644 index de5bdc813..000000000 --- a/Modules/SharePointDsc/en-us/about_SPInstallPrereqs.help.txt +++ /dev/null @@ -1,181 +0,0 @@ -.NAME - SPInstallPrereqs - -# Description - - 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. - -.PARAMETER InstallerPath - Key - String - The full path to prerequisiteinstaller.exe - -.PARAMETER OnlineMode - Required - Boolean - Should the installer download prerequisites from the internet or not - -.PARAMETER SXSpath - Write - String - The path to the Windows Server Operating System SXS source files, for use in closed environments without access to Windows Update - -.PARAMETER SQLNCli - Write - String - The path to the installer for this prerequisite - -.PARAMETER PowerShell - Write - String - The path to the installer for this prerequisite - -.PARAMETER NETFX - Write - String - The path to the installer for this prerequisite - -.PARAMETER IDFX - Write - String - The path to the installer for this prerequisite - -.PARAMETER Sync - Write - String - The path to the installer for this prerequisite - -.PARAMETER AppFabric - Write - String - The path to the installer for this prerequisite - -.PARAMETER IDFX11 - Write - String - The path to the installer for this prerequisite - -.PARAMETER MSIPCClient - Write - String - The path to the installer for this prerequisite - -.PARAMETER WCFDataServices - Write - String - The path to the installer for this prerequisite - -.PARAMETER KB2671763 - Write - String - The path to the installer for this prerequisite - -.PARAMETER WCFDataServices56 - Write - String - The path to the installer for this prerequisite - -.PARAMETER MSVCRT11 - Write - String - The path to the installer for this prerequisite - -.PARAMETER MSVCRT14 - Write - String - The path to the installer for this prerequisite - -.PARAMETER KB3092423 - Write - String - The path to the installer for this prerequisite - -.PARAMETER ODBC - Write - String - The path to the installer for this prerequisite - -.PARAMETER DotNetFx - Write - String - The path to the installer for this prerequisite - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to install the prerequisites. Absent is currently not supported - - -.EXAMPLE - 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 InstallPrerequisites - { - InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" - OnlineMode = $true - } - } - } - - -.EXAMPLE - 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 InstallPrerequisites - { - 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" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt deleted file mode 100644 index bb52a8c22..000000000 --- a/Modules/SharePointDsc/en-us/about_SPIrmSettings.help.txt +++ /dev/null @@ -1,54 +0,0 @@ -.NAME - SPIrmSettings - -# Description - - This resource is used to manipulate the IRM settings in SharePoint, integrating - it with AD RMS - - The default value for the Ensure parameter is Present. When not specifying this - parameter, IRM is configured. - -.PARAMETER Ensure - Key - String - Allowed values: Present, Absent - Enable or Disable IRM on this farm - -.PARAMETER UseADRMS - Write - Boolean - Use the RMS server published in this farm's Active Directory - -.PARAMETER RMSserver - Write - String - Use the specified RMS server, must provide in URL format - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply the RMS settings to a local farm, pointing to - a specific RMS server - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPIrmSettings RMSSettings - { - Ensure = "Present" - RMSserver = "https://rms.contoso.com" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt deleted file mode 100644 index 2cb9a9b88..000000000 --- a/Modules/SharePointDsc/en-us/about_SPJoinFarm.help.txt +++ /dev/null @@ -1,98 +0,0 @@ -.NAME - SPJoinFarm - -# Description - - WARNING: This resource is deprecated. Please use SPFarm instead as - this resource will be removed from version 2.0 of SharePointDsc - - This resource will be responsible for joining a server to an existing - SharePoint farm. To create a new farm use the SPCreateFarm resource on a - different server to begin with, and then pass the same database server and - configuration database name parameters to the additional servers using this - resource. After the server has joined the farm, the process will wait for 5 - minutes to allow farm specific configuration to take place on the server, - before allowing further DSC configuration to take place. - -.PARAMETER FarmConfigDatabaseName - Key - string - The name of the config database to connect to - -.PARAMETER DatabaseServer - Key - string - The server that hosts the config database - -.PARAMETER Passphrase - Required - string - The passphrase that should be used to join the farm - -.PARAMETER ServerRole - Write - string - Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache - SharePoint 2016 only - the MinRole role to enroll this server as - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to join an existing SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPJoinFarm JoinFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - Passphrase = $Passphrase - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to join an existing SharePoint farm using a specific - server role (applies to SharePoint 2016 only). - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPJoinFarm JoinFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - ServerRole = "WebFrontEnd" - Passphrase = $Passphrase - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt deleted file mode 100644 index 2db706949..000000000 --- a/Modules/SharePointDsc/en-us/about_SPManagedAccount.help.txt +++ /dev/null @@ -1,105 +0,0 @@ -.NAME - SPManagedAccount - -# Description - - This resource will ensure a managed account is provisioned in to the SharePoint - farm. The Account object specific the credential to store (including username - and password) to set as the managed account. The settings for - EmailNotification, PreExpireDays and Schedule all relate to enabling automatic - password change for the managed account, leaving these option out of the - resource will ensure that no automatic password changing from SharePoint occurs. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the managed account is created. - -.PARAMETER AccountName - Key - string - The username of the account - -.PARAMETER Account - Write - String - The credential with password of the account - -.PARAMETER EmailNotification - Write - Uint32 - How many days before a password change should an email be sent - -.PARAMETER PreExpireDays - Write - Uint32 - How many days before a password expires should it be changed - -.PARAMETER Schedule - Write - string - What is the schedule for the password reset - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures managed account exists, absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to create a new managed account in a local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $ManagedAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedAccount NewManagedAccount - { - AccountName = $ManagedAccount.UserName - Account = $ManagedAccount - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to create a new managed account in a local farm, using - the automatic password change schedule - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $ManagedAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedAccount NewManagedAccount - { - AccountName = $ManagedAccount.UserName - Account = $ManagedAccount - Ensure = "Present" - Schedule = "monthly between 7 02:00:00 and 7 03:00:00" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt deleted file mode 100644 index de3fc3233..000000000 --- a/Modules/SharePointDsc/en-us/about_SPManagedMetaDataServiceApp.help.txt +++ /dev/null @@ -1,138 +0,0 @@ -.NAME - SPManagedMetaDataServiceApp - -# Description - - Creates a managed metadata service application. The application pool property - specifies which application pool it should use, and will reset the application - back to this pool if it is changed after its initial provisioning. The - database server and database name properties are only used during - provisioning, and will not be altered as part of the ongoing operation of the - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the managed metadata service application - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER ApplicationPool - Required - string - The application pool that the service app will use - -.PARAMETER DatabaseServer - Write - string - The name of the database server which will host the application - -.PARAMETER DatabaseName - Write - string - The name of the database for the service application - -.PARAMETER TermStoreAdministrators - Write - string - A list of the users/groups who are administrators of the term store - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures service app exists, absent ensures it is removed - -.PARAMETER ContentTypeHubUrl - Write - string - The URL of the content type hub for this app (only set when the app is provisioned) - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to deploy the Managed Metadata service app to the local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { - Name = "Managed Metadata Service Application" - InstallAccount = $SetupAccount - ApplicationPool = "SharePoint Service Applications" - DatabaseServer = "SQL.contoso.local" - DatabaseName = "SP_ManagedMetadata" - } - } - } - - -.EXAMPLE - - This example shows how to remove a specific managed metadata service app from the - local SharePoint farm. Because Application pool parameter is required - but is not acutally needed to remove the app, any text value can - be supplied for these as it will be ignored. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { - Name = "Managed Metadata Service Application" - InstallAccount = $SetupAccount - ApplicationPool = "none" - Ensure = "Absent" - } - } - } - - -.EXAMPLE - This example shows how to deploy the Managed Metadata service app to the local SharePoint farm - and also include a specific list of users to be the term store administrators. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { - Name = "Managed Metadata Service Application" - InstallAccount = $SetupAccount - ApplicationPool = "SharePoint Service Applications" - DatabaseServer = "SQL.contoso.local" - DatabaseName = "SP_ManagedMetadata" - TermStoreAdministrators = @( - "CONTOSO\user1", - "CONTOSO\user2" - ) - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt deleted file mode 100644 index 387889cd9..000000000 --- a/Modules/SharePointDsc/en-us/about_SPManagedPath.help.txt +++ /dev/null @@ -1,121 +0,0 @@ -.NAME - SPManagedPath - -# Description - - This resource is responsible for creating managed paths associated with a - specific web application. The WebAppUrl parameter is used to specify the web - application to create the path against, and the RelativeUrl parameter lets you - set the URL. Explicit when set to true will create an explicit inclusion path, - if set to false the path is created as wildcard inclusion. If you are using - host named site collections set HostHeader to true and the path will be - created as a host header path to be applied for host named site collections. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the managed path is created. - -.PARAMETER WebAppUrl - Key - string - The URL of the web application to apply the managed path to - this is ignored for host header web applications - -.PARAMETER RelativeUrl - Key - string - The relative URL of the managed path - -.PARAMETER Explicit - Required - boolean - Should the host header be explicit? If false then it is a wildcard - -.PARAMETER HostHeader - Required - boolean - Is this a host header web application? - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures managed path exists, absent ensures it is removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to deploy an explicit managed path to a specifici web application - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedPath TestManagedPath - { - WebAppUrl = "http://sharepoint.contoso.com" - InstallAccount = $SetupAccount - RelativeUrl = "example" - Explicit = $true - HostHeader = $false - } - } - } - - -.EXAMPLE - This example shows how to add a wildcard managed path to a specific web application - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedPath TestManagedPath - { - WebAppUrl = "http://sharepoint.contoso.com" - InstallAccount = $SetupAccount - RelativeUrl = "teams" - Explicit = $false - HostHeader = $true - } - } - } - - -.EXAMPLE - This example shows how to remove a wildcard managed path from a specific web application - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPManagedPath TestManagedPath - { - WebAppUrl = "http://sharepoint.contoso.com" - InstallAccount = $SetupAccount - RelativeUrl = "teams" - Explicit = $false - HostHeader = $true - Ensure = "Absent" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt deleted file mode 100644 index ef9deab6c..000000000 --- a/Modules/SharePointDsc/en-us/about_SPOfficeOnlineServerBinding.help.txt +++ /dev/null @@ -1,87 +0,0 @@ -.NAME - SPOfficeOnlineServerBinding - -# Description - - This resource will create a binding to an Office Online Server (formerly known - as Office Web Apps). The DnsName property can be a single server name, or a - FQDN of a load balanced end point that will direct traffic to a farm. - - NOTE: This resource is designed to be used where all WOPI bindings will be - targeted to the same Office Online Server farm. If used on a clean - environment, the new bindings will all point to the one DNS Name. If used on - an existing configuration that does not follow this rule, it will match only - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the zone is configured. - -.PARAMETER Zone - Key - string - Allowed values: Internal-HTTP, Internal-HTTPS, External-HTTP, External-HTTPS - The zone for this binding - -.PARAMETER DnsName - Required - string - The DNS name of the server/s that are running Office Web Apps - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures the binding for this zone exists, absent ensures it doesn't - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to create bindings to the internal-https zone for the - local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPOfficeOnlineServerBinding OosBinding - { - Zone = "internal-https" - DnsName = "webapps.contoso.com" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to remove bindings from the internal-http zone for the - local SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPOfficeOnlineServerBinding OosBinding - { - Zone = "Internal-HTTP" - DnsName = "webapps.contoso.com" - PsDscRunAsCredential = $SetupAccount - Ensure = "Absent" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt deleted file mode 100644 index b09350b20..000000000 --- a/Modules/SharePointDsc/en-us/about_SPOutgoingEmailSettings.help.txt +++ /dev/null @@ -1,100 +0,0 @@ -.NAME - SPOutgoingEmailSettings - -# Description - - This resource is used to set the outgoing email settings for either a single - web application, or the whole farm. To configure the resource for a specific - web app, use the URL of the web application for the WebAppUrl property, to - change the settings for the whole farm use the URL of the central admin - website instead. It is possible to set the outgoing server, from address, - reply to address and the character set to be used for emails. - -.PARAMETER WebAppUrl - key - string - The URL of the web application. If you want to set the global settings use the Central Admin URL - -.PARAMETER SMTPServer - Required - string - The SMTP server for outgoing mail - -.PARAMETER FromAddress - Required - string - The from address to put on messages - -.PARAMETER ReplyToAddress - Required - string - The email address that replies should be directed to - -.PARAMETER CharacterSet - Required - string - The character set to use on messages - -.PARAMETER UseTLS - Write - boolean - Use TLS when connecting to the SMTP server (SharePoint 2016 only) - -.PARAMETER SMTPPort - Write - uint32 - The port which is used to connect to the SMTP server (SharePoint 2016 only) - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows to set outgoing email settings for the entire farm. Use the URL - of the central admin site for the web app URL to apply for the entire farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPOutgoingEmailSettings FarmWideEmailSettings - { - WebAppUrl = "http://sharepoint1:2013" - SMTPServer = "smtp.contoso.com" - FromAddress = "sharepoint`@contoso.com" - ReplyToAddress = "noreply`@contoso.com" - CharacterSet = "65001" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows to set outgoing email settings for a specific web app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPOutgoingEmailSettings FarmWideEmailSettings - { - WebAppUrl = "http://site.contoso.com" - SMTPServer = "smtp.contoso.com" - FromAddress = "sharepoint`@contoso.com" - ReplyToAddress = "noreply`@contoso.com" - CharacterSet = "65001" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt deleted file mode 100644 index 5a4e04213..000000000 --- a/Modules/SharePointDsc/en-us/about_SPPasswordChangeSettings.help.txt +++ /dev/null @@ -1,58 +0,0 @@ -.NAME - SPPasswordChangeSettings - -# Description - - This resource is used to control settings that relate to the automatic - changing of passwords for managed accounts (where they opt-in to be managed by - SharePoint). These settings can be manually controlled through central - administration, or configured in this resource. The settings relate to email - notifications of when passwords are reset, as well as behavior when a reset - -.PARAMETER MailAddress - key - string - The email address to send notifications of password changes to - -.PARAMETER DaysBeforeExpiry - Write - Uint32 - The number of days before password expiry to send send emails - -.PARAMETER PasswordChangeWaitTimeSeconds - Write - Uint32 - The duration that a password reset will wait for before it times out - -.PARAMETER NumberOfRetries - Write - Uint32 - How many retries if the password change fails - -.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 password change settings for managed accounts in the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPPasswordChangeSettings ManagedAccountPasswordResetSettings - { - MailAddress = "sharepoint`@contoso.com" - DaysBeforeExpiry = "14" - PasswordChangeWaitTimeSeconds = "60" - NumberOfRetries = "3" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt deleted file mode 100644 index f3eb083f8..000000000 --- a/Modules/SharePointDsc/en-us/about_SPPerformancePointServiceApp.help.txt +++ /dev/null @@ -1,93 +0,0 @@ -.NAME - SPPerformancePointServiceApp - -# Description - - This resource is responsible for creating Performance Point Service Application - instances within the local SharePoint farm. The resource will provision and - configure the Performance Point Service Application. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the service application - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER ApplicationPool - Required - string - The name of the application pool to run the service app in - -.PARAMETER DatabaseName - Write - string - The name of the database for the service app - -.PARAMETER DatabaseServer - Write - string - The name of the database server to host the database - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present ensures service app exists, absent ensures it is removed - -.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 performance point service app in the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPPerformancePointServiceApp PerformancePoint - { - Name = "Performance Point Service Application" - ApplicationPool = "SharePoint Web Services" - InstallAccount = $SetupAccount - } - } - } - - -.EXAMPLE - This example removes the specific performance point service app from the local - farm. The ApplicationPool parameter is still mandatory but it is not used, so - the value can be anything. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPPerformancePointServiceApp PerformancePoint - { - Name = "Performance Point Service Application" - ApplicationPool = "n/a" - Ensure = "Absent" - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt deleted file mode 100644 index 907f29fdc..000000000 --- a/Modules/SharePointDsc/en-us/about_SPProductUpdate.help.txt +++ /dev/null @@ -1,145 +0,0 @@ -.NAME - SPProductUpdate - -# Description - - This resource is used to perform the update step of installing SharePoint - updates, like Cumulative Updates and Service Packs. The SetupFile parameter - should point to the update file. The ShutdownServices parameter is used to - indicate if some services (Timer, Search and IIS services) have to be stopped - before installation of the update. This will speed up the installation. The - BinaryInstallDays and BinaryInstallTime parameters specify a window in which - the update can be installed. This module requires the Configuration Wizard - resource to fully complete the installation of the update, which can be done - through the use of SPConfigWizard. - - NOTE: - When files are downloaded from the Internet, a Zone.Identifier alternate data - stream is added to indicate that the file is potentially from an unsafe source. - To use these files, make sure you first unblock them using Unblock-File. - SPProductUpdate will throw an error when it detects the file is blocked. - - IMPORTANT: - This resource retrieves build information from the Configuration Database. - Therefore it requires SharePoint to be installed and a farm created. If you - like to deploy a new farm and install updates automatically, you need to - implement the following order: - - 1. Install the SharePoint Binaries (SPInstall) - 2. (Optional) Install SharePoint Language Pack(s) Binaries - (SPInstallLanguagePack) - 3. Create SPFarm (SPFarm) - 4. Install Cumulative Updates (SPProductUpdate) - 5. Run the Configuration Wizard (SPConfigWizard) - -.PARAMETER SetupFile - Key - String - The name of the update setup file - -.PARAMETER ShutdownServices - Write - Boolean - Shutdown SharePoint services to speed up installation - -.PARAMETER BinaryInstallDays - Write - String - Allowed values: mon, tue, wed, thu, fri, sat, sun - Specify on which dates the installation is allowed - -.PARAMETER BinaryInstallTime - Write - String - Specify in which time frame the installation is allowed - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to install SharePoint. Absent is currently not supported - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example installs the Cumulative Update only in the specified window. - It also shuts down services to speed up the installation process. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPProductUpdate InstallCUMay2016 - { - SetupFile = "C:\Install\CUMay2016\ubersrv2013-kb3115029-fullfile-x64-glb.exe" - ShutdownServices = $true - BinaryInstallDays = "sat", "sun" - BinaryInstallTime = "12:00am to 2:00am" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example installs the SharePoint 2013 Service Pack only in the specified window. - It also shuts down services to speed up the installation process. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPProductUpdate InstallCUMay2016 - { - SetupFile = "C:\Install\SP2013SP1\officeserversp2013-kb2880552-fullfile-x64-en-us.exe" - ShutdownServices = $true - BinaryInstallDays = "sat", "sun" - BinaryInstallTime = "12:00am to 2:00am" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example installs the SharePoint 2013 Dutch Language Pack Service Pack only in the specified window. - It also shuts down services to speed up the installation process. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPProductUpdate InstallCUMay2016 - { - SetupFile = "C:\Install\SP2013-LP_NL-SP1\serverlpksp2013-kb2880554-fullfile-x64-nl-nl.exe" - ShutdownServices = $true - BinaryInstallDays = "sat", "sun" - BinaryInstallTime = "12:00am to 2:00am" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt deleted file mode 100644 index 8ec9b8521..000000000 --- a/Modules/SharePointDsc/en-us/about_SPPublishServiceApplication.help.txt +++ /dev/null @@ -1,87 +0,0 @@ -.NAME - SPPublishServiceApplication - -# Description - - This resource is used to specify if a specific service application should be - published (Ensure = "Present") or not published (Ensure = "Absent") on the - current server. The name is the display name of the service application as - shown in the Central Admin website. - - You can publish the following service applications in a SharePoint Server - 2013/2016 farm: - - * Business Data Connectivity - * Machine Translation - * Managed Metadata - * User Profile - * Search - * Secure Store - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the service application to publish - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to ensure it runs on this server, or absent to ensure it is stopped - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to ensure that the managed metadata service is published - within the farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPPublishServiceApplication PublishManagedMetadataServiceApp - { - Name = "Managed Metadata Service Application" - Ensure = "Present" - InstallAccount = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to ensure that the Secure Store Service is not - published within the farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPPublishServiceApplication UnpublishSecureStoreServiceApp - { - Name = "Secure Store Service Application" - Ensure = "Absent" - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt deleted file mode 100644 index e5c9a3473..000000000 --- a/Modules/SharePointDsc/en-us/about_SPQuotaTemplate.help.txt +++ /dev/null @@ -1,69 +0,0 @@ -.NAME - SPQuotaTemplate - -# Description - - This resource is used to configure quota templates in the farm. These settings - will be used to make sure a certain quota template exists or not. When it - exists, it will also make sure the settings are configured as specified. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the quota template is created. - -.PARAMETER Name - Key - string - The name of the quota template - -.PARAMETER StorageMaxInMB - Write - uint32 - The maximum storage for sites of this template in MB - -.PARAMETER StorageWarningInMB - Write - uint32 - The amount of storage for sites of this template that triggers a warning - -.PARAMETER MaximumUsagePointsSolutions - Write - uint32 - The maximum number of performance points for sandbox solutions for this template - -.PARAMETER WarningUsagePointsSolutions - Write - uint32 - The warning number of performance points for sandbox solutions for this template - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to create this template, absent to ensure it does not exist - -.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 specific quota template in the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPQuotaTemplate TeamsiteTemplate - { - Name = "Teamsite" - StorageMaxInMB = 1024 - StorageWarningInMB = 512 - MaximumUsagePointsSolutions = 1000 - WarningUsagePointsSolutions = 800 - Ensure = "Present" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt deleted file mode 100644 index 18b12dcf4..000000000 --- a/Modules/SharePointDsc/en-us/about_SPRemoteFarmTrust.help.txt +++ /dev/null @@ -1,59 +0,0 @@ -.NAME - SPRemoteFarmTrust - -# Description - - This resource is used to trust a remote SharePoint farm. This is used when - federating search results between two different SharePoint farms. The - technique is described at - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the remote farm trust is created. - -.PARAMETER Name - Key - string - A name of the remote farm, used to create token issuer and root authority - -.PARAMETER RemoteWebAppUrl - Required - string - The URL of a web app in the remote farm, must use HTTPS - -.PARAMETER LocalWebAppUrl - Required - string - The URL of a local web app to connect the remote farm to - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Set to present to ensure the trust exists, or absent to ensure it is removed - -.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 remote farm trust so that the local web app trusts calls - that will come from the remote web app. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPRemoteFarmTrust TrustRemoteFarmForSearch - { - Name = "CentralSearchFarm" - RemoteWebAppUrl = "https://search.sharepoint.contoso.com" - LocalWebAppUrl = "https://local.sharepoint2.contoso.com" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt deleted file mode 100644 index da63318da..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchContentSource.help.txt +++ /dev/null @@ -1,154 +0,0 @@ -.NAME - SPSearchContentSource - -# Description - - This resource will deploy and configure a content source in a specified search - service application. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the content source is created. - -.PARAMETER Name - Key - String - The name of the content source - -.PARAMETER ServiceAppName - Key - String - The name of the search service app that this content source exists within - -.PARAMETER ContentSourceType - Required - String - Allowed values: SharePoint, Website, FileShare - The type of content source - currently only SharePoint, Website and File Shares are supported - -.PARAMETER Addresses - Required - String - A list of the addresses this content source includes - -.PARAMETER CrawlSetting - Required - String - Allowed values: CrawlEverything, CrawlFirstOnly, Custom - Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only) - -.PARAMETER ContinuousCrawl - Write - Boolean - Should this content source use continuous crawl (SharePoint sites only) - -.PARAMETER IncrementalSchedule - Write - String - What is the incremental schedule for this content source - -.PARAMETER FullSchedule - Write - String - What is the full schedule for this content source - -.PARAMETER Priority - Write - String - Allowed values: Normal, High - What is the priority on this content source - -.PARAMETER LimitPageDepth - Write - Uint32 - How many pages deep should the crawler go (-1 = unlimited, website sources only) - -.PARAMETER LimitServerHops - Write - Uint32 - How many server hops should the crawler make (-1 = unlimtied, website sources only) - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the source should exist, absent if it should not - -.PARAMETER Force - Write - Boolean - Specify true if DSC is allowed to delete and recreate a content source to apply the correct settings, otherwise false will just report errors if a change can not be applied. - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to create a SharePoint sites content source - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchContentSource LocalSharePointSites - { - Name = "Local SharePoint Sites" - ServiceAppName = "Search Service Application" - ContentSourceType = "SharePoint" - Addresses = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com") - CrawlSetting = "CrawlEverything" - ContinuousCrawl = $true - IncrementalSchedule = MSFT_SPSearchCrawlSchedule { - ScheduleType = "Daily" - StartHour = "0" - StartMinute = "0" - CrawlScheduleRepeatDuration = "1440" - CrawlScheduleRepeatInterval = "5" - } - FullSchedule = $null - Priority = "Normal" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to create a website content source - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchContentSource WebsiteSource - { - Name = "Contoso website" - ServiceAppName = "Search Service Application" - ContentSourceType = "Website" - Addresses = @("http://www.contoso.com") - CrawlSetting = "Custom" - LimitPageDepth = 5 - LimitServerHops = 0 - IncrementalSchedule = MSFT_SPSearchCrawlSchedule{ - ScheduleType = "Daily" - StartHour = "0" - StartMinute = "0" - CrawlScheduleRepeatDuration = "1440" - CrawlScheduleRepeatInterval = "5" - } - FullSchedule = MSFT_SPSearchCrawlSchedule{ - ScheduleType = "Weekly" - CrawlScheduleDaysOfWeek = @("Monday", "Wednesday", "Friday") - StartHour = "3" - StartMinute = "0" - } - Priority = "Normal" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt deleted file mode 100644 index b8ad9d357..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchCrawlRule.help.txt +++ /dev/null @@ -1,110 +0,0 @@ -.NAME - SPSearchCrawlRule - -# Description - - This resource is responsible for managing the search crawl rules in the search - service application. You can create new rules, change existing rules and remove - existing rules. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the crawl rule is created. - -.PARAMETER Path - Key - string - The name of the search service application - -.PARAMETER ServiceAppName - Required - string - The name of the search service application - -.PARAMETER AuthenticationType - Write - string - Allowed values: DefaultRuleAccess, BasicAccountRuleAccess, CertificateRuleAccess, NTLMAccountRuleAccess, FormRuleAccess, CookieRuleAccess, AnonymousAccess - Authentication type used by the crawl rule - -.PARAMETER RuleType - Write - string - Allowed values: InclusionRule, ExclusionRule - The type of the rule - -.PARAMETER CrawlConfigurationRules - Write - string - Allowed values: FollowLinksNoPageCrawl, CrawlComplexUrls, CrawlAsHTTP - The configuration options for this rule - -.PARAMETER AuthenticationCredentials - Write - String - The credentials used for this crawl rule (used for types BasicAccountRuleAccess and NTLMAccountRuleAccess) - -.PARAMETER CertificateName - Write - string - The certificate used for this crawl rule (used for type CertificateRuleAccess) - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the crawl rule 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 - - -.EXAMPLE - This example shows how to apply settings to a sepcific URL in search - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchCrawlRule IntranetCrawlAccount - { - Path = "https://intranet.sharepoint.contoso.com" - ServiceAppName = "Search Service Application" - Ensure = "Present" - RuleType = "InclusionRule" - CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" - AuthenticationType = "DefaultRuleAccess" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to set a certificate for authentication to a content source - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchCrawlRule IntranetCrawlAccountCertificate - { - Path = "https://intranet.sharepoint.contoso.com" - ServiceAppName = "Search Service Application" - Ensure = "Present" - RuleType = "InclusionRule" - CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" - AuthenticationType = "CertificateRuleAccess" - CertificateName = "Certificate Name" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt deleted file mode 100644 index e90e7fa9b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchFileType.help.txt +++ /dev/null @@ -1,97 +0,0 @@ -.NAME - SPSearchFileType - -# Description - - This resource is responsible for managing the search file types in the search - service application. You can create new file types, change existing types and - remove existing file types. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the file type is added. - -.PARAMETER FileType - Key - string - The name of the file type - -.PARAMETER ServiceAppName - Key - string - The name of the search service application - -.PARAMETER Description - Write - string - The description of the file type - -.PARAMETER MimeType - Write - string - The mime type of the file type - -.PARAMETER Enabled - Write - boolean - The state of the file type - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the file type 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 - - -.EXAMPLE - This example shows how to apply settings to a specific file type in search, using the required parameters - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchFileType PDF - { - FileType = "pdf" - ServiceAppName = "Search Service Application" - Description = "PDF" - MimeType = "application/pdf" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to disable a specific file type in search - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchFileType PDF - { - FileType = "pdf" - ServiceAppName = "Search Service Application" - Description = "PDF" - MimeType = "application/pdf" - Enabled = $false - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt deleted file mode 100644 index e6b3f15e0..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchIndexPartition.help.txt +++ /dev/null @@ -1,68 +0,0 @@ -.NAME - SPSearchIndexPartition - -# Description - - This resource is responsible for creating search indexes. It works by creating - the index topology components and updating the topology from the server that - runs this resource. For this reason this resource only needs to run from one - server and not from each server which will host the index component. The - search service application and existing search topology must be deployed - before creating additional indexes. The first index will be created through - the use of the SPSearchRoles resource. Additional search index partitions can - be created through using this resource. - - Note that for the search topology to apply correctly, the path specified for - RootDirectory needs to exist on the server that is executing this resource. For - example, if the below example was executed on "Server1" it would also need to - ensure that it was able to create the index path at I:\. If no disk labeled I: - was available on server1, this would fail, even though it will not hold an - actual index component. - -.PARAMETER Index - Key - Uint32 - The number of the partition in this farm - -.PARAMETER Servers - Required - String - A list of the servers that this partition should exist on - -.PARAMETER RootDirectory - Write - String - The directory that the index should use locally on each server to store data - -.PARAMETER ServiceAppName - Key - String - The name of the search service application - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example adds an extra search partition to the local farms topology - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchIndexPartition AdditionalPartition - { - Servers = @("Server2", "Server3") - Index = 1 - RootDirectory = "I:\SearchIndexes\1" - ServiceAppName = "Search Service Application" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt deleted file mode 100644 index 87ce4c00a..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchResultSource.help.txt +++ /dev/null @@ -1,76 +0,0 @@ -.NAME - SPSearchResultSource - -# Description - - This resource is used to configure search result sources in the SharePoint - search service application. Result sources can be configured to be of the - following provider types: - - * Exchange Search Provider - * Local People Provider - * Local SharePoint Provider - * OpenSearch Provider - * Remote People Provider - * Remote SharePoint Provider - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the result source is created. - -.PARAMETER Name - Key - String - The name of the result source - -.PARAMETER SearchServiceAppName - Required - String - The name of the search service application to associate this result source with - -.PARAMETER Query - Required - String - The query to pass to the provider source - -.PARAMETER ProviderType - Required - String - Allowed values: Exchange Search Provider, Local People Provider, Local SharePoint Provider, OpenSearch Provider, Remote People Provider, Remote SharePoint Provider - The provider type to use for the result source - -.PARAMETER ConnectionUrl - Write - String - The URI to connect to the remote location - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the result source 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 - - -.EXAMPLE - This example shows how to create a remote sharepoint search result source - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchResultSource RemoteSharePointFarm - { - Name = "External SharePoint results" - SearchServiceAppName = "Search Service Application" - Query = "{searchTerms}" - ProviderType = "Remote SharePoint Provider" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt deleted file mode 100644 index d2e2bf507..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchServiceApp.help.txt +++ /dev/null @@ -1,113 +0,0 @@ -.NAME - SPSearchServiceApp - -# Description - - This resource is responsible for provisioning the search service application. - The current version lets you specify the database name and server, as well as - the application pool. If the application pool is changed the DSC resource will - set it back as per what is set in the resource. The database name parameter is - used as the prefix for all search databases (so you will end up with one for - the admin database which matches the name, and then - "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well). - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the search service application - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER ApplicationPool - Required - string - The application pool that it should run in - -.PARAMETER SearchCenterUrl - Write - string - The URL of the enterprise search center site collection - -.PARAMETER DatabaseName - Write - string - The name of the database (noting that some search databases will use this as a prefix) - -.PARAMETER DatabaseServer - Write - string - The server that host the databases for this service application - -.PARAMETER DefaultContentAccessAccount - Write - String - The default content access account for this search service app - -.PARAMETER CloudIndex - Write - boolean - Should this search service application be a cloud based service app - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app should exist, absent if it should not - -.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 - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchServiceApp SearchServiceApp - { - Name = "Search Service Application" - DatabaseName = "SP_Search" - ApplicationPool = "SharePoint Service Applications" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example removes a search service app in the local farm. The ApplicationPool - parameter is still required but is not actually used, so its value does not matter. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchServiceApp SearchServiceApp - { - Name = "Search Service Application" - Ensure = "Absent" - ApplicationPool = "n/a" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt deleted file mode 100644 index 7b415189f..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSearchTopology.help.txt +++ /dev/null @@ -1,89 +0,0 @@ -.NAME - SPSearchTopology - -# Description - - This resource is responsible for provisioning a search topology in to the - current farm. It allows the configuration to dictate the search topology roles - that the current server should be running. Any combination of roles can be - specified and the topology will be upaded to reflect the current servers new - roles. If this is the first server to apply topology to a farm, then at least - one search index must be provided. To this end, the FirstPartitionIndex, - FirstPartitionDirectory and FirstPartitionServers allow configuring where the - first index partition will belong. This will behave the same as the - SPSearchIndexPartition resource. - - Note that for the search topology to apply correctly, the path specified for - FirstPartitionDirectory needs to exist on the server that is executing this - resource. For example, if the below example was executed on "Server1" it would - also need to ensure that it was able to create the index path at I:\. If no - disk labeled I: was available on server1, this would fail, even though it will - not hold an actual index component. - -.PARAMETER ServiceAppName - Key - String - The name of the search service application for this topology - -.PARAMETER Admin - Required - String - A list of servers that will run the admin component - -.PARAMETER Crawler - Required - String - A list of servers that will run the crawler component - -.PARAMETER ContentProcessing - Required - String - A list of servers that will run the content processing component - -.PARAMETER AnalyticsProcessing - Required - String - A list of servers that will run the analytics processing component - -.PARAMETER QueryProcessing - Required - String - A list of servers that will run the query processing component - -.PARAMETER IndexPartition - Required - String - A list of servers that will host the first (0) index partition - -.PARAMETER FirstPartitionDirectory - Required - String - The local directory servers will use to store the first index partition - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply a specific topology to the search service app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSearchTopology LocalSearchTopology - { - ServiceAppName = "Search Service Application" - Admin = @("Server1","Server2") - Crawler = @("Server1","Server2") - ContentProcessing = @("Server1","Server2") - AnalyticsProcessing = @("Server1","Server2") - QueryProcessing = @("Server3","Server4") - PsDscRunAsCredential = $SetupAccount - FirstPartitionDirectory = "I:\SearchIndexes\0" - IndexPartition = @("Server3","Server4") - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt deleted file mode 100644 index dcd0d8d78..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSecureStoreServiceApp.help.txt +++ /dev/null @@ -1,127 +0,0 @@ -.NAME - SPSecureStoreServiceApp - -# Description - - This resource is responsible for provisioning and configuring the secure store - service application. The parameters passed in (except those related to database - specifics) are validated and set when the resource is run, the database values - are only used in provisioning of the service application. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the secure store service app - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER ApplicationPool - Required - string - The name of the application pool it will run in - -.PARAMETER AuditingEnabled - Required - boolean - Is auditing enabled for this service app - -.PARAMETER AuditlogMaxSize - Write - uint32 - What is the maximum size of the audit log in MB - -.PARAMETER DatabaseCredentials - Write - String - What SQL credentials should be used to access the database - -.PARAMETER DatabaseName - Write - string - The name of the database for the service app - -.PARAMETER DatabaseServer - Write - string - The name of the database server to host the database - -.PARAMETER DatabaseAuthenticationType - Write - string - Allowed values: Windows, SQL - What type of authentication should be used to access the database - -.PARAMETER FailoverDatabaseServer - Write - string - The name of the database server hosting a failover instance of the database - -.PARAMETER PartitionMode - Write - boolean - Is partition mode enabled for this service app - -.PARAMETER Sharing - Write - boolean - Is sharing enabled for this service app - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app 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 - - -.EXAMPLE - This example creates a new secure store service app. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSecureStoreServiceApp SecureStoreServiceApp - { - Name = "Secure Store Service Application" - ApplicationPool = "SharePoint Service Applications" - AuditingEnabled = $true - AuditlogMaxSize = 30 - DatabaseName = "SP_SecureStore" - InstallAccount = $SetupAccount - } - } - } - - -.EXAMPLE - This example removes a secure store service app. The ApplicationPool and - AuditingEnabled parameters are required, but are not used so their values - are able to be set to anything. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSecureStoreServiceApp SecureStoreServiceApp - { - Name = "Secure Store Service Application" - ApplicationPool = "n/a" - AuditingEnabled = $false - InstallAccount = $SetupAccount - Ensure = "Absent" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt deleted file mode 100644 index 9f03c2ae0..000000000 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppPool.help.txt +++ /dev/null @@ -1,55 +0,0 @@ -.NAME - SPServiceAppPool - -# Description - - This resource is used for provisioning an application pool that can be used for - service applications. The account used for the service account must already be - registered as a managed account (which can be provisioned through - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application pool is provisioned. - -.PARAMETER Name - Key - string - The name of application pool - -.PARAMETER ServiceAccount - Required - string - The name of the managed account to run this service account as - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app pool 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 - - -.EXAMPLE - This example creates a service application pool for service apps to run in. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPServiceAppPool MainServiceAppPool - { - Name = "SharePoint Service Applications" - ServiceAccount = "Demo\ServiceAccount" - PsDscRunAsCredential = $SetupAccount - Ensure = "Present" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt deleted file mode 100644 index c1e52446c..000000000 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppProxyGroup.help.txt +++ /dev/null @@ -1,83 +0,0 @@ -.NAME - SPServiceAppProxyGroup - -# Description - - This resource is used to manage SharePoint Service Application Proxy Groups. - The "Ensure" parameter controls whether or not the Proxy Group should exist. A - proxy group cannot be removed if a web application is using it. The - "ServiceAppProxies" property will set a specific list of Service App Proxies - to be members of this Proxy Group. It will add and remove proxies to ensure - the group matches this list exactly. The "ServiceAppProxiesToInclude" and - "ServiceAppProxiesToExclude" properties will allow you to add and remove - proxies from the group, leaving other proxies that are in the group but not in - either list intact. - - Use the proxy group name "Default" to manipulate the default proxy group. - - Requirements: - At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or - ServiceAppProxiesToExclude properties needs to be specified. Do not combine - the ServiceAppProxies property with the ServiceAppProxiesToInclude and - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the proxy group is created. - -.PARAMETER Name - Key - String - Name of the Proxy Group to create - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present creates the proxy group if it does not already exist, Absent will delete the proxy group if it exists - -.PARAMETER ServiceAppProxies - Write - String - List of service application proxies that belong in this proxy group, all others will be removed - -.PARAMETER ServiceAppProxiesToInclude - Write - String - List of service application proxies to add to this proxy group, existing proxies will remain - -.PARAMETER ServiceAppProxiesToExclude - Write - String - List of service application proxies to remove from this proxy grop, all others will remain - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example creates two seperate proxy groups of service apps that can be - assigned to web apps in the farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPServiceAppProxyGroup ProxyGroup1 - { - Name = "Proxy Group 1" - Ensure = "Present" - ServiceAppProxies = "Web 1 User Profile Service Application","Web 1 MMS Service Application","State Service Application" - } - - SPServiceAppProxyGroup ProxyGroup2 - { - Name = "Proxy Group 2" - Ensure = "Present" - ServiceAppProxiesToInclude = "Web 2 User Profile Service Application" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt deleted file mode 100644 index 01a0291ca..000000000 --- a/Modules/SharePointDsc/en-us/about_SPServiceAppSecurity.help.txt +++ /dev/null @@ -1,81 +0,0 @@ -.NAME - SPServiceAppSecurity - -# Description - - This resource is used to manage the sharing security settings of a specific - service application. There are a number of approaches to how this can be - implemented. Firstly you can set permissions for the app administrators, or - for the sharing permission by specifying the SecurityType attribute. These - options correlate to the buttons seen in the ribbon on the "manage service - applications" page in Central Administration after you select a specific - service app. The "Members" property will set a specific list of members for - the service app, 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 - -.PARAMETER ServiceAppName - Key - String - The name of the service application you wish to apply security settings to - -.PARAMETER SecurityType - Key - string - Allowed values: Administrators, SharingPermissions - Administrators will set the administrators for the service app, SharingPermissions will set those granted access through the permissions button seen in the Sharing section of the ribbon in central admin - -.PARAMETER Members - Write - String - A list of members to set the group to. Those not in this list will be removed - -.PARAMETER MembersToInclude - Write - String - A list of members to add. Members not in this list will be left in the group - -.PARAMETER MembersToExclude - Write - String - A list of members to remove. Members not in this list will be left in the group - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how full control permission can be given to the farm - account and service app pool account to the user profile service app's - sharing permission. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - $membersToInclude = @() - $membersToInclude += MSFT_SPServiceAppSecurityEntry { - Username = "CONTOSO\SharePointFarmAccount" - AccessLevel = "Full Control" - } - $membersToInclude += MSFT_SPServiceAppSecurityEntry { - Username = "CONTOSO\SharePointServiceApps" - AccessLevel = "Full Control" - } - SPServiceAppSecurity UserProfileServiceSecurity - { - ServiceAppName = "User Profile Service Application" - SecurityType = "SharingPermissions" - MembersToInclude = $membersToInclude - MembersToExclude = @("CONTOSO\BadAccount1", "CONTOSO\BadAccount2") - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt deleted file mode 100644 index 0b2342092..000000000 --- a/Modules/SharePointDsc/en-us/about_SPServiceInstance.help.txt +++ /dev/null @@ -1,76 +0,0 @@ -.NAME - SPServiceInstance - -# Description - - This resource is used to specify if a specific service should be running - (Ensure = "Present") or not running (Ensure = "Absent") on the current server. - The name is the display name of the service as shown in the Central Admin - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service instance is started. - -.PARAMETER Name - Key - string - The name of the service instance to manage - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to ensure it runs on this server, or absent to ensure it is stopped - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to ensure that the managed metadata service is running - on the local server. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPServiceInstance ManagedMetadataServiceInstance - { - Name = "Managed Metadata Web Service" - Ensure = "Present" - InstallAccount = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to ensure that the Business Data Connectivity Service - is not running on the local server. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPServiceInstance StopBCSServiceInstance - { - Name = "Business Data Connectivity Service" - Ensure = "Absent" - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt deleted file mode 100644 index 8949c9c96..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSessionStateService.help.txt +++ /dev/null @@ -1,59 +0,0 @@ -.NAME - SPSessionStateService - -# Description - - This resource will provision a state service app to the local farm. Specify - the name of the database server and database name to provision the app with, - and optionally include the session timeout value. If session timeout is not - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER DatabaseName - Key - string - The name of the database for the service - -.PARAMETER DatabaseServer - Key - string - The name of the database server for the database - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present is the state service should be enabled, absent if it should be disabled - -.PARAMETER SessionTimeout - Write - uint32 - What is the timeout on sessions - -.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 session state service on the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSessionStateService StateServiceApp - { - DatabaseName = "SP_StateService" - DatabaseServer = "SQL.test.domain" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt deleted file mode 100644 index 71eb6b65e..000000000 --- a/Modules/SharePointDsc/en-us/about_SPShellAdmins.help.txt +++ /dev/null @@ -1,120 +0,0 @@ -.NAME - SPShellAdmins - -# Description - - This resource is used to manage the users with Shell Admin permissions. 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. The "ContentDatabases" and - "AllContentDatabases" properties will allow you to control the permissions on - Content Databases. - - Requirements: - - * At least one of the Members, MemberToInclude or MembersToExclude properties - needs to be specified. - * Do not combine the Members property with the MemberToInclude and - MembersToExclude properties. - * Do not combine the ContentDatabase property with the AllContentDatabases - property. - - Notes: - 1.) If a content database is created using the Central Admin, the farm account - is the owner of that content database in SQL Server. When this is true, you - cannot add it to the Shell Admins (common for AllContentDatabases parameter) - and the resource will throw an error. Workaround: Change database owner in SQL - -.PARAMETER Name - Key - String - Name for the config, used for administration purposes - -.PARAMETER Members - Write - String - Exact list of accounts that will have to get Shell Admin permissions - -.PARAMETER MembersToInclude - Write - String - List of all accounts that must be in the Shell Admins group - -.PARAMETER MembersToExclude - Write - String - List of all accounts that are not allowed to have Shell Admin permissions - -.PARAMETER ContentDatabases - Write - String - Shell Admin configuration of Content Databases - -.PARAMETER AllContentDatabases - Write - Boolean - Specify if all content databases must get the same config as the general config - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example gives admin access to the specified users for the local farm as well as - all content databases in the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPShellAdmins ShellAdmins - { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - AllContentDatabases = $true - } - } - } - - -.EXAMPLE - This example gives admin access to the specified users for the local farm as well as - all content databases in the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPShellAdmins ShellAdmins - { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - ContentDatabases = @( - @(MSFT_SPContentDatabasePermissions { - Name = "SharePoint_Content_1" - Members = "CONTOSO\user2", "CONTOSO\user3" - }) - @(MSFT_SPContentDatabasePermissions { - Name = "SharePoint_Content_2" - Members = "CONTOSO\user3", "CONTOSO\user4" - }) - ) - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSite.help.txt b/Modules/SharePointDsc/en-us/about_SPSite.help.txt deleted file mode 100644 index fe3bb4a3b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSite.help.txt +++ /dev/null @@ -1,104 +0,0 @@ -.NAME - SPSite - -# Description - - This resource will provision a site collection to the current farm, based on - the settings that are passed through. These settings map to the New-SPSite - cmdlet and accept the same values and types. - - The current version of SharePointDsc is only able to check for the existence - of a site collection, the additional parameters are not checked for yet, but - will be in a later release - - Note: When creating Host Header Site Collections, do not use the HostHeader - parameter in SPWebApplication. This will set the specified host header on your - IIS site and prevent the site from listening for the URL of the Host Header - Site Collection. - If you want to change the IIS website binding settings, please use the xWebsite - resource in the xWebAdministration module. - -.PARAMETER Url - Key - string - The URL of the site collection - -.PARAMETER OwnerAlias - Required - string - The username of the site collection administrator - -.PARAMETER CompatibilityLevel - Write - uint32 - The compatibility level of the site - -.PARAMETER ContentDatabase - Write - string - The name of the content database to create the site in - -.PARAMETER Description - Write - string - The description to apply to the site collection - -.PARAMETER HostHeaderWebApplication - Write - string - The URL of the host header web application to create this site in - -.PARAMETER Language - Write - uint32 - The language code of the site - -.PARAMETER Name - Write - string - The display name of the site collection - -.PARAMETER OwnerEmail - Write - string - The email address of the site collection administrator - -.PARAMETER QuotaTemplate - Write - string - The quota template to apply to the site collection - -.PARAMETER SecondaryEmail - Write - string - The secondary site collection admin email address - -.PARAMETER SecondaryOwnerAlias - Write - string - The secondary site collection admin username - -.PARAMETER Template - Write - string - The template to apply to the site collection - -.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 site collection with the provided details - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSite TeamSite - { - Url = "http://sharepoint.contoso.com" - OwnerAlias = "CONTOSO\ExampleUser" - HostHeaderWebApplication = "http://spsites.contoso.com" - Name = "Team Sites" - Template = "STS#0" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt deleted file mode 100644 index 98947110b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPStateServiceApp.help.txt +++ /dev/null @@ -1,63 +0,0 @@ -.NAME - SPStateServiceApp - -# Description - - This resource provisions an instance of the state service in to the local farm. - The database specific parameters are only used during initial provisioning of - the app, and will not change database settings beyond the initial deployment. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the state service app - -.PARAMETER DatabaseCredentials - Write - String - The database credentials for accessing the database - -.PARAMETER DatabaseName - Required - string - The name of the database for the service app - -.PARAMETER DatabaseServer - Write - string - The name of the database server - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app 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 - - -.EXAMPLE - This example creates a state service application in the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPStateServiceApp StateServiceApp - { - Name = "State Service Application" - DatabaseName = "SP_State" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt deleted file mode 100644 index 5cfe78035..000000000 --- a/Modules/SharePointDsc/en-us/about_SPSubscriptionSettingsServiceApp.help.txt +++ /dev/null @@ -1,96 +0,0 @@ -.NAME - SPSubscriptionSettingsServiceApp - -# 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 subscription - settings service 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. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the subscription settings service app - -.PARAMETER ApplicationPool - Required - String - The name of the application pool the service app runs in - -.PARAMETER DatabaseName - Write - string - The name of the database for the service app - -.PARAMETER DatabaseServer - Write - String - The name of the database server - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app 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 - - -.EXAMPLE - This example creates a new subscription settings service app in the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp - { - Name = "Subscription Settings Service Application" - ApplicationPool = "SharePoint web services" - DatabaseServer = "SQL01.contoso.com" - DatabaseName = "SP_SubscriptionSettings" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example removes a subscription settings service app in the local farm. - The ApplicationPool property is required, but is ignored when removing a - service app. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp - { - Name = "Subscription Settings Service Application" - ApplicationPool = "n/a" - PsDscRunAsCredential = $SetupAccount - Ensure = "Absent" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt deleted file mode 100644 index ea2f5011a..000000000 --- a/Modules/SharePointDsc/en-us/about_SPTimerJobState.help.txt +++ /dev/null @@ -1,72 +0,0 @@ -.NAME - SPTimerJobState - -# Description - - This resource is used to configure a timer job and make sure it is in a - specific state. The resource can be used to enable or disabled the job and - configure the schedule of the job. - - The schedule parameter has to be written in the SPSchedule format - (https://technet.microsoft.com/en-us/library/ff607916.aspx). - - Examples are: - - - Every 5 minutes between 0 and 59 - - Hourly between 0 and 59 - - Daily at 15:00:00 - - Weekly between Fri 22:00:00 and Sun 06:00:00 - - Monthly at 15 15:00:00 - - Yearly at Jan 1 15:00:00 - - NOTE: Make sure you use the internal timer job name, not the display name! Use - "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" - to find the internal name for each Timer Job. - -.PARAMETER Name - Key - String - The internal name of the timer job (not the display name) - -.PARAMETER WebApplication - Write - String - The name of the web application that the timer job belongs to - -.PARAMETER Enabled - Write - Boolean - Should the timer job be enabled or not - -.PARAMETER Schedule - Write - String - The schedule for the timer job to execute on - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example show how to disable the dead site delete job in the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPTimerJobState DisableTimerJob_DeadSiteDelete - { - Name = "job-dead-site-delete" - WebApplication = "http://sites.sharepoint.contoso.com" - Enabled = $false - Schedule ="weekly at sat 5:00" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt deleted file mode 100644 index d184884a5..000000000 --- a/Modules/SharePointDsc/en-us/about_SPTrustedIdentityTokenIssuer.help.txt +++ /dev/null @@ -1,168 +0,0 @@ -.NAME - SPTrustedIdentityTokenIssuer - -# Description - - This resource is used to create or remove SPTrustedIdentityTokenIssuer in a - SharePoint farm. - - Either parameter SigningCertificateThumbPrint or SigningCertificateFilePath - must be set, but not both. - - The SigningCertificateThumbPrint must be the thumbprint of the signing - certificate stored in the certificate store LocalMachine\My of the server - - Note that the private key of the certificate must not be available in the - certiificate store because SharePoint does not accept it. - - The SigningCertificateFilePath must be the file path to the public key of - the signing certificate. - - The ClaimsMappings property is an array of MSFT_SPClaimTypeMapping to use - with cmdlet New-SPClaimTypeMapping. Each MSFT_SPClaimTypeMapping requires - properties Name and IncomingClaimType. Property LocalClaimType is not - required if its value is identical to IncomingClaimType. - - The IdentifierClaim property must match an IncomingClaimType element in - ClaimsMappings array. - - The ClaimProviderName property can be set to specify a custom claims provider. - It must be already installed in the SharePoint farm and returned by cmdlet - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the token issuer is created. - -.PARAMETER Name - Key - String - Name of the SPTrustedIdentityTokenIssuer - -.PARAMETER Description - Required - String - Description of the SPTrustedIdentityTokenIssuer - -.PARAMETER Realm - Required - String - Default Realm that is passed to identity provider - -.PARAMETER SignInUrl - Required - String - URL of the identity provider where user is redirected to for authentication - -.PARAMETER IdentifierClaim - Required - String - Identity claim type that uniquely identifies the user - -.PARAMETER ClaimsMappings - Required - String - Array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping - -.PARAMETER SigningCertificateThumbprint - Write - String - Specify the thumbprint of the signing certificate, which must be located in certificate store LocalMachine\\My - -.PARAMETER SigningCertificateFilePath - Write - String - Specify the file path to the signing certificate if it is not stored in the local certificate store already - -.PARAMETER ClaimProviderName - Write - String - Name of a claims provider to set with this SPTrustedIdentityTokenIssuer - -.PARAMETER ProviderSignOutUri - Write - String - Sign-out URL - -.PARAMETER Ensure - Write - String - Allowed values: Present, Absent - Present if the SPTrustedIdentityTokenIssuer should be created, or Absent if it should be removed - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example deploys a trusted token issuer to the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPTrustedIdentityTokenIssuer SampleSPTrust - { - Name = "Contoso" - Description = "Contoso" - Realm = "https://sharepoint.contoso.com" - SignInUrl = "https://adfs.contoso.com/adfs/ls/" - IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ClaimsMappings = @( - MSFT_SPClaimTypeMapping{ - Name = "Email" - IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - } - MSFT_SPClaimTypeMapping{ - Name = "Role" - IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" - LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" - } - ) - SigningCertificateThumbPrint = "F0D3D9D8E38C1D55A3CEF3AAD1C18AD6A90D5628" - ClaimProviderName = "LDAPCP" - ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example deploys a trusted token issuer to the local farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPTrustedIdentityTokenIssuer SampleSPTrust - { - Name = "Contoso" - Description = "Contoso" - Realm = "https://sharepoint.contoso.com" - SignInUrl = "https://adfs.contoso.com/adfs/ls/" - IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ClaimsMappings = @( - MSFT_SPClaimTypeMapping{ - Name = "Email" - IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - } - MSFT_SPClaimTypeMapping{ - Name = "Role" - IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" - LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" - } - ) - SigningCertificateFilePath = "F:\Data\DSC\FakeSigning.cer" - ClaimProviderName = "LDAPCP" - ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt deleted file mode 100644 index f072a5703..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUsageApplication.help.txt +++ /dev/null @@ -1,86 +0,0 @@ -.NAME - SPUsageApplication - -# Description - - This resource provisions an instance of the usage and health monitoring service - application. The database settings are only used for initial provisioning, but - the usage settings can be changed and will be enforced as the resource is - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the service application - -.PARAMETER DatabaseName - Write - string - The name of the database for the service app - -.PARAMETER DatabaseServer - Write - string - The name of the database server - -.PARAMETER DatabaseCredentials - Write - String - The credentials to use to access the database - -.PARAMETER FailoverDatabaseServer - Write - string - The name of the failover database server - -.PARAMETER UsageLogCutTime - Write - uint32 - The time in minutes to cut over to new log files - -.PARAMETER UsageLogLocation - Write - string - The location on each server to store the log files - -.PARAMETER UsageLogMaxFileSizeKB - Write - uint32 - The maximum file size for log files in KB - -.PARAMETER UsageLogMaxSpaceGB - Write - uint32 - The total space of all log files on disk in GB - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app 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 - - -.EXAMPLE - This example deploys a usage application to the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUsageApplication UsageApplication - { - Name = "Usage Service Application" - DatabaseName = "SP_Usage" - UsageLogCutTime = 5 - UsageLogLocation = "L:\UsageLogs" - UsageLogMaxFileSizeKB = 1024 - Ensure = "Present" - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt deleted file mode 100644 index 6b170b01b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileProperty.help.txt +++ /dev/null @@ -1,168 +0,0 @@ -.NAME - SPUserProfileProperty - -# Description - - This resource will create a property in a user profile service application. It - creates, update or delete a property using the parameters that are passed in to - it. - - The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the - 5th field of section Bla, which has propertyName value of 5000 then your - DisplayOrder needs to be 5005. If no DisplayOrder is added then SharePoint - adds it as the last property of section X. - - Length is only relevant if Field type is "String". - - This Resource doesn't currently support removing existing user profile - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the user profile property is created. - -.PARAMETER Name - Key - string - The internal name of the user profile property - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the property should exist, absent if it should be removed - -.PARAMETER UserProfileService - Required - string - The name of the user profile service application - -.PARAMETER DisplayName - Write - string - The display name of the property - -.PARAMETER Type - Write - string - Allowed values: BigInteger, Binary, Boolean, Date, DateNoYear, DateTime, Email, Float, Guid, HTML, Integer, Person, String, StringMultiValue, TimeZone, URL - The type of the property - -.PARAMETER Description - Write - string - The description of the property - -.PARAMETER PolicySetting - Write - string - Allowed values: Mandatory, Optin, Optout, Disabled - The policy setting to apply to the property - -.PARAMETER PrivacySetting - Write - string - Allowed values: Public, Contacts, Organization, Manager, Private - The privacy setting for the property - -.PARAMETER MappingConnectionName - Write - string - The name of the UPS connect to map this property to - -.PARAMETER MappingPropertyName - Write - string - The name of the property from the UPS connection to map to - -.PARAMETER MappingDirection - Write - string - The direction of the mapping, either Import or Export - -.PARAMETER Length - Write - uint32 - The length of the field - -.PARAMETER DisplayOrder - Write - uint32 - The display order to put the property in to the list at - -.PARAMETER IsEventLog - Write - boolean - Is this field used for event logging - -.PARAMETER IsVisibleOnEditor - Write - boolean - Is this field visible when editing a users profile, or hidden from editing - -.PARAMETER IsVisibleOnViewer - Write - boolean - Is this field visible when viewing a users profile - -.PARAMETER IsUserEditable - Write - boolean - Is this field able to be edited by a user, or only an administrator - -.PARAMETER IsAlias - Write - boolean - Is this field an alias that can be used to refer to a user by - -.PARAMETER IsSearchable - Write - boolean - Is this field able to be searched upon - -.PARAMETER UserOverridePrivacy - Write - boolean - Can users override the default privacy policy - -.PARAMETER TermStore - Write - string - The name of the term store to look up managed terms from - -.PARAMETER TermGroup - Write - string - The name of the term store group that terms are in for this field - -.PARAMETER TermSet - Write - string - The name of the term set to allow values to be selected from - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example deploys/updates the WorkEmail2 property in the user profile service - app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileProperty WorkEmailProperty - { - Name = "WorkEmail2" - Ensure = "Present" - UserProfileService = "User Profile Service Application" - DisplayName = "Work Email" - Type = "Email" - Description = "" #implementation isn't using it yet - PolicySetting = "Mandatory" - PrivacySetting = "Public" - MappingConnectionName = "contoso.com" - MappingPropertyName = "mail" - MappingDirection = "Import" - Length = 10 - DisplayOrder =25 - IsEventLog =$false - IsVisibleOnEditor=$true - IsVisibleOnViewer = $true - IsUserEditable = $true - IsAlias = $false - IsSearchable = $false - TermStore = "" - TermGroup = "" - TermSet = "" - UserOverridePrivacy = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt deleted file mode 100644 index 062bde77c..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSection.help.txt +++ /dev/null @@ -1,68 +0,0 @@ -.NAME - SPUserProfileSection - -# Description - - This resource will create a section in a user profile service application. It - creates, update or delete a section using the parameters that are passed in to - it. - - If no DisplayOrder is added then SharePoint will automatically assigned an ID - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the user profile section is created. - -.PARAMETER Name - Key - string - The internal name of the user profile section - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the section should exist, absent if it should be removed - -.PARAMETER UserProfileService - Required - string - The name of the user profile service application this section exists in - -.PARAMETER DisplayName - Write - string - The display name of the section - -.PARAMETER DisplayOrder - Write - uint32 - A number used to sort sections by - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example adds a new section for profile properties to the specified - user profile service app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileSection PersonalInformationSection - { - Name = "PersonalInformationSection" - UserProfileService = "User Profile Service Application" - DisplayName = "Personal Information" - DisplayOrder = 5000 - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt deleted file mode 100644 index 4aa51ed58..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceApp.help.txt +++ /dev/null @@ -1,153 +0,0 @@ -.NAME - SPUserProfileServiceApp - -# Description - - This resource will provision an instance of the user profile service to the - farm. It creates the required databases using the parameters that are passed - in to it (although these are only used during the initial provisioning). The - farm account is used during the provisioning of the service only (in the set - method), and the install account is used in the get and test methods. This is - done to ensure that the databases are created with the correct schema owners - and allow the user profile sync service to operate correctly. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the user profile service - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER ApplicationPool - Required - string - The name of the application pool to run the service app in - -.PARAMETER FarmAccount - Write - String - The farm account to use when provisioning the app - -.PARAMETER MySiteHostLocation - Write - string - The URL of the my site host collection - -.PARAMETER ProfileDBName - Write - string - The name of the profile database - -.PARAMETER ProfileDBServer - Write - string - The name of the server to host the profile database - -.PARAMETER SocialDBName - Write - string - The name of the social database - -.PARAMETER SocialDBServer - Write - string - The name of the database server to host the social database - -.PARAMETER SyncDBName - Write - string - The name of the sync database - -.PARAMETER SyncDBServer - Write - string - The name of the database server to host the sync database - -.PARAMETER EnableNetBIOS - Write - boolean - Whether Farm should resolve NetBIOS domain names - -.PARAMETER NoILMUsed - Write - boolean - Specifies if the service application should be configured to use AD Import - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app 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 - - -.EXAMPLE - This example adds a new user profile service application to the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileServiceApp UserProfileServiceApp - { - Name = "User Profile Service Application" - ApplicationPool = "SharePoint Service Applications" - MySiteHostLocation = "http://my.sharepoint.contoso.local" - ProfileDBName = "SP_UserProfiles" - ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" - SocialDBName = "SP_Social" - SocialDBServer = "SQL.contoso.local\SQLINSTANCE" - SyncDBName = "SP_ProfileSync" - SyncDBServer = "SQL.contoso.local\SQLINSTANCE" - EnableNetBIOS = $false - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example adds a new user profile service application to the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileServiceApp UserProfileServiceApp - { - Name = "User Profile Service Application" - ApplicationPool = "SharePoint Service Applications" - MySiteHostLocation = "http://my.sharepoint.contoso.local" - ProfileDBName = "SP_UserProfiles" - ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" - SocialDBName = "SP_Social" - SocialDBServer = "SQL.contoso.local\SQLINSTANCE" - SyncDBName = "SP_ProfileSync" - SyncDBServer = "SQL.contoso.local\SQLINSTANCE" - EnableNetBIOS = $false - NoILMUsed = $true - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt deleted file mode 100644 index 7730af844..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileServiceAppPermissions.help.txt +++ /dev/null @@ -1,59 +0,0 @@ -.NAME - SPUserProfileServiceAppPermissions - -# Description - - This resource will apply permissions to a user profile service application. - These can control access to create my sites, use social features, and use - tagging. If you want to allow all users the ability to use a specific - permisisons include "Everyone" as a user in the corresponding property. To - specify that there should be no permissions on a type, use "none" - -.PARAMETER ProxyName - Key - string - The name of the proxy that is attached to the user profile service you wish to set permissions for - -.PARAMETER CreatePersonalSite - Required - string - A list of user principals that will have the Create personal site permission - -.PARAMETER FollowAndEditProfile - Required - string - A list of user principals that will have the Follow users and edit profile permission - -.PARAMETER UseTagsAndNotes - Required - string - A list of user principals that will have the Use tags and notes permission - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example applies permissions for the user profile service application to limit - access to specific features. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileServiceAppPermissions UPAPermissions - { - ProxyName = "User Profile Service Application Proxy" - CreatePersonalSite = @("DEMO\Group", "DEMO\User1") - FollowAndEditProfile = @("Everyone") - UseTagsAndNotes = @("None") - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt deleted file mode 100644 index 8b4409e0a..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncConnection.help.txt +++ /dev/null @@ -1,93 +0,0 @@ -.NAME - SPUserProfileSyncConnection - -# Description - - This resource will ensure a specifc user profile sync connection is in place - and that it is configured accordingly to its definition - - This resource currently supports AD only. - -.PARAMETER Name - Key - string - The name of the connection - -.PARAMETER Forest - Required - string - The name of the AD forest to read from - -.PARAMETER UserProfileService - Required - string - The name of the user profile service that this connection is attached to - -.PARAMETER ConnectionCredentials - Required - string - The credentials to connect to Active Directory with - -.PARAMETER IncludedOUs - Required - string - A list of the OUs to import users from - -.PARAMETER ExcludedOUs - Write - string - A list of the OUs to ignore users from - -.PARAMETER Server - Write - string - The specific AD server to connect to - -.PARAMETER UseSSL - Write - boolean - Should SSL be used for the connection - -.PARAMETER Force - Write - boolean - Set to true to run the set method on every call to this resource - -.PARAMETER ConnectionType - Write - string - Allowed values: ActiveDirectory, BusinessDataCatalog - The type of the connection - currently only Active Directory is supported - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example adds a new user profile sync connection to the specified user - profile service app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $ConnectionAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileSyncConnection MainDomain - { - UserProfileService = "User Profile Service Application" - Forest = "contoso.com" - Name = "Contoso" - ConnectionCredentials = $ConnectionAccount - Server = "server.contoso.com" - UseSSL = $false - IncludedOUs = @("OU=SharePoint Users,DC=Contoso,DC=com") - ExcludedOUs = @("OU=Notes Usersa,DC=Contoso,DC=com") - Force = $false - ConnectionType = "ActiveDirectory" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt deleted file mode 100644 index 209cf882b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPUserProfileSyncService.help.txt +++ /dev/null @@ -1,71 +0,0 @@ -.NAME - SPUserProfileSyncService - -# Description - - This resource is responsible for ensuring that the user profile sync service - has been provisioned (Ensure = "Present") or is not running (Ensure = - "Absent") on the current server. This resource uses the InstallAccount to - validate the current state only, the set method which will do the provisioning - uses the FarmAccount to do the actual work - this means that CredSSP - authentication will need to be permitted to allow a connection to the local - server. To allow successful provisioning the farm account must be in the local - administrators group, however it is not best practice to leave this account in - the Administrators group. Therefore this resource will add the FarmAccount - credential to the local administrators group at the beginning of the set - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the user profile sync service is provisioned. - -.PARAMETER UserProfileServiceAppName - Key - string - The name of the user profile service for this sync instance - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to ensure the service is running, absent to ensure it is not - -.PARAMETER FarmAccount - Required - String - The farm account, which is needed to provision the service app - -.PARAMETER RunOnlyWhenWriteable - Write - Boolean - Should the sync service only run when the user profile database is in a writeable state? - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example provisions the user profile sync service to the local server - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileSyncService UserProfileSyncService - { - UserProfileServiceAppName = "User Profile Service Application" - Ensure = "Present" - FarmAccount = $FarmAccount - RunOnlyWhenWriteable = $true - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt deleted file mode 100644 index fe74ec48b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPVisioServiceApp.help.txt +++ /dev/null @@ -1,85 +0,0 @@ -.NAME - SPVisioServiceApp - -# Description - - This resource is responsible for creating Visio Graphics Service Application - instances within the local SharePoint farm. The resource will provision and - configure the Visio Graphics Service Application. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the service application - -.PARAMETER ApplicationPool - Required - string - The name of the application pool to run the service app in - -.PARAMETER ProxyName - Write - string - The name of the Visio Service Application Proxy - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the service app 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 - - -.EXAMPLE - This example shows how to create a new visio services service app in the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPVisioServiceApp VisioServices - { - Name = "Visio Graphics Service Application" - ApplicationPool = "SharePoint Web Services" - InstallAccount = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to remove a visio services service app in the local farm. - The ApplicationPool property is still requried but is not used when removing, so - the value used here doesn't matter. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPVisioServiceApp VisioServices - { - Name = "Visio Graphics Service Application" - ApplicationPool = "n/a" - Ensure = "Absent" - InstallAccount = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt b/Modules/SharePointDsc/en-us/about_SPWeb.help.txt deleted file mode 100644 index 79e332fab..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWeb.help.txt +++ /dev/null @@ -1,86 +0,0 @@ -.NAME - SPWeb - -# Description - - This resource will provision a SPWeb based on the settings that are passed - through. These settings map to the New-SPWeb cmdlet and accept the same values - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the web is created. - -.PARAMETER Url - Key - string - The URL of the web - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the web should exist or Absent if it should be removed - -.PARAMETER Description - Write - string - The description to apply to the web - -.PARAMETER Name - Write - string - The Name of the web - -.PARAMETER Language - Write - uint32 - The Lanhuage (LCID) of the web - -.PARAMETER Template - Write - string - The WebTemplate to use to create the web - -.PARAMETER UniquePermissions - Write - Boolean - True if the web should have unique permissions, otherwise false. - -.PARAMETER UseParentTopNav - Write - Boolean - True if the web should use the parent nav bar, otherwise false. - -.PARAMETER AddToQuickLaunch - Write - Boolean - True if the web should be in the quick launch of the parent web, otherwise false. - -.PARAMETER AddToTopNav - Write - Boolean - True if the web should be added to the top nav bar of the parent web, otherwise false. - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example deploys a subsite in a specific location - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWeb TeamSite - { - Url = "http://sharepoint.contoso.com/sites/site/subweb" - Name = "Team Sites" - Ensure = "Present" - Description = "A place to share documents with your team." - Template = "STS#0" - Language = 1033 - AddToTopNav = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt deleted file mode 100644 index bbc65b7eb..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppBlockedFileTypes.help.txt +++ /dev/null @@ -1,90 +0,0 @@ -.NAME - SPWebAppBlockedFileTypes - -# Description - - This resource is responsible for controlling the blocked file type setting on a - specific web application. It has two modes of operation, the first is to use - the "blocked" property, where you are able to define a specific list of file - types that will be blocked. In this mode when it is detected that the list - does not match the local farm, it is set to match this list exactly. The - second mode is to use the "EnsureBlocked" and "EnsureAllowed" properties. - EnsureBlocked will check to make sure that the specified file types are on the - list, and if not they will be added. EnsureAllowed checks to make sure that a - file type is not on the list, and if it is it will be removed. Both of these - properties will only make changes to the file types in their list and will - leave the full list as it is otherwise, whereas the blocked property resets - -.PARAMETER Url - Key - string - The URL of the web application to set blocked file types for - -.PARAMETER Blocked - write - string - This is a fixed list to use for blocked file types in this web app - -.PARAMETER EnsureBlocked - write - string - This list of file types that will always be added to the list for this web app. Types not in this list will be left in the list - -.PARAMETER EnsureAllowed - write - string - This list of file types that will always be removedfrom the list for this web app. Types not in this list will be left in the list - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to ensure that specific file types are always blocked while - others will always be allowed. Any file types not mentioned in this config will be - able to be managed manually. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes - { - Url = "http://exmaple.contoso.local" - EnsureBlocked = @("exe", "dll", "msi") - EnsureAllowed = @("pdf", "docx", "xlsx") - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to ensure that the blocked file type list always - specifically matches this list. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes - { - Url = "http://exmaple.contoso.local" - Blocked = @("exe", "dll", "msi") - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt deleted file mode 100644 index 68659ed15..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppGeneralSettings.help.txt +++ /dev/null @@ -1,124 +0,0 @@ -.NAME - SPWebAppGeneralSettings - -# Description - - This resource is responsible for setting web application settings that are - found under the "general settings" screen in central admin. The web - application is specified through the URL property, and then any combination of - settings can be applied. Any settings not included will be left as the default - (or whatever they have been manually changed to within SharePoint). - -.PARAMETER Url - Key - string - The URL of the web app to set the general settings for - -.PARAMETER TimeZone - Write - uint32 - The timezone code to use for this web app. A full list is at https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spregionalsettings.timezones.aspx - -.PARAMETER Alerts - Write - boolean - Should alerts be enabled for this web app - -.PARAMETER AlertsLimit - Write - uint32 - What is the maximum number of alerts that a user can create in this web app - -.PARAMETER RSS - Write - boolean - Should RSS feeds be enabled in this web app - -.PARAMETER BlogAPI - Write - boolean - Should the Blog API be enabled in this web app - -.PARAMETER BlogAPIAuthenticated - Write - boolean - Is authentication required for the blog API - -.PARAMETER BrowserFileHandling - Write - String - Allowed values: Strict, Permissive - What file handling mode should be used in this web app - strict or permissive - -.PARAMETER SecurityValidation - Write - boolean - Is security validation enforced in this web app - -.PARAMETER SecurityValidationExpires - Write - boolean - Does security validation expire after a set time - -.PARAMETER SecurityValidationTimeOutMinutes - Write - uint32 - Number of minutes security validation will expire if securityvalidationexpires is set - -.PARAMETER RecycleBinEnabled - Write - boolean - Is the recycle bin enabled in this web application - -.PARAMETER RecycleBinCleanupEnabled - Write - boolean - Is automatic cleanup of the recycle bin enabled in this web app - -.PARAMETER RecycleBinRetentionPeriod - Write - uint32 - How many days does the recycle bin keep content for - -.PARAMETER SecondStageRecycleBinQuota - Write - uint32 - How much content does the second stage recycle bin keep content for - -.PARAMETER MaximumUploadSize - Write - uint32 - What is the maximum file upload size for this web app (in MB) - -.PARAMETER CustomerExperienceProgram - Write - boolean - Should the customer experience program be enabled in this web app - -.PARAMETER AllowOnlineWebPartCatalog - Write - boolean - Should the Online WebPart Gallery be enabled for this web app - -.PARAMETER SelfServiceSiteCreationEnabled - Write - boolean - Should Self Service Site Creation be enabled - -.PARAMETER PresenceEnabled - Write - boolean - Is Skype for Business presence enabled for this web app - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply some of the available general settings to the - specified web app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppGeneralSettings PrimaryWebAppGeneralSettings - { - Url = "http://exmaple.contoso.local" - TimeZone = 76 - Alerts = $true - RSS = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt deleted file mode 100644 index 376f4e1be..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppPermissions.help.txt +++ /dev/null @@ -1,89 +0,0 @@ -.NAME - SPWebAppPermissions - -# Description - - This resource is responsible for managing the user permissions for a web - application. You can either specify to set all permissions or specify - individual permissions per category. - - More info about the permission levels: - -.PARAMETER WebAppUrl - Key - string - The url of the web application - -.PARAMETER ListPermissions - Write - string - Allowed values: Manage Lists, Override List Behaviors, Add Items, Edit Items, Delete Items, View Items, Approve Items, Open Items, View Versions, Delete Versions, Create Alerts, View Application Pages - List permissions that need to be configured - -.PARAMETER SitePermissions - Write - string - Allowed values: Manage Permissions, View Web Analytics Data, Create Subsites, Manage Web Site, Add and Customize Pages, Apply Themes and Borders, Apply Style Sheets, Create Groups, Browse Directories, Use Self-Service Site Creation, View Pages, Enumerate Permissions, Browse User Information, Manage Alerts, Use Remote Interfaces, Use Client Integration Features, Open, Edit Personal User Information - Site permissions that need to be configured - -.PARAMETER PersonalPermissions - Write - string - Allowed values: Manage Personal Views, Add/Remove Personal Web Parts, Update Personal Web Parts - Personal permissions that need to be configured - -.PARAMETER AllPermissions - Write - boolean - Set all permissions - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to limit the available permisions within a web app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppPermissions WebApplicationPermissions - { - WebAppUrl = "https://intranet.sharepoint.contoso.com" - ListPermissions = "Manage Lists","Override List Behaviors","Add Items","Edit Items","Delete Items","View Items","Approve Items","Open Items","View Versions","Delete Versions","Create Alerts","View Application Pages" - SitePermissions = "Manage Permissions","View Web Analytics Data","Create Subsites","Manage Web Site","Add and Customize Pages","Apply Themes and Borders","Apply Style Sheets","Create Groups","Browse Directories","Use Self-Service Site Creation","View Pages","Enumerate Permissions","Browse User Information","Manage Alerts","Use Remote Interfaces","Use Client Integration Features","Open","Edit Personal User Information" - PersonalPermissions = "Manage Personal Views","Add/Remove Personal Web Parts","Update Personal Web Parts" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to ensure all permissions are available for a web app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppPermissions WebApplicationPermissions - { - WebAppUrl = "https://portal.sharepoint.contoso.com" - AllPermissions = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt deleted file mode 100644 index 404dc14ba..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppPolicy.help.txt +++ /dev/null @@ -1,123 +0,0 @@ -.NAME - SPWebAppPolicy - -# Description - - This resource is used to set the User Policies for web applications. The - usernames can be either specified in Classic or Claims format, both will be - accepted. 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. - - Requirements: - At least one of the Members, MemberToInclude or MembersToExclude properties - needs to be specified. Do not combine the Members property with the - MemberToInclude and MembersToExclude properties. Do not set the - ActAsSystemAccount property to $true without setting the permission level to - -.PARAMETER WebAppUrl - Key - string - The URL of the web application - -.PARAMETER Members - Write - String - Exact list of accounts that will have to get Web Policy permissions - -.PARAMETER MembersToInclude - Write - String - List of all accounts that must be in the Web Policy group - -.PARAMETER MembersToExclude - Write - String - List of all accounts that are not allowed to have any Web Policy permissions - -.PARAMETER SetCacheAccountsPolicy - Write - Boolean - Include the Cache Accounts in the policy or not - -.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 specific web app policy for the specified web app to - match the provided list below. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppPolicy WebAppPolicy - { - WebAppUrl = "http://sharepoint.contoso.com" - Members = @( - MSFT_SPWebPolicyPermissions { - Username = "contoso\user1" - PermissionLevel = "Full Control" - ActAsSystemAccount = $true - } - MSFT_SPWebPolicyPermissions { - Username = "contoso\Group 1" - PermissionLevel = "Full Read" - IdentityType = "Claims" - } - ) - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to include specific members while excluding other members - from the policy of the web app. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppPolicy WebAppPolicy - { - WebAppUrl = "http://sharepoint.contoso.com" - MembersToInclude = @( - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user1" - PermissionLevel = "Full Control" - }) - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user2" - PermissionLevel = "Full Read" - }) - ) - MembersToExclude = @( - @(MSFT_SPWebPolicyPermissions { - Username = "contoso\user3" - }) - ) - SetCacheAccountsPolicy = $true - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt deleted file mode 100644 index 12151f76f..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppProxyGroup.help.txt +++ /dev/null @@ -1,52 +0,0 @@ -.NAME - SPWebAppProxyGroup - -# Description - - This resource is used to associate a web application to a service application - proxy group. Use the proxy group name "Default" to associate the web - application to the default proxy group. A web applicaiton can only connect to - a single service application proxy group. This resource will overright the - existing service application proxy group association. - - This resource is used in conjunction with the SPServiceAppProxyGroup resource, - which creates the proxy groups and associates the desired service application - proxies with it. Within your configuration, that resource should be a - -.PARAMETER WebAppUrl - Key - String - URL of the web application - -.PARAMETER ServiceAppProxyGroup - Required - string - Name of the Service Application Proxy Group - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to assign a specific proxy group to the specified web app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppProxyGroup ContosoWeb - { - WebAppUrl = "https://web.contoso.com" - ServiceAppProxyGroup = "Proxy Group 1" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt deleted file mode 100644 index 2ef086db4..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppSiteUseAndDeletion.help.txt +++ /dev/null @@ -1,62 +0,0 @@ -.NAME - SPWebAppSiteUseAndDeletion - -# Description - - This resource is responsible for controlling the Site Use and Deletion - settings on a specific web application. You can enable or disable the Site Use - and Deletion feature, specify the amount of days after which the alerts are - being send, if sites have to be deleted automatically and if so after how many - -.PARAMETER Url - Key - string - The URL of the web application - -.PARAMETER SendUnusedSiteCollectionNotifications - Write - boolean - Should emails be sent to notify site owners of unused site collections - -.PARAMETER UnusedSiteNotificationPeriod - Write - uint32 - How many days should pass before a site is flagged as unused - -.PARAMETER AutomaticallyDeleteUnusedSiteCollections - Write - boolean - Should unused site collection be automatically deleted - -.PARAMETER UnusedSiteNotificationsBeforeDeletion - Write - uint32 - How many days before an unused site is deleted should an email be sent to the owner - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply site use and deletion settings to the specified web applicaiton - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion - { - Url = "http://example.contoso.local" - SendUnusedSiteCollectionNotifications = $true - UnusedSiteNotificationPeriod = 90 - AutomaticallyDeleteUnusedSiteCollections = $true - UnusedSiteNotificationsBeforeDeletion = 24 - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt deleted file mode 100644 index c82635b35..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppThrottlingSettings.help.txt +++ /dev/null @@ -1,97 +0,0 @@ -.NAME - SPWebAppThrottlingSettings - -# Description - - This resource is responsible for setting web application settings that are - found under the "resource throttling" screen in central admin. The web - application is specified through the URL property, and then any combination of - settings can be applied. Any settings not included will be left as the default - (or whatever they have been manually changed to within SharePoint). Happy hour - is the setting used to control the window where threshold do not apply - throughout the day. You can specify the start time of this window as well as - -.PARAMETER Url - Key - string - The URL of the web application - -.PARAMETER ListViewThreshold - Write - uint32 - What should the list view threshold for this site be set to - -.PARAMETER AllowObjectModelOverride - Write - boolean - Should object model code be able to be override the list view threshold - -.PARAMETER AdminThreshold - Write - uint32 - What is the list view threshold for site administrators - -.PARAMETER ListViewLookupThreshold - Write - uint32 - What is the maximum number of lookup fields in a single list view - -.PARAMETER HappyHourEnabled - Write - boolean - Should the happy hour window be enabled for this web app - -.PARAMETER HappyHour - Write - string - The time window for happy hour - -.PARAMETER UniquePermissionThreshold - Write - uint32 - What is the limit for unique permissions on a single object in this web app - -.PARAMETER RequestThrottling - Write - boolean - Is request throttling enabled on this web app - -.PARAMETER ChangeLogEnabled - Write - boolean - Is the change log enabled for this web app - -.PARAMETER ChangeLogExpiryDays - Write - uint32 - How many days does the change log store data for - -.PARAMETER EventHandlersEnabled - Write - boolean - Are event handlers enabled in the web application - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply throttling settings to a specific web app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings - { - Url = "http://exmaple.contoso.local" - ListViewThreshold = 5000 - AllowObjectModelOverride = $false - HappyHourEnabled = $true - HappyHour = MSFT_SPWebApplicationHappyHour { - Hour = 3 - Minute = 0 - Duration = 1 - } - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt deleted file mode 100644 index b0a3353dc..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebAppWorkflowSettings.help.txt +++ /dev/null @@ -1,57 +0,0 @@ -.NAME - SPWebAppWorkflowSettings - -# Description - - This resource is responsible for setting web application settings that are - found under the "workflow settings" screen in central admin. The web - application is specified through the URL property, and then any combination of - settings can be applied. Any settings not included will be left as the default - (or whatever they have been manually changed to within SharePoint). - -.PARAMETER Url - Key - string - The URL of the web application - -.PARAMETER ExternalWorkflowParticipantsEnabled - Write - boolean - Are external workflow participants enabled in the web app - -.PARAMETER UserDefinedWorkflowsEnabled - Write - boolean - Are user defined workflows enabled in this web app - -.PARAMETER EmailToNoPermissionWorkflowParticipantsEnable - Write - boolean - Are documents sent via email to external participants of workflow - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to apply workflow settings to the specific web application - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings - { - Url = "Shttp://exmaple.contoso.local" - ExternalWorkflowParticipantsEnabled = $false - EmailToNoPermissionWorkflowParticipantsEnable = $false - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt deleted file mode 100644 index 42d76ab7f..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebApplication.help.txt +++ /dev/null @@ -1,179 +0,0 @@ -.NAME - SPWebApplication - -# Description - - This resource is responsible for creating a web application within the local - SharePoint farm. The resource will provision the web application with all of - the current settings, and then ensure that it stays part of the correct - application pool beyond that (additional checking and setting of properties - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the web application is provisioned. - - Note: When using Host Header Site Collections, do not use the HostHeader - parameter in SPWebApplication. This will set the specified host header on your - IIS site and prevent the site from listening for the URL of the Host Header - Site Collection. - If you want to change the IIS website binding settings, please use the xWebsite - resource in the xWebAdministration module. - -.PARAMETER Name - Key - string - The name of the web application - -.PARAMETER ApplicationPool - Required - string - The name of the application pool to run this site in - -.PARAMETER ApplicationPoolAccount - Required - string - The name of the managed account to run the app pool with - -.PARAMETER Url - Required - string - The URL of the web application - -.PARAMETER AllowAnonymous - Write - boolean - Should anonymous access be enabled for this web app - -.PARAMETER AuthenticationMethod - Write - string - Allowed values: NTLM, Kerberos, Claims, Classic - What authentication mode should be used for the web app - -.PARAMETER AuthenticationProvider - Write - string - What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims - -.PARAMETER DatabaseName - Write - string - The name of the first content database to be created with this web app - -.PARAMETER DatabaseServer - Write - string - The name of the database server to host the default content DB - -.PARAMETER HostHeader - Write - string - The host header to use for the web app - -.PARAMETER Path - Write - string - The path on the local servers to host the IIS web site from - -.PARAMETER Port - Write - string - The port to run the site on - -.PARAMETER UseSSL - Write - boolean - Should this web app use SSL - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the web app 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 - - -.EXAMPLE - This example shows how to create a new web application in the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebApplication HostNameSiteCollectionWebApp - { - Name = "SharePoint Sites" - ApplicationPool = "SharePoint Sites" - ApplicationPoolAccount = "CONTOSO\svcSPWebApp" - AllowAnonymous = $false - AuthenticationMethod = "NTLM" - DatabaseName = "SP_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - Url = "http://example.contoso.local" - Port = 80 - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to create a new web application in the local farm using a custom claim provider. - A SPTrustedIdentityTokenIssuer is created named Contoso, then this SPTrustedIdentityTokenIssuer is referenced - by the SPWebApplication as the AuthenticationProvider and the AuthenticationMethod is set to "Claims" value. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - - - SPTrustedIdentityTokenIssuer SampleSPTrust - { - Name = "Contoso" - Description = "Contoso" - Realm = "https://sharepoint.contoso.com" - SignInUrl = "https://adfs.contoso.com/adfs/ls/" - IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ClaimsMappings = @( - MSFT_SPClaimTypeMapping{ - Name = "Email" - IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - } - MSFT_SPClaimTypeMapping{ - Name = "Role" - IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" - LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" - } - ) - SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" - ClaimProviderName = "LDAPCP" - ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - - - SPWebApplication HostNameSiteCollectionWebApp - { - Name = "SharePoint Sites" - ApplicationPool = "SharePoint Sites" - ApplicationPoolAccount = "CONTOSO\svcSPWebApp" - AllowAnonymous = $false - AuthenticationMethod = "Claims" - AuthenticationProvider = "Contoso" - DatabaseName = "SP_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - Url = "http://example.contoso.local" - Port = 80 - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt deleted file mode 100644 index 80c0a694b..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebApplicationAppDomain.help.txt +++ /dev/null @@ -1,64 +0,0 @@ -.NAME - SPWebApplicationAppDomain - -# Description - - This resource will configure the App Domain at a specific zone for the given - Web Application. The configuration is done per zone on the specified web - application, allowing for the setting of unique app domains for each extension - of a web application. The app prefix should still be set using the SPAppDomain - resource before this is applied to customise a specific zone. - -.PARAMETER WebApplication - Key - string - The URL of the web application to set the app domain for - -.PARAMETER Zone - Key - string - Allowed values: Default, Internet, Intranet, Extranet, Custom - The zone that this app domain applies to - -.PARAMETER AppDomain - Required - string - The domain for apps in this web app zone - -.PARAMETER Port - Write - string - The port to run apps on - -.PARAMETER SSL - Write - boolean - Should apps run under SSL - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example shows how to set the app domain for a specified web application - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebApplicationAppDomain Domain - { - AppDomain = "contosointranetapps.com" - WebApplication ="http://portal.contoso.com"; - Zone = "Default"; - Port = 80; - SSL = $false; - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt b/Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt deleted file mode 100644 index 461b6a58c..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWebApplicationExtension.help.txt +++ /dev/null @@ -1,101 +0,0 @@ -.NAME - SPWebApplicationExtension - -# Description - - This resource is responsible for extending an existing web application into a new - zone. The resource will provision the web application extension with all of - the current settings, and then ensure that it stays present and will ensure the - AllowAnonymous and Authentication methods remain consistent. Please note that this - currently does not support changing the claims provider on an existing claims - enabled web application externsion. - -.PARAMETER WebAppUrl - Key - string - The URL of the parent web application - -.PARAMETER Name - Required - string - The name of the web application extension - -.PARAMETER Url - Required - string - The URL of the web application extension - -.PARAMETER Zone - Key - string - Allowed values: Default, Intranet, Internet, Extranet, Custom - Specifies one of the five zones with which the internal URL of this new extension is to be associated. - -.PARAMETER AllowAnonymous - Write - boolean - Should anonymous access be enabled for this web app extension - -.PARAMETER AuthenticationMethod - Write - string - Allowed values: NTLM, Kerberos, Claims - What authentication mode should be used for the web app extension - -.PARAMETER AuthenticationProvider - Write - string - What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims - -.PARAMETER HostHeader - Write - string - The host header to use for the web app extension - -.PARAMETER Path - Write - string - The path on the local servers to host the IIS web site from - -.PARAMETER Port - Write - string - The port to run the site on - -.PARAMETER UseSSL - Write - boolean - Should this web app extension use SSL - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present if the web app 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 - - -.EXAMPLE - This example shows how to create a new web application extension in the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebApplicationExtension IntranetZone - { - WebAppUrl = "http://example.contoso.local" - Name = "Contoso Intranet Zone" - AllowAnonymous = $false - AuthenticationMethod = "NTLM" - Url = "http://intranet.contoso.local" - Zone = "Intranet" - HostHeader = "intranet.contoso.local" - Path = "c:\inetpub\wwwroot\wss\VirtualDirectories\intranet" - UseSSL = $false - Port = 80 - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt deleted file mode 100644 index 4f031c8e7..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWordAutomationServiceApp.help.txt +++ /dev/null @@ -1,161 +0,0 @@ -.NAME - SPWordAutomationServiceApp - -# Description - - The resource is able to provision, unprovision and configure the Word - Automation Service Application. All settings that you can configure on the - Service Application administration page are configurable using this resource. - - Important: - When you specify Ensure=Present, the Application Pool and DatabaseName - parameters are required. When you specify Ensure=Absent, no other parameters - are allowed (with the exception of Name, InstallAccount or - PsDscRunAsCredential). - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - THe name of the service application - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to ensure the app exists, absent to ensure that it does not - -.PARAMETER ApplicationPool - Write - string - The name of the application pool to run the service app in - -.PARAMETER DatabaseName - Write - string - The name of the database for the service app - -.PARAMETER DatabaseServer - Write - string - The name of the server that will host the database - -.PARAMETER SupportedFileFormats - Write - string - Allowed values: docx, doc, mht, rtf, xml - The list of supported file types - -.PARAMETER DisableEmbeddedFonts - Write - boolean - Should embedded fonts be disabled - -.PARAMETER MaximumMemoryUsage - Write - uint32 - What is the maximum amount of memory the service app should use (in MB) - -.PARAMETER RecycleThreshold - Write - uint32 - What is the recycle threshold for this service app - -.PARAMETER DisableBinaryFileScan - Write - boolean - Should binary file scans be disabled - -.PARAMETER ConversionProcesses - Write - uint32 - How many conversion processes can be run at once - -.PARAMETER JobConversionFrequency - Write - uint32 - How frequently should new jobs be started from the queue (in minutes) - -.PARAMETER NumberOfConversionsPerProcess - Write - uint32 - How many document conversions should be included in a single process - -.PARAMETER TimeBeforeConversionIsMonitored - Write - uint32 - How long can a conversion be run before it becomes monitored - -.PARAMETER MaximumConversionAttempts - Write - uint32 - What is the maximum number of attempts to convert a document - -.PARAMETER MaximumSyncConversionRequests - Write - uint32 - What is the maximum number of sync conversion requests for the service app - -.PARAMETER KeepAliveTimeout - Write - uint32 - How long is the keep alive timeout set to for the service app - -.PARAMETER MaximumConversionTime - Write - uint32 - What is the maximum time in seconds for a document conversion to be allowed to run - -.PARAMETER InstallAccount - Write - string - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - -.EXAMPLE - This example makes sure the service application exists and has a specific configuration - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWordAutomationServiceApp WordAutomation - { - Name = "Word Automation Service Application" - Ensure = "Present" - ApplicationPool = "SharePoint Web Services" - DatabaseName = "WordAutomation_DB" - DatabaseServer = "SQLServer" - SupportedFileFormats = "docx", "doc", "mht", "rtf", "xml" - DisableEmbeddedFonts = $false - MaximumMemoryUsage = 100 - RecycleThreshold = 100 - DisableBinaryFileScan = $false - ConversionProcesses = 8 - JobConversionFrequency = 15 - NumberOfConversionsPerProcess = 12 - TimeBeforeConversionIsMonitored = 5 - MaximumConversionAttempts = 2 - MaximumSyncConversionRequests = 25 - KeepAliveTimeout = 30 - MaximumConversionTime = 300 - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example removes a word automation service app - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWordAutomationServiceApp WordAutomation - { - Name = "Word Automation Service Application" - Ensure = "Absent" - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt deleted file mode 100644 index 979c2cf81..000000000 --- a/Modules/SharePointDsc/en-us/about_SPWorkManagementServiceApp.help.txt +++ /dev/null @@ -1,92 +0,0 @@ -.NAME - SPWorkManagementServiceApp - -# Description - - This resource is used to provision and manage an instance of the Work - Management Services Service Application. It will identify an instance of the - work 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. - - Remarks - - - Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, - MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in - minutes. - - The default value for the Ensure parameter is Present. When not specifying this - parameter, the service application is provisioned. - -.PARAMETER Name - Key - string - The name of the work management service application - -.PARAMETER ProxyName - Write - string - The proxy name, if not specified will be /Name of service app/ Proxy - -.PARAMETER Ensure - Write - string - Allowed values: Present, Absent - Present to ensure the app exists, Absent to ensure it is removed - -.PARAMETER ApplicationPool - Write - String - The name of the application pool this will run in - -.PARAMETER MinimumTimeBetweenEwsSyncSubscriptionSearches - Write - uint32 - The minimum amount of time bween EWS sync subscription searches - -.PARAMETER MinimumTimeBetweenProviderRefreshes - Write - uint32 - The minimum time between provider refreshes - -.PARAMETER MinimumTimeBetweenSearchQueries - Write - uint32 - The minimum time between search queries - -.PARAMETER NumberOfSubscriptionSyncsPerEwsSyncRun - Write - uint32 - The number of subscription syncronisations per EWS sync run - -.PARAMETER NumberOfUsersEwsSyncWillProcessAtOnce - Write - uint32 - How many users will EWS calls include at once - -.PARAMETER NumberOfUsersPerEwsSyncBatch - Write - uint32 - How many users are included in a batch for EWS - -.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 work management service app in the local farm - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWorkManagementServiceApp WorkManagementServiceApp - { - Name = "Work Management Service Application" - ApplicationPool = "SharePoint web services" - MinimumTimeBetweenEwsSyncSubscriptionSearches = 10 - PsDscRunAsCredential = $SetupAccount - } - } - } - - From d62d91a60156892bc4abc59cdd3775d8404c06e6 Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Thu, 7 Sep 2017 11:49:26 +0200 Subject: [PATCH 13/18] Updated documentation after issue with folder name casing --- .../en-US/about_SPAccessServiceApp.help.txt | 89 ++++++++ .../en-US/about_SPAlternateUrl.help.txt | 87 ++++++++ .../en-US/about_SPAntivirusSettings.help.txt | 65 ++++++ .../en-US/about_SPAppCatalog.help.txt | 45 ++++ .../en-US/about_SPAppDomain.help.txt | 45 ++++ .../about_SPAppManagementServiceApp.help.txt | 101 +++++++++ .../en-US/about_SPAppStoreSettings.help.txt | 99 +++++++++ .../en-US/about_SPBCSServiceApp.help.txt | 97 ++++++++ .../en-US/about_SPBlobCacheSettings.help.txt | 87 ++++++++ .../en-US/about_SPCacheAccounts.help.txt | 84 +++++++ .../en-US/about_SPConfigWizard.help.txt | 79 +++++++ .../en-US/about_SPContentDatabase.help.txt | 104 +++++++++ .../en-US/about_SPCreateFarm.help.txt | 191 ++++++++++++++++ .../en-US/about_SPDatabaseAAG.help.txt | 120 ++++++++++ .../en-US/about_SPDesignerSettings.help.txt | 96 ++++++++ ...about_SPDiagnosticLoggingSettings.help.txt | 129 +++++++++++ .../about_SPDistributedCacheService.help.txt | 174 +++++++++++++++ .../en-US/about_SPExcelServiceApp.help.txt | 152 +++++++++++++ .../SharePointDsc/en-US/about_SPFarm.help.txt | 210 ++++++++++++++++++ .../en-US/about_SPFarmAdministrators.help.txt | 89 ++++++++ .../en-US/about_SPFarmPropertyBag.help.txt | 84 +++++++ .../en-US/about_SPFarmSolution.help.txt | 77 +++++++ .../en-US/about_SPFeature.help.txt | 93 ++++++++ .../about_SPHealthAnalyzerRuleState.help.txt | 62 ++++++ .../en-US/about_SPInstall.help.txt | 127 +++++++++++ .../about_SPInstallLanguagePack.help.txt | 91 ++++++++ .../en-US/about_SPInstallPrereqs.help.txt | 181 +++++++++++++++ .../en-US/about_SPIrmSettings.help.txt | 54 +++++ .../en-US/about_SPJoinFarm.help.txt | 98 ++++++++ .../en-US/about_SPManagedAccount.help.txt | 105 +++++++++ ...about_SPManagedMetaDataServiceApp.help.txt | 138 ++++++++++++ .../en-US/about_SPManagedPath.help.txt | 121 ++++++++++ ...about_SPOfficeOnlineServerBinding.help.txt | 87 ++++++++ .../about_SPOutgoingEmailSettings.help.txt | 100 +++++++++ .../about_SPPasswordChangeSettings.help.txt | 58 +++++ ...bout_SPPerformancePointServiceApp.help.txt | 93 ++++++++ .../en-US/about_SPProductUpdate.help.txt | 145 ++++++++++++ ...about_SPPublishServiceApplication.help.txt | 87 ++++++++ .../en-US/about_SPQuotaTemplate.help.txt | 69 ++++++ .../en-US/about_SPRemoteFarmTrust.help.txt | 59 +++++ .../about_SPSearchContentSource.help.txt | 154 +++++++++++++ .../en-US/about_SPSearchCrawlRule.help.txt | 110 +++++++++ .../en-US/about_SPSearchFileType.help.txt | 97 ++++++++ .../about_SPSearchIndexPartition.help.txt | 68 ++++++ .../en-US/about_SPSearchResultSource.help.txt | 76 +++++++ .../en-US/about_SPSearchServiceApp.help.txt | 113 ++++++++++ .../en-US/about_SPSearchTopology.help.txt | 89 ++++++++ .../about_SPSecureStoreServiceApp.help.txt | 127 +++++++++++ .../en-US/about_SPServiceAppPool.help.txt | 55 +++++ .../about_SPServiceAppProxyGroup.help.txt | 83 +++++++ .../en-US/about_SPServiceAppSecurity.help.txt | 81 +++++++ .../en-US/about_SPServiceInstance.help.txt | 76 +++++++ .../about_SPSessionStateService.help.txt | 59 +++++ .../en-US/about_SPShellAdmins.help.txt | 120 ++++++++++ .../SharePointDsc/en-US/about_SPSite.help.txt | 104 +++++++++ .../en-US/about_SPStateServiceApp.help.txt | 63 ++++++ ..._SPSubscriptionSettingsServiceApp.help.txt | 96 ++++++++ .../en-US/about_SPTimerJobState.help.txt | 72 ++++++ ...bout_SPTrustedIdentityTokenIssuer.help.txt | 168 ++++++++++++++ .../en-US/about_SPUsageApplication.help.txt | 86 +++++++ .../about_SPUserProfileProperty.help.txt | 168 ++++++++++++++ .../en-US/about_SPUserProfileSection.help.txt | 68 ++++++ .../about_SPUserProfileServiceApp.help.txt | 153 +++++++++++++ ...PUserProfileServiceAppPermissions.help.txt | 59 +++++ ...about_SPUserProfileSyncConnection.help.txt | 93 ++++++++ .../about_SPUserProfileSyncService.help.txt | 71 ++++++ .../en-US/about_SPVisioServiceApp.help.txt | 85 +++++++ .../SharePointDsc/en-US/about_SPWeb.help.txt | 86 +++++++ .../about_SPWebAppBlockedFileTypes.help.txt | 90 ++++++++ .../about_SPWebAppGeneralSettings.help.txt | 124 +++++++++++ .../en-US/about_SPWebAppPermissions.help.txt | 89 ++++++++ .../en-US/about_SPWebAppPolicy.help.txt | 123 ++++++++++ .../en-US/about_SPWebAppProxyGroup.help.txt | 52 +++++ .../about_SPWebAppSiteUseAndDeletion.help.txt | 62 ++++++ .../about_SPWebAppThrottlingSettings.help.txt | 97 ++++++++ .../about_SPWebAppWorkflowSettings.help.txt | 57 +++++ .../en-US/about_SPWebApplication.help.txt | 179 +++++++++++++++ .../about_SPWebApplicationAppDomain.help.txt | 64 ++++++ .../about_SPWebApplicationExtension.help.txt | 101 +++++++++ .../about_SPWordAutomationServiceApp.help.txt | 161 ++++++++++++++ .../about_SPWorkManagementServiceApp.help.txt | 92 ++++++++ 81 files changed, 8043 insertions(+) create mode 100644 Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPFarm.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPFeature.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPInstall.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSite.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWeb.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt new file mode 100644 index 000000000..af0142a8a --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt @@ -0,0 +1,89 @@ +.NAME + SPAccessServiceApp + +# Description + + This resource is responsible for creating Access Services Application instances + within the local SharePoint farm. The resource will provision and configure the + Access Services Service Application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER DatabaseServer + Required - string + The name of the database server to host Access Services databases + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy Access Services 2013 to the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAccessServiceApp AccessServices + { + Name = "Access Services Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + + This example shows how to remove a specific Access Services 2013 from the local + SharePoint farm. Because Application pool and database server are both required + parameters, but are not acutally needed to remove the app, any text value can + be supplied for these as they will be ignored. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAccessServiceApp AccessServices + { + Name = "Access Services Service Application" + ApplicationPool = "n/a" + DatabaseServer = "n/a" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt new file mode 100644 index 000000000..c19dcabd8 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt @@ -0,0 +1,87 @@ +.NAME + SPAlternateUrl + +# Description + + This resource is used to define an alternate access mapping URL for a specified + web application. These can be assigned to specific zones for each web + application. Alternatively a URL can be removed from a zone to ensure that it + will remain empty and have no alternate URL. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the setting is configured. + +.PARAMETER WebAppUrl + Key - String + The URL of the web application to apply the alternate URL to + +.PARAMETER Zone + Key - String + Allowed values: Default, Intranet, Extranet, Custom, Internet + The Zone to use for the alternate URL + +.PARAMETER Url + Write - String + The new alternate URL + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures the URL is set for this zone on this web app, Absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to add a new alternate URL to a specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAlternateUrl CentralAdminAAM + { + WebAppUrl = "http://sharepoint1:9999" + Zone = "Intranet" + Url = "https://admin.sharepoint.contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove an alternate URL from a specified zone for a specific + web application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAlternateUrl CentralAdminAAM + { + WebAppUrl = "http://sharepoint1:9999" + Zone = "Intranet" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt new file mode 100644 index 000000000..e5310458b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt @@ -0,0 +1,65 @@ +.NAME + SPAntivirusSettings + +# 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. + +.PARAMETER ScanOnDownload + Key - Boolean + Should documents be scanned before being downloaded + +.PARAMETER ScanOnUpload + Write - Boolean + Should documents be scanned on upload + +.PARAMETER AllowDownloadInfected + Write - Boolean + Should documents that are infected be allowed to be downloaded + +.PARAMETER AttemptToClean + Write - Boolean + Should infected documents be handed to the AV engine to attempt cleaning + +.PARAMETER TimeoutDuration + Write - Uint16 + What is the timeout for an AV scan in seconds + +.PARAMETER NumberOfThreads + Write - Uint16 + How many concurrent threads should the AV engine be able to run on a server + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply specific anti-virus configuration to the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAntivirusSettings AVSettings + { + ScanOnDownload = $true + ScanOnUpload = $true + AllowDownloadInfected = $false + AttemptToClean = $false + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt new file mode 100644 index 000000000..7503bc167 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt @@ -0,0 +1,45 @@ +.NAME + SPAppCatalog + +# 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). + + This resource should be run using the farm account, and not another specific + setup account. Running this with the setup account you have used in your + configuration may relate to access denied errors. + +.PARAMETER SiteUrl + Key - string + The URL of the site collection that will be the app catalog for the web app that it is in + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppCatalog MainAppCatalog + { + SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt new file mode 100644 index 000000000..a0dd1da87 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt @@ -0,0 +1,45 @@ +.NAME + SPAppDomain + +# 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. + +.PARAMETER AppDomain + Key - string + The domain name for apps to use in this farm + +.PARAMETER Prefix + Required - string + The prefix to go on to app URLs + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply app URLs to the current farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppDomain LocalFarmAppUrls + { + AppDomain = "contosointranetapps.com" + Prefix = "app" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt new file mode 100644 index 000000000..db0141d21 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt @@ -0,0 +1,101 @@ +.NAME + SPAppManagementServiceApp + +# 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. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the app management service application + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER ApplicationPool + Required - String + The app pool that should be used to run the service app + +.PARAMETER DatabaseName + Write - string + The name of the database for the service application + +.PARAMETER DatabaseServer + Write - String + The name of the server for the database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new app management service application in the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppManagementServiceApp AppManagementServiceApp + { + Name = "App Management Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_AppManagement" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove a specific app management service application in the + local SharePoint farm. The application pool property is still mandatory but it is not + used so therefore the value is not important. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppManagementServiceApp AppManagementServiceApp + { + Name = "App Management Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt new file mode 100644 index 000000000..20fc57d6c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt @@ -0,0 +1,99 @@ +.NAME + SPAppStoreSettings + +# Description + + This resource will configure the ability to purchase apps for both SharePoint + and Office apps. + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER AllowAppPurchases + Write - Boolean + Specifies if App Purchases from the SharePoint Store are allowed + +.PARAMETER AllowAppsForOffice + Write - Boolean + Specifies if App Purchases for Office applications are allowed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppStoreSettings EnableSharePointAppStore + { + WebAppUrl = "https://sharepoint.contoso.com" + AllowAppPurchases = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppStoreSettings EnableAppStores + { + WebAppUrl = "https://sharepoint.contoso.com" + AllowAppPurchases = $true + AllowAppsForOffice = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to configure the AppCatalog in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPAppStoreSettings DisableAppStores + { + WebAppUrl = "https://sharepoint.contoso.com" + AllowAppPurchases = $false + AllowAppsForOffice = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt new file mode 100644 index 000000000..32597f9e7 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt @@ -0,0 +1,97 @@ +.NAME + SPBCSServiceApp + +# 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. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the BCS service app + +.PARAMETER ApplicationPool + Required - String + The application pool it should run in + +.PARAMETER DatabaseName + Write - string + Name of the database to create for the service app + +.PARAMETER DatabaseServer + Write - String + Name of the database server to host the database on + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy a Business Connectivity Services application to the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPBCSServiceApp BCSServiceApp + { + Name = "BCS Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseName = "SP_BCS" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to deploy a Business Connectivity Services application to the + local SharePoint farm. The application pool account is mandatory but the value is + ignored when removing a service app, so the value entered here does not matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPBCSServiceApp BCSServiceApp + { + Name = "BCS Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt new file mode 100644 index 000000000..bc524e718 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt @@ -0,0 +1,87 @@ +.NAME + SPBlobCacheSettings + +# Description + + This resource is used to configure the Blob Cache settings for a web + application. + + Important: + This resource only configures the local server. It changes the web.config + file directly and is NOT using the SPWebConfigModifications class. In order + to configure all WFE servers in the farm, you have to apply this resource + to all servers. + + Note: + + - In order to prevent inconsistancy between different web front end servers, + make sure you configure this setting on all servers equally. + - If the specified folder does not exist, the resource will create the folder. + + Best practice: + Specify a directory that is not on the same drive as where either the server + operating system swap files or server log files are stored. + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER Zone + Key - string + Allowed values: Default, Intranet, Internet, Custom, Extranet + The zone of the web application for which blob cache has to be configured + +.PARAMETER EnableCache + Required - Boolean + Specify if the blob cache has to be enabled + +.PARAMETER Location + Write - string + The location where the blob cache has to store its files + +.PARAMETER MaxSizeInGB + Write - Uint16 + The maximum size (in GB) of disk space the blob cache is allowed to use + +.PARAMETER MaxAgeInSeconds + Write - Uint32 + The maximum age (in seconds) that a browser caches a blob + +.PARAMETER FileTypes + Write - string + Specify the file types that must be stored by the blob cache + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the blob cache settings on the local server for the + specified web application and zone + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPBlobCacheSettings BlobCacheSettings + { + WebAppUrl = "http://intranet.contoso.com" + Zone = "Default" + EnableCache = $true + Location = "F:\BlobCache" + MaxSizeInGB = 10 + FileTypes = "\.(gif|jpg|png|css|js)$" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt new file mode 100644 index 000000000..cdc335f2d --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt @@ -0,0 +1,84 @@ +.NAME + SPCacheAccounts + +# 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)). + +.PARAMETER WebAppUrl + Key - string + The URL of the web application to set the accounts for + +.PARAMETER SuperUserAlias + Required - string + The account name for the super user + +.PARAMETER SuperReaderAlias + Required - string + The account name for the super reader + +.PARAMETER SetWebAppPolicy + Write - boolean + Should the web app policy be set for these accounts? + +.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 super use and reader accounts for the specified web app. It will + also set the appropriate web app policies by default for these accounts. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example sets the super use and reader accounts for the specified web app. It will + not set the web app policies for these accounts though, allowing them to be controlled + elsewhere (either manually or with SPWebAppPolicy) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + SetWebAppPolicy = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt new file mode 100644 index 000000000..c61bfe6e6 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt @@ -0,0 +1,79 @@ +.NAME + SPConfigWizard + +# Description + + This resource is used to perform the upgrade step of installing SharePoint + updates, like Cumulative Updates, Service Packs and Language Packs. The + DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in + which the update can be installed. This module has to be used to complete the + update installation step, performed by SPProductUpdate. + +.PARAMETER Ensure + Key - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + +.PARAMETER DatabaseUpgradeDays + Write - String + Allowed values: mon, tue, wed, thu, fri, sat, sun + Specify on which dates running the Configuration Wizard is allowed + +.PARAMETER DatabaseUpgradeTime + Write - String + Specify in which time frame running the Configuration Wizard is allowed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example runs the Configuration Wizard as soon as it is applied. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPConfigWizard RunConfigWizard + { + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example only runs the Configuration Wizard in the specified window: + - Saturday and Sunday night between 3am and 5am. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPConfigWizard RunConfigWizard + { + Ensure = "Present" + DatabaseUpgradeDays = "sat", "sun" + DatabaseUpgradeTime = "3:00am to 5:00am" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt new file mode 100644 index 000000000..1ef44784b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt @@ -0,0 +1,104 @@ +.NAME + SPContentDatabase + +# Description + + This resource is used to add and remove Content Databases to web applications + and configure these databases. Note: The resource cannot be used to move the + database to a different SQL instance. It will throw an error when it detects + that the specified SQL instance is a different instance that is currently in + use. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the content database is provisioned. + +.PARAMETER Name + Key - String + Specifies the name of the content database + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the content DB + +.PARAMETER WebAppUrl + Required - string + The URL of the web application + +.PARAMETER Enabled + Write - Boolean + Should the database be enabled + +.PARAMETER WarningSiteCount + Write - Uint16 + Specify the site collection warning limit for the content database + +.PARAMETER MaximumSiteCount + Write - Uint16 + Specify the site collection maximum limit for the content database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to create this database, absent to ensure it does not exist + +.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 content database for the specified web application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPContentDatabase ContentDB + { + Name = "SharePoint_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + WebAppUrl = "http://sharepoint.contoso.com" + Enabled = $true + WarningSiteCount = 2000 + MaximumSiteCount = 5000 + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example dismounts a content database from the specified web application. This + will not remove the database from SQL server however, only taking it out of the + web applications configuration. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPContentDatabase ContentDB + { + Name = "SharePoint_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + WebAppUrl = "http://sharepoint.contoso.com" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt new file mode 100644 index 000000000..49b7b24c2 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt @@ -0,0 +1,191 @@ +.NAME + SPCreateFarm + +# Description + + WARNING: This resource is deprecated. Please use SPFarm instead as + this resource will be removed from version 2.0 of SharePointDsc + + 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 SPJoinFarm. 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 passphrase is passed as a Credential object.The username of this + credential is ignored, only the value of the password is used as the farm + passphrase. + + 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 SPDistributedCacheService on at least one server in the farm to + designate it as a cache server. + + CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not + specified, it defaults to NTLM. If using Kerberos, make sure to have + appropriate SPNs setup for Farm account and Central Administration URI. + +.PARAMETER FarmConfigDatabaseName + Key - String + Name of the configuration database + +.PARAMETER DatabaseServer + Key - String + Server that will host the configuration and admin content databases + +.PARAMETER FarmAccount + Required - String + The account to use as the main farm account + +.PARAMETER Passphrase + Required - String + The passphrase to use to allow servers to join this farm + +.PARAMETER AdminContentDatabaseName + Required - String + The name of the admin content database + +.PARAMETER CentralAdministrationPort + Write - uint32 + What port will Central Admin be provisioned to - default is 9999 + +.PARAMETER CentralAdministrationAuth + Write - String + Allowed values: NTLM, Kerberos + The authentication provider of the CentralAdministration web application + +.PARAMETER ServerRole + Write - string + Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache + SharePoint 2016 only - the MinRole role to enroll this server as + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCreateFarm CreateFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. Here the port for the central admin site to + run on, as well as the authentication mode for the site are also specified. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCreateFarm CreateFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + CentralAdministrationPort = 5000 + CentralAdministrationAuth = "Kerberos" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. In this example we also see + the server role defined as "Application" which tells SharePoint 2016 the role to apply to + this server as soon as the farm is created. This property is not supported for SharePoint 2013 + and so this specific example would fail if used against that verison. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPCreateFarm CreateFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + ServerRole = "Application" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt new file mode 100644 index 000000000..834c30c21 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt @@ -0,0 +1,120 @@ +.NAME + SPDatabaseAAG + +# Description + + This resource will allow specifying which SQL Server AlwaysOn Availability + group a resource should be in. This resource does not configure the + Availability Groups on SQL Server, they must already exist. It simply adds + the specified database to the group. + + You can add a single database name by specifying the database name, or + multiple databases by specifying wildcards. For example: + SP_Content* or *Content* + + Important: + This resource requires the April 2014 CU to be installed. The required + cmdlets have been added in this CU: http://support.microsoft.com/kb/2880551 + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the content database is added to the AAG. + +.PARAMETER DatabaseName + Key - string + The name of the database to put in the AlwaysOn group + +.PARAMETER AGName + Required - string + Name of the AlwaysOn group on the SQL server - this must already exist + +.PARAMETER FileShare + Write - string + The fileshare to use for the SQL backup when adding to the group + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the database should be in this AlwaysOn group, or Absent if it should not be in the group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example takes an existing SharePoint database and puts it in to the specified + AlwaysOn Availability Group (AAG). + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "SP_Config" + AGName = "MyAvailabilityGroup" + FileShare = "\\SQL\Backups" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example takes existing SharePoint databases, based on the database name pattern, and puts + them in to the specified AlwaysOn Availability Group (AAG). + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "*Content*" + AGName = "MyAvailabilityGroup" + FileShare = "\\SQL\Backups" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a database from the specified AlwaysOn Availability Group (AAG) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDatabaseAAG ConfigDBAAG + { + DatabaseName = "SP_Config" + AGName = "MyAvailabilityGroup" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt new file mode 100644 index 000000000..29abe027d --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt @@ -0,0 +1,96 @@ +.NAME + SPDesignerSettings + +# 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 + +.PARAMETER Url + Key - string + The URL of the web application or site collection to configure + +.PARAMETER SettingsScope + Required - string + Allowed values: WebApplication, SiteCollection + Define the scope of the configuration - either WebApplication or SiteCollection + +.PARAMETER AllowSharePointDesigner + Write - Boolean + Allow the use of SharePoint Designer + +.PARAMETER AllowDetachPagesFromDefinition + Write - Boolean + Allow pages to be un-ghosted by SharePoint Designer + +.PARAMETER AllowCustomiseMasterPage + Write - Boolean + Allow masterpages to be changed by SharePoint Designer + +.PARAMETER AllowManageSiteURLStructure + Write - Boolean + Allow site URL structure to be changed by SharePoint Designer + +.PARAMETER AllowCreateDeclarativeWorkflow + Write - Boolean + Allow users to create declarative workflows with SharePoint Designer + +.PARAMETER AllowSavePublishDeclarativeWorkflow + Write - Boolean + Allow users to save and re-publish declarative workflows with SharePoint Designer + +.PARAMETER AllowSaveDeclarativeWorkflowAsTemplate + Write - Boolean + Allow users to save declarative workflows as a template from SharePoint Designer + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies settings to disable SharePoint Designer access to the + specified web application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDesignerSettings MainWebAppSPDSettings + { + Url = "https://intranet.sharepoint.contoso.com" + SettingsScope = "WebApplication" + AllowSharePointDesigner = $false + AllowDetachPagesFromDefinition = $false + AllowCustomiseMasterPage = $false + AllowManageSiteURLStructure = $false + AllowCreateDeclarativeWorkflow = $false + AllowSavePublishDeclarativeWorkflow = $false + AllowSaveDeclarativeWorkflowAsTemplate = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt new file mode 100644 index 000000000..b66029c17 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt @@ -0,0 +1,129 @@ +.NAME + SPDiagnosticLoggingSettings + +# 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 + +.PARAMETER LogPath + Key - string + The physical path on each server to store ULS logs + +.PARAMETER LogSpaceInGB + Required - uint32 + The space in GB that should be used to store ULS logs + +.PARAMETER AppAnalyticsAutomaticUploadEnabled + Write - boolean + Should app analytics automatically be uploaded + +.PARAMETER CustomerExperienceImprovementProgramEnabled + Write - boolean + Should the customer experience program be enabled in this farm + +.PARAMETER DaysToKeepLogs + Write - uint32 + How many days should ULS logs be kept for + +.PARAMETER DownloadErrorReportingUpdatesEnabled + Write - boolean + Should updates to error reporting tools be automatically downloaded + +.PARAMETER ErrorReportingAutomaticUploadEnabled + Write - boolean + Should error reports be automatically uploaded + +.PARAMETER ErrorReportingEnabled + Write - boolean + Should reporting of errors be enabled + +.PARAMETER EventLogFloodProtectionEnabled + Write - boolean + Protect event logs with Event Log Flood Protection + +.PARAMETER EventLogFloodProtectionNotifyInterval + Write - uint32 + What interval should the event logs report a flood event + +.PARAMETER EventLogFloodProtectionQuietPeriod + Write - uint32 + What quiet period should reset the event log flood protection thresholds + +.PARAMETER EventLogFloodProtectionThreshold + Write - uint32 + What is the event log flood protection threshold + +.PARAMETER EventLogFloodProtectionTriggerPeriod + Write - uint32 + What is the time period that will trigger event log flood protection + +.PARAMETER LogCutInterval + Write - uint32 + How many minutes of activity will a ULS log file leep in an individual file + +.PARAMETER LogMaxDiskSpaceUsageEnabled + Write - boolean + Will the maximum disk space setting be enabled + +.PARAMETER ScriptErrorReportingDelay + Write - uint32 + What delay will be set before script error reporting is triggered + +.PARAMETER ScriptErrorReportingEnabled + Write - boolean + Is script error reporting enabled in this farm + +.PARAMETER ScriptErrorReportingRequireAuth + Write - boolean + Require users to be authenticated to allow script errors to be reported + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies the specified diagnostic logging settings to the local + SharPoint farm. Any setting not defined will be left as it default, or to + whatever value has been manually configured outside of DSC. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDiagnosticLoggingSettings ApplyDiagnosticLogSettings + { + PsDscRunAsCredential = $SetupAccount + 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 + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt new file mode 100644 index 000000000..f68a80185 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt @@ -0,0 +1,174 @@ +.NAME + SPDistributedCacheService + +# 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 SPCreateFarm and SPJoinFarm 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. + + The ServerProvisionOrder optional property is used when a pull server is + handing out configurations to nodes in order to tell this resource about a + specific order of enabling the caches. This allows for multiple servers to + receive the same configuration, but they will always check for the server + before them in the list first to ensure that it is running distributed cache. + By doing this you can ensure that you do not create conflicts with two or more + servers provisioning a cache at the same time. Note, this approach only makes + a server check the others for distributed cache, it does not provision the + cache automatically on all servers. If a previous server in the sequence does + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the distributed cache is provisioned. + +.PARAMETER Name + Key - String + A name to assign to this resource - not really used. For example - AppFabricCachingService + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the current server should be running distributed cache, absent to ensure that it isn't running + +.PARAMETER CacheSizeInMB + Required - UInt32 + How many MB should be used for the cache. The maximum supported is 16384 + +.PARAMETER ServiceAccount + Required - String + The name of the service account to run the service as. This should already be registered as a managed account in SharePoint + +.PARAMETER ServerProvisionOrder + Write - String + A list of servers which specifies the order they should provision the cache in to ensure that two servers do not do it at the same time + +.PARAMETER CreateFirewallRules + Required - Boolean + Should the Windows Firewall rules for distributed cache be created? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies the distributed cache service to the current server, + also setting the rules in Windows firewall to allow communication with + other cache hosts. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + InstallAccount = $SetupAccount + CreateFirewallRules = $true + } + } + } + + +.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 + hosts to the Windows Firewall. Use this approach if you have an alternate + firewall solution. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + InstallAccount = $SetupAccount + CreateFirewallRules = $false + } + } + } + + +.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 + create the cache at the same time, resuling in errors. + + Note: Do not allow plain text passwords in production environments. + + + $ConfigurationData = @{ + AllNodes = @( + @{ + NodeName = 'Server1' + PSDscAllowPlainTextPassword = $true + }, + @{ + NodeName = 'Server2' + PSDscAllowPlainTextPassword = $true + } + ) + } + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node "Server1" + { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + ServerProvisionOrder = @("Server1","Server2") + CreateFirewallRules = $true + InstallAccount = $SetupAccount + } + } + + node "Server2" + { + SPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + ServerProvisionOrder = @("Server1","Server2") + CreateFirewallRules = $true + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt new file mode 100644 index 000000000..45dea7a37 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt @@ -0,0 +1,152 @@ +.NAME + SPExcelServiceApp + +# Description + + This resource is responsible for creating Excel Services Application instances + within the local SharePoint farm. The resource will provision and configure the + Excel Services Service Application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER TrustedFileLocations + Write - string + Trusted file locations for the service app + +.PARAMETER CachingOfUnusedFilesEnable + Write - Boolean + Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. + +.PARAMETER CrossDomainAccessAllowed + Write - Boolean + Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. + +.PARAMETER EncryptedUserConnectionRequired + Write - String + Allowed values: None, Connection + Requires that encryption is used between the end-user and the server running Excel Services Application. + +.PARAMETER ExternalDataConnectionLifetime + Write - Uint32 + Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. + +.PARAMETER FileAccessMethod + Write - String + Allowed values: UseImpersonation, UseFileAccessAccount + Specifies the authentication method that Excel Services Application uses to retrieve files. + +.PARAMETER LoadBalancingScheme + Write - String + Allowed values: RoundRobin, Local, WorkbookURL + Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers. + +.PARAMETER MemoryCacheThreshold + Write - Uint32 + Specifies the percentage of the maximum private bytes that can be allocated to inactive objects. + +.PARAMETER PrivateBytesMax + Write - Uint32 + Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. + +.PARAMETER SessionsPerUserMax + Write - Uint32 + Specifies the maximum number of sessions allowed for a user. + +.PARAMETER SiteCollectionAnonymousSessionsMax + Write - Uint32 + Specifies the maximum number of anonymous sessions allowed per site collection. + +.PARAMETER TerminateProcessOnAccessViolation + Write - Boolean + Terminates Excel Services Application when an access violation occurs in the process. + +.PARAMETER ThrottleAccessViolationsPerSiteCollection + Write - Uint32 + Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbook’s site collection are blocked from loading for the specified period (in seconds). + +.PARAMETER UnattendedAccountApplicationId + Write - String + Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter. + +.PARAMETER UnusedObjectAgeMax + Write - Uint32 + Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. + +.PARAMETER WorkbookCache + Write - String + Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application. + +.PARAMETER WorkbookCacheSizeMax + Write - Uint32 + Specifies the maximum allowable size, in megabytes, of an individual session. + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy Excel Services to the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPExcelServiceApp ExcelServices + { + Name = "Excel Services Service Application" + ApplicationPool = "SharePoint Service Applications" + InstallAccount = $SetupAccount + } + } + } + + +.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. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPExcelServiceApp ExcelServices + { + Name = "Excel Services Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt new file mode 100644 index 000000000..b433f1629 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt @@ -0,0 +1,210 @@ +.NAME + SPFarm + +# Description + + This resource is used to create a new SharePoint farm and allow servers to + join that farm. It will detect the presence of the configuration database + on the SQL server as a first step, and if it does not exist then the farm + will be created. If the database does exist, the server will join that + configuration database. Once the config DB has been created, the + resource will install local help collections, secure resources and activate + features. + + If the central admin site is to be running on the local server, the + RunCentralAdmin property should be set to true. In the event that the central + admin site has not been provisioned, this resource will first create it, + otherwise it will simply start the central admin service instance on the + local server. + + The passphrase is passed as a Credential object.The username of this + credential is ignored, only the value of the password is used as the farm + passphrase. + + 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 SPDistributedCacheService on at least one server in the farm to + designate it as a cache server. + + CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not + specified, it defaults to NTLM. If using Kerberos, make sure to have + appropriate SPNs setup for Farm account and Central Administration URI. + +.PARAMETER Ensure + Key - string + Allowed values: Present, Absent + Present to create/join the farm. Absent is currently not supported + +.PARAMETER FarmConfigDatabaseName + Required - String + Name of the configuration database + +.PARAMETER DatabaseServer + Required - String + Server that will host the configuration and admin content databases + +.PARAMETER FarmAccount + Required - String + The account to use as the main farm account + +.PARAMETER Passphrase + Required - String + The passphrase to use to allow servers to join this farm + +.PARAMETER AdminContentDatabaseName + Required - String + The name of the admin content database + +.PARAMETER RunCentralAdmin + Required - Boolean + Should the central admin site run on this specific server? + +.PARAMETER CentralAdministrationPort + Write - uint32 + What port will Central Admin be provisioned to - default is 9999 + +.PARAMETER CentralAdministrationAuth + Write - String + Allowed values: NTLM, Kerberos + The authentication provider of the CentralAdministration web application + +.PARAMETER ServerRole + Write - string + Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache + SharePoint 2016 only - the MinRole role to enroll this server as + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarm SharePointFarm + { + Ensure = "Present" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + RunCentralAdmin = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. Here the port for the central admin site to + run on, as well as the authentication mode for the site are also specified. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarm SharePointFarm + { + Ensure = "Present" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + CentralAdministrationPort = 5000 + CentralAdministrationAuth = "Kerberos" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + RunCentralAdmin = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how a basic SharePoint farm can be created. The database server and names + are specified, and the accounts to run the setup as, the farm account and the passphrase are + all passed in to the configuration to be applied. By default the central admin site in this + example is provisioned to port 9999 using NTLM authentication. In this example we also see + the server role defined as "Application" which tells SharePoint 2016 the role to apply to + this server as soon as the farm is created. This property is not supported for SharePoint 2013 + and so this specific example would fail if used against that verison. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarm SharePointFarm + { + Ensure = "Present" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + AdminContentDatabaseName = "SP_AdminContent" + ServerRole = "Application" + Passphrase = $Passphrase + FarmAccount = $FarmAccount + RunCentralAdmin = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt new file mode 100644 index 000000000..96503b5a9 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt @@ -0,0 +1,89 @@ +.NAME + SPFarmAdministrators + +# 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. + +.PARAMETER Name + Key - String + A generic name for this resource, its value is not important + +.PARAMETER Members + Write - String + A list of members to set the group to. Those not in this list will be removed + +.PARAMETER MembersToInclude + Write - String + A list of members to add. Members not in this list will be left in the group + +.PARAMETER MembersToExclude + Write - String + A list of members to remove. Members not in this list will be left in the group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to set a specific list of members for the farm admins group. + Any members not in this list will be removed. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarmAdministrators LocalFarmAdmins + { + Name = "Farm Administrators" + Members = @("CONTOSO\user1", "CONTOSO\user2") + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how certain changes are made to the farm admins groups. Here any + members in the MembersToInclude property are added, and members in the MembersToExclude + property are removed. Any members that exist in the farm admins group that aren't listed + in either of these properties are left alone. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarmAdministrators LocalFarmAdmins + { + Name = "Farm Administrators" + MembersToInclude = @("CONTOSO\user1") + MembersToExclude = @("CONTOSO\user2") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt new file mode 100644 index 000000000..0644d0bb4 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt @@ -0,0 +1,84 @@ +.NAME + SPFarmPropertyBag + +# Description + + This resource is used to work with SharePoint Property Bags at the farm level. + The account that runs this resource must be a farm administrator. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the property bag is configured. + +.PARAMETER Key + Key - string + The key of the SPFarm property bag + +.PARAMETER Value + Write - String + Value of the SPfarm property bag + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Set to present to ensure the SPfarm property exists, or absent to ensure it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how add property bag in the current farm. + + +Configuration Example +{ + param + ( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPFarmPropertyBag APPLICATION_APPCodeProperty + { + PsDscRunAsCredential = $SetupAccount + Key = "FARM_TYPE" + Value = "SearchFarm" + Ensure = "Present" + } + } +} + + +.EXAMPLE + This example shows how remove property bag in the current farm. + + +Configuration Example +{ + param + ( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPFarmPropertyBag APPLICATION_APPCodeProperty + { + PsDscRunAsCredential = $SetupAccount + Key = "KeyToRemove" + Ensure = "Absent" + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt new file mode 100644 index 000000000..89c6517d3 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt @@ -0,0 +1,77 @@ +.NAME + SPFarmSolution + +# Description + + This resource is used to make sure that a specific farm solution is either + present or absent in a farm. The solution can be deployed to one or more web + application passing an array of URL's to the WebApplications property. If the + solution contains resources scoped for web applications and no WebApplications + are specified, the solution will be deployed to all web applications. If the + solution does not contain resources scoped for web applications the property + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the solution is deployed. + +.PARAMETER Name + Key - string + The filename of the WSP package + +.PARAMETER LiteralPath + Required - string + The full path to the WSP file + +.PARAMETER WebApplications + Write - string + A list of the web applications to deploy this to + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the WSP should be deployed, or Absent if it should be removed + +.PARAMETER Version + Write - string + The version of the package that is being modified + +.PARAMETER Deployed + Write - Boolean + Should the solution be deployed to the farm, or just installed to the farm + +.PARAMETER SolutionLevel + Write - string + Allowed values: 14, 15, All + What compatability level should the WSP be deployed as? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy a WSP to specific web applications. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFarmSolution SampleWsp + { + Name = "MySolution.wsp" + LiteralPath = "C:\src\MySolution.wsp" + Ensure = "Present" + Version = "1.0.0" + WebApplications = @("http://collaboration", "http://mysites") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPFeature.help.txt b/Modules/SharePointDsc/en-US/about_SPFeature.help.txt new file mode 100644 index 000000000..11006c2ee --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPFeature.help.txt @@ -0,0 +1,93 @@ +.NAME + SPFeature + +# 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 + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the feature is enabled. + +.PARAMETER Name + Key - string + The name of the feature + +.PARAMETER FeatureScope + Required - string + Allowed values: Farm, WebApplication, Site, Web + The scope to change the feature at - Farm, WebApplication, SiteCollection or Site + +.PARAMETER Url + Key - string + The URL to change the feature at + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the feature is to be enabled, Absent if it is to be disabled + +.PARAMETER Version + Write - string + The version of the feature to check against + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to enable a site collection scoped feature + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFeature EnableViewFormsLockDown + { + Name = "ViewFormPagesLockDown" + Url = "http://www.contoso.com" + FeatureScope = "Site" + PsDscRunAsCredential = $SetupAccount + Version = "1.0.0.0" + } + } + } + + +.EXAMPLE + This example shows how to disable a site collection scoped feature + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPFeature EnableViewFormsLockDown + { + Name = "ViewFormPagesLockDown" + Url = "http://www.contoso.com" + FeatureScope = "Site" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + Version = "1.0.0.0" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt new file mode 100644 index 000000000..cf4d28a54 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt @@ -0,0 +1,62 @@ +.NAME + SPHealthAnalyzerRuleState + +# Description + + This resource is used to configure Health Analyzer rules for the local farm. + The resource is able to enable/disable and configure the specified rule. + +.PARAMETER Name + Key - String + The name of the rule exactly as it appears in central admin + +.PARAMETER Enabled + Required - Boolean + Should the rule be enabled? + +.PARAMETER RuleScope + Write - String + Allowed values: All Servers, Any Server + What is the scope of this rule + +.PARAMETER Schedule + Write - String + Allowed values: Hourly, Daily, Weekly, Monthly, OnDemandOnly + How often should the rule check + +.PARAMETER FixAutomatically + Write - Boolean + Should the rule fix itself automatically + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to disable a health analyzer rule + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPHealthAnalyzerRuleState DisableDiskSpaceRule + { + Name = "Drives are at risk of running out of free space." + Enabled = $false + RuleScope = "All Servers" + Schedule = "Daily" + FixAutomatically = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt new file mode 100644 index 000000000..937fce5d5 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt @@ -0,0 +1,127 @@ +.NAME + SPInstall + +# Description + + This resource is used to install the SharePoint binaries. The BinaryDir + parameter should point to the path that setup.exe is located (not to setup.exe + itself). The ProductKey parameter is used to inject in to the configuration + file and validate the license key during the installation process. This module + depends on the prerequisites already being installed, which can be done + + NOTE: This resource only supports SharePoint Server. SharePoint Foundation + is not supported. For examples to install SharePoint Foundation using DSC, see: + https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3) + + ## Installing from network locations + + If you wish to install SharePoint 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. + +.PARAMETER BinaryDir + Key - String + The directory that contains all of the SharePoint binaries + +.PARAMETER ProductKey + Required - String + The product key to use during the installation + +.PARAMETER InstallPath + Write - String + The install directory to use in the installation, leave blank to use the setup defaults + +.PARAMETER DataPath + Write - String + The data directory to use in the installation, leave blank to use the setup defaults + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + + +.EXAMPLE + This module will install SharePoint to the default locations. The binaries for + SharePoint in this scenario are stored at C:\SPInstall (so it will look to run + C:\SPInstall\Setup.exe) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstall InstallBinaries + { + BinaryDir = "C:\SPInstall" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + } + } + } + + +.EXAMPLE + This module will install SharePoint to the specific locations set for the + InstallPath and DataPath directories. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstall InstallBinaries + { + BinaryDir = "D:\SharePoint\Binaries" + InstallPath = "D:\SharePoint\Install" + DataPath = "D:\SharePoint\Data" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + } + } + } + + +.EXAMPLE + This module will install SharePoint Foundation 2013 to the local server + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName PSDesiredStateConfiguration + + node localhost { + Package InstallSharePointFoundation + { + Ensure = "Present" + Name = "Microsoft SharePoint Foundation 2013 Core" + Path = "E:\SharePoint2013\Setup.exe" + Arguments = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml" + ProductID = "90150000-1014-0000-1000-0000000FF1CE" + ReturnCode = 0 + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt new file mode 100644 index 000000000..359d97f42 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt @@ -0,0 +1,91 @@ +.NAME + SPInstallLanguagePack + +# Description + + This resource is used to install the SharePoint Language Pack binaries. The + BinaryDir parameter should point to the path that setup.exe is located (not to + setup.exe itself). + + The BinaryInstallDays and BinaryInstallTime parameters specify a window in which + the update can be installed. + + With SharePoint 2016, the Language Packs are offered as an EXE package. You have + to extract this package before installing, using the following command: + .\serverlanguagepack.exe /extract:[Extract Folder] + +.PARAMETER BinaryDir + Key - String + The directory that contains all of the SharePoint binaries + +.PARAMETER BinaryInstallDays + Write - String + Allowed values: mon, tue, wed, thu, fri, sat, sun + Specify on which dates the installation is allowed + +.PARAMETER BinaryInstallTime + Write - String + Specify in which time frame the installation is allowed + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This module will install the SharePoint Language Pack. The binaries for + SharePoint in this scenario are stored at C:\SPInstall (so it will look to run + C:\SPInstall\Setup.exe) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstallLanguagePack InstallLPBinaries + { + BinaryDir = "C:\SPInstall" + Ensure = "Present" + } + } + } + + +.EXAMPLE + This module will install the SharePoint Language Pack in the specified timeframe. + The binaries for SharePoint in this scenario are stored at C:\SPInstall (so it + will look to run C:\SPInstall\Setup.exe) + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInstallLanguagePack InstallLPBinaries + { + BinaryDir = "C:\SPInstall" + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt new file mode 100644 index 000000000..de5bdc813 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt @@ -0,0 +1,181 @@ +.NAME + SPInstallPrereqs + +# Description + + 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. + +.PARAMETER InstallerPath + Key - String + The full path to prerequisiteinstaller.exe + +.PARAMETER OnlineMode + Required - Boolean + Should the installer download prerequisites from the internet or not + +.PARAMETER SXSpath + Write - String + The path to the Windows Server Operating System SXS source files, for use in closed environments without access to Windows Update + +.PARAMETER SQLNCli + Write - String + The path to the installer for this prerequisite + +.PARAMETER PowerShell + Write - String + The path to the installer for this prerequisite + +.PARAMETER NETFX + Write - String + The path to the installer for this prerequisite + +.PARAMETER IDFX + Write - String + The path to the installer for this prerequisite + +.PARAMETER Sync + Write - String + The path to the installer for this prerequisite + +.PARAMETER AppFabric + Write - String + The path to the installer for this prerequisite + +.PARAMETER IDFX11 + Write - String + The path to the installer for this prerequisite + +.PARAMETER MSIPCClient + Write - String + The path to the installer for this prerequisite + +.PARAMETER WCFDataServices + Write - String + The path to the installer for this prerequisite + +.PARAMETER KB2671763 + Write - String + The path to the installer for this prerequisite + +.PARAMETER WCFDataServices56 + Write - String + The path to the installer for this prerequisite + +.PARAMETER MSVCRT11 + Write - String + The path to the installer for this prerequisite + +.PARAMETER MSVCRT14 + Write - String + The path to the installer for this prerequisite + +.PARAMETER KB3092423 + Write - String + The path to the installer for this prerequisite + +.PARAMETER ODBC + Write - String + The path to the installer for this prerequisite + +.PARAMETER DotNetFx + Write - String + The path to the installer for this prerequisite + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install the prerequisites. Absent is currently not supported + + +.EXAMPLE + 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 InstallPrerequisites + { + InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" + OnlineMode = $true + } + } + } + + +.EXAMPLE + 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 InstallPrerequisites + { + 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" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt new file mode 100644 index 000000000..bb52a8c22 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt @@ -0,0 +1,54 @@ +.NAME + SPIrmSettings + +# Description + + This resource is used to manipulate the IRM settings in SharePoint, integrating + it with AD RMS + + The default value for the Ensure parameter is Present. When not specifying this + parameter, IRM is configured. + +.PARAMETER Ensure + Key - String + Allowed values: Present, Absent + Enable or Disable IRM on this farm + +.PARAMETER UseADRMS + Write - Boolean + Use the RMS server published in this farm's Active Directory + +.PARAMETER RMSserver + Write - String + Use the specified RMS server, must provide in URL format + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply the RMS settings to a local farm, pointing to + a specific RMS server + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPIrmSettings RMSSettings + { + Ensure = "Present" + RMSserver = "https://rms.contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt new file mode 100644 index 000000000..2cb9a9b88 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt @@ -0,0 +1,98 @@ +.NAME + SPJoinFarm + +# Description + + WARNING: This resource is deprecated. Please use SPFarm instead as + this resource will be removed from version 2.0 of SharePointDsc + + This resource will be responsible for joining a server to an existing + SharePoint farm. To create a new farm use the SPCreateFarm resource on a + different server to begin with, and then pass the same database server and + configuration database name parameters to the additional servers using this + resource. After the server has joined the farm, the process will wait for 5 + minutes to allow farm specific configuration to take place on the server, + before allowing further DSC configuration to take place. + +.PARAMETER FarmConfigDatabaseName + Key - string + The name of the config database to connect to + +.PARAMETER DatabaseServer + Key - string + The server that hosts the config database + +.PARAMETER Passphrase + Required - string + The passphrase that should be used to join the farm + +.PARAMETER ServerRole + Write - string + Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache + SharePoint 2016 only - the MinRole role to enroll this server as + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to join an existing SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPJoinFarm JoinFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + Passphrase = $Passphrase + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to join an existing SharePoint farm using a specific + server role (applies to SharePoint 2016 only). + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $Passphrase + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPJoinFarm JoinFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + ServerRole = "WebFrontEnd" + Passphrase = $Passphrase + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt new file mode 100644 index 000000000..2db706949 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt @@ -0,0 +1,105 @@ +.NAME + SPManagedAccount + +# Description + + This resource will ensure a managed account is provisioned in to the SharePoint + farm. The Account object specific the credential to store (including username + and password) to set as the managed account. The settings for + EmailNotification, PreExpireDays and Schedule all relate to enabling automatic + password change for the managed account, leaving these option out of the + resource will ensure that no automatic password changing from SharePoint occurs. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the managed account is created. + +.PARAMETER AccountName + Key - string + The username of the account + +.PARAMETER Account + Write - String + The credential with password of the account + +.PARAMETER EmailNotification + Write - Uint32 + How many days before a password change should an email be sent + +.PARAMETER PreExpireDays + Write - Uint32 + How many days before a password expires should it be changed + +.PARAMETER Schedule + Write - string + What is the schedule for the password reset + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures managed account exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new managed account in a local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $ManagedAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedAccount NewManagedAccount + { + AccountName = $ManagedAccount.UserName + Account = $ManagedAccount + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to create a new managed account in a local farm, using + the automatic password change schedule + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $ManagedAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedAccount NewManagedAccount + { + AccountName = $ManagedAccount.UserName + Account = $ManagedAccount + Ensure = "Present" + Schedule = "monthly between 7 02:00:00 and 7 03:00:00" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt new file mode 100644 index 000000000..de3fc3233 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt @@ -0,0 +1,138 @@ +.NAME + SPManagedMetaDataServiceApp + +# Description + + Creates a managed metadata service application. The application pool property + specifies which application pool it should use, and will reset the application + back to this pool if it is changed after its initial provisioning. The + database server and database name properties are only used during + provisioning, and will not be altered as part of the ongoing operation of the + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the managed metadata service application + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER ApplicationPool + Required - string + The application pool that the service app will use + +.PARAMETER DatabaseServer + Write - string + The name of the database server which will host the application + +.PARAMETER DatabaseName + Write - string + The name of the database for the service application + +.PARAMETER TermStoreAdministrators + Write - string + A list of the users/groups who are administrators of the term store + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER ContentTypeHubUrl + Write - string + The URL of the content type hub for this app (only set when the app is provisioned) + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $SetupAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "SP_ManagedMetadata" + } + } + } + + +.EXAMPLE + + This example shows how to remove a specific managed metadata service app from the + local SharePoint farm. Because Application pool parameter is required + but is not acutally needed to remove the app, any text value can + be supplied for these as it will be ignored. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $SetupAccount + ApplicationPool = "none" + Ensure = "Absent" + } + } + } + + +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm + and also include a specific list of users to be the term store administrators. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $SetupAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "SP_ManagedMetadata" + TermStoreAdministrators = @( + "CONTOSO\user1", + "CONTOSO\user2" + ) + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt new file mode 100644 index 000000000..387889cd9 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt @@ -0,0 +1,121 @@ +.NAME + SPManagedPath + +# Description + + This resource is responsible for creating managed paths associated with a + specific web application. The WebAppUrl parameter is used to specify the web + application to create the path against, and the RelativeUrl parameter lets you + set the URL. Explicit when set to true will create an explicit inclusion path, + if set to false the path is created as wildcard inclusion. If you are using + host named site collections set HostHeader to true and the path will be + created as a host header path to be applied for host named site collections. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the managed path is created. + +.PARAMETER WebAppUrl + Key - string + The URL of the web application to apply the managed path to - this is ignored for host header web applications + +.PARAMETER RelativeUrl + Key - string + The relative URL of the managed path + +.PARAMETER Explicit + Required - boolean + Should the host header be explicit? If false then it is a wildcard + +.PARAMETER HostHeader + Required - boolean + Is this a host header web application? + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures managed path exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy an explicit managed path to a specifici web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedPath TestManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $SetupAccount + RelativeUrl = "example" + Explicit = $true + HostHeader = $false + } + } + } + + +.EXAMPLE + This example shows how to add a wildcard managed path to a specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedPath TestManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $SetupAccount + RelativeUrl = "teams" + Explicit = $false + HostHeader = $true + } + } + } + + +.EXAMPLE + This example shows how to remove a wildcard managed path from a specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedPath TestManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $SetupAccount + RelativeUrl = "teams" + Explicit = $false + HostHeader = $true + Ensure = "Absent" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt new file mode 100644 index 000000000..ef9deab6c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt @@ -0,0 +1,87 @@ +.NAME + SPOfficeOnlineServerBinding + +# Description + + This resource will create a binding to an Office Online Server (formerly known + as Office Web Apps). The DnsName property can be a single server name, or a + FQDN of a load balanced end point that will direct traffic to a farm. + + NOTE: This resource is designed to be used where all WOPI bindings will be + targeted to the same Office Online Server farm. If used on a clean + environment, the new bindings will all point to the one DNS Name. If used on + an existing configuration that does not follow this rule, it will match only + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the zone is configured. + +.PARAMETER Zone + Key - string + Allowed values: Internal-HTTP, Internal-HTTPS, External-HTTP, External-HTTPS + The zone for this binding + +.PARAMETER DnsName + Required - string + The DNS name of the server/s that are running Office Web Apps + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures the binding for this zone exists, absent ensures it doesn't + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create bindings to the internal-https zone for the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOfficeOnlineServerBinding OosBinding + { + Zone = "internal-https" + DnsName = "webapps.contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove bindings from the internal-http zone for the + local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOfficeOnlineServerBinding OosBinding + { + Zone = "Internal-HTTP" + DnsName = "webapps.contoso.com" + PsDscRunAsCredential = $SetupAccount + Ensure = "Absent" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt new file mode 100644 index 000000000..b09350b20 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt @@ -0,0 +1,100 @@ +.NAME + SPOutgoingEmailSettings + +# Description + + This resource is used to set the outgoing email settings for either a single + web application, or the whole farm. To configure the resource for a specific + web app, use the URL of the web application for the WebAppUrl property, to + change the settings for the whole farm use the URL of the central admin + website instead. It is possible to set the outgoing server, from address, + reply to address and the character set to be used for emails. + +.PARAMETER WebAppUrl + key - string + The URL of the web application. If you want to set the global settings use the Central Admin URL + +.PARAMETER SMTPServer + Required - string + The SMTP server for outgoing mail + +.PARAMETER FromAddress + Required - string + The from address to put on messages + +.PARAMETER ReplyToAddress + Required - string + The email address that replies should be directed to + +.PARAMETER CharacterSet + Required - string + The character set to use on messages + +.PARAMETER UseTLS + Write - boolean + Use TLS when connecting to the SMTP server (SharePoint 2016 only) + +.PARAMETER SMTPPort + Write - uint32 + The port which is used to connect to the SMTP server (SharePoint 2016 only) + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows to set outgoing email settings for the entire farm. Use the URL + of the central admin site for the web app URL to apply for the entire farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOutgoingEmailSettings FarmWideEmailSettings + { + WebAppUrl = "http://sharepoint1:2013" + SMTPServer = "smtp.contoso.com" + FromAddress = "sharepoint`@contoso.com" + ReplyToAddress = "noreply`@contoso.com" + CharacterSet = "65001" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows to set outgoing email settings for a specific web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPOutgoingEmailSettings FarmWideEmailSettings + { + WebAppUrl = "http://site.contoso.com" + SMTPServer = "smtp.contoso.com" + FromAddress = "sharepoint`@contoso.com" + ReplyToAddress = "noreply`@contoso.com" + CharacterSet = "65001" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt new file mode 100644 index 000000000..5a4e04213 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt @@ -0,0 +1,58 @@ +.NAME + SPPasswordChangeSettings + +# Description + + This resource is used to control settings that relate to the automatic + changing of passwords for managed accounts (where they opt-in to be managed by + SharePoint). These settings can be manually controlled through central + administration, or configured in this resource. The settings relate to email + notifications of when passwords are reset, as well as behavior when a reset + +.PARAMETER MailAddress + key - string + The email address to send notifications of password changes to + +.PARAMETER DaysBeforeExpiry + Write - Uint32 + The number of days before password expiry to send send emails + +.PARAMETER PasswordChangeWaitTimeSeconds + Write - Uint32 + The duration that a password reset will wait for before it times out + +.PARAMETER NumberOfRetries + Write - Uint32 + How many retries if the password change fails + +.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 password change settings for managed accounts in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPasswordChangeSettings ManagedAccountPasswordResetSettings + { + MailAddress = "sharepoint`@contoso.com" + DaysBeforeExpiry = "14" + PasswordChangeWaitTimeSeconds = "60" + NumberOfRetries = "3" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt new file mode 100644 index 000000000..f3eb083f8 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt @@ -0,0 +1,93 @@ +.NAME + SPPerformancePointServiceApp + +# Description + + This resource is responsible for creating Performance Point Service Application + instances within the local SharePoint farm. The resource will provision and + configure the Performance Point Service Application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.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 performance point service app in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPerformancePointServiceApp PerformancePoint + { + Name = "Performance Point Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes the specific performance point service app from the local + farm. The ApplicationPool parameter is still mandatory but it is not used, so + the value can be anything. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPerformancePointServiceApp PerformancePoint + { + Name = "Performance Point Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt new file mode 100644 index 000000000..907f29fdc --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt @@ -0,0 +1,145 @@ +.NAME + SPProductUpdate + +# Description + + This resource is used to perform the update step of installing SharePoint + updates, like Cumulative Updates and Service Packs. The SetupFile parameter + should point to the update file. The ShutdownServices parameter is used to + indicate if some services (Timer, Search and IIS services) have to be stopped + before installation of the update. This will speed up the installation. The + BinaryInstallDays and BinaryInstallTime parameters specify a window in which + the update can be installed. This module requires the Configuration Wizard + resource to fully complete the installation of the update, which can be done + through the use of SPConfigWizard. + + NOTE: + When files are downloaded from the Internet, a Zone.Identifier alternate data + stream is added to indicate that the file is potentially from an unsafe source. + To use these files, make sure you first unblock them using Unblock-File. + SPProductUpdate will throw an error when it detects the file is blocked. + + IMPORTANT: + This resource retrieves build information from the Configuration Database. + Therefore it requires SharePoint to be installed and a farm created. If you + like to deploy a new farm and install updates automatically, you need to + implement the following order: + + 1. Install the SharePoint Binaries (SPInstall) + 2. (Optional) Install SharePoint Language Pack(s) Binaries + (SPInstallLanguagePack) + 3. Create SPFarm (SPFarm) + 4. Install Cumulative Updates (SPProductUpdate) + 5. Run the Configuration Wizard (SPConfigWizard) + +.PARAMETER SetupFile + Key - String + The name of the update setup file + +.PARAMETER ShutdownServices + Write - Boolean + Shutdown SharePoint services to speed up installation + +.PARAMETER BinaryInstallDays + Write - String + Allowed values: mon, tue, wed, thu, fri, sat, sun + Specify on which dates the installation is allowed + +.PARAMETER BinaryInstallTime + Write - String + Specify in which time frame the installation is allowed + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to install SharePoint. Absent is currently not supported + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example installs the Cumulative Update only in the specified window. + It also shuts down services to speed up the installation process. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProductUpdate InstallCUMay2016 + { + SetupFile = "C:\Install\CUMay2016\ubersrv2013-kb3115029-fullfile-x64-glb.exe" + ShutdownServices = $true + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example installs the SharePoint 2013 Service Pack only in the specified window. + It also shuts down services to speed up the installation process. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProductUpdate InstallCUMay2016 + { + SetupFile = "C:\Install\SP2013SP1\officeserversp2013-kb2880552-fullfile-x64-en-us.exe" + ShutdownServices = $true + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example installs the SharePoint 2013 Dutch Language Pack Service Pack only in the specified window. + It also shuts down services to speed up the installation process. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProductUpdate InstallCUMay2016 + { + SetupFile = "C:\Install\SP2013-LP_NL-SP1\serverlpksp2013-kb2880554-fullfile-x64-nl-nl.exe" + ShutdownServices = $true + BinaryInstallDays = "sat", "sun" + BinaryInstallTime = "12:00am to 2:00am" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt new file mode 100644 index 000000000..8ec9b8521 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt @@ -0,0 +1,87 @@ +.NAME + SPPublishServiceApplication + +# Description + + This resource is used to specify if a specific service application should be + published (Ensure = "Present") or not published (Ensure = "Absent") on the + current server. The name is the display name of the service application as + shown in the Central Admin website. + + You can publish the following service applications in a SharePoint Server + 2013/2016 farm: + + * Business Data Connectivity + * Machine Translation + * Managed Metadata + * User Profile + * Search + * Secure Store + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the service application to publish + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure it runs on this server, or absent to ensure it is stopped + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure that the managed metadata service is published + within the farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPublishServiceApplication PublishManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + Ensure = "Present" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure that the Secure Store Service is not + published within the farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPublishServiceApplication UnpublishSecureStoreServiceApp + { + Name = "Secure Store Service Application" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt new file mode 100644 index 000000000..e5c9a3473 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt @@ -0,0 +1,69 @@ +.NAME + SPQuotaTemplate + +# Description + + This resource is used to configure quota templates in the farm. These settings + will be used to make sure a certain quota template exists or not. When it + exists, it will also make sure the settings are configured as specified. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the quota template is created. + +.PARAMETER Name + Key - string + The name of the quota template + +.PARAMETER StorageMaxInMB + Write - uint32 + The maximum storage for sites of this template in MB + +.PARAMETER StorageWarningInMB + Write - uint32 + The amount of storage for sites of this template that triggers a warning + +.PARAMETER MaximumUsagePointsSolutions + Write - uint32 + The maximum number of performance points for sandbox solutions for this template + +.PARAMETER WarningUsagePointsSolutions + Write - uint32 + The warning number of performance points for sandbox solutions for this template + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to create this template, absent to ensure it does not exist + +.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 specific quota template in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPQuotaTemplate TeamsiteTemplate + { + Name = "Teamsite" + StorageMaxInMB = 1024 + StorageWarningInMB = 512 + MaximumUsagePointsSolutions = 1000 + WarningUsagePointsSolutions = 800 + Ensure = "Present" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt new file mode 100644 index 000000000..18b12dcf4 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt @@ -0,0 +1,59 @@ +.NAME + SPRemoteFarmTrust + +# Description + + This resource is used to trust a remote SharePoint farm. This is used when + federating search results between two different SharePoint farms. The + technique is described at + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the remote farm trust is created. + +.PARAMETER Name + Key - string + A name of the remote farm, used to create token issuer and root authority + +.PARAMETER RemoteWebAppUrl + Required - string + The URL of a web app in the remote farm, must use HTTPS + +.PARAMETER LocalWebAppUrl + Required - string + The URL of a local web app to connect the remote farm to + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Set to present to ensure the trust exists, or absent to ensure it is removed + +.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 remote farm trust so that the local web app trusts calls + that will come from the remote web app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPRemoteFarmTrust TrustRemoteFarmForSearch + { + Name = "CentralSearchFarm" + RemoteWebAppUrl = "https://search.sharepoint.contoso.com" + LocalWebAppUrl = "https://local.sharepoint2.contoso.com" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt new file mode 100644 index 000000000..da63318da --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt @@ -0,0 +1,154 @@ +.NAME + SPSearchContentSource + +# Description + + This resource will deploy and configure a content source in a specified search + service application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the content source is created. + +.PARAMETER Name + Key - String + The name of the content source + +.PARAMETER ServiceAppName + Key - String + The name of the search service app that this content source exists within + +.PARAMETER ContentSourceType + Required - String + Allowed values: SharePoint, Website, FileShare + The type of content source - currently only SharePoint, Website and File Shares are supported + +.PARAMETER Addresses + Required - String + A list of the addresses this content source includes + +.PARAMETER CrawlSetting + Required - String + Allowed values: CrawlEverything, CrawlFirstOnly, Custom + Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only) + +.PARAMETER ContinuousCrawl + Write - Boolean + Should this content source use continuous crawl (SharePoint sites only) + +.PARAMETER IncrementalSchedule + Write - String + What is the incremental schedule for this content source + +.PARAMETER FullSchedule + Write - String + What is the full schedule for this content source + +.PARAMETER Priority + Write - String + Allowed values: Normal, High + What is the priority on this content source + +.PARAMETER LimitPageDepth + Write - Uint32 + How many pages deep should the crawler go (-1 = unlimited, website sources only) + +.PARAMETER LimitServerHops + Write - Uint32 + How many server hops should the crawler make (-1 = unlimtied, website sources only) + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the source should exist, absent if it should not + +.PARAMETER Force + Write - Boolean + Specify true if DSC is allowed to delete and recreate a content source to apply the correct settings, otherwise false will just report errors if a change can not be applied. + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a SharePoint sites content source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchContentSource LocalSharePointSites + { + Name = "Local SharePoint Sites" + ServiceAppName = "Search Service Application" + ContentSourceType = "SharePoint" + Addresses = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com") + CrawlSetting = "CrawlEverything" + ContinuousCrawl = $true + IncrementalSchedule = MSFT_SPSearchCrawlSchedule { + ScheduleType = "Daily" + StartHour = "0" + StartMinute = "0" + CrawlScheduleRepeatDuration = "1440" + CrawlScheduleRepeatInterval = "5" + } + FullSchedule = $null + Priority = "Normal" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to create a website content source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchContentSource WebsiteSource + { + Name = "Contoso website" + ServiceAppName = "Search Service Application" + ContentSourceType = "Website" + Addresses = @("http://www.contoso.com") + CrawlSetting = "Custom" + LimitPageDepth = 5 + LimitServerHops = 0 + IncrementalSchedule = MSFT_SPSearchCrawlSchedule{ + ScheduleType = "Daily" + StartHour = "0" + StartMinute = "0" + CrawlScheduleRepeatDuration = "1440" + CrawlScheduleRepeatInterval = "5" + } + FullSchedule = MSFT_SPSearchCrawlSchedule{ + ScheduleType = "Weekly" + CrawlScheduleDaysOfWeek = @("Monday", "Wednesday", "Friday") + StartHour = "3" + StartMinute = "0" + } + Priority = "Normal" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt new file mode 100644 index 000000000..b8ad9d357 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt @@ -0,0 +1,110 @@ +.NAME + SPSearchCrawlRule + +# Description + + This resource is responsible for managing the search crawl rules in the search + service application. You can create new rules, change existing rules and remove + existing rules. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the crawl rule is created. + +.PARAMETER Path + Key - string + The name of the search service application + +.PARAMETER ServiceAppName + Required - string + The name of the search service application + +.PARAMETER AuthenticationType + Write - string + Allowed values: DefaultRuleAccess, BasicAccountRuleAccess, CertificateRuleAccess, NTLMAccountRuleAccess, FormRuleAccess, CookieRuleAccess, AnonymousAccess + Authentication type used by the crawl rule + +.PARAMETER RuleType + Write - string + Allowed values: InclusionRule, ExclusionRule + The type of the rule + +.PARAMETER CrawlConfigurationRules + Write - string + Allowed values: FollowLinksNoPageCrawl, CrawlComplexUrls, CrawlAsHTTP + The configuration options for this rule + +.PARAMETER AuthenticationCredentials + Write - String + The credentials used for this crawl rule (used for types BasicAccountRuleAccess and NTLMAccountRuleAccess) + +.PARAMETER CertificateName + Write - string + The certificate used for this crawl rule (used for type CertificateRuleAccess) + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the crawl rule 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 + + +.EXAMPLE + This example shows how to apply settings to a sepcific URL in search + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchCrawlRule IntranetCrawlAccount + { + Path = "https://intranet.sharepoint.contoso.com" + ServiceAppName = "Search Service Application" + Ensure = "Present" + RuleType = "InclusionRule" + CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" + AuthenticationType = "DefaultRuleAccess" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to set a certificate for authentication to a content source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchCrawlRule IntranetCrawlAccountCertificate + { + Path = "https://intranet.sharepoint.contoso.com" + ServiceAppName = "Search Service Application" + Ensure = "Present" + RuleType = "InclusionRule" + CrawlConfigurationRules = "FollowLinksNoPageCrawl","CrawlComplexUrls", "CrawlAsHTTP" + AuthenticationType = "CertificateRuleAccess" + CertificateName = "Certificate Name" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt new file mode 100644 index 000000000..e90e7fa9b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt @@ -0,0 +1,97 @@ +.NAME + SPSearchFileType + +# Description + + This resource is responsible for managing the search file types in the search + service application. You can create new file types, change existing types and + remove existing file types. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the file type is added. + +.PARAMETER FileType + Key - string + The name of the file type + +.PARAMETER ServiceAppName + Key - string + The name of the search service application + +.PARAMETER Description + Write - string + The description of the file type + +.PARAMETER MimeType + Write - string + The mime type of the file type + +.PARAMETER Enabled + Write - boolean + The state of the file type + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the file type 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 + + +.EXAMPLE + This example shows how to apply settings to a specific file type in search, using the required parameters + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchFileType PDF + { + FileType = "pdf" + ServiceAppName = "Search Service Application" + Description = "PDF" + MimeType = "application/pdf" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to disable a specific file type in search + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchFileType PDF + { + FileType = "pdf" + ServiceAppName = "Search Service Application" + Description = "PDF" + MimeType = "application/pdf" + Enabled = $false + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt new file mode 100644 index 000000000..e6b3f15e0 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt @@ -0,0 +1,68 @@ +.NAME + SPSearchIndexPartition + +# Description + + This resource is responsible for creating search indexes. It works by creating + the index topology components and updating the topology from the server that + runs this resource. For this reason this resource only needs to run from one + server and not from each server which will host the index component. The + search service application and existing search topology must be deployed + before creating additional indexes. The first index will be created through + the use of the SPSearchRoles resource. Additional search index partitions can + be created through using this resource. + + Note that for the search topology to apply correctly, the path specified for + RootDirectory needs to exist on the server that is executing this resource. For + example, if the below example was executed on "Server1" it would also need to + ensure that it was able to create the index path at I:\. If no disk labeled I: + was available on server1, this would fail, even though it will not hold an + actual index component. + +.PARAMETER Index + Key - Uint32 + The number of the partition in this farm + +.PARAMETER Servers + Required - String + A list of the servers that this partition should exist on + +.PARAMETER RootDirectory + Write - String + The directory that the index should use locally on each server to store data + +.PARAMETER ServiceAppName + Key - String + The name of the search service application + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds an extra search partition to the local farms topology + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchIndexPartition AdditionalPartition + { + Servers = @("Server2", "Server3") + Index = 1 + RootDirectory = "I:\SearchIndexes\1" + ServiceAppName = "Search Service Application" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt new file mode 100644 index 000000000..87ce4c00a --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt @@ -0,0 +1,76 @@ +.NAME + SPSearchResultSource + +# Description + + This resource is used to configure search result sources in the SharePoint + search service application. Result sources can be configured to be of the + following provider types: + + * Exchange Search Provider + * Local People Provider + * Local SharePoint Provider + * OpenSearch Provider + * Remote People Provider + * Remote SharePoint Provider + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the result source is created. + +.PARAMETER Name + Key - String + The name of the result source + +.PARAMETER SearchServiceAppName + Required - String + The name of the search service application to associate this result source with + +.PARAMETER Query + Required - String + The query to pass to the provider source + +.PARAMETER ProviderType + Required - String + Allowed values: Exchange Search Provider, Local People Provider, Local SharePoint Provider, OpenSearch Provider, Remote People Provider, Remote SharePoint Provider + The provider type to use for the result source + +.PARAMETER ConnectionUrl + Write - String + The URI to connect to the remote location + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the result source 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 + + +.EXAMPLE + This example shows how to create a remote sharepoint search result source + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchResultSource RemoteSharePointFarm + { + Name = "External SharePoint results" + SearchServiceAppName = "Search Service Application" + Query = "{searchTerms}" + ProviderType = "Remote SharePoint Provider" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt new file mode 100644 index 000000000..d2e2bf507 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt @@ -0,0 +1,113 @@ +.NAME + SPSearchServiceApp + +# Description + + This resource is responsible for provisioning the search service application. + The current version lets you specify the database name and server, as well as + the application pool. If the application pool is changed the DSC resource will + set it back as per what is set in the resource. The database name parameter is + used as the prefix for all search databases (so you will end up with one for + the admin database which matches the name, and then + "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well). + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the search service application + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER ApplicationPool + Required - string + The application pool that it should run in + +.PARAMETER SearchCenterUrl + Write - string + The URL of the enterprise search center site collection + +.PARAMETER DatabaseName + Write - string + The name of the database (noting that some search databases will use this as a prefix) + +.PARAMETER DatabaseServer + Write - string + The server that host the databases for this service application + +.PARAMETER DefaultContentAccessAccount + Write - String + The default content access account for this search service app + +.PARAMETER CloudIndex + Write - boolean + Should this search service application be a cloud based service app + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app should exist, absent if it should not + +.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 + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchServiceApp SearchServiceApp + { + Name = "Search Service Application" + DatabaseName = "SP_Search" + ApplicationPool = "SharePoint Service Applications" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a search service app in the local farm. The ApplicationPool + parameter is still required but is not actually used, so its value does not matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchServiceApp SearchServiceApp + { + Name = "Search Service Application" + Ensure = "Absent" + ApplicationPool = "n/a" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt new file mode 100644 index 000000000..7b415189f --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt @@ -0,0 +1,89 @@ +.NAME + SPSearchTopology + +# Description + + This resource is responsible for provisioning a search topology in to the + current farm. It allows the configuration to dictate the search topology roles + that the current server should be running. Any combination of roles can be + specified and the topology will be upaded to reflect the current servers new + roles. If this is the first server to apply topology to a farm, then at least + one search index must be provided. To this end, the FirstPartitionIndex, + FirstPartitionDirectory and FirstPartitionServers allow configuring where the + first index partition will belong. This will behave the same as the + SPSearchIndexPartition resource. + + Note that for the search topology to apply correctly, the path specified for + FirstPartitionDirectory needs to exist on the server that is executing this + resource. For example, if the below example was executed on "Server1" it would + also need to ensure that it was able to create the index path at I:\. If no + disk labeled I: was available on server1, this would fail, even though it will + not hold an actual index component. + +.PARAMETER ServiceAppName + Key - String + The name of the search service application for this topology + +.PARAMETER Admin + Required - String + A list of servers that will run the admin component + +.PARAMETER Crawler + Required - String + A list of servers that will run the crawler component + +.PARAMETER ContentProcessing + Required - String + A list of servers that will run the content processing component + +.PARAMETER AnalyticsProcessing + Required - String + A list of servers that will run the analytics processing component + +.PARAMETER QueryProcessing + Required - String + A list of servers that will run the query processing component + +.PARAMETER IndexPartition + Required - String + A list of servers that will host the first (0) index partition + +.PARAMETER FirstPartitionDirectory + Required - String + The local directory servers will use to store the first index partition + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply a specific topology to the search service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchTopology LocalSearchTopology + { + ServiceAppName = "Search Service Application" + Admin = @("Server1","Server2") + Crawler = @("Server1","Server2") + ContentProcessing = @("Server1","Server2") + AnalyticsProcessing = @("Server1","Server2") + QueryProcessing = @("Server3","Server4") + PsDscRunAsCredential = $SetupAccount + FirstPartitionDirectory = "I:\SearchIndexes\0" + IndexPartition = @("Server3","Server4") + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt new file mode 100644 index 000000000..dcd0d8d78 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt @@ -0,0 +1,127 @@ +.NAME + SPSecureStoreServiceApp + +# Description + + This resource is responsible for provisioning and configuring the secure store + service application. The parameters passed in (except those related to database + specifics) are validated and set when the resource is run, the database values + are only used in provisioning of the service application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the secure store service app + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER ApplicationPool + Required - string + The name of the application pool it will run in + +.PARAMETER AuditingEnabled + Required - boolean + Is auditing enabled for this service app + +.PARAMETER AuditlogMaxSize + Write - uint32 + What is the maximum size of the audit log in MB + +.PARAMETER DatabaseCredentials + Write - String + What SQL credentials should be used to access the database + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the database + +.PARAMETER DatabaseAuthenticationType + Write - string + Allowed values: Windows, SQL + What type of authentication should be used to access the database + +.PARAMETER FailoverDatabaseServer + Write - string + The name of the database server hosting a failover instance of the database + +.PARAMETER PartitionMode + Write - boolean + Is partition mode enabled for this service app + +.PARAMETER Sharing + Write - boolean + Is sharing enabled for this service app + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example creates a new secure store service app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSecureStoreServiceApp SecureStoreServiceApp + { + Name = "Secure Store Service Application" + ApplicationPool = "SharePoint Service Applications" + AuditingEnabled = $true + AuditlogMaxSize = 30 + DatabaseName = "SP_SecureStore" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a secure store service app. The ApplicationPool and + AuditingEnabled parameters are required, but are not used so their values + are able to be set to anything. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSecureStoreServiceApp SecureStoreServiceApp + { + Name = "Secure Store Service Application" + ApplicationPool = "n/a" + AuditingEnabled = $false + InstallAccount = $SetupAccount + Ensure = "Absent" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt new file mode 100644 index 000000000..9f03c2ae0 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt @@ -0,0 +1,55 @@ +.NAME + SPServiceAppPool + +# Description + + This resource is used for provisioning an application pool that can be used for + service applications. The account used for the service account must already be + registered as a managed account (which can be provisioned through + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application pool is provisioned. + +.PARAMETER Name + Key - string + The name of application pool + +.PARAMETER ServiceAccount + Required - string + The name of the managed account to run this service account as + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app pool 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 + + +.EXAMPLE + This example creates a service application pool for service apps to run in. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceAppPool MainServiceAppPool + { + Name = "SharePoint Service Applications" + ServiceAccount = "Demo\ServiceAccount" + PsDscRunAsCredential = $SetupAccount + Ensure = "Present" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt new file mode 100644 index 000000000..c1e52446c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt @@ -0,0 +1,83 @@ +.NAME + SPServiceAppProxyGroup + +# Description + + This resource is used to manage SharePoint Service Application Proxy Groups. + The "Ensure" parameter controls whether or not the Proxy Group should exist. A + proxy group cannot be removed if a web application is using it. The + "ServiceAppProxies" property will set a specific list of Service App Proxies + to be members of this Proxy Group. It will add and remove proxies to ensure + the group matches this list exactly. The "ServiceAppProxiesToInclude" and + "ServiceAppProxiesToExclude" properties will allow you to add and remove + proxies from the group, leaving other proxies that are in the group but not in + either list intact. + + Use the proxy group name "Default" to manipulate the default proxy group. + + Requirements: + At least one of the ServiceAppProxies, ServiceAppProxiesToInclude or + ServiceAppProxiesToExclude properties needs to be specified. Do not combine + the ServiceAppProxies property with the ServiceAppProxiesToInclude and + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the proxy group is created. + +.PARAMETER Name + Key - String + Name of the Proxy Group to create + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present creates the proxy group if it does not already exist, Absent will delete the proxy group if it exists + +.PARAMETER ServiceAppProxies + Write - String + List of service application proxies that belong in this proxy group, all others will be removed + +.PARAMETER ServiceAppProxiesToInclude + Write - String + List of service application proxies to add to this proxy group, existing proxies will remain + +.PARAMETER ServiceAppProxiesToExclude + Write - String + List of service application proxies to remove from this proxy grop, all others will remain + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example creates two seperate proxy groups of service apps that can be + assigned to web apps in the farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceAppProxyGroup ProxyGroup1 + { + Name = "Proxy Group 1" + Ensure = "Present" + ServiceAppProxies = "Web 1 User Profile Service Application","Web 1 MMS Service Application","State Service Application" + } + + SPServiceAppProxyGroup ProxyGroup2 + { + Name = "Proxy Group 2" + Ensure = "Present" + ServiceAppProxiesToInclude = "Web 2 User Profile Service Application" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt new file mode 100644 index 000000000..01a0291ca --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt @@ -0,0 +1,81 @@ +.NAME + SPServiceAppSecurity + +# Description + + This resource is used to manage the sharing security settings of a specific + service application. There are a number of approaches to how this can be + implemented. Firstly you can set permissions for the app administrators, or + for the sharing permission by specifying the SecurityType attribute. These + options correlate to the buttons seen in the ribbon on the "manage service + applications" page in Central Administration after you select a specific + service app. The "Members" property will set a specific list of members for + the service app, 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 + +.PARAMETER ServiceAppName + Key - String + The name of the service application you wish to apply security settings to + +.PARAMETER SecurityType + Key - string + Allowed values: Administrators, SharingPermissions + Administrators will set the administrators for the service app, SharingPermissions will set those granted access through the permissions button seen in the Sharing section of the ribbon in central admin + +.PARAMETER Members + Write - String + A list of members to set the group to. Those not in this list will be removed + +.PARAMETER MembersToInclude + Write - String + A list of members to add. Members not in this list will be left in the group + +.PARAMETER MembersToExclude + Write - String + A list of members to remove. Members not in this list will be left in the group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how full control permission can be given to the farm + account and service app pool account to the user profile service app's + sharing permission. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + $membersToInclude = @() + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointFarmAccount" + AccessLevel = "Full Control" + } + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointServiceApps" + AccessLevel = "Full Control" + } + SPServiceAppSecurity UserProfileServiceSecurity + { + ServiceAppName = "User Profile Service Application" + SecurityType = "SharingPermissions" + MembersToInclude = $membersToInclude + MembersToExclude = @("CONTOSO\BadAccount1", "CONTOSO\BadAccount2") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt new file mode 100644 index 000000000..0b2342092 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt @@ -0,0 +1,76 @@ +.NAME + SPServiceInstance + +# Description + + This resource is used to specify if a specific service should be running + (Ensure = "Present") or not running (Ensure = "Absent") on the current server. + The name is the display name of the service as shown in the Central Admin + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service instance is started. + +.PARAMETER Name + Key - string + The name of the service instance to manage + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure it runs on this server, or absent to ensure it is stopped + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure that the managed metadata service is running + on the local server. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceInstance ManagedMetadataServiceInstance + { + Name = "Managed Metadata Web Service" + Ensure = "Present" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure that the Business Data Connectivity Service + is not running on the local server. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPServiceInstance StopBCSServiceInstance + { + Name = "Business Data Connectivity Service" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt new file mode 100644 index 000000000..8949c9c96 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt @@ -0,0 +1,59 @@ +.NAME + SPSessionStateService + +# Description + + This resource will provision a state service app to the local farm. Specify + the name of the database server and database name to provision the app with, + and optionally include the session timeout value. If session timeout is not + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER DatabaseName + Key - string + The name of the database for the service + +.PARAMETER DatabaseServer + Key - string + The name of the database server for the database + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present is the state service should be enabled, absent if it should be disabled + +.PARAMETER SessionTimeout + Write - uint32 + What is the timeout on sessions + +.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 session state service on the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSessionStateService StateServiceApp + { + DatabaseName = "SP_StateService" + DatabaseServer = "SQL.test.domain" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt new file mode 100644 index 000000000..71eb6b65e --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt @@ -0,0 +1,120 @@ +.NAME + SPShellAdmins + +# Description + + This resource is used to manage the users with Shell Admin permissions. 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. The "ContentDatabases" and + "AllContentDatabases" properties will allow you to control the permissions on + Content Databases. + + Requirements: + + * At least one of the Members, MemberToInclude or MembersToExclude properties + needs to be specified. + * Do not combine the Members property with the MemberToInclude and + MembersToExclude properties. + * Do not combine the ContentDatabase property with the AllContentDatabases + property. + + Notes: + 1.) If a content database is created using the Central Admin, the farm account + is the owner of that content database in SQL Server. When this is true, you + cannot add it to the Shell Admins (common for AllContentDatabases parameter) + and the resource will throw an error. Workaround: Change database owner in SQL + +.PARAMETER Name + Key - String + Name for the config, used for administration purposes + +.PARAMETER Members + Write - String + Exact list of accounts that will have to get Shell Admin permissions + +.PARAMETER MembersToInclude + Write - String + List of all accounts that must be in the Shell Admins group + +.PARAMETER MembersToExclude + Write - String + List of all accounts that are not allowed to have Shell Admin permissions + +.PARAMETER ContentDatabases + Write - String + Shell Admin configuration of Content Databases + +.PARAMETER AllContentDatabases + Write - Boolean + Specify if all content databases must get the same config as the general config + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example gives admin access to the specified users for the local farm as well as + all content databases in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + AllContentDatabases = $true + } + } + } + + +.EXAMPLE + This example gives admin access to the specified users for the local farm as well as + all content databases in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + ContentDatabases = @( + @(MSFT_SPContentDatabasePermissions { + Name = "SharePoint_Content_1" + Members = "CONTOSO\user2", "CONTOSO\user3" + }) + @(MSFT_SPContentDatabasePermissions { + Name = "SharePoint_Content_2" + Members = "CONTOSO\user3", "CONTOSO\user4" + }) + ) + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSite.help.txt b/Modules/SharePointDsc/en-US/about_SPSite.help.txt new file mode 100644 index 000000000..fe3bb4a3b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSite.help.txt @@ -0,0 +1,104 @@ +.NAME + SPSite + +# Description + + This resource will provision a site collection to the current farm, based on + the settings that are passed through. These settings map to the New-SPSite + cmdlet and accept the same values and types. + + The current version of SharePointDsc is only able to check for the existence + of a site collection, the additional parameters are not checked for yet, but + will be in a later release + + Note: When creating Host Header Site Collections, do not use the HostHeader + parameter in SPWebApplication. This will set the specified host header on your + IIS site and prevent the site from listening for the URL of the Host Header + Site Collection. + If you want to change the IIS website binding settings, please use the xWebsite + resource in the xWebAdministration module. + +.PARAMETER Url + Key - string + The URL of the site collection + +.PARAMETER OwnerAlias + Required - string + The username of the site collection administrator + +.PARAMETER CompatibilityLevel + Write - uint32 + The compatibility level of the site + +.PARAMETER ContentDatabase + Write - string + The name of the content database to create the site in + +.PARAMETER Description + Write - string + The description to apply to the site collection + +.PARAMETER HostHeaderWebApplication + Write - string + The URL of the host header web application to create this site in + +.PARAMETER Language + Write - uint32 + The language code of the site + +.PARAMETER Name + Write - string + The display name of the site collection + +.PARAMETER OwnerEmail + Write - string + The email address of the site collection administrator + +.PARAMETER QuotaTemplate + Write - string + The quota template to apply to the site collection + +.PARAMETER SecondaryEmail + Write - string + The secondary site collection admin email address + +.PARAMETER SecondaryOwnerAlias + Write - string + The secondary site collection admin username + +.PARAMETER Template + Write - string + The template to apply to the site collection + +.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 site collection with the provided details + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSite TeamSite + { + Url = "http://sharepoint.contoso.com" + OwnerAlias = "CONTOSO\ExampleUser" + HostHeaderWebApplication = "http://spsites.contoso.com" + Name = "Team Sites" + Template = "STS#0" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt new file mode 100644 index 000000000..98947110b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt @@ -0,0 +1,63 @@ +.NAME + SPStateServiceApp + +# Description + + This resource provisions an instance of the state service in to the local farm. + The database specific parameters are only used during initial provisioning of + the app, and will not change database settings beyond the initial deployment. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the state service app + +.PARAMETER DatabaseCredentials + Write - String + The database credentials for accessing the database + +.PARAMETER DatabaseName + Required - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example creates a state service application in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPStateServiceApp StateServiceApp + { + Name = "State Service Application" + DatabaseName = "SP_State" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt new file mode 100644 index 000000000..5cfe78035 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt @@ -0,0 +1,96 @@ +.NAME + SPSubscriptionSettingsServiceApp + +# 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 subscription + settings service 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. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the subscription settings service app + +.PARAMETER ApplicationPool + Required - String + The name of the application pool the service app runs in + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - String + The name of the database server + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example creates a new subscription settings service app in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp + { + Name = "Subscription Settings Service Application" + ApplicationPool = "SharePoint web services" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_SubscriptionSettings" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a subscription settings service app in the local farm. + The ApplicationPool property is required, but is ignored when removing a + service app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp + { + Name = "Subscription Settings Service Application" + ApplicationPool = "n/a" + PsDscRunAsCredential = $SetupAccount + Ensure = "Absent" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt new file mode 100644 index 000000000..ea2f5011a --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt @@ -0,0 +1,72 @@ +.NAME + SPTimerJobState + +# Description + + This resource is used to configure a timer job and make sure it is in a + specific state. The resource can be used to enable or disabled the job and + configure the schedule of the job. + + The schedule parameter has to be written in the SPSchedule format + (https://technet.microsoft.com/en-us/library/ff607916.aspx). + + Examples are: + + - Every 5 minutes between 0 and 59 + - Hourly between 0 and 59 + - Daily at 15:00:00 + - Weekly between Fri 22:00:00 and Sun 06:00:00 + - Monthly at 15 15:00:00 + - Yearly at Jan 1 15:00:00 + + NOTE: Make sure you use the internal timer job name, not the display name! Use + "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" + to find the internal name for each Timer Job. + +.PARAMETER Name + Key - String + The internal name of the timer job (not the display name) + +.PARAMETER WebApplication + Write - String + The name of the web application that the timer job belongs to + +.PARAMETER Enabled + Write - Boolean + Should the timer job be enabled or not + +.PARAMETER Schedule + Write - String + The schedule for the timer job to execute on + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example show how to disable the dead site delete job in the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTimerJobState DisableTimerJob_DeadSiteDelete + { + Name = "job-dead-site-delete" + WebApplication = "http://sites.sharepoint.contoso.com" + Enabled = $false + Schedule ="weekly at sat 5:00" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt new file mode 100644 index 000000000..d184884a5 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt @@ -0,0 +1,168 @@ +.NAME + SPTrustedIdentityTokenIssuer + +# Description + + This resource is used to create or remove SPTrustedIdentityTokenIssuer in a + SharePoint farm. + + Either parameter SigningCertificateThumbPrint or SigningCertificateFilePath + must be set, but not both. + + The SigningCertificateThumbPrint must be the thumbprint of the signing + certificate stored in the certificate store LocalMachine\My of the server + + Note that the private key of the certificate must not be available in the + certiificate store because SharePoint does not accept it. + + The SigningCertificateFilePath must be the file path to the public key of + the signing certificate. + + The ClaimsMappings property is an array of MSFT_SPClaimTypeMapping to use + with cmdlet New-SPClaimTypeMapping. Each MSFT_SPClaimTypeMapping requires + properties Name and IncomingClaimType. Property LocalClaimType is not + required if its value is identical to IncomingClaimType. + + The IdentifierClaim property must match an IncomingClaimType element in + ClaimsMappings array. + + The ClaimProviderName property can be set to specify a custom claims provider. + It must be already installed in the SharePoint farm and returned by cmdlet + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the token issuer is created. + +.PARAMETER Name + Key - String + Name of the SPTrustedIdentityTokenIssuer + +.PARAMETER Description + Required - String + Description of the SPTrustedIdentityTokenIssuer + +.PARAMETER Realm + Required - String + Default Realm that is passed to identity provider + +.PARAMETER SignInUrl + Required - String + URL of the identity provider where user is redirected to for authentication + +.PARAMETER IdentifierClaim + Required - String + Identity claim type that uniquely identifies the user + +.PARAMETER ClaimsMappings + Required - String + Array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping + +.PARAMETER SigningCertificateThumbprint + Write - String + Specify the thumbprint of the signing certificate, which must be located in certificate store LocalMachine\\My + +.PARAMETER SigningCertificateFilePath + Write - String + Specify the file path to the signing certificate if it is not stored in the local certificate store already + +.PARAMETER ClaimProviderName + Write - String + Name of a claims provider to set with this SPTrustedIdentityTokenIssuer + +.PARAMETER ProviderSignOutUri + Write - String + Sign-out URL + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Present if the SPTrustedIdentityTokenIssuer should be created, or Absent if it should be removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys a trusted token issuer to the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateThumbPrint = "F0D3D9D8E38C1D55A3CEF3AAD1C18AD6A90D5628" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example deploys a trusted token issuer to the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateFilePath = "F:\Data\DSC\FakeSigning.cer" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt new file mode 100644 index 000000000..f072a5703 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt @@ -0,0 +1,86 @@ +.NAME + SPUsageApplication + +# Description + + This resource provisions an instance of the usage and health monitoring service + application. The database settings are only used for initial provisioning, but + the usage settings can be changed and will be enforced as the resource is + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the database server + +.PARAMETER DatabaseCredentials + Write - String + The credentials to use to access the database + +.PARAMETER FailoverDatabaseServer + Write - string + The name of the failover database server + +.PARAMETER UsageLogCutTime + Write - uint32 + The time in minutes to cut over to new log files + +.PARAMETER UsageLogLocation + Write - string + The location on each server to store the log files + +.PARAMETER UsageLogMaxFileSizeKB + Write - uint32 + The maximum file size for log files in KB + +.PARAMETER UsageLogMaxSpaceGB + Write - uint32 + The total space of all log files on disk in GB + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example deploys a usage application to the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUsageApplication UsageApplication + { + Name = "Usage Service Application" + DatabaseName = "SP_Usage" + UsageLogCutTime = 5 + UsageLogLocation = "L:\UsageLogs" + UsageLogMaxFileSizeKB = 1024 + Ensure = "Present" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt new file mode 100644 index 000000000..6b170b01b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt @@ -0,0 +1,168 @@ +.NAME + SPUserProfileProperty + +# Description + + This resource will create a property in a user profile service application. It + creates, update or delete a property using the parameters that are passed in to + it. + + The parameter DisplayOrder is absolute. ie.: If you want it to be placed as the + 5th field of section Bla, which has propertyName value of 5000 then your + DisplayOrder needs to be 5005. If no DisplayOrder is added then SharePoint + adds it as the last property of section X. + + Length is only relevant if Field type is "String". + + This Resource doesn't currently support removing existing user profile + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the user profile property is created. + +.PARAMETER Name + Key - string + The internal name of the user profile property + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the property should exist, absent if it should be removed + +.PARAMETER UserProfileService + Required - string + The name of the user profile service application + +.PARAMETER DisplayName + Write - string + The display name of the property + +.PARAMETER Type + Write - string + Allowed values: BigInteger, Binary, Boolean, Date, DateNoYear, DateTime, Email, Float, Guid, HTML, Integer, Person, String, StringMultiValue, TimeZone, URL + The type of the property + +.PARAMETER Description + Write - string + The description of the property + +.PARAMETER PolicySetting + Write - string + Allowed values: Mandatory, Optin, Optout, Disabled + The policy setting to apply to the property + +.PARAMETER PrivacySetting + Write - string + Allowed values: Public, Contacts, Organization, Manager, Private + The privacy setting for the property + +.PARAMETER MappingConnectionName + Write - string + The name of the UPS connect to map this property to + +.PARAMETER MappingPropertyName + Write - string + The name of the property from the UPS connection to map to + +.PARAMETER MappingDirection + Write - string + The direction of the mapping, either Import or Export + +.PARAMETER Length + Write - uint32 + The length of the field + +.PARAMETER DisplayOrder + Write - uint32 + The display order to put the property in to the list at + +.PARAMETER IsEventLog + Write - boolean + Is this field used for event logging + +.PARAMETER IsVisibleOnEditor + Write - boolean + Is this field visible when editing a users profile, or hidden from editing + +.PARAMETER IsVisibleOnViewer + Write - boolean + Is this field visible when viewing a users profile + +.PARAMETER IsUserEditable + Write - boolean + Is this field able to be edited by a user, or only an administrator + +.PARAMETER IsAlias + Write - boolean + Is this field an alias that can be used to refer to a user by + +.PARAMETER IsSearchable + Write - boolean + Is this field able to be searched upon + +.PARAMETER UserOverridePrivacy + Write - boolean + Can users override the default privacy policy + +.PARAMETER TermStore + Write - string + The name of the term store to look up managed terms from + +.PARAMETER TermGroup + Write - string + The name of the term store group that terms are in for this field + +.PARAMETER TermSet + Write - string + The name of the term set to allow values to be selected from + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys/updates the WorkEmail2 property in the user profile service + app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileProperty WorkEmailProperty + { + Name = "WorkEmail2" + Ensure = "Present" + UserProfileService = "User Profile Service Application" + DisplayName = "Work Email" + Type = "Email" + Description = "" #implementation isn't using it yet + PolicySetting = "Mandatory" + PrivacySetting = "Public" + MappingConnectionName = "contoso.com" + MappingPropertyName = "mail" + MappingDirection = "Import" + Length = 10 + DisplayOrder =25 + IsEventLog =$false + IsVisibleOnEditor=$true + IsVisibleOnViewer = $true + IsUserEditable = $true + IsAlias = $false + IsSearchable = $false + TermStore = "" + TermGroup = "" + TermSet = "" + UserOverridePrivacy = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt new file mode 100644 index 000000000..062bde77c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt @@ -0,0 +1,68 @@ +.NAME + SPUserProfileSection + +# Description + + This resource will create a section in a user profile service application. It + creates, update or delete a section using the parameters that are passed in to + it. + + If no DisplayOrder is added then SharePoint will automatically assigned an ID + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the user profile section is created. + +.PARAMETER Name + Key - string + The internal name of the user profile section + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the section should exist, absent if it should be removed + +.PARAMETER UserProfileService + Required - string + The name of the user profile service application this section exists in + +.PARAMETER DisplayName + Write - string + The display name of the section + +.PARAMETER DisplayOrder + Write - uint32 + A number used to sort sections by + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds a new section for profile properties to the specified + user profile service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileSection PersonalInformationSection + { + Name = "PersonalInformationSection" + UserProfileService = "User Profile Service Application" + DisplayName = "Personal Information" + DisplayOrder = 5000 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt new file mode 100644 index 000000000..4aa51ed58 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt @@ -0,0 +1,153 @@ +.NAME + SPUserProfileServiceApp + +# Description + + This resource will provision an instance of the user profile service to the + farm. It creates the required databases using the parameters that are passed + in to it (although these are only used during the initial provisioning). The + farm account is used during the provisioning of the service only (in the set + method), and the install account is used in the get and test methods. This is + done to ensure that the databases are created with the correct schema owners + and allow the user profile sync service to operate correctly. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the user profile service + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER FarmAccount + Write - String + The farm account to use when provisioning the app + +.PARAMETER MySiteHostLocation + Write - string + The URL of the my site host collection + +.PARAMETER ProfileDBName + Write - string + The name of the profile database + +.PARAMETER ProfileDBServer + Write - string + The name of the server to host the profile database + +.PARAMETER SocialDBName + Write - string + The name of the social database + +.PARAMETER SocialDBServer + Write - string + The name of the database server to host the social database + +.PARAMETER SyncDBName + Write - string + The name of the sync database + +.PARAMETER SyncDBServer + Write - string + The name of the database server to host the sync database + +.PARAMETER EnableNetBIOS + Write - boolean + Whether Farm should resolve NetBIOS domain names + +.PARAMETER NoILMUsed + Write - boolean + Specifies if the service application should be configured to use AD Import + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example adds a new user profile service application to the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileServiceApp UserProfileServiceApp + { + Name = "User Profile Service Application" + ApplicationPool = "SharePoint Service Applications" + MySiteHostLocation = "http://my.sharepoint.contoso.local" + ProfileDBName = "SP_UserProfiles" + ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" + SocialDBName = "SP_Social" + SocialDBServer = "SQL.contoso.local\SQLINSTANCE" + SyncDBName = "SP_ProfileSync" + SyncDBServer = "SQL.contoso.local\SQLINSTANCE" + EnableNetBIOS = $false + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example adds a new user profile service application to the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileServiceApp UserProfileServiceApp + { + Name = "User Profile Service Application" + ApplicationPool = "SharePoint Service Applications" + MySiteHostLocation = "http://my.sharepoint.contoso.local" + ProfileDBName = "SP_UserProfiles" + ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" + SocialDBName = "SP_Social" + SocialDBServer = "SQL.contoso.local\SQLINSTANCE" + SyncDBName = "SP_ProfileSync" + SyncDBServer = "SQL.contoso.local\SQLINSTANCE" + EnableNetBIOS = $false + NoILMUsed = $true + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt new file mode 100644 index 000000000..7730af844 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt @@ -0,0 +1,59 @@ +.NAME + SPUserProfileServiceAppPermissions + +# Description + + This resource will apply permissions to a user profile service application. + These can control access to create my sites, use social features, and use + tagging. If you want to allow all users the ability to use a specific + permisisons include "Everyone" as a user in the corresponding property. To + specify that there should be no permissions on a type, use "none" + +.PARAMETER ProxyName + Key - string + The name of the proxy that is attached to the user profile service you wish to set permissions for + +.PARAMETER CreatePersonalSite + Required - string + A list of user principals that will have the Create personal site permission + +.PARAMETER FollowAndEditProfile + Required - string + A list of user principals that will have the Follow users and edit profile permission + +.PARAMETER UseTagsAndNotes + Required - string + A list of user principals that will have the Use tags and notes permission + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example applies permissions for the user profile service application to limit + access to specific features. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileServiceAppPermissions UPAPermissions + { + ProxyName = "User Profile Service Application Proxy" + CreatePersonalSite = @("DEMO\Group", "DEMO\User1") + FollowAndEditProfile = @("Everyone") + UseTagsAndNotes = @("None") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt new file mode 100644 index 000000000..8b4409e0a --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt @@ -0,0 +1,93 @@ +.NAME + SPUserProfileSyncConnection + +# Description + + This resource will ensure a specifc user profile sync connection is in place + and that it is configured accordingly to its definition + + This resource currently supports AD only. + +.PARAMETER Name + Key - string + The name of the connection + +.PARAMETER Forest + Required - string + The name of the AD forest to read from + +.PARAMETER UserProfileService + Required - string + The name of the user profile service that this connection is attached to + +.PARAMETER ConnectionCredentials + Required - string + The credentials to connect to Active Directory with + +.PARAMETER IncludedOUs + Required - string + A list of the OUs to import users from + +.PARAMETER ExcludedOUs + Write - string + A list of the OUs to ignore users from + +.PARAMETER Server + Write - string + The specific AD server to connect to + +.PARAMETER UseSSL + Write - boolean + Should SSL be used for the connection + +.PARAMETER Force + Write - boolean + Set to true to run the set method on every call to this resource + +.PARAMETER ConnectionType + Write - string + Allowed values: ActiveDirectory, BusinessDataCatalog + The type of the connection - currently only Active Directory is supported + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds a new user profile sync connection to the specified user + profile service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $ConnectionAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileSyncConnection MainDomain + { + UserProfileService = "User Profile Service Application" + Forest = "contoso.com" + Name = "Contoso" + ConnectionCredentials = $ConnectionAccount + Server = "server.contoso.com" + UseSSL = $false + IncludedOUs = @("OU=SharePoint Users,DC=Contoso,DC=com") + ExcludedOUs = @("OU=Notes Usersa,DC=Contoso,DC=com") + Force = $false + ConnectionType = "ActiveDirectory" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt new file mode 100644 index 000000000..209cf882b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt @@ -0,0 +1,71 @@ +.NAME + SPUserProfileSyncService + +# Description + + This resource is responsible for ensuring that the user profile sync service + has been provisioned (Ensure = "Present") or is not running (Ensure = + "Absent") on the current server. This resource uses the InstallAccount to + validate the current state only, the set method which will do the provisioning + uses the FarmAccount to do the actual work - this means that CredSSP + authentication will need to be permitted to allow a connection to the local + server. To allow successful provisioning the farm account must be in the local + administrators group, however it is not best practice to leave this account in + the Administrators group. Therefore this resource will add the FarmAccount + credential to the local administrators group at the beginning of the set + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the user profile sync service is provisioned. + +.PARAMETER UserProfileServiceAppName + Key - string + The name of the user profile service for this sync instance + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the service is running, absent to ensure it is not + +.PARAMETER FarmAccount + Required - String + The farm account, which is needed to provision the service app + +.PARAMETER RunOnlyWhenWriteable + Write - Boolean + Should the sync service only run when the user profile database is in a writeable state? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example provisions the user profile sync service to the local server + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $FarmAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPUserProfileSyncService UserProfileSyncService + { + UserProfileServiceAppName = "User Profile Service Application" + Ensure = "Present" + FarmAccount = $FarmAccount + RunOnlyWhenWriteable = $true + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt new file mode 100644 index 000000000..fe74ec48b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt @@ -0,0 +1,85 @@ +.NAME + SPVisioServiceApp + +# Description + + This resource is responsible for creating Visio Graphics Service Application + instances within the local SharePoint farm. The resource will provision and + configure the Visio Graphics Service Application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER ProxyName + Write - string + The name of the Visio Service Application Proxy + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example shows how to create a new visio services service app in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPVisioServiceApp VisioServices + { + Name = "Visio Graphics Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove a visio services service app in the local farm. + The ApplicationPool property is still requried but is not used when removing, so + the value used here doesn't matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPVisioServiceApp VisioServices + { + Name = "Visio Graphics Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt new file mode 100644 index 000000000..79e332fab --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt @@ -0,0 +1,86 @@ +.NAME + SPWeb + +# Description + + This resource will provision a SPWeb based on the settings that are passed + through. These settings map to the New-SPWeb cmdlet and accept the same values + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the web is created. + +.PARAMETER Url + Key - string + The URL of the web + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the web should exist or Absent if it should be removed + +.PARAMETER Description + Write - string + The description to apply to the web + +.PARAMETER Name + Write - string + The Name of the web + +.PARAMETER Language + Write - uint32 + The Lanhuage (LCID) of the web + +.PARAMETER Template + Write - string + The WebTemplate to use to create the web + +.PARAMETER UniquePermissions + Write - Boolean + True if the web should have unique permissions, otherwise false. + +.PARAMETER UseParentTopNav + Write - Boolean + True if the web should use the parent nav bar, otherwise false. + +.PARAMETER AddToQuickLaunch + Write - Boolean + True if the web should be in the quick launch of the parent web, otherwise false. + +.PARAMETER AddToTopNav + Write - Boolean + True if the web should be added to the top nav bar of the parent web, otherwise false. + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys a subsite in a specific location + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWeb TeamSite + { + Url = "http://sharepoint.contoso.com/sites/site/subweb" + Name = "Team Sites" + Ensure = "Present" + Description = "A place to share documents with your team." + Template = "STS#0" + Language = 1033 + AddToTopNav = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt new file mode 100644 index 000000000..bbc65b7eb --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt @@ -0,0 +1,90 @@ +.NAME + SPWebAppBlockedFileTypes + +# Description + + This resource is responsible for controlling the blocked file type setting on a + specific web application. It has two modes of operation, the first is to use + the "blocked" property, where you are able to define a specific list of file + types that will be blocked. In this mode when it is detected that the list + does not match the local farm, it is set to match this list exactly. The + second mode is to use the "EnsureBlocked" and "EnsureAllowed" properties. + EnsureBlocked will check to make sure that the specified file types are on the + list, and if not they will be added. EnsureAllowed checks to make sure that a + file type is not on the list, and if it is it will be removed. Both of these + properties will only make changes to the file types in their list and will + leave the full list as it is otherwise, whereas the blocked property resets + +.PARAMETER Url + Key - string + The URL of the web application to set blocked file types for + +.PARAMETER Blocked + write - string + This is a fixed list to use for blocked file types in this web app + +.PARAMETER EnsureBlocked + write - string + This list of file types that will always be added to the list for this web app. Types not in this list will be left in the list + +.PARAMETER EnsureAllowed + write - string + This list of file types that will always be removedfrom the list for this web app. Types not in this list will be left in the list + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure that specific file types are always blocked while + others will always be allowed. Any file types not mentioned in this config will be + able to be managed manually. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes + { + Url = "http://exmaple.contoso.local" + EnsureBlocked = @("exe", "dll", "msi") + EnsureAllowed = @("pdf", "docx", "xlsx") + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure that the blocked file type list always + specifically matches this list. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes + { + Url = "http://exmaple.contoso.local" + Blocked = @("exe", "dll", "msi") + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt new file mode 100644 index 000000000..68659ed15 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt @@ -0,0 +1,124 @@ +.NAME + SPWebAppGeneralSettings + +# Description + + This resource is responsible for setting web application settings that are + found under the "general settings" screen in central admin. The web + application is specified through the URL property, and then any combination of + settings can be applied. Any settings not included will be left as the default + (or whatever they have been manually changed to within SharePoint). + +.PARAMETER Url + Key - string + The URL of the web app to set the general settings for + +.PARAMETER TimeZone + Write - uint32 + The timezone code to use for this web app. A full list is at https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spregionalsettings.timezones.aspx + +.PARAMETER Alerts + Write - boolean + Should alerts be enabled for this web app + +.PARAMETER AlertsLimit + Write - uint32 + What is the maximum number of alerts that a user can create in this web app + +.PARAMETER RSS + Write - boolean + Should RSS feeds be enabled in this web app + +.PARAMETER BlogAPI + Write - boolean + Should the Blog API be enabled in this web app + +.PARAMETER BlogAPIAuthenticated + Write - boolean + Is authentication required for the blog API + +.PARAMETER BrowserFileHandling + Write - String + Allowed values: Strict, Permissive + What file handling mode should be used in this web app - strict or permissive + +.PARAMETER SecurityValidation + Write - boolean + Is security validation enforced in this web app + +.PARAMETER SecurityValidationExpires + Write - boolean + Does security validation expire after a set time + +.PARAMETER SecurityValidationTimeOutMinutes + Write - uint32 + Number of minutes security validation will expire if securityvalidationexpires is set + +.PARAMETER RecycleBinEnabled + Write - boolean + Is the recycle bin enabled in this web application + +.PARAMETER RecycleBinCleanupEnabled + Write - boolean + Is automatic cleanup of the recycle bin enabled in this web app + +.PARAMETER RecycleBinRetentionPeriod + Write - uint32 + How many days does the recycle bin keep content for + +.PARAMETER SecondStageRecycleBinQuota + Write - uint32 + How much content does the second stage recycle bin keep content for + +.PARAMETER MaximumUploadSize + Write - uint32 + What is the maximum file upload size for this web app (in MB) + +.PARAMETER CustomerExperienceProgram + Write - boolean + Should the customer experience program be enabled in this web app + +.PARAMETER AllowOnlineWebPartCatalog + Write - boolean + Should the Online WebPart Gallery be enabled for this web app + +.PARAMETER SelfServiceSiteCreationEnabled + Write - boolean + Should Self Service Site Creation be enabled + +.PARAMETER PresenceEnabled + Write - boolean + Is Skype for Business presence enabled for this web app + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply some of the available general settings to the + specified web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppGeneralSettings PrimaryWebAppGeneralSettings + { + Url = "http://exmaple.contoso.local" + TimeZone = 76 + Alerts = $true + RSS = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt new file mode 100644 index 000000000..376f4e1be --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt @@ -0,0 +1,89 @@ +.NAME + SPWebAppPermissions + +# Description + + This resource is responsible for managing the user permissions for a web + application. You can either specify to set all permissions or specify + individual permissions per category. + + More info about the permission levels: + +.PARAMETER WebAppUrl + Key - string + The url of the web application + +.PARAMETER ListPermissions + Write - string + Allowed values: Manage Lists, Override List Behaviors, Add Items, Edit Items, Delete Items, View Items, Approve Items, Open Items, View Versions, Delete Versions, Create Alerts, View Application Pages + List permissions that need to be configured + +.PARAMETER SitePermissions + Write - string + Allowed values: Manage Permissions, View Web Analytics Data, Create Subsites, Manage Web Site, Add and Customize Pages, Apply Themes and Borders, Apply Style Sheets, Create Groups, Browse Directories, Use Self-Service Site Creation, View Pages, Enumerate Permissions, Browse User Information, Manage Alerts, Use Remote Interfaces, Use Client Integration Features, Open, Edit Personal User Information + Site permissions that need to be configured + +.PARAMETER PersonalPermissions + Write - string + Allowed values: Manage Personal Views, Add/Remove Personal Web Parts, Update Personal Web Parts + Personal permissions that need to be configured + +.PARAMETER AllPermissions + Write - boolean + Set all permissions + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to limit the available permisions within a web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPermissions WebApplicationPermissions + { + WebAppUrl = "https://intranet.sharepoint.contoso.com" + ListPermissions = "Manage Lists","Override List Behaviors","Add Items","Edit Items","Delete Items","View Items","Approve Items","Open Items","View Versions","Delete Versions","Create Alerts","View Application Pages" + SitePermissions = "Manage Permissions","View Web Analytics Data","Create Subsites","Manage Web Site","Add and Customize Pages","Apply Themes and Borders","Apply Style Sheets","Create Groups","Browse Directories","Use Self-Service Site Creation","View Pages","Enumerate Permissions","Browse User Information","Manage Alerts","Use Remote Interfaces","Use Client Integration Features","Open","Edit Personal User Information" + PersonalPermissions = "Manage Personal Views","Add/Remove Personal Web Parts","Update Personal Web Parts" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to ensure all permissions are available for a web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPermissions WebApplicationPermissions + { + WebAppUrl = "https://portal.sharepoint.contoso.com" + AllPermissions = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt new file mode 100644 index 000000000..404dc14ba --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt @@ -0,0 +1,123 @@ +.NAME + SPWebAppPolicy + +# Description + + This resource is used to set the User Policies for web applications. The + usernames can be either specified in Classic or Claims format, both will be + accepted. 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. + + Requirements: + At least one of the Members, MemberToInclude or MembersToExclude properties + needs to be specified. Do not combine the Members property with the + MemberToInclude and MembersToExclude properties. Do not set the + ActAsSystemAccount property to $true without setting the permission level to + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER Members + Write - String + Exact list of accounts that will have to get Web Policy permissions + +.PARAMETER MembersToInclude + Write - String + List of all accounts that must be in the Web Policy group + +.PARAMETER MembersToExclude + Write - String + List of all accounts that are not allowed to have any Web Policy permissions + +.PARAMETER SetCacheAccountsPolicy + Write - Boolean + Include the Cache Accounts in the policy or not + +.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 specific web app policy for the specified web app to + match the provided list below. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPolicy WebAppPolicy + { + WebAppUrl = "http://sharepoint.contoso.com" + Members = @( + MSFT_SPWebPolicyPermissions { + Username = "contoso\user1" + PermissionLevel = "Full Control" + ActAsSystemAccount = $true + } + MSFT_SPWebPolicyPermissions { + Username = "contoso\Group 1" + PermissionLevel = "Full Read" + IdentityType = "Claims" + } + ) + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to include specific members while excluding other members + from the policy of the web app. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPolicy WebAppPolicy + { + WebAppUrl = "http://sharepoint.contoso.com" + MembersToInclude = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user1" + PermissionLevel = "Full Control" + }) + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user2" + PermissionLevel = "Full Read" + }) + ) + MembersToExclude = @( + @(MSFT_SPWebPolicyPermissions { + Username = "contoso\user3" + }) + ) + SetCacheAccountsPolicy = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt new file mode 100644 index 000000000..12151f76f --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt @@ -0,0 +1,52 @@ +.NAME + SPWebAppProxyGroup + +# Description + + This resource is used to associate a web application to a service application + proxy group. Use the proxy group name "Default" to associate the web + application to the default proxy group. A web applicaiton can only connect to + a single service application proxy group. This resource will overright the + existing service application proxy group association. + + This resource is used in conjunction with the SPServiceAppProxyGroup resource, + which creates the proxy groups and associates the desired service application + proxies with it. Within your configuration, that resource should be a + +.PARAMETER WebAppUrl + Key - String + URL of the web application + +.PARAMETER ServiceAppProxyGroup + Required - string + Name of the Service Application Proxy Group + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to assign a specific proxy group to the specified web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppProxyGroup ContosoWeb + { + WebAppUrl = "https://web.contoso.com" + ServiceAppProxyGroup = "Proxy Group 1" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt new file mode 100644 index 000000000..2ef086db4 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt @@ -0,0 +1,62 @@ +.NAME + SPWebAppSiteUseAndDeletion + +# Description + + This resource is responsible for controlling the Site Use and Deletion + settings on a specific web application. You can enable or disable the Site Use + and Deletion feature, specify the amount of days after which the alerts are + being send, if sites have to be deleted automatically and if so after how many + +.PARAMETER Url + Key - string + The URL of the web application + +.PARAMETER SendUnusedSiteCollectionNotifications + Write - boolean + Should emails be sent to notify site owners of unused site collections + +.PARAMETER UnusedSiteNotificationPeriod + Write - uint32 + How many days should pass before a site is flagged as unused + +.PARAMETER AutomaticallyDeleteUnusedSiteCollections + Write - boolean + Should unused site collection be automatically deleted + +.PARAMETER UnusedSiteNotificationsBeforeDeletion + Write - uint32 + How many days before an unused site is deleted should an email be sent to the owner + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply site use and deletion settings to the specified web applicaiton + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion + { + Url = "http://example.contoso.local" + SendUnusedSiteCollectionNotifications = $true + UnusedSiteNotificationPeriod = 90 + AutomaticallyDeleteUnusedSiteCollections = $true + UnusedSiteNotificationsBeforeDeletion = 24 + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt new file mode 100644 index 000000000..c82635b35 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt @@ -0,0 +1,97 @@ +.NAME + SPWebAppThrottlingSettings + +# Description + + This resource is responsible for setting web application settings that are + found under the "resource throttling" screen in central admin. The web + application is specified through the URL property, and then any combination of + settings can be applied. Any settings not included will be left as the default + (or whatever they have been manually changed to within SharePoint). Happy hour + is the setting used to control the window where threshold do not apply + throughout the day. You can specify the start time of this window as well as + +.PARAMETER Url + Key - string + The URL of the web application + +.PARAMETER ListViewThreshold + Write - uint32 + What should the list view threshold for this site be set to + +.PARAMETER AllowObjectModelOverride + Write - boolean + Should object model code be able to be override the list view threshold + +.PARAMETER AdminThreshold + Write - uint32 + What is the list view threshold for site administrators + +.PARAMETER ListViewLookupThreshold + Write - uint32 + What is the maximum number of lookup fields in a single list view + +.PARAMETER HappyHourEnabled + Write - boolean + Should the happy hour window be enabled for this web app + +.PARAMETER HappyHour + Write - string + The time window for happy hour + +.PARAMETER UniquePermissionThreshold + Write - uint32 + What is the limit for unique permissions on a single object in this web app + +.PARAMETER RequestThrottling + Write - boolean + Is request throttling enabled on this web app + +.PARAMETER ChangeLogEnabled + Write - boolean + Is the change log enabled for this web app + +.PARAMETER ChangeLogExpiryDays + Write - uint32 + How many days does the change log store data for + +.PARAMETER EventHandlersEnabled + Write - boolean + Are event handlers enabled in the web application + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply throttling settings to a specific web app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings + { + Url = "http://exmaple.contoso.local" + ListViewThreshold = 5000 + AllowObjectModelOverride = $false + HappyHourEnabled = $true + HappyHour = MSFT_SPWebApplicationHappyHour { + Hour = 3 + Minute = 0 + Duration = 1 + } + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt new file mode 100644 index 000000000..b0a3353dc --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt @@ -0,0 +1,57 @@ +.NAME + SPWebAppWorkflowSettings + +# Description + + This resource is responsible for setting web application settings that are + found under the "workflow settings" screen in central admin. The web + application is specified through the URL property, and then any combination of + settings can be applied. Any settings not included will be left as the default + (or whatever they have been manually changed to within SharePoint). + +.PARAMETER Url + Key - string + The URL of the web application + +.PARAMETER ExternalWorkflowParticipantsEnabled + Write - boolean + Are external workflow participants enabled in the web app + +.PARAMETER UserDefinedWorkflowsEnabled + Write - boolean + Are user defined workflows enabled in this web app + +.PARAMETER EmailToNoPermissionWorkflowParticipantsEnable + Write - boolean + Are documents sent via email to external participants of workflow + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply workflow settings to the specific web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings + { + Url = "Shttp://exmaple.contoso.local" + ExternalWorkflowParticipantsEnabled = $false + EmailToNoPermissionWorkflowParticipantsEnable = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt new file mode 100644 index 000000000..42d76ab7f --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt @@ -0,0 +1,179 @@ +.NAME + SPWebApplication + +# Description + + This resource is responsible for creating a web application within the local + SharePoint farm. The resource will provision the web application with all of + the current settings, and then ensure that it stays part of the correct + application pool beyond that (additional checking and setting of properties + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the web application is provisioned. + + Note: When using Host Header Site Collections, do not use the HostHeader + parameter in SPWebApplication. This will set the specified host header on your + IIS site and prevent the site from listening for the URL of the Host Header + Site Collection. + If you want to change the IIS website binding settings, please use the xWebsite + resource in the xWebAdministration module. + +.PARAMETER Name + Key - string + The name of the web application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run this site in + +.PARAMETER ApplicationPoolAccount + Required - string + The name of the managed account to run the app pool with + +.PARAMETER Url + Required - string + The URL of the web application + +.PARAMETER AllowAnonymous + Write - boolean + Should anonymous access be enabled for this web app + +.PARAMETER AuthenticationMethod + Write - string + Allowed values: NTLM, Kerberos, Claims, Classic + What authentication mode should be used for the web app + +.PARAMETER AuthenticationProvider + Write - string + What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims + +.PARAMETER DatabaseName + Write - string + The name of the first content database to be created with this web app + +.PARAMETER DatabaseServer + Write - string + The name of the database server to host the default content DB + +.PARAMETER HostHeader + Write - string + The host header to use for the web app + +.PARAMETER Path + Write - string + The path on the local servers to host the IIS web site from + +.PARAMETER Port + Write - string + The port to run the site on + +.PARAMETER UseSSL + Write - boolean + Should this web app use SSL + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the web app 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 + + +.EXAMPLE + This example shows how to create a new web application in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebApplication HostNameSiteCollectionWebApp + { + Name = "SharePoint Sites" + ApplicationPool = "SharePoint Sites" + ApplicationPoolAccount = "CONTOSO\svcSPWebApp" + AllowAnonymous = $false + AuthenticationMethod = "NTLM" + DatabaseName = "SP_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + Url = "http://example.contoso.local" + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to create a new web application in the local farm using a custom claim provider. + A SPTrustedIdentityTokenIssuer is created named Contoso, then this SPTrustedIdentityTokenIssuer is referenced + by the SPWebApplication as the AuthenticationProvider and the AuthenticationMethod is set to "Claims" value. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + + + SPWebApplication HostNameSiteCollectionWebApp + { + Name = "SharePoint Sites" + ApplicationPool = "SharePoint Sites" + ApplicationPoolAccount = "CONTOSO\svcSPWebApp" + AllowAnonymous = $false + AuthenticationMethod = "Claims" + AuthenticationProvider = "Contoso" + DatabaseName = "SP_Content_01" + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + Url = "http://example.contoso.local" + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt new file mode 100644 index 000000000..80c0a694b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt @@ -0,0 +1,64 @@ +.NAME + SPWebApplicationAppDomain + +# Description + + This resource will configure the App Domain at a specific zone for the given + Web Application. The configuration is done per zone on the specified web + application, allowing for the setting of unique app domains for each extension + of a web application. The app prefix should still be set using the SPAppDomain + resource before this is applied to customise a specific zone. + +.PARAMETER WebApplication + Key - string + The URL of the web application to set the app domain for + +.PARAMETER Zone + Key - string + Allowed values: Default, Internet, Intranet, Extranet, Custom + The zone that this app domain applies to + +.PARAMETER AppDomain + Required - string + The domain for apps in this web app zone + +.PARAMETER Port + Write - string + The port to run apps on + +.PARAMETER SSL + Write - boolean + Should apps run under SSL + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to set the app domain for a specified web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebApplicationAppDomain Domain + { + AppDomain = "contosointranetapps.com" + WebApplication ="http://portal.contoso.com"; + Zone = "Default"; + Port = 80; + SSL = $false; + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt new file mode 100644 index 000000000..461b6a58c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt @@ -0,0 +1,101 @@ +.NAME + SPWebApplicationExtension + +# Description + + This resource is responsible for extending an existing web application into a new + zone. The resource will provision the web application extension with all of + the current settings, and then ensure that it stays present and will ensure the + AllowAnonymous and Authentication methods remain consistent. Please note that this + currently does not support changing the claims provider on an existing claims + enabled web application externsion. + +.PARAMETER WebAppUrl + Key - string + The URL of the parent web application + +.PARAMETER Name + Required - string + The name of the web application extension + +.PARAMETER Url + Required - string + The URL of the web application extension + +.PARAMETER Zone + Key - string + Allowed values: Default, Intranet, Internet, Extranet, Custom + Specifies one of the five zones with which the internal URL of this new extension is to be associated. + +.PARAMETER AllowAnonymous + Write - boolean + Should anonymous access be enabled for this web app extension + +.PARAMETER AuthenticationMethod + Write - string + Allowed values: NTLM, Kerberos, Claims + What authentication mode should be used for the web app extension + +.PARAMETER AuthenticationProvider + Write - string + What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims + +.PARAMETER HostHeader + Write - string + The host header to use for the web app extension + +.PARAMETER Path + Write - string + The path on the local servers to host the IIS web site from + +.PARAMETER Port + Write - string + The port to run the site on + +.PARAMETER UseSSL + Write - boolean + Should this web app extension use SSL + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the web app 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 + + +.EXAMPLE + This example shows how to create a new web application extension in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebApplicationExtension IntranetZone + { + WebAppUrl = "http://example.contoso.local" + Name = "Contoso Intranet Zone" + AllowAnonymous = $false + AuthenticationMethod = "NTLM" + Url = "http://intranet.contoso.local" + Zone = "Intranet" + HostHeader = "intranet.contoso.local" + Path = "c:\inetpub\wwwroot\wss\VirtualDirectories\intranet" + UseSSL = $false + Port = 80 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt new file mode 100644 index 000000000..4f031c8e7 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt @@ -0,0 +1,161 @@ +.NAME + SPWordAutomationServiceApp + +# Description + + The resource is able to provision, unprovision and configure the Word + Automation Service Application. All settings that you can configure on the + Service Application administration page are configurable using this resource. + + Important: + When you specify Ensure=Present, the Application Pool and DatabaseName + parameters are required. When you specify Ensure=Absent, no other parameters + are allowed (with the exception of Name, InstallAccount or + PsDscRunAsCredential). + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + THe name of the service application + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the app exists, absent to ensure that it does not + +.PARAMETER ApplicationPool + Write - string + The name of the application pool to run the service app in + +.PARAMETER DatabaseName + Write - string + The name of the database for the service app + +.PARAMETER DatabaseServer + Write - string + The name of the server that will host the database + +.PARAMETER SupportedFileFormats + Write - string + Allowed values: docx, doc, mht, rtf, xml + The list of supported file types + +.PARAMETER DisableEmbeddedFonts + Write - boolean + Should embedded fonts be disabled + +.PARAMETER MaximumMemoryUsage + Write - uint32 + What is the maximum amount of memory the service app should use (in MB) + +.PARAMETER RecycleThreshold + Write - uint32 + What is the recycle threshold for this service app + +.PARAMETER DisableBinaryFileScan + Write - boolean + Should binary file scans be disabled + +.PARAMETER ConversionProcesses + Write - uint32 + How many conversion processes can be run at once + +.PARAMETER JobConversionFrequency + Write - uint32 + How frequently should new jobs be started from the queue (in minutes) + +.PARAMETER NumberOfConversionsPerProcess + Write - uint32 + How many document conversions should be included in a single process + +.PARAMETER TimeBeforeConversionIsMonitored + Write - uint32 + How long can a conversion be run before it becomes monitored + +.PARAMETER MaximumConversionAttempts + Write - uint32 + What is the maximum number of attempts to convert a document + +.PARAMETER MaximumSyncConversionRequests + Write - uint32 + What is the maximum number of sync conversion requests for the service app + +.PARAMETER KeepAliveTimeout + Write - uint32 + How long is the keep alive timeout set to for the service app + +.PARAMETER MaximumConversionTime + Write - uint32 + What is the maximum time in seconds for a document conversion to be allowed to run + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example makes sure the service application exists and has a specific configuration + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWordAutomationServiceApp WordAutomation + { + Name = "Word Automation Service Application" + Ensure = "Present" + ApplicationPool = "SharePoint Web Services" + DatabaseName = "WordAutomation_DB" + DatabaseServer = "SQLServer" + SupportedFileFormats = "docx", "doc", "mht", "rtf", "xml" + DisableEmbeddedFonts = $false + MaximumMemoryUsage = 100 + RecycleThreshold = 100 + DisableBinaryFileScan = $false + ConversionProcesses = 8 + JobConversionFrequency = 15 + NumberOfConversionsPerProcess = 12 + TimeBeforeConversionIsMonitored = 5 + MaximumConversionAttempts = 2 + MaximumSyncConversionRequests = 25 + KeepAliveTimeout = 30 + MaximumConversionTime = 300 + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a word automation service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWordAutomationServiceApp WordAutomation + { + Name = "Word Automation Service Application" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt new file mode 100644 index 000000000..979c2cf81 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt @@ -0,0 +1,92 @@ +.NAME + SPWorkManagementServiceApp + +# Description + + This resource is used to provision and manage an instance of the Work + Management Services Service Application. It will identify an instance of the + work 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. + + Remarks + + - Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches, + MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in + minutes. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - string + The name of the work management service application + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to ensure the app exists, Absent to ensure it is removed + +.PARAMETER ApplicationPool + Write - String + The name of the application pool this will run in + +.PARAMETER MinimumTimeBetweenEwsSyncSubscriptionSearches + Write - uint32 + The minimum amount of time bween EWS sync subscription searches + +.PARAMETER MinimumTimeBetweenProviderRefreshes + Write - uint32 + The minimum time between provider refreshes + +.PARAMETER MinimumTimeBetweenSearchQueries + Write - uint32 + The minimum time between search queries + +.PARAMETER NumberOfSubscriptionSyncsPerEwsSyncRun + Write - uint32 + The number of subscription syncronisations per EWS sync run + +.PARAMETER NumberOfUsersEwsSyncWillProcessAtOnce + Write - uint32 + How many users will EWS calls include at once + +.PARAMETER NumberOfUsersPerEwsSyncBatch + Write - uint32 + How many users are included in a batch for EWS + +.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 work management service app in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWorkManagementServiceApp WorkManagementServiceApp + { + Name = "Work Management Service Application" + ApplicationPool = "SharePoint web services" + MinimumTimeBetweenEwsSyncSubscriptionSearches = 10 + PsDscRunAsCredential = $SetupAccount + } + } + } + + From 80a1bfed7f2cd79c679cebc0cd5a8c88b347741f Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Fri, 8 Sep 2017 14:46:31 +0200 Subject: [PATCH 14/18] Implemented fix to resolve test issues --- Tests/TestHarness.psm1 | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/Tests/TestHarness.psm1 b/Tests/TestHarness.psm1 index 148aad622..a81770b37 100644 --- a/Tests/TestHarness.psm1 +++ b/Tests/TestHarness.psm1 @@ -68,7 +68,21 @@ function Invoke-TestHarness # DSC Common Tests if ($PSBoundParameters.ContainsKey('DscTestsPath') -eq $true) { - $testsToRun += @( $DscTestsPath ) + $getChildItemParameters = @{ + Path = $DscTestsPath + Recurse = $true + Filter = '*.Tests.ps1' + } + + # Get all tests '*.Tests.ps1'. + $commonTestFiles = Get-ChildItem @getChildItemParameters + + # Remove DscResource.Tests unit and integration tests. + $commonTestFiles = $commonTestFiles | Where-Object -FilterScript { + $_.FullName -notmatch 'DSCResource.Tests\\Tests' + } + + $testsToRun += @( $commonTestFiles.FullName ) } if ($IgnoreCodeCoverage.IsPresent -eq $false) From 5c6626d4fe29854c8ca503fda94326eb035339e1 Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Tue, 19 Dec 2017 07:49:46 +0100 Subject: [PATCH 15/18] Updated documentation as part of 2.0 release --- .../en-US/about_SPAlternateUrl.help.txt | 18 +- .../en-US/about_SPBCSServiceApp.help.txt | 4 + .../en-US/about_SPCreateFarm.help.txt | 148 +---------------- .../en-US/about_SPInstall.help.txt | 7 + .../en-US/about_SPInstallPrereqs.help.txt | 78 +++++++-- .../en-US/about_SPJoinFarm.help.txt | 72 +------- .../en-US/about_SPLogLevel.help.txt | 122 ++++++++++++++ ...ut_SPMachineTranslationServiceApp.help.txt | 99 +++++++++++ ...about_SPManagedMetaDataServiceApp.help.txt | 83 +++++++++- ...PManagedMetaDataServiceAppDefault.help.txt | 56 +++++++ .../en-US/about_SPMinRoleCompliance.help.txt | 44 +++++ .../about_SPOutgoingEmailSettings.help.txt | 4 +- .../about_SPPasswordChangeSettings.help.txt | 2 +- ...SPProjectServerADResourcePoolSync.help.txt | 96 +++++++++++ ...SPProjectServerAdditionalSettings.help.txt | 55 +++++++ ..._SPProjectServerGlobalPermissions.help.txt | 154 ++++++++++++++++++ .../en-US/about_SPProjectServerGroup.help.txt | 102 ++++++++++++ .../about_SPProjectServerLicense.help.txt | 69 ++++++++ ...out_SPProjectServerPermissionMode.help.txt | 71 ++++++++ .../about_SPProjectServerServiceApp.help.txt | 104 ++++++++++++ ..._SPProjectServerTimeSheetSettings.help.txt | 125 ++++++++++++++ ...t_SPProjectServerUserSyncSettings.help.txt | 56 +++++++ .../about_SPProjectServerWssSettings.help.txt | 52 ++++++ ...about_SPPublishServiceApplication.help.txt | 4 +- .../about_SPSearchContentSource.help.txt | 8 - .../en-US/about_SPSearchServiceApp.help.txt | 4 +- .../en-US/about_SPSearchTopology.help.txt | 9 +- .../en-US/about_SPServiceIdentity.help.txt | 50 ++++++ .../en-US/about_SPServiceInstance.help.txt | 4 +- .../en-US/about_SPShellAdmins.help.txt | 24 +-- .../en-US/about_SPStateServiceApp.help.txt | 4 + .../en-US/about_SPTimerJobState.help.txt | 31 ++-- .../about_SPUserProfileProperty.help.txt | 2 +- .../about_SPUserProfileServiceApp.help.txt | 22 +-- ...about_SPUserProfileSyncConnection.help.txt | 4 +- .../about_SPUserProfileSyncService.help.txt | 17 +- .../SharePointDsc/en-US/about_SPWeb.help.txt | 67 ++++++++ .../about_SPWebAppAuthentication.help.txt | 149 +++++++++++++++++ .../about_SPWebAppGeneralSettings.help.txt | 4 + ...bout_SPWebAppPeoplePickerSettings.help.txt | 85 ++++++++++ .../about_SPWebAppSiteUseAndDeletion.help.txt | 4 +- .../en-US/about_SPWebAppSuiteBar.help.txt | 98 +++++++++++ .../en-US/about_SPWebApplication.help.txt | 84 +--------- .../about_SPWebApplicationExtension.help.txt | 12 +- .../about_SPWordAutomationServiceApp.help.txt | 4 +- .../en-US/about_SPWorkflowService.help.txt | 54 ++++++ 46 files changed, 1960 insertions(+), 405 deletions(-) create mode 100644 Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt index c19dcabd8..72e49de10 100644 --- a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt @@ -11,9 +11,9 @@ The default value for the Ensure parameter is Present. When not specifying this parameter, the setting is configured. -.PARAMETER WebAppUrl +.PARAMETER WebAppName Key - String - The URL of the web application to apply the alternate URL to + The name of the web application to apply the alternate URL to .PARAMETER Zone Key - String @@ -21,9 +21,13 @@ The Zone to use for the alternate URL .PARAMETER Url - Write - String + Key - String The new alternate URL +.PARAMETER Internal + Write - Boolean + Specifies if the URL has to be configured as internal + .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -50,9 +54,11 @@ node localhost { SPAlternateUrl CentralAdminAAM { - WebAppUrl = "http://sharepoint1:9999" + WebAppName = "SharePoint - www.domain.com80" Zone = "Intranet" Url = "https://admin.sharepoint.contoso.com" + Internal = $false + Ensure = "Present" PsDscRunAsCredential = $SetupAccount } } @@ -76,8 +82,10 @@ node localhost { SPAlternateUrl CentralAdminAAM { - WebAppUrl = "http://sharepoint1:9999" + WebAppName = "SharePoint - www.domain.com80" Zone = "Intranet" + Url = "http://www.externaldomain.com" + Internal = $false Ensure = "Absent" PsDscRunAsCredential = $SetupAccount } diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt index 32597f9e7..1b31735eb 100644 --- a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt @@ -19,6 +19,10 @@ Key - string The name of the BCS service app +.PARAMETER ProxyName + Write - string + The name of the BCS service application proxy + .PARAMETER ApplicationPool Required - String The application pool it should run in diff --git a/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt index 49b7b24c2..d7f4e2ea5 100644 --- a/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt @@ -3,32 +3,8 @@ # Description - WARNING: This resource is deprecated. Please use SPFarm instead as - this resource will be removed from version 2.0 of SharePointDsc - - 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 SPJoinFarm. 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 passphrase is passed as a Credential object.The username of this - credential is ignored, only the value of the password is used as the farm - passphrase. - - 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 SPDistributedCacheService on at least one server in the farm to - designate it as a cache server. - - CentralAdministrationAuth can be specified as "NTLM" or "KERBEROS". If not - specified, it defaults to NTLM. If using Kerberos, make sure to have - appropriate SPNs setup for Farm account and Central Administration URI. + WARNING: This resource has been removed. Please use SPFarm instead. + See http://aka.ms/SPDsc-SPFarm for details. .PARAMETER FarmConfigDatabaseName Key - String @@ -69,123 +45,3 @@ POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. By default the central admin site in this - example is provisioned to port 9999 using NTLM authentication. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCreateFarm CreateFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. Here the port for the central admin site to - run on, as well as the authentication mode for the site are also specified. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCreateFarm CreateFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - CentralAdministrationPort = 5000 - CentralAdministrationAuth = "Kerberos" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how a basic SharePoint farm can be created. The database server and names - are specified, and the accounts to run the setup as, the farm account and the passphrase are - all passed in to the configuration to be applied. By default the central admin site in this - example is provisioned to port 9999 using NTLM authentication. In this example we also see - the server role defined as "Application" which tells SharePoint 2016 the role to apply to - this server as soon as the farm is created. This property is not supported for SharePoint 2013 - and so this specific example would fail if used against that verison. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPCreateFarm CreateFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - AdminContentDatabaseName = "SP_AdminContent" - ServerRole = "Application" - Passphrase = $Passphrase - FarmAccount = $FarmAccount - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt index 937fce5d5..8abaa689a 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt @@ -25,6 +25,13 @@ approach is to copy the installation media to the local nodes first and then execute the installation from there. + ## Multilingual support + + Where possible, resources in SharePointDsc have been written in a way that + they should support working with multiple language packs for multilingual + deployments. However due to constraints in how we set up and install the + product, only English ISOs are supported for installing SharePoint. + .PARAMETER BinaryDir Key - String The directory that contains all of the SharePoint binaries diff --git a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt index de5bdc813..941c143e2 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt @@ -37,6 +37,16 @@ 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://technet.microsoft.com/library/a88d3f72-7ac3-4f08-b302-c4ca0a796268%28v=office.16%29.aspx?#section5 + + SharePoint 2016: + https://technet.microsoft.com/en-us/library/cc262485(v=office.16).aspx#section5 + .PARAMETER InstallerPath Key - String The full path to prerequisiteinstaller.exe @@ -51,67 +61,67 @@ .PARAMETER SQLNCli Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER PowerShell Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 only) .PARAMETER NETFX Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 only) .PARAMETER IDFX Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 only) .PARAMETER Sync Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER AppFabric Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER IDFX11 Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER MSIPCClient Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER WCFDataServices Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 only) .PARAMETER KB2671763 Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 only) .PARAMETER WCFDataServices56 Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2013 and SP2016) .PARAMETER MSVCRT11 Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2016 only) .PARAMETER MSVCRT14 Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2016 only) .PARAMETER KB3092423 Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2016 only) .PARAMETER ODBC Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2016 only) .PARAMETER DotNetFx Write - String - The path to the installer for this prerequisite + The path to the installer for this prerequisite (SP2016 only) .PARAMETER Ensure Write - string @@ -179,3 +189,39 @@ } +.EXAMPLE + This module will install the prerequisites for SharePoint 2016. 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 InstallPrerequisites + { + 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" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt index 2cb9a9b88..2a98ad3e9 100644 --- a/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt @@ -3,16 +3,8 @@ # Description - WARNING: This resource is deprecated. Please use SPFarm instead as - this resource will be removed from version 2.0 of SharePointDsc - - This resource will be responsible for joining a server to an existing - SharePoint farm. To create a new farm use the SPCreateFarm resource on a - different server to begin with, and then pass the same database server and - configuration database name parameters to the additional servers using this - resource. After the server has joined the farm, the process will wait for 5 - minutes to allow farm specific configuration to take place on the server, - before allowing further DSC configuration to take place. + WARNING: This resource has been removed. Please use SPFarm instead. + See http://aka.ms/SPDsc-SPFarm for details. .PARAMETER FarmConfigDatabaseName Key - string @@ -36,63 +28,3 @@ POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 -.EXAMPLE - This example shows how to join an existing SharePoint farm. - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPJoinFarm JoinFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - Passphrase = $Passphrase - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to join an existing SharePoint farm using a specific - server role (applies to SharePoint 2016 only). - - - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $Passphrase - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPJoinFarm JoinFarm - { - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - FarmConfigDatabaseName = "SP_Config" - ServerRole = "WebFrontEnd" - Passphrase = $Passphrase - PsDscRunAsCredential = $SetupAccount - } - } - } - - diff --git a/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt b/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt new file mode 100644 index 000000000..38a07ab28 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt @@ -0,0 +1,122 @@ +.NAME + SPLogLevel + +# Description + + This resource is used to change the minimum severity of events captured in + the trace logs (ULS logs) and the Windows event logs. Settings can be changed + globally for all areas and categories (using the '*' character as the + wildcard), for all categories within an area, and for specific categories + within an area. Settings can be changed to desired valid values, or set to the + default by using the keyword 'Default' as the trace level and event level. + You must specify a unique name for each instance of this resource in a configuration. + +.PARAMETER Name + Key - String + Friendly Name used to reference this collection of log level settings + +.PARAMETER SPLogLevelSetting + Required - String + Collection of SPLogLevelItems to 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 an Area / Category item to a custom value. + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPLogLevel SetUserProfileLogingtoVerbose + { + Name = "SP_Database-Verbose" + SPLogLevelSetting = @( + MSFT_SPLogLevelItem { + Area = "SharePoint Server" + Name = "Database" + TraceLevel = "Verbose" + EventLevel = "Verbose" + } + ) + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example sets an entire Area to the default values + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPLogLevel SetAllSPServerToDefault + { + Name = "SPServer_defaults" + SPLogLevelSetting = @( + MSFT_SPLogLevelItem { + Area = "SharePoint Server" + Name = "*" + TraceLevel = "Default" + EventLevel = "Default" + } + ) + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example sets multiple items to custom values + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPLogLevel SetCustomValues + { + Name = "CustomLoggingSettings" + SPLogLevelSetting = @( + MSFT_SPLogLevelItem { + Area = "SharePoint Server" + Name = "Database" + TraceLevel = "Verbose" + EventLevel = "Verbose" + } + MSFT_SPLogLevelItem { + Area = "Business Connectivity Services" + Name = "Business Data" + TraceLevel = "Unexpected" + EventLevel = "Error" + } + ) + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt new file mode 100644 index 000000000..49d9aaf11 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt @@ -0,0 +1,99 @@ +.NAME + SPMachineTranslationServiceApp + +# Description + + This resource is used to provision and manage an instance of the Machine + Translation Service Application. It will identify an instance of the MT + 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. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - String + Specifies the name of the service application. + +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + +.PARAMETER DatabaseName + Required - String + Specifies the name of the database for the service application. + +.PARAMETER DatabaseServer + Required - String + Specifies the name of the database server for the service application. + +.PARAMETER ApplicationPool + Required - String + Specifies the application pool to use with the service application. + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy the SP Machine Translation Service App to the local SharePoint farm. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPMachineTranslationServiceApp MachineTranslationServiceApp + { + Name = "Translation Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "Translation" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example shows how to remove the SP Machine Translation Service App to the local SharePoint farm. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPMachineTranslationServiceApp MachineTranslationServiceApp + { + Name = "Translation Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "Translation" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt index de3fc3233..f19624695 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt @@ -8,10 +8,16 @@ back to this pool if it is changed after its initial provisioning. The database server and database name properties are only used during provisioning, and will not be altered as part of the ongoing operation of the + set method. The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned. + The content type hub url will be set or reset. + + The language settings (default and working) are only changed if they are part of + the bound parameters. Otherwise they will not be altered. + .PARAMETER Name Key - string The name of the managed metadata service application @@ -45,6 +51,14 @@ Write - string The URL of the content type hub for this app (only set when the app is provisioned) +.PARAMETER DefaultLanguage + Write - UInt32 + The LCID of the default language (only set when the app is provisioned) + +.PARAMETER Languages + Write - UInt32 + The LCIDs of the working languages (only set when the app is provisioned) + .PARAMETER InstallAccount Write - String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 @@ -65,7 +79,7 @@ node localhost { SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { + { Name = "Managed Metadata Service Application" InstallAccount = $SetupAccount ApplicationPool = "SharePoint Service Applications" @@ -95,7 +109,7 @@ node localhost { SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { + { Name = "Managed Metadata Service Application" InstallAccount = $SetupAccount ApplicationPool = "none" @@ -110,7 +124,7 @@ and also include a specific list of users to be the term store administrators. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -121,7 +135,7 @@ node localhost { SPManagedMetaDataServiceApp ManagedMetadataServiceApp - { + { Name = "Managed Metadata Service Application" InstallAccount = $SetupAccount ApplicationPool = "SharePoint Service Applications" @@ -136,3 +150,64 @@ } +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm + and also include a specific list of users to be the term store administrators. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "SP_ManagedMetadata" + TermStoreAdministrators = @( + "CONTOSO\user1", + "CONTOSO\user2" + ) + DefaultLanguage = 1033 + Languages = @(1031, 1033) + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm + and also include a specific list of users to be the term store administrators. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + PSDscRunAsCredential = $SetupAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = "SQL.contoso.local" + DatabaseName = "SP_ManagedMetadata" + ContentTypeHubUrl = "http://contoso.sharepoint.com/sites/ct" + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt new file mode 100644 index 000000000..abdc6a780 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt @@ -0,0 +1,56 @@ +.NAME + SPManagedMetaDataServiceAppDefault + +# Description + + Using several managed metadata service instances in a farm requires some + configuration, which service application proxy should be used as default + for keywords or site collection specific term sets. + + This setting has to be configured in conjunction with the SPManagedMetadataServiceApp + resource. This resource allows to specify which managed metadata service application + proxy should be used as default for these two settings. + +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + +.PARAMETER DefaultSiteCollectionProxyName + Required - String + The name of the managed metadata service application proxy used as default column terms set + +.PARAMETER DefaultKeywordProxyName + Required - String + The name of the managed metadata service application proxy used as default keyword terms set + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to deploy the Managed Metadata service app to the local SharePoint farm. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPManagedMetaDataServiceAppDefault ManagedMetadataServiceAppDefault + { + IsSingleInstance = "Yes" + DefaultSiteCollectionProxyName = "Managed Metadata Service Application Proxy" + DefaultKeywordProxyName = "Managed Metadata Service Application Proxy" + InstallAccount = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt b/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt new file mode 100644 index 000000000..ce973c212 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt @@ -0,0 +1,44 @@ +.NAME + SPMinRoleCompliance + +# Description + + This resource will help manage compliance of MinRole based servers. Each time + the resource runs it will investigate which service instances should be running + based on the role of servers anywhere in the farm, and if they are not in a + compliant state it will tell SharePoint to create timer jobs to make the + necesssary modifications to make the farm compliant again. + +.PARAMETER State + Key - string + Allowed values: Compliant, NonCompliant + Should the state be set to compliant + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to ensure the farm is always compliant with MinRole settings + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPMinRoleCompliance MinRoleCompliance + { + State = "Compliant" + PSDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt index b09350b20..9e4cf8da6 100644 --- a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt @@ -59,7 +59,7 @@ node localhost { SPOutgoingEmailSettings FarmWideEmailSettings - { + { WebAppUrl = "http://sharepoint1:2013" SMTPServer = "smtp.contoso.com" FromAddress = "sharepoint`@contoso.com" @@ -86,7 +86,7 @@ node localhost { SPOutgoingEmailSettings FarmWideEmailSettings - { + { WebAppUrl = "http://site.contoso.com" SMTPServer = "smtp.contoso.com" FromAddress = "sharepoint`@contoso.com" diff --git a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt index 5a4e04213..e10906845 100644 --- a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt @@ -45,7 +45,7 @@ node localhost { SPPasswordChangeSettings ManagedAccountPasswordResetSettings - { + { MailAddress = "sharepoint`@contoso.com" DaysBeforeExpiry = "14" PasswordChangeWaitTimeSeconds = "60" diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt new file mode 100644 index 000000000..13a809f3a --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt @@ -0,0 +1,96 @@ +.NAME + SPProjectServerADResourcePoolSync + +# Description + + This resource is used to control the settings of the Active Directory + resource pool sync for Project Server, for a specific PWA instance. + You can control which AD groups should be imported from and control + settings about reactivitating users. + + Note: The schedule for this import is controlled via a standard + SharePoint server timer job, and as such it can be controlled with + the SPTimerJobState resource. Below is an example of how to set + this resource to run the AD import job daily. The name of the job + here may change if you have multiple Project Server service apps + in the same farm. + + SPTimerJobState RunProjectSeverADImport + { + Name = "ActiveDirectorySync" + Enabled = $true + Schedule = "daily between 03:00:00 and 03:00:00" + PsDscRunAsCredential = $SetupAccount + } + +.PARAMETER Url + Key - string + The default zone URL of the Project site to set permissions for + +.PARAMETER GroupNames + Write - string + The names of groups in the current domain to sync resources from + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Should the resource sync process be present or absent for this site? + +.PARAMETER AutoReactivateUsers + Write - boolean + Should inactive users found in sync be automatically reactiviated? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example enables Project Server AD resource pool sync + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerADResourcePoolSync EnableSync + { + Ensure = "Present" + Url = "http://projects.contoso.com/pwa" + GroupNames = @("DOMAIN\Group 1", "DOMAIN\Group 2") + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example disables Project Server AD resource pool sync + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerADResourcePoolSync EnableSync + { + Ensure = "Absent" + Url = "http://projects.contoso.com/pwa" + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt new file mode 100644 index 000000000..e02d683e2 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt @@ -0,0 +1,55 @@ +.NAME + SPProjectServerAdditionalSettings + +# Description + + This resource is used to manage the "additional settings" for a PWA instance + (based on what is in the 'additional settings' page of the web interface). + +.PARAMETER Url + Key - string + The default zone URL of the Project site to manage settings at + +.PARAMETER ProjectProfessionalMinBuildNumber + Write - string + What is the minimum build number for the Project Professional client that can connect? + +.PARAMETER ServerCurrency + Write - string + What is the default server currency? + +.PARAMETER EnforceServerCurrency + Write - boolean + Should all projects be forced to use the server currency? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply additional settings to the PWA site + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerAdditionalSettings Settings + { + Url = "http://projects.contoso.com/pwa" + ServerCurrency = "AUD" + EnforceServerCurrency = $true + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt new file mode 100644 index 000000000..59c0931ea --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt @@ -0,0 +1,154 @@ +.NAME + SPProjectServerGlobalPermissions + +# Description + + This resource allows you to enforce global permissions in a PWA site for a + specific project server group or an individual resource. + +.PARAMETER Url + Key - string + The default zone URL of the Project site to manage the group at + +.PARAMETER EntityName + Key - string + The name of the user or group + +.PARAMETER EntityType + Key - string + Allowed values: User, Group + What type of entity are you setting permissions for? + +.PARAMETER AllowPermissions + Write - string + What permissions should be allowed for this entity? + +.PARAMETER DenyPermissions + Write - string + What permissions should be denied for this entity? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to set permissions for a specific resource in a PWA site + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerGlobalPermissions Permissions + { + Url = "http://projects.contoso.com" + EntityName = "Domain\user" + EntityType = "User" + AllowPermissions = @( + "LogOn", + "NewTaskAssignment", + "AccessProjectDataService", + "ReassignTask", + "ManagePortfolioAnalyses", + "ManageUsersAndGroups", + "ManageWorkflow", + "ManageCheckIns", + "ManageGanttChartAndGroupingFormats", + "ManageEnterpriseCustomFields", + "ManageSecurity", + "ManageEnterpriseCalendars", + "ManageCubeBuildingService", + "CleanupProjectServerDatabase", + "SaveEnterpriseGlobal", + "ManageWindowsSharePointServices", + "ManagePrioritizations", + "ManageViews", + "ContributeToProjectWebAccess", + "ManageQueue", + "LogOnToProjectServerFromProjectProfessional", + "ManageDrivers", + "ManagePersonalNotifications", + "ManageServerConfiguration", + "ChangeWorkflow", + "ManageActiveDirectorySettings", + "ManageServerEvents", + "ManageSiteWideExchangeSync", + "ManageListsInProjectWebAccess" + ) + DenyPermissions = @( + "NewProject" + ) + PSDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example shows how to set permissions for a specific group that exists in a PWA site + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerGlobalPermissions Permissions + { + Url = "http://projects.contoso.com" + EntityName = "Group Name" + EntityType = "Group" + AllowPermissions = @( + "LogOn", + "NewTaskAssignment", + "AccessProjectDataService", + "ReassignTask", + "ManagePortfolioAnalyses", + "ManageUsersAndGroups", + "ManageWorkflow", + "ManageCheckIns", + "ManageGanttChartAndGroupingFormats", + "ManageEnterpriseCustomFields", + "ManageSecurity", + "ManageEnterpriseCalendars", + "ManageCubeBuildingService", + "CleanupProjectServerDatabase", + "SaveEnterpriseGlobal", + "ManageWindowsSharePointServices", + "ManagePrioritizations", + "ManageViews", + "ContributeToProjectWebAccess", + "ManageQueue", + "LogOnToProjectServerFromProjectProfessional", + "ManageDrivers", + "ManagePersonalNotifications", + "ManageServerConfiguration", + "ChangeWorkflow", + "ManageActiveDirectorySettings", + "ManageServerEvents", + "ManageSiteWideExchangeSync", + "ManageListsInProjectWebAccess" + ) + DenyPermissions = @( + "NewProject" + ) + PSDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt new file mode 100644 index 000000000..c030fcb3c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt @@ -0,0 +1,102 @@ +.NAME + SPProjectServerGroup + +# Description + + This resource is used to configure a group within Project Server. This is only + available for use when the site is configured to use Project Server permissions + mode and for Project Server 2016 only. + +.PARAMETER Url + Key - string + The default zone URL of the Project site to manage the group at + +.PARAMETER Name + Key - string + The name of the group + +.PARAMETER Description + Write - string + The description of the group + +.PARAMETER ADGroup + Write - string + What AD group should be used to synchronise membership to this Project Server group, cannot be used with Members, MembersToInclude or MembersToExclude + +.PARAMETER Members + Write - string + A fixed list of members to be in this group, cannot be used with ADGroup, MembersToInclude or MembersToExclude + +.PARAMETER MembersToInclude + Write - string + A list of members to ensure are in this group, cannot be used with ADGroup or Members + +.PARAMETER MembersToExclude + Write - string + A list of members to ensure are not in this group, cannot be used with ADGroup or Members + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example shows how to create a group with a specific list of members in a PWA site + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerGroup Group + { + Url = "http://projects.contoso.com" + Name = "My group" + Members = @( + "Domain\User1" + "Domain\User2" + ) + PSDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example shows how to create a PWA group mapped to a group in AD + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerGroup Group + { + Url = "http://projects.contoso.com" + Name = "My group" + ADGroup = "Domain\Group" + PSDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt new file mode 100644 index 000000000..153c3aaf4 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt @@ -0,0 +1,69 @@ +.NAME + SPProjectServerLicense + +# Description + + This resource is used to enable a Project Server license in to a SharePoint + 2016 farm. + +.PARAMETER Ensure + Key - string + Allowed values: Present, Absent + Should a Project Server license be enabled or disabled + +.PARAMETER ProductKey + Write - string + What is the product key for Project Server + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example enables Project Server in the current environment + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerLicense ProjectLicense + { + Ensure = "Present" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example disables Project Server in the current environment + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerLicense ProjectLicense + { + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt new file mode 100644 index 000000000..45413e163 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt @@ -0,0 +1,71 @@ +.NAME + SPProjectServerPermissionMode + +# Description + + This resource allows you to set the permissions mode (either SharePoint or + ProjectServer) for a specific project server site. + +.PARAMETER Url + Key - string + The default zone URL of the Project site to set permissions for + +.PARAMETER PermissionMode + Required - string + Allowed values: SharePoint, ProjectServer + What permission mode should PWA use + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to a specific PWA site to use SharePoint permission mode. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerPermissionMode PermissionMode + { + Url = "http://projects.contoso.com" + PermissionMode = "SharePoint" + InstallAccount = $SetupAccount + } + } +} + + +.EXAMPLE + This example shows how to a specific PWA site to use Project server + permission mode. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerPermissionMode PermissionMode + { + Url = "http://projects.contoso.com" + PermissionMode = "ProjectServer" + InstallAccount = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt new file mode 100644 index 000000000..0e54a440b --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt @@ -0,0 +1,104 @@ +.NAME + SPProjectServerServiceApp + +# Description + + This resource is responsible for provisioning and managing the Project Server + service application in SharePoint Server 2016. + + To create a Project Server site the following DSC resources can + be used to create the site and enable the feature. + + SPSite PWASite + { + Url = "http://projects.contoso.com" + OwnerAlias = "CONTOSO\ExampleUser" + HostHeaderWebApplication = "http://spsites.contoso.com" + Name = "PWA Site" + Template = "PWA#0" + PsDscRunAsCredential = $SetupAccount + } + + SPFeature PWASiteFeature + { + Name = "PWASITE" + Url = "http://projects.contoso.com" + FeatureScope = "Site" + PsDscRunAsCredential = $SetupAccount + DependsOn = "[SPSite]PWASite" + } + +.PARAMETER Name + Key - string + The name of the service application + +.PARAMETER ApplicationPool + Required - string + The name of the application pool to run the service app in + +.PARAMETER ProxyName + Write - string + The name of the Project Server Service Application Proxy + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the service app 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 + + +.EXAMPLE + This example shows how to create a new project server services service app + in the local farm + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerServiceApp ProjectServiceApp + { + Name = "Project Server Service Application" + ApplicationPool = "SharePoint Web Services" + InstallAccount = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to remove a project server service app in the local farm. + The ApplicationPool property is still required but is not used when removing, so + the value used here doesn't matter. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPProjectServerServiceApp ProjectServiceApp + { + Name = "Project Server Service Application" + ApplicationPool = "n/a" + Ensure = "Absent" + InstallAccount = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt new file mode 100644 index 000000000..b30c3291c --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt @@ -0,0 +1,125 @@ +.NAME + SPProjectServerTimeSheetSettings + +# Description + + Allows you to configure the default timesheet settings for a specific PWA + instance. + +.PARAMETER Url + Key - string + The default zone URL of the Project site to set timesheet settings for + +.PARAMETER EnableOvertimeAndNonBillableTracking + Write - boolean + Should timesheets allow tracking of overtime and non-billable work types + +.PARAMETER DefaultTimesheetCreationMode + Write - string + Allowed values: CurrentTaskAssignments, CurrentProjects, NoPrepopulation + What is the default mode for timesheets to be created in + +.PARAMETER DefaultTrackingUnit + Write - string + Allowed values: Days, Weeks + What is the default tracking unit for timesheets + +.PARAMETER DefaultReportingUnit + Write - string + Allowed values: Hours, Days + What is the default reporting unit for timesheets + +.PARAMETER HoursInStandardDay + Write - Real32 + How many hours are in a standard timesheeet day? + +.PARAMETER HoursInStandardWeek + Write - Real32 + How many hours are in a standard timesheeet week? + +.PARAMETER MaxHoursPerTimesheet + Write - Real32 + Maximum hours per timesheet + +.PARAMETER MinHoursPerTimesheet + Write - Real32 + Minimum hours per timesheet + +.PARAMETER MaxHoursPerDay + Write - Real32 + Maximum hours per day + +.PARAMETER AllowFutureTimeReporting + Write - boolean + Allow future time reporting? + +.PARAMETER AllowNewPersonalTasks + Write - boolean + Allow new personal tasks? + +.PARAMETER AllowTopLevelTimeReporting + Write - boolean + Allow top-level time reporting? + +.PARAMETER RequireTaskStatusManagerApproval + Write - boolean + Require task status manager approval? + +.PARAMETER RequireLineApprovalBeforeTimesheetApproval + Write - boolean + Require line approval before timesheet approval? + +.PARAMETER EnableTimesheetAuditing + Write - boolean + Enable timesheet auditing? + +.PARAMETER FixedApprovalRouting + Write - boolean + Enable fixed approval routing? + +.PARAMETER SingleEntryMode + Write - boolean + Enable single entry mode? + +.PARAMETER DefaultTrackingMode + Write - string + Allowed values: PercentComplete, ActualDoneAndRemaining, HoursPerPeriod, FreeForm + What is the default tracking mode for tasks? + +.PARAMETER ForceTrackingModeForAllProjects + Write - boolean + Force project managers to use the specified tracking mode for each project? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example demonstrates how to apply timesheet settings to a specific + PWA instance + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerTimeSheetSettings ConfigureTimeSheets + { + Url = "http://projects.contoso.com/pwa" + HoursInStandardDay = 8 + HoursInStandardWeek = 40 + AllowFutureTimeReporting = $false + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt new file mode 100644 index 000000000..4390aa386 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt @@ -0,0 +1,56 @@ +.NAME + SPProjectServerUserSyncSettings + +# Description + + This resource is responsible for configuration of the user sync settings between + projects and project sites. + +.PARAMETER Url + Key - string + The default zone URL of the Project site to set user sync settings for + +.PARAMETER EnableProjectWebAppSync + Required - boolean + Enable Project Web App Sync + +.PARAMETER EnableProjectSiteSync + Required - boolean + Enable Project Site Sync + +.PARAMETER EnableProjectSiteSyncForSPTaskLists + Required - boolean + Enable Project Site Sync for SharePoint Task List Projects + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example demonstrates how to set user sync settings for a PWA site + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerUserSyncSettings UserSyncSettings + { + Url = "http://projects.contoso.com/pwa" + EnableProjectWebAppSync = $true + EnableProjectSiteSync = $true + EnableProjectSiteSyncForSPTaskLists = $true + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt new file mode 100644 index 000000000..efae83fc3 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt @@ -0,0 +1,52 @@ +.NAME + SPProjectServerWssSettings + +# Description + + This resource is used to control settings that relate to the SharePoint sites + that are linked to projects in Project Server. + + NOTE: The account you use to run this resource (through either the InstallAccount + or PsDscRunAsCredential properties) needs to have elevated rights to execute + this resource. It is recommended to use the SharePoint Farm Account for this + purpose to avoid receiving a "GeneralSecurityAccessDenied" error. + +.PARAMETER Url + Key - string + The default zone URL of the Project site to set WSS settings for + +.PARAMETER CreateProjectSiteMode + Required - string + Allowed values: AutoCreate, UserChoice, DontCreate + How should new SharePoint sites be created? + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example demonstrates how to set WSS settings for a PWA site + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPProjectServerWssSettings WssSettings + { + Url = "http://projects.contoso.com/pwa" + CreateProjectSiteMode = "AutoCreate" + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt index 8ec9b8521..8163fcefa 100644 --- a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt @@ -51,7 +51,7 @@ node localhost { SPPublishServiceApplication PublishManagedMetadataServiceApp - { + { Name = "Managed Metadata Service Application" Ensure = "Present" InstallAccount = $SetupAccount @@ -76,7 +76,7 @@ node localhost { SPPublishServiceApplication UnpublishSecureStoreServiceApp - { + { Name = "Secure Store Service Application" Ensure = "Absent" InstallAccount = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt index da63318da..1b0d8cdc8 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt @@ -92,13 +92,6 @@ Addresses = @("http://sharepointsite1.contoso.com", "http://sharepointsite2.contoso.com") CrawlSetting = "CrawlEverything" ContinuousCrawl = $true - IncrementalSchedule = MSFT_SPSearchCrawlSchedule { - ScheduleType = "Daily" - StartHour = "0" - StartMinute = "0" - CrawlScheduleRepeatDuration = "1440" - CrawlScheduleRepeatInterval = "5" - } FullSchedule = $null Priority = "Normal" Ensure = "Present" @@ -130,7 +123,6 @@ Addresses = @("http://www.contoso.com") CrawlSetting = "Custom" LimitPageDepth = 5 - LimitServerHops = 0 IncrementalSchedule = MSFT_SPSearchCrawlSchedule{ ScheduleType = "Daily" StartHour = "0" diff --git a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt index d2e2bf507..08e56ad36 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt @@ -75,7 +75,7 @@ node localhost { SPSearchServiceApp SearchServiceApp - { + { Name = "Search Service Application" DatabaseName = "SP_Search" ApplicationPool = "SharePoint Service Applications" @@ -101,7 +101,7 @@ node localhost { SPSearchServiceApp SearchServiceApp - { + { Name = "Search Service Application" Ensure = "Absent" ApplicationPool = "n/a" diff --git a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt index 7b415189f..0e548e5fb 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt @@ -13,9 +13,16 @@ first index partition will belong. This will behave the same as the SPSearchIndexPartition resource. + You only need to run the topology resource on a single server in the farm. + It will enable the components on each server in the farm, as specified in + the configuration. It is not required to also include SPServiceInstance as + the SPSearchTopology will make sure they are started when applying the + topology. However, it can be a good idea to include it so that the services + will be started later on if they are ever found to be stopped. + Note that for the search topology to apply correctly, the path specified for FirstPartitionDirectory needs to exist on the server that is executing this - resource. For example, if the below example was executed on "Server1" it would + resource. For example, if a configuration was executed on "Server1" it would also need to ensure that it was able to create the index path at I:\. If no disk labeled I: was available on server1, this would fail, even though it will not hold an actual index component. diff --git a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt new file mode 100644 index 000000000..a0c4ccdb2 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt @@ -0,0 +1,50 @@ +.NAME + SPServiceIdentity + +# Description + + This resource is used to specify a managed account to be used to run a service instance. + The name is the typename of the service as shown in the Central Admin website. + This resource only needs to be run on one server in the farm, as the process identity + update method will apply the settings to all instances of the service. + +.PARAMETER Name + Key - string + The name of the service instance to manage + +.PARAMETER ManagedAccount + Required - string + The user name of a managed account that will be used to run the service + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5 + + +.EXAMPLE + This example shows how to set the SandBox Code Service to run under a specifed service account. + The account must already be registered as a managed account. + + +Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + SPServiceIdentity SandBoxUserAccount + { + Name = "Microsoft SharePoint Foundation Sandboxed Code Service" + ManagedAccount = "CONTOSO\SPUserCode" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt index 0b2342092..5fd3ee114 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt @@ -40,7 +40,7 @@ node localhost { SPServiceInstance ManagedMetadataServiceInstance - { + { Name = "Managed Metadata Web Service" Ensure = "Present" InstallAccount = $SetupAccount @@ -65,7 +65,7 @@ node localhost { SPServiceInstance StopBCSServiceInstance - { + { Name = "Business Data Connectivity Service" Ensure = "Absent" InstallAccount = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt index 71eb6b65e..a6fef1af9 100644 --- a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt @@ -46,13 +46,13 @@ Write - String List of all accounts that are not allowed to have Shell Admin permissions -.PARAMETER ContentDatabases +.PARAMETER Databases Write - String - Shell Admin configuration of Content Databases + Shell Admin configuration of Databases -.PARAMETER AllContentDatabases +.PARAMETER AllDatabases Write - Boolean - Specify if all content databases must get the same config as the general config + Specify if all databases must get the same config as the general config .PARAMETER InstallAccount Write - String @@ -76,9 +76,9 @@ node localhost { SPShellAdmins ShellAdmins { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - AllContentDatabases = $true + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + AllDatabases = $true } } } @@ -101,14 +101,14 @@ node localhost { SPShellAdmins ShellAdmins { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - ContentDatabases = @( - @(MSFT_SPContentDatabasePermissions { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + Databases = @( + @(MSFT_SPDatabasePermissions { Name = "SharePoint_Content_1" Members = "CONTOSO\user2", "CONTOSO\user3" }) - @(MSFT_SPContentDatabasePermissions { + @(MSFT_SPDatabasePermissions { Name = "SharePoint_Content_2" Members = "CONTOSO\user3", "CONTOSO\user4" }) diff --git a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt index 98947110b..ad167064f 100644 --- a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt @@ -14,6 +14,10 @@ Key - string The name of the state service app +.PARAMETER ProxyName + Write - string + The proxy name, if not specified will be /Name of service app/ Proxy + .PARAMETER DatabaseCredentials Write - String The database credentials for accessing the database diff --git a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt index ea2f5011a..a338d8a43 100644 --- a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt @@ -19,17 +19,20 @@ - Monthly at 15 15:00:00 - Yearly at Jan 1 15:00:00 - NOTE: Make sure you use the internal timer job name, not the display name! Use - "Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayName" - to find the internal name for each Timer Job. + NOTE: Make sure you use the typename timer job name, not the display name! Use + "Get-SPTimerJob | Where-Object { $_.Title -eq "\" } | Select typename" + to find the typename for each Timer Job. -.PARAMETER Name + NOTE2: You cannot use SPTimerJobState to change the Health Analyzer jobs, because + these are configured to specific times by default. + +.PARAMETER TypeName Key - String - The internal name of the timer job (not the display name) + The type name of the timer job (not the display name) -.PARAMETER WebApplication - Write - String - The name of the web application that the timer job belongs to +.PARAMETER WebAppUrl + Key - String + The URL of the web application that the timer job belongs to, N/A if no web application is applicable .PARAMETER Enabled Write - Boolean @@ -58,13 +61,13 @@ Import-DscResource -ModuleName SharePointDsc node localhost { - SPTimerJobState DisableTimerJob_DeadSiteDelete + SPTimerJobState DisableTimerJob_AppServerJob { - Name = "job-dead-site-delete" - WebApplication = "http://sites.sharepoint.contoso.com" - Enabled = $false - Schedule ="weekly at sat 5:00" - PsDscRunAsCredential = $SetupAccount + TypeName = "Microsoft.Office.Server.Administration.ApplicationServerJob" + WebAppUrl = "http://sites.sharepoint.contoso.com" + Enabled = $false + Schedule ="weekly at sat 5:00" + PsDscRunAsCredential = $SetupAccount } } } diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt index 6b170b01b..3487d22cf 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt @@ -38,7 +38,7 @@ .PARAMETER Type Write - string - Allowed values: BigInteger, Binary, Boolean, Date, DateNoYear, DateTime, Email, Float, Guid, HTML, Integer, Person, String, StringMultiValue, TimeZone, URL + Allowed values: Big Integer, Binary, Boolean, Date, DateNoYear, Date Time, Email, Float, HTML, Integer, Person, String (Single Value), String (Multi Value), TimeZone, Unique Identifier, URL The type of the property .PARAMETER Description diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt index 4aa51ed58..d998fc2e2 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt @@ -5,11 +5,11 @@ This resource will provision an instance of the user profile service to the farm. It creates the required databases using the parameters that are passed - in to it (although these are only used during the initial provisioning). The - farm account is used during the provisioning of the service only (in the set - method), and the install account is used in the get and test methods. This is - done to ensure that the databases are created with the correct schema owners - and allow the user profile sync service to operate correctly. + in to it (although these are only used during the initial provisioning). + + The specified InstallAccount or PSDSCRunAsCredential has to be the Farm Account. + This is done to ensure that the databases are created with the correct schema + owners and allow the user profile sync service to operate correctly. The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned. @@ -26,10 +26,6 @@ Required - string The name of the application pool to run the service app in -.PARAMETER FarmAccount - Write - String - The farm account to use when provisioning the app - .PARAMETER MySiteHostLocation Write - string The URL of the my site host collection @@ -85,11 +81,7 @@ param( [Parameter(Mandatory = $true)] [PSCredential] - $SetupAccount, - - [Parameter(Mandatory = $true)] - [PSCredential] - $FarmAccount + $SetupAccount ) Import-DscResource -ModuleName SharePointDsc @@ -106,7 +98,6 @@ SyncDBName = "SP_ProfileSync" SyncDBServer = "SQL.contoso.local\SQLINSTANCE" EnableNetBIOS = $false - FarmAccount = $FarmAccount PsDscRunAsCredential = $SetupAccount } } @@ -144,7 +135,6 @@ SyncDBServer = "SQL.contoso.local\SQLINSTANCE" EnableNetBIOS = $false NoILMUsed = $true - FarmAccount = $FarmAccount PsDscRunAsCredential = $SetupAccount } } diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt index 8b4409e0a..276369eda 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt @@ -3,8 +3,8 @@ # Description - This resource will ensure a specifc user profile sync connection is in place - and that it is configured accordingly to its definition + This resource will ensure a specifc user profile sync connection + is in place and that it is configured accordingly to its definition This resource currently supports AD only. diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt index 209cf882b..6138b4966 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt @@ -5,14 +5,17 @@ This resource is responsible for ensuring that the user profile sync service has been provisioned (Ensure = "Present") or is not running (Ensure = - "Absent") on the current server. This resource uses the InstallAccount to - validate the current state only, the set method which will do the provisioning - uses the FarmAccount to do the actual work - this means that CredSSP - authentication will need to be permitted to allow a connection to the local - server. To allow successful provisioning the farm account must be in the local + "Absent") on the current server. + + This resource requires that the FarmAccount is specified as the InstallAccount + or PsDscRunAsCredential parameter. It will throw an exception if this is not + the case. + + To allow successful provisioning the farm account must be in the local administrators group, however it is not best practice to leave this account in the Administrators group. Therefore this resource will add the FarmAccount - credential to the local administrators group at the beginning of the set + credential to the local administrators group at the beginning of the set method + and remove it again later on. The default value for the Ensure parameter is Present. When not specifying this parameter, the user profile sync service is provisioned. @@ -58,7 +61,7 @@ node localhost { SPUserProfileSyncService UserProfileSyncService - { + { UserProfileServiceAppName = "User Profile Service Application" Ensure = "Present" FarmAccount = $FarmAccount diff --git a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt index 79e332fab..6f48b73f4 100644 --- a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt @@ -50,6 +50,10 @@ Write - Boolean True if the web should be added to the top nav bar of the parent web, otherwise false. +.PARAMETER RequestAccessEmail + Write - string + The e-mail address to which requests for access are sent. Set to emtpy string to disable access requests. + .PARAMETER InstallAccount Write - String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 @@ -84,3 +88,66 @@ } +.EXAMPLE + This example deploys a subsite in a specific location and enables + access requests for this web + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWeb TeamSite + { + Url = "http://sharepoint.contoso.com/sites/site/subweb" + Name = "Team Sites" + Ensure = "Present" + Description = "A place to share documents with your team." + Template = "STS#0" + Language = 1033 + AddToTopNav = $true + UniquePermissions = $true + RequestAccessEmail = "sample@contoso.com" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example deploys a subsite in a specific location and disables + access requests for this web + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWeb TeamSite + { + Url = "http://sharepoint.contoso.com/sites/site/subweb" + Name = "Team Sites" + Ensure = "Present" + Description = "A place to share documents with your team." + Template = "STS#0" + Language = 1033 + AddToTopNav = $true + RequestAccessEmail = "" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt new file mode 100644 index 000000000..1f2ef6aab --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt @@ -0,0 +1,149 @@ +.NAME + SPWebAppAuthentication + +# Description + + This resource is responsible for configuring the authentication on a web + application within the local SharePoint farm. The resource is able to + configure the five available zones (if they exist) separately and each + zone can have multiple authentication methods configured. + + NOTE: This resource cannot be used to convert a Classic web application + to Claims mode. You have to run Convert-SPWebApplication manually for that. + + NOTE 2: Updating the configuration can take a long time, up to five minutes. + The Set-SPWebApplication cmdlet sometimes requires several minutes to + complete its action. This is not a SharePointDsc issue. + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER Default + Write - string + Specifies the authentication for the Default zone. + +.PARAMETER Intranet + Write - string + Specifies the authentication for the Intranet zone. + +.PARAMETER Internet + Write - string + Specifies the authentication for the Internet zone. + +.PARAMETER Extranet + Write - string + Specifies the authentication for the Extranet zone. + +.PARAMETER Custom + Write - string + Specifies the authentication for the Custom zone. + +.PARAMETER InstallAccount + Write - string + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the authentication of a web application in the local farm using a custom + claim provider. A SPTrustedIdentityTokenIssuer is created named Contoso, then this SPTrustedIdentityTokenIssuer + is referenced by the SPWebAppAuthentication as the AuthenticationProvider and the AuthenticationMethod is set + to "Federated" value. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + SPWebAppAuthentication ContosoAuthentication + { + WebAppUrl = "http://sharepoint.contoso.com" + Default = @( + MSFT_SPWebAppAuthenticationMode { + AuthenticationMethod = "NTLM" + } + ) + Extranet = @( + MSFT_SPWebAppAuthenticationMode { + AuthenticationMethod = "FBA" + MembershipProvider = "MemberPRovider" + RoleProvider = "RoleProvider" + } + ) + } + } + } + + +.EXAMPLE + This example shows how to configure the authentication of a web application in the local farm using a custom + claim provider. A SPTrustedIdentityTokenIssuer is created named Contoso, then this SPTrustedIdentityTokenIssuer + is referenced by the SPWebAppAuthentication as the AuthenticationProvider and the AuthenticationMethod is set + to "Federated" value. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + + SPTrustedIdentityTokenIssuer SampleSPTrust + { + Name = "Contoso" + Description = "Contoso" + Realm = "https://sharepoint.contoso.com" + SignInUrl = "https://adfs.contoso.com/adfs/ls/" + IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + ClaimsMappings = @( + MSFT_SPClaimTypeMapping{ + Name = "Email" + IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" + } + MSFT_SPClaimTypeMapping{ + Name = "Role" + IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + } + ) + SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" + ClaimProviderName = "LDAPCP" + ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + + + SPWebAppAuthentication ContosoAuthentication + { + WebAppUrl = "http://sharepoint.contoso.com" + Default = @( + MSFT_SPWebAppAuthenticationMode { + AuthenticationMethod = "NTLM" + } + ) + Internet = @( + MSFT_SPWebAppAuthenticationMode { + AuthenticationMethod = "Federated" + AuthenticationProvider = "Contoso" + } + ) + DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt index 68659ed15..5daef7cce 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt @@ -90,6 +90,10 @@ Write - boolean Is Skype for Business presence enabled for this web app +.PARAMETER DefaultQuotaTemplate + Write - string + What is the default quota template for this web app + .PARAMETER InstallAccount Write - string POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt new file mode 100644 index 000000000..9a26150ca --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt @@ -0,0 +1,85 @@ +.NAME + SPWebAppPeoplePickerSettings + +# Description + + This resource is used to configure the People Picker settings for a web + application. + + NOTE: + If the forest or domain on which SharePoint is installed has a one-way + trust with another forest or domain, you must first set the credentials + for an account that can authenticate with the forest or domain to be + queried before you can configure the SearchActiveDirectoryDomains. + + The encryption key must be set on every front-end web server in the farm + on which SharePoint is installed: + https://technet.microsoft.com/en-us/library/gg602075(v=office.15).aspx#section3 + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER ActiveDirectoryCustomFilter + Write - String + Sets a customized query filter to send to Active Directory + +.PARAMETER ActiveDirectoryCustomQuery + Write - String + Sets the custom query that is sent to Active Directory + +.PARAMETER ActiveDirectorySearchTimeout + Write - Uint16 + Sets the time-out in seconds when a query is issued to Active Directory + +.PARAMETER OnlySearchWithinSiteCollection + Write - Boolean + Specifies whether to search only the current site collection + +.PARAMETER SearchActiveDirectoryDomains + Write - String + List of all domains/forests that must be searched + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the people picker settings on the specified web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $AccessAccount, + + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppPeoplePickerSettings ConfigurePeoplePicker + { + WebAppUrl = "http://sharepoint.contoso.com" + ActiveDirectoryCustomFilter = $null + ActiveDirectoryCustomQuery = $null + ActiveDirectorySearchTimeout = 30 + OnlySearchWithinSiteCollection = $false + SearchActiveDirectoryDomains = @( + MSFT_SPWebAppPPSearchDomain { + FQDN = "contoso.com" + IsForest = $false + AccessAccount = $AccessAccount + } + ) + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt index 2ef086db4..34dbcb74e 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt @@ -34,10 +34,10 @@ .EXAMPLE - This example shows how to apply site use and deletion settings to the specified web applicaiton + This example shows how to apply site use and deletion settings to the specified web application - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt new file mode 100644 index 000000000..84140d108 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt @@ -0,0 +1,98 @@ +.NAME + SPWebAppSuiteBar + +# Description + + This resource is used to set the Suite Bar branding for web + applications. It supports both the SharePoint 2013 and SharePoint + 2016 ways of branding the suite bar. + + Requirements: + For SharePoint 2013, only the SuiteBarBrandingElementHtml + should be specified, whereas for SharePoint 2016, only one + or all of SuiteNavBrandingLogoNavigationUrl, + SuiteNavBrandingLogoTitle, SuiteNavBrandingLogoUrl or + SuiteNavBrandingText should be. + +.PARAMETER WebAppUrl + Key - string + The URL of the web application + +.PARAMETER SuiteNavBrandingLogoNavigationUrl + Write - String + SP2016+: Url to take the users to when the suite bar logo is clicked + +.PARAMETER SuiteNavBrandingLogoTitle + Write - String + SP2016+: Alternative text for the Suite Bar Logo + +.PARAMETER SuiteNavBrandingLogoUrl + Write - String + SP2016+: URL of the logo for the Suite Bar + +.PARAMETER SuiteNavBrandingText + Write - String + SP2016+: Text to display at the left hand side of the suite bar + +.PARAMETER SuiteBarBrandingElementHtml + Write - String + SP2013: HTML to inject in the left hand-side of the Suite Bar + +.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 branding for the suite bar of a given + Web Application in SharePoint 2016. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppSuiteBar SP2016Branding + { + WebAppUrl = "https://intranet.sharepoint.contoso.com" + SuiteNavBrandingLogoNavigationUrl = "http://sites.sharepoint.com" + SuiteNavBrandingLogoTitle = "This is my logo" + SuiteNavBrandingLogoUrl = "http://sites.sharepoint.com/images/logo.gif" + SuiteNavBrandingText = "SharePointDSC WebApp" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example sets the branding for the suite bar of a given + Web Application in SharePoint 2013. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWebAppSuiteBar SP2013Branding + { + WebAppUrl = "https://intranet.sharepoint.contoso.com" + SuiteBarBrandingElementHtml = "
SharePointDSC WebApp
" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt index 42d76ab7f..793e1fb2d 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt @@ -6,7 +6,7 @@ This resource is responsible for creating a web application within the local SharePoint farm. The resource will provision the web application with all of the current settings, and then ensure that it stays part of the correct - application pool beyond that (additional checking and setting of properties + application pool beyond that (additional checking and setting of properties) The default value for the Ensure parameter is Present. When not specifying this parameter, the web application is provisioned. @@ -38,14 +38,9 @@ Write - boolean Should anonymous access be enabled for this web app -.PARAMETER AuthenticationMethod - Write - string - Allowed values: NTLM, Kerberos, Claims, Classic - What authentication mode should be used for the web app - -.PARAMETER AuthenticationProvider - Write - string - What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims +.PARAMETER UseClassic + Write - boolean + Create the web application with Classic authentication (only used during creation of a new web application) .PARAMETER DatabaseName Write - string @@ -67,10 +62,6 @@ Write - string The port to run the site on -.PARAMETER UseSSL - Write - boolean - Should this web app use SSL - .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -85,41 +76,7 @@ This example shows how to create a new web application in the local farm - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPWebApplication HostNameSiteCollectionWebApp - { - Name = "SharePoint Sites" - ApplicationPool = "SharePoint Sites" - ApplicationPoolAccount = "CONTOSO\svcSPWebApp" - AllowAnonymous = $false - AuthenticationMethod = "NTLM" - DatabaseName = "SP_Content_01" - DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - Url = "http://example.contoso.local" - Port = 80 - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - } - } - - -.EXAMPLE - This example shows how to create a new web application in the local farm using a custom claim provider. - A SPTrustedIdentityTokenIssuer is created named Contoso, then this SPTrustedIdentityTokenIssuer is referenced - by the SPWebApplication as the AuthenticationProvider and the AuthenticationMethod is set to "Claims" value. - - - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -129,49 +86,18 @@ Import-DscResource -ModuleName SharePointDsc node localhost { - - - SPTrustedIdentityTokenIssuer SampleSPTrust - { - Name = "Contoso" - Description = "Contoso" - Realm = "https://sharepoint.contoso.com" - SignInUrl = "https://adfs.contoso.com/adfs/ls/" - IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - ClaimsMappings = @( - MSFT_SPClaimTypeMapping{ - Name = "Email" - IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" - } - MSFT_SPClaimTypeMapping{ - Name = "Role" - IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" - LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" - } - ) - SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" - ClaimProviderName = "LDAPCP" - ProviderSignOutUri = "https://adfs.contoso.com/adfs/ls/" - Ensure = "Present" - PsDscRunAsCredential = $SetupAccount - } - - SPWebApplication HostNameSiteCollectionWebApp { Name = "SharePoint Sites" ApplicationPool = "SharePoint Sites" ApplicationPoolAccount = "CONTOSO\svcSPWebApp" AllowAnonymous = $false - AuthenticationMethod = "Claims" - AuthenticationProvider = "Contoso" DatabaseName = "SP_Content_01" DatabaseServer = "SQL.contoso.local\SQLINSTANCE" Url = "http://example.contoso.local" Port = 80 Ensure = "Present" PsDscRunAsCredential = $SetupAccount - DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" } } } diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt index 461b6a58c..d0da31624 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt @@ -31,15 +31,6 @@ Write - boolean Should anonymous access be enabled for this web app extension -.PARAMETER AuthenticationMethod - Write - string - Allowed values: NTLM, Kerberos, Claims - What authentication mode should be used for the web app extension - -.PARAMETER AuthenticationProvider - Write - string - What authentication provider should be used for the web app. This value is required when AuthenticationMethod is set to Claims - .PARAMETER HostHeader Write - string The host header to use for the web app extension @@ -70,7 +61,7 @@ This example shows how to create a new web application extension in the local farm - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -85,7 +76,6 @@ WebAppUrl = "http://example.contoso.local" Name = "Contoso Intranet Zone" AllowAnonymous = $false - AuthenticationMethod = "NTLM" Url = "http://intranet.contoso.local" Zone = "Intranet" HostHeader = "intranet.contoso.local" diff --git a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt index 4f031c8e7..665b56e53 100644 --- a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt @@ -110,7 +110,7 @@ node localhost { SPWordAutomationServiceApp WordAutomation - { + { Name = "Word Automation Service Application" Ensure = "Present" ApplicationPool = "SharePoint Web Services" @@ -150,7 +150,7 @@ node localhost { SPWordAutomationServiceApp WordAutomation - { + { Name = "Word Automation Service Application" Ensure = "Absent" PsDscRunAsCredential = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt new file mode 100644 index 000000000..56c9ff360 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt @@ -0,0 +1,54 @@ +.NAME + SPWorkflowService + +# Description + + This resource is used to register the SharePoint Server + against a Workflow Manager Instance. + + Requirements: + Provide the url of the Workflow Manager instance to + connect to. + +.PARAMETER WorkflowHostUri + Key - string + The URL of the Workflow Service + +.PARAMETER SPSiteUrl + Key - String + The URL of the Site Collection to associate with the Workflow Service Proxy + +.PARAMETER AllowOAuthHttp + Write - Boolean + Specify whether or not to allow connection to the Workflow Service over Http + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example registers the workflow service over http. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPWorkflowService WorkflowService + { + WorkflowHostUri = "http://workflow.sharepoint.contoso.com" + SPSiteUrl = "http://sites.sharepoint.com" + AllowOAuthHttp = $true + PsDscRunAsCredential = $SetupAccount + } + } + } + + From 80c26852e8bb6b5aab4e87a707ed4251bbedcd04 Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Wed, 7 Feb 2018 14:05:45 +0100 Subject: [PATCH 16/18] Updated Help content --- .../en-US/about_SPAlternateUrl.help.txt | 6 + .../en-US/about_SPBlobCacheSettings.help.txt | 9 +- .../en-US/about_SPContentDatabase.help.txt | 10 +- .../about_SPDiagnosticsProvider.help.txt | 62 ++++++++++ ...bout_SPInfoPathFormsServiceConfig.help.txt | 107 ++++++++++++++++++ .../en-US/about_SPInstall.help.txt | 3 +- ...about_SPOfficeOnlineServerBinding.help.txt | 3 +- ...SPProjectServerADResourcePoolSync.help.txt | 3 +- .../about_SPProjectServerWssSettings.help.txt | 3 +- .../about_SPSearchAuthoritativePage.help.txt | 92 +++++++++++++++ .../en-US/about_SPSearchCrawlMapping.help.txt | 64 +++++++++++ .../about_SPSearchCrawlerImpactRule.help.txt | 42 +++++++ ...bout_SPSecurityTokenServiceConfig.help.txt | 66 +++++++++++ .../en-US/about_SPServiceIdentity.help.txt | 3 +- .../SharePointDsc/en-US/about_SPSite.help.txt | 3 +- .../en-US/about_SPTimerJobState.help.txt | 3 +- ...PUserProfileServiceAppPermissions.help.txt | 6 +- .../about_SPWebAppAuthentication.help.txt | 6 +- .../en-US/about_SPWebApplication.help.txt | 3 +- .../about_SPWorkManagementServiceApp.help.txt | 6 + 20 files changed, 478 insertions(+), 22 deletions(-) create mode 100644 Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt index 72e49de10..03d24fd59 100644 --- a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt @@ -8,6 +8,12 @@ application. Alternatively a URL can be removed from a zone to ensure that it will remain empty and have no alternate URL. + To select the Central Administration site, use the following command to retrieve + the correct web application name: + (Get-SPWebApplication -IncludeCentralAdministration | Where-Object { + $_.IsAdministrationWebApplication + }).DisplayName + The default value for the Ensure parameter is Present. When not specifying this parameter, the setting is configured. diff --git a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt index bc524e718..fb91f98c1 100644 --- a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt @@ -12,11 +12,10 @@ to configure all WFE servers in the farm, you have to apply this resource to all servers. - Note: - - - In order to prevent inconsistancy between different web front end servers, - make sure you configure this setting on all servers equally. - - If the specified folder does not exist, the resource will create the folder. + NOTE: + In order to prevent inconsistancy between different web front end servers, + make sure you configure this setting on all servers equally. + If the specified folder does not exist, the resource will create the folder. Best practice: Specify a directory that is not on the same drive as where either the server diff --git a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt index 1ef44784b..c0ca49d45 100644 --- a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt @@ -4,10 +4,12 @@ # Description This resource is used to add and remove Content Databases to web applications - and configure these databases. Note: The resource cannot be used to move the - database to a different SQL instance. It will throw an error when it detects - that the specified SQL instance is a different instance that is currently in - use. + and configure these databases. + + NOTE: + The resource cannot be used to move the database to a different SQL instance. + It will throw an error when it detects that the specified SQL instance is a + different instance that is currently in use. The default value for the Ensure parameter is Present. When not specifying this parameter, the content database is provisioned. diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt new file mode 100644 index 000000000..3db3722f9 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt @@ -0,0 +1,62 @@ +.NAME + SPDiagnosticsProvider + +# Description + + This resource is responsible for configuring the Diagnostics Provider within + the local SharePoint farm. Using Ensure equals to Absent is not supported. + This resource can only apply configuration, not ensure they don't exist. + +.PARAMETER Name + Key - string + Name of the Diagnostics Provider to configure + +.PARAMETER Retention + Write - Uint16 + Sets the retention period in days + +.PARAMETER MaxTotalSizeInBytes + Write - Uint64 + Sets the maximum retention size in bytes + +.PARAMETER Enabled + Write - Boolean + True enables the Diagnostics Provider + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present to configure the diagnostics provider + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the retention period for a Diagnostics Provider. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDiagnosticsProvider BlockingQueryProvider + { + Ensure = "Present" + Name = "job-diagnostics-blocking-query-provider" + MaxTotalSizeInBytes = 10000000000000 + Retention = 14 + Enabled = $true + PSDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt b/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt new file mode 100644 index 000000000..c8115f783 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt @@ -0,0 +1,107 @@ +.NAME + SPInfoPathFormsServiceConfig + +# Description + + This resource is responsible for configuring the InfoPath Forms service within + the local SharePoint farm. Using Ensure equals to Absent is not supported. + This resource can only apply configuration, not ensure they don't exist. + +.PARAMETER Ensure + Key - string + Allowed values: Present, Absent + Present ensures the settings are applied + +.PARAMETER AllowUserFormBrowserEnabling + Write - Boolean + True sets the InfoPath Forms Service to allow users to browse forms + +.PARAMETER AllowUserFormBrowserRendering + Write - Boolean + True sets the InfoPath Forms Service to render forms in the browser + +.PARAMETER MaxDataConnectionTimeout + Write - Uint32 + Sets the maximum connection timeout in milliseconds + +.PARAMETER DefaultDataConnectionTimeout + Write - Uint32 + Sets the default connection timeout in milliseconds + +.PARAMETER MaxDataConnectionResponseSize + Write - Uint32 + Sets the maximum response size in kb for the user response + +.PARAMETER RequireSslForDataConnections + Write - Boolean + True sets the InfoPath Forms Service to require SSL for its connections + +.PARAMETER AllowEmbeddedSqlForDataConnections + Write - Boolean + True sets the InfoPath Forms Service to allow embedded SQL sonnections in Forms + +.PARAMETER AllowUdcAuthenticationForDataConnections + Write - Boolean + True sets the InfoPath Forms Service to allow User Defined connections + +.PARAMETER AllowUserFormCrossDomainDataConnections + Write - Boolean + True sets the InfoPath Forms Service to allow Cross-Domain connections + +.PARAMETER MaxPostbacksPerSession + Write - Uint16 + Maximum number of postback allowed per session + +.PARAMETER MaxUserActionsPerPostback + Write - Uint16 + Maximum number of actions that can be triggered per postback + +.PARAMETER ActiveSessionsTimeout + Write - Uint16 + Timeout in minutes for active sessions + +.PARAMETER MaxSizeOfUserFormState + Write - Uint16 + Maximum size of user session data + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to configure the InfoPath Forms Service + in the local SharePoint farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPInfoPathFormsServiceConfig InfoPathFormsServiceConfig + { + Ensure = "Present" + AllowUserFormBrowserEnabling = $true + AllowUserFormBrowserRendering = $true + MaxDataConnectionTimeout = 20000 + DefaultDataConnectionTimeout = 10000 + MaxDataConnectionResponseSize = 1500 + RequireSslForDataConnections = $true + AllowEmbeddedSqlForDataConnections = $false + AllowUdcAuthenticationForDataConnections = $false + AllowUserFormCrossDomainDataConnections = $false + MaxPostbacksPerSession = 75 + MaxUserActionsPerPostback = 200 + ActiveSessionsTimeout = 1440 + MaxSizeOfUserFormState = 4096 + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt index 8abaa689a..4023dd69b 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt @@ -9,7 +9,8 @@ file and validate the license key during the installation process. This module depends on the prerequisites already being installed, which can be done - NOTE: This resource only supports SharePoint Server. SharePoint Foundation + NOTE: + This resource only supports SharePoint Server. SharePoint Foundation is not supported. For examples to install SharePoint Foundation using DSC, see: https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3) diff --git a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt index ef9deab6c..f2a0d5e05 100644 --- a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt @@ -7,7 +7,8 @@ as Office Web Apps). The DnsName property can be a single server name, or a FQDN of a load balanced end point that will direct traffic to a farm. - NOTE: This resource is designed to be used where all WOPI bindings will be + NOTE: + This resource is designed to be used where all WOPI bindings will be targeted to the same Office Online Server farm. If used on a clean environment, the new bindings will all point to the one DNS Name. If used on an existing configuration that does not follow this rule, it will match only diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt index 13a809f3a..7147c5960 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt @@ -8,7 +8,8 @@ You can control which AD groups should be imported from and control settings about reactivitating users. - Note: The schedule for this import is controlled via a standard + NOTE: + The schedule for this import is controlled via a standard SharePoint server timer job, and as such it can be controlled with the SPTimerJobState resource. Below is an example of how to set this resource to run the AD import job daily. The name of the job diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt index efae83fc3..2b2fe458e 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt @@ -6,7 +6,8 @@ This resource is used to control settings that relate to the SharePoint sites that are linked to projects in Project Server. - NOTE: The account you use to run this resource (through either the InstallAccount + NOTE: + The account you use to run this resource (through either the InstallAccount or PsDscRunAsCredential properties) needs to have elevated rights to execute this resource. It is recommended to use the SharePoint Farm Account for this purpose to avoid receiving a "GeneralSecurityAccessDenied" error. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt new file mode 100644 index 000000000..2bcee98a1 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt @@ -0,0 +1,92 @@ +.NAME + SPSearchAuthoritativePage + +# Description + + This resource is responsible for managing the search authoritative pages in the + search service application. You can create new pages, change existing pages and + remove existing pages. + + The default value for the Ensure parameter is Present. When you omit this + parameter the crawl rule is created. + +.PARAMETER ServiceAppName + Key - String + Search Service Application Name + +.PARAMETER Path + Key - String + Source URI for the authoritative page + +.PARAMETER Level + Write - Real32 + Level of Authoratitive Page, values between 0.0 and 2.0 + +.PARAMETER Action + Write - String + Allowed values: Authoratative, Demoted + The resource will either make the page authoritative or demoted based on this value + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Ensure the Authoritative is Present or Absent + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a Search Authoritative Page + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchAuthoritativePage AuthoratativePage + { + ServiceAppName = "Search Service Application" + Path = "http://site.sharepoint.com/Pages/authoritative.aspx" + Action = "Authoratative" + Level = 0.0 + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to create a Search Demoted Page + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchAuthoritativePage AuthoratativePage + { + ServiceAppName = "Search Service Application" + Path = "http://site.sharepoint.com/Pages/demoted.aspx" + Action = "Demoted" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt new file mode 100644 index 000000000..5722696ee --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt @@ -0,0 +1,64 @@ +.NAME + SPSearchCrawlMapping + +# Description + + This resource is responsible for managing the search crawl mapping in the + search service application. You can create new mappings, change existing mappings + and remove existing mappings. + + The default value for the Ensure parameter is Present. When you omit this + parameter the crawl rule is created. + +.PARAMETER ServiceAppName + Key - String + Search Service Application Name + +.PARAMETER Url + Key - String + Source URI for the crawl mapping + +.PARAMETER Target + Required - String + Target URI for the crawl mapping + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Ensure the crawl mapping is Present or Absent + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to apply a Search Crawl Mapping rule to a search application. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + SPSearchCrawlMapping IntranetCrawlMapping + { + ServiceAppName = "Search Service Application" + Url = "http://crawl.sharepoint.com" + Target = "http://site.sharepoint.com" + Ensure = "Present" + PsDScRunAsCredential = $SetupAccount + } + + } + } + + + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt new file mode 100644 index 000000000..f6dbc8c59 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt @@ -0,0 +1,42 @@ +.NAME + SPSearchCrawlerImpactRule + +# Description + + This resource is responsible for managing the search crawl impact rules in the + search service application. You can create new rules, change existing rules and + remove existing rules. + + The default value for the Ensure parameter is Present. When you omit this + parameter the crawl rule is created. + +.PARAMETER ServiceAppName + Key - String + Search Service Application Name + +.PARAMETER Name + Key - String + The Site for the crawl impact rule + +.PARAMETER Behavior + Read - String + The Behavior (RequestLimit or WaitTime) for this crawl impact rule + +.PARAMETER RequestLimit + Write - UInt32 + The RequestLimit setting for the crawl impact rule + +.PARAMETER WaitTime + Write - UInt32 + The WaitTime setting for the crawl impact rule + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Ensure the crawl rule is Present or Absent + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt b/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt new file mode 100644 index 000000000..c6ef7dff7 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt @@ -0,0 +1,66 @@ +.NAME + SPSecurityTokenServiceConfig + +# Description + + This resource is responsible for configuring the Security Token Service within + the local SharePoint farm. Using Ensure equals to Absent is not supported. + This resource can only apply configuration, not ensure they don't exist. + +.PARAMETER Name + Key - string + The name of the security token service + +.PARAMETER NameIdentifier + Write - string + The identifier for the security token service + +.PARAMETER UseSessionCookies + Write - Boolean + True set the security token service to use cookies + +.PARAMETER AllowOAuthOverHttp + Write - Boolean + True set the security token service to allow OAuth over HTTP + +.PARAMETER AllowMetadataOverHttp + Write - Boolean + True set the security token service to allow metadata exchange over HTTP + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present ensures the configurations are applied + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example configures the Security Token Service + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSecurityTokenServiceConfig SecurityTokenService + { + Name = "SPSecurityTokenService" + NameIdentifier = "00000003-0000-0ff1-ce00-000000000000@9f11c5ea-2df9-4950-8dcf-da8cd7aa4eff" + UseSessionCookies = $false + AllowOAuthOverHttp = $false + AllowMetadataOverHttp = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt index a0c4ccdb2..01ee465b2 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt @@ -4,6 +4,7 @@ # Description This resource is used to specify a managed account to be used to run a service instance. + You can also specify LocalService, LocalSystem or NetworkService as ManagedAccount. The name is the typename of the service as shown in the Central Admin website. This resource only needs to be run on one server in the farm, as the process identity update method will apply the settings to all instances of the service. @@ -14,7 +15,7 @@ .PARAMETER ManagedAccount Required - string - The user name of a managed account that will be used to run the service + The user name of a managed account, LocalService, LocalSystem or NetworkService that will be used to run the service .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-US/about_SPSite.help.txt b/Modules/SharePointDsc/en-US/about_SPSite.help.txt index fe3bb4a3b..2fce6342c 100644 --- a/Modules/SharePointDsc/en-US/about_SPSite.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSite.help.txt @@ -11,7 +11,8 @@ of a site collection, the additional parameters are not checked for yet, but will be in a later release - Note: When creating Host Header Site Collections, do not use the HostHeader + NOTE: + When creating Host Header Site Collections, do not use the HostHeader parameter in SPWebApplication. This will set the specified host header on your IIS site and prevent the site from listening for the URL of the Host Header Site Collection. diff --git a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt index a338d8a43..9e3360bf0 100644 --- a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt @@ -19,7 +19,8 @@ - Monthly at 15 15:00:00 - Yearly at Jan 1 15:00:00 - NOTE: Make sure you use the typename timer job name, not the display name! Use + NOTE: + Make sure you use the typename timer job name, not the display name! Use "Get-SPTimerJob | Where-Object { $_.Title -eq "\" } | Select typename" to find the typename for each Timer Job. diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt index 7730af844..d37c2e2f5 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt @@ -14,15 +14,15 @@ The name of the proxy that is attached to the user profile service you wish to set permissions for .PARAMETER CreatePersonalSite - Required - string + Write - string A list of user principals that will have the Create personal site permission .PARAMETER FollowAndEditProfile - Required - string + Write - string A list of user principals that will have the Follow users and edit profile permission .PARAMETER UseTagsAndNotes - Required - string + Write - string A list of user principals that will have the Use tags and notes permission .PARAMETER InstallAccount diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt index 1f2ef6aab..49fa25bb7 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt @@ -8,10 +8,12 @@ configure the five available zones (if they exist) separately and each zone can have multiple authentication methods configured. - NOTE: This resource cannot be used to convert a Classic web application + NOTE: + This resource cannot be used to convert a Classic web application to Claims mode. You have to run Convert-SPWebApplication manually for that. - NOTE 2: Updating the configuration can take a long time, up to five minutes. + NOTE 2: + Updating the configuration can take a long time, up to five minutes. The Set-SPWebApplication cmdlet sometimes requires several minutes to complete its action. This is not a SharePointDsc issue. diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt index 793e1fb2d..497a8c23f 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt @@ -11,7 +11,8 @@ The default value for the Ensure parameter is Present. When not specifying this parameter, the web application is provisioned. - Note: When using Host Header Site Collections, do not use the HostHeader + NOTE: + When using Host Header Site Collections, do not use the HostHeader parameter in SPWebApplication. This will set the specified host header on your IIS site and prevent the site from listening for the URL of the Host Header Site Collection. diff --git a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt index 979c2cf81..af5397081 100644 --- a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt @@ -19,6 +19,12 @@ The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned. + NOTE: + You cannot use this resource with SharePoint 2016, since the Work + Management functionality has been removed in SharePoint 2016. + More information: + https://technet.microsoft.com/en-us/library/mt346112(v=office.16).aspx + .PARAMETER Name Key - string The name of the work management service application From b1cd1ea8abfa48037ee82814cd8f31bf0ea01ef5 Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Tue, 20 Mar 2018 20:01:45 +0100 Subject: [PATCH 17/18] Adding documentation to release --- .../en-US/about_SPAlternateUrl.help.txt | 18 +- ..._SPDistributedCacheClientSettings.help.txt | 196 ++++++++++++++++++ .../en-US/about_SPTimerJobState.help.txt | 2 +- .../about_SPUserProfileServiceApp.help.txt | 19 +- .../about_SPUserProfileSyncService.help.txt | 21 +- 5 files changed, 243 insertions(+), 13 deletions(-) create mode 100644 Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt index 03d24fd59..028f892bf 100644 --- a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt @@ -8,14 +8,28 @@ application. Alternatively a URL can be removed from a zone to ensure that it will remain empty and have no alternate URL. + The default value for the Ensure parameter is Present. When not specifying this + parameter, the setting is configured. + + ## Central Administration + To select the Central Administration site, use the following command to retrieve the correct web application name: (Get-SPWebApplication -IncludeCentralAdministration | Where-Object { $_.IsAdministrationWebApplication }).DisplayName - The default value for the Ensure parameter is Present. When not specifying this - parameter, the setting is configured. + To update the existing Default Zone AAM for Central Administration (e.g. to + implement HTTPS), use the above command to retrieve the web application name + (by default, it will be "SharePoint Central Administration v4") and specify + "Default" as the Zone. If you wish to add AAM's instead, you may use the other + zones to do so. + + Using SPAlternateUrl to update the Default Zone AAM for Central Administration + will update the AAM in SharePoint as well as the CentralAdministrationUrl value + in the registry. It will not, however, update bindings in IIS. It is recommended + to use the xWebsite resource from the xWebAdministration module to configure the + appropriate bindings in IIS. .PARAMETER WebAppName Key - String diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt new file mode 100644 index 000000000..0acd30fb3 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt @@ -0,0 +1,196 @@ +.NAME + SPDistributedCacheClientSettings + +# Description + + This resource is responsible for configuring the distributed cache client + settings. It only accepts Ensure='Present' as a key. The resource can + configure the following cache components: DistributedLogonTokenCache, + DistributedViewStateCache, DistributedAccessCache, + DistributedActivityFeedCache, DistributedActivityFeedLMTCache, + DistributedBouncerCache, DistributedDefaultCache, DistributedSearchCache, + DistributedSecurityTrimmingCache, and DistributedServerToAppServerAccessTokenCache. + +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Unique key for the resource. Set to 'Yes' to apply configuration. + +.PARAMETER DLTCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Logon Token Cache + +.PARAMETER DLTCRequestTimeout + Write - UInt32 + Request timeout for the Distributed Logon Token Cache + +.PARAMETER DLTCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Logon Token Cache + +.PARAMETER DVSCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed View State Cache + +.PARAMETER DVSCRequestTimeout + Write - UInt32 + Request timeout for the Distributed View State Cache + +.PARAMETER DVSCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed View State Cache + +.PARAMETER DACMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Access Cache + +.PARAMETER DACRequestTimeout + Write - UInt32 + Request timeout for the Distributed Access Cache + +.PARAMETER DACChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Access Cache + +.PARAMETER DAFMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Activity Feed Cache + +.PARAMETER DAFRequestTimeout + Write - UInt32 + Request timeout for the Distributed Activity Feed Cache + +.PARAMETER DAFChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Activity Feed Cache + +.PARAMETER DAFCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Activity Feed LMT Cache + +.PARAMETER DAFCRequestTimeout + Write - UInt32 + Request timeout for the Distributed Activity Feed LMT Cache + +.PARAMETER DAFCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Activity Feed LMT Cache + +.PARAMETER DBCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Bouncer Cache + +.PARAMETER DBCRequestTimeout + Write - UInt32 + Request timeout for the Distributed Bouncer Cache + +.PARAMETER DBCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Bouncer Cache + +.PARAMETER DDCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Default Cache + +.PARAMETER DDCRequestTimeout + Write - UInt32 + Request timeout for the Distributed Default Cache + +.PARAMETER DDCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Default Cache + +.PARAMETER DSCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Search Cache + +.PARAMETER DSCRequestTimeout + Write - UInt32 + Request timeout for the Distributed Search Cache + +.PARAMETER DSCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Search Cache + +.PARAMETER DTCMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Security Trimming Cache + +.PARAMETER DTCRequestTimeout + Write - UInt32 + Request timeout for the Distributed Security Trimming Cache + +.PARAMETER DTCChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Security Trimming Cache + +.PARAMETER DSTACMaxConnectionsToServer + Write - UInt32 + Maximum number of connections to the Distributed Server to Application Server Cache + +.PARAMETER DSTACRequestTimeout + Write - UInt32 + Request timeout for the Distributed Server to Application Server Cache + +.PARAMETER DSTACChannelOpenTimeOut + Write - UInt32 + Channel timeout for the Distributed Server to Application Server Cache + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example configures the distributed cache client settings. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPDistributedCacheClientSettings Settings + { + IsSingleInstance = "Yes" + DLTCMaxConnectionsToServer = 3 + DLTCRequestTimeout = 1000 + DLTCChannelOpenTimeOut = 1000 + DVSCMaxConnectionsToServer = 3 + DVSCRequestTimeout = 1000 + DVSCChannelOpenTimeOut = 1000 + DACMaxConnectionsToServer = 3 + DACRequestTimeout = 1000 + DACChannelOpenTimeOut = 1000 + DAFMaxConnectionsToServer = 3 + DAFRequestTimeout = 1000 + DAFChannelOpenTimeOut = 1000 + DAFCMaxConnectionsToServer = 3 + DAFCRequestTimeout = 1000 + DAFCChannelOpenTimeOut = 1000 + DBCMaxConnectionsToServer = 3 + DBCRequestTimeout = 1000 + DBCChannelOpenTimeOut = 1000 + DDCMaxConnectionsToServer = 3 + DDCRequestTimeout = 1000 + DDCChannelOpenTimeOut = 1000 + DSCMaxConnectionsToServer = 3 + DSCRequestTimeout = 1000 + DSCChannelOpenTimeOut = 1000 + DTCMaxConnectionsToServer = 3 + DTCRequestTimeout = 1000 + DTCChannelOpenTimeOut = 1000 + DSTACMaxConnectionsToServer = 3 + DSTACRequestTimeout = 1000 + DSTACChannelOpenTimeOut = 1000 + PsDscRunAscredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt index 9e3360bf0..3c1cc7b3a 100644 --- a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt @@ -33,7 +33,7 @@ .PARAMETER WebAppUrl Key - String - The URL of the web application that the timer job belongs to, N/A if no web application is applicable + The URL of the web application that the timer job belongs to. Use the value 'N/A' if no web application is applicable .PARAMETER Enabled Write - Boolean diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt index d998fc2e2..9a6d3bab7 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt @@ -7,13 +7,26 @@ farm. It creates the required databases using the parameters that are passed in to it (although these are only used during the initial provisioning). - The specified InstallAccount or PSDSCRunAsCredential has to be the Farm Account. - This is done to ensure that the databases are created with the correct schema - owners and allow the user profile sync service to operate correctly. + The specified InstallAccount or PSDSCRunAsCredential cannot be the Farm Account. + The resource will throw an error when it is. + + To allow successful provisioning, the farm account must be in the local + administrators group, however it is not best practice to leave this account in + the Administrators group. Therefore this resource will add the Farm Account + credential to the local administrators group at the beginning of the set method + and remove it again later on. The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned. + NOTE: + Due to the fact that SharePoint requires certain User Profile components to be + provisioned as the Farm account, this resource and SPUserProfileSyncService + retrieve the Farm account from the Managed Accounts. + This does however mean that CredSSP is required, which has some security + implications. More information about these risks can be found at: + http://www.powershellmagazine.com/2014/03/06/accidental-sabotage-beware-of-credssp/ + .PARAMETER Name Key - string The name of the user profile service diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt index 6138b4966..045fa89ce 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt @@ -7,19 +7,26 @@ has been provisioned (Ensure = "Present") or is not running (Ensure = "Absent") on the current server. - This resource requires that the FarmAccount is specified as the InstallAccount - or PsDscRunAsCredential parameter. It will throw an exception if this is not - the case. + The specified InstallAccount or PSDSCRunAsCredential cannot be the Farm Account. + The resource will throw an error when it is. - To allow successful provisioning the farm account must be in the local + To allow successful provisioning, the farm account must be in the local administrators group, however it is not best practice to leave this account in - the Administrators group. Therefore this resource will add the FarmAccount + the Administrators group. Therefore this resource will add the Farm Account credential to the local administrators group at the beginning of the set method and remove it again later on. The default value for the Ensure parameter is Present. When not specifying this parameter, the user profile sync service is provisioned. + NOTE: + Due to the fact that SharePoint requires certain User Profile components to be + provisioned as the Farm account, this resource and SPUserProfileServiceApp + retrieve the Farm account from the Managed Accounts. + This does however mean that CredSSP is required, which has some security + implications. More information about these risks can be found at: + http://www.powershellmagazine.com/2014/03/06/accidental-sabotage-beware-of-credssp/ + .PARAMETER UserProfileServiceAppName Key - string The name of the user profile service for this sync instance @@ -30,8 +37,8 @@ Present to ensure the service is running, absent to ensure it is not .PARAMETER FarmAccount - Required - String - The farm account, which is needed to provision the service app + Write - String + PARAMETER IS NOT USED ANYMORE, WILL BE REMOVED IN V3.0 .PARAMETER RunOnlyWhenWriteable Write - Boolean From 44dd8075787870cebbb561140c39f53159d6542d Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Wed, 13 Jun 2018 10:22:57 +0200 Subject: [PATCH 18/18] Updated documentation --- .../en-US/about_SPAccessServiceApp.help.txt | 2 + .../en-US/about_SPAlternateUrl.help.txt | 2 + .../en-US/about_SPAntivirusSettings.help.txt | 2 + .../en-US/about_SPAppCatalog.help.txt | 2 + .../en-US/about_SPAppDomain.help.txt | 2 + .../about_SPAppManagementServiceApp.help.txt | 2 + .../en-US/about_SPAppStoreSettings.help.txt | 2 + .../en-US/about_SPBCSServiceApp.help.txt | 2 + .../en-US/about_SPBlobCacheSettings.help.txt | 2 + .../en-US/about_SPCacheAccounts.help.txt | 2 + .../en-US/about_SPConfigWizard.help.txt | 2 + .../en-US/about_SPContentDatabase.help.txt | 2 + .../en-US/about_SPDatabaseAAG.help.txt | 2 + .../en-US/about_SPDesignerSettings.help.txt | 2 + ...about_SPDiagnosticLoggingSettings.help.txt | 2 + .../about_SPDiagnosticsProvider.help.txt | 2 + ..._SPDistributedCacheClientSettings.help.txt | 2 + .../about_SPDistributedCacheService.help.txt | 2 + .../en-US/about_SPExcelServiceApp.help.txt | 2 + .../SharePointDsc/en-US/about_SPFarm.help.txt | 2 + .../en-US/about_SPFarmAdministrators.help.txt | 2 + .../en-US/about_SPFarmPropertyBag.help.txt | 2 + .../en-US/about_SPFarmSolution.help.txt | 2 + .../en-US/about_SPFeature.help.txt | 2 + .../about_SPHealthAnalyzerRuleState.help.txt | 2 + ...bout_SPInfoPathFormsServiceConfig.help.txt | 2 + .../en-US/about_SPInstall.help.txt | 2 + .../about_SPInstallLanguagePack.help.txt | 2 + .../en-US/about_SPInstallPrereqs.help.txt | 2 + .../en-US/about_SPIrmSettings.help.txt | 2 + .../en-US/about_SPLogLevel.help.txt | 2 + ...ut_SPMachineTranslationServiceApp.help.txt | 2 + .../en-US/about_SPManagedAccount.help.txt | 2 + ...about_SPManagedMetaDataServiceApp.help.txt | 2 + ...PManagedMetaDataServiceAppDefault.help.txt | 2 + .../en-US/about_SPManagedPath.help.txt | 2 + .../en-US/about_SPMinRoleCompliance.help.txt | 2 + ...about_SPOfficeOnlineServerBinding.help.txt | 2 + .../about_SPOutgoingEmailSettings.help.txt | 2 + .../about_SPPasswordChangeSettings.help.txt | 2 + ...bout_SPPerformancePointServiceApp.help.txt | 2 + .../en-US/about_SPProductUpdate.help.txt | 2 + ...SPProjectServerADResourcePoolSync.help.txt | 2 + ...SPProjectServerAdditionalSettings.help.txt | 2 + ..._SPProjectServerGlobalPermissions.help.txt | 2 + .../en-US/about_SPProjectServerGroup.help.txt | 2 + .../about_SPProjectServerLicense.help.txt | 2 + ...out_SPProjectServerPermissionMode.help.txt | 2 + .../about_SPProjectServerServiceApp.help.txt | 2 + ..._SPProjectServerTimeSheetSettings.help.txt | 2 + ...t_SPProjectServerUserSyncSettings.help.txt | 2 + .../about_SPProjectServerWssSettings.help.txt | 2 + ...about_SPPublishServiceApplication.help.txt | 2 + .../en-US/about_SPQuotaTemplate.help.txt | 2 + .../en-US/about_SPRemoteFarmTrust.help.txt | 2 + .../about_SPSearchAuthoritativePage.help.txt | 2 + .../about_SPSearchContentSource.help.txt | 2 + .../en-US/about_SPSearchCrawlMapping.help.txt | 2 + .../en-US/about_SPSearchCrawlRule.help.txt | 2 + .../about_SPSearchCrawlerImpactRule.help.txt | 2 + .../en-US/about_SPSearchFileType.help.txt | 2 + .../about_SPSearchIndexPartition.help.txt | 2 + .../en-US/about_SPSearchResultSource.help.txt | 2 + .../en-US/about_SPSearchServiceApp.help.txt | 2 + .../en-US/about_SPSearchTopology.help.txt | 2 + .../about_SPSecureStoreServiceApp.help.txt | 2 + ...bout_SPSecurityTokenServiceConfig.help.txt | 2 + .../en-US/about_SPServiceAppPool.help.txt | 2 + .../about_SPServiceAppProxyGroup.help.txt | 2 + .../en-US/about_SPServiceAppSecurity.help.txt | 2 + .../en-US/about_SPServiceIdentity.help.txt | 2 + .../en-US/about_SPServiceInstance.help.txt | 2 + .../about_SPSessionStateService.help.txt | 2 + .../en-US/about_SPShellAdmins.help.txt | 2 + .../SharePointDsc/en-US/about_SPSite.help.txt | 2 + .../en-US/about_SPStateServiceApp.help.txt | 2 + ..._SPSubscriptionSettingsServiceApp.help.txt | 2 + .../en-US/about_SPTimerJobState.help.txt | 2 + ...bout_SPTrustedIdentityTokenIssuer.help.txt | 2 + ...IdentityTokenIssuerProviderRealms.help.txt | 207 ++++++++++++++++++ .../en-US/about_SPUsageApplication.help.txt | 2 + .../about_SPUserProfileProperty.help.txt | 2 + .../en-US/about_SPUserProfileSection.help.txt | 2 + .../about_SPUserProfileServiceApp.help.txt | 12 +- ...PUserProfileServiceAppPermissions.help.txt | 2 + ...about_SPUserProfileSyncConnection.help.txt | 10 + .../about_SPUserProfileSyncService.help.txt | 2 + .../en-US/about_SPVisioServiceApp.help.txt | 2 + .../SharePointDsc/en-US/about_SPWeb.help.txt | 2 + .../about_SPWebAppAuthentication.help.txt | 2 + .../about_SPWebAppBlockedFileTypes.help.txt | 2 + .../about_SPWebAppGeneralSettings.help.txt | 2 + ...bout_SPWebAppPeoplePickerSettings.help.txt | 2 + .../en-US/about_SPWebAppPermissions.help.txt | 2 + .../en-US/about_SPWebAppPolicy.help.txt | 2 + .../en-US/about_SPWebAppProxyGroup.help.txt | 2 + .../about_SPWebAppSiteUseAndDeletion.help.txt | 2 + .../en-US/about_SPWebAppSuiteBar.help.txt | 2 + .../about_SPWebAppThrottlingSettings.help.txt | 2 + .../about_SPWebAppWorkflowSettings.help.txt | 2 + .../en-US/about_SPWebApplication.help.txt | 2 + .../about_SPWebApplicationAppDomain.help.txt | 2 + .../about_SPWebApplicationExtension.help.txt | 2 + .../about_SPWordAutomationServiceApp.help.txt | 2 + .../about_SPWorkManagementServiceApp.help.txt | 2 + .../en-US/about_SPWorkflowService.help.txt | 2 + 106 files changed, 433 insertions(+), 2 deletions(-) create mode 100644 Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt index af0142a8a..7c47d5fd6 100644 --- a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating Access Services Application instances within the local SharePoint farm. The resource will provision and configure the Access Services Service Application. diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt index 028f892bf..adf0e202c 100644 --- a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to define an alternate access mapping URL for a specified web application. These can be assigned to specific zones for each web application. Alternatively a URL can be removed from a zone to ensure that it diff --git a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt index e5310458b..a311bd156 100644 --- a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt index 7503bc167..c363e0214 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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). diff --git a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt index a0dd1da87..522632ebf 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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. diff --git a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt index db0141d21..3782a62e2 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt index 20fc57d6c..1f0c44782 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will configure the ability to purchase apps for both SharePoint and Office apps. diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt index 1b31735eb..11a901a7b 100644 --- a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt index fb91f98c1..682705314 100644 --- a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Specific + This resource is used to configure the Blob Cache settings for a web application. diff --git a/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt index cdc335f2d..7545cc4bd 100644 --- a/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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)). diff --git a/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt index c61bfe6e6..8cd498ddc 100644 --- a/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Utility + This resource is used to perform the upgrade step of installing SharePoint updates, like Cumulative Updates, Service Packs and Language Packs. The DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in diff --git a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt index c0ca49d45..ec5888af0 100644 --- a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to add and remove Content Databases to web applications and configure these databases. diff --git a/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt index 834c30c21..dab04d597 100644 --- a/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will allow specifying which SQL Server AlwaysOn Availability group a resource should be in. This resource does not configure the Availability Groups on SQL Server, they must already exist. It simply adds diff --git a/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt index 29abe027d..b6337b942 100644 --- a/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt index b66029c17..a7ac89ff3 100644 --- a/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt index 3db3722f9..43b0acf98 100644 --- a/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for configuring the Diagnostics Provider within the local SharePoint farm. Using Ensure equals to Absent is not supported. This resource can only apply configuration, not ensure they don't exist. diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt index 0acd30fb3..acf3d850b 100644 --- a/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for configuring the distributed cache client settings. It only accepts Ensure='Present' as a key. The resource can configure the following cache components: DistributedLogonTokenCache, diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt index f68a80185..5210953af 100644 --- a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Specific + 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 SPCreateFarm and SPJoinFarm is to not enroll every server as a diff --git a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt index 45dea7a37..4a95d56dc 100644 --- a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating Excel Services Application instances within the local SharePoint farm. The resource will provision and configure the Excel Services Service Application. diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt index b433f1629..c0ce3ae8a 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Specific + This resource is used to create a new SharePoint farm and allow servers to join that farm. It will detect the presence of the configuration database on the SQL server as a first step, and if it does not exist then the farm diff --git a/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt index 96503b5a9..4820892b7 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Common + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt index 0644d0bb4..c2e12c59d 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to work with SharePoint Property Bags at the farm level. The account that runs this resource must be a farm administrator. diff --git a/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt index 89c6517d3..6bfc8c997 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to make sure that a specific farm solution is either present or absent in a farm. The solution can be deployed to one or more web application passing an array of URL's to the WebApplications property. If the diff --git a/Modules/SharePointDsc/en-US/about_SPFeature.help.txt b/Modules/SharePointDsc/en-US/about_SPFeature.help.txt index 11006c2ee..aee7301c4 100644 --- a/Modules/SharePointDsc/en-US/about_SPFeature.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFeature.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt index cf4d28a54..9373405b9 100644 --- a/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to configure Health Analyzer rules for the local farm. The resource is able to enable/disable and configure the specified rule. diff --git a/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt b/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt index c8115f783..a3f29c642 100644 --- a/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for configuring the InfoPath Forms service within the local SharePoint farm. Using Ensure equals to Absent is not supported. This resource can only apply configuration, not ensure they don't exist. diff --git a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt index 4023dd69b..64379e38d 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Common + This resource is used to install the SharePoint binaries. The BinaryDir parameter should point to the path that setup.exe is located (not to setup.exe itself). The ProductKey parameter is used to inject in to the configuration diff --git a/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt index 359d97f42..86c7283e9 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to install the SharePoint Language Pack binaries. The BinaryDir parameter should point to the path that setup.exe is located (not to setup.exe itself). diff --git a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt index 941c143e2..384b1e13a 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Common + 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 diff --git a/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt index bb52a8c22..fdd87143b 100644 --- a/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS diff --git a/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt b/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt index 38a07ab28..8ecc0003f 100644 --- a/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to change the minimum severity of events captured in the trace logs (ULS logs) and the Windows event logs. Settings can be changed globally for all areas and categories (using the '*' character as the diff --git a/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt index 49d9aaf11..92cc49c62 100644 --- a/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to provision and manage an instance of the Machine Translation Service Application. It will identify an instance of the MT app through the application display name. Currently the resource will diff --git a/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt index 2db706949..38738833a 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will ensure a managed account is provisioned in to the SharePoint farm. The Account object specific the credential to store (including username and password) to set as the managed account. The settings for diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt index f19624695..62362444e 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + Creates a managed metadata service application. The application pool property specifies which application pool it should use, and will reset the application back to this pool if it is changed after its initial provisioning. The diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt index abdc6a780..551c38276 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + Using several managed metadata service instances in a farm requires some configuration, which service application proxy should be used as default for keywords or site collection specific term sets. diff --git a/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt index 387889cd9..aba74df6b 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating managed paths associated with a specific web application. The WebAppUrl parameter is used to specify the web application to create the path against, and the RelativeUrl parameter lets you diff --git a/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt b/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt index ce973c212..3f7776d9f 100644 --- a/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Utility + This resource will help manage compliance of MinRole based servers. Each time the resource runs it will investigate which service instances should be running based on the role of servers anywhere in the farm, and if they are not in a diff --git a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt index f2a0d5e05..82a1c2487 100644 --- a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will create a binding to an Office Online Server (formerly known as Office Web Apps). The DnsName property can be a single server name, or a FQDN of a load balanced end point that will direct traffic to a farm. diff --git a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt index 9e4cf8da6..cd4886d7d 100644 --- a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to set the outgoing email settings for either a single web application, or the whole farm. To configure the resource for a specific web app, use the URL of the web application for the WebAppUrl property, to diff --git a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt index e10906845..344e716c6 100644 --- a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to control settings that relate to the automatic changing of passwords for managed accounts (where they opt-in to be managed by SharePoint). These settings can be manually controlled through central diff --git a/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt index f3eb083f8..40a9da043 100644 --- a/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating Performance Point Service Application instances within the local SharePoint farm. The resource will provision and configure the Performance Point Service Application. diff --git a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt index 907f29fdc..b244788f4 100644 --- a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Common + This resource is used to perform the update step of installing SharePoint updates, like Cumulative Updates and Service Packs. The SetupFile parameter should point to the update file. The ShutdownServices parameter is used to diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt index 7147c5960..35d5372e4 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to control the settings of the Active Directory resource pool sync for Project Server, for a specific PWA instance. You can control which AD groups should be imported from and control diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt index e02d683e2..fd3114aea 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to manage the "additional settings" for a PWA instance (based on what is in the 'additional settings' page of the web interface). diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt index 59c0931ea..0beb81a13 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource allows you to enforce global permissions in a PWA site for a specific project server group or an individual resource. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt index c030fcb3c..f6a67953d 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to configure a group within Project Server. This is only available for use when the site is configured to use Project Server permissions mode and for Project Server 2016 only. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt index 153c3aaf4..c22b21e95 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to enable a Project Server license in to a SharePoint 2016 farm. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt index 45413e163..e73d6e644 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource allows you to set the permissions mode (either SharePoint or ProjectServer) for a specific project server site. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt index 0e54a440b..cbc06e397 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for provisioning and managing the Project Server service application in SharePoint Server 2016. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt index b30c3291c..a53f30310 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + Allows you to configure the default timesheet settings for a specific PWA instance. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt index 4390aa386..3ce3df5c2 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for configuration of the user sync settings between projects and project sites. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt index 2b2fe458e..575397561 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to control settings that relate to the SharePoint sites that are linked to projects in Project Server. diff --git a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt index 8163fcefa..dfa1ad01d 100644 --- a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to specify if a specific service application should be published (Ensure = "Present") or not published (Ensure = "Absent") on the current server. The name is the display name of the service application as diff --git a/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt index e5c9a3473..ca4dd1e9f 100644 --- a/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to configure quota templates in the farm. These settings will be used to make sure a certain quota template exists or not. When it exists, it will also make sure the settings are configured as specified. diff --git a/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt index 18b12dcf4..fe892a933 100644 --- a/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to trust a remote SharePoint farm. This is used when federating search results between two different SharePoint farms. The technique is described at diff --git a/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt index 2bcee98a1..9164a96d9 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for managing the search authoritative pages in the search service application. You can create new pages, change existing pages and remove existing pages. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt index 1b0d8cdc8..eb5f41447 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will deploy and configure a content source in a specified search service application. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt index 5722696ee..0ce04c2b1 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for managing the search crawl mapping in the search service application. You can create new mappings, change existing mappings and remove existing mappings. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt index b8ad9d357..b21158382 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for managing the search crawl rules in the search service application. You can create new rules, change existing rules and remove existing rules. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt index f6dbc8c59..a1765d510 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for managing the search crawl impact rules in the search service application. You can create new rules, change existing rules and remove existing rules. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt index e90e7fa9b..6c027f7fb 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for managing the search file types in the search service application. You can create new file types, change existing types and remove existing file types. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt index e6b3f15e0..8be8cbeb6 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating search indexes. It works by creating the index topology components and updating the topology from the server that runs this resource. For this reason this resource only needs to run from one diff --git a/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt index 87ce4c00a..831637c09 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to configure search result sources in the SharePoint search service application. Result sources can be configured to be of the following provider types: diff --git a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt index 08e56ad36..90bc720ee 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for provisioning the search service application. The current version lets you specify the database name and server, as well as the application pool. If the application pool is changed the DSC resource will diff --git a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt index 0e548e5fb..0fc94c07a 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for provisioning a search topology in to the current farm. It allows the configuration to dictate the search topology roles that the current server should be running. Any combination of roles can be diff --git a/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt index dcd0d8d78..bf5f94015 100644 --- a/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for provisioning and configuring the secure store service application. The parameters passed in (except those related to database specifics) are validated and set when the resource is run, the database values diff --git a/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt b/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt index c6ef7dff7..0812616ea 100644 --- a/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for configuring the Security Token Service within the local SharePoint farm. Using Ensure equals to Absent is not supported. This resource can only apply configuration, not ensure they don't exist. diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt index 9f03c2ae0..7a61d86f7 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used for provisioning an application pool that can be used for service applications. The account used for the service account must already be registered as a managed account (which can be provisioned through diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt index c1e52446c..998180edb 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to manage SharePoint Service Application Proxy Groups. The "Ensure" parameter controls whether or not the Proxy Group should exist. A proxy group cannot be removed if a web application is using it. The diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt index 01a0291ca..0e92c08a2 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to manage the sharing security settings of a specific service application. There are a number of approaches to how this can be implemented. Firstly you can set permissions for the app administrators, or diff --git a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt index 01ee465b2..49c7fea1c 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to specify a managed account to be used to run a service instance. You can also specify LocalService, LocalSystem or NetworkService as ManagedAccount. The name is the typename of the service as shown in the Central Admin website. diff --git a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt index 5fd3ee114..6296109a1 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Specific + This resource is used to specify if a specific service should be running (Ensure = "Present") or not running (Ensure = "Absent") on the current server. The name is the display name of the service as shown in the Central Admin diff --git a/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt index 8949c9c96..873001830 100644 --- a/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will provision a state service app to the local farm. Specify the name of the database server and database name to provision the app with, and optionally include the session timeout value. If session timeout is not diff --git a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt index a6fef1af9..d7978dd38 100644 --- a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to manage the users with Shell Admin permissions. 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 diff --git a/Modules/SharePointDsc/en-US/about_SPSite.help.txt b/Modules/SharePointDsc/en-US/about_SPSite.help.txt index 2fce6342c..4e6a6487a 100644 --- a/Modules/SharePointDsc/en-US/about_SPSite.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSite.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will provision a site collection to the current farm, based on the settings that are passed through. These settings map to the New-SPSite cmdlet and accept the same values and types. diff --git a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt index ad167064f..3f86c150a 100644 --- a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource provisions an instance of the state service in to the local farm. The database specific parameters are only used during initial provisioning of the app, and will not change database settings beyond the initial deployment. diff --git a/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt index 5cfe78035..48fa80533 100644 --- a/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to provision and manage an instance of the App Management Services Service Application. It will identify an instance of the subscription settings service app through the application display name. Currently the diff --git a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt index 3c1cc7b3a..95c14b49f 100644 --- a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to configure a timer job and make sure it is in a specific state. The resource can be used to enable or disabled the job and configure the schedule of the job. diff --git a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt index d184884a5..4987bc90d 100644 --- a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to create or remove SPTrustedIdentityTokenIssuer in a SharePoint farm. diff --git a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt new file mode 100644 index 000000000..837832af7 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt @@ -0,0 +1,207 @@ +.NAME + SPTrustedIdentityTokenIssuerProviderRealms + +# Description + + **Type:** Distributed + + This resource is used to add or remove provider realms to + SPTrustedIdentityTokenIssuer in a SharePoint farm. The "ProviderRealms" + property will set a specific list of realms, making sure + that every realm in the list is set and all others that are + already configured but not in this list will be removed. + The "ProviderRealmsToInclude" and "ProviderRealmsToExclude" properties + will allow you to control a specific set of realms to add or remove, + without changing any other realms that are set already. Include and + Exclude can be combined together. RealmUrl is the key and should be + unique, otherwise existing RealmUrn value will be updated/replaced. + +.PARAMETER IssuerName + Key - String + Name of the SPTrustedIdentityTokenIssuer + +.PARAMETER ProviderRealms + Write - String + Realms to set. Those not in this list will be removed + +.PARAMETER ProviderRealmsToInclude + Write - String + Realms to add. Realms not in this list will be left + +.PARAMETER ProviderRealmsToExclude + Write - String + Realms to remove. Realms not in this list will be left + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Present if the ProviderRealms should be created, or Absent if it should be removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example adds provider realms to existing trusted token issuer. + Existing will be removed. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + $ProviderRealms = @() + $ProviderRealms += MSFT_SPProviderRealm { + RealmUrl = "https://search.contoso.com" + RealmUrn = "urn:sharepoint:contoso:search" + } + + $ProviderRealms += MSFT_SPProviderRealm { + RealmUrl = "https://intranet.contoso.com" + RealmUrn = "urn:sharepoint:contoso:intranet" + } + + SPTrustedIdentityTokenIssuerProviderRealms Farm1OverwriteExample + { + IssuerName = "Contoso" + ProviderRealms = $ProviderRealms + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example adds provider realms to existing trusted token issuer. + Existing are left and not removed. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + $ProviderRealmsToInclude = @() + $ProviderRealmsToInclude += MSFT_SPProviderRealm { + RealmUrl = "https://search.contoso.com" + RealmUrn = "urn:sharepoint:contoso:search" + } + + $ProviderRealmsToInclude += MSFT_SPProviderRealm { + RealmUrl = "https://intranet.contoso.com" + RealmUrn = "urn:sharepoint:contoso:intranet" + } + + SPTrustedIdentityTokenIssuerProviderRealms Farm1IncludeExample + { + IssuerName = "Contoso" + ProviderRealmsToInclude = $ProviderRealmsToInclude + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example excludes provider realms from + existing trusted token issuer. + Existing and not excluded are left and not removed. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + $ProviderRealmsToExclude = @() + $ProviderRealmsToExclude += MSFT_SPProviderRealm { + RealmUrl = "https://search.contoso.com" + RealmUrn = "urn:sharepoint:contoso:search" + } + + $ProviderRealmsToExclude += MSFT_SPProviderRealm { + RealmUrl = "https://intranet.contoso.com" + RealmUrn = "urn:sharepoint:contoso:intranet" + } + + SPTrustedIdentityTokenIssuerProviderRealms Farm1ExcludeExample + { + IssuerName = "Contoso" + ProviderRealmsToExclude = $ProviderRealmsToExclude + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } +} + + +.EXAMPLE + This example includes and excludes provider realms + from existing trusted token issuer. + Existing and not excluded are left and not removed. + + +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + $ProviderRealmsToInclude = @() + $ProviderRealmsToInclude += MSFT_SPProviderRealm { + RealmUrl = "https://search.contoso.com" + RealmUrn = "urn:sharepoint:contoso:search" + } + + $ProviderRealmsToInclude += MSFT_SPProviderRealm { + RealmUrl = "https://intranet.contoso.com" + RealmUrn = "urn:sharepoint:contoso:intranet" + } + + $ProviderRealmsToExclude = @() + $ProviderRealmsToExclude += MSFT_SPProviderRealm { + RealmUrl = "https://search1.contoso.com" + RealmUrn = "urn:sharepoint:contoso:search1" + } + + $ProviderRealmsToExclude += MSFT_SPProviderRealm { + RealmUrl = "https://intranet.contoso.com" + RealmUrn = "urn:sharepoint:contoso:intranet" + } + + SPTrustedIdentityTokenIssuerProviderRealms Farm1IncludeExcludeExample + { + IssuerName = "Contoso" + ProviderRealmsToInclude = $ProviderRealmsToInclude + ProviderRealmsToExclude = $ProviderRealmsToExclude + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } +} + + diff --git a/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt index f072a5703..3a935104f 100644 --- a/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource provisions an instance of the usage and health monitoring service application. The database settings are only used for initial provisioning, but the usage settings can be changed and will be enforced as the resource is diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt index 3487d22cf..b15ea0204 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will create a property in a user profile service application. It creates, update or delete a property using the parameters that are passed in to it. diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt index 062bde77c..f298036a2 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will create a section in a user profile service application. It creates, update or delete a section using the parameters that are passed in to it. diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt index 9a6d3bab7..4751205ba 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will provision an instance of the user profile service to the farm. It creates the required databases using the parameters that are passed in to it (although these are only used during the initial provisioning). @@ -43,6 +45,10 @@ Write - string The URL of the my site host collection +.PARAMETER MySiteManagedPath + Write - string + The Managed Path of the my site sites + .PARAMETER ProfileDBName Write - string The name of the profile database @@ -89,7 +95,7 @@ This example adds a new user profile service application to the local farm - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -104,6 +110,7 @@ Name = "User Profile Service Application" ApplicationPool = "SharePoint Service Applications" MySiteHostLocation = "http://my.sharepoint.contoso.local" + MySiteManagedPath = "personal" ProfileDBName = "SP_UserProfiles" ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" SocialDBName = "SP_Social" @@ -121,7 +128,7 @@ This example adds a new user profile service application to the local farm - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -140,6 +147,7 @@ Name = "User Profile Service Application" ApplicationPool = "SharePoint Service Applications" MySiteHostLocation = "http://my.sharepoint.contoso.local" + MySiteManagedPath = "personal" ProfileDBName = "SP_UserProfiles" ProfileDBServer = "SQL.contoso.local\SQLINSTANCE" SocialDBName = "SP_Social" diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt index d37c2e2f5..89470cea2 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will apply permissions to a user profile service application. These can control access to create my sites, use social features, and use tagging. If you want to allow all users the ability to use a specific diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt index 276369eda..b37f0f99a 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will ensure a specifc user profile sync connection is in place and that it is configured accordingly to its definition @@ -36,10 +38,18 @@ Write - string The specific AD server to connect to +.PARAMETER Port + Write - uint32 + The specific port to connect to + .PARAMETER UseSSL Write - boolean Should SSL be used for the connection +.PARAMETER UseDisabledFilter + Write - boolean + Should disabled accounts be filtered + .PARAMETER Force Write - boolean Set to true to run the set method on every call to this resource diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt index 045fa89ce..8975104ec 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Specific + This resource is responsible for ensuring that the user profile sync service has been provisioned (Ensure = "Present") or is not running (Ensure = "Absent") on the current server. diff --git a/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt index fe74ec48b..e5819b715 100644 --- a/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating Visio Graphics Service Application instances within the local SharePoint farm. The resource will provision and configure the Visio Graphics Service Application. diff --git a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt index 6f48b73f4..fe4b41121 100644 --- a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will provision a SPWeb based on the settings that are passed through. These settings map to the New-SPWeb cmdlet and accept the same values diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt index 49fa25bb7..95c0c65f8 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for configuring the authentication on a web application within the local SharePoint farm. The resource is able to configure the five available zones (if they exist) separately and each diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt index bbc65b7eb..6c00a2e51 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for controlling the blocked file type setting on a specific web application. It has two modes of operation, the first is to use the "blocked" property, where you are able to define a specific list of file diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt index 5daef7cce..e19a2bcb8 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for setting web application settings that are found under the "general settings" screen in central admin. The web application is specified through the URL property, and then any combination of diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt index 9a26150ca..556fb2333 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to configure the People Picker settings for a web application. diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt index 376f4e1be..ec399bd14 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for managing the user permissions for a web application. You can either specify to set all permissions or specify individual permissions per category. diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt index 404dc14ba..0a6ce43e1 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to set the User Policies for web applications. The usernames can be either specified in Classic or Claims format, both will be accepted. There are a number of approaches to how this can be implemented. The diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt index 12151f76f..726b24e8f 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to associate a web application to a service application proxy group. Use the proxy group name "Default" to associate the web application to the default proxy group. A web applicaiton can only connect to diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt index 34dbcb74e..a8cbe3e18 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for controlling the Site Use and Deletion settings on a specific web application. You can enable or disable the Site Use and Deletion feature, specify the amount of days after which the alerts are diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt index 84140d108..6654bb948 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to set the Suite Bar branding for web applications. It supports both the SharePoint 2013 and SharePoint 2016 ways of branding the suite bar. diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt index c82635b35..6b21ce165 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for setting web application settings that are found under the "resource throttling" screen in central admin. The web application is specified through the URL property, and then any combination of diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt index b0a3353dc..fe71b8148 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for setting web application settings that are found under the "workflow settings" screen in central admin. The web application is specified through the URL property, and then any combination of diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt index 497a8c23f..4962bccfd 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for creating a web application within the local SharePoint farm. The resource will provision the web application with all of the current settings, and then ensure that it stays part of the correct diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt index 80c0a694b..351b54ed1 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource will configure the App Domain at a specific zone for the given Web Application. The configuration is done per zone on the specified web application, allowing for the setting of unique app domains for each extension diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt index d0da31624..3911fc15d 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is responsible for extending an existing web application into a new zone. The resource will provision the web application extension with all of the current settings, and then ensure that it stays present and will ensure the diff --git a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt index 665b56e53..e902221ee 100644 --- a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + The resource is able to provision, unprovision and configure the Word Automation Service Application. All settings that you can configure on the Service Application administration page are configurable using this resource. diff --git a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt index af5397081..ec7b9d855 100644 --- a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to provision and manage an instance of the Work Management Services Service Application. It will identify an instance of the work management service application through the application display name. diff --git a/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt index 56c9ff360..1b64effe7 100644 --- a/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt @@ -3,6 +3,8 @@ # Description + **Type:** Distributed + This resource is used to register the SharePoint Server against a Workflow Manager Instance.