List of object reference variables
The available reference variables and their possible values are described in the following table.
Reference variable name | Resolves to | Applicable object extension |
|---|---|---|
START.DEFLABEL | Default start command label | STM UPM WRM GSM |
STOP.DEFLABEL | Default stop command label | STM UPM WRM GSM |
ACTCHKPGM.1.RESPONSE | MVS command response text indicating that the item associated with this object is in an up/active state. | STM UPM WRM GSM |
ACTCHKPGM.1.RESPLNNR | MVS command response line number containing the text in MVS command response (@ACTCHKPGM.1.RESPONSE) | STM UPM WRM GSM |
GSM.ITEM | Item name associated with this GSM Extension object | Generic Stateless Mgmt (GSM) |
AFFINITY | Affinity setting of High, Med, or Low | STM UPM WRM GSM |
CONTROL or CNTL | Setting of either ACTIVE or SUSPEND | STM UPM WRM GSM |
DESCRIPTION | Object description | STM UPM WRM GSM |
FULLCMD | Full command and parameters that start the USS process; for example: /usr/bin/mypgm -f /usr/var/mylog | UPM |
IPLSTART | Setting of either Yes or No | STM UPM WRM GSM |
JOBNAME | Jobname associated with the address space where the USS process executes | UPM |
MDLTYPE | Setting of either Yes (a model) or No (not a model) | STM UPM WRM GSM |
OBJNAME | Object name | STM UPM WRM GSM |
PID | Process-ID of the USS process | UPM |
PPID | Process-ID of the parent process of the USS process | UPM |
PRODUCT | Product name to which this object is associated with | STM UPM WRM GSM |
RESTART | Setting of either Yes or No | STM UPM WRM GSM |
RESTIME | Number of minutes to wait before resetting start count | STM UPM WRM GSM |
SHORTNAME | Unique short name | STM UPM WRM GSM |
SHUTDOWN | Setting of either Normal (for a shutdown where automation is performed) or Quick (where shutdown is performed without automation tasks) | STM UPM WRM GSM |
STCNAME | Name of a Started Task (STC) | STM |
STEPNAME | Name of a step of a Started Task (STC) Some third-party products might assign a stepname at startup, which appears in IBM z/OS control blocks as if the name was entered with the start command. | STM |
STRENGTH | Parent to all its children dependency strength | STM UPM WRM GSM |
TYPE | Object type of either Norm (normal objects) or TRAN (transient objects) | STM UPM WRM GSM |
ABENDEVT.n.ID | Message ID from the abend event | STM UPM WRM GSM |
ABENDEVT.n.TYPE | Event type (CMD, JRNL, or MSG) from the abend event | STM UPM WRM GSM |
ABENDEVT.n.TEXT | Message text from the abend event | STM UPM WRM GSM |
ABENDEVT.n.ORIGINSTC | Name of the originating Started Task from the abend event | STM UPM WRM GSM |
ABENDEVT.n.STEP | PROC or JOB step name for the abend event | STM UPM WRM GSM |
ACTCHKPGM.1.CMD | Active check command and any parameters | STM UPM WRM GSM |
ACTCHKPGM.1.TYPE | Command type setting of either MVS, EXEC, USS command or AOSV name | STM UPM WRM GSM |
ACTCHKPGM.1.USERNAME | User name associated with the USS process that runs the Active Check Program command when the command type is USS | STM UPM WRM GSM |
ACTCHKPGM.1.SPAWNJOB | Job name assigned to the address space where the USS process runs for the Active Check Program command when the command type is USS | STM UPM WRM GSM |
CMDCON.NAME | Command console name | STM UPM WRM GSM |
DEP.n.CHILDSTR | Child to parent dependency strength (can override the strength specified) | STM UPM WRM GSM |
DEP.n.NAME | Dependency object or set name | STM UPM WRM GSM |
DEP.n.SYSNAME | Dependency on system | STM UPM WRM GSM |
DEP.n.PROP | Either @STATUS, or OMODE. or a user-defined property for this dependency | STM UPM WRM GSM |
DEP.n.OP | Comparison symbol for the dependency (such as EQ, NE, and so on) | STM UPM WRM GSM |
DEP.n.VALUE | Value to be compared against either the user property specified in the property field, or the status of the object or set | STM UPM WRM GSM |
HOSTS.n.SYSNAME | Name of system in the object's eligible systems list | STM UPM WRM GSM |
POSTSTART.n.CMD | Post-start command | STM UPM WRM GSM |
POSTSTART.n.DESCR | Post-start description | STM UPM WRM GSM |
POSTSTART.n.INTVL | Post-start interval | STM UPM WRM GSM |
POSTSTART.n.LABEL | Post-start command label | STM UPM WRM GSM |
POSTSTART.n.MAX | Post-start maximum | STM UPM WRM GSM |
POSTSTART.n.SPAWNJOB | Job name assigned to the address space where the USS process runs for the post-start command when the command type is USS | UPM WRM |
POSTSTART.n.TYPE | Valid values are MVS, EXEC, AOSV, USS, TOM, VPUT, LOG, JRNL, WTO | STM UPM WRM GSM |
POSTSTART.n.USERNAME | Job name assigned to the address space where the USS process runs for the start-retry command when the command type is USS | UPM WRM |
POSTSTART.n.WAITCMPL | Valid values are Y or N | STM UPM WRM GSM |
POSTSTOP.n.CMD | Post-stop command | STM UPM WRM GSM |
POSTSTOP.n.DESCR | Post-stop description | STM UPM WRM GSM |
POSTSTOP.n.INTVL | Post-stop interval | STM UPM WRM GSM |
POSTSTOP.n.LABEL | Post-stop command label | STM UPM WRM GSM |
POSTSTOP.n.MAX | Post-stop maximum | STM UPM WRM GSM |
POSTSTOP.n.SPAWNJOB | Job name assigned to the address space where the USS process runs for the post-stop command when the command type is USS | UPM WRM |
POSTSTART.n.TIMEOUT | Number of seconds to wait for completion of command if wait-for-completion=Y | STM UPM WRM GSM |
POSTSTOP.n.TIMEOUT | Number of seconds to wait for completion of command if wait-for-completion=Y | STM UPM WRM GSM |
POSTSTOP.n.USERNAME | User name associated with the USS process that runs the post-stop command when the command type is USS | UPM WRM |
POSTSTOP.n.WAITCMPL | Valid values are Y or N | STM UPM WRM GSM |
PRESTART.n.CMD | Pre-start command | STM UPM WRM GSM |
PRESTART.n.DESCR | Pre-start description | STM UPM WRM GSM |
PRESTART.n.INTVL | Number of seconds to delay execution of command | STM UPM WRM GSM |
PRESTART.n.LABEL | Pre-start command label | STM UPM WRM GSM |
PRESTART.n.SPAWNJOB | Job name assigned to the address space where the USS process runs for the pre-start command when the command type is USS | UPM WRM |
PRESTART.n.TIMEOUT | Number of seconds to wait for completion of command if wait-for-completion=Y | STM UPM WRM GSM |
PRESTART.n.TYPE | Valid values are MVS, EXEC, AOSV, USS, TOM, VPUT, LOG, JRNL, WTO | STM UPM WRM GSM |
PRESTART.n.USERNAME | User name associated with the USS process that runs the pre-start command when the command type is USS | UPM WRM |
PRESTART.n.WAITCMPL | Y, Nalid values are Y or N | STM UPM WRM GSM |
PRESTOP.n.CMD | Pre-stop command | STM UPM WRM GSM |
PRESTOP.n.DESCR | Pre-stop description | STM UPM WRM GSM |
PRESTOP.n.INTVL | Number of seconds to delay execution of command | STM UPM WRM GSM |
PRESTOP.n.SPAWNJOB | Job name assigned to the address space where the USS process runs for the pre-stop command when the command type is USS | UPM WRM |
PRESTOP.n.TIMEOUT | Number of seconds to wait for completion of command if wait-for-completion=Y | STM UPM WRM GSM |
PRESTOP.n.TYPE | Valid values are MVS, EXEC, AOSV, USS, TOM, VPUT, LOG, JRNL, WTO | STM UPM WRM GSM |
PRESTOP.n.USERNAME | User name associated with the USS process that runs the pre-stop command when the command type is USS | UPM WRM |
PRESTOP.n.WAITCMPL | Valid values are Y or N | STM UPM WRM GSM |
RECOVERY.CMD | Recovery command and any parameters | STM UPM WRM GSM |
RECOVERY.SPAWNJOB | Job name assigned to the address space where the USS process runs for the recovery command when the command type is USS | UPM WRM |
RECOVERY.TYPE | Command type setting of either MVS, EXEC, USS command or AOSV name | STM UPM WRM GSM |
RECOVERY.USERNAME | User name associated with the USS process that runs the recovery command when the command type is USS | UPM WRM |
RECOVERY.n.CMD | Recovery command text | STM UPM WRM GSM |
RECOVERY.n.INTVL | Number of seconds to delay execution of command | STM UPM WRM GSM |
RECOVERY.n.LABEL | Recovery command label | STM UPM WRM GSM |
RECOVERY.n.SPAWNJOB | Job name assigned to the address space where the process runs for the recovery command when the command type is USS | STM UPM WRM GSM |
RECOVERY.n.TIMEOUT | Number of seconds to wait for completion of command if wait-for-completion=YES | STM UPM WRM GSM |
RECOVERY.n.TYPE | Valid values are MVS, EXEC, AOSV, USS, TOM, VPUT, LOG, JRNL, WTO | STM UPM WRM GSM |
RECOVERY.n.USERNAME | User name associated with the USS process that runs the command when the command type is USS | STM UPM WRM GSM |
RECOVERY.n.WAITCMPL | Valid values are Y or N | STM UPM WRM GSM |
SERVER.n.CONNCMD | Connect command | STM UPM WRM GSM |
SERVER.n.CONNTYPE | Command type setting of either MVS (for an MVS command), EXEC (for an EXEC), USS command or AOSV name | STM UPM WRM GSM |
SERVER.n.CSPWNJOB | Job name assigned to the address space where the USS process runs for the server connect command when the command type is USS | UPM WRM |
SERVER.n.CUSRN | User name associated with the USS process that runs the server-connect command when the command type is USS | STM UPM WRM GSM |
SERVER.n.DISCCMD | Disconnect command | STM UPM WRM GSM |
SERVER.n.DISCTYPE | Command type setting of either MVS (for an MVS command), EXEC (for an EXEC), USS command or AOSV name | STM UPM WRM GSM |
SERVER.n.DSPWNJOB | Job name assigned to the address space where the USS process runs for the server disconnect command when the command type is USS | UPM WRM |
SERVER.n.DUSRN | User name associated with the USS process that runs the server-disconnect command when the command type is USS | STM UPM WRM GSM |
SERVER.n.SERVOBJ | Server object name | STM UPM WRM GSM |
START.DEFAULT | Number of the default command | STM UPM WRM GSM |
START.n.CMD | START command | STM UPM WRM GSM |
START.n.LABEL | Start command label | STM UPM WRM GSM |
START.n.MAX | START maximum | STM UPM WRM GSM |
START.n.SPAWNJOB | Job name assigned to the address space where the USS process runs when the command type is USS | UPM WRM |
START.n.TIMEOUT | Numeric start timeout value | STM UPM WRM GSM |
START.n.TYPE | Command type setting of either MVS (for an MVS command), EXEC (for an EXEC), USS command or AOSV name | STM UPM WRM GSM |
START.n.USERNAME | User name associated with the USS process when the command type is USS | UPM WRM |
STARTEVT.n.ID | Message ID from the startup event | STM UPM WRM GSM |
STARTEVT.n.ORIGINSTC | Name of the originating Started Task from the startup event | STM UPM WRM GSM |
STARTEVT.n.STEP | PROC or JOB step name for the start event | STM UPM WRM GSM |
STARTEVT.n.TEXT | Message text from the startup event | STM UPM WRM GSM |
STARTEVT.n.TYPE | Event type (either CMD, JRNL, or MSG) from the startup event | STM UPM WRM GSM |
STARTRETRY.n.CMD | START RETRY command | STM UPM WRM GSM |
STARTRETRY.n.LABEL | START RETRY command label | STM UPM WRM GSM |
STARTRETRY.n.MAX | START RETRY maximum | STM UPM WRM GSM |
STARTRETRY.n.DESCR | START RETRY description | STM UPM WRM GSM |
STARTRETRY.n.SPAWNJOB | Additional job name that identifies USS processes for UPM objects | UPM WRM |
STARTRETRY.n.TIMEOUT | START RETRY timeout | STM UPM WRM GSM |
STARTRETRY.n.TYPE | Command type setting of either MVS (for an MVS command), EXEC (for an EXEC), USS command or AOSV name | STM UPM WRM GSM |
STARTRETRY.n.USERNAME | User name associated with the USS process that runs the start-retry command when the command type is USS | UPM WRM |
STOP.DEFAULT | Number of the default command | STM UPM WRM GSM |
STOP.n.CMD | STOP command | STM UPM WRM GSM |
STOP.n.LABEL | Stop command label | STM UPM WRM GSM |
STOP.n.SPAWNJOB | Job name assigned to the address space where the USS process runs for the stop command when the command type is USS | UPM WRM |
STOP.n.TIMEOUT | Numeric stop timeout value | STM UPM WRM GSM |
STOP.n.TYPE | Command type setting of either MVS (for an MVS command), EXEC (for an EXEC), USS command or AOSV name | STM UPM WRM GSM |
STOP.n.USERNAME | User name associated with the USS process that runs the stop command when the command type is USS | UPM WRM |
STOPEVT.n.ID | Message ID from the stop event | STM UPM WRM GSM |
STOPEVT.n.ORIGINSTC | Name of the originating Started Task from the stop event | STM UPM WRM GSM |
STOPEVT.n.STEP | PROC or JOB step name for the stop event | STM UPM WRM GSM |
STOPEVT.n.TEXT | Message text from the stop event | STM UPM WRM GSM |
STOPEVT.n.TYPE | Event type (CMD, JRNL, or MSG) from the stop event | STM UPM WRM GSM |
STOPRETRY.n.CMD | STOP RETRY command | STM UPM WRM GSM |
STOPRETRY.n.DESCR | STOP RETRY description | STM UPM WRM GSM |
STOPRETRY.n.LABEL | STOP RETRY command label | STM UPM WRM GSM |
STOPRETRY.n.MAX | STOP RETRY maximum | STM UPM WRM GSM |
STOPRETRY.n.SPAWNJOB | Job name assigned to the address space where the USS process runs for the stop command when the command type | UPM WRM |
STOPRETRY.n.TIMEOUT | STOP RETRY timeout | STM UPM WRM GSM |
STOPRETRY.n.TYPE | Command type setting of MVS (for an MVS command), EXEC (for an EXEC), USS command or AOSV name | STM UPM WRM GSM |
STOPRETRY.n.USERNAME | User name associated with the USS process that runs the stop-retry command when the command type is USS | UPM WRM |
UPM.IDJOB | Job name for a specific USS process when multiple USS processes have the same process command and parameters | UPM |
USER1 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER2 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER3 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER4 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER5 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER6 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER7 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
USER8 | User-entered 32-byte value that appears on views that display objects; this value can be used to filter these object views | STM UPM WRM GSM |
VERIFY.START | Specifies whether TOM issues a WTOR before starting the object | STM UPM WRM GSM |
VERIFY.START.DEFAULT | Specifies how TOM should reply to the WTOR after the reply time period has elapsed | STM UPM WRM GSM |
VERIFY.START.TIMEOUT | Specifies how long TOM should wait for an operator response to the WTOR before responding with the default reply | STM UPM WRM GSM |
VERIFY.STOP | Specifies whether TOM issues a WTOR before stopping the object | STM UPM WRM GSM |
VERIFY.STOP.DEFAULT | Specifies how TOM should reply to the WTOR after the reply time period has elapsed | STM UPM WRM GSM |
VERIFY.STOP.TIMEOUT | Specifies how long TOM should wait for an operator response to the WTOR before responding with the default reply | STM UPM WRM GSM |
WRM.RESOURCE | Name of a Work Load Manager (WLM) resource | WRM |