From 79487468d063bc4b3fb04d5b400574304f5c4bb5 Mon Sep 17 00:00:00 2001 From: KarolKaczmarek Date: Tue, 2 Feb 2016 11:05:07 -0800 Subject: [PATCH 1/6] Update manifest with PrivateData --- Modules/xSharePoint/xSharePoint.psd1 | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/Modules/xSharePoint/xSharePoint.psd1 b/Modules/xSharePoint/xSharePoint.psd1 index 8a6a441af..699a7b121 100644 --- a/Modules/xSharePoint/xSharePoint.psd1 +++ b/Modules/xSharePoint/xSharePoint.psd1 @@ -94,15 +94,34 @@ AliasesToExport = '*' # List of all files packaged with this module # FileList = @() -# Private data to pass to the module specified in RootModule/ModuleToProcess -# PrivateData = '' - # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -prefix. # DefaultCommandPrefix = '' +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = @('DesiredStateConfiguration', 'DSC', 'DSCResourceKit', 'DSCResource') + + # A URL to the license for this module. + LicenseUri = 'https://github.com/PowerShell/xSharePoint/blob/master/LICENSE' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/PowerShell/xSharePoint' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + } # End of PSData hashtable +} # End of PrivateData hashtable } From 903f8af541139b4fb5599740a825a638f469cc9a Mon Sep 17 00:00:00 2001 From: KarolKaczmarek Date: Tue, 2 Feb 2016 12:27:07 -0800 Subject: [PATCH 2/6] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3d065fa48..f203ec3a1 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,8 @@ Additional detailed documentation is included on the wiki on GitHub. ## Version History +### Unreleased + ### 0.10.0.0 * Added xSPWordAutomationServiceApp, xSPHealthAnalyzerRuleState, xSPUserProfileProperty, xSPWorkManagementApp, xSPUserProfileSyncConnection and xSPShellAdmin resources From 311f764f56d61fd7a389a438315113ead6ae44b7 Mon Sep 17 00:00:00 2001 From: Brian Farnhill Date: Thu, 4 Feb 2016 08:14:42 +1100 Subject: [PATCH 3/6] Added documentation for release --- .../en-us/about_xSPAntivirusSettings.help.txt | 28 ++++++++ .../en-us/about_xSPAppCatalog.help.txt | 21 ++++++ .../en-us/about_xSPAppDomain.help.txt | 24 +++++++ .../about_xSPAppManagementServiceApp.help.txt | 27 ++++++++ .../en-us/about_xSPBCSServiceApp.help.txt | 28 ++++++++ .../en-us/about_xSPCacheAccounts.help.txt | 23 +++++++ .../en-us/about_xSPCreateFarm.help.txt | 38 ++++++++++ .../en-us/about_xSPDesignerSettings.help.txt | 45 ++++++++++++ ...bout_xSPDiagnosticLoggingSettings.help.txt | 54 +++++++++++++++ .../about_xSPDistributedCacheService.help.txt | 30 ++++++++ .../about_xSPFarmAdministrators.help.txt | 25 +++++++ .../en-us/about_xSPFeature.help.txt | 27 ++++++++ .../about_xSPHealthAnalyzerRuleState.help.txt | 28 ++++++++ .../en-us/about_xSPInstall.help.txt | 37 ++++++++++ .../en-us/about_xSPInstallPrereqs.help.txt | 69 +++++++++++++++++++ .../en-us/about_xSPJoinFarm.help.txt | 26 +++++++ .../en-us/about_xSPManagedAccount.help.txt | 26 +++++++ ...bout_xSPManagedMetaDataServiceApp.help.txt | 27 ++++++++ .../en-us/about_xSPManagedPath.help.txt | 28 ++++++++ .../about_xSPOutgoingEmailSettings.help.txt | 28 ++++++++ .../about_xSPPasswordChangeSettings.help.txt | 27 ++++++++ .../en-us/about_xSPQuotaTemplate.help.txt | 29 ++++++++ .../about_xSPSearchIndexPartition.help.txt | 35 ++++++++++ .../en-us/about_xSPSearchServiceApp.help.txt | 27 ++++++++ .../en-us/about_xSPSearchTopology.help.txt | 42 +++++++++++ .../about_xSPSecureStoreServiceApp.help.txt | 34 +++++++++ .../en-us/about_xSPServiceAppPool.help.txt | 22 ++++++ .../en-us/about_xSPServiceInstance.help.txt | 29 ++++++++ .../about_xSPSessionStateService.help.txt | 26 +++++++ .../en-us/about_xSPShellAdmins.help.txt | 56 +++++++++++++++ .../xSharePoint/en-us/about_xSPSite.help.txt | 38 ++++++++++ .../en-us/about_xSPStateServiceApp.help.txt | 24 +++++++ ...xSPSubscriptionSettingsServiceApp.help.txt | 27 ++++++++ .../en-us/about_xSPTimerJobState.help.txt | 38 ++++++++++ .../en-us/about_xSPUsageApplication.help.txt | 32 +++++++++ .../about_xSPUserProfileProperty.help.txt | 69 +++++++++++++++++++ .../about_xSPUserProfileServiceApp.help.txt | 40 +++++++++++ ...bout_xSPUserProfileSyncConnection.help.txt | 37 ++++++++++ .../about_xSPUserProfileSyncService.help.txt | 26 +++++++ .../en-us/about_xSPVisioServiceApp.help.txt | 18 +++++ .../about_xSPWebAppBlockedFileTypes.help.txt | 30 ++++++++ .../about_xSPWebAppGeneralSettings.help.txt | 39 +++++++++++ .../en-us/about_xSPWebAppPolicy.help.txt | 24 +++++++ ...about_xSPWebAppSiteUseAndDeletion.help.txt | 28 ++++++++ ...about_xSPWebAppThrottlingSettings.help.txt | 42 +++++++++++ .../about_xSPWebAppWorkflowSettings.help.txt | 26 +++++++ .../en-us/about_xSPWebApplication.help.txt | 38 ++++++++++ .../about_xSPWebApplicationAppDomain.help.txt | 31 +++++++++ ...about_xSPWordAutomationServiceApp.help.txt | 69 +++++++++++++++++++ 49 files changed, 1642 insertions(+) create mode 100644 Modules/xSharePoint/en-us/about_xSPAntivirusSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPAppCatalog.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPAppDomain.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPAppManagementServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPBCSServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPCacheAccounts.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPCreateFarm.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPDesignerSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPDiagnosticLoggingSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPDistributedCacheService.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPFarmAdministrators.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPFeature.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPHealthAnalyzerRuleState.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPInstall.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPInstallPrereqs.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPJoinFarm.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPManagedAccount.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPManagedMetaDataServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPManagedPath.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPOutgoingEmailSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPPasswordChangeSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPQuotaTemplate.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSearchIndexPartition.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSearchServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSearchTopology.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSecureStoreServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPServiceAppPool.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPServiceInstance.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSessionStateService.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPShellAdmins.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSite.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPStateServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPSubscriptionSettingsServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPTimerJobState.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPUsageApplication.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPUserProfileProperty.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPUserProfileServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPUserProfileSyncConnection.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPUserProfileSyncService.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPVisioServiceApp.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebAppBlockedFileTypes.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebAppGeneralSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebAppPolicy.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebAppSiteUseAndDeletion.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebAppThrottlingSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebAppWorkflowSettings.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebApplication.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWebApplicationAppDomain.help.txt create mode 100644 Modules/xSharePoint/en-us/about_xSPWordAutomationServiceApp.help.txt diff --git a/Modules/xSharePoint/en-us/about_xSPAntivirusSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPAntivirusSettings.help.txt new file mode 100644 index 000000000..36c109a8e --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPAntivirusSettings.help.txt @@ -0,0 +1,28 @@ +NAME + xSPAntivirusSettings + +PARAMETERS + ScanOnDownload (Key, Boolean) + ScanOnUpload (Write, Boolean) + AllowDownloadInfected (Write, Boolean) + AttemptToClean (Write, Boolean) + TimeoutDuration (Write, Uint16) + NumberOfThreads (Write, Uint16) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to set the global antivirus settings for the local farm. +These settings will be used to control the behavior of an external anti-virus scanning tool that is able to integrate with SharePoint. +Note that this will not scan documents for viruses on it's own, an external tool still needs to be installed on the servers that integrates with SharePoint. + +EXAMPLE + + xSPAntivirusSettings AVSettings + { + ScanOnDownload = $true + ScanOnUpload = $true + AllowDownloadInfected = $false + AttemptToClean = $false + } + diff --git a/Modules/xSharePoint/en-us/about_xSPAppCatalog.help.txt b/Modules/xSharePoint/en-us/about_xSPAppCatalog.help.txt new file mode 100644 index 000000000..2517b9435 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPAppCatalog.help.txt @@ -0,0 +1,21 @@ +NAME + xSPAppCatalog + +PARAMETERS + SiteUrl (Key, string) + InstallAccount (Write, String) + +DESCRIPTION + +This resource will ensure that a specific site collection is marked as the app catalog for the web application that the site is in. +The catalog site needs to have been created using the correct template (APPCATALOG#0). + +EXAMPLE + + xSPAppCatalog MainAppCatalog + { + SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" + PsDscRunAsCredential = $SPSetupAccount + } + + diff --git a/Modules/xSharePoint/en-us/about_xSPAppDomain.help.txt b/Modules/xSharePoint/en-us/about_xSPAppDomain.help.txt new file mode 100644 index 000000000..0c0fb216e --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPAppDomain.help.txt @@ -0,0 +1,24 @@ +NAME + xSPAppDomain + +PARAMETERS + AppDomain (Key, string) + Prefix (Required, string) + InstallAccount (Write, String) + +DESCRIPTION + +This resource will set the value for the app domain settings at the farm level. +You can set the domain name and the prefix that is to be used for app URLs. + + +EXAMPLE + + xSPAppDomain LocalFarmAppUrls + { + AppDomain = "contosointranetapps.com" + Prefix = "app" + PsDscRunAsCredential = $InstallAccount + } + + diff --git a/Modules/xSharePoint/en-us/about_xSPAppManagementServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPAppManagementServiceApp.help.txt new file mode 100644 index 000000000..907b721de --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPAppManagementServiceApp.help.txt @@ -0,0 +1,27 @@ +NAME + xSPAppManagementServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, String) + DatabaseName (Write, string) + DatabaseServer (Write, String) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to provision and manage an instance of the App Management Services Service Application. +It will identify an instance of the app management service application through the application display name. +Currently the resource will provision the app if it does not yet exist, and will change the application pool associated to the app if it does not match the configuration. +Database names or server name will not be changed if the configuration does not match, these parameters are only used for the initial provisioning of the service application. + +EXAMPLE + + xSPAppManagementServiceApp AppManagementServiceApp + { + Name = "App Management Service Application" + AppPool = "SharePoint web services" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_ManagedMetadata" +} + diff --git a/Modules/xSharePoint/en-us/about_xSPBCSServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPBCSServiceApp.help.txt new file mode 100644 index 000000000..1ae922739 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPBCSServiceApp.help.txt @@ -0,0 +1,28 @@ +NAME + xSPBCSServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, String) + DatabaseName (Write, string) + DatabaseServer (Write, String) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to provision and manage an instance of the Business Connectivity Services Service Application. +It will identify an instance of the BCS app through the application display name. +Currently the resource will provision the app if it does not yet exist, and will change the service account associated to the app if it does not match the configuration. +Database names or server name will not be changed if the configuration does not match, these parameters are only used for the initial provisioning of the service application. + +EXAMPLE + + xSPBCSServiceApp BCSServiceApp + { + Name = "BCS Service Application" + ApplicationPool = "SharePoint Service Applications" + DatabaseName = "SP_BCS" + DatabaseServer = $DatabaseServer + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPCacheAccounts.help.txt b/Modules/xSharePoint/en-us/about_xSPCacheAccounts.help.txt new file mode 100644 index 000000000..ff8f5448e --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPCacheAccounts.help.txt @@ -0,0 +1,23 @@ +NAME + xSPCacheAccounts + +PARAMETERS + WebAppUrl (Key, string) + SuperUserAlias (Required, string) + SuperReaderAlias (Required, string) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to set the "super user" and "super reader" cache accounts for the specified web application object (as described in the TechNet article [Configure object cache user accounts in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/ff758656.aspx)). + +EXAMPLE + + xSPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPCreateFarm.help.txt b/Modules/xSharePoint/en-us/about_xSPCreateFarm.help.txt new file mode 100644 index 000000000..3a963643f --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPCreateFarm.help.txt @@ -0,0 +1,38 @@ +NAME + xSPCreateFarm + +PARAMETERS + FarmConfigDatabaseName (Key, String) + DatabaseServer (Key, String) + FarmAccount (Required, String) + InstallAccount (Write, String) + Passphrase (Required, String) + AdminContentDatabaseName (Required, String) + CentralAdministrationPort (Write, uint32) + ServerRole (Write, string, Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd) + +DESCRIPTION + +This resource is used to provision a new SharePoint farm. +It should only be used on the first server in the farm to create the configuration database, all servers to join the farm after the first server creates the configuration database should use [xSPJoinFarm](xSPJoinFarm). +Once the config DB has been created, the resource will install local help collections, secure resources, activate features and provision the central admin site. + +The port of the Central Admin website can be set by using the CentralAdministrationPort property, if this is not defined the site will be provisioned on port 9999. +However this setting will not impact existing deployments that already have Central Admin provisioned on another port. +Also when a farm is created, the current behavior is to not enroll the server as a cache server (which is the default behavior of SharePoint). +This means you need to use [xSPDistributedCacheService](xSPDistributedCacheService) on at least one server in the farm to designate it as a cache server. + +EXAMPLE + + xSPCreateFarm CreateSPFarm + { + DatabaseServer = "SQL.contoso.local\SQLINSTANCE" + FarmConfigDatabaseName = "SP_Config" + Passphrase = "Example Passphrase" + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + AdminContentDatabaseName = "SP_AdminContent" + CentralAdministrationPort = 2000 + ServerRole = Custom + } + diff --git a/Modules/xSharePoint/en-us/about_xSPDesignerSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPDesignerSettings.help.txt new file mode 100644 index 000000000..3f633ae0a --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPDesignerSettings.help.txt @@ -0,0 +1,45 @@ +NAME + xSPDesignerSettings + +PARAMETERS + Url (Key, string) + SettingsScope (Required, string, Allowed values: WebApplication, SiteCollection) + AllowSharePointDesigner (Write, Boolean) + AllowDetachPagesFromDefinition (Write, Boolean) + AllowCustomiseMasterPage (Write, Boolean) + AllowManageSiteURLStructure (Write, Boolean) + AllowCreateDeclarativeWorkflow (Write, Boolean) + AllowSavePublishDeclarativeWorkflow (Write, Boolean) + AllowSaveDeclarativeWorkflowAsTemplate (Write, Boolean) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to set the SharePoint Designer settings for the local farm or site collections. +These settings will be used to control if users are allowed to make changes using SharePoint Designer. +Note that this will not prevent users from installing SharePoint Designer, just from using SharePoint Designer to connect to the farm. + +Settings can be applied against an entire web application, or a specific site collection. +Use the "SettingsScope" property to set it to either "WebApplication" or "SiteCollection" to define which you are targetting. + +Known issue: +When using PowerShell v4 or PowerShell v5 with the InstallAccount switch (instead of PsDscRunAsCredential), you cannot use the SettingsScope "SiteCollection". +Due to an issue with Remote PowerShell and SharePoint, changing the Site Collection settings results in an Access Denied error. +Consider implementing PowerShell v5 and switching to the PsDscRunAsCredential configuration. + +EXAMPLE + + xSPDesignerSettings MainWebAppSPDSettings + { + Url = "https://intranet.sharepoint.contoso.com" + SettingsScope = "WebApplication" + AllowSharePointDesigner = $false + AllowDetachPagesFromDefinition = $false + AllowCustomiseMasterPage = $false + AllowManageSiteURLStructure = $false + AllowCreateDeclarativeWorkflow = $false + AllowSavePublishDeclarativeWorkflow = $false + AllowSaveDeclarativeWorkflowAsTemplate = $false + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPDiagnosticLoggingSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPDiagnosticLoggingSettings.help.txt new file mode 100644 index 000000000..e7aed4e26 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPDiagnosticLoggingSettings.help.txt @@ -0,0 +1,54 @@ +NAME + xSPDiagnosticLoggingSettings + +PARAMETERS + LogPath (Key, string) + LogSpaceInGB (Required, uint32) + AppAnalyticsAutomaticUploadEnabled (Write, boolean) + CustomerExperienceImprovementProgramEnabled (Write, boolean) + DaysToKeepLogs (Write, uint32) + DownloadErrorReportingUpdatesEnabled (Write, boolean) + ErrorReportingAutomaticUploadEnabled (Write, boolean) + ErrorReportingEnabled (Write, boolean) + EventLogFloodProtectionEnabled (Write, boolean) + EventLogFloodProtectionNotifyInterval (Write, uint32) + EventLogFloodProtectionQuietPeriod (Write, uint32) + EventLogFloodProtectionThreshold (Write, uint32) + EventLogFloodProtectionTriggerPeriod (Write, uint32) + LogCutInterval (Write, uint32) + LogMaxDiskSpaceUsageEnabled (Write, boolean) + ScriptErrorReportingDelay (Write, uint32) + ScriptErrorReportingEnabled (Write, boolean) + ScriptErrorReportingRequireAuth (Write, boolean) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is responsible for configuring settings to do with the diagnostic (ULS) logging on servers in the farm. +These settings are applied to the diagnostic logging service for the farm and do not need to be applied to each server individually, the settings will be propagated throughout the farm when they are set. + +EXAMPLE + + xSPDiagnosticLoggingSettings ApplyDiagnosticLogSettings + { + PsDscRunAsCredential = $InstallAccount + LogPath = "L:\ULSLogs" + LogSpaceInGB = 10 + AppAnalyticsAutomaticUploadEnabled = $false + CustomerExperienceImprovementProgramEnabled = $true + DaysToKeepLogs = 7 + DownloadErrorReportingUpdatesEnabled = $false + ErrorReportingAutomaticUploadEnabled = $false + ErrorReportingEnabled = $false + EventLogFloodProtectionEnabled = $true + EventLogFloodProtectionNotifyInterval = 5 + EventLogFloodProtectionQuietPeriod = 2 + EventLogFloodProtectionThreshold = 5 + EventLogFloodProtectionTriggerPeriod = 2 + LogCutInterval = 15 + LogMaxDiskSpaceUsageEnabled = $true + ScriptErrorReportingDelay = 30 + ScriptErrorReportingEnabled = $true + ScriptErrorReportingRequireAuth = $true + } + diff --git a/Modules/xSharePoint/en-us/about_xSPDistributedCacheService.help.txt b/Modules/xSharePoint/en-us/about_xSPDistributedCacheService.help.txt new file mode 100644 index 000000000..8801f477f --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPDistributedCacheService.help.txt @@ -0,0 +1,30 @@ +NAME + xSPDistributedCacheService + +PARAMETERS + Name (Key, String) + Ensure (Required, string, Allowed values: Present, Absent) + CacheSizeInMB (Required, UInt32) + ServiceAccount (Required, String) + InstallAccount (Write, String) + CreateFirewallRules (Required, Boolean) + +DESCRIPTION + +This resource is responsible for provisioning the distributed cache to the service it runs on. +This is required in your farm on at least one server (as the behavior of [xSPCreateFarm](xSPCreateFarm) and [xSPJoinFarm](xSPJoinFarm) is to not enroll every server as a cache server). +The service will be provisioned or de-provisioned based on the Ensure property, and when provisioned the CacheSizeInMB property and ServiceAccount property will be used to configure it. +The property createFirewallRules is used to determine if exceptions should be added to the windows firewall to allow communication between servers on the appropriate ports. + +EXAMPLE + + xSPDistributedCacheService EnableDistributedCache + { + Name = "AppFabricCachingService" + Ensure = "Present" + CacheSizeInMB = 8192 + ServiceAccount = "DEMO\ServiceAccount" + InstallAccount = $InstallAccount + CreateFirewallRules = $true + } + diff --git a/Modules/xSharePoint/en-us/about_xSPFarmAdministrators.help.txt b/Modules/xSharePoint/en-us/about_xSPFarmAdministrators.help.txt new file mode 100644 index 000000000..e93f8e886 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPFarmAdministrators.help.txt @@ -0,0 +1,25 @@ +NAME + xSPFarmAdministrators + +PARAMETERS + Name (Key, String) + Members (Write, String) + MembersToInclude (Write, String) + MembersToExclude (Write, String) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to manage the membership of the farm administrators group. +There are a number of approaches to how this can be implemented. +The "members" property will set a specific list of members for the group, making sure that every user/group in the list is in the group and all others that are members and who are not in this list will be removed. +The "MembersToInclude" and "MembersToExclude" properties will allow you to control a specific set of users to add or remove, without changing any other members that are in the group already that may not be specified here, allowing for some manual management outside of this configuration resource. + +EXAMPLE + + xSPFarmAdministrators LocalFarmAdmins + { + Name = "Farm Administrators" + Members = @("CONTOSO\user1", "CONTOSO\user2") + } + diff --git a/Modules/xSharePoint/en-us/about_xSPFeature.help.txt b/Modules/xSharePoint/en-us/about_xSPFeature.help.txt new file mode 100644 index 000000000..819300593 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPFeature.help.txt @@ -0,0 +1,27 @@ +NAME + xSPFeature + +PARAMETERS + Name (Key, string) + FeatureScope (Required, string, Allowed values: Farm, WebApplication, Site, Web) + Url (Key, string) + InstallAccount (Write, String) + Ensure (Required, string, Allowed values: Present, Absent) + +DESCRIPTION + +This resource is used to make sure that a specific feature is either enabled or disabled at a given URL/scope. +The Ensure property will dictate if the feature should be on or off. +The name property is the name of the feature based on its folder name in the FEATURES folder in the SharePoint hive directory. + +EXAMPLE + + xSPFeature EnableViewFormsLockDown + { + Name = "ViewFormPagesLockDown" + Url = "http://www.contoso.com" + Ensure = "Present" + Scope = "Site" + PsDscRunAsCredential = $SetupAccuount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPHealthAnalyzerRuleState.help.txt b/Modules/xSharePoint/en-us/about_xSPHealthAnalyzerRuleState.help.txt new file mode 100644 index 000000000..46f3efb57 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPHealthAnalyzerRuleState.help.txt @@ -0,0 +1,28 @@ +NAME + xSPHealthAnalyzerRuleState + +PARAMETERS + Name (Key, String) + Enabled (Required, Boolean) + RuleScope (Write, String, Allowed values: All Servers, Any Server) + Schedule (Write, String, Allowed values: Hourly, Daily, Weekly, Monthly, OnDemandOnly) + FixAutomatically (Write, Boolean) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPHealthAnalyzerRuleState DisableDiskSpaceRule + { + Name = "Drives are at risk of running out of free space." + Enabled = $true + RuleScope = "All Servers" + Schedule = "Daily" + FixAutomatically = $false + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPInstall.help.txt b/Modules/xSharePoint/en-us/about_xSPInstall.help.txt new file mode 100644 index 000000000..11fd1b24d --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPInstall.help.txt @@ -0,0 +1,37 @@ +NAME + xSPInstall + +PARAMETERS + BinaryDir (Key, String) + ProductKey (Required, String) + Ensure (Required, string, Allowed values: Present, Absent) + +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 [xSPInstallPreReqs](xSPInstallPreReqs). + +EXAMPLE + + xSPInstall InstallBinaries + { + BinaryDir = "C:\SPInstall" + ProductKey = $ProductKey + } + +**Installing SharePoint Foundation 2013** + +Currently SharePoint Foundation is not supported by xSPInstall (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 + } + diff --git a/Modules/xSharePoint/en-us/about_xSPInstallPrereqs.help.txt b/Modules/xSharePoint/en-us/about_xSPInstallPrereqs.help.txt new file mode 100644 index 000000000..2df04ba51 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPInstallPrereqs.help.txt @@ -0,0 +1,69 @@ +NAME + xSPInstallPrereqs + +PARAMETERS + InstallerPath (Key, String) + OnlineMode (Required, Boolean) + SQLNCli (Write, String) + PowerShell (Write, String) + NETFX (Write, String) + IDFX (Write, String) + Sync (Write, String) + AppFabric (Write, String) + IDFX11 (Write, String) + MSIPCClient (Write, String) + WCFDataServices (Write, String) + KB2671763 (Write, String) + WCFDataServices56 (Write, String) + KB2898850 (Write, String) + MSVCRT11 (Write, String) + MSVCRT14 (Write, String) + KB3092423 (Write, String) + ODBC (Write, String) + DotNet452 (Write, String) + Ensure (Required, string, Allowed values: Present, Absent) + +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. + +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: + + xSPInstallPrereqs InstallPrerequisites + { + InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" + OnlineMode = $true + } + +Offline example: + + xSPInstallPrereqs InstallPrerequisites + { + InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" + OnlineMode = $false + 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/xSharePoint/en-us/about_xSPJoinFarm.help.txt b/Modules/xSharePoint/en-us/about_xSPJoinFarm.help.txt new file mode 100644 index 000000000..5c3151c05 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPJoinFarm.help.txt @@ -0,0 +1,26 @@ +NAME + xSPJoinFarm + +PARAMETERS + FarmConfigDatabaseName (Key, string) + DatabaseServer (Key, string) + InstallAccount (Write, String) + Passphrase (Required, string) + ServerRole (Write, string, Allowed values: Application, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, SpecialLoad, WebFrontEnd) + +DESCRIPTION + +This resource will be responsible for joining a server to an existing SharePoint farm. +To create a new farm use the [xSPCreateFarm](xSPCreateFarm) 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 + + xSPJoinFarm JoinSPFarm + { + DatabaseServer = $DatabaseServer + FarmConfigDatabaseName = "SP_Config" + Passphrase = $FarmPassPhrase + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPManagedAccount.help.txt b/Modules/xSharePoint/en-us/about_xSPManagedAccount.help.txt new file mode 100644 index 000000000..b9a08d091 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPManagedAccount.help.txt @@ -0,0 +1,26 @@ +NAME + xSPManagedAccount + +PARAMETERS + AccountName (Key, string) + Account (Required, String) + InstallAccount (Write, String) + EmailNotification (Write, Uint32) + PreExpireDays (Write, Uint32) + Schedule (Write, string) + +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. + +EXAMPLE + + xSPManagedAccount WebPoolManagedAccount + { + AccountName = $WebPoolManagedAccount.UserName + Account = $WebPoolManagedAccount + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPManagedMetaDataServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPManagedMetaDataServiceApp.help.txt new file mode 100644 index 000000000..ddf468d41 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPManagedMetaDataServiceApp.help.txt @@ -0,0 +1,27 @@ +NAME + xSPManagedMetaDataServiceApp + +PARAMETERS + Name (Key, string) + InstallAccount (Write, String) + ApplicationPool (Required, string) + DatabaseServer (Write, string) + DatabaseName (Write, string) + +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. + +EXAMPLE + + xSPManagedMetaDataServiceApp ManagedMetadataServiceApp + { + Name = "Managed Metadata Service Application" + InstallAccount = $InstallAccount + ApplicationPool = "SharePoint Service Applications" + DatabaseServer = $DatabaseServer + DatabaseName = "SP_ManagedMetadata" + } + diff --git a/Modules/xSharePoint/en-us/about_xSPManagedPath.help.txt b/Modules/xSharePoint/en-us/about_xSPManagedPath.help.txt new file mode 100644 index 000000000..28e0a61f8 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPManagedPath.help.txt @@ -0,0 +1,28 @@ +NAME + xSPManagedPath + +PARAMETERS + WebAppUrl (Key, string) + InstallAccount (Write, String) + RelativeUrl (Key, string) + Explicit (Required, boolean) + HostHeader (Required, boolean) + +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. + +EXAMPLE + + xSPManagedPath TeamsManagedPath + { + WebAppUrl = "http://sharepoint.contoso.com" + InstallAccount = $InstallAccount + RelativeUrl = "teams" + Explicit = $false + HostHeader = $true + } + diff --git a/Modules/xSharePoint/en-us/about_xSPOutgoingEmailSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPOutgoingEmailSettings.help.txt new file mode 100644 index 000000000..a04ccfe2c --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPOutgoingEmailSettings.help.txt @@ -0,0 +1,28 @@ +NAME + xSPOutgoingEmailSettings + +PARAMETERS + WebAppUrl (key, string) + SMTPServer (Required, string) + FromAddress (Required, string) + ReplyToAddress (Required, string) + CharacterSet (Required, string) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPOutgoingEmailSettings FarmWideEmailSettings + { + WebAppUrl = "http://sharepoint1:2013" + SMTPServer = "smtp.contoso.com" + FromAddress = "sharepoint@contoso.com" + ReplyToAddress = "noreply@contoso.com" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPPasswordChangeSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPPasswordChangeSettings.help.txt new file mode 100644 index 000000000..500f86ecb --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPPasswordChangeSettings.help.txt @@ -0,0 +1,27 @@ +NAME + xSPPasswordChangeSettings + +PARAMETERS + MailAddress (key, string) + DaysBeforeExpiry (Write, Uint32) + PasswordChangeWaitTimeSeconds (Write, Uint32) + NumberOfRetries (Write, Uint32) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPPasswordChangeSettings ManagedAccountPasswordResetSettings + { + MailAddress = "sharepoint@contoso.com" + DaysBeforeExpiry = "14" + PasswordChangeWaitTimeSeconds = "60" + NumberOfRetries = "3" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPQuotaTemplate.help.txt b/Modules/xSharePoint/en-us/about_xSPQuotaTemplate.help.txt new file mode 100644 index 000000000..8e259c1c1 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPQuotaTemplate.help.txt @@ -0,0 +1,29 @@ +NAME + xSPQuotaTemplate + +PARAMETERS + Name (Key, string) + StorageMaxInMB (Write, uint32) + StorageWarningInMB (Write, uint32) + MaximumUsagePointsSolutions (Write, uint32) + WarningUsagePointsSolutions (Write, uint32) + Ensure (Required, string, Allowed values: Present, Absent) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPQuotaTemplate TeamsiteTemplate + { + Name = "Teamsite" + StorageMaxInMB = 1024 + StorageWarningInMB = 512 + MaximumUsagePointsSolutions = 1000 + WarningUsagePointsSolutions = 800 + Ensure = "Present" + } + diff --git a/Modules/xSharePoint/en-us/about_xSPSearchIndexPartition.help.txt b/Modules/xSharePoint/en-us/about_xSPSearchIndexPartition.help.txt new file mode 100644 index 000000000..1f04f5bb9 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSearchIndexPartition.help.txt @@ -0,0 +1,35 @@ +NAME + xSPSearchIndexPartition + +PARAMETERS + Index (Key, Uint32) + Servers (Required, String) + RootDirectory (Write, String) + ServiceAppName (Required, String) + InstallAccount (Write, String) + +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 xSPSearchRoles 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 + + xSPSearchIndexPartition MainSearchPartition + { + Servers = @("Server2", "Server3") + Index = 1 + RootDirectory = "I:\SearchIndexes\1" + ServiceAppName = "Search Service Application" + PsDscRunAsCredential = $SPSetupAccount + DependsOn = "[xSPSearchRoles]LocalSearchRoles" + } + diff --git a/Modules/xSharePoint/en-us/about_xSPSearchServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPSearchServiceApp.help.txt new file mode 100644 index 000000000..e8a2d3cd5 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSearchServiceApp.help.txt @@ -0,0 +1,27 @@ +NAME + xSPSearchServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, string) + DatabaseName (Write, string) + DatabaseServer (Write, string) + InstallAccount (Write, String) + +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). + +EXAMPLE + + xSPSearchServiceApp SearchServiceApp + { + Name = "Search Service Application" + DatabaseName = "SP_Search" + ApplicationPool = "SharePoint Service Applications" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPSearchTopology.help.txt b/Modules/xSharePoint/en-us/about_xSPSearchTopology.help.txt new file mode 100644 index 000000000..74352442f --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSearchTopology.help.txt @@ -0,0 +1,42 @@ +NAME + xSPSearchTopology + +PARAMETERS + ServiceAppName (Key, String) + Admin (Required, String) + Crawler (Required, String) + ContentProcessing (Required, String) + AnalyticsProcessing (Required, String) + QueryProcessing (Required, String) + IndexPartition (Required, String) + FirstPartitionDirectory (Required, String) + InstallAccount (Write, String) + +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 xSPSearchIndexPartition 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 + + xSPSearchRoles LocalSearchRoles + { + 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") + } + diff --git a/Modules/xSharePoint/en-us/about_xSPSecureStoreServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPSecureStoreServiceApp.help.txt new file mode 100644 index 000000000..0c4281926 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSecureStoreServiceApp.help.txt @@ -0,0 +1,34 @@ +NAME + xSPSecureStoreServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, string) + AuditingEnabled (Required, boolean) + AuditlogMaxSize (Write, uint32) + DatabaseCredentials (Write, String) + DatabaseName (Write, string) + DatabaseServer (Write, string) + DatabaseAuthenticationType (Write, string, Allowed values: Windows, SQL) + FailoverDatabaseServer (Write, string) + PartitionMode (Write, boolean) + Sharing (Write, boolean) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPSecureStoreServiceApp SecureStoreServiceApp + { + Name = "Secure Store Service Application" + ApplicationPool = "SharePoint Service Applications" + AuditingEnabled = $true + AuditlogMaxSize = 30 + DatabaseName = "SP_SecureStore" + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPServiceAppPool.help.txt b/Modules/xSharePoint/en-us/about_xSPServiceAppPool.help.txt new file mode 100644 index 000000000..0290e3773 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPServiceAppPool.help.txt @@ -0,0 +1,22 @@ +NAME + xSPServiceAppPool + +PARAMETERS + Name (Key, string) + ServiceAccount (Required, string) + InstallAccount (Write, String) + +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 [xSPManagedAccount](xSPManagedAccount)). + +EXAMPLE + + xSPServiceAppPool MainServiceAppPool + { + Name = "SharePoint Service Applications" + ServiceAccount = "Demo\ServiceAccount" + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPServiceInstance.help.txt b/Modules/xSharePoint/en-us/about_xSPServiceInstance.help.txt new file mode 100644 index 000000000..54e28c49c --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPServiceInstance.help.txt @@ -0,0 +1,29 @@ +NAME + xSPServiceInstance + +PARAMETERS + Name (Key, string) + InstallAccount (Write, String) + Ensure (Required, string, Allowed values: Present, Absent) + +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. + +**Examples** + + xSPServiceInstance ManagedMetadataServiceInstance + { + Name = "Managed Metadata Web Service" + Ensure = "Present" + InstallAccount = $InstallAccount + } + + xSPServiceInstance StopBCSServiceInstance + { + Name = "Business Data Connectivity Service" + Ensure = "Absent" + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPSessionStateService.help.txt b/Modules/xSharePoint/en-us/about_xSPSessionStateService.help.txt new file mode 100644 index 000000000..ac4c84fe8 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSessionStateService.help.txt @@ -0,0 +1,26 @@ +NAME + xSPSessionStateService + +PARAMETERS + DatabaseName (Key, string) + DatabaseServer (Key, string) + Enabled (Required, boolean) + SessionTimeout (Write, uint32) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPSessionStateService StateServiceApp + { + DatabaseName = "SP_StateService" + DatabaseServer = "SQL.test.domain" + Enabled = $true + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPShellAdmins.help.txt b/Modules/xSharePoint/en-us/about_xSPShellAdmins.help.txt new file mode 100644 index 000000000..99744b488 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPShellAdmins.help.txt @@ -0,0 +1,56 @@ +NAME + xSPShellAdmins + +PARAMETERS + Name (Key, String) + Members (Write, String) + MembersToInclude (Write, String) + MembersToExclude (Write, String) + ContentDatabases (Write, String) + AllContentDatabases (Write, Boolean) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + AllContentDatabases = $true + } + + xSPShellAdmins ShellAdmins + { + Name = "Shell Admins" + Members = "CONTOSO\user1", "CONTOSO\user2" + ContentDatabases = @( + @(MSFT_xSPContentDatabasePermissions { + Name = "SharePoint_Content_1" + Members = "CONTOSO\user2", "CONTOSO\user3" + }) + @(MSFT_xSPContentDatabasePermissions { + Name = "SharePoint_Content_2" + Members = "CONTOSO\user3", "CONTOSO\user4" + }) + ) + } + + diff --git a/Modules/xSharePoint/en-us/about_xSPSite.help.txt b/Modules/xSharePoint/en-us/about_xSPSite.help.txt new file mode 100644 index 000000000..86229eb8a --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSite.help.txt @@ -0,0 +1,38 @@ +NAME + xSPSite + +PARAMETERS + Url (Key, string) + OwnerAlias (Required, string) + CompatibilityLevel (Write, uint32) + ContentDatabase (Write, string) + Description (Write, string) + HostHeaderWebApplication (Write, string) + Language (Write, uint32) + Name (Write, string) + OwnerEmail (Write, string) + QuotaTemplate (Write, string) + SecondaryEmail (Write, string) + SecondaryOwnerAlias (Write, string) + Template (Write, string) + InstallAccount (Write, String) + +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 xSharePoint 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 + + xSPSite TeamSite + { + Url = "http://sharepoint.contoso.com" + OwnerAlias = "CONTOSO\ExampleUser" + HostHeaderWebApplication = "http://spsites.contoso.com" + Name = "Team Sites" + Template = "STS#0" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPStateServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPStateServiceApp.help.txt new file mode 100644 index 000000000..8549522bb --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPStateServiceApp.help.txt @@ -0,0 +1,24 @@ +NAME + xSPStateServiceApp + +PARAMETERS + Name (Key, string) + DatabaseCredentials (Write, String) + DatabaseName (Required, string) + DatabaseServer (Write, string) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPStateServiceApp StateServiceApp + { + Name = "State Service Application" + DatabaseName = "SP_State" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPSubscriptionSettingsServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPSubscriptionSettingsServiceApp.help.txt new file mode 100644 index 000000000..de49e3053 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPSubscriptionSettingsServiceApp.help.txt @@ -0,0 +1,27 @@ +NAME + xSPSubscriptionSettingsServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, String) + DatabaseName (Write, string) + DatabaseServer (Write, String) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to provision and manage an instance of the App Management Services Service Application. +It will identify an instance of the 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 + + xSPSubscriptionSettingsServiceApp SubscriptionSettingsServiceApp + { + Name = "Subscription Settings Service Application" + AppPool = "SharePoint web services" + DatabaseServer = "SQL01.contoso.com" + DatabaseName = "SP_ManagedMetadata" + } + diff --git a/Modules/xSharePoint/en-us/about_xSPTimerJobState.help.txt b/Modules/xSharePoint/en-us/about_xSPTimerJobState.help.txt new file mode 100644 index 000000000..4bc7d8751 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPTimerJobState.help.txt @@ -0,0 +1,38 @@ +NAME + xSPTimerJobState + +PARAMETERS + Name (Key, String) + WebApplication (Write, String) + Enabled (Write, Boolean) + Schedule (Write, String) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPTimerJobState DisableTimerJob_DeadSiteDelete + { + Name = "job-dead-site-delete" + WebApplication = "http://sites.sharepoint.contoso.com" + Enabled = $true + Schedule ="weekly at sat 5:00" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPUsageApplication.help.txt b/Modules/xSharePoint/en-us/about_xSPUsageApplication.help.txt new file mode 100644 index 000000000..b37395cc5 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPUsageApplication.help.txt @@ -0,0 +1,32 @@ +NAME + xSPUsageApplication + +PARAMETERS + Name (Key, string) + InstallAccount (Write, String) + DatabaseName (Write, string) + DatabaseServer (Write, string) + DatabaseCredentials (Write, String) + FailoverDatabaseServer (Write, string) + UsageLogCutTime (Write, uint32) + UsageLogLocation (Write, string) + UsageLogMaxFileSizeKB (Write, uint32) + UsageLogMaxSpaceGB (Write, uint32) + +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. + +EXAMPLE + + xSPUsageApplication UsageApplication + { + Name = "Usage Service Application" + DatabaseName = "SP_Usage" + UsageLogCutTime = 5 + UsageLogLocation = "L:\UsageLogs" + UsageLogMaxFileSizeKB = 1024 + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPUserProfileProperty.help.txt b/Modules/xSharePoint/en-us/about_xSPUserProfileProperty.help.txt new file mode 100644 index 000000000..a6a3c7728 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPUserProfileProperty.help.txt @@ -0,0 +1,69 @@ +NAME + xSPUserProfileProperty + +PARAMETERS + Name (Key, string) + Ensure (write, string, Allowed values: Present, Absent) + UserProfileService (required, string) + DisplayName (write, string) + Type (write, string, Allowed values: BigInteger, Binary, Boolean, Date, DateNoYear, DateTime, Email, Float, Guid, HTML, Integer, Person, String, StringMultiValue, TimeZone, URL) + Description (write, string) + PolicySetting (write, string, Allowed values: Mandatory, Optin, Optout, Disabled) + PrivacySetting (write, string, Allowed values: Public, Contacts, Organization, Manager, Private) + MappingConnectionName (write, string) + MappingPropertyName (write, string) + MappingDirection (write, string) + Length (write, uint32) + DisplayOrder (write, uint32) + IsEventLog (write, boolean) + IsVisibleOnEditor (write, boolean) + IsVisibleOnViewer (write, boolean) + IsUserEditable (write, boolean) + IsAlias (write, boolean) + IsSearchable (write, boolean) + UserOverridePrivacy (write, boolean) + TermStore (write, string) + TermGroup (write, string) + TermSet (write, string) + InstallAccount (Write, String) + +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 + +EXAMPLE +xSPUserProfileProperty WorkEmailProperty +{ + Name = "WorkEmail2" + UserProfileService = "User Profile Service Application" + DisplayName = "Work Email" + Type = "Email" + Description = "" #implementation isn't using it yet + PolicySetting = "Required" + PrivacySetting = "Everyone" + 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 +} + + diff --git a/Modules/xSharePoint/en-us/about_xSPUserProfileServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPUserProfileServiceApp.help.txt new file mode 100644 index 000000000..a8ed83351 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPUserProfileServiceApp.help.txt @@ -0,0 +1,40 @@ +NAME + xSPUserProfileServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, string) + FarmAccount (Required, String) + InstallAccount (Write, String) + MySiteHostLocation (Write, string) + ProfileDBName (Write, string) + ProfileDBServer (Write, string) + SocialDBName (Write, string) + SocialDBServer (Write, string) + SyncDBName (Write, string) + SyncDBServer (Write, string) + +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. + +EXAMPLE + + xSPUserProfileServiceApp 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" + FarmAccount = $FarmAccount + PsDscRunAsCredential = $SetupAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPUserProfileSyncConnection.help.txt b/Modules/xSharePoint/en-us/about_xSPUserProfileSyncConnection.help.txt new file mode 100644 index 000000000..f62a3588b --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPUserProfileSyncConnection.help.txt @@ -0,0 +1,37 @@ +NAME + xSPUserProfileSyncConnection + +PARAMETERS + Name (Key, string) + Forest (Required, string) + UserProfileService (Required, string) + ConnectionCredentials (Required, string) + InstallAccount (Write, string) + IncludedOUs (Required, string) + ExcludedOUs (write, string) + Server (write, string) + UseSSL (Write, boolean) + Force (Write, boolean) + ConnectionType (Write, string, Allowed values: ActiveDirectory, BusinessDataCatalog) + +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. +EXAMPLE + + xSPUserProfileSyncConnection 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" +} + diff --git a/Modules/xSharePoint/en-us/about_xSPUserProfileSyncService.help.txt b/Modules/xSharePoint/en-us/about_xSPUserProfileSyncService.help.txt new file mode 100644 index 000000000..bed8e8027 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPUserProfileSyncService.help.txt @@ -0,0 +1,26 @@ +NAME + xSPUserProfileSyncService + +PARAMETERS + UserProfileServiceAppName (Key, string) + Ensure (Required, string, Allowed values: Present, Absent) + FarmAccount (Required, String) + InstallAccount (Write, String) + +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. + +EXAMPLE + + xSPUserProfileSyncService UserProfileSyncService + { + UserProfileServiceAppName = "User Profile Service Application" + Ensure = "Present" + FarmAccount = $FarmAccount + InstallAccount = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPVisioServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPVisioServiceApp.help.txt new file mode 100644 index 000000000..f19b6fcf6 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPVisioServiceApp.help.txt @@ -0,0 +1,18 @@ +NAME + xSPVisioServiceApp + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, string) + +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. +EXAMPLE + xSPVisioServiceApp VisioServices + { + Name = "Visio Graphics Service Application" + ApplicationPool = "SharePoint Web Services" + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebAppBlockedFileTypes.help.txt b/Modules/xSharePoint/en-us/about_xSPWebAppBlockedFileTypes.help.txt new file mode 100644 index 000000000..f726bdcb3 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebAppBlockedFileTypes.help.txt @@ -0,0 +1,30 @@ +NAME + xSPWebAppBlockedFileTypes + +PARAMETERS + Url (Key, string) + Blocked (write, string) + EnsureBlocked (write, string) + EnsureAllowed (write, string) + InstallAccount (Write, string) + +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. + +EXAMPLE + + xSPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes + { + Url = "Shttp://exmaple.contoso.local" + EnsureBlocked = @("exe", "dll", "msi") + EnsureAllowed = @("pdf", "docx", "xlsx") + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebAppGeneralSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPWebAppGeneralSettings.help.txt new file mode 100644 index 000000000..9ac055e73 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebAppGeneralSettings.help.txt @@ -0,0 +1,39 @@ +NAME + xSPWebAppGeneralSettings + +PARAMETERS + Url (Key, string) + TimeZone (write, uint32) + Alerts (write, boolean) + AlertsLimit (write, uint32) + RSS (write, boolean) + BlogAPI (write, boolean) + BlogAPIAuthenticated (write, boolean) + BrowserFileHandling (write, String, Allowed values: Strict, Permissive) + SecurityValidation (write, boolean) + RecycleBinEnabled (write, boolean) + RecycleBinCleanupEnabled (write, boolean) + RecycleBinRetentionPeriod (write, uint32) + SecondStageRecycleBinQuota (write, uint32) + MaximumUploadSize (write, uint32) + CustomerExperienceProgram (write, boolean) + PresenceEnabled (write, boolean) + InstallAccount (Write, string) + +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). + +EXAMPLE + + xSPWebAppGeneralSettings PrimaryWebAppGeneralSettings + { + Url = "Shttp://exmaple.contoso.local" + TimeZone = 76 + Alerts = $true + RSS = $false + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebAppPolicy.help.txt b/Modules/xSharePoint/en-us/about_xSPWebAppPolicy.help.txt new file mode 100644 index 000000000..890f39792 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebAppPolicy.help.txt @@ -0,0 +1,24 @@ +NAME + xSPWebAppPolicy + +PARAMETERS + WebAppUrl (Key, string) + UserName (Key, string) + PermissionLevel (Required, string, Allowed values: Deny All, Deny Write, Full Read, Full Control) + ActAsSystemUser (Write, boolean) + InstallAccount (Write, String) + +DESCRIPTION + +This resource is used to set the "super user" and "super reader" cache accounts for the specified web application object (as described in the TechNet article [Configure object cache user accounts in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/ff758656.aspx)). + +EXAMPLE + + xSPCacheAccounts SetCacheAccounts + { + WebAppUrl = "http://sharepoint.contoso.com" + SuperUserAlias = "DEMO\svcSPSuperUser" + SuperReaderAlias = "DEMO\svcSPReader" + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebAppSiteUseAndDeletion.help.txt b/Modules/xSharePoint/en-us/about_xSPWebAppSiteUseAndDeletion.help.txt new file mode 100644 index 000000000..9119180e2 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebAppSiteUseAndDeletion.help.txt @@ -0,0 +1,28 @@ +NAME + xSPWebAppSiteUseAndDeletion + +PARAMETERS + Url (Key, string) + SendUnusedSiteCollectionNotifications (write, boolean) + UnusedSiteNotificationPeriod (write, uint32) + AutomaticallyDeleteUnusedSiteCollections (write, boolean) + UnusedSiteNotificationsBeforeDeletion (write, uint32) + InstallAccount (Write, string) + +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. + +EXAMPLE + + xSPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion + { + Url = "http://example.contoso.local" + SendUnusedSiteCollectionNotifications = $true + UnusedSiteNotificationPeriod = 90 + AutomaticallyDeleteUnusedSiteCollections = $true + UnusedSiteNotificationsBeforeDeletion = 24 + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebAppThrottlingSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPWebAppThrottlingSettings.help.txt new file mode 100644 index 000000000..b56203227 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebAppThrottlingSettings.help.txt @@ -0,0 +1,42 @@ +NAME + xSPWebAppThrottlingSettings + +PARAMETERS + Url (Key, string) + ListViewThreshold (write, uint32) + AllowObjectModelOverride (write, boolean) + AdminThreshold (write, uint32) + ListViewLookupThreshold (write, uint32) + HappyHourEnabled (write, boolean) + HappyHour (Write, string) + UniquePermissionThreshold (write, uint32) + RequestThrottling (write, boolean) + ChangeLogEnabled (write, boolean) + ChangeLogExpiryDays (write, uint32) + EventHandlersEnabled (write, boolean) + InstallAccount (Write, string) + +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. + +EXAMPLE + + xSPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings + { + Url = "Shttp://exmaple.contoso.local" + ListViewThreshold = 5000 + AllowObjectModelOverride = $false + HappyHourEnabled = $true + HappyHour = MSFT_xSPWebApplicationHappyHour { + Hour = 3 + Minute = 0 + Duration = 1 + } + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebAppWorkflowSettings.help.txt b/Modules/xSharePoint/en-us/about_xSPWebAppWorkflowSettings.help.txt new file mode 100644 index 000000000..1b8513563 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebAppWorkflowSettings.help.txt @@ -0,0 +1,26 @@ +NAME + xSPWebAppWorkflowSettings + +PARAMETERS + Url (Key, string) + ExternalWorkflowParticipantsEnabled (write, boolean) + UserDefinedWorkflowsEnabled (write, boolean) + EmailToNoPermissionWorkflowParticipantsEnable (write, boolean) + InstallAccount (Write, string) + +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). + +EXAMPLE + + xSPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings + { + Url = "Shttp://exmaple.contoso.local" + ExternalWorkflowParticipantsEnabled = $false + EmailToNoPermissionWorkflowParticipantsEnable = $false + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebApplication.help.txt b/Modules/xSharePoint/en-us/about_xSPWebApplication.help.txt new file mode 100644 index 000000000..0810cc7c8 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebApplication.help.txt @@ -0,0 +1,38 @@ +NAME + xSPWebApplication + +PARAMETERS + Name (Key, string) + ApplicationPool (Required, string) + ApplicationPoolAccount (Required, string) + Url (Required, string) + AllowAnonymous (Write, boolean) + AuthenticationMethod (Write, string, Allowed values: NTLM, Kerberos) + DatabaseName (Write, string) + DatabaseServer (Write, string) + HostHeader (Write, string) + Path (Write, string) + Port (Write, string) + InstallAccount (Write, string) + +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). + +EXAMPLE + + xSPWebApplication 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 + PsDscRunAsCredential = $InstallAccount + } + diff --git a/Modules/xSharePoint/en-us/about_xSPWebApplicationAppDomain.help.txt b/Modules/xSharePoint/en-us/about_xSPWebApplicationAppDomain.help.txt new file mode 100644 index 000000000..09814c517 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWebApplicationAppDomain.help.txt @@ -0,0 +1,31 @@ +NAME + xSPWebApplicationAppDomain + +PARAMETERS + WebApplication (Key, string) + Zone (Key, string, Allowed values: Default, Internet, Intranet, Extranet, Custom) + AppDomain (Required, string) + Port (Write, string) + SSL (Write, boolean) + InstallAccount (Write, String) + +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 xSPAppDomain resource before this is applied to customise a specific zone. + + +EXAMPLE + + xSPWebApplicationAppDomain Domain + { + AppDomain = "contosointranetapps.com" + WebApplication ="http://portal.contoso.com"; + Zone = "Default"; + Port = 80; + SSL = $false; + PsDscRunAsCredential = $InstallAccount + } + + diff --git a/Modules/xSharePoint/en-us/about_xSPWordAutomationServiceApp.help.txt b/Modules/xSharePoint/en-us/about_xSPWordAutomationServiceApp.help.txt new file mode 100644 index 000000000..7aa2c5d23 --- /dev/null +++ b/Modules/xSharePoint/en-us/about_xSPWordAutomationServiceApp.help.txt @@ -0,0 +1,69 @@ +NAME + xSPWordAutomationServiceApp + +PARAMETERS + Name (Key, string) + Ensure (Required, string, Allowed values: Present, Absent) + ApplicationPool (Write, string) + DatabaseName (Write, string) + DatabaseServer (Write, string) + SupportedFileFormats (Write, string, Allowed values: docx, doc, mht, rtf, xml) + DisableEmbeddedFonts (Write, boolean) + MaximumMemoryUsage (Write, uint32) + RecycleThreshold (Write, uint32) + DisableBinaryFileScan (Write, boolean) + ConversionProcesses (Write, uint32) + JobConversionFrequency (Write, uint32) + NumberOfConversionsPerProcess (Write, uint32) + TimeBeforeConversionIsMonitored (Write, uint32) + MaximumConversionAttempts (Write, uint32) + MaximumSyncConversionRequests (Write, uint32) + KeepAliveTimeout (Write, uint32) + MaximumConversionTime (Write, uint32) + InstallAccount (Write, string) + +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). + +EXAMPLE + +Make sure the service application exists and has a specific configuration + + xSPWordAutomationServiceApp 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 + + xSPWordAutomationServiceApp Word Automation + { + Name = "Word Automation Service Application" + Ensure = "Absent" + PsDscRunAsCredential = $InstallAccount + } + From 389d8159391ab68c18cfb04791f95f26edd71e28 Mon Sep 17 00:00:00 2001 From: KarolKaczmarek Date: Wed, 3 Feb 2016 13:44:50 -0800 Subject: [PATCH 4/6] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f203ec3a1..6ce37fa10 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,10 @@ Additional detailed documentation is included on the wiki on GitHub. ### Unreleased +### 0.11.0.0 + + * Updates to module manifest file + ### 0.10.0.0 * Added xSPWordAutomationServiceApp, xSPHealthAnalyzerRuleState, xSPUserProfileProperty, xSPWorkManagementApp, xSPUserProfileSyncConnection and xSPShellAdmin resources From e2a18c9967aa72dd4a1f83df33978c9973850e94 Mon Sep 17 00:00:00 2001 From: KarolKaczmarek Date: Wed, 3 Feb 2016 13:45:18 -0800 Subject: [PATCH 5/6] Update xSharePoint.psd1 --- Modules/xSharePoint/xSharePoint.psd1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Modules/xSharePoint/xSharePoint.psd1 b/Modules/xSharePoint/xSharePoint.psd1 index 699a7b121..81741fa53 100644 --- a/Modules/xSharePoint/xSharePoint.psd1 +++ b/Modules/xSharePoint/xSharePoint.psd1 @@ -12,7 +12,7 @@ # RootModule = '' # Version number of this module. -ModuleVersion = '0.10.0.0' +ModuleVersion = '0.11.0.0' # ID used to uniquely identify this module GUID = '6c1176a0-4fac-4134-8ca2-3fa8a21a7b90' From 45bce6380da55efe77d0ac832679a1ab145826be Mon Sep 17 00:00:00 2001 From: KarolKaczmarek Date: Wed, 3 Feb 2016 13:45:45 -0800 Subject: [PATCH 6/6] Update appveyor.yml --- appveyor.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index 34b0ee083..430bcd22d 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,4 +1,4 @@ -version: 0.10.{build}.0 +version: 0.11.{build}.0 install: - cinst -y pester @@ -27,7 +27,7 @@ after_test: Remove-Item (Join-Path "$env:APPVEYOR_BUILD_FOLDER\modules\xSharePoint" "xSharePoint.pssproj") $manifest = Join-Path "$env:APPVEYOR_BUILD_FOLDER\modules\xSharePoint" "xSharePoint.psd1" - (Get-Content $manifest -Raw).Replace("0.10.0.0", $env:APPVEYOR_BUILD_VERSION) | Out-File $manifest + (Get-Content $manifest -Raw).Replace("0.11.0.0", $env:APPVEYOR_BUILD_VERSION) | Out-File $manifest Add-Type -assemblyname System.IO.Compression.FileSystem [System.IO.Compression.ZipFile]::CreateFromDirectory("$env:APPVEYOR_BUILD_FOLDER\modules\xSharePoint", "$env:APPVEYOR_BUILD_FOLDER\xSharePoint.zip") Get-ChildItem "$env:APPVEYOR_BUILD_FOLDER\xSharePoint.zip" | % { Push-AppveyorArtifact $_.FullName -FileName $_.Name }