System Programmer Reference › User Exits › Restore Authorization (VMBEXIT3) User Exit › TODISK and TODIR Authorization

TODISK and TODIR Authorization

CA VM:Backup calls the user exit with the TODISK or TODIR keyword only if at least one FORDISK or FORDIR authorization was previously granted.

The user exit is called with the TODISK keyword if the requesting user specifies that data be restored to a minidisk. CA VM:Backup passes the target user ID and virtual address of the target minidisk along with the source user ID and a list of all source domains.

The user exit is called with the TODIR keyword if the requesting user specifies that data be restored to a directory.

• For a target SFS directory, CA VM:Backup passes the target user ID and the fully-qualified directory name along with the source user ID and a list of all source domains.
• For a target BFS directory, CA VM:Backup passes the target user ID and full directory pathname along with the source user ID and a list of all source domains.

Source domains are the minidisks and directories from which the requesting user has selected to restore data. The list of source domains that is passed to the user exit will contain one of the following:

• Virtual addresses of minidisks and/or the fully-qualified directory names or SFS directories
• Fully-qualified directory pathnames of BFS directories

  A pathname is considered fully qualified when /../VMBFS:filepoolid:filespaceid is specified at the start of the pathname.

CA VM:Backup calls VMBEXIT3 TODISK and TODIR with the following arguments:

TODISK requester tuserid tvaddr , suserid sdomains...

TODIR requester tuserid tdir , suserid sdomains...

Note: The FORUSER, FORDIR, TODISK, and TODIR argument lists are passed as multiple argument strings; in the calling argument above, the strings are shown separated by a comma. The second string of the FORDIR, TODISK, and TODIR argument lists contains a variable number of items. For details on parsing multiple argument strings, see the IBM z/VM REXX/VM Reference.

The number of strings passed with the FORUSER or FORDIR argument lists depends on whether the user is restoring CMS/SFS data or BFS data. If the user is restoring BFS data, an additional string that contains BFS-specific information is passed.

requester

Identifies the user ID initiating the restore request.

tuserid

Specifies one of the following to identify the target user ID:

• User ID owning the target minidisk or SFS directory
• Filespace ID portion of the target BFS fully-qualified directory pathname; a fully-qualified directory pathname of a BFS directory starts with:

  /../VMBFS:filepool:filespaceid
  

  For a BFS directory, the target user ID (tuserid) is filespaceid.

tvaddr

Identifies the virtual address of the minidisk owned by the target user (tuserid) to which the requesting user is attempting to restore data.

tdir

Identifies the fully-qualified directory name of an SFS directory or fully-qualified directory pathname of a BFS directory owned by the target user (tuserid) to which the requesting user is attempting to restore data.

Note: A pathname is considered fully qualified when /../VMBFS:filepoolid:filespaceid is specified at the start of a pathname. Because the fully-qualified directory pathname can contain blank characters, CA VM:Backup encloses the fully-qualified directory pathname in single quotes. CA VM:Backup doubles any single quotes in the pathname.

suserid

Identifies the user ID of the source user for whom the requesting user wants to restore. When the requesting user wants to restore his own data, requester is the same as suserid. When a novice user initiates a restore request, requester is always the same as suserid.

sdomains...

Specifies one of the following to identify domains from which the requesting user has selected data to restore and that are owned by the source user (suserid):

• Virtual address of one or more minidisks and/or the fully-qualified directory name of one or more SFS directories
• Fully-qualified directory pathname of one or more BFS directories

Note: A pathname is considered fully qualified when /../VMBFS:filepoolid:filespaceid is specified at the start of a pathname. Because the fully-qualified directory pathname can contain blank characters, CA VM:Backup encloses the fully-qualified directory pathname in single quotes. CA VM:Backup doubles any single quotes in the pathname.