Parameters

The parameters are explained as follows:

name

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

,ACTIVE

An optional input parameter that indicates the check should run when it is added to the system.

To code: Specify a value.

,ALLOWDYNSEV=NO

,ALLOWDYNSEV=YES

An optional parameter, which indicates if this check is allowed to use keyword SEVERITY on an invocation of service HZSFMSG, to send check messages with a dynamic severity. The default is ALLOWDYNSEV=NO.

,ALLOWDYNSEV=NO: indicates that the check is not allowed to specify a dynamic severity. This is the default.
,ALLOWDYNSEV=YES: indicates that the check is allowed to specify a dynamic severity.

,CHECKNAME=checkname

A required input parameter that specifies the name of the check being added. IBM® recommends using the naming convention of a short component reference followed by a descriptive title (e.g., GRS_MODE). Upper and lower case alphabetic characters(a-z), numerics (0-9), national characters (@,$,#) and the underscore ('_') are allowed. Lower case alphabetic characters are folded to upper case and are treated as equivalent to their corresponding upper case value.

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

CHECKOWNER=checkowner

A required input parameter that specifies the owner of the check being added. The check owner and check name identify the check. IBM recommends that you use your company name followed by the short component name (i.e., IBMGRS) as the owner. Upper and lower case alphabetic characters(a-z), numerics (0-9), national characters (@,$,#) and the underscore ('_') are allowed. Lower case alphabetic characters are folded to upper case and are treated as equivalent to their corresponding upper case value. Do not use as the checkowner any of the following: QUERY, MESSAGES, ACTIVATE, DEACTIVATE, UPDATE, RUN, REFRESH, DELETE, ADDNEW.

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

,CHECKROUTINE=checkroutine

When REMOTE=NO is specified, a required input parameter that specifies the module name of the check. The system gives control to the entry point of this module to run the check. The check routine module must be in an APF-authorized library. For a non-remote check, the system must be able to locate the check routine within the joblib or steplib of the IBM Health Checker for z/OS® address space, the LPA, or the LNKLST.

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

,DATE=date

A required input parameter, date (its format is YYYYMMDD) that indicates when the default values for the check were defined. When two HZSADDCK requests are received with the same check owner and check name, the request with the latest date will be honored. When the date provided on a matching POLICY UPDATE or POLICY DELETE statement is older than this date, that policy statement is not applied to this check.

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

,DOM=SYSTEM

,DOM=CHECK

An optional parameter that messages from previous check iterations via Delete Operator Message (DOM) requests. The default is DOM=SYSTEM.

,DOM=SYSTEM

indicates that the system will, just before the start of a new check iteration, execute the DOM requests for all check exception message WTOs from the previous check iteration, if there are any. This is the default.

,DOM=CHECK

indicates that the check will use the HZSFMSG REQUEST=DOM service to issue DOM requests for check exception WTOs from previous check iterations. The system will take care of the DOM only in the following cases:

when a health check gets deactivated, disabled, deleted, or refreshed
when Health Checker ends

,EIHOURS=eihours

,EIHOURS=0

When INTERVAL=ONETIME is specified, an optional input parameter that specifies the number of hours in the exception interval. It must be in the range 0 through 999. If both EIHours and EIMinutes specify 0, no exception interval is processed. The default is 0.

To code: Specify the RS-type address of a halfword field, or specify a literal decimal value. eihours must be in the range 0 through 999.

,EIHOURS=eihours

,EIHOURS=0

When EINTERVAL=TIMER and INTERVAL=TIMER are specified, an optional input parameter that specifies the number of hours in the exception interval. It must be in the range 0 through 999. The default is 0.

To code: Specify the RS-type address of a halfword field, or specify a literal decimal value. eihours must be in the range 0 through 999.

,EIMINUTES=eiminutes

,EIMINUTES=0

When INTERVAL=ONETIME is specified, an optional input parameter that specifies the number of minutes in the exception interval It must be in the range 0 through 59. If both EIHours and EIMinutes specify 0, no exception interval is processed. The default is 0.

To code: Specify the RS-type address of a halfword field, or specify a literal decimal value. eiminutes must be in the range 0 through 59.

,EIMINUTES=eiminutes

,EIMINUTES=0

When EINTERVAL=TIMER and INTERVAL=TIMER are specified, an optional input parameter that specifies the number of minutes in the exception interval It must be in the range 0 through 59. The default is 0.

To code: Specify the RS-type address of a halfword field, or specify a literal decimal value. eiminutes must be in the range 0 through 59.

,EINTERVAL=SYSTEM

,EINTERVAL=HALF

,EINTERVAL=TIMER

When INTERVAL=TIMER is specified, an optional parameter that specifies the time exception interval for the next running of the check. If the previous running of the check resulted in an exception, then this interval is to be used. The default is EINTERVAL=SYSTEM.

,EINTERVAL=SYSTEM: indicates that the check should run according to system rules (namely, according to the interval parameter).
,EINTERVAL=HALF: indicates that the check should run when one half of the interval according to the interval parameter has expired. This value is rounded up to a whole number of minutes.
,EINTERVAL=TIMER: indicates that a timer is used to reschedule the check. The number of hours is combined with the number of minutes to determine how long after the completion of the check routine's running the next running of the check routine should occur. When both the hours and minutes values are zero, the system treats this as if EINTERVAL=SYSTEM had been specified.

,ENTRYCODE=entrycode

When REMOTE=NO is specified, an optional input parameter that specifies a unique check entry value when the same check routine will be accessed by multiple checks. This value is passed to the check routine in the field Pqe_Entry_Code.

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

,ENTRYCODE=entrycode

When REXX=YES and REMOTE=YES are specified, an optional input parameter that specifies a unique check entry value when the same check routine will be accessed by multiple checks. This value is passed to the check routine in the field Pqe_EntryCode.

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

,EXEC=exec

When REXX=YES and REMOTE=YES are specified, a required input parameter that is the name of the REXX exec to be invoked.

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

,EXITRTN=exitrtn

When REMOTE=NO is specified, a required input parameter that specifies the name of the exit routine that invoked this HZSADDCK request.

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

,EXITRTN=exitrtn

When REXX=YES and REMOTE=YES are specified, a required input parameter that specifies the name of the exit routine that invoked this HZSADDCK request.

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

,GLOBAL

An optional input parameter that indicates the check should run on only one system in a sysplex. The system on which the check runs is designated as the global system for that check. Serialization for the global check is accomplished via exclusive ownership of SCOPE=SYSTEMS ENQ with QNAME SYSZHZS and RNAME checkowner.checkname.

To code: Specify a value.

,HANDLE=handle

When REXX=NO and REMOTE=YES are specified, a required output parameter that is to hold a handle (token) that identifies the check. This handle is to be used on the HANDLE parameter of the HZSCHECK and HZSFMSG macros.

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

,HOURS=hours

,HOURS=0

When INTERVAL=TIMER is specified, an optional input parameter that specifies the number of hours. It must be in the range 0 through 999. The default is 0.

To code: Specify the RS-type address of a halfword field, or specify a literal decimal value. hours must be in the range 0 through 999.

,INACTIVE

An optional input parameter that Indicates the check should not run until the state is changed to active.

To code: Specify a value.

,INTERVAL=ONETIME

,INTERVAL=TIMER

A required parameter that specifies the time interval for the next running of the check.

,INTERVAL=ONETIME: indicates that the check should run once. It will not be rescheduled.
,INTERVAL=TIMER: indicates that a timer is used to reschedule the check. The number of hours is combined with the number of minutes to determine how long after the completion of the check routine's running the next running of the check routine should occur. When both the hours and minutes values are zero, the system treats this as if INTERVAL=ONETIME had been specified.

,LOCAL

An optional input parameter that indicates the check should run on this system.

To code: Specify a value.

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

,MINUTES=minutes

,MINUTES=0

When INTERVAL=TIMER is specified, an optional input parameter that specifies the number of minutes. It must be in the range 0 through 59. The default is 0.

To code: Specify the RS-type address of a halfword field, or specify a literal decimal value. minutes must be in the range 0 through 59.

,MSGTBL=msgtbl

When REMOTE=NO is specified, a required input parameter that specifies the module name of the message table that will be used when generating messages for the check.

The message table must be built using the HZSMSGEN REXX exec.
The message table module must be in an APF-authorized library.
The system must be able to locate the message table within the joblib or steplib of the IBM Health Checker for z/OS address space, the LPA, or the LNKLST.

A special text value of '*NONE ' indicates that you are adding a check that has no associated message table and instead the check will be using service HZSFMSG REQUEST=DIRECTMSG or REXX function HZSLFMSG with HZSLFMSG_REQUEST='DIRECTMSG' to issue messages directly from the check routine.

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

,MSGTBL=msgtbl

When REXX=YES and REMOTE=YES are specified, a required input parameter that specifies the module name of the message table that will be used when generating messages for the check.

The message table must be built using the HZSMSGEN REXX exec.
The message table module must be in an APF-authorized library.
The system must be able to locate the message table within the joblib or steplib of the IBM Health Checker for z/OS address space, the LPA, or the LNKLST.

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

,PARMS=parms

,PARMS=NO_PARMS

An optional input parameter that specifies the default parameters for the check. The length of the parameter string is specified by the PARMSLEN parameter. Alphanumeric or national characters separated by commas are the standard form of expressing check parameters. IBM recommends that each parameter be of the form "keyword(value)" and that multiple parameters be separated from each other by a comma. An example of a parameter string following that protocol is "MAXLEN(8),MINLEN(1)". Although the parameters are not checked when the check is added, the check routine itself will likely do so. The default is NO_PARMS.

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

,PARMSLEN=parmslen

,PARMSLEN=0

When PARMS=parms is specified, a required input parameter that contains the length of the default parameters for each check. The length must be in the range 1 through 256. 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. parmslen must be in the range 0 through 256.

,PETOKEN=petoken

When REXX=NO and REMOTE=YES are specified, a required input parameter that is a pause element token obtained by the caller via the IEAVAPE service using an authlvl of IEA_UNAUTHORIZED (even if the caller is authorized). The caller, waiting to be told what to do by IBM Health Checker for z/OS, should pause using that 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:
- EXEC
- HANDLE
- PETOKEN
- REXXHLQ
- TIMELIMIT

To code: Specify one of the following:

IMPLIED_VERSION
MAX
A decimal value of 0, or 1

,REASON=reason

A required input parameter that indicates what the check routine validates. The text is limited to 126 characters.

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

,REASONLEN=reasonlen

A required input parameter that contains the length of the Reason text. It must be in the range 1 through 126.

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

,REMOTE=NO

,REMOTE=YES

An optional parameter, which identifies the locale of the check. The default is REMOTE=NO.

,REMOTE=NO: indicates that the check 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.

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

,REXX=NO

,REXX=YES

When REMOTE=YES is specified, an optional parameter, which identifies if this is a REXX check The default is REXX=NO.

,REXX=NO: indicates that this is not a REXX check.
,REXX=YES: indicates that this is a REXX check

,REXXHLQ=rexxhlq

When REXX=YES and REMOTE=YES are specified, a required input parameter that specifies the high level qualifier for data sets(s) to be made available to the Rexx exec. The output data set (such as the one to which the 'say' function would send its output) is made available when the check is in debug mode and not otherwise. When there is no entry code, or the entry code is 0, the output data set name for a high level qualifier of 'HLQ' will be 'HLQ.execname.REXXOUT'. When there is a non-0 entry code, the output data set name will be 'HLQ.execname.REXXOUT.En' where n is the decimal value of the entry code. If the entry code exceeds 9999999, the value modulo 10000000 will be used. The system will not make any attempt to ensure that the data sets are unique beyond this naming convention. If not already allocated, the data set will be allocated by the system. If the data set is to be created, the IBM Health Checker for z/OS address space identity must have the authority to create the data set. If the system does attempt to create or use the data set and is not successful, the check routine will not run successfully. The input data set name will be formed using a similar protocol, changing only REXXOUT to REXXIN. The use of the REXXIN data set is controlled by the REXXIN parameter.

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

,REXXIN=NO

,REXXIN=YES

When REXXTSO=NO, REXX=YES and REMOTE=YES are specified, an optional parameter that indicates if there is a REXX input data set. The default is REXXIN=NO.

,REXXIN=NO: indicates that there is no REXX input data set.
,REXXIN=YES: indicates that the REXX input data set does exist and is to be made available to the exec. Its naming convention is described under the REXXHLQ parameter. If the data set does not exist, the exec will not successfully be given control.

,REXXTSO=YES

,REXXTSO=NO

When REXX=YES and REMOTE=YES are specified, an optional parameter that indicates if this REXX exec needs access to TSO functions. The default is REXXTSO=YES.

,REXXTSO=YES: indicates that the REXX exec needs TSO functions. The exec will execute in a TSO host command environment.
,REXXTSO=NO: indicates that the REXX exec does not need TSO functions. The exec will execute in a MVS™ host command environment.

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

,SECCHECK=UNAUTH

,SECCHECK=ALL

When REMOTE=YES 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 for remote checks. If RACF does not grant authority, the request is rejected.

,SEVERITY=LOW

,SEVERITY=MED

,SEVERITY=HI

A required parameter that indicates the severity assigned to the check.

,SEVERITY=LOW: indicates that this is a low-severity check. When a low-severity check detects an exception, an informational WTO is issued.
,SEVERITY=MED: indicates that this is a medium-severity check. When a medium-severity check detects an exception, an eventual action WTO is issued.
,SEVERITY=HI: indicates that this is a high-severity check. When a high-severity check detects an exception, a critical eventual action WTO is issued.

,TIMELIMIT=timelimit

,TIMELIMIT=NO_TIMELIMIT

When REXX=YES and REMOTE=YES are specified, an optional input parameter that is the number of seconds to which the execution of an iteration of the exec is to be limited. A value of 0 is treated the same as "no time limit". TIMELIMIT accepts a value between 0 and 21474536. The default is NO_TIMELIMIT.

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

,USS=NO

,USS=YES

When REMOTE=NO is specified, an optional parameter that indicates whether the check uses z/OS UNIX System Services. This information is used when z/OS UNIX itself is shut down, at which time IBM Health Checker for z/OS will wait for the completion of the running of any non-remote check that has indicated it uses z/OS UNIX before allowing the z/OS UNIX shutdown to complete. Also, when z/OS UNIX are not available, checks that have indicated they use those services are not run. Thus, indicating "YES" if the check actually does not use z/OS UNIX could delay USS shutdown and would result in the check's not being run when those services are not available. The default is USS=NO.

,USS=NO: indicates the check does not use z/OS UNIX.
,USS=YES: indicates the check does use z/OS UNIX.

,USS=NO

,USS=YES

When REXX=NO and REMOTE=YES are specified, an optional parameter that indicates whether the check uses z/OS UNIX System Services. When z/OS UNIX are not available, checks that have indicated they use those services are not run. Thus, indicating "YES" if the check actually does not use z/OS UNIX would result in the check's not being run when those services are not available. The default is USS=NO.

,USS=NO: indicates the check does not use z/OS UNIX.
,USS=YES: indicates the check does use z/OS UNIX.

,USS=NO

,USS=YES

When REXXTSO=YES, REXX=YES and REMOTE=YES are specified, an optional parameter that indicates whether the check uses z/OS UNIX System Services. When z/OS UNIX are not available, checks that have indicated they use those services are not run. Thus, indicating "YES" if the check actually does not use z/OS UNIX would result in the check's not being run when those services are not available. The default is USS=NO.

,USS=NO: indicates the check does not use z/OS UNIX.
,USS=YES: indicates the check does use z/OS UNIX.

,VERBOSE=NO

,VERBOSE=YES

An optional parameter that identifies the initial verbose mode for the check. The default is VERBOSE=NO.

,VERBOSE=NO: indicates that verbose mode is not to be in effect.
,VERBOSE=YES: indicates that verbose mode is to be in effect.