Start-SPProfileServiceIncrementalReplication
Applies to: SharePoint Server 2010
Replicates changes for selected profile properties from the source User Profile service application to the destination User Profile service application using the Replication Engine Windows service.
Syntax
Start-SPProfileServiceIncrementalReplication -Destination <String[]> -Source <String> [-ActiveDirectoryDomains <String[]>] [-Credential <PSCredential>] [-DoSocialReplication <SwitchParameter>] [-DoUpgrade <SwitchParameter>] [-EnableInstrumentation <SwitchParameter>] [-FeedProperties <String[]>] [-MatchSubtype <SwitchParameter>] [-NumberOfRetry <Int32>] [-Properties <String[]>] [-ReplicationInterval <Int32>] [-Timeout <Int32>] [-WaitTimeBetweenFailures <Int32>]
Detailed Description
The Start-SPProfileServiceIncrementalReplication cmdlet replicates any changes to the user profile information and social data—including social tags, notes, and ratings—for the selected user profile properties from the source User Profile service application to the destination User Profile service application. The first time you run this cmdlet, you must provide the credentials for the User Profile Replication Engine Windows service. These credentials can be retrieved using the Get-credentials cmdlet. Once started, you can view the instrumentation log to verify if any changes are present.
If you need to stop incremental profile replication for any reason, use the Stop-SPProfileServiceIncrementalReplication cmdlet. Do not start or stop incremental profile replication by manually starting or stopping the User Profile Service Replication Engine Windows service using the Windows MMC snap-in.
You must have configured a trusted My Site host location by using the User Profile Service Administration Web page in Central Administration. For additional information about how to configure a trusted My Site host locations, see Add or delete a trusted My Site host location (SharePoint Server 2010).
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Destination |
Required |
System.String[] |
Specifies the URL of the My Site Host to where the user profiles are replicated, for example, http://euro.contoso.com:8081/my. |
Source |
Required |
System.String |
Specifies the URL of the My Site Host from where the user profiles are retrieved, for example, http://hq.contoso.com:8081/my. |
ActiveDirectoryDomains |
Optional |
System.String[] |
Specifies the Active Directory Domain Services (AD DS) accounts to be replicated, for example, "headquarters" or "Europe".The default value returns all AD DS domains. |
Credential |
Optional |
System.Management.Automation.PSCredential |
Specifies the User Profile Replication Engine Windows service credentials the first time you run this cmdlet or anytime you want to change the Replication Engine service credentials. To get the User Profile Replication Engine Windows service credentials, use the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?LinkID=113311). |
DoSocialReplication |
Optional |
System.Management.Automation.SwitchParameter |
Enables replication of social tags, notes, and ratings. Only use this parameter when both the source User Profile service application and the destination User Profile service application are Microsoft SharePoint Server 2010-based. |
DoUpgrade |
Optional |
System.Management.Automation.SwitchParameter |
Enables the replacement of invalid characters in the social taxonomy. This attribute must be used if the source is a Office SharePoint Server 2007 User Profile SSP and the destination is a SharePoint Server 2010 User Profile service application. |
EnableInstrumentation |
Optional |
System.Management.Automation.SwitchParameter |
Enables detailed logging by using the instrumentation log. |
FeedProperties |
Optional |
System.String[] |
Specifies that the trusted My Site host locations list should be ignored when replicating changes for the specified user profile properties. |
MatchSubtype |
Optional |
System.Management.Automation.SwitchParameter |
Prevents mismatches between source and destination profile properties by using the destination profile properties as a filter. For performance reasons, we recommend that you only use this parameter if most of the user profile properties are mismatched between the source User Profile service application and the destination User Profile service application. |
NumberOfRetry |
Optional |
System.Int32 |
Specifies the number of times that the User Profile Replication Engine should attempt to restart in the event of a failure, for example, a network disconnection. The default value is 10. |
Properties |
Optional |
System.String[] |
Specifies which user profile properties to replicate, for example, "FirstName" or "AboutMe". You can also use the Get-SPProfilePropertyCollection cmdlet to return a collection of all user profile properties. The default value returns all user profile properties. |
ReplicationInterval |
Optional |
System.Int32 |
Specifies the amount of time, in seconds, between each replication iteration. The default value is 5. |
Timeout |
Optional |
System.Int32 |
Specifies the amount of time the User Profile Replication Engine should wait for a response from the Web service before timing out. The default value is the Web service timeout. |
WaitTimeBetweenFailures |
Optional |
System.Int32 |
Specifies the amount of time, in seconds, that the User Profile Replication Engine should wait after it fails to replicate a user profile before the Start-SPProfileServiceRecoveryReplication process begins. The default value is 300. |
Input Types
Return Types
Example
----------Example----------
get-spprofilepropertycollection -source http://euro.contoso.com:8081 | start-spprofileserviceincrementalreplication -source http://hq.contoso.com:8081 -destination http://euro.contoso.com:8081 -EnableInstrumentation -Credential $mycredential
This example replicates any changes to all user profile properties from hq.contoso.com to euro.contoso.com and tracks any changes in the instrumentation log.
See Also
Reference
Get-SPProfilePropertyCollection
Start-SPProfileServiceFullReplication
Start-SPProfileServiceRecoveryReplication
Stop-SPProfileServiceIncrementalReplication
Concepts
User Profile Replication Engine overview (SharePoint Server 2010)