Add-SPPeoplePickerSearchADDomain
This cmdlet adds a forest or domain to the list that the People Picker uses when searching for users.
Syntax
Add-SPPeoplePickerSearchADDomain
-WebApplication <SPWebApplicationPipeBind>
-DomainName <String>
[-IsForest]
[-Index <Int32>]
[-Credential <PSCredential>]
[-AssignmentCollection <SPAssignmentCollection>]
[-SecureSocketsLayer]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
This Add-SPPeoplePickerSearchADDomain cmdlet adds a forest or domain with domain name and optional login name and password to the list of Active Directory domains used by People Picker.
Examples
-------------EXAMPLE 1-------------
Add-SPPeoplePickerSearchADDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -IsForestThis example adds forest corp.contoso.com to the People Picker search Active Directory domain list of the Web application MyOfficeApp1.
-------------EXAMPLE 2-------------
Add-SPPeoplePickerSearchADDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -Credential (New-Object System.Management.Automation.PSCredential "contoso\user", (ConvertTo-SecureString "password" -AsPlainText -Force))This example adds domain corp.contoso.com to the People Picker search Active Directory domain list of the Web application MyOfficeApp1, with login name user and password password.
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 |
-Credential
The login name and password used by People Picker for authenticating to a forest or domain that it doesn't have a two-way trust relationship with.
This parameter is not neccessary if it has a two-way trust relationship with the forest or domain specified by the DomainName parameter.
If this parameter is not specified, then no login name and password will be used.
| Type: | PSCredential |
| 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 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 |
-Index
The position to insert the forest or domain in the list begin from 0.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-IsForest
Whether the name specified by the DomainName parameter is an active directory forest or 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 |
-SecureSocketsLayer
Specifies whether the newly added forest or domain should enable Secure LDAP (LDAPS).
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-WebApplication
The Web application to add the People Picker forest/domain search setting 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 |