NOT programming interface information
NOT programming interface information

ERB2XDGS - RMF Monitor II sysplex data gathering service

Call ERB2XDGS to request Monitor II data according to the specified SMF record type 79 (Monitor II) subtype.

Write the CALL for ERB2XDGS as shown, coding all parameters in the specified order. For parameters that ERB2XDGS uses to obtain input values, assign values that are acceptable to ERB2XDGS.

Table 1. ERB2XDGS Service
Service call statement Parameters
CALL ERB2XDGS

(answer_area_addr
,answer_area_alet
,answer_area_length
,system_name
,data_gatherer_parm
,data_gatherer_parm_length
,exit_name
,exit_parm
,exit_parm_length
,time_out
,return_code
,reason_code)

answer_area_addr
Specifies the address of the area where RMF™ returns the requested information. The area can be in the calling program's primary address space, or in an address or data space addressable through a public entry on the calling program's dispatchable unit access list (DU-AL).

Define answer_area_addr as pointer variable of length 4.

,answer_area_alet
Specifies the ALET of the answer area provided on the answer_area_addr parameter. If the area resides in the calling program's primary address space, answer_area_alet must be 0.

Define answer_area_alet as unsigned integer variable of length 4.

,answer_area_length
Specifies the length of the answer area provided on the answer_area_addr parameter. If you do not provide enough space, RMF lets you know how much space you should have provided. The answer_area_length input/output parameter contains the length needed for the complete data.

Define answer_area_length as unsigned integer variable of length 4.

,system_name
Specifies the name of the system for which you are requesting information. This is the four character SMF system identification (SID). *ALL specifies that the request is to be sent to all systems in the sysplex.

Define system_name as character variable of length 4.

,data_gatherer_parm
Specifies the parameters for the Monitor II data gatherer on each system.
Define data_gatherer_parm as structure variable of variable length. The layout of the parameter area is as follows:
This figure shows the data gatherer parameter and is explained in the surrounding text.
where:
rty
Specifies the SMF record type of the requested Monitor II data.

Define rty as unsigned integer variable of length 2.

sty
Specifies the SMF record subtype of the requested Monitor II data.

Define sty as unsigned integer variable of length 2.

dg_options
Specifies options for the Monitor II data gatherer for the specified SMF record type and subtype.

Define dg_options as character variable of variable length, maximum 32.

You find a list of all subtypes in Overview.

Example: You want to receive data that is equivalent to the Monitor II command
SENQ D
This requires the following values for this parameter:
rty
SMF record type - 79
sty
SMF record subtype for the SENQ - 07
dg_options
Command option - D
This results in the value '7907D' for the data gatherer parameter.
,data_gatherer_parm_length
Specifies the length of the parameter string data_gatherer_parm.

Define data_gatherer_parm_length as unsigned integer variable of length 4.

,exit_name
Specifies the name of a data reduction exit routine that is invoked by RMF on each system from which data is requested. After the Monitor II data has been retrieved by RMF, this exit may call selected areas from the data to the answer area provided by RMF. These data areas are then combined into the answer area provided by the caller on the requesting system.

The data reduction exit routine ERB2XSMF, provided by IBM®, copies the complete data gathered by the Monitor II data gatherer (SMF record type 79) to the answer area. ERB2XSMF has no exit parameters.

Define exit_name as character variable of length 8.

,exit_parm
Specifies a parameter string that may be passed to the routine specified in exit_name. Use this parameter to control the selection of Monitor II data areas to be returned to the caller.

Define exit_parm as character variable of variable length, maximum 32768.

,exit_parm_length
Specifies the length of the parameter string exit_parm that is passed to the routine specified in exit_name.

Define exit_parm_length as unsigned integer variable of length 4.

,time_out
Specifies a time interval in seconds. If this time interval expires during the processing of the service, RMF returns to the caller with a corresponding return and reason code and partial data.

Define time_out as unsigned integer variable of length 4.

The specification of a non-positive value will cause RMF to use a default value of 60.

,return_code
When ERB2XDGS completes, return_code contains the return code.

Define return_code as unsigned integer variable of length 4.

For details see Return codes and reason codes.

,reason_code
When ERB2XDGS completes, reason_code contains the reason code.

Define reason_code as unsigned integer variable of length 4.

For details see Return codes and reason codes.

End of NOT programming interface information
End of NOT programming interface information