Export (0) Print
Expand All
Expand Minimize

New-MailboxRestoreRequest

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-02

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

Use the New-MailboxRestoreRequest cmdlet to restore a soft-deleted or disconnected mailbox. This cmdlet starts the process of moving content from the soft-deleted mailbox, disabled mailbox, or any mailbox in a recovery database into a connected primary or archive mailbox.

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

New-MailboxRestoreRequest -SourceDatabase <DatabaseIdParameter> [-AllowLegacyDNMismatch <SwitchParameter>] [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] [-ExcludeDumpster <SwitchParameter>] [-ExcludeFolders <String[]>] [-IncludeFolders <String[]>] <COMMON PARAMETERS>
New-MailboxRestoreRequest -RemoteDatabaseGuid <Guid> -RemoteHostName <Fqdn> -RemoteRestoreType <None | RecoveryDatabase | DisconnectedMailbox | SoftDeletedRecipient> [-AllowLegacyDNMismatch <SwitchParameter>] [-AssociatedMessagesCopyOption <DoNotCopy | MapByMessageClass | Copy>] [-ConflictResolutionOption <KeepSourceItem | KeepLatestItem | KeepAll>] [-ExcludeDumpster <SwitchParameter>] [-ExcludeFolders <String[]>] [-IncludeFolders <String[]>] [-RemoteCredential <PSCredential>] <COMMON PARAMETERS>
COMMON PARAMETERS: -SourceStoreMailbox <StoreMailboxIdParameter> -TargetMailbox <MailboxOrMailUserIdParameter> [-AcceptLargeDataLoss <SwitchParameter>] [-BadItemLimit <Unlimited>] [-BatchName <String>] [-CompletedRequestAgeLimit <Unlimited>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-InternalFlags <InternalMrsFlag[]>] [-LargeItemLimit <Unlimited>] [-Name <String>] [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] [-SkipMerging <SkippableMergeComponent[]>] [-SourceRootFolder <String>] [-Suspend <SwitchParameter>] [-SuspendComment <String>] [-TargetIsArchive <SwitchParameter>] [-TargetRootFolder <String>] [-WhatIf [<SwitchParameter>]] [-WorkloadType <None | Local | Onboarding | Offboarding | TenantUpgrade | LoadBalancing | Emergency | RemotePstIngestion | SyncAggregation>]

To create a restore request, you must provide the DisplayName, LegacyDN, or MailboxGUID for the soft-deleted or disabled mailbox. This example uses the Get-MailboxStatistics cmdlet to return the DisplayName, LegacyDN, MailboxGUID, and DisconnectReason for all mailboxes on mailbox database MBD01 that have a disconnect reason of SoftDeleted or Disabled.

Get-MailboxStatistics -Database MBD01 | Where { $_.DisconnectReason -eq "SoftDeleted" -or $_.DisconnectReason -eq "Disabled" } | Format-List LegacyDN, DisplayName, MailboxGUID, DisconnectReason

This example restores the source mailbox with the MailboxGUID 1d20855f-fd54-4681-98e6-e249f7326ddd on mailbox database MBD01 to the target mailbox with the alias Ayla.

New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox 1d20855f-fd54-4681-98e6-e249f7326ddd -TargetMailbox Ayla

This example restores the content of the source mailbox with the DisplayName of Tony Smith on mailbox database MBD01 to the archive mailbox for Tony@contoso.com.

New-MaiboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox "Tony Smith" -TargetMailbox Tony@contoso.com -TargetIsArchive

When mailboxes are moved from a Microsoft Exchange Server 2013 or Exchange Server 2010 Service Pack 1 or later versions database to any other database, Exchange doesn't fully delete the mailbox from the source database immediately upon completion of the move. Instead, the mailbox in the source mailbox database is switched to a soft-deleted state, which allows mailbox data to be accessed during a mailbox restore operation by using the new MailboxRestoreRequest cmdlet set. The soft-deleted mailboxes are retained in the source database until either the deleted mailbox retention period expires or you use the Remove-StoreMailbox cmdlet to purge the mailbox.

To view soft-deleted mailboxes, run the Get-MailboxStatistics cmdlet against a database and look for results that have a DisconnectReason with a value of SoftDeleted. For more information, see EXAMPLE 1 later in this topic.

A mailbox is marked as Disabled a short time after the Disable-Mailbox or Remove-Mailbox command completes.

NoteNote:
The mailbox won't be marked as Disabled until the Microsoft Exchange Information Store service determines that Active Directory has been updated with the disabled mailbox's information. You can expedite the process by running the Update-StoreMailboxState cmdlet against that database.

Exchange retains disabled mailboxes in the mailbox database based on the deleted mailbox retention settings configured for that mailbox database. After the specified period of time, the mailbox is permanently deleted.

To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a database and look for results that have a DisconnectReason with a value of Disabled. For more information, see EXAMPLE 1 later in this topic.

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

RemoteDatabaseGuid

Required

System.Guid

This parameter is reserved for internal Microsoft use.

RemoteHostName

Required

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

RemoteRestoreType

Required

Microsoft.Exchange.Management.RecipientTasks.RemoteRestoreType

This parameter is reserved for internal Microsoft use.

SourceDatabase

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The SourceDatabase parameter specifies the identity of the database from which you're restoring the soft-deleted or disconnected mailbox.

SourceStoreMailbox

Required

Microsoft.Exchange.Configuration.Tasks.StoreMailboxIdParameter

The SourceStoreMailbox parameter specifies the identity of the mailbox from which you want to restore content. This parameter accepts the following values:

  • MailboxGUID

  • LegacyExchangeDN

  • DisplayName

You can find this information by running the Get-MailboxStatistics cmdlet.

TargetMailbox

Required

Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter

The TargetMailbox parameter specifies the identity of the mailbox or mail user to which you want to restore content. The target mailbox or mail user needs to exist before you can run this command successfully. This parameter accepts the following values:

  • GUID

  • Alias

  • LegacyExchangeDN

  • Domain\Account Name

  • SMTP address

AcceptLargeDataLoss

Optional

System.Management.Automation.SwitchParameter

The AcceptLargeDataLoss parameter specifies that a large amount of data loss is acceptable if the BadItemLimit is set to 51 or higher. Items are considered corrupted if the item can't be read from the source database or can't be written to the target database. Corrupted items won't be available in the destination mailbox or .pst file.

AllowLegacyDNMismatch

Optional

System.Management.Automation.SwitchParameter

The AllowLegacyDNMismatch parameter specifies that if the LegacyExchangeDN of the source physical mailbox and the target mailbox don't match, continue the operation. By default, this cmdlet checks to make sure that the LegacyExchangeDN on the source physical mailbox is present on the target user in the form of the LegacyExchangeDN or an X500 proxy address that corresponds to the LegacyExchangeDN. This check prevents you from accidentally restoring a source mailbox into the incorrect target mailbox.

You don't have to provide a value with this parameter.

AssociatedMessagesCopyOption

Optional

Microsoft.Exchange.MailboxReplicationService.FAICopyOption

The AssociatedMessagesCopyOption parameter specifies whether associated messages are copied when the request is processed. Associated messages are special messages that contain hidden data with information about rules, views, and forms. By default, associated messages are copied. This parameter accepts the following values:

  • DoNotCopy   The associated messages aren't copied.

  • MapByMessageClass   This option finds the corresponding associated message by looking up the MessageClass attribute of the source message. If there's an associated message of this class in both source and target folders, it overwrites the associated message in the target. If there isn't an associated message in the target, it creates a copy in the target.

  • Copy   This option copies associated messages from the source to the target. If the same message type exists both in the source and the target location, these associated messages are duplicated. This is the default option.

NoteNote:
Content filtering doesn't apply to associated messages.

BadItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The BadItemLimit parameter specifies the number of bad items to skip if the request encounters corruption in the mailbox. Use 0 to not skip bad items. The valid input range for this parameter is from 0 through 2147483647. The default value is 0. We recommend that you keep the default value 0 and only change the BadItemLimit parameter value if the request fails.

NoteNote:
If you set the BadItemLimit parameter to more than 50, the command fails, and you receive a warning stating: "Please confirm your intention to accept a large amount of data loss by specifying AcceptLargeDataLoss." If you receive this warning, you need to run the command again, this time using the AcceptLargeDataLoss parameter. No further warnings appear, and any corrupted items aren't available after the process is complete.

BatchName

Optional

System.String

The BatchName parameter specifies a descriptive name for restoring a batch of mailboxes. You can use the name in the BatchName parameter as a string search when you use the Get-MailboxRestoreRequest cmdlet.

CompletedRequestAgeLimit

Optional

Microsoft.Exchange.Data.Unlimited

The CompletedRequestAgeLimit parameter specifies how long the status of a completed restore request is set to Completed. If this parameter is set to a value of 0, the status is cleared immediately instead of being changed to Completed.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

ConflictResolutionOption

Optional

Microsoft.Exchange.MailboxReplicationService.ConflictResolutionOption

The ConflictResolutionOption parameter specifies the action for the Microsoft Exchange Mailbox Replication service (MRS) to take if there are multiple matching messages in the target. This parameter takes the following values:

  • KeepSourceItem

  • KeepLatestItem

  • KeepAll

The default value is KeepSourceItem.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

ExcludeDumpster

Optional

System.Management.Automation.SwitchParameter

The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders:

  • Deletions

  • Versions

  • Purges

ExcludeFolders

Optional

System.String[]

The ExcludeFolders parameter specifies the list of folders to exclude during the restore request.

Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax:

<FolderName>/*   Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010".

#<FolderName>#/*   Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, #Inbox# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types:

  • Inbox

  • SentItems

  • DeletedItems

  • Calendar

  • Contacts

  • Drafts

  • Journal

  • Tasks

  • Notes

  • JunkEmail

  • CommunicationHistory

  • Voicemail

  • Fax

  • Conflicts

  • SyncIssues

  • LocalFailures

  • ServerFailures

If the user creates a personal folder with the same name as a well-known folder and the # symbol surrounding it, you can use a back slash (\) as an escape character to specify that folder. For example, if a user creates a folder named #Notes# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \#Notes\#.

NoteNote:
Wildcard characters can't be used in folder names.

IncludeFolders

Optional

System.String[]

The IncludeFolders parameter specifies the list of folder to include during the restore request.

Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax:

<FolderName>/*   Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010".

#<FolderName>#/*   Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, #Inbox# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types:

  • Inbox

  • SentItems

  • DeletedItems

  • Calendar

  • Contacts

  • Drafts

  • Journal

  • Tasks

  • Notes

  • JunkEmail

  • CommunicationHistory

  • Voicemail

  • Fax

  • Conflicts

  • SyncIssues

  • LocalFailures

  • ServerFailures

If the user creates a personal folder with the same name as a well-known folder and the # symbol surrounding it, you can use a back slash (\) as an escape character to specify that folder. For example, if a user creates a folder named #Notes# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \#Notes\#.

NoteNote:
Wildcard characters can't be used in folder names.

InternalFlags

Optional

Microsoft.Exchange.Management.RecipientTasks.InternalMrsFlag[]

The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes.

LargeItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The LargeItemLimit parameter specifies the number of items to skip in the mailbox because these items exceed the item size limit for the target mailbox database. Use 0 to not skip any large items.

NoteNote:
If you set the LargeItemLimit parameter to 51 or higher, you have to include the AcceptLargeDataLoss parameter.

Name

Optional

System.String

The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple restore requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an export request for a user's mailbox that has the alias Kweku and specify the value of this parameter as RestoreFailedMoves, the identity of this export request is Kweku\RestoreFailedMoves.

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

Priority

Optional

Microsoft.Exchange.MailboxReplicationService.RequestPriority

The Priority parameter specifies the priority of the mailbox restore request. Use one of the following values:

  • Emergency

  • Highest

  • Higher

  • High

  • Normal

  • Low

  • Lower

  • Lowest

RemoteCredential

Optional

System.Management.Automation.PSCredential

This parameter is reserved for internal Microsoft use.

SkipMerging

Optional

Microsoft.Exchange.Management.RecipientTasks.SkippableMergeComponent[]

The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values:

  • FolderRules

  • FolderACLs

  • InitialConnectionValidation

Use this parameter only if a restore request fails because of folder rules, folder access control lists (ACLs), or initial connection validation.

SourceRootFolder

Optional

System.String

The SourceRootFolder parameter specifies the root folder of the mailbox from which data is restored. If this parameter isn't specified, the command restores all folders.

Suspend

Optional

System.Management.Automation.SwitchParameter

The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch.

SuspendComment

Optional

System.String

The SuspendComment parameter specifies a description about why the request was suspended. You can only use this parameter if you specify the Suspend parameter.

TargetIsArchive

Optional

System.Management.Automation.SwitchParameter

The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive.

TargetRootFolder

Optional

System.String

The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

WorkloadType

Optional

Microsoft.Exchange.MailboxReplicationService.RequestWorkloadType

The WorkLoadType parameter specifies the type of restore request based on the type of Exchange deployment or the purpose of the restore request. Use one of the following values:

  • None

  • Local

  • Onboarding

  • Offboarding

  • TenantUpgrade

  • LoadBalancing

  • Emergency

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