Resource Type: dsc_spjoinfarm

Defined in:
lib/puppet/type/dsc_spjoinfarm.rb
Providers:
powershell

Overview

The DSC SPJoinFarm resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPJoinFarm/MSFT_SPJoinFarm.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

Parameters

  • dsc_databaseserver

    DatabaseServer - The server that hosts the config database

  • dsc_farmconfigdatabasename

    FarmConfigDatabaseName - The name of the config database to connect to

  • dsc_installaccount

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

  • dsc_passphrase

    Passphrase - The passphrase that should be used to join the farm

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_serverrole

    ServerRole - SharePoint 2016 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_spjoinfarm` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.