Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on the HZSCHECK macro invocation. The name must conform to the rules for an ordinary assembler language symbol.
- ,CART=cart
- ,CART=NO_CART
- An optional input parameter that specifies the Command And Response
Token (CART) to be used if any messages are issued while processing
the HZSCHECK request. The default is NO_CART. which indicates that
messages issued while processing the HZSCHECK will be issued without
a CART.
To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.
- ,CATEGORY=category
- ,CATEGORY=ANY_CATEGORY
- When REQUEST=DELETE and REMOTE=ANY are specified, an optional
input parameter that specifies an array of 1 to 16 contiguous 16 character
entries each of which contains a category. The categories are used
as filters. Each category can include wildcard characters. Checks
that belong to categories that match according to the rules of the
CATRULE parameter and according to the other filtering parameters
(CHECKOWNER, CHECKNAME, and EXITRTN) are processed. The number of
categories is specified by the NUMCAT parameter. The default is ANY_CATEGORY.
To code: Specify the RS-type address, or address in register (2)-(12), of a character field.
- ,CATEGORY=category
- ,CATEGORY=ANY_CATEGORY
- When REQUEST=RUN and REMOTE=ANY are specified, an optional input
parameter that specifies an array of 1 to 16 contiguous 16 character
entries each of which contains a category. The categories are used
as filters. Each category can include wildcard characters. Checks
that belong to categories that match according to the rules of the
CATRULE parameter and according to the other filtering parameters
(CHECKOWNER, CHECKNAME, and EXITRTN) are processed. The number of
categories is specified by the NUMCAT parameter. The default is ANY_CATEGORY.
To code: Specify the RS-type address, or address in register (2)-(12), of a character field.
- ,CATRULE=DEFAULT
- ,CATRULE=ONLY
- ,CATRULE=ANY
- ,CATRULE=EVERY
- ,CATRULE=EXCEPT
- When CATEGORY=category, REQUEST=DELETE and
REMOTE=ANY are specified, a required parameter that indicates how
to process the category filters.
- ,CATRULE=DEFAULT
- indicates to apply the default (which is CATRULE=ONLY).
- ,CATRULE=ONLY
- indicates to match only if all the categories match the categories to which the target check belongs, and if the target check belongs to exactly the number of categories specified by the NUMCAT parameter.
- ,CATRULE=ANY
- indicates to match if any of the categories provided match any of the categories to which the target check belongs.
- ,CATRULE=EVERY
- indicates to match if every one of the categories provided matches any of the categories to which the target check belongs.
- ,CATRULE=EXCEPT
- indicates to match except when one of the categories provided matches any of the categories to which the target check belongs.
- ,CATRULE=DEFAULT
- ,CATRULE=ONLY
- ,CATRULE=ANY
- ,CATRULE=EVERY
- ,CATRULE=EXCEPT
- When CATEGORY=category, REQUEST=RUN and REMOTE=ANY
are specified, a required parameter that indicates how to process
the category filters.
- ,CATRULE=DEFAULT
- indicates to apply the default (which is CATRULE=ONLY).
- ,CATRULE=ONLY
- indicates to match only if all the categories match the categories to which the target check belongs, and if the target check belongs to exactly the number of categories specified by the NUMCAT parameter.
- ,CATRULE=ANY
- indicates to match if any of the categories provided match any of the categories to which the target check belongs.
- ,CATRULE=EVERY
- indicates to match if every one of the categories provided matches any of the categories to which the target check belongs.
- ,CATRULE=EXCEPT
- indicates to match except when one of the categories provided matches any of the categories to which the target check belongs.
- ,CHECKNAME=checkname
- When REQUEST=DELETE and REMOTE=ANY are specified, a required input
parameter that specifies the name of the check to be used as a filter.
CHECKNAME can include wildcard characters. All checks with names that
match the specified name and that match the other filtering parameters
(CHECKOWNER, EXITRTN, CATEGORY) are processed.
To code: Specify the RS-type address, or address in register (2)-(12), of a 32-character field.
- ,CHECKNAME=checkname
- When REQUEST=RUN and REMOTE=ANY are specified, a required input
parameter that specifies the name of the check to be used as a filter.
CHECKNAME can include wildcard characters. All checks with names that
match the specified name and that match the other filtering parameters
(CHECKOWNER, EXITRTN, CATEGORY) are processed.
To code: Specify the RS-type address, or address in register (2)-(12), of a 32-character field.
- ,CHECKOWNER=checkowner
- When REQUEST=DELETE and REMOTE=ANY are specified, a required input
parameter that specifies the owner of the check to be used as a filter.
CHECKOWNER can include wildcard characters. All checks with owners
that match the specified owner and that match the other filtering
parameters (CHECKNAME, EXITRTN, CATEGORY) are processed.
To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.
- ,CHECKOWNER=checkowner
- When REQUEST=RUN and REMOTE=ANY are specified, a required input
parameter that specifies the owner of the check to be used as a filter.
CHECKOWNER can include wildcard characters. All checks with owners
that match the specified owner and that match the other filtering
parameters (CHECKNAME, EXITRTN, CATEGORY) are processed.
To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.
- ,CONSID=consid
- ,CONSID=NO_CONSID
- An optional input parameter that specifies the console ID to be
used if any messages are issued while processing the HZSCHECK request.
The default is NO_CONSID. If the CONSID parameter is not specified,
no messages will be issued while processing the HZSCHECK.
To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.
- ,EXITRTN=exitrtn
- ,EXITRTN=ANY_EXITRTN
- When REQUEST=DELETE and REMOTE=ANY are specified, an optional
input parameter that specifies the name of the exit routine that was
provided via the EXITRTN parameter on the HZSADDCK macro that added
the check. The exit routine is EXITRTN can include wildcard characters.
All checks with names that match the specified name and that match
the other filtering parameters (CHECKOWNER, CHECKNAME, CATEGORY) are
processed. The default is ANY_EXITRTN.
To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.
- ,EXITRTN=exitrtn
- ,EXITRTN=ANY_EXITRTN
- When REQUEST=RUN and REMOTE=ANY are specified, an optional input
parameter that specifies the name of the exit routine that was provided
via the EXITRTN parameter on the HZSADDCK macro that added the check.
The exit routine is EXITRTN can include wildcard characters. All
checks with names that match the specified name and that match the
other filtering parameters (CHECKOWNER, CHECKNAME, CATEGORY) are processed.
The default is ANY_EXITRTN.
To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.
- ,HANDLE=handle
- When REMOTE=YES is specified, a required input parameter that
specifies a handle (token) that identifies the check. This handle
was returned via the HANDLE parameter of the HZSADDCK macro for a
REMOTE=YES REXX=NO check. The handle is in REXX variable hzs_handle
for a REMOTE=YES REXX=YES check.
To code: Specify the RS-type address, or address in register (2)-(12), of a 16-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.
- ,NUMCAT=numcat
- When CATEGORY=category, REQUEST=DELETE and
REMOTE=ANY are specified, a required input parameter that specifies
the number of categories contained in the array specified by the CATEGORY
parameter.
To code: Specify the RS-type address, or address in register (2)-(12), of a one-byte field.
- ,NUMCAT=numcat
- When CATEGORY=category, REQUEST=RUN and REMOTE=ANY
are specified, a required input parameter that specifies the number
of categories contained in the array specified by the CATEGORY parameter.
To code: Specify the RS-type address, or address in register (2)-(12), of a one-byte field.
- ,PETOKEN=petoken
- When REXX=NO, REQUEST=OPSTART and REMOTE=YES are specified, a
required input parameter that is the updated pause element token returned
by the IEAVPSE service (the pause element token was originally obtained
via the IEAVAPE service and then was provided as input to the IEAVPSE
service which returned an updated token). The caller, waiting to be
told what to do by IBM® Health
Checker for z/OS®, should pause
using this pause element token. IBM Health
Checker for z/OS will "release"
using that pause element token to wake up the check processing.
To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- ,PLISTVER=1
- 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:
- REXXTIMELIM
To code: Specify one of the following:- IMPLIED_VERSION
- MAX
- A decimal value of 0, or 1
- ,PQE=pqe
- When REQUEST=OPSTART and REMOTE=YES are specified, an optional
output parameter that specifies the area into which to place the information
mapped by HZSPQE that is associated with this check. This area should
begin on a doubleword boundary.
To code: Specify the RS-type address, or address in register (2)-(12), of a 4096-character field.
- ,PQECHKWORK=pqechkwork
- ,PQECHKWORK=NO_PQECHKWORK
- When REQUEST=OPCOMPLETE and REMOTE=YES are specified, an optional
input parameter that specifies the PQECHKWORK area which is to be
saved and which is to be provided on the next running of the check.
This area should begin on a doubleword boundary. The default is NO_PQECHKWORK.
To code: Specify the RS-type address, or address in register (2)-(12), of a 2048-character field.
- REMOTE=ANY
- REMOTE=YES
- An optional parameter, which identifies the locale of the check.
The default is REMOTE=ANY.
- REMOTE=ANY
- indicates that the check may either be Remote (runs remotely, in an address space other than that of IBM Health Checker for z/OS) or not Remote (runs locally in the address space of IBM Health Checker for z/OS).
- REMOTE=YES
- indicates that the check runs remotely, in an address space other than that of IBM Health Checker for z/OS.
- ,REQUEST=DELETE
- ,REQUEST=ADDNEW
- ,REQUEST=RUN
- When REMOTE=ANY is specified, a required parameter, which identifies
the type of request.
- ,REQUEST=DELETE
- indicates to delete the specified check(s) from IBM Health Checker for z/OS.
- ,REQUEST=ADDNEW
- indicates to call the HZSADDCHECK dynamic exit, which results
in running exit routines associated with that exit to add checks that
are not currently added to IBM Health
Checker for z/OS. When a check
is added, the current policy is processed to obtain any modifications
to the new check(s).
The system runs checks when they are added, unless they are inactive.
REQUEST(ADDNEW) is not allowed from within a HZSADDCHECK dynamic exit routine.
- ,REQUEST=RUN
- indicates to run the specified check(s) registered with IBM Health Checker for z/OS. Checks that are inactive will not be run.
- ,REQUEST=OPSTART
- ,REQUEST=OPCOMPLETE
- When REMOTE=YES is specified, a required parameter, which identifies
the type of request.
- ,REQUEST=OPSTART
- indicates that the current operation is starting
- ,REQUEST=OPCOMPLETE
- indicates that the current operation is now complete for the check.
- ,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 remain in GPR 15.
To code: Specify the RS-type address of a fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or (R15).
- ,REXX=NO
- When REQUEST=OPSTART and REMOTE=YES are specified, an optional
parameter, which indicates if this is a REXX check. The default is
REXX=NO.
- ,REXX=NO
- indicates that the check is a REXX check.
- ,REXX=NO
- When REQUEST=OPCOMPLETE and REMOTE=YES are specified, an optional
parameter, which indicates if the check is a REXX check. The default
is REXX=NO.
- ,REXX=NO
- indicates that the check is a REXX check.
- ,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 remain 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).
- ,SECCHECK=UNAUTH
- ,SECCHECK=ALL
- When SECCHECKONLY=NO is specified, an optional parameter that
indicates whether to do RACF® security
checks. The default is SECCHECK=UNAUTH.
- ,SECCHECK=UNAUTH
- that indicates to do RACF security checks only when the caller is unauthorized (not supervisor state, not system key, not APF-authorized).
- ,SECCHECK=ALL
- that indicates to do RACF security checks in all cases. If RACF does not grant authority, the request is rejected.
- ,SECCHECKONLY=NO
- ,SECCHECKONLY=YES
- An optional parameter that indicates whether to do full processing
or only security checks. The default is SECCHECKONLY=NO.
- ,SECCHECKONLY=NO
- that indicates to do full processing.
- ,SECCHECKONLY=YES
- that indicates to do only the security check to see if the requesting user has RACF authority to access the data. When this option is specified, the security check is done regardless of the caller's key or state.
- ,SYSNAME=sysname
- ,SYSNAME=CURRENT
- When SECCHECKONLY=YES is specified, an optional input parameter
that specifies the system name to be used when doing the security
check. Note that this specification is used only when the caller is
supervisor state, system key, or APF-authorized. The default is CURRENT.
which indicates to use the name of the system on which this request
was issued.
To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.