Optional parameters

ATTIME
Specifies that XRC delete the specified volume pairs after applying all updates, up to the specified time, to the secondary volumes.

XRC will not apply any updates beyond the specified Universal Time Coordinated (UTC) timestamp to the secondary volumes. All affected secondary volumes are consistent up to the UTC timestamp that is reported on successful completion of the command.

You can issue another XDELPAIR command to change the ATTIME value to either earlier than or later than a previously specified time. The command fails if the specified ATTIME value is earlier than the consistency group time that XRC is currently processing. If you issue multiple commands to a single volume pair, XRC always uses the last valid ATTIME value that you specified with this command.

Note: You cannot issue an XDELPAIR command with the ATTIME parameter to delete a volume that is in the suspended state. You can only delete suspended volumes with an XDELPAIR IMMEDIATE command or an XEND command.

If all volume pairs are deleted or suspended (because of an error or by command) before the time specified on the ATTIME expires, XRC cancels the XDELPAIR command and clears the ATTIME timestamp.

The system data mover (SDM) does not process record updates for the deleted volume that are received in the storage control after the specified time. Record updates in the journal data set that are associated with the deleted volume are discarded and are not available for a subsequent recovery. The storage control continues to record updates to other primary volumes. The SDM then processes these updates.

Specifying the ATTIME parameter with VOLUME(primary_volser) results in the following:
  • If the specified volser is a fixed utility device, the command is rejected, with return code 4082.
  • If the specified volser is not a fixed utility device, it is deleted based on the time specified on the ATTIME parameter.
If more than one volser is specified, and one of the volsers is for a fixed utility device, the command is rejected. If the list of volsers does not include a fixed utility device, XRC will delete each volume in the list based on the time specified on the ATTIME parameter. (The list of volsers can be across multiple storage controls sessions.)
CANCEL
Specifies that XRC cancel the previous XDELPAIR command with an ATTIME or DRAIN request. The CANCEL option is only valid when there is a pending XDELPAIR command.
DRAIN
Specifies that XRC:
  1. Reads the record updates from the cache on all storage controls and obtains the timestamp of the last update for each storage control session.
  2. Determines the most recent timestamp.
  3. Processes the XDELPAIR command when all records, up to and including the most recent timestamp, have been applied to the secondary volumes that are being deleted from the session.
Note: You cannot issue an XDELPAIR command with the DRAIN parameter to delete a volume that is in the suspended state. You can only delete suspended volumes with an XDELPAIR IMMEDIATE command or an XEND command.

If all volume pairs are deleted or suspended (because of an error or by command) before XRC can drain all updates from the primary storage control, XRC cancels the XDELPAIR(DRAIN) command.

Specifying the DRAIN parameter with VOLUME(primary_volser) results in the following:
  • If the specified volser is a fixed utility device, the command is rejected, with return code 4082.
  • If the specified volser is not a fixed utility device, it is deleted after all updates from the storage control cache have been applied to the secondary volumes.
If more than one volser is specified, and one of the volsers is for a fixed utility device, the command is rejected. If the list of volsers does not include a fixed utility device, XRC will delete each volume in the list after all updates from the storage control cache have been applied to the secondary volumes. (The list of volsers can be across multiple storage controls sessions.)
IMMEDIATE
Specifies that XRC immediately process the delete request. IMMEDIATE is the default.

XRC deletes the volume pairs when the current consistency group has been applied. The storage control continues to record updates to other primary volumes, and the SDM processes these updates. The secondary volumes are consistent up to the UTC timestamp that is reported on the successful completion of the command.

Specifying the IMMEDIATE parameter with VOLUME(primary_volser) results in the following:
  • If the specified volser is not a fixed utility device, it is deleted.
  • If the specified volser is the only device in the storage control session and it is a fixed utility device, the volume is deleted. Otherwise, the command is rejected, with return code 4082.
If more than one volser is specified, and one of the volsers is for a fixed utility device and it is not the only device in the storage control session, the command is rejected. If the list of volsers does not include a fixed utility device, XRC will delete each volume in the list. (The list of volsers can be across multiple storage controls sessions.)
NOVERIFY
Specifies that XRC not issue message ANTT0025A, which prompts the user to confirm that XRC should continue to process the command. If you select this option, XRC immediately processes the command without waiting for verification.
MSGROUTEID
Specifies the user ID to which XRC messages associated with the processing of this command are routed. If the specified user ID is not logged on, TSO saves messages in the TSO BRODCAST data set and displays them after the next logon.
Note: Messages issued by the initial command parser routine are sent to the user ID that issues the TSO command.