Build status:
The xSharePoint PowerShell module provides DSC resources that can be used to deploy and manage a SharePoint farm.
This module is provided AS IS, and is not supported through any Microsoft standard support program or service. The "x" in xSharePoint stands for experimental, which means that these resources will be fix forward and monitored by the module owner(s).
Please leave comments, feature requests, and bug reports in the Q & A tab for this module.
If you would like to modify xSharePoint module, please feel free. When modifying, please update the module name, resource friendly name, and MOF class name (instructions below). As specified in the license, you may copy or modify this resource as long as they are used on the Windows Platform. Pleaes refer to the Contribution Guidelines for information about style guides, testing and patterns for contributing to DSC resources.
To install the xSharePoint module:
Unzip the content under $env:ProgramFiles\WindowsPowerShell\Modules folder
To confirm installation:
Run Get-DSCResource to see that xSharePoint is among the DSC Resources listed. Requirements This module requires the latest version of PowerShell (v4.0, which ships in Windows 8.1 or Windows Server 2012R2). To easily use PowerShell 4.0 on older operating systems, install WMF 4.0. Please read the installation instructions that are present on both the download page and the release notes for WMF 4.0
Below is a list of DSC resource types that are currently provided by xSharePoint:
- xBCSServiceApp
- xSPCacheAccounts
- xSPClearRemoteSessions
- xSPCreateFarm
- xSPDiagnosticLoggingSettings
- xSPDistributedCacheService
- xSPFeature
- xSPInstall
- xSPInstallPreReqs
- xSPJoinFarm
- xSPManagedAccount
- xSPManagedMetadataServiceApp
- xSPManagedPath
- xSPSearchServiceApp
- xSPSecureStoreServiceApp
- xSPServiceAppPool
- xSPServiceInstance
- xSPSite
- xSPStateServiceApp
- xSPUsageApplication
- xSPUserProfileServiceApp
- xSPUserProfileSyncService
- xSPWebApplication
Currently the xSharePoint resource is a work in progress that is not yet feature complete. Review the documentation on the wiki of the project on GitHub for details on current functionality, as well as any known issues as the team works towards a feature complete version 1.0
Review the "examples" directory in the xSharePoint resource for some general examples of how the overall module can be used. Additional detailed documentation is included on the wiki on GitHub.
- Support for MinRole options in SharePoint 2016
- Fix to distributed cache deployment of more than one server
- Additional bug fixes and stability improvements
- Added support for PsDscRunAsCredential in PowerShell 5 resource use
- Removed timeout loop in xSPJoinFarm in favour of WaitForAll resource in PowerShell 5
- Fixed bug with detection of version in create farm
- Minor fixes
- Added support for SharePoint 2016 installation
- MSFT_xSPCreateFarm: Added CentraladministrationPort parameter
- Fixed issue with PowerShell session timeouts
- Fixed issue with nested modules’ cmdlets not being found
- Fixed issue with detection of Identity Extensions in xSPInstallPrereqs resource
- Changes to comply with PSScriptAnalyzer rules
- Initial public release of xSharePoint