Backup optional parameters

Edit online

Optional parameters follow the backup command and positional parameters.

/BACKUPDESTination=LOCAL|TSM|BOTH
When you are backing up data to a local system, set BACKUPDESTination to LOCAL. When you are backing up data to an IBM Storage Protect server, set BACKUPDESTination to TSM. To back up data to a local system and an IBM Storage Protect server, set the parameter to BOTH.
/CONFIGfile=configfilename
Use the /CONFIGfile parameter to specify the name (configfilename) of the IBM Storage Protect Snapshot for Exchange Server 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 IBM Storage Protect Snapshot 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 IBM Storage Protect 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 IBM Storage Protect Snapshot for Exchange Server from making too many backups of the same database.
/EXCLUDEDAGACTive
Use the /EXCLUDEDAGACTive parameter to exclude the Exchange Server databases from backup if they belong to a Database Availability Group and are an active database copy.
/EXCLUDEDAGPASsive
Use the /EXCLUDEDAGPASsive parameter to exclude the Exchange Server databases from backup if they belong to a Database Availability Group and are a passive database copy.
/EXCLUDEDB=db-name1,db-nameN,...
Use the /EXCLUDEDB parameter to exclude the specified Exchange Server databases from the backup operation. If the database names are separated by commas, ensure that there are no spaces between the commas and the database names. If any database name contains blanks, enclose the database name in quotation marks. You cannot specify the asterisk (*) wildcard character.
/EXCLUDENONDAGDbs
Use the /EXCLUDENONDAGDbs parameter to exclude the Exchange Server databases from backup if they do not belong to a Database Availability Group.
/LOGFile=logfilename
Use the /LOGFile parameter to specify the name of the activity log file that is generated by IBM Storage Protect Snapshot 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 IBM Storage Protect Snapshot for Exchange Server 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 IBM Storage Protect Snapshot for Exchange Server to run 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

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.
/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.

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

/MOUNTWait=Yes | No
Use the /mountwait parameter to specify whether waits for removable media to mount (such as tapes or CDs) or to stop the current operation. This situation occurs when the is configured to store backup data on removable media and waits for a required storage volume to be mounted.
You can specify these options:
Yes
IBM Storage Protect Snapshot for Exchange Server waits until all initial volumes of any required removable media are made available to the IBM Storage Protect server before it completes the command. This option is the default.
No
IBM Storage Protect Snapshot for Exchange Server ends the command (if removable media are required). An error message is displayed.
/OFFLOAD
Specify this option if, after the VSS snapshot is complete, you want to offload the transfer of the data from the IBM Storage Protect server to the system specified by the REMOTEDSMAGENTNODE parameter. This option is only valid when the BACKUPDESTination parameter is set to either TSM or BOTH. The default is to not offload data.
/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 valid passive copy is available. If no valid passive copy is available, the backup is created from the active database copy.
/Quiet
This parameter prevents status information from being displayed. This function does not affect the level of information that is written to the activity log.
/SKIPINTEGRITYCHECK
Use the /SKIPINTEGRITYCHECK parameter to specify whether IBM Storage Protect Snapshot for Exchange Server bypasses the integrity checking of databases and log files, or automatically runs the integrity checking of databases and log files.
You can specify the following values:
No
Run integrity checking to verify that all database and log files do not contain integrity issues. This option is the default.
Yes
Bypass integrity checking of all database and log files during backup processing.
SKIPDBCHECKIFHEALTHY
Bypass integrity checking of database files only if at least two healthy copies of a database (one active and one passive copy) exist in a Database Availability Group (DAG).
SKIPDBANDLOGCHECKIFHEALTHY
Bypass integrity checking of all database and log files during backup processing only if at least two healthy copies of a database (one active and one passive copy) exist in a DAG.
Attention: If you do not specify a value with the SKIPINTEGRITYCHECK parameter, integrity checking of database and log files is bypassed. If you bypass integrity checking, the backup that is stored on IBM Storage Protect server might not be valid, or data loss can occur.
/TSMOPTFile=tsmoptfilename
The /TSMOPTFile parameter specifies the IBM Storage Protect Snapshot options file to use. Considerations:
  • The tsmoptfilename variable can include a fully qualified path. If you do not include a path, the IBM Storage Protect Snapshot installation directory is used.
  • If the tsmoptfilename variable contains spaces, enclose the variable in double quotation marks. For example: 
    /TSMOPTFile="c:\Program Files\dsm.opt"
  • If you do not specify /TSMOPTFile, the default value is dsm.opt.
  • If you specify /TSMOPTFile, but not tsmoptfilename, the default is also dsm.opt.
/UpdateMailboxInfoOnly
Specify the /UpdateMailboxInfoOnly parameter to update only the mailbox history information in Microsoft Exchange Server database backups, for example: 
tdpexcc backup DB1 full /UpdateMailboxInfoOnly
where DB1 is the database name, and full is the type of database backup.
Restriction: This parameter does not back up the Exchange Server database.