Restoremailbox optional parameters

By default, IBM Spectrum Protect Snapshot uses the local server as the CAS if the CAS role is installed on the local server. If the CAS role is not installed on the local server, IBM Spectrum Protect Snapshot uses the mailbox database that the user is logged in to.

Get-MailboxDatabase -Identity <logon user mailbox database> | 
select RpcClientAccessServer

You can also specify a different CAS.

The configfilename variable can include a fully qualified path. If the configfilename variable does not include a path, the IBM Spectrum Protect Snapshot for Microsoft Exchange Server installation directory is used. If the /CONFIGfile parameter is not specified, or if the configfilename variable is not specified, the default value is tdpexc.cfg.

/CONFIGfile="c:\Program Files\file.cfg"

The logfilename variable identifies the name of the activity log file.

If the specified log file does not exist, a new log file is created. If the specified log file exists, new log entries are appended to the file. The logfilename variable can include a fully qualified path. However, if no path is specified, the log file is written to the IBM Spectrum Protect Snapshot for Microsoft Exchange Server installation directory.

/LOGFile="c:\Program Files\mytdpexchange.log"

If you do not specify the /LOGFile parameter, log records are written to the default log file, tdpexc.log.

The /LOGFile parameter cannot be turned off, logging always occurs.

When you use multiple simultaneous instances of IBM Spectrum Protect Snapshot for Microsoft Exchange Server to run operations, use the /LOGFile parameter to specify a different log file for each instance that is used. This function directs logging for each instance to a different log file and prevents interspersed log file records.

Failure to specify a different log file for each instance can result in unreadable log files.

When you prune log data, you can discard some of the generated logs according to detailed filtering criteria that you set. Depending on the option that you set for the /LOGPrune parameter, some days of data are saved. By default, 60 days of log entries are saved. The option No can be entered to disable log pruning.

Regardless of the option that you set for this parameter, you can explicitly request log pruning at any time.

If you do not specify the /MAILBOXORIGLOCATION parameter, the default value is the location (found in the mailbox location history) of the mailbox to restore from, for the backup time specified. If no mailbox location history is available, the default value is the current active location of the mailbox.

server-name

The name of the Exchange Server where the mailbox is at the time of backup.

db-name

The name of the database where the mailbox is at the time of backup.

The /MAILBOXORIGLOCATION parameter is only necessary if the mailbox to be restored from is moved or deleted after the time of the backup, and no mailbox location history is available.

TDPEXCC RESTOREMAILBOX annjones 
/MAILBOXORIGLOCATION=serv1,mbdb1
/MAILBOXRESTOREDAte=12/31/2013 
/MAILBOXRESTOREDESTination=PST,c:\team99\rcvr.pst

If restore-date orrestore-time values are not specified, no date and time is established. By default the mailbox is restored from the most recent available backup.

If either restore-date or restore-time is specified, then the mailbox is restored from the earliest backup that is selected after the established restoration date and time. If no backup of the mailbox after the established date and time is found, by default the mailbox will be restored from the most recent available backup.

• If you specify both restore-date or restore-time, this action establishes the mailbox restoration period.
• If you specify restore-date and you do not specify restore-time, restore-time defaults to a value of 23:59:59. This action establishes the restore-date at the specified date.
• If you specify restore-time without restore-date, then restore-date defaults to the current date. This setting establishes the restoration date and time as the current date at the specified restore-time.

If restore-date and restore-time values are not specified, no date and time is established. By default the mailbox is restored from the most recent available backup.

If either restore-date or restore-time is specified, the mailbox is restored from the earliest backup that is selected after the established date and time. If no backup of the mailbox after the established date and time is found, by default the mailbox is restored from the most recent available backup.

• If you specify both restore-date and restore-time, this function establishes the mailbox restoration period.
• If you specify restore-date and you do not specify restore-time, restore-time defaults to a value of 23:59:59. This function establishes the restore-date at the specified date.
• If you specify restore-time without restore-date, the restore-date variable defaults to the current date. This function establishes the restoration date and time as the current date at the specified restore-time.

If you do not specify the /mailboxrestoredestination parameter, by default, the EXCHANGE option is used and the /mailboxrestoredestination is not required. The default system behavior is to restore mailbox data to the original location in the original active mailbox. When you restore multiple mailboxes with the same restoremailbox command, the default system behavior is to restore mailbox data into each original active mailbox.

Mailbox items are merged into the mailbox destination. If a mailbox item exists in the mailbox destination, that item is not restored.

You must specify one of the following values when you use this parameter:

EXCHANGE,[target-mailboxname,target-foldername]

Use the /mailboxrestoredestination=EXCHANGE option to restore mailbox messages into a live Exchange Server.

The EXCHANGE option is the default option. If you specify the /mailboxrestoredestination=EXCHANGE option without specifying any variables, the result is the same as not specifying the /mailboxrestoredestination parameter. The mailbox data is restored to the original location in the original active mailbox.

Use /mailboxrestoredestination=EXCHANGE,target-mailboxname,target-foldername to restore mailbox messages into a destination other than the original location in the original active mailbox. The mailbox messages are restored into a subfolder of the specified folder within the target mailbox. The target mailbox can be the original mailbox or an alternate mailbox.

When you restore multiple mailboxes with the same restoremailbox command, this option restores the mailbox data into a subfolder (designated by each original mailbox-alias) of the specified target folder in the active mailbox. The folders from the corresponding original mailbox, which contain the restored mailbox messages, are in each subfolder. The specified folder in the target mailbox contains a subfolder that is designated by the original mailbox alias name. Subfolders that contain the restored mailbox messages are in each parent subfolder. These child subfolders have the folder structure of the original mailbox.

target-mailboxname

Specify the target mailbox-alias or the target mailbox-display name. The target mailbox must be an active mailbox.

If the target-mailboxname variable includes spaces, enclose the entry in double quotation marks.

To restore a specific public folder to an alternate public folder mailbox, specify both the /MAILBOXFILTER=folder,original-folder-name parameter and the /MAILBOXRESTOREDESTination=EXCHANGE,target-publicfolder-mailboxname parameter. For example:

tdpexcc restoremailbox "OriginalPublicFolderMailbox" 
/MailboxFilter=folder,"folderA" /MAILBOXRESTOREDESTination=
EXCHANGE,"TargetPublicFolderMailbox"

You can restore a public folder only to an existing public folder on the Exchange server. If the public folder is relocated to an alternate mailbox destination after the time of the backup, ensure that it exists in the alternate mailbox location with the same folder path as the folder to be restored. The restore operation does not automatically re-create the public folder in the destination mailbox.

target-foldername

The target-foldername variable specifies the mailbox folder in the target mailbox to restore mailbox messages to.

If you restore a mailbox to a different destination than the original mailbox, the mailbox folders are restored in the destination mailbox under a folder that is named original-mailbox_mailbox-GUID. In the process, the Recoverable Items folders are restored.

If you specify the target-mailboxname variable and the target mailbox is not the original mailbox, you must specify a folder name. However, when you restore to a mailbox in a target public folder, do not specify a target folder name. A folder name is not required for public folder restore operations.

If the mailbox folder specified by the target-foldername variable does not exist in the target mailbox, a folder with the target folder name is created in the target mailbox except for public folder mailboxes.

The target folder contains one subfolder for each original-mailbox that is restored (designated by each original-mailbox alias). The folders from the corresponding original mailbox, which contain the restored mailbox messages, are in each subfolder. If you did not specify the /mailboxfilter parameter, the target folder that you specified contains, within the subfolder that is designated by the original mailbox alias, all the folders that are in the mailbox that you are restoring from. If you specified the /mailboxfilter parameter, the subfolder within the folder that you specified contains only the folders with messages that match the filter criteria.

If the target-foldername variable includes spaces, enclose the entire target-foldername variable entry in double quotation marks. For example:

/MAILBOXRESTOREDESTination=EXCHANGE,Kerry,"temp folder"

When you restore multiple mailboxes with the same restoremailbox command, and you specify a target folder, each original-mailbox is restored to the target folder in the target mailbox. The target folder contains one subfolder for each original-mailbox that is restored (designated by each original mailbox alias). The folders from the corresponding original mailbox, which contain the restored mailbox messages, are in each subfolder.

For example, this restoremailbox operation restores mailboxes "andrew baker" and "sally wood" to the folder "previous_acctmngr" in the target mailbox "mary brown":

restoremailbox "andrew baker","sally wood"
/mailboxrestoredest=exchange,"mary brown",previous_acctmngr

The restored mailbox messages are placed in folders that are copied from the original mailboxes that use the following folder structure:

mary brown (target mailbox)
          >-previous_acctmngr     (specified folder)
          |    >-abaker           (original-mailbox1 alias)
          |    | >-Inbox      (restored folder from mailbox1)
          |    | >-Outbox     (restored folder from mailbox1)
          |    | >-My Accts   (restored folder from mailbox1)
          |    | >-swood            (original-mailbox2 alias)
          |    | >-Inbox      (restored folder from mailbox2)
          |    | >-Outbox     (restored folder from mailbox2)
          |    | >-New Accnts (restored folder from mailbox2)
 

PST,non-Unicode-pst-filename-path

Use /mailboxrestoredestination=PST,non-Unicode-pst-filename-path to restore mailbox data to an Exchange Server personal folders (.pst) file. The mailbox data that is restored is in non-Unicode format.

You can include the non-Unicode-pst-filename-path variable to specify the destination where the restoremailbox operation writes the .pst file. The non-Unicode-pst-filename-path can be either a fully qualified path to a .pst file or a directory path. If you do not specify a path, the .pst file is written to the current directory.

• You can specify non-Unicode-pst-filename-path as a fully qualified path to a .pst file to restore all mail to that .pst file.

  TDPEXCC RESTOREMAILBOX gclark
    /mailboxrestoredestination=PST,c:\mb\dept54\vpo.pst

  Note: The .pst directory must exist before you use the restoremailbox command. The .pst file is created if it does not exist.
  If you are restoring more than one mailbox and you specify a fully qualified path to a .pst file, all the mailbox data is restored to the one .pst file specified. Inside the .pst file, the parent-level folder name is the mailbox-alias-name, followed by the rest of the mailbox folders.
• You can specify non-Unicode-pst-filename-path as a directory path to have IBM Spectrum Protect Snapshot for Microsoft Exchange Server create a .pst file by using the mailbox-alias-name of the mailbox that is being restored, and store the .pst file in the specified directory. For example, the .pst file name of the restored mailbox "George Clark"(gclark) is gclark.pst.

  TDPEXCC RESTOREMAILBOX "george clark" 
    /mailboxrestoredestination=PST,c:\mb\dept54\

  The .pst directory must exist before you use the restoremailbox command. If the .pst file does not exist, the file is created.

  If you restore multiple mailboxes with the same restoremailbox command, and you specify a directory path, each mailbox is restored into a separate .pst file. For example, if mailboxes

  John (john1), John Oblong
                                         (oblong), and Barney Olef (barneyo)

  are restored and the specified directory path is c:\finance, all mailboxes are restored into the c:\finance directory as shown:

  c:\finance\john1.pst
  c:\finance\oblong.pst
  c:\finance\barneyo.pst

The .pst directory must exist before you use the restoremailbox command. The mailbox data that is restored by using /mailboxrestoredestination=PST,non-Unicode-pst-filename-path must be less than 2 GB.

If the non-Unicode-pst-filename-path variable includes spaces, enclose the entire non-Unicode-pst-filename-path variable entry in double quotation marks and do not append a backslash character (\) at the end of folder path. For example:

TDPEXCC RESTOREMAILBOX "george clark" 
  /mailboxrestoredestination=PST,"c:\mb\dept54\access group"

UNICODEPST,Unicode-pst-filename-path

Use /mailboxrestoredestination=UNICODEPST,Unicode-pst-filename-path to restore mailbox data to an Exchange Server personal folders (.pst) file. The mailbox data that is restored is in Unicode format.

You can include the Unicode-pst-filename-path variable to specify where the restoremailbox operation locates the .pst file. The Unicode-pst-filename-path can be either a fully qualified UNC path to a .pst file or a directory path. If you do not specify a path, the .pst file is written to the current directory. If you specify a non-UNC path (such as c:\dir\mailbox.pst), IBM Spectrum Protect Snapshot for Microsoft Exchange Server tries to convert it to a UNC path for you, but it might not work for custom UNC paths or shares.

• To restore all mail to a .pst file, specify Unicode-pst-filename-path as a fully qualified path to the .pst file.

  TDPEXCC RESTOREMAILBOX gclark
    /mailboxrestoredestination=UNICODEPST,c:\mb\dept54\vpo.pst

  If the Unicode-pst-filename-path variable includes spaces, enclose the entire Unicode-pst-filename-path variable entry in double quotation marks and do not append a backslash character (\) at the end of folder path. For example:

  TDPEXCC RESTOREMAILBOX "george clark" 
  /mailboxrestoredestination=UNICODEPST,"c:\mb\dept54\access group"

  The .pst directory must exist before you issue the restoremailbox command. If the .pst file does not exist, the file is created.

  If you are restoring more than one mailbox and you specify a fully qualified path to a .pst file, all the mailbox data is restored to the.pst file that you specify. The parent-level folder name in the .pst file is the mailbox-alias-name. The remaining mailbox folders follow the parent-level folder.
• Specify Unicode-pst-filename-path as a directory path if you want IBM Spectrum Protect Snapshot for Microsoft Exchange Server to create a .pst file by using the mailbox-alias-name of the mailbox that is being restored, and to store the .pst file in the specified directory. For example, the .pst file name of the restored mailbox "George Clark"(gclark) is gclark.pst.

  TDPEXCC RESTOREMAILBOX "george clark" 
    /mailboxrestoredestination=UNICODEPST,c:\mb\dept54

  The .pst directory must exist before you issue the restoremailbox command. If the .pst file does not exist, the file is created.

  If you restore multiple mailboxes with the same restoremailbox command, and you specify a directory path, each mailbox is restored into a separate .pst file. For example, if mailboxes

  John (john1), John Oblong
                                         (oblong), and Barney Olef (barneyo)

  are restored and the specified directory path is c:\finance, all mailboxes are restored into the c:\finance directory as shown:

  c:\finance\john1.pst
  c:\finance\oblong.pst
  c:\finance\barneyo.pst

• To restore only the mail items in the Deletions subfolder of the Recoverable Items/ folder, specify the /MAILBOXFILTER=FOLDER parameter with the correct folder value for the target destination.
  As shown in the following example, if you are restoring mail items to a Unicode .pst file, specify the full folder path to the Deletions folder.

  tdpexcc restoremailbox "george clark" /MailboxFilter=folder,
  "Recoverable Items/Deletions" /KEEPRDB=NO /USEExistingrdb=NO 
  /MAILBOXRESTOREDESTination=UNICODEPST,c:\gclark.pst

ARCHIVEMAILBOX,[target-mailboxname,target-foldername]

Use /MAILBOXRESTOREDESTination with the ARCHIVEMAILBOX and /FROMARCHIVE parameters to restore archive mailbox messages to its original archive mailbox or to an alternate archive mailbox.

Use /MAILBOXRESTOREDESTination=ARCHIVEMAILBOX,target-mailboxname to specify the archive mailbox destination that you want to restore to. You can also specify a target folder name in the archive mailbox.

To restore an archive mailbox into a specific folder of an archive mailbox, specify both the /FROMArchive parameter and the /MAILBOXRESTOREDESTination=ARCHIVEMAILBOX,target-mailboxname,target-foldername parameters. For example:

tdpexcc restoremailbox "OriginalFolderName" /FROMArchive
/MAILBOXRESTOREDESTination=ARCHIVEMAILBOX,"TargetFolderName" 
"folderA"

If you specify the /MAILBOXRESTOREDESTination=ARCHIVEMAILBOX parameter without specifying a target mailbox destination, the mailbox messages are restored to the original location in the original archive mailbox.

You can mount a read/write copy of your IBM Spectrum Protect backup so that you can modify the copy without invalidating the backup. You use this option to indicate whether a snapshot backup is mounted as read/write. The default value is as specified in the configuration file with the /MOUNTRW parameter. If a default value is not specified in the configuration file, the default value is No. By specifying the /MOUNTRW option, you override the default value.

If you do not specify the /TEMPDBRESTorepath parameter, the default value is the value that is specified by the /TEMPDBRESTorepath option in the IBM Spectrum Protect Snapshot configuration file. The default IBM Spectrum Protect Snapshot for Microsoft Exchange Server configuration file is tdpexc.cfg. If the /TEMPDBRESTorepath value does not exist in the IBM Spectrum Protect Snapshot for Microsoft Exchange Server configuration file, the TEMP environment variable value is used.

TDPEXCC RESTOREMAILBOX richgreene 
  /tempdbrestorepath="h:\Exchange Restore Directory"

• Do not specify a value of /TEMPDBRESTorepath that is the same value as the location of the active database. If the value is the same, the database might become corrupted.
• Choose a temporary database-restore location that has enough space to hold the entire restore for the database.

For better performance, the current active-transaction logger is to be on a different physical device from the paths that are specified by the values of the /TEMPDBRESTorepath parameter and the /TEMPDBRESTorepath parameter. The paths that are specified by the values of the /TEMPDBRESTorepath parameter and the /TEMPDBRESTorepath parameter can be on the same or separate physical devices from each other.

Do not specify double-byte characters (DBCS) within the temporary database-restore path.

If you do not specify the /TEMPLOGRESTorepath parameter, the default value is the value that is specified by the /TEMPLOGRESTorepath option in the IBM Spectrum Protect Snapshot configuration file. The default IBM Spectrum Protect Snapshot for Microsoft Exchange Server configuration file is tdpexc.cfg. If you do not specify the /TEMPLOGRESTorepath parameter and the /TEMPLOGRESTorepath value does not exist in the IBM Spectrum Protect Snapshot for Microsoft Exchange Server configuration file, the TEMP environment variable value is used.

• Do not specify a value of /TEMPLOGRESTorepath that is the same value as the current location for the database that is used for recovery. If the value is the same, the database might become corrupted.
• Choose a temporary log-restore location that has enough space to hold all the log and patch files.

For better performance, the current active-transaction logger is to be on a different physical device from the paths that are specified by the values of the /TEMPLOGRESTorepath parameter and the /TEMPLOGRESTorepath parameter. The paths that are specified by the values of the /TEMPLOGRESTorepath parameter and the /TEMPLOGRESTorepath parameter can be on the same or separate physical devices from each other.

Do not specify double-byte characters (DBCS) within the temporary log-restore path.

If you do not specify the /TEMPMAILBOXAlias parameter, the default value is the value that is specified by the /TEMPMAILBOXAlias option in the IBM Spectrum Protect Snapshot configuration file. The default IBM Spectrum Protect Snapshot for Microsoft Exchange Server configuration file is tdpexc.cfg. If the /TEMPMAILBOXAlias value does not exist in the IBM Spectrum Protect Snapshot for Microsoft Exchange Server configuration file, the mailbox of the currently logged on user is used as the temporary mailbox.

Specify the following value when you use this parameter:

tempmailbox-alias

Specify the mailbox-alias of the temporary mailbox to use for recovery of mailboxes that are deleted or re-created after the time of the backup you are restoring from.

Ensure that the temporary mailbox is active and has enough storage capacity to accommodate all items of the mailboxes that are being restored.

If the tempmailbox-alias variable includes spaces, enclose the entry in double quotation marks.