Get-SPPeoplePickerSearchADDomain

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Returns all Active Directory forests or domains that the People Picker uses when searching for users.

Syntax

Get-SPPeoplePickerSearchADDomain
   -WebApplication <SPWebApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Get-SPPeoplePickerSearchADDomain
   -WebApplication <SPWebApplicationPipeBind>
   -DomainName <String>
   [-IsForest]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-SPPeoplePickerSearchADDomain cmdlet returns all People Picker search forests or domains that match the criteria specified by the parameters.

Examples

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

Get-SPPeoplePickerSearchADDomain -WebApplication http://sitename

This example returns all Active Directory forests or domains that the People Picker uses when searching for users in the http://sitename web application.

-------------EXAMPLE 2-------------

Get-SPPeoplePickerSearchADDomain -WebApplication http://sitename -DomainName "corp.contoso.com" -IsForest

This example returns the People Picker search entry in the http://sitename web application that uses the "corp.contoso.com" Active Directory forest.

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

-DomainName

Name of the Active Directory forest or domain.

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

-IsForest

Specifies that the name specified by the DomainName parameter is an Active Directory forest. If the IsForest parameter is omitted, the name specified by the DomainName parameter is treated as an Active Directory domain.

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

-WebApplication

Specifies the name, URL, or GUID of the Web application containing the People Picker search settings.

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

Jaa