Export (0) Print
Expand All

Test-ExchangeSearch

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Test-ExchangeSearch cmdlet to test that Exchange Search is currently enabled and is indexing new e-mail messages in a timely manner.


Test-ExchangeSearch [-Identity <MailboxIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IndexingTimeout <Int32>] [-MonitoringContext <$true | $false>] [-WhatIf [<SwitchParameter>]]


Test-ExchangeSearch [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IndexingTimeout <Int32>] [-MonitoringContext <$true | $false>] [-Server <ServerIdParameter>] [-WhatIf [<SwitchParameter>]]


Test-ExchangeSearch [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IndexingTimeout <Int32>] [-MailboxDatabase <DatabaseIdParameter>] [-MonitoringContext <$true | $false>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

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.

IndexingTimeout

Optional

System.Int32

The IndexingTimeout 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 2 minutes (120 seconds). If this parameter isn't specified, the default interval is used.

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.Boolean

The MonitoringContext parameter specifies an event log entry to be written to the Application event log for use by Microsoft System Center Operations Manager 2007. The parameter should be used and set to $true 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.

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 IndexingTimeout parameter has elapsed.

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.

Error Description

 

 

Exceptions Description

 

 

This example tests Exchange Search results for the mailbox database on which the specified mailbox resides.

Test-ExchangeSearch -Identity john@contoso.com

This example tests Exchange Search against the mailbox database EXCH01-SG1-MDB1 with an indexing time-out of 30 seconds.

Test-ExchangeSearch -MailboxDatabase "EXCH01-SG1-MDB1" -IndexingTimeout 30
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft