Parameters

The parameters are explained as follows:

name

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

,ABNORM_COUNT=abnorm_count

An optional output parameter, which contains the number of abnormal terminations per 1000 total terminations, if available. If no abnormal terminations were reported to WLM, this value is zero. This is independent of the reason why no report was issued - whether no abnormal terminations occurred or whether the subsystem of the server is not enabled to report them to WLM.

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

,COST_ZAAP_ON_CP=cost_zaap_on_cp

,COST_ZAAP_ON_CP=1

An optional input parameter, which is used in conjunction with METHOD=EQUICPU. It describes how much more it costs to execute zAAP-eligible work on a CPU instead of on a zAAP processor.

To use the full system capacity, independently of the cost, specify COST_ZAAP_ON_CP=1. With high values of this cost parameter, WLM considers that a system having used up its whole free zAAP capacity should offload less work to the CPU, and gives this system a smaller output weight.

This cost parameter must be in the range from 1 to 100. If the passed value is outside of this range, WLM will instead use the nearest valid integer (1 or 100) as cost parameter. The default is 1.

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

,COST_ZIIP_ON_CP=cost_ziip_on_cp

,COST_ZIIP_ON_CP=1

An optional input parameter, which is used in conjunction with METHOD=EQUICPU. It describes how much more it costs to execute zIIP-eligible work on a CPU instead of on a zIIP processor.

To use the whole system capacity, independently of the cost, specify COST_ZIIP_ON_CP=1. With high values of this cost parameter, WLM considers that a system having used up its whole free zIIP capacity should offload less work to the CPU, and gives this system a smaller output weight.

This cost parameter must be in the range from 1 to 100. If the passed value is out of this range, WLM will use the nearest valid integer (1 or 100) as cost parameter. The default is 1.

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

,CPUPROPORTION=cpuproportion

An optional output parameter, which contains the CPU weight part in the calculation of the weight.

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

,CPUWEIGHT=cpuweight

An optional output parameter, which contains the weight of how well the server is doing on the CPU.

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

,HEALTH=health

An optional output parameter, which contains the health indicator of this server. This is a value between 0 and 100, which was reported to WLM either by the IWM4HLTH or the IWMSRSRG service. If no health indicator was reported, the value is 100.

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

,IL_WEIGHTING=il_weighting

,IL_WEIGHTING=0

An optional input parameter, which controls how WLM evaluates available capacity at importance levels (ILs) lower than the currently selected one. The value of IL_WEIGHTING should be in the range from 0 to 3. If the passed value is out of this range, WLM will use the nearest valid integer (0 or 3) as IL_WEIGHTING instead.

When this parameter is set to 0 (the default value), all free capacities used by levels less important than the current one are evaluated the same. This means that the free capacity below current level is considered to be totally free, and this is equivalent to what WLM did prior to V1R11.

When this parameter is set to 1, free capacity at the lowest ILs is evaluated higher than the current IL, with a weighting growing proportionally to the square root of the IL difference + 1. For example, with a selected IL of 1, free capacity at IL 5 is weighted about 2.236 times more than free capacity at IL 1.

When this parameter is set to 2, free capacity at the lowest ILs is evaluated higher than the current IL, with a weighting growing proportionally to the IL difference + 1. For example, with a selected IL of 1, free capacity at IL 5 is weighted 5 times more than free capacity at IL 1.

When this parameter is set to 3, free capacity at the lowest ILs is weighted more than the current IL, with a weighting growing proportionally to the square of the IL difference + 1. For example, with a selected IL of 1, free capacity at IL 5 is weighted 25 times more than free capacity at IL 1. The default is 0.

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

,MAXEQUIVUNITS=maxequivunits

An optional output parameter, which contains the maximum equivalent service units across all processing resources used to calculate the mixed weight output.

If METHOD=PROPORTIONAL is specified, MAXEQUIVUNITS is automatically set to 0, since WLM does not compute equivalent CPU service units in this case.

If METHOD=EQUICPU is specified, MAXEQUIVUNITS is always a number in the range from 1 to MAXSRVUNITS. MAXEQUIVUNITS then relates to the mixed weight output only, and MAXSRVUNITS to the CPU, ZAAP and ZIIP weight outputs only.

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

,MAXSRVUNITS=maxsrvunits

An optional output parameter, which contains the maximum service units across all processing resources used to calculate the weights.

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

,METHOD=PROPORTIONAL

,METHOD=EQUICPU

An optional parameter, which selects the method for computing the output weights. The default is METHOD=PROPORTIONAL.

,METHOD=PROPORTIONAL

Computes the output weights as a proportion of the three processor type weights.

,METHOD=EQUICPU

Computes a CPU equivalent of the systems before computing the output weights.

To specify METHOD=EQUICPU, all systems in the sysplex must run z/OS® V1R11, or higher. Otherwise WLM automatically switches back to METHOD=PROPORTIONAL.

,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.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

,PLISTVER=2

,PLISTVER=3

,PLISTVER=4

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 the following parameters and those from version 0:
  ABNORM_COUNT
  HEALTH
  
• 2, which supports the following parameters and those from version 0 and 1:

  CPUPROPORTION	ZAAPPROPORTION	ZIIPPROPORTION
  CPUWEIGHT	ZAAPWEIGHT	ZIIPWEIGHT

• 3, which supports the following parameter and those from version 0, 1, and 2:
  MAXSRVUNITS
  
• 4, which supports the following parameters and those from version 0, 1, 2, and 3:

  COST_ZAAP_ON_CP	IL_WEIGHTING	METHOD
  COST_ZIIP_ON_CP	MAXEQUIVUNITS

To code: Specify one of the following:

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

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

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

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

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

,STOKEN=stoken

A required input parameter, which contains the space token of the server.

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

WEIGHT=weight

A required output parameter, which contains the weight of how well the server is performing.

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

,ZAAPPROPORTION=zaapproportion

An optional output parameter, which contains the ZAAP weight part in the calculation of the WEIGHT.

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

,ZAAPWEIGHT=zaapweight

An optional output parameter, which contains the weight of how well the server is doing on the ZAAP.

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

,ZIIPPROPORTION=ziipproportion

An optional output parameter, which contains the ZIIP weight part in the calculation of the WEIGHT.

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

,ZIIPWEIGHT=ziipweight

An optional output parameter, which contains the weight of how well the server is doing on the ZIIP.

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