IBM Tivoli Storage Manager for Mail, Data Protection for Microsoft Exchange Server, Version 7.1

Backup optional parameters

Optional parameters follow the backup command and positional parameters.

/BACKUPDESTination=TSM|LOCAL|BOTH

Use the /BACKUPDESTination parameter to specify the location where the backup is stored.

You can specify:

TSM: The backup is stored on Tivoli® Storage Manager server storage only. This option is the default value.
LOCAL: The backup is stored on local shadow volumes only.
BOTH: The backup is stored on Tivoli Storage Manager server storage and local shadow volumes.

/CONFIGfile=configfilename

Use the /CONFIGfile parameter to specify the name (configfilename) of the Data Protection for Microsoft Exchange configuration file that contains the values to use for a backup operation.

The configfilename variable can include a fully qualified path. If the configfilename variable does not include a path, the Data Protection for Microsoft Exchange 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 were backed up from. This setting can prevent Data Protection for Exchange from making too many backups of the same database.

/EXCLUDEDAGACTive

Use the /EXCLUDEDAGACTive parameter to exclude databases from the backup if they belong to a Database Availability Group and are an active database copy.

/EXCLUDEDAGPASsive

Use the /EXCLUDEDAGPASsive parameter to exclude the databases from backup if they belong to a Database Availability Group and are a passive database copy.

/EXCLUDENONDAGDbs

Use the /EXCLUDENONDAGDbs parameter to exclude the databases from backup if they do not belong to a Database Availability Group.

/EXCLUDEDB=db-name,...

Use the /EXCLUDEDB parameter to exclude the specified databases from the backup operation.

/LOGFile=logfilename

Use the /LOGFile parameter to specify the name of the activity log file that is generated by Data Protection for Microsoft Exchange.

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 Data Protection for Microsoft Exchange installation directory.

If the logfilename variable includes spaces, enclose the entire /LOGFile parameter entry in double quotation marks. For example:

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

If the /LOGFile parameter is not specified, 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 Data Protection for Microsoft Exchange to perform operations, use the /LOGFile parameter to specify a different log file for each instance 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

The /LOGPrune parameter prunes the Data Protection for Microsoft Exchange activity log and specifies how many days of entries are saved. By default, log pruning is enabled and done once each day that Data Protection for Microsoft Exchange is run; however, you can use this option to disable log pruning or explicitly request a prune of the log for one command run even if the log file is already pruned for the day. The numdays variable represents the number of days to save log entries. By default, 60 days of log entries are saved in the prune process.

If you specify numdays, it can range from 0 to 9999. A value of 0 deletes all entries in the Data Protection for Microsoft Exchange activity log file except for the current command entries.
If you specify /LOGPrune, its value is used instead of the value that is stored in the Data Protection for Microsoft Exchange configuration file. Specifying this parameter does not change the value in the configuration file.
Changes to the value of the timeformat or dateformat parameter can result in an undesired pruning of the Data Protection for Microsoft Exchange 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, do one of the following to prevent undesired 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.

/MINimumbackupinterval=numberOfMinutes

If you are scheduling the backup of databases in an Exchange Server Database Availability Group, specify the minimum amount of time, in minutes, before a backup of another copy of the same Database Availability Group database can begin. The range is 1 - 9999. If you use the parameter, but do not specify a value, you can back up the database again immediately after a backup operation of that database completes.

Setting this parameter specifies that only one database copy can be backed up within a timeframe. This option prevents all of the members in a Database Availability Group from backing up the database, which would be redundant and invalidate the Tivoli Storage Manager storage management policy.

/MOUNTWait=Yes|No

Use the /MOUNTWait parameter to specify whether Data Protection for Microsoft Exchange is to wait for removable media to mount (such as tapes or CDs) or to stop the current operation. This situation occurs when the Tivoli Storage Manager server is configured to store backup data on removable media and waits for a required storage volume to be mounted.

You can specify:

Yes: Wait for tape mounts. This option is the default.
No: Do not wait for tape mounts.

/OFFLOAD

Specify this parameter to perform the integrity check and backup of files to Tivoli Storage Manager on the system specified by the remotedsmagentnode instead of the local system. This parameter is only valid when /backupdestination=TSM. This parameter requires a VSS provider that supports transportable shadow copies. It is not supported with the default Windows VSS System Provider.

/PREFERDAGPASsive

If you are scheduling the backup of databases in an Exchange Server Database Availability Group, set this parameter to back up a passive database in an Exchange Server Database Availability Group unless no healthy passive copy is available. If no healthy passive copy is available, the backup is made from the active database copy.

/Quiet

This parameter prevents status information from being displayed. The level of information that is written to the activity log is not affected.

/SKIPINTEGRITYCHECK

Specify this parameter to bypass the Exchange integrity check typically performed during a backup. During VSS backup processing, integrated Exchange integrity checking reads every page in the files to be backed up. Backup processing time can be significant. You can specify the/SKIPINTEGRITYCHECK parameter to bypass integrity checking. This parameter is valid for all VSS backups, only skip these checks in accordance with recommendations from Microsoft.

When using this parameter, it is possible that the stored backup is not valid because it is not being verified with the Exchange integrity check utility. Make sure that you have a valid backup stored on Tivoli Storage Manager server storage. If you are using a Database Availability Group (DAG) configuration, and there are at least two viable copies of the database, you can skip the integrity check in order to speed up the backup.

/TSMNODe=tsmnodename

Use the tsmnodename variable to refer to the Tivoli Storage Manager node name that Data Protection for Microsoft Exchange uses to log on to the Tivoli Storage Manager server. You can store the node name in the Tivoli Storage Manager options file (dsm.opt). This parameter overrides the value in the Tivoli Storage Manager options file if PASSWORDACCESS is set to PROMPT. This parameter is not valid when PASSWORDACCESS is set to GENERATE in the options file.

/TSMOPTFile=tsmoptfilename

Use the tsmoptfilename variable to identify the Data Protection for Microsoft Exchange options file.

The file name can include a fully qualified path name. If no path is specified, the directory where Data Protection for Microsoft Exchange is installed is searched.

If the tsmoptfilename variable includes spaces, enclose the entire /TSMOPTFile parameter entry in double quotation marks. For example:

/TSMOPTFile="c:\Program Files\file.opt"

The default is dsm.opt.

/TSMPassword=tsmpassword

Use the tsmpassword variable to refer to the Tivoli Storage Manager password that Data Protection for Microsoft Exchange uses to log on to the Tivoli Storage Manager server. If you specified PASSWORDACCESS GENERATE in the Data Protection for Microsoft Exchange options file (dsm.opt), you do not need to supply the password here because the one that is stored in the registry is used. However, to store the password in the registry, you must specify the Tivoli Storage Manager password the first time Data Protection for Microsoft Exchange connects to the Tivoli Storage Manager server.

If you do specify a password with this parameter when PASSWORDACCESS GENERATE is in effect, the command-line value is ignored unless the password for this node has not yet been stored in the registry. In that case, the specified password is stored in the registry and used when you run this command.

If PASSWORDACCESS PROMPT is in effect, and you do not specify a password value on the command line, then you are prompted for a password.

The Tivoli Storage Manager password that Data Protection for Microsoft Exchange uses to log on to the Tivoli Storage Manager server can be up to 63 characters in length.

Feedback