Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete, or stopped.

Syntax


`Get-MailboxSearch [-Identity <SearchObjectIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>]`

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Multi-Mailbox Search" entry in the Messaging Policy and Compliance Permissions topic.

Parameters

Parameter	Required	Type	Description
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.
Identity	Optional	Microsoft.Exchange.Configuration.Tasks.SearchObjectIdParameter	The Identity parameter specifies the name of the search query. If a name isn't provided, all mailbox search queries are returned.
Organization	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter	This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.
ResultSize	Optional	Microsoft.Exchange.Data.Unlimited	The ResultSize parameter specifies the maximum number of results to return. The default result size is 1000. Use unlimited to return all mailbox searches.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE 1

This example gets a list of all mailbox searches.

	Copy Code
Get-MailboxSearch -ResultSize "unlimited"

EXAMPLE 2

This example gets a mailbox search called Project Hamilton.

	Copy Code
Get-MailboxSearch "Project Hamilton"

Note:
Identity is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see Parameters.