Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-12-10

Use the Get-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet.

Syntax


`Get-MailboxRestoreRequest [-Identity <MailboxRestoreRequestIdParameter>] [-DomainController <Fqdn>] [-MultiTenant <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>]`


Get-MailboxRestoreRequest [-BatchName <String>] [-DomainController <Fqdn>] [-HighPriority <$true \| $false>] [-MultiTenant <SwitchParameter>] [-Name <String>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>] [-SourceDatabase <DatabaseIdParameter>] [-Status <None \| Queued \| InProgress \| AutoSuspended \| CompletionInProgress \| Completed \| CompletedWithWarning \| Suspended \| Failed>] [-Suspend <$true \| $false>] [-TargetDatabase <DatabaseIdParameter>] [-TargetMailbox <MailboxOrMailUserIdParameter>]

Get-MailboxRestoreRequest [-BatchName <String>]
[-DomainController <Fqdn>] [-HighPriority <$true |
$false>] [-MultiTenant <SwitchParameter>] [-Name
<String>] [-Organization <OrganizationIdParameter>]
[-ResultSize <Unlimited>] [-SourceDatabase
<DatabaseIdParameter>] [-Status <None | Queued |
InProgress | AutoSuspended | CompletionInProgress | Completed |
CompletedWithWarning | Suspended | Failed>] [-Suspend <$true
| $false>] [-TargetDatabase <DatabaseIdParameter>]
[-TargetMailbox <MailboxOrMailUserIdParameter>]

Detailed Description

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 Mailbox Permissions topic.

Parameters

Parameter	Required	Type	Description
Identity	Optional	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). You can't use this parameter in conjunction with the Name parameter.
BatchName	Optional	System.String	The BatchName parameter specifies the name given to a batch of restore requests. You can't use this parameter in conjunction with the Identity parameter.
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.
HighPriority	Optional	System.Boolean	The HighPriority parameter specifies that the cmdlet returns requests that were created with by using the HighPriority parameter. The HighPriority flag indicates that the request should be processed before other lower-priority requests in the queue. You can't use this parameter in conjunction with the Identity parameter.
MultiTenant	Optional	System.Management.Automation.SwitchParameter	This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The MultiTenant parameter specifies that the search should be performed across the entire forest, not just across the organization that's currently scoped. You don't have to specify a value with this parameter.
Name	Optional	System.String	The Name parameter specifies that any restore request that has the specified name is returned. Use this parameter to search on the name you provided when you created the restore request. 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). You can't use this parameter in conjunction with the Identity parameter.
Organization	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter	This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.
ResultSize	Optional	Microsoft.Exchange.Data.Unlimited	The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use `unlimited` for the value of this parameter. The default value is `1000`.
SourceDatabase	Optional	Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter	The SourceDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that are being restored from the specified source database. You can use the following values: GUID of the database Database name You can't use this parameter in conjunction with the Identity parameter.
Status	Optional	Microsoft.Exchange.Data.Directory.Recipient.RequestStatus	The Status parameter specifies that restore requests with the specified status are returned. You can use the following values: `AutoSuspended` `Completed` `CompletedWithWarning` `CompletionInProgress` `Failed` `InProgress` `None` `Queued` `Suspended` You can't use this parameter in conjunction with the Identity parameter.
Suspend	Optional	System.Boolean	The Suspend parameter specifies that the cmdlet should only return restore requests that have been suspended. This parameter accepts `$true` or `$false`. You can't use this parameter in conjunction with the Identity parameter.
TargetDatabase	Optional	Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter	The TargetDatabase parameter specifies that the cmdlet should only return restore requests for mailboxes that reside on the target database. You can use the following values: GUID of the database Database name You can't use this parameter in conjunction with the Identity parameter.
TargetMailbox	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter	The TargetMailbox parameter specifies the identity of the target mailbox. You can use the following values: GUID Distinguished name (DN) Domain\Account User principal name (UPN) Legacy Exchange DN SMTP address Alias You can't use this parameter in conjunction with the Identity parameter.

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.

Examples

EXAMPLE 1

This example returns the status of the in progress and queued restore request with the identity ayla\MailboxRestore.

	Copy Code
Get-MailboxRestoreRequest -Identity "ayla\MailboxRestore"

EXAMPLE 2

This example returns the status of in progress and queued restore requests that are being restored to the target database MBD01.

	Copy Code
Get-MailboxRestoreRequest -TargetDatabase MBD01

EXAMPLE 3

This example returns all restore requests that have the name RestoreToMBD01 where the restore request has been suspended.

	Copy Code
Get-MailboxRestoreRequest -Name "RestoreToMBD01" -Suspend $true