Add-SPProfileLeader
Updated: April 16, 2012
Adds a company leader.
Add-SPProfileLeader [-ProfileServiceApplicationProxy] <SPServiceApplicationProxyPipeBind> [-Name] <SPProfileLeaderPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
ProfileServiceApplicationProxy |
Required |
Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind |
Specifies the name of the User Profile Service Application Proxy to use. |
||
|
Name |
Required |
Microsoft.Office.Server.UserProfiles.PowerShell.SPProfileLeaderPipeBind |
Specifies the account name to be added as a leader for the new User Profile Service application. For example, Contoso\Joe. |
||
|
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.
|
||
|
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 |
||
|
SiteSubscription |
Optional |
Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind |
Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. |
||
|
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 |
Detailed Description
This cmdlet was introduced in Microsoft SharePoint Server 2010 with Service Pack 1 (SP1) and Microsoft SharePoint Foundation 2010 with Service Pack 1 (SP1).
Use the Add-SPProfileLeader cmdlet to add a user as the company leader.
For additional information about SPProfileLeader cmdlets, see The *-SPProfileLeader Windows PowerShell cmdlets in SharePoint Server 2010 SP1 (http://go.microsoft.com/fwlink/p/?LinkId=226295).
Note:
|
|---|
|
After you use the Add-SPProfileLeader cmdlet to add a company leader, you have to run a full crawl on the content source that contains the start address (URL) of the User Profile service application for the changes to take effect. |
Input Types
Return Types
---------EXAMPLE------------
$upaProxy = Get-SPServiceApplicationProxy 1232b6f7-b9ff-99ad-0cd0-fg1g67h981aq
Add-SPProfileLeader -ProfileServiceApplicationProxy $upaProxy -Name "contoso\janedow"
This example adds a company leader named, Jane Dow.
Change History
| Date | Description | Reason |
|---|---|---|
|
April 16, 2012 |
Revised information about the start address to crawl to make the changes take effect. |
Content update |
|
August 23, 2011 |
Initial publication |
|

Note: