Subparameters for REQUEST=XSCSTATS

REQUEST=XSCSTATS
Provides statistics for storage control System Data Mover sessions known to the system this command is executed on.
,QRYSIZE=qrysize
A required input field that contains the length of the QRYINFO area.

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

,QRYINFO=qryinfo
A required variable character output field that is used to return the results of the query.

If the field is not big enough to contain the complete result a return code of 7661 (RQST_XSCSTATS_QRYSIZE_TOO_SMALL) will be placed in the return code part of RETINFO and the total amount of space required will be placed in the reason code for RETINFO.

If the field is big enough to contain the complete result, a return code of 7662 (RQST_XSCSTATS_QRYSIZE_BIG_ENOUGH) will be placed in the return code part of RETINFO, and the total amount of space actually used will be placed in the reason code part of RETINFO.

An ANTRQST XSCSTATS RESULTS buffer has the following format:
  • Bytes 1-6 contain the eye-catcher XSTATS.
  • Bytes 7-8 contain the number of storage control data mover session entries provided in the remainder of the results buffer. Statistics for both concurrent copy (CC) and extended remote copy (XRC) are provided in the results buffer.

The rest of the results buffer depends on the ETYPE value used on the request. If ETYPE(SUMMARY) was specified or no ETYPE value was specified (the default is SUMMARY), the remainder of the results buffer are 32-byte entries of statistics for each storage control session (as indicated by the number found in bytes 7 and 8). If ETYPE(SINGLE) was specified, a single 32-byte entry is provided followed by 8-byte entries for each of the devices in the single storage control session requested.

Each storage control session entry contains the following 32 bytes of statistics:
  • Bytes 1–2 contain the Storage Subsystem Identifier (SSID).
  • Bytes 3–4 contain the storage control session identifier (scsession):
    • Byte 3:
      • Bit 1–0
      • Bit 2–0
      • Bit 3–0
      • Bit 4:
        • 0 – Concurrent Copy (CC) session
        • 1 – Extended Remote Copy (XRC) session
      • Bit 5 – request for status came in on the same path group that owns the session
      • Bit 6 – internally terminated
      • Bit 7 – suspended
      • Bit 8 – quiesced
    • Byte 4 is the actual scession number.
  • Bytes 5–6 contains the record set count for the scession.
  • Byte 7 contains the Channel Connection Address (CCA) for the next utility device to use.
  • Byte 8 contains the scession status information:
    • Bit 1 – scession is suspended
    • Bit 2 – in long busy because the sidefile is 60 percent of cache
    • Bit 3 – in long busy because residual count is > 63K
    • Bit 4 – utility device is fixed
    • Bits 5–8 – 0
  • Bytes 9–10 contain the size of the largest record set
  • Bytes 11–14 contain the number of 4K segments in the sidefile
  • Bytes 15–18 contain the number of 4K segments which represents 60 percent of the cache size
  • Bytes 19–26 contain the scession's current session time in TOD format.
  • Bytes 27–28 contain the time remaining until the scession times out.
  • Bytes 29–30 contain the number of devices belonging to the SCESSION.
  • Bytes 31–32 contain the number of devices that are in device blocking.
  • Byte 33 If ETYPE(SINGLE) is specified, starting at byte 33, statistics for each of the devices in the single control session requested are provided. Bytes 29–30 indicate the number of 8-byte areas that follow. Each 8-byte device statistics area contains the following information:
    • Bytes 1–2 contain the device number of the device. The device number is only available if the device is online to the system which processed the request.
    • Bytes 3–4 contain the CCA of the device.
    • Bytes 5–6 contain the threshold count for the device. The threshold count is only available for the XRC storage control sessions.
    • Bytes 7–8 contain the record set count for the device. The record set count is only available for XRC storage control sessions.
Note:
  1. A storage control must have at least one device online for it's statistics to be gathered.
  2. A storage control session must have at least one device online for it's complete statistics to be gathered.

To code: Specify the RS-type address, or address in register (2)-(12), of a required variable character output 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.

,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 what type of statistics should be returned. The value is left justified and padded on the right with blanks. The following options are available for use:
  • SUMMARY — says to return a summary of the data mover sessions (scsessions) being maintained in the storage controls attached to the system. The format of the returned data is that described by the returned message buffer description WITHOUT the array of device statistics. The field containing the number of devices will be filled in, along with the field telling how many devices are in device blocking. The size of the statistics for each session is 32–bytes, plus 8–bytes for a header. So, if there are five scsessions the size of a buffer to hold all of the information is 168–bytes (8 + 5 * 32).
  • SINGLE — says to return a complete set of statistics for a specified scsession. SSID and SCSESSION must be specified to allow locating the session. The format of the returned data is that described by the returned message buffer description. The count found in bytes 7–8 will be one. The size of the returned message buffer is 8–bytes for the header, plus 32–bytes for the general scession statistics, plus 8–bytes for each device in the scsession. So, if an scsession has five devices the size of the buffer will be 80–bytes (8 + 32 + 5 * 8). An scsession has between 1 and 256 devices.

The default is SUMMARY.

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

,SCSESSION=scsession
,SCSESSION=––
An optional character input field that allows specifying what storage control session identifier (SCID on the XQUERY VOLUME_DETAIL_REPORT) will be used to gather statistics. Specify a two byte hexadecimal number, left justified. For example, the storage control session identifier of X'03' would be specified as X'0300'.

The default is ––

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

,SSID=ssid
An optional character input field that allows specifying what storage control will be used to gather statistics. A two byte hexadecimal number, left justified.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional 3-character input 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.