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
The /configfile parameter specifies the name of the IBM Storage Protect Snapshot for Microsoft SQL Server configuration file, which contains the values for the IBM Storage Protect Snapshot configurable options. See Set command for details on the content of the file.
Considerations:
  • The configfilename variable can include a fully qualified path. If configfilename does not include a path, it uses the directory where IBM Storage Protect Snapshot for Microsoft SQL Server is installed.
  • If configfilename includes spaces, enclose it in double quotation marks.
  • If you do not specify /configfile, the default value is tdpsql.cfg.
  • If you specify /configfile but not configfilename, the default value tdpsql.cfg is used.
/FCMOPTFile=dsmoptfilename
The /fcmoptfile parameter specifies the IBM Storage Protect Snapshot options file to use.
Considerations:
  • 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.
/FROMSQLSERVer=sqlservername
For query FCM, the /fromsqlserver parameter specifies the SQL Server that backup objects were backed up from. This parameter is necessary only when the name of the SQL Server to query, 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 for Microsoft SQL Server 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.
  • After you restore a SQL database to a different SQL Server, the logins of the SQL database might not match the logins for the different SQL Server. If appropriate, you can use the SQL stored procedure SP_CHANGE_USERS_LOGIN to find and correct such SQL login mismatches.
/LOGFile=logfilename
Use the /logfile parameter to specify the name of the activity log file that is generated by IBM Storage Protect Snapshot for Microsoft 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 Microsoft 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"

You cannot turn IBM Storage Protect Snapshot for Microsoft SQL Server logging activity off. If you do not specify /logfile, log records are written to the default log file. The default log file is tdpsql.log.

Attention: When you use multiple simultaneous instances of IBM Storage Protect Snapshot for Microsoft SQL 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.
/OBJect=* | objectname,...
For restore and inactivate operations, /object specifies that only particular backup objects for the specified SQL databases and backup object type (if specified) be restored or deactivated. For query operations, /object includes particular objects and object types in the display. The objectname variable specifies the names of the backup objects you want to restore or deactivate. The object name uniquely identifies each backup object and is created by IBM Storage Protect Snapshot. Use query to view the names of backup objects. You can specify the asterisk (*) wildcard character in objectname to replace zero or more characters for each occurrence. Specifying only the wildcard character indicates all backup objects of the specified SQL databases and backup object type.
/QUERYNode=DP | ALWAYSON | BOTH
Specify whether you want to query standard databases from SQL Server 2012 and later versions that are backed up from a standard IBM Storage Protect Snapshot for Microsoft SQL Server node, the AlwaysOn node, or both nodes. This parameter is ignored for availability databases because the availability databases are always backed up under the AlwaysOn node.
/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.