- /CLIENTACcessserver=configfilename
- Use
the /CLIENTACcessserver parameter to specify
the name of the Client Access Server (CAS) that you want to use. This
parameter is available only if you use Microsoft Exchange 2010 or later versions.
By
default, Tivoli® Storage FlashCopy® Manager 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, Tivoli Storage FlashCopy Manager uses
the mailbox database that the user is logged in to.
To determine
the name of the CAS in use, run this Exchange Management Shell command:
Get-MailboxDatabase -Identity <logon user mailbox database> |
select RpcClientAccessServer
You can also specify
a different CAS.
- /CONFIGfile=configfilename
- Use
the /CONFIGfile parameter to specify the name
of the Tivoli Storage FlashCopy Manager for Exchange
Server configuration
file that contains the values for the Tivoli Storage FlashCopy Manager for Exchange
Server configuration
options.
The configfilename variable can include
a fully qualified path. If the configfilename variable
does not include a path, the Tivoli Storage FlashCopy Manager for 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.
If
the
configfilename variable includes spaces, enclose
the entire
/CONFIGfile parameter entry in double
quotation marks. For example:
/CONFIGfile="c:\Program Files\file.cfg"
- /DAGNODe=nodename
- Specify the node name that you
want to use to back up the databases in an Exchange Server
Database Availability Group. With this setting, backups
from all Database Availability Group members that are configured
to use the DAG node are backed up to a common file space
on the Tivoli Storage
Manager server.
The database copies are managed as a single entity, regardless
of which Database Availability Group member they are backed
up from. This setting can prevent Data Protection for Exchange Server from
making too many backups of the same database.
- /FCMOPTFile=dsmoptfilename
- The /FCMOPTFile parameter
specifies the Tivoli Storage FlashCopy Manager options
file to use.
- The dsmoptfilename variable can include a fully
qualified path. If you do not include a path, the Tivoli Storage FlashCopy Manager installation
directory is used.
- If the dsmoptfilename variable spaces, enclose
it in double quotation marks.
- If you do not specify /FCMOPTFile, the default
value is dsm.opt.
- If you specify /FCMOPTFile but not dsmoptfilename,
the default is also dsm.opt.
- /FROMArchive
- Use
the /FROMArchive parameter only if you are restoring
an archive mailbox and you specify the mailbox alias of the primary
mailbox. If you specify the primary mailbox alias and you do not specify
this parameter option, by default, the primary mailbox is restored.
To restore an archive mailbox to another archive mailbox,
specify both the
/FROMArchive and the
/MAILBOXRESTOREDESTination=ARCHIVEMAILBOX,target-mailboxname parameters.
For example:
tdpexcc restoremailbox "OriginalArchiveMailboxName" /FROMArchive
/MAILBOXRESTOREDESTination=ARCHIVEMAILBOX,"TargetArchiveMailboxName"
- /KEEPRDB=No|Yes
- Use
the /KEEPRDB parameter to specify whether Tivoli Storage FlashCopy Manager retains
a recovery database for reuse in mailbox restore operations, or automatically
removes the recovery database after mailbox restore operations.
You
can specify the following values:
- No
- Do not retain a recovery database for mailbox restore operations.
Remove the recovery database after mailbox restore processing. This
option is the default.
- Yes
- Retain the recovery database for mailbox restore operations.
- /LOGFile=logfilename
- Use
the /LOGFile parameter to specify the name of
the activity log file that is generated by Tivoli Storage FlashCopy Manager for Exchange
Server.
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 Tivoli Storage FlashCopy Manager for Exchange
Server installation
directory.
If the
logfilename variable includes
spaces, enclose the entire
/LOGFile parameter
in double quotation marks. For example:
/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 Tivoli Storage FlashCopy Manager for 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.
- /LOGPrune=numdays|No
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.
Considerations:
- For numdays, the range is 0 to 9999.
A value of 0 deletes all entries in the activity
log file except for the current command entries.
- If you specify no, the log file is not pruned.
- If you do not specify /LOGPrune, the default
value is that specified by the logprune configurable
option in the configuration file. The default value is 60.
- If you specify /LOGPrune, its value is used
instead of the value that is stored in the configuration file. Specifying
this parameter does not change the value in the configuration file.
- You can specify /LOGPrune without specifying numdays or no;
in this case, the default value, 60, is used.
- Changes to the value of the TIMEformat or DATEformat parameter
can result in an unwanted pruning of the log file. If you are running
a command that might prune the log file, and the value of the TIMEformat or DATEformat parameter
is changed, complete one of the following to prevent unintentional
pruning of the log file:
- Make a copy of the existing log file.
- Specify a new log file with the /LOGFile parameter
or logfile setting.
- /MAILBOXFILTER=ATTACHMENTNAME|ENDDATETIME|FOLDER|
MESSAGEBODY| SENDER|STARTDATETIME|SUBJECT|ALLCONTENT
- Use
the /MAILBOXFILTER parameter to specify filters
to restrict what mailbox data is restored. When you are restoring
to a Unicode .pst file, except for the FOLDER and ALLCONTENT filters,
the filters are ignored.
You can specify multiple filters; however,
you must specify each filter only one time. For each filter that you
specify, a separate
/MAILBOXFILTER parameter
must be used. For example:
tdpexcc.exe restoremailbox dchang /MAILBOXFILTER=STARTDATETIME,07/01/2013
/MAILBOXFILTER=ENDDATETIME,07/31/2013
Mailbox data that
matches a combination of all filters that are specified is restored.
If no filters are specified, by default all data in the mailbox is
restored.
Specify one of the following filters when you use
this parameter:
- ATTACHMENTNAME,attachmentname-search-text
- Use /MAILBOXFILTER=attachmentname attachmentname-search-text to
restore only the mailbox messages that contain a match of the specified
text within a message attachment name. The match is not case-sensitive.
For example, an attachmentname-search-text of Rob matches
the attachment name: Rob, robert.txt, PROBE,
and prObe.pdf.
Enclose the attachmentname-search-text variable
in double quotation marks.
The ATTACHMENTNAME filter
does not match the attachment names of encrypted mailbox messages.
If a mailbox message is encrypted, it is skipped by the ATTACHMENTNAME filter.
- ENDDATETIME,end-date[,end-time]
- Use /MAILBOXFILTER=enddatetime,end-date[,end-time] to
restore only the mailbox messages that are sent or received earlier
than the specified date and time.
- The end-date variable is required. Use the
same date format for the end-date that you selected
with the DATEFORMAT option in the Tivoli Storage FlashCopy Manager options
file.
- The end-time variable is optional. Use the
same time format for the end-time variable that
you selected with the TIMEFORMAT option in the Tivoli Storage FlashCopy Manager options
file.
The ENDDATETIME filter date and time must
be later than the STARTDATETIME filter date and time.
If no time is specified, all messages that are sent or received on
that date is restored.
- FOLDER,folder-name
-
Use /MAILBOXFILTER=folder,original-folder-name to
restore only the mailbox messages that are in the specified folder
within the original mailbox. The match is not case-sensitive.
Enclose
the original-folder-name variable in double quotation
marks.
If you use this parameter to filter a public folder to restore, ensure that you
are restoring the folder to an existing public folder that has the same folder path as the public
folder to be restored. If the original public folder is deleted after the time of the backup,
re-create the public folder. Specify the full path to the folder. If the full directory path
includes spaces, enclose the directory path in double quotation marks, and do not append a backslash
character (\) at the end of the directory path.
For example, to restore a folder that is named "SubFolder" under "ParentFolder",
specify "ParentFolder/SubFolder" as the folder
path. To restore all folders in a parent folder, use ParentFolder/*.
If you use this parameter to restore a specific folder
in an archive mailbox, ensure that you specify the full directory
path to the folder.
To restore an archive mailbox
to another archive mailbox, you must specify both the
/MAILBOXFILTER=folder,original-folder-name parameter
and the
/MAILBOXRESTOREDESTination=ARCHIVEMAILBOX,target-mailboxname parameter.
For example:
tdpexcc restoremailbox "OriginalArchiveMailboxName"
/MailboxFilter=folder,"/folderA" /MAILBOXRESTOREDESTination=
ARCHIVEMAILBOX,"TargetArchiveMailboxName"
To restore the folder of a mailbox to a Unicode .pst file,
you must specify the /MAILBOXFILTER=FOLDER parameter
with the /MAILBOXRESTOREDESTination=UNICODEPST parameter.
Specify the full directory path to the folder. For example, to restore
a folder that is named "SubFolder" under "ParentFolder",
specify "ParentFolder/SubFolder" as the folder
path. To restore all folders in a parent folder, use ParentFolder/*.
- MESSAGEBODY,messagebody-search-text
- Use /MAILBOXFILTER=messagebody,,messagebody-search-text to
restore only the mailbox messages that contain a match of the specified
text within the message body. The match is not case-sensitive. For
example, a ,messagebody-search-text of Rob matches
the message body text: Rob, robert, PROBE,
and prObe.
Enclose the messagebody-search-text variable
in double quotation marks.
The MESSAGEBODY filter
does not match the message body of encrypted mailbox messages. If
a mailbox message is encrypted, it is skipped by the MESSAGEBODY filter.
- SENDER,sender-name
- Use /MAILBOXFILTER=sender,,sender-name to
restore only the mailbox messages that are received from the specified
message sender.
Enclose the sender-name variable
in double quotation marks.
- STARTDATETIME,start-date[,start-time]
- Use /MAILBOXFILTER=startdatetime,start-date[,start-time] to
restore only the mailbox messages that are sent or received after
the specified date and time.
The start-date variable
is required. Use the same date format for the start-date that
you selected with the DATEFORMAT option in the Tivoli Storage FlashCopy Manager options
file.
The start-time variable is optional.
Use the same time format for the start-time variable
that you selected with the TIMEFORMAT option in the Tivoli Storage FlashCopy Manager options
file.
The STARTDATETIME filter date and time
must be earlier than the ENDDATETIME filter date
and time. If no time is specified, all messages that are sent or received
on that date is restored.
- SUBJECT,subject-search-text
- Use /MAILBOXFILTER=subject,,subject-search-text to
restore only the mailbox messages that contain a match of the specified
text within the message subject line. The match is not case-sensitive.
For example, a subject-search-text of Rob matches
the subject text: Rob, robert, PROBE,
and prObe.
Enclose the subject-search-text variable
in double quotation marks.
- ALLCONTENT,allcontent-search-text
- Use /MAILBOXFILTER=allcontent,allcontent-search-text to
restore only the mailbox messages that contain a match of the specified
text that is contained within the message sender, the message subject
line, or the message body. The match is not case-sensitive. For example,
an allcontent-search-text of Rob matches Rob, robert, PROBE,
and prObe contained within the attachment name,
message sender, the subject line, or the message body.
Enclose the allcontent-search-text variable
in double quotation marks.
The ALLCONTENT filter
does not match the message body of encrypted mailbox messages. If
a mailbox message is encrypted, the ALLCONTENT filter
matches only text that is contained within the message sender or the
subject line.
- /MAILBOXORIGLOCATION=server-name,db-name
- Use
the /MAILBOXORIGLOCATION parameter to specify
the Exchange Server and the database where the mailbox is at the time
of backup.
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.
A
restoremailbox operation
from a backup that is selected with
Tivoli Storage FlashCopy Manager for Exchange
Server before
version 6.1 fails if the
/MAILBOXORIGLOCATION parameter
is not specified for mailboxes that meet one or both of the following
the conditions:
- The mailbox to be restored is moved. (The mailbox is not in the
same server and the same database where the mailbox is at the time
of backup).
- The mailbox to be restored is deleted and the restore destination
is to an alternate mailbox or to a .pst file.
For example:
TDPEXCC RESTOREMAILBOX annjones
/MAILBOXORIGLOCATION=serv1,mbdb1
/MAILBOXRESTOREDAte=12/31/2013
/MAILBOXRESTOREDESTination=PST,c:\team99\rcvr.pst
- /MAILBOXRESTOREDAte=restore-date
- Use
the /MAILBOXRESTOREDAte parameter with or without
the /mailboxrestoretime parameter to establish
a date and time to restore mailbox data from. A mailbox is restored
from the earliest backup that is selected after the date and time
that is established by the /MAILBOXRESTOREDAte and
the /mailboxrestoretime parameters. Specify the
appropriate date in the restore-date variable; use
the same format that you selected with the DATEFORMAT option
in the Tivoli Storage FlashCopy Manager for Exchange
Server options
file.
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.
- /MAILBOXRESTORETime=restore-time
- Use
the /MAILBOXRESTORETime parameter with or without
the /MAILBOXRESTOREDAte parameter to establish
a date and time to restore a mailbox from. A mailbox is restored from
the earliest backup that is selected after the date and time that
is established by the /MAILBOXRESTOREDAte and
the /MAILBOXRESTORETime parameters. Specify the
appropriate time in the restore-time variable; use
the same format that you selected with the TIMEFORMAT option
in the Tivoli Storage FlashCopy Manager for Exchange
Server options
file.
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.
- /MAILBOXRESTOREDESTination=ARCHIVEMAILBOX|EXCHANGE|PST|UNICODEPST
- Use
the /mailboxrestoredestination parameter to specify
the destination to restore the mailbox data to.
If you do not specify
the /mailboxrestoredestination parameter, 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:
- ARCHIVEMAILBOX,[target-mailboxname,target-foldername]
- Use the /MAILBOXRESTOREDESTination
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.
- EXCHANGE,[target-mailboxname,target-foldername]
- Use the /mailboxrestoredestination EXCHANGE option
to restore mailbox messages into a live Exchange Server.
If you
specify the /mailboxrestoredestination EXCHANGE option
without specifying any variables, /mailboxrestoredestination=EXCHANGE,
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 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
Tivoli Storage FlashCopy Manager for 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 the destination where the
restoremailbox operation writes 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),
Tivoli Storage FlashCopy Manager for Exchange
Server tries to convert it to a UNC path for
you, but it might not work for custom UNC paths or shares.
- You can specify 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=UNICODEPST,c:\mb\dept54\vpo.pst
Important: 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 Unicode-pst-filename-path as a directory path to have
Tivoli Storage FlashCopy Manager for 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=UNICODEPST,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
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"
- /MAILBOXRestoreunread=Yes|No
- Use
the /MAILBOXRestoreunread parameter to specify
whether Data Protection for Microsoft Exchange Server marks
restored mail messages as unread.
You can specify the following
values:
- Yes
- Mark restored mail messages as unread. This option is the default.
- No
- Do not mark restored mail messages as unread.
- /Quiet
- This
parameter prevents the display of status information but does not
affect the level of information that is written to the activity log.
- /TEMPDBRESTorepath=path-name
- Use
the /TEMPDBRESTorepath parameter to specify the
default temporary path to use when you restore mailbox database files.
If
you do not specify the /TEMPDBRESTorepath parameter,
the default value is the value that is specified by the /TEMPDBRESTorepath option
in the Tivoli Storage FlashCopy Manager configuration
file. The default Tivoli Storage FlashCopy Manager for Exchange
Server configuration
file is tdpexc.cfg. If the /TEMPDBRESTorepath value
does not exist in the Tivoli Storage FlashCopy Manager for Exchange
Server configuration
file, the TEMP environment variable value is used.
If the
path-name variable
includes spaces, enclose the entire
/TEMPDBRESTorepath parameter
entry in double quotation marks. For example:
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.
- /TEMPLOGRESTorepath=path-name
- Use
the /TEMPLOGRESTorepath parameter to specify
the default temporary path to use when you restore logs and patch
files.
If you do not specify the /TEMPLOGRESTorepath parameter,
the default value is the value that is specified by the /TEMPLOGRESTorepath option
in the Tivoli Storage FlashCopy Manager configuration
file. The default Tivoli Storage FlashCopy Manager for Exchange
Server configuration
file is tdpexc.cfg. If you do not specify the /TEMPLOGRESTorepath parameter
and the /TEMPLOGRESTorepath value does not exist
in the Tivoli Storage FlashCopy Manager for 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.
- /TEMPMAILBOXAlias=tempmailbox-alias
- Use
the /TEMPMAILBOXAlias parameter to specify the
mailbox-alias of a temporary mailbox to use. A temporary mailbox is
used when you run mailbox restore operations on mailboxes that are
deleted or re-created after the time of the backup you are restoring
from. A temporary mailbox is used by the mailbox restore operations
to store mailbox messages during intermediate processing. The mailbox
messages are deleted from the temporary mailbox when processing is
complete.
If you do not specify the /TEMPMAILBOXAlias parameter,
the default value is the value that is specified by the /TEMPMAILBOXAlias option
in the Tivoli Storage FlashCopy Manager configuration
file. The default Tivoli Storage FlashCopy Manager for Exchange
Server configuration
file is tdpexc.cfg. If the /TEMPMAILBOXAlias value
does not exist in the Tivoli Storage FlashCopy Manager for 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.
- /USEEXISTINGRDB=Yes|No
- Use
the /USEEXISTINGRDB parameter to specify whether Data Protection for Microsoft Exchange Server restores
mailboxes from an existing recovery database, or automatically removes
an existing recovery database during mailbox restore operations.
You
can specify the following values:
- Yes
- Use an existing recovery database for mailbox restore operations.
This option is the default.
- No
- Do not use an existing recovery database for mailbox restore operations.
Remove the recovery database during mailbox restore processing.