Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-15
Use the Test-ExchangeSearch cmdlet to test that Exchange Search is currently enabled and is indexing new e-mail messages in a timely manner.
Syntax
Test-ExchangeSearch [-Identity
<MailboxIdParameter>] [-Archive <SwitchParameter>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-IndexingTimeoutInSeconds <Int32>]
[-MonitoringContext <SwitchParameter>] [-WhatIf
[<SwitchParameter>]]
|
Test-ExchangeSearch [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-IndexingTimeoutInSeconds
<Int32>] [-MonitoringContext <SwitchParameter>]
[-Server <ServerIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Test-ExchangeSearch [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-IndexingTimeoutInSeconds
<Int32>] [-MailboxDatabase <DatabaseIdParameter>]
[-MonitoringContext <SwitchParameter>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The Test-ExchangeSearch cmdlet creates a hidden message and an attachment visible only to Exchange Search. Unless a mailbox is specified in the Identity parameter, the hidden message is stored in the System Attendant mailbox. The command waits for the message to be indexed and then searches for the content. It reports success or failure depending on whether the message is found after the interval set in the IndexingTimeoutInSeconds parameter has elapsed.
You can use the Verbose switch to get detailed information about each step performed by the cmdlet as part of the test.
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 "Exchange Search" entry in the Mailbox Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Archive |
Optional |
System.Management.Automation.SwitchParameter |
The Archive switch specifies that the test be run against the archive mailbox for the mailbox user specified in the Identity parameter. When the Archive switch is used, you must also use the Identity parameter to specify the mailbox. |
|
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 retrieves data from Active Directory. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The Identity parameter specifies the mailbox that you want to test Exchange Search against. If this parameter isn't specified, the System Attendant mailbox is used. The Identity and MailboxDatabase parameters can't be used together. |
|
IndexingTimeoutInSeconds |
Optional |
System.Int32 |
The IndexingTimeoutInSeconds parameter specifies, in
seconds, the maximum amount of time to wait between adding the new
e-mail message to the test mailbox and waiting for it to be
returned in a search result. The default value is |
|
MailboxDatabase |
Optional |
Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter |
The MailboxDatabase parameter specifies the mailbox database to test Exchange Search against. The MailboxDatabase and Identity parameters can't be used together. |
|
MonitoringContext |
Optional |
System.Management.Automation.SwitchParameter |
The MonitoringContext switch specifies an event log entry to be written to the Application event log for use by Microsoft System Center Operations Manager 2007. The switch should be used only if invoking this command from within System Center Operations Manager 2007. |
|
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the Exchange server for the recipient that you want to test Exchange Search against. |
|
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.
Examples
EXAMPLE 1
This example tests Exchange Search results for the mailbox database on which the specified mailbox resides.
 Copy Code |
|
|---|---|
Test-ExchangeSearch -Identity john@contoso.com |
|
EXAMPLE 2
This example tests Exchange Search against the mailbox database EXCH01-SG1-MDB1 with an indexing time-out of 30 seconds.
| Copy Code |
|
|---|---|
Test-ExchangeSearch -MailboxDatabase "EXCH01-SG1-MDB1" -IndexingTimeoutInSeconds 30 |
|
EXAMPLE 3
This example tests Exchange Search results for the mailbox database on which the specified mailbox resides. The Verbose switch is used to display detailed information.
| Copy Code |
|
|---|---|
Test-ExchangeSearch -Identity john@contoso.com -Verbose |
|