User Profile service cmdlets (SharePoint Server 2010)

Updated: August 23, 2011

In Microsoft SharePoint Server 2010, the User Profile Service is used to store and process information about users. This information is stored as a collection of user profile properties per user. The user information must be imported into the user profile store before it can be used by various personalization-related features and people search. These properties can be imported from line-of-business applications and directory services (primarily Active Directory directory service and Lightweight Directory Access Protocol (LDAP)).

In SharePoint Server 2010, the use of social tagging, expertise tagging, and profile synchronization are new features.

SharePoint Server 2010 provides an enterprise-wide repository for storing social and expertise tags and for associating those tags with a user's profile. Administrators can control who can tag items on a given site, decide which tags can be used, and delete tags prior to a specific date or based on a specific user profile ID. Tagging relies on the Managed Metadata Service and can be enabled by using either the UI or Windows PowerShell cmdlets.

Profile synchronization synchronizes data in the SharePoint profile store with profile information contained in directory services across the enterprise, such as Active Directory or LDAP. After a connection to the appropriate directory service has been set up, profile synchronization can be scheduled to run on a regular basis.

You can use User Profile Service Windows PowerShell cmdlets to create and configure the User Profile Service and profile tags, and to configure permissions and all global settings for the User Profile Service.

Cmdlet name	Description
Add-SPSiteSubscriptionProfileConfig	Adds a new site subscription to a User Profile Service application.
Get-SPProfileServiceApplicationSecurity	Returns permission and identity information.
Move-SPProfileManagedMetadataProperty	Moves multiple-string values into a term set.
New-SPProfileServiceApplication	Adds a User Profile Service application to a farm.
New-SPProfileServiceApplicationProxy	Creates a User Profile Service application proxy on the local farm.
Remove-SPSiteSubscriptionProfileConfig	Deletes a site subscription from a User Profile Service application.
Remove-SPSocialItemByDate	Deletes tags, notes, or ratings.
Set-SPProfileServiceApplication	Sets properties of a User Profile Service application.
Set-SPProfileServiceApplicationProxy	Sets properties of a proxy for a User Profile Service application.
Set-SPProfileServiceApplicationSecurity	Sets permission and identity information.
Set-SPSiteSubscriptionProfileConfig	Sets the parameters of a site subscription.
Update-SPProfilePhotoStore	Updates the profile photo store to be compatible with Microsoft SharePoint Server 2010.
Add-PluggableSecurityTrimmer	Adds a pluggable security trimmer to a User Profile service application proxy.
Get-PluggableSecurityTrimmer	Gets pluggable security trimmers that have been added to a User Profile service application proxy.
Remove-PluggableSecurityTrimmer	Removes pluggable security trimmers that have been added to a User Profile service application proxy.
Add-SPProfileLeader	Adds a company leader.
Get-SPProfileLeader	Returns the current company leaders.
Move-SPSocialComments	Moves social comments.
Remove-SPProfileLeader	Removes a company leader.

The following table shows cmdlets that are added as part of the User Profile Replication Engine, included in the SharePoint 2010 Administration Toolkit.

Cmdlet name	Description
Get-SPProfilePropertyCollection	Gets all user profile properties.
Start-SPProfileServiceFullReplication	Replicates all selected user profile properties from the source User Profile service application to the destination User Profile service application.
Start-SPProfileServiceRecoveryReplication	Recovers user profiles that failed to replicate during full profile replication.
Start-SPProfileServiceIncrementalReplication	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.
Stop-SPProfileServiceIncrementalReplication	Stops incremental profile replication.

For more information, see SharePoint 2010 Administration Toolkit (SharePoint Server 2010).

Change History

Date	Description	Reason
August 23, 2011	Updated to include the Add-SPProfileLeader, Get-SPProfileLeader, Remove-SPProfileLeader, and Move-SPSocialComments cmdlets that were introduced in Microsoft SharePoint Server 2010 with Service Pack 1 (SP1) and Microsoft SharePoint Foundation 2010 with Service Pack 1 (SP1).	Content update
July 15, 2010	Added cmdlets that are part of the SharePoint 2010 Administration Toolkit version 1.0.	Product update
May 12, 2010	Initial publication

See Also

Other Resources

Change History