NOT programming interface information
NOT programming interface information

ERB3XDRS - RMF Monitor III sysplex data retrieval service

Call ERB3XDRS to request a set-of-samples of Monitor III data from to the specified date and time range.

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

Table 1. ERB3XDRS Service
Service call statement Parameters
CALL ERB3XDRS

(answer_area_addr
,answer_area_alet
,answer_area_length
,system_name
,data_retrieval_parm
,data_retrieval_parm_length
,exit_name
,exit_parm
,exit_parm_length
,time_out
,return_code
,reason_code)

answer_area_addr
Specifies the address of the area to which 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 information is being requested. This is the four-character SMF system ID (SID). *ALL specifies that the request is to be sent to all systems in the sysplex. However, only the systems with a running Monitor III data gatherer session are able to return the requested data.

Define system_name as character variable of length 4.

,data_retrieval_parm
Specifies the parameters for the retrieval of Monitor III data on each system.
Define data_retrieval_parm as structure variable with a length of 34 bytes. This structure contains the start and end of the range for which data is requested, and parameters that define the format of the returned data. The layout of the 34-byte parameter area is as follows:
This figure shows the data retrieval parameter and is explained in the surrounding text.
start_time
Specifies the date and time of the beginning of the time range for which information is requested.
Define start_time as a character variable of length 14 in "sorted" format.
This figure shows the format of the start time and is explained in the surrounding text.

If you want to omit this information, pass a value of 14 blanks. ERB3XDRS will then return information for one Monitor III MINTIME, ending with or containing the date and time specified in end_time. If this parameter is omitted as well, information for the latest available MINTIME is returned.

end_time
Specifies the date and time of the end of the time range for which information is requested.

Define end_time as character variable of length 14 in the same "sorted" format as start_time.

If you want to omit this information, pass a value of 14 blanks. ERB3XDRS will then return information for one Monitor III MINTIME, starting with or containing the date and time specified in start_time. If this parameter is omitted as well, information for the latest available MINTIME is returned.

df_ssos
Data format Single Set-Of-Samples - specifies whether or not the set-of-samples data should be returned as a combined set-of-samples (as opposed to a sequence of individual sets-of-samples).
YES
the data is returned in a combined form, that is, the individual sets-of-samples are combined into one common set-of-samples.
NO
the data is returned in individual sets-of-samples.

Define df_ssos as character variable of length 3. If you specify NO, pad the string on the right with a blank.

df_comp
Data format Compressed Set-Of-Samples - specifies whether or not the set-of-samples data should be returned in compressed format
YES
the data is returned compressed (as it resides in the Monitor III data sets). This means that it will have to be decompressed using the RMF service ERB3RDEC.
NO
the data is returned uncompressed

Define df_comp as character variable of length 3. If you specify NO, pad the string on the right with a blank.

,data_retrieval_parm_length
Specifies the length of the parameter string data_retrieval_parm.

Define data_retrieval_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 set-of-samples data has been retrieved by RMF, this exit may call selected areas from the set-of-samples 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 ERB3XSOS, provided by IBM®, copies the complete data retrieved from the Monitor III data gatherer (the set-of-samples data) to the answer area. ERB3XSOS has no exit parameters.

Define exit_name as a 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 set-of-samples data areas that are to be returned to the caller.

Define exit_parm as a character variable of variable length, with a maximum of 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 an 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 an 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 ERB3XDRS completes, return_code contains the return code.

Define return_code as an unsigned integer variable of length 4.

For details see Return codes and reason codes.

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

Define reason_code as an 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