Set positional parameters

Edit online

Positional parameters immediately follow the set command and precede the optional parameters.

The following positional parameters specify the values in the IBM Storage Protect Snapshot for Exchange Server configuration file. You can set only one value for each tdpexcc set command run:
BACKUPDESTination=TSM|LOCAL|BOTH
Use the BACKUPDESTination positional parameter to specify the storage location for your backup. You can specify:
TSM
The backup is stored on IBM Storage Protect server storage only. This option is the default.
LOCAL
The backup is stored on local shadow volumes only.
BOTH
The backup is stored on both IBM Storage Protect server storage and local shadow volumes.
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 the capacity metrics report is to be created. If you do not specify a location, the report is not generated.
CLIENTACcessserver=servername
The servername variable refers to the name of the server you use to access the client.
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
(Default) MM/DD/YYYY
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 for Exchange Server log file (tdpexc.log by default). You can avoid losing existing log file data by doing one of the following choices:
  • After you change the value of the DATEformat parameter, make a copy of the existing log file before you run IBM Storage Protect Snapshot for Exchange Server.
  • 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.
Tip: For instant restore processing on IBM and non-IBM 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.
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 run.
LOGFile=logfilename
Use the LOGFile positional parameter to specify the name of the activity log file that is generated by IBM Storage Protect Snapshot for Exchange Server. The IBM Storage Protect Snapshot for Exchange Server 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 for Exchange Server 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. In the configuration file, the default value for the LOGPrune is that specified by the logprune configurable option. The default value is 60, which means 60 days of log entries are saved. The option No can be specified to disable log pruning.

Regardless of the option that is set in the configuration file 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 the LOGPrune parameter, that 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.
/MOUNTRW=Yes|No

You can mount a read/write copy of your IBM Storage Protect backup so that you can modify the copy without invalidating the backup. You use this option to indicate whether a snapshot backup is mounted as read/write. The default value is as specified in the configuration file with the /MOUNTRW parameter. If a default value is not specified in the configuration file, the default value is No. By specifying the /MOUNTRW option, you override the default value.

The following values are available:
No
Perform a read-only mount operation.
Yes
Perform a read/write mount operation. The behavior of the read/write mount is controlled by the USESNAPOFASNAPTOMount parameter in the configuration file.
  • If USESNAPOFASNAPTOMount is set to No, you can mount only COPY backups as read/write. After mounting, the original backup is modified and can no longer be used as a restore point in future database restore operations (on the VSS Options properties page, the Mount read/write (modifies backup, applies to COPY backups only) check box is selected).
  • If USESNAPOFASNAPTOMount is set to Yes, you can mount both FULL and COPY backup types as read/write (on the VSS Options properties page, the Mount read/write (without modifying backup) check box is selected). In this instance, the backups are not modified and can be used in future restore operations.
    Important:
    This mount option is only available for the following devices:
    • SAN Volume Controller (SVC) devices, which require IBM® System Storage® Support for Microsoft Virtual Disk and Volume Shadow Copy Services version 4.12 or later. Dynamic target allocation is not supported.

    • XIV system devices, which require IBM Storage Accelerate Family Provider for Microsoft Windows Volume Shadow Copy Service version 2.9 or later.

    You must allocate more target volumes on your storage device to accommodate the number of concurrent read/write mounts you want to do. An extra target volume that matches the size of the volume to be mounted, is needed for each concurrent read/write mount of that volume.
MOUNTWait=Yes|No
Use the MOUNTWait positional parameter to specify whether IBM Storage Protect Snapshot for Exchange Server waits for removable media to mount (such as tapes or DVDs) or to stop the current operation. This situation occurs when the IBM Storage Protect server is configured to store backup data on removable media and waits for a required storage volume to be mounted.

Specify Yes for IBM Storage Protect Snapshot for Exchange Server to wait until all initial volumes of any required removable media are made available to the IBM Storage Protect server before you complete the command.

Specify No for IBM Storage Protect Snapshot for Exchange Server to end the command (if removable media are required). An error message is displayed.

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
(Default) n,nnn.dd
2
n,nnn,dd
3
n nnn,dd
4
n nnn.dd
5
n.nnn,dd
6
n'nnn,dd
STOREMAILBOXInfo=Yes|No
The STOREMAILBOXInfo parameter is used to track mailbox history for moved and deleted mailboxes. By default, this parameter is set to Yes. If you do not plan to use mailbox restore, you can set this option to No. When the option is set to No, IBM Storage Protect Snapshot for Exchange Server does not back up the mailbox history.

In large or geographically dispersed domains, more time is required to complete the backup mailbox history task. In this scenario, you can reduce the amount of time that is required to complete the backup mailbox history task by setting the option for STOREMAILBOXInfo to No. When you set the option for STOREMAILBOXInfo to No, mailboxes that are not moved or are not deleted can be restored normally. Moved and deleted mailbox restores can use the MAILBOXORIGLOCATION parameter (of the restoremailbox command) to specify the mailbox location at the time of the backup.

TEMPDBRESTorepath=pathname
For mailbox restore operations, use the TEMPDBRESTorepath positional parameter to specify the default temporary path to use when you restore mailbox database files.

If you do not enter a path, the default value is the value of the TEMP environment variable.

If the path name includes spaces, you must enclose the entire TEMPDBRESTorepath positional parameter entry in double quotation marks. For example: 
TDPEXCC SET TEMPDBRESTorepath="h:\Exchange Restore Directory"

Do not specify a value of TEMPDBRESTorepath that is the same value as the location of the active database. If the value is the same, the database might become corrupted. Choose a temporary database-restore location that has enough space to hold the entire restore.

For better performance, the current active-transaction logger must be on a different physical device from the paths that are specified by the values of the TEMPDBRESTorepath parameter setting and the TEMPDBRESTorepath parameter setting. The paths that are specified by the values of the TEMPDBRESTorepath parameter setting and the TEMPDBRESTorepath parameter setting can be on the same or separate physical devices from each other.

Do not specify double-byte characters (DBCS) within the temporary database-restore path.

TIMEformat=formatnumber
Use the TIMEformat positional parameter to specify the format in which you want system time that is displayed.
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
(Default) HH:MM:SS
2
HH,MM,SS
3
HH.MM.SS
4
HH:MM:SSA/P
USESNAPOFASNAPTOMount=Yes|No

During mount operations, you can specify that you want to do a read/write mount by setting /MOUNTRW=Yes. When you set the /MOUNTRW=Yes, the USESNAPOFASNAPTOMount parameter applies and you can further specify whether you want to mount an existing backup or to create a snapshot of an existing backup. You can only set the USESNAPOFASNAPTOMount parameter in your configuration file.

  • If USESNAPOFASNAPTOMount is set to No, the Mount read/write (modifies backup, applies to COPY backups only) check box is selected on the VSS Options properties page. After mounting, the original COPY backup can be modified and so can no longer be used as a restore point for future database restore operations.
  • If USESNAPOFASNAPTOMount is set to Yes, the Mount read/write (without modifying backup) check box is selected on the VSS Options properties page. This option is only available for SAN Volume Controller (SVC) devices.
Important: You can set USESNAPOFASNAPTOMount=Yes only for SAN Volume Controller (SVC) devices with IBM System Storage Support for Microsoft Virtual Disk and Volume Shadow Copy Services version 4.12 or later. Also, you must allocate more target volumes on your SVC storage device to accommodate the number of concurrent read/write mounts you want to do. An extra target volume matching the size of the volume to be mounted is needed for each concurrent read/write mount of that volume.