Resource Type: dsc_spuserprofilesyncservice

Defined in:

lib/puppet/type/dsc_spuserprofilesyncservice.rb

Providers:

powershell

Overview

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

  Ensure - Present to ensure the service is running, absent to ensure it is not Valid values are Present, Absent.

• dsc_farmaccount

  FarmAccount - PARAMETER IS NOT USED ANYMORE, WILL BE REMOVED IN V3.0

• dsc_installaccount

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

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_runonlywhenwriteable

  RunOnlyWhenWriteable - Should the sync service only run when the user profile database is in a writeable state?

  Supported values:

  • true
  • false
• dsc_userprofileserviceappname

  UserProfileServiceAppName - The name of the user profile service for this sync instance

• name (namevar)
• provider

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