Edit

Add-SPPeoplePickerServiceAccountDirectoryPath

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

This cmdlet adds an OU to People Picker service account directory path list.

Syntax

Add-SPPeoplePickerServiceAccountDirectoryPath
   -WebApplication <SPWebApplicationPipeBind>
   -OrganizationalUnitName <String>
   [-Index <Int32>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Administrative user accounts are often located in a different OU from regular site users. If user has forced People Picker to only return query results from a specific OU, the OU should also be added into the service account directory path so the administrator can manage the site collection. This Add-SPPeoplePickerServiceAccountDirectoryPath cmdlet adds an OU into the service account directory path list.

Examples

-------------EXAMPLE 1-------------

Add-SPPeoplePickerServiceAccountDirectoryPath -WebApplication http://MyOfficeApp1 -OUName "OU=FarmAdmin,DC=Contoso,DC=local"

This example adds OU "FarmAdmin" to the service account directory path list of Web application MyOfficeApp1, so that Administrator can use People Picker to get users that are in the OU "FarmAdmin"

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
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Index

The position to insert the domain in the list beginning with 0.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-OrganizationalUnitName

{{ Fill OrganizationalUnitName Description }}

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WebApplication

The Web application to modify the service account directory path list to.

Type:SPWebApplicationPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition