Export (0) Print
Expand All
Expand Minimize

Get-MailboxRestoreRequest

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-07-03

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

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

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

Get-MailboxRestoreRequest [-AccountPartition <AccountPartitionIdParameter>] [-Identity <MailboxRestoreRequestIdParameter>] [-Organization <OrganizationIdParameter>] <COMMON PARAMETERS>

Get-MailboxRestoreRequest [-AccountPartition <AccountPartitionIdParameter>] [-BatchName <String>] [-HighPriority <$true | $false>] [-Name <String>] [-Organization <OrganizationIdParameter>] [-RequestQueue <DatabaseIdParameter>] [-SourceDatabase <DatabaseIdParameter>] [-Status <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed>] [-Suspend <$true | $false>] [-TargetMailbox <MailboxOrMailUserIdParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-DomainController <Fqdn>] [-ResultSize <Unlimited>]

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

Get-MailboxRestoreRequest -Identity "ayla\MailboxRestore"

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

Get-MailboxRestoreRequest -RequestQueue MBD01

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

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

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

AccountPartition

Optional

Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter

This parameter is reserved for internal Microsoft use.

BatchName

Optional

System.String

The BatchName parameter specifies the name given to a batch of restore requests.

You can't use this parameter 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 restore requests with the specified priority range are returned. Use one of the following values:

  • $true   Returns restore requests that were created with a priority of Emergency, Highest, Higher, or High

  • $false   Returns restore requests that were created with a priority of Normal, Low, Lower, or Lowest

Identity

Optional

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).

You can't use this parameter with the Name 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 with the Identity parameter.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

RequestQueue

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The RequestQueue parameter specifies the mailbox database on which the mailbox or archive of the request resides. You can use one of the following values:

  • GUID of the database

  • Database name

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 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 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 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 with the Identity parameter.

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