Tivoli Header

Quick Start


Setting Up Tape Installation-Wide Exits

You must use the deletion installation-wide exit to notify your tape management system that the Tivoli Storage Manager server has deleted a tape from its database. This exit can provide a tape management system with the information required to maintain an accurate inventory of TSM tapes. However, you do not have to use this exit to use tapes with TSM.

The deletion exit is called when the TSM server is returning a tape to scratch because it no longer contains valid files, and when the DELETE VOLUME command is used to delete a volume from the database. The tape volume is deleted from the TSM server database before the deletion exit is called.

The deletion exit allows your tape management system to accurately reflect the server tape usage. You need to use the tape management system facilities to notify itself that the server has deleted the tape from its database.

After the deletion exit notifies the tape management system, it returns control to the server. Tape deletions cannot be cancelled.

If you are using DFSMSrmm or DFRMM, the vital record specification policy is used to determine the management of the volume. If you are using a different tape management system, it should recognize that the volume is being managed by an external data manager (EDM). It should then ensure that only TSM has access until the volume is returned to the tape management system.

Identifying the Deletion Exit to the Server

To use the deletion exit, specify the module in the DELETIONEXIT option in the server options file. If you are using a tape management system, specify the module name of the deletion exit provided by the tape management system. For example, if you are using the DFSMShsm ARCTVEXT module, specify:

+--------------------------------------------------------------------------------+
|deletionexit arctvext                                                           |
+--------------------------------------------------------------------------------+
EDGTVEXT, which replaced ARCTVEXT by DFSMS 1.4, can be used as the deletion exit.

Writing the Deletion Exit

If you are using the DFSMShsm ARCTVEXT exit, the DFSMSrmm EDGTVEXT, or a deletion exit supplied with a tape management system, include the coding required for the TSM deletion exit in your existing exit. The coding considerations for this exit are the same as those for the DFSMShsm ARCTVEXT exit and the DFSMSrmm EDGTVEXT, including entry and exit linkage. A non-zero return code or abend in the exit results in an error message, but has no other effect on TSM processing.

The deletion exit must be reentrant and can run in either 24-bit or 31-bit addressing mode.

Registers on Entry to the Deletion Exit

The registers contain the following information on entry to the deletion exit:

Register
Description

1
The address of the parameter list passed to the exit.

13
The address of a 72-byte standard MVS save area.

14
The address to which the exit must return control.

15
The address of the deletion exit.

0, 2-12
These registers contain nothing of use to the exit.

Deletion Exit Parameter List

Table 12 shows the parameter list passed to the tape deletion exit. Register 1 contains the address of this parameter list.

Table 12. Deletion Exit Parameter List

Offset Length (bytes) Data Type Description
0 (X'00') 4 Address of the data area Pointer to an 8-byte data area containing information about the volume the server has deleted from its database. Table 13 shows the format of the data area.
4 (X'04') 4 Address of the return code The address of a full word containing the return code that the exit must set after completing processing. The return code is binary, and should be 0 if processing is successful, or any other number if processing is unsuccessful. TSM generates an error message if processing is unsuccessful. The high order bit of the return code address is set to 1.

Table 13 shows the format of the data area pointed to by the deletion exit parameter list.

Table 13. Deletion Exit Data Area

Offset Length Data Type or Bit Pattern Description
0 (X'00') 6 Character The volume serial number of the tape volume deleted from the database
6 (X'06') 2 Binary Informational flags
    1... .... .... .... The tape volume is purged from the server's database.
    .1.. .... .... .... The server has protected the files on the volume with expiration dates. This information is determined from the device class associated with the volume.
Note:
If the expiration or retention information on the device class has changed after the volume was first used, this informational flag may be incorrect.
    .... .... 1... .... The DFSMShsm SCRATCHTAPE option was used on the SETSYS TAPEDELETION command for this tape category.
    .... .... .... ..1. This is a backup tape.

Registers on Exit from the Deletion Exit

When you return control to the server, restore the registers to the values they had on entry.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]