Announcing the xSharePoint module for PowerShell DSC!

I am super excited to be able to get this one out there - PowerShell Desired State Configuration (DSC) is a great mechanism to automate configurations of Windows Server and the products that run on them, but to date there has not been a set of DSC resources that allowed the deployment and configuration of SharePoint 2013. This is where the xSharePoint resource comes in! We are aiming to fill that gap and allow for DSC based deployment and configuration of servers in a SharePoint farm.

The current build is very much so a pre-release (version 0.2) and provides a starting point for DSC in the SharePoint space. It includes the following resources:

  •     xBCSServiceApp
  •     xSPCacheAccounts
  •     xSPClearRemoteSessions
  •     xSPCreateFarm
  •     xSPDiagnosticLoggingSettings
  •     xSPDistributedCacheService
  •     xSPFeature
  •     xSPInstall
  •     xSPInstallPreReqs
  •     xSPJoinFarm
  •     xSPManagedAccount
  •     xSPManagedMetadataServiceApp
  •     xSPManagedPath
  •     xSPSearchServiceApp
  •     xSPSecureStoreServiceApp
  •     xSPServiceAppPool
  •     xSPServiceInstance
  •     xSPSite
  •     xSPStateServiceApp
  •     xSPUsageApplication
  •     xSPUserProfileServiceApp
  •     xSPUserProfileSyncService
  •     xSPWebApplication

In the current version the majority of these resources are focused purely on deployment rather than ongoing management of their configuration (like I said, it's pre-release and early days), but we will be working on extending the functionality of these resources, as well as adding new ones as we move forward.

Want to get involved in contributing to the xSharePoint module? It's hosted on GitHub over at, and we would love to see your pull requests for changes and new features come through to be included in the project. If you are keen to contribute then have a look at our contribution guidelines for more information. Lastly be sure to have a look at the wiki for the documentation on how to make use of these DSC resources and some guidance on how to plan to implement xSharePoint.

I'm really looking forward to seeing this module develop and mature over the coming months, it's been great to work on it to date. I want to throw a big thank you out there to the Australian SharePoint PFE community who helped pull together this first cut, in particular Andrew Lynes and Cam Adams who put a lot of work in with me to help get this project going.

Let me know what you think in the comments, I absolutely welcome the feedback!

Comments (6)

  1. Anonymous says:

    Great work chaps!  I know we have had TOP MEN working on this, so looking forward to exploring it.

    Brian, in the words of the legendary Jack Gibson… "played strong, done good".

  2. Anonymous says:

    what the $$$$, best stuff on SharePoint Bing search has given me….Look ma, look at what I have stumbled upon!  This is gold.

  3. Andrew says:

    Brian, this looks really promising, though I still need to get my head round DSC in general. In next release will you be able to add support for multi-tenant SharePoint environments, adding "PartitionMode" flag to appropriate services applications and proxies?

  4. Hi Andrew,

    Multi-tenant support is on our to-do list, however its a bit further down it as there are more common scenarios we are looking to tackle first. However if you or anyone else want's to write it then I'm more than happy to accept pull requests to merge it in to the code base!

    – B

  5. Paul says:

    Is there any guidance anywhere on how to migrate from AutoSPInstaller to Desired State?

    1. This is on the road map, but not something we are ready to produce yet. We have a lot of areas of feature parity with AutoSPInstaller but there are still some elements that need addressing. Stay tuned though as this is absolutely on the road-map and will be addressed.

Skip to main content