Query FCM optional parameters

Edit online

Optional parameters follow the query FCM command and positional parameters.

/ACtive
Use the /ACtive parameter to display active backup objects only. This parameter is the default.
/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=configfilename
Use the /CONFIGfile parameter to specify the name of the IBM Storage Protect Snapshot for Exchange Server configuration file that contains the values for the IBM Storage Protect Snapshot for Exchange Server configuration options.

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"
/DETail
Use the /DETail parameter to display detailed output from the query command.
  • The dsmoptfilename variable can include a fully qualified path. If you do not include a path, the IBM Storage Protect Snapshot installation directory is used.
  • If the dsmoptfilename variable spaces, enclose it in double quotation marks.
  • If you do not specify /FCMOPTFile, the default value is dsm.opt.
  • If you specify /FCMOPTFile, but not dsmoptfilename, the default is also dsm.opt.
/FCMOPTFile=dsmoptfilename
The /FCMOPTFile parameter specifies the IBM Storage Protect Snapshot options file to use.
  • The dsmoptfilename variable can include a fully qualified path. If you do not include a path, the IBM Storage Protect Snapshot installation directory is used.
  • If the dsmoptfilename variable spaces, enclose it in double quotation marks.
  • If you do not specify /FCMOPTFile, the default value is dsm.opt.
  • If you specify /FCMOPTFile, but not dsmoptfilename, the default is also dsm.opt.
/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 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.
/REMOTECOMPUTER=computername
Enter the IP address or host name for the remote system where you want to query the data that is backed up.
/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.