Export (0) Print
Expand All
Expand Minimize

Get-MailboxRestoreRequestStatistics

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-10-23

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Get-MailboxRestoreRequestStatistics cmdlet to view detailed information about restore requests.

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

Get-MailboxRestoreRequestStatistics -Identity <MailboxRestoreRequestIdParameter> <COMMON PARAMETERS>
Get-MailboxRestoreRequestStatistics -RequestQueue <DatabaseIdParameter> [-RequestGuid <Guid>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Diagnostic <SwitchParameter>] [-DiagnosticArgument <String>] [-DomainController <Fqdn>] [-IncludeReport <SwitchParameter>]

This example returns the default statistics for the restore request with the identity Tony\MailboxRestore1. The type of information returned by default includes name, mailbox, status, and percent complete.

Get-MailboxRestoreRequestStatistics -Identity "Tony\MailboxRestore1"

This example returns the statistics for Tony Smith's mailbox and exports the report to a CSV file.

Get-MailboxRestoreRequestStatistics -Identity Tony\MailboxRestore | Export-CSV \\SERVER01\RestoreRequest_Reports\Tony_Restorestats.csv

This example returns additional information about the restore request for Tony Smith's mailbox by using the IncludeReport parameter and by pipelining the results to the Format-List command.

Get-MailboxRestoreRequestStatistics -Identity Tony\MailboxRestore -IncludeReport | Format-List 

This example returns default statistics for a restore request being processed by the instance of MRS running on the server CAS01. This command only returns information for restore requests currently being processed by an instance of MRS. If the Client Access server is finished processing all restore requests, no information is returned. This command is for debugging purposes only and should only be performed if requested by Microsoft Customer Service and Support.

Get-MailboxRestoreRequestStatistics -MRSInstance CAS01.contoso.com 

This example returns additional information for all the restore requests that have a status of Failed by using the IncludeReport parameter, and then saves the information to the text file AllRestoreReports.txt in the location where the command is being run.

Get-MailboxRestoreRequest -Status Failed | Get-MailboxRestoreRequestStatistics -IncludeReport | Format-List > AllRestoreReports.txt

The RequestQueue and MRSInstance parameter syntax sets are for debugging purposes only and should only be used when directed by Microsoft Customer Service and Support.

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 "Mailbox restore request" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MailboxReplicationService.MailboxRestoreRequestIdParameter

The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: <alias>\<name>.

If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1–9).

This parameter can't be used in conjunction with the MRSInstance or RequestQueue parameters.

RequestQueue

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example:

  • Database GUID

  • Database name

You can't use this parameter with the Identity parameter.

Diagnostic

Optional

System.Management.Automation.SwitchParameter

The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems.

DiagnosticArgument

Optional

System.String

The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems.

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.

IncludeReport

Optional

System.Management.Automation.SwitchParameter

The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting.

RequestGuid

Optional

System.Guid

The RequestGuid parameter specifies the unique identifier for the restore request. To find the GUID, use the Get-MailboxRestoreRequest cmdlet.

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