Parameter Descriptions

The parameter descriptions are listed in alphabetical order. Default values are underlined:

,AMDALEVEL=0

,AMDALEVEL=amdalevel

Use this input parameter to specify the level of the IXLYAMDA record mappings that the system returns in the answer area. Valid values are 0 and 1.

A value of 0 indicates that base level IXLYAMDA records will be returned.
A value of 1 indicates that level-1 IXLYAMDA records will be returned. To request a level-1 IXLYAMDA record, use version 1 of the IXLMG macro by specifying AMDALEVEL=1.

,CFNAME=ALL_CFS

,CFNAME=cfname

Use this input parameter to specify the name of the coupling facility for which data is to be gathered or to indicate that data is to be collected for all coupling facilities that are attached to the system on which the IXLMG macro is issued. If not specified, information about all coupling facilities that have a configured attachment to the system on which the IXLMG macro is invoked will be gathered. If CFNAME specifies a coupling facility name, the coupling facility and all allocated structures will be included in the reported data.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the eight-character field that contains the name of the coupling facility for which data is to be gathered.

,COCLASSB=NO_COCLASSB

,COCLASSB=coclassb

Use this input parameter to specify the first cast-out class to be reported on for a cache structure. The specified value must fall within the range of 1 to the maximum coupling facility class value defined for the structure, inclusive. (The number of cast-out classes is determined on the IXLCONN macro.)

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the two-byte field that contains the first cast-out class in the range of cast-out classes to be reported on.

,COCLASSE=coclasse

Use this input parameter to specify the last cast-out class to be reported on for a cache structure. The specified value must fall within the range 1 to the maximum cast-out class value defined for the structure, inclusive, and be greater than or equal to the value for COCLASSB.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a two-byte field that contains the last cast-out class in the range of cast-out classes to be reported on.

DATAAREA=dataarea

Use this output parameter to identify the name of the output storage area that is to contain the measurement data returned by the measurement gathering routine. The storage area is defined by the macro IXLYAMDA. The storage area provided must be in fixed or disabled reference storage.

This macro does not clear the caller's storage area. It is the caller's responsibility to clear the area, if this is required.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the name of the storage area to contain the measurement data.

,DATALEN=datalen

Use the input parameter to specify the length of the storage area to contain the measurement data returned by the measurement gathering routine.

Use the IXLYAMDA macro to determine the length of the DATAAREA by determining the length of each section that you request and how many times each section will be repeated.

The minimum length is the length of the IXLYAMDA header. If the DATAAREA is not large enough to hold all the data requested, a return code X'4' with a reason code of IXLRSNCODEMOREDATA will be returned. The length of the output data will be returned in the IXLYAMDA, in the field IXLYAMDAREA_TLEN.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the fullword field that contains the length of the storage area.

,HWSTATISTICS=YES

,HWSTATISTICS=NO

,HWSTATISTICS=CF

Use this input parameter to indicate whether the statistics gathered from the coupling facility should be included in the measurement data. The statistics include coupling facility measurement information and structure control information.

YES: Include statistics gathered from the coupling facility in the returned measurement data.
NO: Do not include statistics gathered from the coupling facility in the returned measurement data.
CF: Include statistics gathered from the coupling facility only for coupling facility measurement information, and not for structure control information.

Note:

If HWSTATISTICS=YES is specified, the data will include information retrieved from the coupling facility, specifically structure control information for each structure and measurement data for each coupling facility. The data returned will contain information on all allocated structures in the coupling facility whether the structure has an active connector from the system on which IXLMG was invoked or not. This information could contain structures not currently known in the CFRM active policy.
- The data returned for structures with active connectors from the system on which IXLMG was invoked contains both structure usage and control information.
- The data returned for structures with no active connectors from the system on which IXLMG was invoked contains only structure control information.
- The data returned for each coupling facility contains coupling facility usage, control, and measurement information.
If HWSTATISTICS=NO is specified, the data will not include structure control information or facility measurement information retrieved from the coupling facility.
- The data returned for structures with active connectors from the system on which IXLMG was invoked contains structure usage information.
- No data is returned for structures with no active connectors from the system on which IXLMG was invoked.
- The data returned for each coupling facility contains coupling facility usage and control information.
If HWSTATISTICS=CF is specified, the data will include measurement data for each coupling facility retrieved from the coupling facility but will not include the structure control information for each structure.
- The data returned for structures with active connectors from the system on which IXLMG was invoked contains structure usage information.
- No data is returned for structures with no active connectors from the system on which IXLMG was invoked.
- The data returned for each coupling facility contains coupling facility usage, control, and measurement information.

,MF=S

,MF=(L,mfctrl)

,MF=(L,mfctrl,mfattr)

,MF=(L,mfctrl,0D)

,MF=(E,mfctrl)

,MF=(E,mfctrl,COMPLETE)

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter can be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,mfctrl: Use this output parameter to specify a storage area to contain the parameters.
To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list.
,mfattr: Use this input parameter to specify the name of a 1- to 60-character string that can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list. If you do not code mfattr, the system provides a value of 0D, which forces the parameter list to a doubleword boundary.
,COMPLETE: Use this input parameter to require that the system check for required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional parameters that are not documented here. The ones that are not documented do not have any effect on the macro. For example, if SMILE=var were an optional parameter and the default is SMILE=NO_SMILE then it would not be documented. However, if the default was SMILE=:-), then it would be documented because a value would be the default.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=plistver

Use this input parameter to specify the version of the macro. See Understanding IXLMG Version Support for a description of the options available with PLISTVER.

,RETCODE=retcode

Use this output parameter to specify the location in which the system is to copy the return code from GPR 15.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword to contain the return code.

,RSNCODE=rsncode

Use this output parameter to specify the location in which the system is to copy the reason code from GPR 0.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword to contain the reason code.

,STGCLASS= NO_STGCLASS

,STGCLASS=stgclass

Use this input parameter to specify for a cache structure the storage class for which you would like storage class statistics.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a one-byte field that contains the storage class for which storage class statistics should be reported.

,STRCOPYCNTLS=NO

,STRCOPYCNTLS=YES

Use this input parameter to specify whether the structure copy controls record should be included in the measurement data associated with the structure records. Note that this information is intended for system use only, and therefore no mapping is provided for the structure copy controls data.

NO: Structure copy controls should not be included in the measurement data.
YES: Structure copy controls should be included in the measurement data.
Specifying STRCOPYCNTLS=YES requires an AMDALEVEL of 1 or higher.

,STRNAME=strname

Use this input parameter to specify the name of the coupling facility structure for which data is to be gathered.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the name of the coupling facility structure for which data is to be gathered.