Query TSM optional parameters

Optional parameters follow the query TSM command and positional parameters.

/ACtive

Use the /ACtive parameter to display active backup objects only. This setting is the default setting.

/ALl

Use the /ALl parameter to display both active and inactive backup objects. If the /ALl parameter is not specified, only active backup objects are displayed.

/CONFIGfile=filename

Use the /CONFIGfile parameter to specify the name of the Data Protection for Exchange Server configuration file that contains the values for the Data Protection for Exchange Server configuration options.

The filename variable can include a fully qualified path. If the filename 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 filename variable is not specified, the default value is tdpexc.cfg.

If the filename variable includes spaces, enclose the entire /CONFIGfileparameter 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 and restore the databases in an Exchange Server Database Availability Group (DAG). With this setting, backups from all DAG members that are configured to use the DAG node are backed up to a common file space on the Tivoli® Storage Manager server. The database copies are managed as a single entity, regardless of which DAG member they were backed up from. This setting can prevent Data Protection for Exchange Server from making too many backups of the same database.

/DEtail

Use the /DEtail parameter to display comprehensive information about the status of the Tivoli Storage Manager server, including the following details:

Backup compressed

Table 1. Backup compressed values
Value	Status
Yes	One or more objects are compressed.
No	No objects are compressed.
Unknown	It is not known whether the backup is compressed, which includes backups before Data Protection for Exchange Server version 6.3.

Backup encryption type

Table 2. Backup encryption type values
Value	Status
None	None of the objects are encrypted.
AES-256	The objects are encrypted with AES-256 encryption. The most secure data encryption method is AES256.
AES-128	The objects are encrypted with AES-128 encryption.
DES-56	The objects are encrypted with DES-56 encryption.
Unknown	It is not known whether the objects in the database are encrypted, which includes backups before Data Protection for Exchange Server version 6.3.

Backup client-deduplicated

Table 3. Backup client-deduplicated values
Value	Status
Yes	One or more objects are client-side deduplicated.
No	No objects are client-side deduplicated.
Unknown	It is not known whether the backup is client-side deduplicated, which includes backups before Data Protection for Exchange Server version 6.3.

Backup supports instant restore

Table 4. Backup supports instant restore values
Value	Status
Yes	One or more objects support instant restore.
No	No objects support instant restore.
Unknown	The backup might not support instant restore. This setting applies to backups before Data Protection for Exchange Server version 6.3.

/FROMEXCSERVer=servername

Use the /fromexcserver parameter to specify the name of the Exchange Server where the original backup is completed.

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

If a DAG node is specified by using the dagnode parameter, Data Protection for Exchange Server uses this node name instead of the Data Protection for Exchange Server node to back up databases in an Exchange Server Database Availability Group. Therefore, the query tsm command automatically displays the backups that were 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 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 you use multiple simultaneous instances of Data Protection for Exchange Server to complete 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.

/REMOTECOMPUTER=computername

Enter the IP address or host name for the remote system where you want to query the data backups.

/REMOTECOMPUTERUser=user

Enter the user name that is used to log on to the server specified with the REMOTECOMPUTER parameter. If a domain is required to log on with the domain account, enter Domain\User. To log on to the local account, the domain is not required. There is no default value.

/REMOTECOMPUTERPassword=passwd

Enter the password for the user name that is specified with the REMOTECOMPUTERUser parameter. There is no default value.

/SHOWMAILBOXInfo

Use the /SHOWMAILBOXInfo parameter to display mailbox history information in backup databases.

/TSMNODe=nodename

Use the tsmnodename variable to refer to the Tivoli Storage Manager node name that Data Protection for Exchange 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=optfilename

Use the optfilename 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 optfilename 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=password

Use the password variable to refer to the Tivoli Storage Manager password that Data Protection for Exchange Server uses to log on to the Tivoli Storage Manager server.

If you specified PASSWORDACCESS GENERATE in the Data Protection for Exchange Server options file (dsm.opt), supplying the password here is not necessary 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 Exchange 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 interface, you are prompted for a password.

The Tivoli Storage Manager password that Data Protection for Exchange Server uses to log on to the Tivoli Storage Manager server can be up to 63 characters in length.