The volume not in library installation exit (CBRUXVNL) is passed
by way of register 1, the pointer to a parameter list mapped by CBRUXNPL.
The installation exit, CBRUXVNL, cannot update the tape volume
record. All fields in the volume not in library installation exit
parameter list (CBRUXNPL) are input only. Here is the format of CBRUXNPL.
UXNPL DSECT , VOLUME NOT IN LIBRARY PARAMETER LIST
**********************************************************************
* *
* VOLUME NOT IN LIBRARY PARAMETERS: ALL FIELDS ARE INPUT ONLY AND *
* CAN NOT BE MODIFIED BY *
* INSTALLATION EXIT *
* *
**********************************************************************
UXNPARM DS 0D CBRUXVNL PARAMETER SECTION
UXNWHERE DS XL1 WHERE THE ERROR WAS FOUND
* 1 JOB STEP SETUP PROCESSING
* 2 DEVICE ALLOCATION PROCESSING
* 3 LIBRARY MOUNT PROCESSING
UXNERROR DS XL1 ERROR INDICATOR
* 1 VOLUME RECORD NOT IN TCDB
* 2 VOLUME IS SHELF RESIDENT
* 3 VOLUME IN DIFFERENT LIBRARY
* 4 VOLUME EJECT PENDING AND
* EJECT CANNOT BE CANCELED
DS CL6 RESERVED
UXNLIB DS CL8 LIBRARY NAME IN WHICH THE VOLUME SHOULD
* BE ENTERED OR BLANKS
UXNLDEV DS CL8 LIBRARY DEVICE TYPE OR BLANKS
UXNLCON DS CL8 LIBRARY CONSOLE NAME OR BLANKS
UXNLTYP DS CL1 LIBRARY LOGICAL TYPE OR BLANK
* 'R' FOR AUTOMATED LIBRARY
* 'M' FOR MANUAL LIBRARY
DS CL7 RESERVED
UXNLDESC DS CL120 LIBRARY DESCRIPTION OR BLANKS
UXNVOLSR DS CL6 VOLUME SERIAL NUMBER
UXNSUPPT DS XL1 SUPPORT FLAGS
UXNJINFO EQU X'80' ON IF JOB INFORMATION PROVIDED
* (JOB STEP SETUP INVOCATION)
* FLAG X'40' IS RESERVED
DS CL1 RESERVED
UXNLIBRS DS CL8 LIBRARY NAME IN WHICH THE VOLUME
* RESIDES OR "SHELF" OR BLANKS
UXNUSEA DS CL1 VOLUME USE ATTRIBUTE OR BLANKS
* 'P' FOR PRIVATE
* 'S' FOR SCRATCH
UXNWPROT DS CL1 WRITE PROTECTION STATUS OR BLANK
* 'Y' FOR WRITE-PROTECTED
* 'N' FOR NOT WRITE-PROTECTED
UXNCHKPT DS CL1 CHECKPOINT VOLUME INDICATOR OR BLANK
* 'Y' FOR CHECKPOINT VOLUME
* 'N' FOR NOT CHECKPOINT VOLUME
UXNLOC DS CL1 VOLUME LOCATION OR BLANK
* 'L' FOR LIBRARY-RESIDENT
* 'S' FOR SHELF-RESIDENT
UXNTDSI DS 0F TAPE DEVICE SELECTION INFORMATION
UXNREC DS XL1 TAPE RECORDING TECHNOLOGY OR ZERO
UXNMEDIA DS XL1 MEDIA TYPE OR ZERO
UXNCOMP DS XL1 COMPACTION OR ZERO
UXNSPEC DS XL1 SPECIAL ATTRIBUTE OR ZERO
UXNGROUP DS CL8 STORAGE GROUP NAME OR BLANKS
UXNSHLOC DS CL32 SHELF LOCATION OR BLANKS
UXNOWNER DS CL64 VOLUME OWNER INFORMATION OR BLANKS
DS CL8 RESERVED
UXNCREAT DS CL10 VOLUME RECORD CREATION DATE YYYY-MM-DD
* OR BLANKS
UXNENTEJ DS CL10 LAST ENTRY OR EJECTION DATE YYYY-MM-DD
* OR BLANKS
UXNMOUNT DS CL10 LAST MOUNTED DATE YYYY-MM-DD
* OR BLANKS
UXNWRITE DS CL10 LAST WRITTEN DATE YYYY-MM-DD
* OR BLANKS
UXNEXPIR DS CL10 VOLUME EXPIRATION DATE YYYY-MM-DD
* OR BLANKS
DS CL10 RESERVED
DS CL4 RESERVED
**********************************************************************
* *
* JOB INFORMATION AVAILABLE WHEN INVOKED FOR *
* JOB STEP SETUP PROCESSING (UXNWHERE=UXNSETUP) *
* *
**********************************************************************
* *
* JOB INFORMATION FIELDS ARE INPUT ONLY FIELDS *
* *
**********************************************************************
UXNJOB DS 0CL120 JOB INFORMATION
UXNJOBNM DS CL8 JOB NAME
UXNSTPNM DS CL8 STEP NAME
UXNPRGNM DS CL8 PROGRAM NAME
UXNDDNM DS CL8 DD NAME
UXNDSN DS CL44 DATASET NAME
UXNUNIT DS CL8 UNIT NAME
**********************************************************************
* UXNDISP FIELDS CONTAIN STANDARD JCL DISPOSITION PARAMETERS *
* (DISPOSITION SUBPARAMETERS WILL REFLECT THE JOB *
* SPECIFICATIONS, ZEROES, IF NOT SPECIFIED, OR IN SOME CASES, *
* DEFAULT SETTINGS RATHER THAN ZEROES) *
**********************************************************************
UXNDISP DS 0CL17 DISPOSITION (DISP=...)
UXNDISP1 DS CL3 1ST SUBPARAMETER, STATUS
UXNDISP2 DS CL7 2ND SUBPARAMETER, NORMAL
UXNDISP3 DS CL7 3RD SUBPARAMETER, ABNORMAL
*
UXNFLAGS DS XL1 JOB INFORMATION FLAGS
UXNCATLG EQU X'80' ON IF VOLSER OBTAINED FROM CATALOG
DS CL2 RESERVED
UXNDEVTP DS CL4 DEVICE TYPE FROM CATALOG
* (PROVIDED IF UXNCATLG IS ON)
DS CL12 RESERVED
UXNEND DS 0D END OF CBRUXVNL PARAMETER SECTION
SPACE 1
UXNPLLEN EQU * - UXNPL LENGTH OF THE PARAMETER LIST
**********************************************************************
* *
* RETURN CODES *
* *
**********************************************************************
UXNNORML EQU 0 PERFORM NORMAL PROCESSING
UXNRETRY EQU 4 RETRY THE FAILING OPERATION
UXNFAIL EQU 8 CANCEL THE JOB STEP
UXNDONT EQU 16 DO NOT CALL THE VOLUME NOT IN LIBRARY
* INSTALLATION EXIT AGAIN AND PERFORM
* NORMAL PROCESSING
SPACE 1
**********************************************************************
* *
* WHERE CONSTANTS (UXNWHERE) *
* *
**********************************************************************
UXNSETUP EQU 1 DURING JOB SETUP PROCESSING
UXNALLOC EQU 2 DURING DEVICE ALLOCATION PROCESSING
UXNLBMNT EQU 3 DURING LIBRARY MOUNT PROCESSING
SPACE 1
**********************************************************************
* *
* ERROR CONSTANTS (UXNERROR) *
* *
**********************************************************************
UXNNTCDB EQU 1 VOLUME RECORD NOT IN TCDB
UXNSHELF EQU 2 VOLUME IS SHELF RESIDENT
UXNDFRNT EQU 3 VOLUME IN DIFFERENT LIBRARY
UXNEJECT EQU 4 VOLUME EJECT PENDING AND
* EJECT CANNOT BE CANCELED
SPACE 1
**********************************************************************
* *
* LIBRARY LOGICAL TYPE CONSTANTS (UXNLTYP) *
* *
**********************************************************************
UXNAUTO EQU C'R' AUTOMATED/REAL LIBRARY
UXNMAN EQU C'M' MANUAL LIBRARY
SPACE 1
**********************************************************************
* *
* USE ATTRIBUTE CONSTANTS (UXNUSEA) *
* *
**********************************************************************
UXNPRIV EQU C'P' PRIVATE USE ATTRIBUTE
UXNSCRT EQU C'S' SCRATCH USE ATTRIBUTE
SPACE 1
**********************************************************************
* *
* LOCATION CONSTANTS (UXNLOC) *
* *
**********************************************************************
UXNLBRY EQU C'L' LIBRARY RESIDENT
UXNSHLF EQU C'S' SHELF RESIDENT
SPACE 1
**********************************************************************
* *
* TAPE DEVICE SELECTION INFORMATION (TDSI) CONSTANTS *
* *
**********************************************************************
* CONSTANTS TO DEFINE TAPE RECORDING TECHNOLOGY *
**********************************************************************
UXNNOREC EQU 0 RECORDING TECHNOLOGY UNKNOWN OR
* UNSPECIFIED
UXN18TRK EQU 1 READ/WRITE ON AN 18 TRACK DEVICE
UXN36TRK EQU 2 READ/WRITE ON A 36 TRACK DEVICE
UXN128TRK EQU 3 READ/WRITE ON A 128 TRACK DEVICE
UXN256TRK EQU 4 READ/WRITE ON A 256 TRACK DEVICE
UXN384TRK EQU 5 READ/WRITE ON A 384 TRACK DEVICE
UXNEFMT1 EQU 6 READ/WRITE ON ENTERPRISE FORMAT 1
* (EFMT1) DEVICE
UXNEFMT2 EQU 7 READ/WRITE ON ENTERPRISE FORMAT 2
* (EFMT2) DEVICE
UXNEEFMT2 EQU 8 READ/WRITE ON ENTERPRISE ENCRYPTED FORMAT 2
* (EEFMT2) DEVICE
UXNEFMT3 EQU 9 READ/WRITE ON ENTERPRISE
* FORMAT 3 (EFMT3) DEVICE
UXNEEFMT3 EQU 10 READ/WRITE ON ENTERPRISE
* ENCRYPTED FORMAT 3 (EEFMT3) DEVICE
UXNEFMT4 EQU 11 READ/WRITE ON ENTERPRISE FORMAT 4
* (EFMT4) DEVICE
UXNEEFMT4 EQU 12 READ/WRITE ON ENTERPRISE ENCRYPTED
* FORMAT 4 (EEFMT4) DEVICE
**********************************************************************
* CONSTANTS TO DEFINE MEDIA TYPE *
**********************************************************************
UXNNOMED EQU 0 MEDIA TYPE UNKNOWN OR UNSPECIFIED
UXNMED1 EQU 1 MEDIA1 - CARTRIDGE SYSTEM TAPE
UXNMED2 EQU 2 MEDIA2 - ENHANCED CAPACITY CARTRIDGE
* SYSTEM TAPE
UXNMED3 EQU 3 MEDIA3 - HIGH PERFORMANCE CARTRIDGE
* TAPE
UXNMED4 EQU 4 MEDIA4 - EXTENDED HIGH PERFORMANCE
* CARTRIDGE TAPE
UXNMED5 EQU 5 MEDIA5 - ENTERPRISE TAPE CARTRIDGE
UXNMED6 EQU 6 MEDIA6 - ENTERPRISE WORM TAPE
* CARTRIDGE
UXNMED7 EQU 7 MEDIA7 - ENTERPRISE ECONOMY TAPE
* CARTRIDGE
UXNMED8 EQU 8 MEDIA8 - ENTERPRISE ECONOMY WORM TAPE
* CARTRIDGE
UXNMED9 EQU 9 MEDIA9 - ENTERPRISE EXTENDED TAPE
* CARTRIDGE
UXNMED10 EQU 10 MEDIA10 - ENTERPRISE EXTENDED WORM TAPE
* CARTRIDGE
UXNMED11 EQU 11 MEDIA11 - ENTERPRISE ADVANCED
* TAPE CARTRIDGE
UXNMED12 EQU 12 MEDIA12 - ENTERPRISE ADVANCED
* WORM TAPE CARTRIDGE
UXNMED13 EQU 13 MEDIA13 - ENTERPRISE ADVANCED
* ECONOMY TAPE CARTRIDGE
**********************************************************************
* CONSTANTS TO DEFINE COMPACTION *
* (THE MEANING OF THE COMPACTION FIELD HAS CHANGED FROM TYPE OF *
* COMPACTION TO COMPACTION YES/NO - UXNIDRC AND UXNCOMPT CAN BE *
* USED INTERCHANGEABLY) *
**********************************************************************
UXNCMPNS EQU 0 COMPACTION UNKNOWN OR NOT SET
UXNNOCMP EQU 1 NO COMPACTION
UXNIDRC EQU 2 COMPACTION
UXNCOMPT EQU 2 COMPACTION
**********************************************************************
* CONSTANTS TO DEFINE SPECIAL ATTRIBUTE *
**********************************************************************
UXNNOSPC EQU 0 VOLUME HAS NO SPECIAL ATTRIBUTE
UXNRDCOM EQU 1 VOLUME WILL BE MOUNTED FOR READ ONLY -
* ALL READ-COMPATIBLE DEVICES MAY BE
* SELECTED
SPACE 1
**********************************************************************
* *
* MISCELLANEOUS CONSTANTS *
* *
**********************************************************************
UXNPLSP EQU 230 SUBPOOL NUMBER
UXNYES EQU C'Y' YES
UXNNO EQU C'N' NO
UXNBLANK EQU C' ' BLANK
Storage
is obtained below the line, from subpool 230, user key, for the installation
exit parameter list.
z/OS DFSMS OAM Planning, Installation, and Storage Administration Guide for Tape Libraries
Copyright IBM Corporation 1990, 2014