Update config positional parameters
Positional parameters immediately follow the update config command and precede the optional parameters.
The following positional parameters specify the values in the IBM Storage
Protect Snapshot configuration file. You can set only one value for each update config command run:
- CAPACITYINFOINTerval=numdays
- Use
the CAPACITYINFOINTerval positional parameter to specify how often you want the capacity metrics
report to be generated.
The report, in an XML file format, is generated automatically at the end of a backup operation. The valid value range is 1 - 365 and the default value is 7 days, which means the report is generated once every 7 days.
- CAPACITYINFOLOCation=pathname
- Use the CAPACITYINFOLOCation positional parameter to specify the location where you want the capacity metrics report to be created. If you do not specify a location, the report is not generated.
- DATEformat=dateformatnum
- Use the DATEformat
positional parameter to select the format you want to use to display dates.
The dateformatnum variable displays the date in one of the following formats. Select the format number that corresponds to the format you want to use.
- 1
- MM/DD/YYYY. This format is the default.
- 2
- DD-MM-YYYY
- 3
- YYYY-MM-DD
- 4
- DD.MM.YYYY
- 5
- YYYY.MM.DD
- 6
- YYYY/MM/DD
- 7
- DD/MM/YYYY
Changes to the value of the dateformat parameter can result in an undesired pruning of the IBM Storage Protect Snapshot log file (fcm.log by default). You can avoid losing existing log file data by doing one of the following actions:- After you change the value of the dateformat parameter, make a copy of the existing log file before you run IBM Storage Protect Snapshot.
- Specify a new log file with the /logfile parameter.
- IMPORTVSSSNAPSHOTSONLYWhenneeded
- Use the
/IMPORTVSSSNAPSHOTSONLYWhenneeded parameter to specify whether IBM Storage Protect Snapshot
automatically imports VSS snapshots to the Windows system where the snapshots are created. Specify one of the following values:
- Yes
- Import VSS snapshots to the Windows system where the snapshots
are created. The option is the default. During backup processing, transportable snapshots are
automatically created and imported to storage systems when the snapshots are required. This option
is the default. Restriction: For instant restore processing on third-party storage systems, you must specify the Yes option to enable the storage system to create transportable snapshots during backups.
- No
- Do not create transportable VSS snapshots during backup processing, and do not automatically import the snapshot to storage systems after the backup is completed.
- LANGuage=language
- Specify the three-character code of the language you want to use to display messages:
- CHS
- Simplified Chinese
- CHT
- Traditional Chinese
- DEU
- Standard German
- ENU
- American English (This option is the default.)
- ESP
- Standard Spanish
- FRA
- Standard French
- ITA
- Standard Italian
- JPN
- Japanese
- KOR
- Korean
- PTB
- Brazilian Portuguese
- LOCALDSMAgentnode=nodename
- Specify the node name of the local system that runs the VSS backups. This positional parameter must be specified for VSS operations to be completed.
- LOGFile=logfilename
- Use the LOGFile positional parameter to specify the name of the activity log
file that is generated by IBM Storage Protect Snapshot. The IBM Storage Protect Snapshot activity
log records significant events, such as completed commands and error messages.
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 assigned to the IBM Storage Protect Snapshot installation directory. - /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, some 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.
- NUMberformat=fmtnum
- Use the NUMberformat positional parameter to
specify the format you want to use to display numbers. The fmtnum variable displays numbers by using one of the following formats. Select the format number that corresponds to the format you want to use.
- 1
- n,nnn.dd. This format is the default.
- 2
- n,nnn,dd.
- 3
- n nnn,dd
- 4
- n nnn.dd
- 5
- n.nnn,dd
- 6
- n'nnn,dd
- REMOTEDSMAgentnode=remote_node
- Specifies the remote client node that runs the VSS offloaded backups on a remote computer.
- TIMEformat=formatnumber
- Use the TIMEformat positional parameter to specify the format in which you
want to display the system time. The formatnumber variable displays time in one of the following formats. Select the format number that corresponds to the format you want to use.
- 1
- HH:MM:SS This is the default.
- 2
- HH,MM,SS
- 3
- HH.MM.SS
- 4
- HH:MM:SSA/P