SUSPEND function
The SUSPEND function corresponds to the SUSpend line command, which can be issued for objects from the TOBJOR view or sets from the TSETO view.
When an object is in SUSPEND control mode, TOM does not attempt to start or stop it.
For example, if the object has a schedule indicating that it should be down during from 01:00:00 to 03:59:00, TOM does not stop the object at 01:00:00 if it is in SUSPEND control mode. Some commands might cause the object to start or stop while in SUSPEND control mode. For example, the STOP function with the BYPASSCNTL parameter does cause the object to stop. The LOCK function stops an ACTIVE object even if it is in SUSPEND control mode.
The following table shows the command and parameters:
Command | Parameters |
|---|---|
TOMEXEC FUNCTION(SUSPEND) | OBJECT(name)|SET(name) | ALL DEFBASE(name) SYSPLEX(name) [NOTE('xxx')] IPLLEVEL EVAL MANAGE HOST(system-name) [TOMID(tom ID) | TOMPLEX(tomplex name)] |
The following table describes the parameters:
Parameter | Function |
|---|---|
OBJECT | Specify the object name to be suspended from TOM control (mutually exclusive with the SET parameter). For information about specifying the object name, see Object-and-set-naming-restrictions. |
SET | Specify the set name to be suspended from TOM control (mutually exclusive with the OBJECT parameter). For information about specifying the set name, see Object-and-set-naming-restrictions. |
OPT | Specifies which actions for the named object are to be suspended. The following parameter values: CNTL – The object will be taken out of TOM’s control. TOM will continue to monitor the status of the object and will trigger action against any dependents based on the status changes. TOM will not take action against a suspended object. PRESTARrt – Suspend execution of all pre-start commands defined for the object. STArt – Suspend execution of the specified or default start command. POSTSTArt – Suspend execution of all post-start commands defined for the object. STARTRetry – Suspend execution of all start-retry commands defined for the object. ALLSTArt – Starting of the object will be removed from TOM’s control. Selecting this value will suspend Pre-Start, Start, Post-Start and Start-Retry processing. PRESTOp – Suspend execution of all pre-stop commands defined for the object. STOp – Suspend execution of the specified or default stop command. POSTSTOp – Suspend execution of all post-stop commands defined for the object. STOPRetry – Suspend execution of all stop-retry commands defined for the object. ALLSTOp – Stopping of the object will be removed from TOM’s control. Selecting this value will suspend Pre-Stop, Stop, Post-Stop and Stop-Retry processing. RECovery – Suspend execution of all recovery commands defined for the object. |
ALL | Specify to SUSPEND all objects in the definition base. |
DEFBASE | Specify the object definition base where the item to be SUSPENDed is stored in the registry. This value is associated with the SYSPLEX keyword value. If it is not specified, the currently active object base is used. |
SYSPLEX | Specify the sysplex associated with the definition base (object or calendar) where the item to be SUSPENDed is stored in the registry. If it is not specified, the sysplex of the system where the TOM PAS is running will be used. |
NOTE | Specify a reason for the action taken. By default this parameter is optional but it is required if you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx. If NOTE('xxx') is required but is not specified, the request will be rejected with RC147. Error message MAMOD2035E is written to the log. |
IPLLEVEL | Disables the use of IPLLEVEL after the TOM PAS was started with IPLL=Y or after the ACTIVATE IPLLEVEL command was issued. START or STOP IPLLEVEL commands will not work. |
EVAL | Specifies that TOM will not run an evaluation cycle after initialization completes. EVAL=SUSPEND prevents any request for object evaluation. |
MANAGE | Specifies that TOM will not start or stop objects depending upon feedback from evaluation. |
HOST | Specifies which system the action should affect. This parameter is valid only when used with IPLLEVEL, MANAGE, or EVAL. |
TOMID | Specify the ID of the TOM PAS on which you want the command issued. |
TOMPLEX | Specify the name of the TOMPLEX where you want to issue the function. See Specifying-the-TOMID-and-TOMPLEX-parameters for usage information. |