Delete backup optional parameters

Edit online

Optional parameters follow the delete backup command and positional parameters.

/BACKUPDESTination=LOCAL|TSM
Use this parameter to specify the destination of the backups to be deleted. The default is TSM
/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 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 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 processed.

The default is the local Exchange Server.

If a DAG node is specified by using the dagnode parameter, IBM Storage Protect Snapshot for Microsoft Exchange Server uses this node name instead of the IBM Storage Protect Snapshot for Microsoft Exchange Server node to back up databases in an Exchange Server Database Availability Group. Therefore, the delete command automatically deletes the backups that are created by the other DAG members, without having to specify the /fromexcserver parameter.

/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 process 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 name of the backup object you want to delete. The object name uniquely identifies each backup object and is created by IBM Storage Protect Snapshot for Exchange Server.

Use the IBM Storage Protect Snapshot for Exchange Server query fcm * /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 backup command. If it is not specified, the delete backup command fails.

/OLDerthan=days
Use the /olderthan parameter to specify how old backup files can be to be deleted. The days variable can range from 0 - 9999. There is no default value for the /olderthan parameter.
/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.
/TSMNODe=tsmnodename
Use the tsmnodename variable to refer to the IBM Storage Protect node name that IBM Storage Protect Snapshot 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 IBM Storage Protect options file.

The file name can include a fully qualified path name. If no path is specified, the IBM Storage Protect Snapshot installation directory is used.

If the tsmoptfilename variable includes spaces, enclose it in double quotation marks. For example: 
/TSMOPTFile="c:\Program Files\file.opt"

The default is dsm.opt if you do not specify the /tsmoptfile parameter or if you specify /tsmoptfile but not tsmoptfilename.

TSMPassword
Use the tsmpassword variable to refer to the IBM Storage Protect password that IBM Storage Protect Snapshot uses to log on to the IBM Storage Protect server.

If you specified PASSWORDACCESS GENERATE in the IBM Storage Protect Snapshot options file (dsm.opt), supplying the password is not necessary 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 that IBM Storage Protect Snapshot 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 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, you are prompted for a password.

The IBM Storage Protect password that IBM Storage Protect Snapshot uses to log on to the IBM Storage Protect server can be up to 63 characters in length.