Resource Type: dsc_spfarm

Defined in:

lib/puppet/type/dsc_spfarm.rb

Providers:

powershell

Overview

The DSC SPFarm resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_admincontentdatabasename

  AdminContentDatabaseName - The name of the admin content database

• dsc_centraladministrationauth

  CentralAdministrationAuth - The authentication provider of the CentralAdministration web application Valid values are NTLM, Kerberos.

• dsc_centraladministrationport

  CentralAdministrationPort - What port will Central Admin be provisioned to - default is 9999

• dsc_databaseserver

  DatabaseServer - Server that will host the configuration and admin content databases

• dsc_developerdashboard

  DeveloperDashboard - Specifies the state of the Developer Dashboard (‘OnDemand’ is SP2013 only) Valid values are Off, On, OnDemand.

• dsc_ensure

  Ensure - Present to create/join the farm. Absent is currently not supported Valid values are Present, Absent.

• dsc_farmaccount

  FarmAccount - The account to use as the main farm account

• dsc_farmconfigdatabasename

  FarmConfigDatabaseName - Name of the configuration database

• dsc_installaccount

  InstallAccount - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

• dsc_issingleinstance

  IsSingleInstance - Specifies the resource is a single instance, the value must be ‘Yes’ Valid values are Yes.

• dsc_passphrase

  Passphrase - The passphrase to use to allow servers to join this farm

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_runcentraladmin

  RunCentralAdmin - Should the central admin site run on this specific server?

  Supported values:

  • true
  • false
• dsc_serverrole

  ServerRole - SharePoint 2016 & 2019 only - the MinRole role to enroll this server as Valid values are Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_spfarm` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.