Export (0) Print
Expand All

Get-FailedContentIndexDocuments

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-13

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-FailedContentIndexDocuments cmdlet to retrieve a list of documents for a mailbox, mailbox database, or Mailbox server that couldn't be indexed by Exchange Search.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-FailedContentIndexDocuments -Identity <MailboxIdParameter> [-Archive <SwitchParameter>] <COMMON PARAMETERS>
Get-FailedContentIndexDocuments -Server <ServerIdParameter> <COMMON PARAMETERS>
Get-FailedContentIndexDocuments -MailboxDatabase <DatabaseIdParameter> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-EndDate <DateTime>] [-ErrorCode <Int32>] [-FailureMode <Transient | Permanent | All>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-StartDate <DateTime>] [-WhatIf [<SwitchParameter>]]

This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox of user Terry Adams.

Get-FailedContentIndexDocuments -Identity "Terry Adams"

This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox database Mailbox Database MDB2.

Get-FailedContentIndexDocuments -MailboxDatabase "Mailbox Database MDB2"

The Get-FailedContentIndexDocuments cmdlet returns a list of documents that couldn't be indexed. The most common reason is that there was no filter available for that document type or there was an attachment within the document. For example, the PDF filter isn't available by default. If an email message contains a PDF document, because there is no PDF filter, the document is marked as failed content indexing.

After a new filter is installed, only new messages with attachments of the type for which the filter is installed are indexed. If you want to index older messages for the document type, the mailbox has to be moved.

The cmdlet output provides details about items in a mailbox that couldn't be indexed, including an error code and the reason for failure.

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 "Get unsearchable items" entry in the Recipients permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox. You can use one of the following values:

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

MailboxDatabase

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

This parameter is available only in on-premises Exchange 2013.

The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use the following values:

  • GUID of the database

  • Database name

  • DN

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

This parameter is available only in on-premises Exchange 2013.

The Server parameter specifies a Mailbox server. You can use the following values:

  • Name

  • GUID

  • DN

Archive

Optional

System.Management.Automation.SwitchParameter

The Archive switch restricts the scope of the cmdlet to the user’s archive. When using the Archive switch, you must also specify the Identity parameter.

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.

Credential

Optional

System.Management.Automation.PSCredential

This parameter is reserved for internal Microsoft use.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

EndDate

Optional

System.DateTime

The EndDate parameter specifies the end date of the date range.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

ErrorCode

Optional

System.Int32

The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results.

FailureMode

Optional

Microsoft.Exchange.Search.Core.Abstraction.FailureMode

The FailureMode parameter specifies the type of error. Use the following values.

  • Transient   Returns items that couldn’t be indexed due to transient errors. Exchange Search attempts to index these items again.

  • Permanent   Returns items that couldn’t be indexed due to a permanent error. Exchange Search does not attempt to index these items again.

  • All   Returns items that couldn’t be indexed regardless of nature of failure.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

This parameter is reserved for internal Microsoft use.

StartDate

Optional

System.DateTime

The StartDate parameter specifies the start date of the date range.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft