Skip to content

Latest commit

 

History

History
125 lines (90 loc) · 3.48 KB

File metadata and controls

125 lines (90 loc) · 3.48 KB
external help file Microsoft.SharePoint.PowerShell.dll-Help.xml
Module Name SharePointServer
online version https://learn.microsoft.com/powershell/module/sharepoint-server/clear-sppeoplepickersearchaddomain
applicable SharePoint Server Subscription Edition
title Clear-SPPeoplePickerSearchADDomain
schema 2.0.0

Clear-SPPeoplePickerSearchADDomain

SYNOPSIS

This cmdlet clears the list of People Picker search forests and domains for a specified Web application.

SYNTAX

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

DESCRIPTION

This Clear-PeoplePickerSearchADDomain cmdlet clears the list of forests and domains in the list of search Active Directory domains used by People Picker.

EXAMPLES

EXAMPLE 1

Clear-SPPeoplePickerSearchAdDomain -WebApplication http://MyOfficeApp1

This example clears the list of People Picker search forests and domains of the Web application, MyOfficeApp1.

PARAMETERS

-AssignmentCollection

Applicable: SharePoint Server Subscription Edition

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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WebApplication

Applicable: SharePoint Server Subscription Edition

The Web application to clear the search forests and domains from.

Type: SPWebApplicationPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Confirm

Applicable: SharePoint Server Subscription Edition

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Applicable: SharePoint Server Subscription Edition

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS