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 SQL Server preferences file (tdpsql.cfg). If no value is present, the backup is deleted from Tivoli Storage Manager server storage.
You can specify:
TSM The backup is deleted from Tivoli Storage Manager server storage.
This option is the default if no value is specified in the Data Protection for SQL Server preferences file (tdpsql.cfg).
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 SQL 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 SQL Server installation directory is used. If the /configfile parameter is not specified, or if the configfilename variable is not specified, the default value is tdpsql.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"
/FROMSQLSERVer=server-name
Use the /fromsqlserver parameter to specify the name of the SQL Server where the original backup is completed. This parameter is necessary only when the name of the SQL Server to delete from, as determined by the /sqlserverparameter, is different from the name of the SQL Server that the backup objects were created from. The default value is the /sqlserver value or the value set in the Data Protection for SQL Server configuration file.
v If the two SQL Server names are different, you must use this parameter even if /fromsqlserver was a non-clustered default instance.
/LOGFile=logfilename
Use the /logfile parameter to specify the name of the activity log file that is generated by Data Protection for SQL Server.
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 SQL 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\mytdpsql.log"
If the /logfile parameter is not specified, log records are written to the default log file, tdpsql.log.
The /logfile parameter cannot be turned off, logging always occurs.
When you are using multiple simultaneous instances of Data Protection for SQL Serverto complete operations, use the /logfile parameter to specify a different log file for each instance used. Logging for each instance is directed to a different log file, which 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, a certain number of days of data are saved. By default, 60 days of log entries are saved. The option Nocan 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:
v 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.
v If you specify no, the log file is not pruned.
v If you do not specify /LOGPrune, the default value is that specified by the logpruneconfigurable option in the configuration file. The default value is 60.
v 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.
v You can specify /LOGPrune without specifying numdays or no; in this case, the default value, 60, is used.
v 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.
/OBJect=objectname,...
Use the /object parameter to specify the names of backup objects that you want to delete. The object name uniquely identifies each backup object and is created by Data Protection for SQL Server.
Use the Data Protection for SQL Server query tsm * /all command to view the names of all available backup objects. This parameter specifies that only particular backup objects for the specified SQL Server databases and backup object type are deleted. The objectname variable specifies the names of the backup objects that you want to delete. The object name uniquely identifies each backup object and is created by Data Protection for SQL Server.
/Quiet This parameter prevents status information from being displayed. This parameter does not affect the level of information that is written to the activity log.
/TSMNODe=tsmnodename
Use the tsmnodename variable to refer to the Tivoli Storage Manager node name that Data Protection for SQL Server 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 SQL Server options file.
The file name can include a fully qualified path name. If no path is
specified, the directory where Data Protection for SQL 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 Tivoli Storage Manager password that Data Protection for SQL Server uses to log on to the Tivoli Storage Manager server.
If you specified PASSWORDACCESS GENERATE in the Data Protection for SQL 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 Tivoli Storage Manager password the first time that Data Protection for SQL Server 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 is not yet 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 SQL Server uses to log on to the Tivoli Storage Manager server can be up to 63
Related reference:
“Set positional parameters” on page 263