Add-SPProfileSyncConnection

Adds a synchronization connection.

Syntax

Add-SPProfileSyncConnection
   [-ProfileServiceApplication] <SPServiceApplicationPipeBind>
   -ConnectionDomain <String>
   -ConnectionForestName <String>
   -ConnectionPassword <SecureString>
   -ConnectionSynchronizationOU <String>
   -ConnectionUserName <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-ConnectionClaimIDMapAttribute <String>]
   [-ConnectionClaimProviderIdValue <String>]
   [-ConnectionClaimProviderTypeValue <String>]
   [-ConnectionNamingContext <String>]
   [-ConnectionPort <Int32>]
   [-ConnectionServerName <String>]
   [-ConnectionUseSSL <Boolean>]
   [-WhatIf]
   [-ConnectionFilterOutUnlicensed <Boolean>]
   [-ConnectionUseDisabledFilter <Boolean>]
   [<CommonParameters>]

Description

This cmdlet was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation 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

This cmdlet only works with Active Directory Synchronization Connections

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

----------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.

Parameters

-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionClaimIDMapAttribute

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionClaimProviderIdValue

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionClaimProviderTypeValue

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionDomain

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionFilterOutUnlicensed

Do not use.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionForestName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionNamingContext

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionPassword

Specifies the password of the account used for directory connection.

Type:SecureString
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionPort

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

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionServerName

Specifies the name of the domain controller to connect to.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionSynchronizationOU

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionUseDisabledFilter

Filters out disabled accounts.

Note

This will only filter out accounts which are in a disabled state prior to being imported. It will not filter out accounts which have been disabled after importing.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionUseSSL

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

The valid values are: $True or $False

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ConnectionUserName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-ProfileServiceApplication

Specifies the name of the User Profile service application.

Type:SPServiceApplicationPipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019