Delete Backup optional parameters

Optional parameters follow the delete backup command and positional parameters.

/BACKUPDESTination=TSM|LOCAL

Use the /backupdestination parameter to specify the location from where the backup is to be deleted. The default is the value (if present) specified in the Data Protection for Exchange Server preferences file (tdpexc.cfg). If no value is present, the backup is deleted from IBM Storage Protect™ server storage.

You can specify:

TSM: The backup is deleted from IBM Storage Protect server storage. This option is the default value.
LOCAL: The backup is deleted from the local shadow volumes.

/CONFIGfile=configfilename

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

The configfilename variable can include a fully qualified path. If the configfilename variable does not include a path, the Data Protection 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 Microsoft™ Exchange Server from making too many backups of the same database.

/FROMEXCSERVer=server-name

Use the /fromexcserver parameter to specify the name of the Exchange Server where the original backup was performed.

The default is the local Exchange Server. However, you must specify the name if the Exchange Server is not the default.

/LOGFile=logfilename

Use the /logfile parameter to specify the name of the activity log file that is generated by Data Protection 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 Data Protection 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 using multiple simultaneous instances of Data Protection for Exchange Server to perform operations, use the /logfile parameter to specify a different log file for each instance used. This 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

Use the /logprune parameter to disable log pruning or to explicitly request that the log be pruned for one command run. By default, log pruning is enabled and performed once per day. The numdays variable represents the number of days to save log entries. By default, 60 days of log entries are saved in the pruning process. You can use the Data Protection for Exchange Server GUI or the set command to change the defaults so that log pruning is disabled, or so that more or less days of log entries are saved. If you use the command line, you can use the /logprune parameter to override these defaults. When the value of the /logprune variable numdays is a number in the range 0 - 9999, the log is pruned even if log pruning has already been performed for the day.

Changes to the value of the timeformat or dateformat parameter can result in the log file being pruned unintentionally. If the value of the timeformat or dateformat parameter has changed, prior to issuing a Data Protection for Exchange Server command that might prune the log file, perform one of the following actions to prevent the log file from being pruned:

Make a copy of the existing log file.
Specify a new log file with the /logfile parameter or logfile setting.

/OBJect=objectname

Use the /object parameter to specify the name of the backup object that you want to delete. The object name uniquely identifies each backup object and is created by Data Protection for Exchange Server.

Use the Data Protection for Exchange Server query tsm * /all command to view the names of all available backup objects.

The /object parameter is used to delete only one incremental backup at a time. When multiple active incremental backups exist, the /object parameter must be specified with the delete command. If it is not specified, the delete command fails.

/OLDerthan=days

Use the /olderthan parameter to specify how old backup files can be before they are deleted. The days variable can range from 0 - 9999. There is no default value for/olderthan.

/Quiet

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

/TSMNODe=tsmnodename

Use the tsmnodename variable to refer to the IBM Storage Protect node name that Data Protection for Exchange Server uses to log on to the IBM Storage Protect server.

You can store the node name in the IBM Storage Protect options file (dsm.opt). This parameter overrides the value in the IBM Storage Protect 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 Exchange Server options file.

The file name can include a fully qualified path name. If no path is specified, the directory where Data Protection for Exchange Server 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 IBM Storage Protect password that Data Protection for Exchange Server uses to log on to the IBM Storage Protect server.

If you specified PASSWORDACCESS GENERATE in the Data Protection for Exchange Server 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 IBM Storage Protect password the first time Data Protection for Exchange Server connects to the IBM Storage Protect 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 IBM Storage Protect password that Data Protection for Exchange Server uses to log on to the IBM Storage Protect server can be up to 63 characters in length.