Parameters

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the IWM4MCRE macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

,ALLOCATEBELOW=NO

,ALLOCATEBELOW=YES

When MONTKN64=montkn64 and REQTYPE=SINGLE are specified, an optional parameter, which indicates whether the virtual storage for the delay monitoring environment is to be obtained below 2 gigabytes. This is especially helpful for callers with 31-bit dependencies. The default is ALLOCATEBELOW=NO.

,ALLOCATEBELOW=NO

indicates that the delay monitoring environment is to be located as 64-bit virtual storage.

,ALLOCATEBELOW=YES

indicates that the virtual storage is to be located below 2 gigabytes.

,ALLOCATEBELOW=NO

,ALLOCATEBELOW=YES

When MONTKN64_LIST=montkn64_list and REQTYPE=MULTIPLE are specified, an optional parameter, which indicates whether the virtual storage for the delay monitoring environment is to be obtained below 2 gigabytes. This is especially helpful for callers with 31-bit dependencies. The default is ALLOCATEBELOW=NO.

,ALLOCATEBELOW=NO

indicates that the delay monitoring environment is to be located as 64-bit virtual storage.

,ALLOCATEBELOW=YES

indicates that the virtual storage is to be located below 2 gigabytes.

,AMOUNT=amount

When REQTYPE=MULTIPLE is specified, a required input parameter, which specifies the number of delay monitoring environments to be created.

While there is no restriction on the number of delay monitoring environments to be created, caller should only create the minimum number of delay monitoring environments that are needed.

If there are too many unused delay monitoring environments existing in the system, the storage and CPU overheads may be significant.

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

,BPMGMTONLY=NO

,BPMGMTONLY=YES

When REPORTONLY=NO is specified, an optional parameter, which indicates whether the monitoring environment is used together with enclaves to manage buffer pools (YES) or (NO). The default is BPMGMTONLY=NO.

,BPMGMTONLY=NO

indicates that the monitoring environment is not used together with enclaves to manage buffer pools.

,BPMGMTONLY=YES

indicates that the monitoring environment is used together with enclaves to manage buffer pools.

,CONNTKN=conntkn

When SUBSYSP=CONNECT is specified, a required input parameter, which contains the connect token associated with the subsystem.

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

,EWLM=NO

,EWLM=YES

When SUBSYSP=VALUE is specified, an optional parameter, which indicates if the created monitoring environment is intended to paricipate in Enterprise Workload Management (EWLM). The default is EWLM=NO.

,EWLM=NO

The monitoring environment can not be used to report on ARM work requests.

,EWLM=YES

The monitoring environment participates in cross platform Enterprise Workload Management and interacts with EWLM. An ARM application instance will be registered and started using the passed subsystem type (SUBSYS), subsystem name (SUBSYSNM), and the new parameter group name (GROUPNM, GROUPNM_LEN) - an already existing ARM registration for the same address space with identical SUBSYS, SUBSYSNM, GROUPNM and GROUPNM_LEN parameters will be reused. All ARM work requests associated with the created monitoring environment are reported for this ARM application instance.

,GROUPNM=groupnm

,GROUPNM=NO_GROUPNM

When EWLM=YES and SUBSYSP=VALUE are specified, an optional input parameter, which contains the name of an application group, i.e. a group of similar or cooperating subsystem instances. A group name can be up to 255 characters long. Provision of a data area initialized to all blanks is equivalent to specification of NO_GROUPNM. The default is NO_GROUPNM. indicates that no group name is passed.

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

,GROUPNM_LEN=groupnm_len

When GROUPNM=groupnm, EWLM=YES and SUBSYSP=VALUE are specified, a required input parameter, which contains the length of the group name. A group name can be up to 255 characters long.

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

,LISTLEN=listlen

When REQTYPE=MULTIPLE is specified, a required input parameter which specifies the length (in bytes) of the area identified by the MONTKN_LIST / MONTKN64_LIST keyword.

Size of this area must be at least the size of one monitoring token (see MONTKN / MONTKN64 keyword) times AMOUNT. If the user specified area is not large enough to return the delay monitoring tokens, a specific return/reason code will be returned and the request will not be processed.

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

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

An optional input parameter that specifies the macro form.

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. MF=S is the default.

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 may 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 of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,list addr

The name of a storage area to contain the parameters. For MF=S and MF=E, this can be an RS-type address or an address in register (1)-(12).

,attr

An optional 1- to 60-character input string that you use to force boundary alignment of the parameter list. Use a value of 0F to force the parameter list to a word boundary, or 0D to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value of 0D.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

,MONTKN=montkn

When REQTYPE=SINGLE is specified, a required output parameter which will receive the delay monitoring token.

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

,MONTKN_LIST=montkn_list

When REQTYPE=MULTIPLE is specified, a required input parameter which specifies an area into which a list of delay monitoring tokens will be placed.
A single MONTKN has a size of 4 byte.

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

,MONTKN_LISTLEN=montkn_listlen

When REQTYPE=MULTIPLE is specified, a required input parameter

Still supported, but use LISTLEN instead

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

,MONTKNKEY=montknkey

When MONTKNKEYP=VALUE is specified, a required input parameter, which contains the key in which the delay monitoring environment will be invoked subsequently when using the output MONTKN / MONTKN64. The low order 4 bits (bits 4-7) contain the key value. The high order 4 bits (bits 0-3) must be 0.

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

,MONTKNKEYP=VALUE

,MONTKNKEYP=PSWKEY

A required parameter, which describes how the input key for the monitoring environment should be obtained.

,MONTKNKEYP=VALUE

indicates that the key is being passed explicitly via MONTKNKEY.

,MONTKNKEYP=PSWKEY

indicates that the current PSW key should be used.

,MONTKN64=montkn64

When REQTYPE=SINGLE is specified, a required output parameter which will receive the long delay monitoring token.

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

,MONTKN64_LIST=montkn64_list

When REQTYPE=MULTIPLE is specified, a required input parameter which specifies an area into which a list of long delay monitoring tokens will be placed.
A single MONTKN64 has a size of 8 byte.

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

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

,PLISTVER=2

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form, when both are assembled with the same level of the system. In this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 0, which supports all parameters except those specifically referenced in higher versions.
• 1, which supports both the following parameters and those from version 0:

  BPMGMTONLY	GROUPNM
  EWLM	GROUPNM_LEN

• 2, which supports both the following parameters and those from version 0 and 1:

  ALLOCATEBELOW	MONTKN_LIST	MONTKN64_LIST
  LISTLEN	MONTKN_LISTLEN
  MONTKN	MONTKN64

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0, 1, or 2

,REPORTONLY=NO

,REPORTONLY=YES

An optional parameter, which indicates whether the monitoring environment is for reporting purposes only (YES) or (NO). The default is REPORTONLY=NO.

,REPORTONLY=NO

indicates that the monitoring environment is for management and reporting purposes.

,REPORTONLY=YES

indicates that the monitoring environment is for reporting purposes only.

REQTYPE=SINGLE

REQTYPE=MULTIPLE

An optional parameter that indicates whether the request is to create a single delay monitoring environment or to create multiple delay monitoring environments. The default is REQTYPE=SINGLE.

REQTYPE=SINGLE

The request is to create a single delay monitoring environment.

REQTYPE=MULTIPLE

The request is to create a number of delay monitoring environments.

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15. If you specify 15, GPR15, REG15, or R15 (within or without parentheses), the value will be left in GPR 15.

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

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0. If you specify 0, 00, GPR0, GPR00, REG0, REG00, or R0 (within or without parentheses), the value will be left in GPR 0.

To code: Specify the RS-type address of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00), REG0), (REG00), or (R0).

,SUBSYS=subsys

When SUBSYSP=VALUE is specified, a required input parameter, which contains the generic subsystem type (e.g. IMS, CICS, etc.).

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

,SUBSYSNM=subsysnm

When SUBSYSP=VALUE is specified, a required input parameter, which contains the subsystem name.

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

,SUBSYSP=CONNECT

,SUBSYSP=VALUE

A required parameter, which describes how the calling subsystem is providing identification.

,SUBSYSP=CONNECT

indicates that the connect token is being passed.

,SUBSYSP=VALUE

indicates that the subsystem name is being passed directly.