UNLOCK function
The UNLOCK function corresponds to the UNLock line command, which can be issued for objects from the TOBJOR view or sets from the TSETO view.
Use the UNLOCK function to allow TOM to perform the start process for an object on the system that is specified by the HOST parameter.
An object can have a status of LOCKED as a result of the LOCK, STOP (when RESNEXTIPL is specified), or MOVE (when RESNEXTIPL is specified) commands or functions. If the object is not ACTIVE on any system in its VSL, TOM starts the object on the system specified by the HOST parameter when its dependency and schedule criteria are satisfied.
The following table shows the command and parameters:
Command | Parameters |
|---|---|
TOMEXEC FUNCTION(UNLOCK) | OBJECT(name)|SET(name) HOST(hostname’) [CMDNUMBER(nnn)] [NOTE('xxx')] [TOMID(tom ID) | TOMPLEX(tomplex name)] |
The following table describes the parameters:
Parameter | Function |
|---|---|
OBJECT | Specify the object name to be unlocked. For information about specifying the object name, see Object-and-set-naming-restrictions. |
SET | Specify the set name to be unlocked. For information about specifying the set name, see Object-and-set-naming-restrictions. |
HOST | Specify the name of a MVS system that is specified in the object definition’s valid systems list. The HOST parameter is mutually exclusive with the SET parameter. The HOST parameter is optional. If you do not specify HOST, TOM issues the function on the ACTIVE system. |
CMDNUMBER | When multiple start commands are defined for the object, specify the number of the start command TOM uses when TOM starts the object. If you do not specify the CMDNUMBER keyword, TOM uses the start command that is defined by the object's Default Start Command attribute. |
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. |
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. |