CSLZQRY: query request

In an IMSplex, you might want to query statistics about one or more components in the CSL. You can write an IMSplex member program, for example, an automated operator program (AOP), that uses the CSLZQRY request to obtain statistics. Any member of an IMSplex can issue the CSLZQRY request.

CSLZQRY syntax

CSLZQRY DSECT syntax

Use FUNC=DSECT to include equate (EQU) statements in your program for the CSLZQRY parameter list length and the CSLZQRY return and reason codes.


>>-CSLZQRY----FUNC=DSECT---------------------------------------><

CSLZQRY STATS syntax

Use FUNC=STATS to request statistics from ODBM, OM, RM, or SCI. The information that is returned from the CSLZQRY request is the same information that is passed to the STATS exit for that particular ODBM, OM, RM, or SCI.


>>-CSLZQRY----FUNC=STATS-| A |---------------------------------><

A

|--MBRNAME=mbrname--OUTPUT=outputbuffer------------------------->

>--OUTLEN=outputbufferlen--PARM=parm--+---------+--------------->
                                      '-ECB=ecb-'   

>--RETCODE=returncode--RSNCODE=reasoncode--SCITOKEN=scitoken----|

CSLZQRY parameters

ECB=symbol
ECB=(r2-r12): (Optional) - Specifies a z/OS® event control block (ECB) used for asynchronous requests. When the request is complete, the ECB specified is posted. If an ECB is not specified, the task is suspended until the request is complete. If an ECB is specified, the invoker of the request must issue a WAIT (or equivalent) after receiving control from CSLZQRY and before using or examining any data returned by this request (including the RETCODE and RSNCODE fields).
MBRNAME=symbol
MBRNAME=(r2-r12): (Required) - A 4-byte input parameter that specifies the address of the 8-byte CSL member name to which to send the query.
OUTLEN=symbol
OUTLEN=(r2-r12): (Required) - A 4-byte output parameter that is used to receive the length of the output buffer. When the request returns, this word contains the length of the buffer pointed to by the OUTPUT= parameter. The output length is zero if no output is built, for example, when an error is detected before any output can be built. When the caller is done with this storage, it is the caller's responsibility to release the storage by issuing a CSLSCBFR request.
OUTPUT=outputbuffer
OUTPUT=(r2-r12): (Required) - Specifies a 4-byte field to receive the address of the variable length output returned by the CSLZQRY request. The output contains the results of the CSLZQRY. The output length is returned in the OUTLEN= field. The output address is zero if no output was built, for example, if an error was detected before any output could be built. This buffer is not preallocated by the caller. When the caller is done with this storage, it is the caller's responsibility to release the storage by issuing a CSLSCBFR request.
PARM=symbol
PARM=(r2-r12): (Required) - Specifies the CSLZQRY parameter list. The length of the parameter list must be equal to the parameter list length EQU value defined by ZQRY_PARMLN.
RETCODE=symbol
RETCODE=(r2-r12): (Required) - Specifies a 4-byte field to receive the return code on output. This can be returned by ODBM, OM, RM, or SCI. ODBM return codes are defined in CSLDRR. OM return codes are defined in CSLORR. RM return codes are defined in CSLRRR. SCI return codes are defined in CSLSRR.
RSNCODE=symbol
RSNCODE=(r2-r12): (Required) - Specifies a 4-byte field to receive the reason code on output. This can be returned by ODBM, OM, RM, or SCI. ODBM reason codes are defined in CSLDRR. OM reason codes are defined in CSLORR. RM reason codes are defined in CSLRRR. SCI reason codes are defined in CSLSRR.
SCITOKEN=symbol
SCITOKEN=(r2-r12): (Required) - Specifies a 16-byte field containing the SCI token. This token uniquely identifies this connection to SCI. The SCI token was returned by a successful CSLSCREG FUNC=REGISTER request.

CSLZQRY return and reason codes

The following table lists the return and reason codes that can be returned on a CSLZQRY macro request. Also included is the meaning of a reason code (that is, what possibly caused it).

Table 1. CSLZQRY return and reason codes
Return code	Reason code	Meaning
X'00000000'	X'00000000'	The request completed successfully.
X'xx000008'	X'00002050'	The caller of the service attempted to pass an invalid parameter list. The request is rejected. "xx" identifies the component to set the return code.