Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-03
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.
Syntax
Get-MailboxRestoreRequestStatistics -Identity
<MailboxRestoreRequestIdParameter> [-IncludeReport
<SwitchParameter>] <COMMON PARAMETERS>
|
Get-MailboxRestoreRequestStatistics -RequestQueue
<DatabaseIdParameter> [-IncludeReport
<SwitchParameter>] [-RequestGuid <Guid>] <COMMON
PARAMETERS>
|
COMMON PARAMETERS: [-DomainController
<Fqdn>]
|
Examples
EXAMPLE 1
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.
 Copy Code |
|
|---|---|
Get-MailboxRestoreRequestStatistics -Identity "Tony\MailboxRestore1" |
|
EXAMPLE 2
This example returns the statistics for Tony Smith's mailbox and exports the report to a CSV file.
| Copy Code |
|
|---|---|
Get-MailboxRestoreRequestStatistics -Identity Tony\MailboxRestore | Export-CSV \\SERVER01\RestoreRequest_Reports\Tony_Restorestats.csv |
|
EXAMPLE 3
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.
| Copy Code |
|
|---|---|
Get-MailboxRestoreRequestStatistics -Identity Tony\MailboxRestore -IncludeReport | Format-List |
|
EXAMPLE 4
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.
| Copy Code |
|
|---|---|
Get-MailboxRestoreRequestStatistics -MRSInstance CAS01.contoso.com |
|
EXAMPLE 5
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.
| Copy Code |
|
|---|---|
Get-MailboxRestoreRequest -Status Failed | Get-MailboxRestoreRequestStatistics -IncludeReport | Format-List > AllRestoreReports.txt |
|
Detailed Description
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Management.RecipientTasks.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 specifies the target mailbox database on which the mailbox or archive of the request resides. You can use one of the following values:
This parameter can't be used in conjunction with the Identity or MRSInstance parameters. |
|
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. |
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.