IBM Hydra HVT Information Area Output Exits

This section provides descriptions of the VTS component standard user output exits that are invoked during the output phase of daily update processing for the IBM TS7700 Hydra Virtual Tape Subsystem Information Area (HVT) files.
micsrm140
This section provides descriptions of the VTS component standard user output exits that are invoked during the output phase of daily update processing for the IBM TS7700 Hydra Virtual Tape Subsystem Information Area (HVT) files.
Contents
General Information for Output Exits
Each exit description includes the user exit name and title, a description of its purpose, and when it is invoked. It also shows which data elements are available and any special considerations.
Exit code must not issue either RETURN or DELETE statements since their invocation assumes the entire DATA step will be executed.
Exit code can set SKIP_REC = 1 to prevent the current observation from being written to the output file.
All VTS component output exits use the indirect form of exit invocation. For general information about indirect exits, see Indirect Exit Points, of the System Modification Guide.
Output Exits for the HVT Information Area Files
Two types of output exits are available for each HVT Information Area file:
  • USRSfff exits - invoked prior to output to WORK.HVTfff
HVT Information Area USRSfff Exits
All HVT Information Area USRSfff exits are invoked when the raw data record is still in the input buffer. They generally have access to DETAIL timespan data elements for their respective files, regardless of the element activation status (on or off). Data elements turned off in the DETAIL timespan are not kept in the file, but in most cases were populated during the input record parsing.
Note:
The HVTHCA file is the only file not produced directly from reading raw data and, as a result, has no user exit. It is created by merging the HVTVDA and HVTHHA files. Any user exit processing in the HVTVDA or HVTHHA files will also affect the HVTHCA file.
To minimize work space requirements, derived data elements are not computed before being output to the work files. If USRSfff exit code must examine derived data element values, the %fffDERV(TS=DETAIL) macro can be used to compute the derived data element values within the USRSfff exits. If the %fffDERV macro is invoked, the derived data elements will be computed, but not kept in the work file.
All modifications made in the USRSfff exits are propagated from the work files to the
MICS
database files.
USRSVDA
Exit Prior to Output of WORK.HVTVDA
Description
The USRSVDA exit allows access to the data elements used to create Hydra Vnode Device Activity (HVTVDA) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval channel I/O statistics and concurrent virtual drive activity for the cluster's Vnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTVDA file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTVDA file. In addition, individual HVTVDA observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTVDA file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSVAP
Exit Prior to Output of WORK.HVTVAP
Description
The USRSVAP exit allows access to the data elements used to create Hydra Vnode Adapter Port Activity (HVTVAP) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval I/O statistics for each Host Bus Adapter (HBA) at the port level for this cluster's Vnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTVAP file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTVAP file. In addition, individual HVTVAP observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTVAP file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHHC
Exit Prior to Output of WORK.HVTHHC
Description
The USRSHHC exit allows access to the data elements used to create Hydra Hnode Cache Activity (HVTHHC) WORK file observations. At the point where this exit is invoked, the observation contains the 15-minute interval disk cache utilization and virtual tape mount activity for this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHHC file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHHC file. In addition, individual HVTHHC observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHHC file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHCP
Exit Prior to Output of WORK.HVTHCP
Description
The USRSHCP exit allows access to the data elements used to create Hnode Cache Partition Activity (HVTHCP) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval disk cache utilization and virtual tape mount activity within each cache partition for this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHCP file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHCP file. In addition, individual HVTHCP observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHCP file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHPG
Exit Prior to Output of WORK.HVTHPG
Description
The USRSHPG exit allows access to the data elements used to create Hydra Hnode Cache Pref Grp Statistics (HVTHPG) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval age statistics of virtual volumes in each preference group within each cache partition for this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHPG file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHPG file. In addition, individual HVTHPG observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHPG file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHPD
Exit Prior to Output of WORK.HVTHPD
Description
The USRSHPD exit allows access to the data elements used to create Hydra Hnode Physical Drive Activity (HVTHPD) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics on physical tape drive activity by device class for this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHPD file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHPD file. In addition, individual HVTHPD observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements
Available All DETAIL timespan HVTHPD file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHGP
Exit Prior to Output of WORK.HVTHGP
Description
The USRSHGP exit allows access to the data elements used to create Hydra Hnode G-Use Pool Activity (HVTHGP) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics for each of the possible 32 general use pools that can be defined in this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHGP file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHGP file. In addition, individual HVTHGP observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHGP file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHGM
Exit Prior to Output of WORK.HVTHGM
Description
The USRSHGM exit allows access to the data elements used to create Hydra Hnode G-Use Pool Media Activity (HVTHGM) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics for each of the 8 possible media types in each of the general use pools defined in this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHGM file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHGM file. In addition, individual HVTHGM observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHGM file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHHA
Exit Prior to Output of WORK.HVTHHA
Description
The USRSHHA exit allows access to the data elements used to create Hydra Hnode Activity (HVTHHA) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics on all node level statistics in this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHHA file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHHA file. In addition, individual HVTHHA observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHHA file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSHEI
Exit Prior to Output of WORK.HVTHEI
Description
The USRSHEI exit allows access to the data elements used to create Hydra Hnode Export/Import Activity (HVTHEI) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics on the export/import activity in this cluster's Hnode.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTHEI file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTHEI file. In addition, individual HVTHEI observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTHEI file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSGRC
Exit Prior to Output of WORK.HVTGRC
Description
The USRSGRC exit allows access to the data elements used to create Hnode Grid Activity (HVTGRC) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics on end-of-interval snapshot statistics on the queue depth for data and virtual volumes that are still scheduled to be copied to another cluster in the grid from this cluster.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTGRC file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTGRC file. In addition, individual HVTGRC observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements
Available All DETAIL timespan HVTGRC file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSGCC
Exit Prior to Output of WORK.HVTGCC
Description
The USRSGCC exit allows access to the data elements used to create Hnode Grid Cluster Activity (HVTGCC) work file observations. At the point where this exit is invoked, the observation contains the 15-minute interval statistics on the amount of data transferred to other clusters in the grid during the interval from this cluster.
Invocation
This exit gains control immediately before the output of a record to the WORK.HVTGCC file.
Uses
This exit can be used to examine, modify, or assign values to data elements before they are output to the WORK.HVTGCC file. In addition, individual HVTGCC observations can be prevented from being output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan HVTGCC file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None