Previous Topic: Devices and TapesNext Topic: Summary of CA VM:Backup User Exits


User Exits

CA VM:Backup supports five user exits. A template for each, written in REXX, is included in the SERVLINK file and is deployed to the sample code minidisk during installation.

All user exits must be coded in REXX, respecting the parameter and calling conventions of the REXX interface. They can, however, call ASSEMBLER modules. For complete information about formatting calls to and from a REXX program, see the IBM z/VM REXX/VM Reference.

Unlike other CA Mainframe VM Product Manager products, CA VM:Backup does not use a USEREXIT record to identify user exits. Simply place the user exits on the VMBACKUP 191 minidisk, where they will always be available to CA VM:Backup. User exits must have the filename VMBEXIT1, VMBEXIT2, VMBEXIT3, VMBEXIT4, or VMBEXIT5; the filetype must be EXEC.

Note: The exits do not operate asynchronously and cannot be defined as user area programs. This means that CA VM:Backup stops all other work while in a user exit. User exits cannot be located at storage address X'20000'.

Always be sure to carefully test a user exit before putting it into production on your system. Because user exits can be called repeatedly, you might want to EXECLOAD them once at initialization to improve performance. For each user exit you want to EXECLOAD, enter an EXECLOAD command that specifies the user exit's file name in the CA VM:Backup PROFILE EXEC, as follows:

EXECLOAD filename EXEC

The user exits can use IUCV to transfer communications between users and service virtual machines. The CMS IUCV facility is the recommended means of communication because it does not interfere with CA VM:Backup communications. The user exits can also issue CP SMSG messages, but they cannot receive them.

This section contains the following topics:

Summary of CA VM:Backup User Exits

Tape Mount (VMBEXIT1)

Quiesce (VMBEXIT2) User Exit

Restore Authorization (VMBEXIT3) User Exit

Restore Link (VMBEXIT4) User Exit

Tape Allocation (VMBEXIT5) User Exit