System Programmer Reference › User Exits › Quiesce (VMBEXIT2) User Exit

Quiesce (VMBEXIT2) User Exit

You can use the quiesce user exit, VMBEXIT2, to send customized minidisk or file space quiesce requests to users or other service virtual machines. You can also use this user exit to send customized messages to resume minidisk or file space activity when CA VM:Backup has finished backing up the minidisk or file space.

Quiescing a minidisk or file space ensures that all read/write activity on that minidisk or file space is suspended before CA VM:Backup attempts to back it up. You indicate that CA VM:Backup should quiesce a minidisk or file space in the exception file associated with a backup job template file.

CA VM:Backup automatically checks whether VMBEXIT2 EXEC exists. If it does, CA VM:Backup directs all quiesce requests, including those from jobs submitted by authorized clients, such as CA VM:Archiver, to the user exit. If it does not, CA VM:Backup issues a CP SMSG userid QUIESCE command to request quiescing for each minidisk or file space targeted for quiescing in the exception file. VMBEXIT2 must ignore requests to quiesce CA VM:Archiver DASD area minidisks; it must return those requests to CA VM:Backup, which quiesces those minidisks using the CP SMSG QUIESCE command.

Only one quiesce user exit can exist. Because all backup jobs specifying that a minidisk or file space be quiesced call this user exit, make sure that VMBEXIT2 is coded to include cases for all minidisks or file spaces that may need to be quiesced.

CA VM:Backup passes a single argument string as follows:

{QUIESCE | RESUME} {userid vaddr | filepoolid:userid}

Definitions

QUIESCE | RESUME

Indicates whether to quiesce or resume the minidisk or file space.

userid vaddr

Specifies the owner and virtual address of the minidisk being quiesced or resumed.

filepoolid:userid

Specifies the file pool and owning user ID of the file space being quiesced or resumed.

Return Codes

The user exit must pass back a return code in fullword format (a 4-byte hexadecimal value) or in whole number format. From REXX, this can be done with the following:

Fullword format

return d2c(rcode,4)

Whole number format

return code

Return codes have the following meanings: