Query config optional parameters

Edit online

Optional parameters follow the query config command.

/CONFIGfile=filename
Use the /CONFIGfile parameter to specify the name (filename) of the IBM Storage Protect Snapshot configuration file that contains the values to use for a query config operation.

The filename variable can include a fully qualified path. If the filename variable does not include a path, the IBM Storage Protect Snapshot installation directory is used. If the /CONFIGfile parameter is not specified, or if the filename variable is not specified, the default value is fcmcfg.xml.

If the filename variable includes spaces, enclose the entire /CONFIGfile parameter entry in double quotation marks. For example: 
/CONFIGfile="c:\Program Files\fcmcfg.xml"
/FCMOPTFile=filename
Use the filename 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 directory where IBM Storage Protect Snapshot is installed is searched.

If the filename variable includes spaces, enclose the entire /FCMOPTFile parameter entry in double quotation marks. For example: 
/FCMOPTFile="c:\Program Files\file.opt"

The default is dsm.opt.

/LOGFile=filename
Use the /LOGFile parameter to specify the name of the activity log file that is generated by IBM Storage Protect Snapshot. The filename 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 filename variable can include a fully qualified path. However, if no path is specified, the log file is written to the IBM Storage Protect Snapshot installation directory.

If the filename variable includes spaces, enclose the entire /logfile parameter entry in double quotation marks. For example: 
/LOGFile="c:\Program Files\myfcm.log"

If the /LOGFile parameter is not specified, log records are written to the default log file, fcm.log.

The /LOGFile parameter cannot be turned off, logging always occurs.

/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.
/TSMNODe=nodename
Use the nodename 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.

/TSMPassword=password
Use the password 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 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, then 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.