CX10XDRS

Call CX10XDRS (or ERBXDRS) to request data from the most recently completed CMF Online interval in RMF MON III record format.

The result is a limited implementation of ERB3XDRS API - CX10XDRS to support only Db2 z/OS metrics and SDSF - Job Delay information.

To write a CALL to CX10XDRS, the following parameters must be coded in the specified order.

LINK EP=CX10XDRS,
     PARAM=(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)

The following table shows the format of the values that you assign to the parameters.

Parameter	Description		Format and length
answer_area_addr	address of the area where CMF returns the requested information The area can be in the caller’s primary address space or in an address or data space that is addressable through a public entry on the caller’s Dispatchable Unit Access List (DU-AL).		AL4
answer_area_alet	ALET of the answer area provided on the answer_area_addr parameter If the area resides in the caller’s primary address space, answer_area_alet must be 0.		FL4
answer_area_length	length of the answer area provided on the answer_area_addr parameter. Important If you do not provide enough length, CMF sets a return code and reason code, and places the necessary length in the answer_area_length parameter.		FL4
system_name	name of the system for which information is being requested This name 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. Important* For this support level, BMC supports only the local system. If you enter *ALL, only data from the local system is provided.		CL4
data_retrieval_parm	parameters for the retrieval of Monitor III data on each system Important The data_retrieval_parm is a structure variable with a length of 34 bytes that contains the start and end of the range for which data is requested and parameters that define the format of the returned data.		FL34
	start_time	date and time of the beginning of the time range for which information is requested. If you omit this information, a value of 14 blanks passes. CX10XDRS returns 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.	CL14 This field is validated for syntax. The value of this field is not used for this support level of CX10XDRS/ERB3XDRS. You can leave this field blank for this support level.
	end_time	date and time of the end of the time range for which information is requested If you omit this information, a value of 14 blanks passes. CX10XDRS returns 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, which specifies whether the set-of-samples data should be returned as a combined set-of-samples (as opposed to a sequence of individual sets-of-samples) Important For this support level, the value for df_ssos must be YES. YES—the individual sets-of-samples are combined into one common set-of-samples NO—the data is returned in individual sets-of-samples	CL3
	df_comp	data format compressed set-of-samples - specifies whether the set-of-samples data should be returned in compressed format Important For this support level, the value for df_comp must be NO. YES—the data is returned compressed NO—the data is returned uncompressed	CL3
data_retrieval_parm_length	length of the parameter string data_retrieval_parm		FL4
exit_name	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 exit_name must be the Db2 RMF exit routine or SDSF exit routine based on the caller. See the following required Db2 APARs for more information: PK62116: USE RMF-API FOR ADDING Z/OS CPU AND MEMORY METRICS TO IFI REC. 1 PK66373: RMF-DATA REDUCTION EXIT RELATED TO DB2 IFCID1 ENHANCEMENT		CL8
exit_parm	parameter string that might be passed to the routine that is 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.		CL5 up to 32768
exit_parm_length	length of the parameter string exit_parm that is passed to the routine specified in exit_name		FL4
time_out	time interval in seconds If the time interval expires during the processing of the service, CMF returns to the caller with a corresponding return code, reason code, and partial data. The default value of 60 overrides any value not given in the specified time.		FL4 the value is a non-negative number
return_code	return code when CX10XDRS is completed		FL4
reason_code	reason code when CX10XDRS is completed		FL4

Sample DSECT for the common answer area header

The following DSECT defines the common callable service answer area header. It precedes the DSECTs of the other API result areas.

XDRH     DSECT , Common Answer Area Header
XDRHNAM DC    CL4'DSQA' Acronym: DSQA, DSRA or XDGH
XDRHVER DC    F'1' Version: 1
XDRHLEN DC    F'0' Length of returned data
XDRHTLEN DC    F'0' Length needed for all data
XDRHPLX DC    CL8'PLEXNAME' Name of sysplex
XDRHSOF DC     A(XDRHSYS1-XDRH) Offset from hdr to 1st sys entry
XDRHSLN DC    F'16' Length of one sys entry
XDRHSNO DC    A(0) Number of sys entries
XDRHDOF DC    A(0) Offset from hdr to 1st data sec.
XDRHDLN DC    F'0' Length of one data section
XDRHDNO DC    A(0) Number of data sections
XDRS     DSECT , System entry: 1 per sys in plex
XDRSSNM DC    CL8'SYSNAME' MVS system name
XDRSSID DS    CL4 SMF system ID
XDRSRMF DS    X Status flags
XDRSCMAC EQU   X'80' CMF active on system
XDRSDBAC EQU   X'40' XDS Active on system
XDRSRSVF EQU   X'3F' Reserved bits
        DS     XL3 Reserved
*
XDRHSYS1 EQU XDRH+XDRHSIZE,XDRSSIZE 1st system entry

XDRHNAM	four-character acronym of the common header as follows: DSQA for CX10XDQY DSRA for CX10DSRC XDGH for CX10XDGS
XDRHVER	version of the common header (initially set to 1)
XDRHLEN	total length of the returned data
XDRHTLEN	total length of the answer area needed to contain all of the requested data
XDRHPLX	name of the sysplex on which the calling application is running
XDRHSOF	offset from the header to the first system list entry SNM
XDRHSLN	length of one system list entry (SNM,SID,CMF)
XDRHSNO	number of system list entries (SNM,SID,CMF)
XDRHDOF	offset from the header to the first data section For the detailed layout, refer to the individual data section explanations.
XDRHDLN	length of one data section For a variable length data section, this field is zero. In this case, the length is stored in the individual data section header.
XDRHDNO	number of returned data sections
XDRSSNM	eight-character system name
XDRSSID	four-character SMF system ID If CMF Online is not active on this system, this field contains hexadecimal zeros.
XDRSCMF	32-bit CMF status indicator containing XDRSCMAC, XDRSDBAC, and XDRSRVF The values of XDRSCMAC and XDRSDBAC are currently identical (either 0 or 1).
XDRSCMAC	bit 0 (high-order bit) indicates the status of CMF Online on this system ('1'B = active)
XDRSDBAC	bit 1 indicates the status of XDS on this system ('1'B = active)
XDRSRVF	bits 2 to 31 are reserved

Important

The XDRS DSECT repeats once for each system in the sysplex.

CX10XDRS

Sample DSECT for the common answer area header

On this page