Parameters

The parameters are explained as follows:

name

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

,HEALTH=health

,HEALTH=NO_HEALTH

An optional input parameter, which contains the health factor associated with the address space. This is a value, that reflects, up to which percentage this address space is capable to handle requests. NO_HEALTH indicates that no health indicator was passed. This is the default. In this case, a health value of 100 is assumed, when the server is registered.

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

,HOST=host

,HOST=NO_HOST

An optional input parameter, which contains the host name associated with the address space to be registered. The value should be padded on the right with blanks for any unused characters. NO_HOST indicates that no host name was passed. This is the default.

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

LOCATION=location

A required input parameter, which contains the server LOCATION associated with the address space to be registered. The value should be padded on the right with blanks for any unused characters.

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

,LUNAME=luname

A required input parameter, which contains the server Logical Unit name associated with the address space to be registered.

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

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

,NETWORK_ID=network_id

A required input parameter, which contains the Network ID associated with the address space to be registered.

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

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

,PLISTVER=2

,PLISTVER=3

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; 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 parameter and those from version 0:
  USERDATA
  
• 2, which supports the following parameter and those from version 0 and 1:
  HOST
  
• 3, which supports the following parameter and those from version 0, 1 and 2:
  HEALTH
  
  Note:

  The PLISTVER=3 option can only be used on systems running z/OS® V1R7 with OA14310 installed, and on systems running z/OS V1R8 or higher.

To code: Specify one of the following:

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

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

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

,USERDATA=userdata

,USERDATA=NO_USERDATA

An optional input parameter, which contains data meaningful to the user of this service. This user data is available to callers of the IWMSRSRS service.

The format is undefined to MVS™. The default is NO_USERDATA, which indicates that no user data was passed.

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