INQUIRE Display contents of directory file

The INQUIRE statement enables the user to output the contents of the directory file.

If neither the FILES, JOBVAR, SV nor POOL operand is specified, all files and then all job variables are output in alphabetical order.
If FILES and JOBVAR or the SV operand are specified, files and job variables are likewise output in merged form.
Files and job variables cannot be output separately unless separate INQUIRE statements with the appropriate operands are entered.

INQUIRE / Q

[DIR[ECTORY] = { $TSOS.ARCHIVE.DIR / filename }

[ { [,F[ILES] = { filename / (filename,...) }] [,J[OBVAR] = jv-name ] / (jv-name,...) } ] /
     ,SV = { ALL / OBS[OLETE] / svid / (svid,...) / backup,date[.time] } [,F[ILES] ] [,J[OBVAR] ] /
     ,POOL [,AV[AILABLE]]  } ]

[,P[ASSWORD] = password]
[,L[IST] = SYSOUT / SYSLST / BOTH]

DIRECTORY= $TSOS.ARCHIVE.DIR / filename
This is the name of the directory file whose contents are to be output.
The user can address any directory file created under his own user ID. He can also address his own files in the system support's directory file.

FILES = filename / (filename,...)
This determines that information about files is output from the directory file.
The fully or partially qualified names of the desired files should be entered for filename. If the user has specified the directory file of the system support, only information about the files under his own user ID is supplied.

JOBVAR = jv-name / (jv-name,...)
This determines that information relating to job variables is output from the directory file. The fully or partially qualified names of the job variables should be entered for jv-name.

SV =
This determines that information relating to save versions (svid) is output from the directory file.

SV = ALL
All the save versions (svid) in the specified directory file are output.

SV = OBSOLETE
All the “obsolete” save versions (svid) are output from the directory file. An obsolete save version is one whose retention period (RETPD) has expired.

SV = svid / (svid,...)
Only the specified save versions are output from the directory file.

SV = backup,date.time
All the save versions created by means of the SAVE statement and with this BACKUP entry up to and including the specified time are output.

SV = ...,FILES
The file names are output sorted according to save version. The user only receives information about his own files. The system support on the other hand is given information about all the files in the system.

SV = ...,JOBVAR
The job variable names are output, sorted according to save version. Any user other than the system support receives a list of his own job variables.

POOL
This outputs the VSNs of the volumes in the volume pool in the directory file in ascending order. The following information is also output:

• volume type

• svid, if the volume has already been included in a save version

• AVAILABLE, if the volume is free

• UNUSABLE, if the volume cannot be used for writing

• POOL, if the volume was added to the pool by means of the POOL statement

• OPERATOR, if the volume was added to the pool by the operating

• the expiration date, if it has not yet been reached

POOL,AVAILABLE
Only the VSNs of the available volumes are output.

PASSWORD = password
The password for the ARCHIVE run.
An entry is necessary if the directory file is protected by a read password and is not under TSOS.

LIST =
This defines the output medium for the report of this ARCHIVE run.

LIST = SYSOUT
The report is output to the user's terminal in interactive mode.This is the default for runs in interactive mode.

LIST = SYSLST
The report is output to SYSLST.This is the default for batch mode.

LIST = BOTH
The report is output to both SYSLST and SYSOUT.

Example 1

/START-ARCHIVE

%  BLS0990 PROCESSING OF REP FILE ':SBZ3:$TSOS.SYSREP.ARCHIVE.120' STARTED
%  ARCLOAD Program 'ARCHIVE', version '12.0A' of '2018-06-04' loaded 
           from file ':1OSH:$TSOS.SYSLNK.ARCHIVE.120'
%  ARCCOPY Copyright (C) FUJITSU TECHNOLOGY SOLUTIONS 2018. 
            All rights reserved 
%  ARC0001 ARCHIVE READY

*INQUIRE DIRECTORY=ARCHIVE.DIR,FILES=FILE. —————————————————  (1)

*   I N Q U I R E   C O M M A N D   L I S T I N G *** 
 
PARAMETER VALUES:-
CNS     = YES
INQUIRE DIRECTORY=ARCHIVE.DIR,FILES=FILE.
%  ARC0002 STATEMENT ACCEPTED. ARCHIVE SEQUENCE NUMBER 'A.100814.150638',
           VERSION='12.0A'

%  ARC0003 ARCHIVE STATEMENT COMPLETED

*END

%  ARC0009 ARCHIVE TERMINATED

(1)

ARCHIVE should output all information relating to the FILE. files from the directory file ARCHIVE.DIR.

(2)

The ARCHIVE report is output to SYSOUT.It contains the following information: FILE/JOB VARIABLE NAME: All the files under the user ID TSOS having the partially qualified file name FILE. and included in the directory file ARCHIVE.DIR. CFID: Internal file names. SAVE VERSION: Name of the save versions. EXP.DATE: expiration date; the retention period of the volume has expired (OBS). TYPE: Save types. VSN(S): VSNs of the input volumes.

Example 2

/START-ARCHIVE

%  BLS0990 PROCESSING OF REP FILE ':SBZ3:$TSOS.SYSREP.ARCHIVE.120' STARTED
%  ARCLOAD Program 'ARCHIVE', version '12.0A' of '2018-06-04' loaded  
           from file ':1OSH:$TSOS.SYSLNK.ARCHIVE.120'
%  ARCCOPY Copyright (C) FUJITSU TECHNOLOGY SOLUTIONS 2018. 
            All rights reserved  
%  ARC0001 ARCHIVE READY

*INQUIRE DIRECTORY=ARCHIVE.DIR,POOL ————————————————— (1)

*   I N Q U I R E   C O M M A N D   L I S T I N G *** 
 
PARAMETER VALUES:-
CNS     = YES
 
INQUIRE DIRECTORY=ARCHIVE.DIR,POOL
%  ARC0002 STATEMENT ACCEPTED. ARCHIVE SEQUENCE NUMBER 'A.100814.150710', 
           VERSION='12.0A'

%  ARC0003 ARCHIVE STATEMENT COMPLETED

*END

%  ARC0009 ARCHIVE TERMINATED

(1)

ARCHIVE should output information relating to the volume pool from thedirectory file ARCHIVE.DIR.

(2)

The ARCHIVE report is output via SYSOUT. It contains the following information: VSN: VSNs of the save volumes contained in the volume pool in the directory file ARCHIVE.DIR. VOL.TYPE: volume type of the respective volume. Obsolete  volume types are displayed as follows: ?XX? where XX is the hex value of the volume type. CURRENT USE: The corresponding save version is listed for MT cartridge OS0320. MT cartridge OS0321 is still available (AVAILABLE). OWNER: The MT cartridges are entered in the volume pool with the POOL statement. EXP.DATE The expiration date has already been reached, so no entry is shown. Otherwise the expiration date is shown here.

Example 3

/START-ARCHIVE

%  BLS0990 PROCESSING OF REP FILE ':SBZ3:$TSOS.SYSREP.ARCHIVE.120' STARTED
%  ARCLOAD Program 'ARCHIVE', version '12.0A' of '2018-06-04' loaded  
           from file ':1OSH:$TSOS.SYSLNK.ARCHIVE.120'
%  ARCCOPY Copyright (C) FUJITSU TECHNOLOGY SOLUTIONS 2018. 
            All rights reserved  
%  ARC0001 ARCHIVE READY

*INQUIRE DIRECTORY=ARCHIVE.DIR,SV=OBSOLETE ————————————————— (1)

*   I N Q U I R E   C O M M A N D   L I S T I N G *** 
 
PARAMETER VALUES:-
CNS     = YES
 
INQUIRE DIRECTORY=ARCHIVE.DIR,SV=OBSOLETE
%  ARC0002 STATEMENT ACCEPTED. ARCHIVE SEQUENCE NUMBER 'A.100814.150820', 
           VERSION='12.0A'

%  ARC0003 ARCHIVE STATEMENT COMPLETED

*END

%  ARC0009 ARCHIVE TERMINATED

(1)

ARCHIVE is to output all the information on the obsolete save versions from the directory file ARCHIVE.DIR.

(2)

The report on the ARCHIVE run is output via SYSOUT and contains the following information: SAVE VERSION IDENTIFIER - S... - ON VOLUME TYPE TAPE-C4 (OBSOLETE)The specified save version in the directory file ARCHIVE.DIR is released for deletion; its retention period has expired. OPTIONS: Operands which were valid in the SAVE statement for the expired save version. Only YES or NO is displayed here for the ERASE operand. YES is also displayed if ERASE=ALL/ALLP/ALLPCNS/ALLCNS was specified in the SAVE statement. S/SAVE: The number of the parallel run. VSN(S): VSNs of the volumes of this save version.