Delete Backup optional parameters

Edit online

Optional parameters follow the delete backup command and positional parameters.

/CONFIGfile=configfilename
Use the /configfile parameter to specify the name (configfilename) of the IBM Storage Protect Snapshot 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 IBM Storage Protect Snapshot 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"

See Set positional parameters for descriptions of available configuration parameters.

/FROMSQLSERVer=server-name
Use the /fromsqlserver parameter to specify the name of the SQL Server where the original backup was done. This parameter is necessary only when the name of the SQL Server to delete from, as determined by the /sqlserver parameter, 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 that is set in the IBM Storage Protect Snapshot configuration file.
Considerations:
  • 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 IBM Storage Protect Snapshot for SQL 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 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 use multiple simultaneous instances of IBM Storage Protect Snapshot for SQL Serverto 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, a certain number of 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.
/OBJect=objectname,...
Use the /object parameter to specify the names of backup objects you want to delete. The object name uniquely identifies each backup object and is created by IBM Storage Protect Snapshot for SQL Server.

Use the IBM Storage Protect Snapshot for SQL Server query fcm * /all command to view the names of all available backup objects. This parameter specifies that only particular backup objects for the specified SQL databases and backup object type is to be deleted. The objectname variable specifies the names of the backup objects you want to delete. The object name uniquely identifies each backup object and is created by IBM Storage Protect Snapshot for SQL Server.

/QUERYNode=DP | ALWAYSON
Specify whether you want to query standard databases from SQL Server 2012 that were backed up from a standard Data Protection for SQL node or the AlwaysOn node. This parameter is ignored for availability databases because the availability databases are always backed up under the AlwaysOn node.
/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.