Restore-RMEMailbox

From PowerGUI Wiki

Jump to: navigation, search

Restores specific mailboxes.

Contents

Syntax

Restore-RMEMailbox [-CreateMissingMailboxes] [-SourceMailboxes] <Object> [-RestoreTarget <String>] [-OrganizationalUnit <String>] [-MailboxDatabaseDn <String>] [-TargetServerName <String>] [-StorageGroupName <String>] [-StoreName <String>] [[-TargetFolder] <IMapiContainer>] [[-TargetPath] <String>] [[-NamePrefix] <String>] -AnsiPst [[-FolderPath] <String>] [[-NamingOptions] <TargetNamingOptions>] -ApplySecurity [-DuplicateAction <DuplicateAction>] [<CommonParameters>]

Detailed Description

The Restore-RMEMailbox cmdlet restores specific mailboxes.



Related Commands

Parameters

Name Description Required? Pipeline Input Default Value
CreateMissingMailboxes Specifies to create the restored mailboxes on their home Exchange Servers, in case these mailboxes are not found in the target domain. This parameter creates a new mail-enabled user account for each missing mailbox being restored. If this parameter is omitted, the missing mailboxes are not restored (skipped). false false
SourceMailboxes Specifies the mailboxes to be restored. Enter a variable that contains the mailbox objects or type a command or expression that gets the mailbox objects. true true (ByValue, ByPropertyName)
RestoreTarget Specifies the Active Directory domain where the target Exchange Server computer resides. false false
OrganizationalUnit Specifies the Active Directory (AD) container where you want to create new mailbox-enabled user accounts for the missing mailboxes being restored. If this parameter is omitted, the new user accounts will be created in the default AD container for user accounts (CN=Users). false false
MailboxDatabaseDn Specifies the distinguished name (DN) of the homeMDB attribute in Active Directory. This attribute links a mailbox-enabled user account to a particular database in a specific storage group on a specific server. Specifying the homeMDB attribute DN in this parameter allows you to restore mailboxes to their home Exchange Servers. This parameter overrides and can be used instead of the following parameters:
  • TargetServerName
  • StorageGroupName
  • StoreName
false false
TargetServerName Specifies the name of the target Exchange Server computer where you want to restore the mailboxes. Instead of specifying this parameter, you can use the MailboxDatabaseDn parameter. false false
StorageGroupName Specifies the name of the storage group on the target Exchange Server computer where you want to restore the mailboxes. Instead of specifying this parameter, you can use the MailboxDatabaseDn parameter. false false
StoreName Specifies the name of the store on the target Exchange Server computer where you want to restore the mailboxes. Instead of specifying this parameter, you can use the MailboxDatabaseDn parameter. false false
TargetFolder Specifies the target folder to restore the mailboxes to. Enter a variable that contains the target folder object or type a command or expression that gets the target folder object. false false
TargetPath Specifies the name of the folder where target Personal Folders (.pst) files will be generated. This parameter is ignored unless you restore mailboxes to new Personal Folders (.pst) files. false false
NamePrefix Specifies the custom prefix to be added to the names of generated target Personal Folders (.pst) files. This parameter is ignored unless you restore mailboxes to new Personal Folders (.pst) files. false false
AnsiPst Specifies to restore each folder to a new individual Personal Folders (.pst) file in the ANSI format. false false
FolderPath Specifies the path to the target folder in a storage or file where you want to place the restored mailboxes. false false
NamingOptions Specifies naming options for the generated target Personal Folders (.pst) files.

This parameter can take one or both of the following values:

  • 'IncludeStoreName' - Adds the source storage name as a prefix to the names of target .pst files.
  • 'IncludeTimeStamp' - Appends the date and time of creation of target .pst files to their names.

If specifying both values, delimit them with a comma. This parameter is ignored unless you restore mailboxes to new Personal Folders (.pst) files.

false false
ApplySecurity Applies access permissions to the new target Personal Folders (.pst) files generated in the result of the restore operation. false false
DuplicateAction Specifies how to handle message duplicates during the restore operation.

This parameter can take one of the following values:

  • 'Copy' - The messages you are restoring will not overwrite any of their duplicates located in target storages or files. The restored messages and their duplicates will coexist in target storages or files.
  • 'Overwrite' - The messages you are restoring will overwrite all their duplicates in target storages or files without any warning.
  • 'OverwriteIfNewer' - The messages you are restoring will overwrite their duplicates in target storages or files only if these duplicates are older than the messages being restored.
  • 'Skip' - The messages whose duplicates are found in target storages or files will not be restored.
false false

Examples

Example 1

Attach-RMEExchangeDB "C:\Data\Edb\EdbSearchTest\EdbSearchTest.edb" | Get-RMEFolder -MailboxNameInclude "John Doe" | Restore-RMEMailbox -TargetPath "C:\Data\Exported\Pst"

The Attach-RMEExchangeDB cmdlet connects to the EdbSearchTest.edb mailbox store database and pipes it to the Get-RMEMailbox cmdlet that retrieves the mailbox whose name is John Doe. The Restore-RMEMailbox cmdlet then restores the retrieved mailbox to a new .pst file in the "C:\Data\Exported\Pst" folder.

Retrieved from "http://wiki.powergui.org/index.php/Restore-RMEMailbox"
Personal tools