TechNet
Export (0) Print
Expand All

Get-MailboxRestoreRequestStatistics

 

Applies to: Exchange Online, Exchange Server 2016

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

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

For information about the parameter sets in the Syntax section below, see Exchange cmdlet 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 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 C:\Reports\AllRestoreReports.txt.

Get-MailboxRestoreRequest -Status Failed | Get-MailboxRestoreRequestStatistics -IncludeReport | Format-List > C:\Reports\AllRestoreReports.txt

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

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

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

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

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

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

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

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

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.

 
Show:
© 2016 Microsoft