Resource Type: dsc_spuserprofilesyncconnection

Defined in:

lib/puppet/type/dsc_spuserprofilesyncconnection.rb

Providers:

powershell

Overview

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

  ConnectionCredentials - The credentials to connect to Active Directory with

• dsc_connectiontype

  ConnectionType - The type of the connection - currently only Active Directory is supported Valid values are ActiveDirectory, BusinessDataCatalog.

• dsc_ensure

  Ensure - Present if the connection should exist, absent if it should not Valid values are Present, Absent.

• dsc_excludedous

  ExcludedOUs - A list of the OUs to ignore users from. For SharePoint 2016/2019 matching existing OUs to include are removed.

• dsc_force

  Force - Set to true to run the set method on every call to this resource. Only has effect on SharePoint 2013

  Supported values:

  • true
  • false
• dsc_forest

  Forest - The name of the AD forest to read from

• dsc_includedous

  IncludedOUs - A list of the OUs to import users from. For SharePoint 2016/2019 existing OUs will not be removed if not included in this list. Use ExludedOUs for removing OUs in SharePoint 2016/2019

• dsc_installaccount

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

• dsc_name

  Name - The name of the connection

• dsc_port

  Port - The specific port to connect to

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_server

  Server - The specific AD server to connect to

• dsc_usedisabledfilter

  UseDisabledFilter - Should disabled accounts be filtered

  Supported values:

  • true
  • false
• dsc_userprofileservice

  UserProfileService - The name of the user profile service that this connection is attached to

• dsc_usessl

  UseSSL - Should SSL be used for the connection

  Supported values:

  • true
  • false
• name (namevar)
• provider

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