Previous Topic: PREMOVE User ExitNext Topic: SECURITY REPORTS User Exit

Reference Guide › User Exit Reference › SCRATCH User Exit

SCRATCH User Exit

Use the SCRATCH user exit to prevent accidental scratching or moving of vital minidisks by accepting or rejecting a scratch or move request. The SCRATCH user exit also screens requests to remove virtual machines. This user exit is optional but strongly recommended.

SCRATCH userid userid2 vaddr macroname

Definitions

userid

Specifies the user ID that performs the scratch or removal.

userid2

Specifies the user ID being removed or having a minidisk scratched.

vaddr

Specifies the virtual address of the minidisk being scratched. If specified as an asterisk, the exit assumes that userid2 is being removed, assigned a new directory manager, or changed to a new user ID.

macroname

Specifies the name of the optimized CA VM:Director macro calling this user exit.

Return Codes

The following table describes the return codes:

Return Code

Meaning

0

Minidisk or user ID scratch is accepted

4

Minidisk or user ID scratch is accepted, and a message is stacked; the length limit of the message is 67 bytes

8

Minidisk or user ID scratch is rejected, and a message is stacked; the length limit of the message is 67 bytes

Macros

The following macros call the SCRATCH user exit:

Called by

Optimized Macro Name

Under These Circumstances

VMXASN00

ASSIGN

A user ID is assigned to a new directory manager

VMXCHG00

CHANGE

A directory manager attempts to change a user ID

VMXCMD00

CHGMDISK

A minidisk is changed using the CHGMDISK command

VMXCMP00

COMPRESS

A directory manager defragments an extent

VMXDELNT

DELENTRY

A user ID is removed using the DELENTRY command

VMXDMD00

DELMDISK

A minidisk is removed using the DELMDISK command

VMXMAI40

MAI00040

A directory manager removes a user from the directory using the MAINT MANAGE command

VMXMAN30

MAN00030

A directory manager scratches a minidisk using the MANAGE command

VMXMAN40

MAN00040

A directory manager removes a user from the directory using the MANAGE command

VMXMANA0

MAN000A0

A directory manager uses the Redefine a Minidisk in Place function of the MANAGE command

VMXMANB0

MAN000B0

A directory manager moves a minidisk to another location using the MANAGE command

VMXTRN00

TRANSFER

A directory manager transfers ownership of a user ID or a minidisk