Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWMRESET macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ASID=asid
- A parameter which contains the address space identifier (ASID)
of the job you want to change.
To code: Specify
the RS-type address, or address in register (2)-(12), of a halfword
field.
- ,FUNCTION=RESET
- ,FUNCTION=QUIESCE
- ,FUNCTION=RESUME
- An optional parameter, which indicates the function to perform
against the job. The default is FUNCTION=RESET.
- ,FUNCTION=RESET
- Requests that the job's service class or performance group be
changed.
- ,FUNCTION=QUIESCE
- Requests that the job be quiesced. If the job is non-swappable,
it is given the lowest possible performance characteristics.
- ,FUNCTION=RESUME
- Requests that the job be reclassified according to the service
policy in effect. This undoes a prior request to reset the job to
a particular service class, or to quiesce the job.
- JOBNAME=jobname
- A required input parameter which contains the jobname of the
job you want to change. If there is more than one executing job with
this jobname, you must specify the ASID parameter to identify the
specific job.
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)
- ,MF=(E,list addr,NOCHECK)
- ,MF=(M,list
addr)
- ,MF=(M,list addr,COMPLETE)
- ,MF=(M,list addr,NOCHECK)
- 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.
Use MF=M together with the list and execute
forms of the macro for service routines that need to provide different
options according to user-provided input. Use the list form to define
a storage area; use the modify form to set the appropriate options;
then use the execute form to call the service.
IBM® recommends that you use the modify and execute
forms of IWMRESET in the following order:
- Use IWMRESET ...MF=(M,list-addr,COMPLETE) specifying appropriate
parameters, including all required ones.
- Use IWMRESET ...MF=(M,list-addr,NOCHECK), specifying the parameters
that you want to change.
- Use IWMRESET ...MF=(E,list-addr,NOCHECK), to execute the macro.
- ,list addr
- The name of a storage area to contain the parameters. For MF=S,
MF=E, and MF=M, 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.
- ,NOCHECK
- Specifies that the system is not to check for required parameters
and is not to supply defaults for omitted optional parameters.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- 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, if you use the currently available parameters.
To code: Specify one of the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0
- ,PRODUCT=product
- A required input parameter, which contains the product name
that is requesting the job be changed. The product name is included
in the SMF 90 subtype 30 record created by IWMRESET.
To
code: Specify the RS-type address, or address in register (2)-(12),
of an 8-character field.
- ,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).
- ,SRVCLASS=srvclass
-
When FUNCTION=RESET is specified, a required input
parameter which is the service class to be assigned to the job. Resetting
to a new service class also resumes quiesced work.
When you
reset a server to a new service class, the goals associated with that
service class are ignored. However the resource group associated with
the new service class is honored. The one exception where the goal
for a server is honored is when the transactions it is serving have
been assigned a discretionary goal.
To code: Specify
the RS-type address of an 8-character field.
- ,USERID=userid
- A required input parameter, which contains the ID of the user
who is requesting the job be changed. The user ID is included in the
SMF 90 subtype 30 record created by IWMRESET. If there is no user
ID available, the caller should pass blanks.
To
code: Specify the RS-type address, or address in register (2)-(12),
of an 8-character field.
|