Applies to: Exchange Server 2013
Topic Last Modified: 2012-10-05
Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Start-MailboxSearch -Identity
<EwsStoreObjectIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>] [-Force
<SwitchParameter>] [-Resume <SwitchParameter>]
[-StatisticsStartIndex <Int32>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example starts the mailbox search ProjectContoso.
 Copy Code |
|
|---|---|
Start-MailboxSearch -Identity "ProjectContoso" |
|
Detailed Description
You can use In-Place eDiscovery to search one or more specified mailboxes or all mailboxes across the Microsoft Exchange Server 2013 organization. A search is created by using the Exchange Administration Center (EAC) or the New-MailboxSearch cmdlet.
 Caution: |
|---|
| When restarting a search, any previous results returned by the same search and copied to a Discovery mailbox are removed. To preserve previous search results and resume the search from the point it was stopped, use the Resume switch. |
In Exchange 2013, mailbox searches are also used for In-Place Hold. However, you can’t start or stop In-Place Hold using the Start-MailboxSearch and Stop-MailboxSearch cmdlets.
For more details, see In-Place Hold and In-Place eDiscovery.
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 "In-Place eDiscovery" entry in the Messaging Policy and Compliance Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.EwsStoreObjectIdParameter |
The Identity parameter specifies the name of the search. The name is referenced when starting, stopping, or removing the search. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force switch suppresses the confirmation prompt displayed before the command is executed. |
|
Resume |
Optional |
System.Management.Automation.SwitchParameter |
The Resume switch resumes a stopped, failed, or partially succeeded search from the point it stopped. If you use the Resume switch to resume a search, previous search results aren't removed from the target mailbox. |
|
StatisticsStartIndex |
Optional |
System.Int32 |
The StatisticsStartIndex parameter is used by the Exchange Administration Center (EAC) to retrieve keyword statistics in a paged operation. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.