Export (0) Print
Expand All

Add-SPProfileSyncConnection

SharePoint 2013
 

Applies to: SharePoint Server 2013 Standard

Topic Last Modified: 2013-12-18

Adds a synchronization connection.

Add-SPProfileSyncConnection [-ProfileServiceApplication] <SPServiceApplicationPipeBind> -ConnectionDomain <String> -ConnectionForestName <String> -ConnectionPassword <SecureString> -ConnectionSynchronizationOU <String> -ConnectionUserName <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-ConnectionClaimIDMapAttribute <String>] [-ConnectionClaimProviderIdValue <String>] [-ConnectionClaimProviderTypeValue <String>] [-ConnectionNamingContext <String>] [-ConnectionPort <Int32>] [-ConnectionServerName <String>] [-ConnectionUseDisabledFilter <$true | $false>] [-ConnectionUseSSL <$true | $false>] [-WhatIf [<SwitchParameter>]]

This cmdlet was introduced in SharePoint Server 2010 with Service Pack 1 (SP1) and SharePoint Foundation 2010 with Service Pack 1 (SP1).

Use the Add-SPProfileSyncConnection cmdlet to add a User Profile synchronization connection.

For additional information about profile synchronization connections, see Overview of profile synchronization in SharePoint Server 2013

NoteNote:
This cmdlet only works with Active Directory Synchronization Connections

 

Parameter Required Type Description

ProfileServiceApplication

Required

Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind

Specifies the name of the User Profile service application.

ConnectionDomain

Required

System.String

Specifies the NetBIOS name of the domain you are connecting to.

ConnectionForestName

Required

System.String

Specifies the fully qualified domain name (FQDN) of the forest you are connecting to.

ConnectionPassword

Required

System.Security.SecureString

Specifies the password of the account used for directory connection.

ConnectionSynchronizationOU

Required

System.String

Specifies the top level organizational unit (OU) that you would like to synchronize. The value must be a domain name and you can only include one container per command.

ConnectionUserName

Required

System.String

Specifies the user name to be used for the synchronization connection.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

ConnectionClaimIDMapAttribute

Optional

System.String

Specifies the Claims ID used by the Claim Provider, that is, samAccountName.

ConnectionClaimProviderIdValue

Optional

System.String

Specifies the Claims Provider ID or Name for an authentication type while a Web App is configured.

ConnectionClaimProviderTypeValue

Optional

System.String

Specifies the Authentication claim Provider that will be used to encode the User Profile accounts names. For example, Windows/Forms etc. This means if a user logs in using the given Authentication Type, then a profile can be found by looking up a claim encoded credentials.

ConnectionNamingContext

Optional

System.String

Specifies the naming context of the directory information tree to connect to.

ConnectionPort

Optional

System.Int32

Specifies the port to be used to connect to the directory service. The default port is 389.

ConnectionServerName

Optional

System.String

Specifies the name of the domain controller to connect to.

ConnectionUseSSL

Optional

System.Boolean

Specifies if the connection to the directory service must be over SSL.

The valid values are: $True or $False

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

----------EXAMPLE-----------

Add-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionForestName "fabrikam.com"-ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com"

This example adds a user from the fabrikam domain using a specific user profile service application.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft