Specifies the information to be extracted from the request. Some keywords apply only to a specific user exit, as shown below:
|
Keyword |
Use with ALLOCATE user exit |
Use with COMMAND user exit |
|
ACCOUNT |
Y |
|
|
BUFFER |
Y |
Y |
|
COMMAND |
Y |
Y |
|
DEVICE |
Y |
|
|
DRIVE |
Y |
Y |
|
EDL |
Y |
|
|
MOUNT |
Y |
|
|
POOL |
Y |
|
|
USERID |
Y |
Y |
|
VOLSER |
Y |
|
Each keyword is described including a list of the REXX special variables returned. The variables are returned in the form:
Returns the account number of the requesting user.
|
REXX Special Variable |
Description |
|
ACCOUNT.0 |
Number of variables returned |
|
ACCOUNT.1 |
Account number of the requesting user (MOUNT or ALLOCATE request only) |
Returns the contents of the common user exit buffer. Trailing blanks and nulls are suppressed. The buffer defaults to nulls.
|
REXX Special Variable |
Description |
|---|---|
|
BUFFER.0 |
Number of variables returned |
|
BUFFER.1 |
Common user exit buffer contents |
Returns the current command.
|
REXX Special Variable |
Description |
|
COMMAND.0 |
Number of variables returned |
|
COMMAND.1 |
Command string including any changes made to the command by the command user exit |
Returns device information for the real device address (raddr).
|
REXX Special Variable |
Description |
|
|---|---|---|
|
DEVICE.0 |
Number of variables returned |
|
|
DEVICE.1
|
Status [User|*] [volser|*] The variables status, user, and volser are as displayed on the output from the CA VM:Tape QUERY TAPE command. The * indicates there is no user or volser associated with this device. |
|
|
|
||
|
DEVICE.2
|
Type [name|*] The variable type is the device unit type and name corresponds to the name assigned to the device on the DEVICE or MIADEVICE record. The * indicates there is no name associated with this device. |
|
|
|
||
|
DEVICE.3 |
Verify densities |
|
|
DEVICE.4 |
Read densities |
|
|
DEVICE.5 |
Write densities |
|
|
DEVICE.6
|
[LMS|HSC|RMS|MANUAL] location [sublocation|*] [MANUAL] The variable location is the location of the device. The variable sublocation identifies the sublocation name, for example, LSM001. The * indicates that a sublocation is not applicable or the sublocation is not defined. For the HSC product only, MANUAL indicates that this device is operating in manual mode because it is in an offline LSM. |
|
|
|
||
|
DEVICE.7
|
[ACL |*] [READY|NOTREADY] ACL indicates that the device is equipped with an auto-cartridge loader. READY | NOTREADY refers to the device’s readiness to drop the cartridge. The * indicates that the device is not ACL equipped. |
|
|
|
||
|
DEVICE.8
|
[STAM|MIA|*] [EXCLUDED|AVAILABLE] STAM indicates the device is controlled by STAM. MIA indicates the device is controlled by MIA. EXCLUDED | AVAILABLE refers to availability for allocation. The * indicates that there is no drive sharing software in use, the drives are being shared manually, or both. |
|
|
|
Returns the list of all drives handled by CA VM:Tape.
|
REXX Special Variable |
Description |
|
DRIVE.0 |
Number of variables returned |
|
DRIVE.1 |
Real address of the first drive |
|
. |
|
|
DRIVE.n |
Real address of the nth drive |
Returns the eligible drive list for this allocation, including selection status in its current ordering.
You can use the SET EDL primitive to modify the eligible drive list, which allows sites to customize drive allocation.
Note: For more information about the SET primitive, see SET Primitive.
|
REXX Special Variable |
Description |
|
|
EDL.0 |
Number of drives in the list |
|
|
EDL.1
|
raddr [ EXEMPT ] The variable raddr is the real drive address of the first drive and is followed optionally by the keyword EXEMPT if the drive is currently exempt from selection. |
|
|
|
||
|
. |
|
|
|
EDL.n |
Real drive address of the nth drive |
Returns information concerning the current request.
|
REXX Special Variable |
Description |
|
|
MOUNT.0 |
Number of variables returned |
|
|
MOUNT.1 |
Command to execute |
|
|
MOUNT.2 |
userid vaddr |
|
|
MOUNT.3
|
[READ|WRITE] Indicates the request is a read request (READ) or a write request (WRITE). |
|
|
|
||
|
MOUNT.4
|
[DSN|*] DSN is the data set name associated with the mount request or the data set name in the TMC. The * indicates the data set name is not specified. |
|
|
|
||
|
MOUNT.5
|
[OS|*] [OPEN|EOV|CLOSE] OS is the type of OS simulation requested. It can be open, end of volume (EOV), or close. The * indicates that the request is not an OS simulation request. |
|
|
|
Returns USER, SYSTEM, or OFF and the currently specified scratch pool name for the request.
|
REXX Special Variable |
Description |
|
|
POOL.0 |
Number of variables returned |
|
|
POOL.1
|
[USER|SYSTEM|OFF] USER is returned if the POOLNAME option is specified on the MOUNT command. SYSTEM is returned if a scratch pool is selected from scratch pool assignment rules. OFF is returned if the volume is owned, if no scratch pools are configured, or if the ALLOCATE command is issued. |
|
|
|
||
|
|
||
|
|
||
|
POOL.2
|
Scratch pool name or general (optional) If POOL.1 is USER, POOL.2 is the pool that was specified on the MOUNT command. If POOL.1 is SYSTEM, POOL.2 is the name of the pool that CA VM:Tape used to satisfy the mount request. If POOL.2 is general (represented in lowercase letters), the tape came from the general scratch tape pool that was not explicitly defined by the CA VM:Tape scratch pool facility. |
|
|
|
||
|
|
Returns the various user IDs associated with the indicated request.
|
REXX Special Variable |
Description |
|
USER.0 |
Number of variables returned |
|
USER.1 |
User ID who submitted request (for CA VM:Batch jobs, this is the CA VM:Batch worker) |
|
USER.2 |
Alternate user ID for CA VM:Batch jobs. This is the user ID who submitted the CA VM:Batch request. If this is not a CA VM:Batch job, this is the same as USER.1. |
|
USER.3 |
User ID to receive drive |
|
USER.4 |
If WORK is specified on the MOUNT request, USER.4 is the user ID that runs the CA VM:Tape service virtual machine (usually VMTAPE). If SAVEFOR is specified, USER.4 is the user ID for which the scratch tape is being saved. Otherwise, USER.4 is the user ID for whom the request is processed. |
|
USER.5 |
Accounting user ID |
Returns information concerning the volume associated with the mount request.
|
REXX Special Variable |
Description |
|
|---|---|---|
|
VOLSER.0 |
Number of variables returned |
|
|
VOLSER.1
|
[*|volser LIBRARY[OWNER] The * indicates that a scratch tape was requested and Autopick is not enabled. The variable volser is the volume serial number that is associated with the mount request, followed optionally by the keyword LIBRARY if a tape with the same volser exists in the TMC. It is followed by the owner of the tape if the tape is not a scratch tape. |
|
|
|
||
|
or
|
[VOLSER FOREIGN [ LIBRARY] [OWNER]] ] The volser associated with the mount request is a FOREIGN tape (either by default or because the FOREIGN option was specified on the request) followed optionally by the keyword LIBRARY if a tape with the same volser exists in the TMC. If the LIBRARY tape is not a scratch tape, the owner of the LIBRARY tape is provided. |
|
|
|
||
|
VOLSER.2
|
[SCRATCH|*] [AUTO|NOAUTO] SCRATCH indicates the tape is a scratch tape. AUTO indicates that Autopick is turned on. NOAUTO indicates that Autopick is turned off. The * indicates that the tape is not a scratch tape. |
|
|
|
||
|
VOLSER.3
|
[location | product*] The location and product variables are the location and product of the volume. The * indicates that the location is not applicable or cannot be determined. |
|
|
|
|
Copyright © 2013 CA.
All rights reserved.
|
|