Parameters

The parameters are explained as follows:

name

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

,ANSLEN=anslen

A required input parameter, which contains the length of the SYSINFO_BLOCK in bytes.

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

,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 the additional cost of executing zAAP-eligible work on a CPU instead of on a zAAP processor.

If the caller wants to use the full system capacity, independently of the cost, then it should set COST_ZAAP_ON_CP=1. With high values of this cost parameter, WLM considers that a system having used up its 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 specified 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 the additional cost of executing zIIP-eligible work on a CPU instead of on a zIIP processor.

If the caller wants to use the full system capacity, independently of the cost, then it should set COST_ZIIP_ON_CP=1. With high values of this cost parameter, WLM considers that a system having used up its 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 specified 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.

,ENTRY_COUNT=entry_count

An optional output parameter, which will hold the number of server entries returned by the service. This is the number of entries in the SYSR_INFO array (see IWMWSYSR). ENTRY_COUNT may only be specified when running on OS/390 R3 or higher. On earlier releases this request is ignored and the variable is zeroed. No return code is given that this has happened.

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

,EXTENDED_DATA=NO

,EXTENDED_DATA=YES

An optional parameter, which describes whether the format of the output area named by SYSINFO_BLOCK includes the extended section or not (see IWMWSYSR). The default is EXTENDED_DATA=NO.

,EXTENDED_DATA=NO

indicates that the format of the output area named by SYSINFO_BLOCK includes only the standard information mapped by the SYSR, which consists of an array of entries described by SYSR_INFO.

,EXTENDED_DATA=YES

indicates that the format of the output area given by SYSINFO_BLOCK includes first the standard information mapped by the SYSR, which consists of an array of entries described by SYSR_INFO, followed immediately by the header for the extension section and any other data described by the header.

EXTENDED_DATA is only available to callers of the IWMSRSRS service when invoked on a system running OS/390 R3 or higher. The EXTENDED_DATA returned by OS/390 R3 includes the header and associated userdata. Data associated with entries on MVS images not supporting a particular type of data will be set as binary zeroes - for example servers on MVS SP5.2 will have userdata which is all zeroes. No special indication will be given for this condition. In particular no special return or reason codes are given.

On releases prior to OS/390 R3, EXTENDED_DATA(YES) is processed as though EXTENDED_DATA(NO) was specified. No return code is given that this has happened.

,FUNCTION=SELECT

,FUNCTION=QUERY

,FUNCTION=SPECIFIC

An optional parameter, which describes which set of servers are of interest to the caller. The default is FUNCTION=SELECT.

,FUNCTION=SELECT

indicates that the servers best suited to receive work are to be returned.

,FUNCTION=QUERY

indicates that all servers associated with the input LOCATION are to be returned. QUERY may only be specified when running on OS/390 R3 or higher. On earlier releases this request is processed as a SELECT request. No return code is given that this has happened.

,FUNCTION=SPECIFIC

indicates that all servers in the sysplex which are associated with the input Location name along with a relative weighting for each server are returned. SPECIFIC may only be specified when running on z/OS V1R7 or higher. On earlier releases this request is processed as a SELECT request. No return code is given that this has happened.

,IL_WEIGHTING=il_weighting

,IL_WEIGHTING=0

An optional input parameter, which controls how WLM weights 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 outside of this range, WLM will instead use the nearest valid integer (0 or 3) as IL_WEIGHTING.

When this parameter is set to 0 (the default value), all free capacities used by levels less important than the current one are weighted the same. This means that the free capacity below the 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 weighted more 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 weighted more 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.

,LOCATION=location

A required input parameter, which contains the LOCATION associated with the registered address spaces which are candidates to receive work.

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

,METHOD=PROPORTIONAL

,METHOD=EQUICPU

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

,METHOD=PROPORTIONAL

Calculates the output weights as a proportion of the 3 processor types weights.

,METHOD=EQUICPU

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

In order for METHOD=EQUICPU to be active, all systems in sysplex must run at least z/OS V1R11. 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

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:

  ENTRY_COUNT	EXTENDED_DATA	FUNCTION

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

  COST_ZAAP_ON_CP	IL_WEIGHTING
  COST_ZIIP_ON_CP	METHOD

To code: Specify one of the following:

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

,QUERYLEN=querylen

A required output parameter, variable which contains the number of bytes needed for all data requested, taking into account the format specified via the EXTENDED_DATA keyword.

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

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

SYSINFO_BLOCK=sysinfo_block

A required input parameter, of the area to be filled in with the system information for the registered, active, LUs in the SYSPLEX associated with the input location.

The area must be large enough to contain at least 1 entry. The format of this area is mapped by IWMWSYSR. The EXTENDED_DATA keyword describes the desired format. The FUNCTION keyword describes which servers are candidates for inclusion.

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