PURGE Delete from directory file

This statement permits save versions whose retention period has expired to be deleted from the directory file.

PU[RGE]

DIR[ECTORY] = ARCHIVE.DIR / filename

,SV = OBS[OLETE] / svid / (svid,...) / backup,date[.time]
,FORCE = NO / YES

,NOW = YES / NO[,TIME = sec]
[,P[ASSWORD] = password / (password,...)]
,L[IST] = { SYSLST / SYSOUT / BOTH / NONE } [,ALL]

DIRECTORY = ARCHIVE.DIR / filename
This specifies the directory file to be processed.

SV =
This defines the save versions to be deleted.

SV = OBSOLETE
All the save versions whose retention period has expired are deleted from the specified directory file.

SV = svid / (svid,...)
This specifies the save version(s) to be deleted. Any save version specified is deleted only if its retention period has expired or if FORCE=YES is specified.

SV = backup,date.time
The save versions created with the specified BACKUP entry before or at the time and date given and whose retention period has expired, are deleted from the directory file.

FORCE =
This determines whether save versions that are still valid should be deleted.

FORCE = NO
Only the obsolete save versions are deleted.

FORCE = YES
All explicitly specified save versions are deleted. From ARCHIVE V12.0E, the warning message ARC0824 is issued at the console for each save version deleted with the option.

NOW =
This operand specifies when the statement is to be executed.

NOW = YES
The PURGE statement is executed immediately.

NOW = NO
The PURGE statement is checked for correct syntax and then written to the queue file ARCHIVE.LATER. This process is given the ARCHIVE identifier L.yymmdd.hhmmss. The identifier is only allocated if no LATER job exists in the same task at the time. If this is not the case, the process is stored under the existing identifier.
The LATER job can be started by means of a PROCESS statement or deleted by means of a DELETE statement.

NOW = NO,TIME=sec
The number of CPU seconds that are available to this process when it is started. This entry corresponds to the operand CPU-LIMIT in /START-(EXECUTABLE-)PROGRAM.

PASSWORD = password / (password,...)
If you specify the operand NOW=NO, you must enter here the passwords for

• the directory file, if it is protected by a write password and is not under TSOS.

• the save version, if it has been protected by a password with SVPASS.

• magnetic tapes and MT cartridges that are protected by a password (up to 4 characters) under MAREN.

In all other cases, you should enter the passwords with the /ADD-PASSWORD command before ARCHIVE is called. Only in this case are the passwords also valid for the subsequent ARCHIVE runs of the same user job.

The system support must enter the password for the directory file if this file is assigned under another user ID.

LIST =
This specifies the output medium. The deleted save version and its associated volumes are output.

LIST = SYSLST
A list of the deleted save versions and tapes is output to SYSLST.

LIST = SYSOUT
A list of the deleted save versions and tapes is output to SYSOUT.

LIST = BOTH
Output is directed to both SYSLST and SYSOUT.

LIST = NONE
The deleted save versions are not output.

LIST = ...,ALL
In addition to the save versions and volumes all the information about the relevant files and job variables is output.

Notes on PURGE

• If the files belonging to a deleted save version are on disk, these files are also deleted. Any tapes which become free and were not entered in the directory file by means of the POOL statement, but were assigned to a save version via the TAPES/VOLUME operand, via MAREN or by interrogation at the console, are purged from the pool.

• Tapes given the status UNUSABLE because they could not be opened owing to an unrecoverable write error are not purged from the directory file. The user must remove them from the directory file himself by means of the POOL statement (REMOVE operand).

• An ARCHIVE run with PURGE ...,FORCE=YES also deletes save versions whose retention period has not yet expired. Tapes on which this save version is stored are not released in the process. These tapes cannot be used until the expiration date has been reached.

• The following steps must be carried out in order to return a tape whose retention period has not yet expired to the pool:

  1. Delete all the save versions with the statement PURGE ..., FORCE=YES.

  2. Delete the tape with the volume serial number vsn from the pool of the specified directory file with the statement POOL REMOVE=vsn.

  3. Initialize the tape again with the aid of the INIT utility routine (see the “Utility Routines” manual [1]).

  4. Add the tape with the volume serial number vsn to the pool of the specified directory file with the statement POOL ADD=vsn.

Example

/START-ARCHIVE

%  BLS0990 PROCESSING OF REP FILE ':SBZ3:$TSOS.SYSREP.ARCHIVE.120' STARTED
%  ARCLOAD Program 'ARCHIVE', version '12.0E' of '2023-06-04' loaded 
           from file ':SBZ3:$TSOS.SYSLNK.ARCHIVE.120'
%  ARCCOPY Copyright (C) 2022 Fujitsu Technology Solutions GmbH. All rights reserved 
%  ARC0001 ARCHIVE READY

*PURGE DIRECTORY=ARCHIVE.DIR.B,SV=OBSOLETE,LIST=SYSOUT ————————————————  (1)

*       P U R G E   C O M M A N D   L I S T I N G ***
 
PURGE DIRECTORY=ARCHIVE.DIR.B,SV=OBSOLETE,LIST=SYSOUT
%  ARC0002 STATEMENT ACCEPTED. ARCHIVE SEQUENCE NUMBER 'A.200823.145228',
           VERSION='12.0E' 
%  MARM121 MAREN CATALOG ENTRY 'OS0427'/'0001' MODIFIED
*           ***        P U R G E   A R C H I V E   R E P O R T  *** ———  (2) 
                                    DIRECTORY - $TSOS.ARCHIVE.DIR.B
     SAVE VERSION         VSNS
 
   S.100822.145211       OS0427
            ***      E N D   O F   A R C H I V E   R E P O R T  *** 
%  ARC0003 ARCHIVE STATEMENT COMPLETED

*END

%  ARC0009 ARCHIVE TERMINATED

(1)	ARCHIVE is to delete from the directory file ARCHIVE.DIR all save versions whose retention periods have expired and to output the log via SYSOUT.
(2)	The ARCHIVE report is output via SYSOUT. It contains the following information: SAVE VERSION: Name of the deleted save version. VSNS: VSN of the volume which was occupied by the deleted save version. The volume is available again.