ADRUFO Parameter List

Register 1 contains the address of the ADRUFO parameter list. You can use the ADRUFO mapping macro to map the parameter list. These sections are shown in Table 1.

UFOHDR: contains information describing the type of entry and, for a function entry, details of the function to be scheduled. It also contains an offset to UFOFUNCT or UFOPARM and the addresses of UFOVOL for input and UFOVOL for output.
UFOFUNCT: contains information about the function to be scheduled and which ones can be altered by this exit routine. The bits are described in the parameter list. It is created for the function entry.
UFOPARM: contains bits that can be set to change defaults or override commands. The bits are described in the parameter list. It is created for the PARM change entry.
UFOVOL: is an array of entries describing the volumes used for input and output for the specific function commands.

Table 1. ADRUFO Parameter List
Offset	Length or Bit Pattern	Name	Description
0 (X'0')	24	ADRUFOB
0 (X'0')	24	UFOHDR	Header of ADRUFO parameter list
0 (X'0')	4	UFID	Identifier: EBCDIC "UFO"
4 (X'4')	2	UFLEN	Length of parameter list
6 (X'6')	2	UFBDYOFF	Offset to UFOFUNCT or UFOPARM
8 (X'8')	4	UFVOLI@	Address of input volume list or 0
12 (X'C')	4	UFVOLO@	Address of output Volume list or 0
16 (X'10')	2	UFFUNCT	Function being performed X'0000' = parameter change entry
16 (X'10')	1	UFFUNCT1	Function byte one
	1... ....	UFFUDEF	1 = DEFRAG operation
	.1.. ....	UFFUCOPY	1 = COPY operation
	..1. ....	UFFUREST	1 = RESTORE operation
	...1 ....	UFFUDUMP	1 = DUMP operation
	.... 1...	UFFUPRT	1 = PRINT operation
	.... .1..	UFFUCPYD	1 = COPYDUMP operation
	.... ..x.		Reserved
	.... ...1	UFFUCOMP	1 = COMPRESS operation
17 (X'11')	1	UFFUNCT2	Function byte two
	1... ....	UFFURLSE	1 = RELEASE operation
	.1.. ....	UFFUCONV	1 = CONVERTV operation
	..1. ....	UFFUBLSA	1 = BUILDSA operation
	...x ....		Reserved
	.... 1...	UFFUCGCR	1 = CGCREATED operation
	.... .1..	UFFUCONS	1 = CONSOLIDATE operation
	.... ..xx		Reserved
18 (X'12')	1	UFFIND	Functional indicators
	1... ....	UFFIFULL	1 = full volume request (DUMP, RESTORE, COPY, DEFRAG, and CONSOLIDATE)
	.1.. ....	UFFIPART	1 = partial request (DUMP, RESTORE, COPY, DEFRAG, and PRINT)
	..1. ....	UFFIFILT	1 = request by filter/data set name (DUMP, RESTORE, and PRINT)
	...1 ....	UFFIPRTV	1 = print VTOC
	.... 1...	UFFLOGCL	1 = logical processing for COPY, DUMP, or RELEASE - either no input volumes are specified, (catalog filtering), or one of the following is specified: LOGINDDNAME, LOGINDYNAM, LOGDDNAME, LOGDYNAM.
	.... .xxx		Reserved
19 (X'13')	1	UFAIFLGS	Application interface flags
	1... ....	UFAIINV	1 = invoked by application interface
	.1.. ....	UFUIMAL	1 = UIM not to be given control Note: See the Application Programming Interface in the z/OS DFSMSdfp Storage Administration.
	..1. ....	UFUIMCH	1 = do not allow ADRUIM to modify options, values
	...1 ....	UFSTOP	1 = do not schedule task
	.... 1...	UFSYSIN	1 = SYSIN or alternate is not present. Allowed if UFAIINV is ON and UFUIMAL is OFF.
	.... .1..	UFSYSPR	1 = SYSPRINT or alternate is not present. Allowed if UFAIINV is ON and UFUIMAL is OFF.
	.... ..1.	UFNOIN	1 = no input tape (only for RESTORE)
	.... ...1	UFNOOUT	1 = no output tape (only for DUMP)
20 (X'14')	1	UFFLAGS	Flags
	1... ....	UFBYFCCK	1 = bypass facility class checks if user is APF-authorized and requests RACF bypass
	.1.. ....	UFSAFOK	1 = OK to use the SAF interface at the highest supported level
	..1. ….	UFFREWCL	1 = rewind on close
	...1 ….	UFIGCTNN	1 = ignore catalog entries for new named data set, valid only for logical dump
	.... 1...	UFFCFRRT	1 = retry FlashCopy without fast reverse restore
	.... .1..	UFBYFRVF	1 = bypass verification during fast reverse restore
	…. ..xx		Reserved
21 (X'15')	3		Reserved
24 (X'18')			Force word alignment
0 (X'0')	48	UFOFUNCT	List of options for function. Pointed to by the address of UFOHDR and UFBDYOFF. Present if any bits are ON in UFFUNCT.
0 (X'0')	1	UFO1FLGS	First set of option flags.
	1... ....	UFO1COMP	1 = COMPRESS (DUMP)
	.1.. ....	UFO1CVOL	1 = COPYVOLID (RESTORE and COPY)
	..1. ....	UFO1PURG	1 = purge (DUMP, COPY and RESTORE)
	...1 ....	UFO1RESE	1 = reset change bit (DUMP)
	.... 1...	UFO1WRCK	1 = WRITECHECK
	.... .1..	UFO1ALD	1 = ALLDATA
	.... ..1.	UFO1ALDL	1 = ALLDATA(LIST). 0 = ALLDATA(). Valid only if UFO1ALD = 1. Bit might not be set ON by the exit but might be reset to change ALLDATA(LIST) to ALLDATA()
	.... ...1	UFO1ALLE	1 = ALLEXCP
1 (X'1')	1	UFO2FLGS	Second set of option flags
	1... ....	UFO2DYNQ	0 = use ENQ to hold data set. 1 = use DYNALOC to hold data set (DUMP, DEFRAG, PRINT, and RESTORE)
	.1.. ....	UFO2ENQE	1 = ENQ exclusive (DUMP, RESTORE, and PRINT)
	..1. ....	UFO2ENQS	1 = ENQ shared if exclude fails (DUMP, RESTORE, and PRINT)
	...1 ....	UFO2ENQN	1 = do not ENQ if exclude and share fail (DUMP, RESTORE, and PRINT)
	.... 1...	UFO2DEL	1 = delete after data set DUMP or COPY
	.... .1..	UFO2CTLG	1 = catalog data sets during a data set RESTORE, COPY
	.... .1..	UFO2RECT	1 = recatalog data sets during a data set RESTORE, COPY
	.... ..1.	UFO2UNC	1 = uncatalog data sets after a data set DUMP, COPY
	.... ...1	UFO2VLD	1 = validate: dump the VSAM indexed data set in new format (logical data set dump)
2 (X'2')	1	UFDUOPTM	Optimize value (1, 2, 3, or 4)
3 (X'3')	1	UFOINSOP	Installation options
	1... ....	UFOERASE	1 = erase DASD tracks
	.1.. ....	UFOIACPY	1 = DUMP must produce all output copies or none at all
	..1. ....	UFOBLDIX	1 = invoke ICKDSF to rebuild VTOC index
	...1 ....	UFORACLG	RACFLOG = YES specified or force RACF logging
	.... 1...	UFOBK32K	Tape block size 32K could be specified in the JCL as DCB=BLKSIZE=32760
	.... .1..	UFOARBA	1 = AUTORELBLKA specified
	.... ..1.	UFOMKMV	1 = MAKEMULTI specified
	.... ...1	UFOFLEAV	1 = close leave flag
4 (X'4')	4	UFOFRAGI	FRAGMENTATION INDEX(DEFRAG) 9,90,900=900, 09=90, 009=9
8 (X'8')	1	UFOVCFLG	VOLCOUNT flags
	1... ....	UFOVCCUR	1 = VOLCOUNT(*)
	.1.. ....	UFOVCSRC	1 = VOLCOUNT(SRC)
	..1. ....	UFOVCNUM	1 = VOLCOUNT(N(nn))
	...1 ....	UFOVCANY	1 = VOLCOUNT(ANY)
	.... 1...	UFOSMALL	1 = SELECTMULTI(ALL)
	.... .1..	UFOSMANY	1 = SELECTMULTI(ANY)
	.... ..1.	UFOSM1ST	1 = SELECTMULTI(FIRST)
	.... ...1	UFOCPFRC	1 = dump/copy checkpointed data sets (see UFOCPDAY)
9 (X'9')	1	UFOVCVAL	Binary number of volumes to use when UFOVCNUM is set
10 (X'A')	1	UFOCPDAY	Binary number of days for FORCECP keyword (see UFOCPFRC)
11 (X'B')	1		Reserved
12 (X'C')	4	UFOMNSQT	Minimum secondary allocation quantity
16 (X'10')	4	UFOMNTUS	Minimum unused tracks RELEASEUNUSED, CHANGEALLOC
20 (X'14')	1	UFO3FLGS	Third option flag byte
	1... ....	UFO3FORC	1 = force unmovables on COPY, RESTORE
	.1.. ....	UFO3REPL	1 = replace (DATASET COPY, RESTORE)
	..1. ....	UFOFRBLK	1 = force reblocking of data sets (COPY, RESTORE)
	...1 ....	UFODRBLK	1 = disable reblocking of data sets (COPY, RESTORE)
	.... 1...	UFOALLMU	1 = search ALLMULTI
	.... .1..	UFOSPHER	1 = perform sphere processing
	.... ..1.	UFONOSMS	1 = NULLSTORCLAS specified
	.... ...1	UFONMGMT	1 = NULLMGMTCLAS specified
21 (X'15')	1	UFOWAITS	Wait time in seconds between RESERVE and ENQ retries (all)
22 (X'16')	1	UFOWAITR	Number of retries on reserve or ENQ failures (all commands)
23 (X'17')	1	UFOTGTAL	TGTALLOC flags
	1... ....	UFOTGTCY	1 = cylinder
	.1.. ....	UFOTGTTR	1 = track
	..1. ....	UFOTGTBL	1 = block
	...1 ....	UFOTGTSR	1 = source
	.... xxxx		Reserved
24 (X'18')	1	UFOPROCK	Process options
	1... ....	UFOPRUND	1 = process UNDEFDSORG
	.1.. ....	UFOPRSYS	1 = process SYS1
	..xx xxxx		Reserved
25 (X'19')	1	UFO4FLGS	Fourth options flag byte
	1... ....	UFOT0REQ	Concurrent copy requested
	.1.. ....	UFODCOND	DUMPCONDITIONING
	..1. ....	UFOCVRBK	CICSVRBACKUP
	...1 ....	UFOFCNC	FLASHCOPY NOCOPY
	.... 1...	UFOFCWD	FLASHCOPY WITHDRAW
	.... .1..	UFOFC2PP	FLASHCOPY to PPRC Primary allowed
	.... ..1.	UFOFCN2C	FCNOCOPYTOCOPY
	.... ...1	UFOFCFRZ	FCCGFREEZE
26 (X'1A')	2	UFORIOPC	Read I/O pacing
28 (X'1C')	1	UFO5FLGS	Fifth options flag byte
	1... ....	UFOFRREQ	FASTREPLICATION(REQUIRED)
	.1.. ....	UFOFRPRF	FASTREPLICATION(PREFERRED)
	..1. ....	UFOFRNO	FASTREPLICATION(NONE)
	...1 ....	UFO5REPU	REPLACEUNCONDITIONAL
	.... 1...	UFOFCINC	FCINCREMENTAL
	.... .1..	UFOFCINL	FCINCREMENTALLAST
	.... ..1.	UFOFCVFR	FCINCRVERIFY (REVERSE)
	.... ...1	UFOFCVFN	FCINCRVERIFY (NOREVERSE)
29 (X'1D')	1	UFO6FLGS	Sixth options flags bytes
	1... ....	UFOFRMSM	FRMSG(MINIMAL)
	.1.. ....	UFOFRMSS	FRMSG(SUMMARIZED)
	..1. ....	UFOFRMSD	FRMSG(DETAILED)
	...1 ....	UFOHCOMP	HWCOMPRESS
	.... 1...	UFODBTRC	DEBUG(TRACE)
	…. .1..	UFODBSMS	DEBUG(SMSMSG)
	…. ..1.	UFOFCVFY	Force FCCGVERIFY termination on first error
	…. ...x	*	Reserved
30 (X'1E')	1	UFOFCWTS	Wait time in seconds between queries for background copy completion
31 (X'1F')	1	UFOFCWTR	Number of additional queries for background copy completion
32 (X'20')	1	UFO7FLGS	Seventh options flags byte
	1… …	UFOFCSEF	FCSETGTOK (FAILRELATION)
	.x.. ....		Reserved
	..1. ….	UFO7CCAR	CONCURRENT(ANYREQ)
	...1 ….	UFO7CCVR	CONCURRENT(VIRTUALREQ)
	…. 1...	UFO7CCCR	CONCURRENT(CACHEREQ)
	…. .1..	UFO7CCAP	CONCURRENT(ANYPREF)
	…. ..1.	UFO7CCVP	CONCURRENT(VIRTUALPREF)
	…. …1	UFO7CCCP	CONCURRENT(CACHEPREF)
33 (X'21')	1	UFO8FLGS	Eighth options flags byte
	1... ....	UFOPMREQ	FCTOPPRCPRIMARY(PRESMIRREQ)
	.1.. ....	UFOPMPRE	FCTOPPRCPRIMARY(PRESMIRPREF)
	..1. ....	UFOPMNON	FCTOPPRCPRIMARY(PRESMIRNONE)
	...1 ....	UFOFCFRR	FCFASTREVERSERESTORE
	.... 1...	UFOFCFVR	FCFULLVOLUMERELATION
	…. .1..	UFO8RESY	Force RESET(YES) on RESTORE
	…. ..1.	UFO8RESN	Force RESET(NO) on RESTORE
	…. …1	UFO8RESD	Force RESET(DUMP) on RESTORE
34 (X'22')	2	UFOMAXTM	Number of minutes for DEFRAG or CONSOLIDATE to execute before quiescing processing
36 (X'24')	1	UFO9FLGS	Ninth options flags byte
	1... ....	UFOBRCLK	BCSRECOVER(LOCK)
	.1.. ....	UFOBRCSU	BCSRECOVER(SUSPEND)
	..1. ....	UFOZCNON	ZCOMPRESS(NONE)
	...1 ....	UFOZCPRE	ZCOMPRESS(PREFERRED)
	.... 1...	UFOZCREQ	ZCOMPRESS(REQUIRED)
	…. .xxx	*	Reserved
48 (X'30')			Force word alignment
0 (X'0')	32	UFOPARM	EXEC PARM option list. Pointed to by the address of UFOHDR and UFBDYOFF. Present if all bits are OFF in UFFUNCT.
0 (X'0')	1	UFSERPAR	Serial / parallel
	1... ....	UFFORSER	1 = force to serial
	.1.. ....	UFDEFPAR	1 = default to parallel. Ignored if UFFORSER is 1.
	..xx xxxx		Reserved
1 (X'1')	1	UFXAFLAG	Control flags for XA mode.
	1... ....	UFXABUFF	1 = I/O buffer above 16M required
	.1.. ....	UFAI31B	1 = AI buffer above 16M required
	..1. ....	UFPZB64R	1 = I/O buffer backed anywhere in 64-bit real storage request
	...x xxxx		Reserved
2 (X'2')	8	UFWKUNIT	WORKUNIT parameter
10 (X'A')	6	UFWKVOL	WORKVOL parameter
16 (X'10')	1	UFOPFLG1	FLAG BYTE 1
	1... ....	UFOUEXCP	DEBUG(FRMSG(MINIMAL))
	.xxx xxxx		Reserved
17 (X'11')	1	UFOMXTSK	Max Parallel Tasks
18 (X'12')	14		Reserved
32 (X'20')			Force word alignment
0 (X'0')		UFOVOL	Volume list header. Pointed to by UFVOLI@ and UFVOLO@.
0 (X'0')	4	UFOVHDR	Header
0 (X'0')	2	UFOVCNT	Count of volume list entries
2 (X'2')	2		Reserved
4 (X'4')	20	UFOVENT	Volume list entry
4 (X'4')	4	UFOVUCB@	Address of UCB or 0
8 (X'8')	8	UFODDNAM	DDNAME or blank
16 (X'10')	6	UFOVOLID	Volume serial number or 0
22 (X'16')	2		Reserved