Subparameters for REQUEST=XQUERY

REQUEST=XQUERY
Returns status information on an XRC session. The information will be in the MESSAGES buffer.
,SID=sid
A required input character field containing the XRC session ID to which the request is sent. The ID is left-justified and padded on the right with blanks.

When an ETYPE parameter value ENVIRONMENTP, ENVIRONMENTH, or ENVIRONMENTF is specified with an SID value that represents an inactive or undefined session, values for the control address space (ANTAS000) are reported. These values are the default environment values plus any overrides from the ANTXIN00 parmlib member.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 8-character field.

,RETINFO=retinfo
A required output parameter field that is used to return detailed information about the results of executing the request. Information about the results of scheduling the request are returned in the RETCODE and RSNCODE fields. Align the area on a word boundary. The first 4-bytes contain the return code and the second 4-bytes contain the reason code. The remainder of the information is dependent on the return and reason codes. See the coding example SDM API usability guide about how to coordinate the RETCODE, RSNCODE, and RETINFO fields.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 100-character output field.

FEATURES=features
Specifies that the requested report display the LIC features available to the storage controls. A required output parameter used together with the STORAGECONTROL keyword, produces an XQUERY STORAGECONTROL_FEATURES report. The report shows identification, capability, and function enablement information about each storage control session.
Start of changeXFEATURES=featuresEnd of change
Start of changeSpecifies that the requested report is an XQUERY STORAGECONTROL XFEATURES report, which shows information related to workload-based write pacing.End of change
,MESSAGES=messages
A required output parameter field in which ANTRQST will place the address of a buffer containing messages about the results of executing the request. These are the messages that would have been returned to the caller if the TSO interface had been used. If there are no messages, the address will be zero.
An ANTRQST message buffer has the following format:
  • Bytes 1-4 contain the size of the ANTRQST message buffer.
  • Byte 5 contains the subpool of the ANTRQST message buffer.
  • Byte 6 is not used.
  • Bytes 7-8 contain the number of messages in the array that follows.

The rest of the message buffer is an array of messages. Each message has the following format:

  • Bytes 1-2 contain the size of the message in bytes 3-x.
  • Bytes 3-x contain the message.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 4-character field.

,ECB=ecb
,ECB=NO_ECB
An optional input parameter field that SDM posts for an asynchronous request. This field is ignored for synchronous requests.

The default is NO_ECB.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,ETYPE=etype
,ETYPE=SUMMARY
An optional input parameter field that specifies which query command to execute. The value is left-justified and padded on the right with blanks. If the field contains binary zeros, the program uses the default. The following options are available:
  • CONFIGURATION — says an XQUERY CONFIGURATION report is wanted.
  • ENVIRONMENTF — says an XQUERY ENVIRONMENT(FLAG) report is wanted.
  • ENVIRONMENTH — says an XQUERY ENVIRONMENT(PATCH) report is wanted.
  • ENVIRONMENTP — says an XQUERY ENVIRONMENT(PARMLIB) report is wanted.
  • DETAIL — says an XQUERY VOLUME_DETAIL report is wanted.
  • DETAILS — says an XQUERY STORAGECONTROL DETAIL report is wanted.
  • MASTER — says an XQUERY MASTER report is wanted.
  • PACE— says an XQUERY PACE report is wanted.
  • SET — says an XQUERY SET report is wanted.
  • STORAGECONTROL — says an XQUERY STORAGECONTROL report is wanted.
  • SUMMARY — says an XQUERY SUMMARY report is wanted . This is the default.
  • VOLUME — says an XQUERY VOLUME report is wanted.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional 16-character field.

,MHLQ=mhlq
,MHLQ=SYS1
An optional input parameter field containing the high level qualifier of the Master Control data set. The name is left justified and padded on the right with blanks. If the field contains binary zeros, the default is used. This field is used only if the MASTER option is specified in the ETYPE keyword.

The default is SYS1.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,SCSESSION=scsession
,SCSESSION=––
An optional input field that contains an alphabetic value that allows requesting that only volumes in the specified storage control session be displayed. The value is left justified and padded on the right with blanks. If the field contains binary zeros, the default is used. This field is ignored for all ETYPEs except DETAIL and VOLUME.

The default is ––.

To code: Specify the RS-type address, or address in register (2)-(12) of an optional 2-character field.

,SSID=ssid
An optional input field that contains a 2–byte hexadecimal number, left justified, that allows requesting that only volumes in the specified storage subsystem be displayed. This field is ignored for all ETYPEs except DETAIL and VOLUME.

To code: Specify the RS-type address, or address in register (2)-(12) of an optional 3-character field.

,WAITTIME=waittime
,WAITTIME=0
An optional halfword input parameter field containing how long in seconds SDM will wait for a request to complete. A value of zero says to not time the request. If the time expires before the request is complete a value of 7039 (RQST_WAITTIME_EXPIRED [see ANTRQSTL]) will be returned. If the request is a synchronous request, the value will be placed in the return code part of RETINFO. If the request is an asynchronous request, the value will be used as the ECB post code.

The default is 0.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional halfword input field.