Console command CMD subcommands

ACTBase

F tom,CMd ACTBase Base(name)

Type(Cal|Def)

• ACTBASE activates an alternate definition or calendar Definition Base on all of the members of a TOMPLEX.
• Type represents a calendar or Definition Base.

ACTIvate

F tom,CMd ACTIvate

Object(name)|Set(name)|ALL|IPLLevel|MANAGE|EVAL

NOTe('xxx')

OPT=(CNTL,PRESTArt,STARt,

           POSTSTArt,STARTRetry,

           ALLSTArt,PRESTOp,STOp,

           POSTSTOp,STOPRetry,

           ALLSTOp,RECovery)

Host(host)

DEFBASE(‘name’)|DB(‘name’)

SYSPLEX(‘name’)

• ACTIVATE places an object (or set of objects) into the control or enables IPLLEVEL, MANAGE, EVAL for a TOM system..
• The ALL parameter ensures that all of objects in the Definition Base are under the control of TOM. The OBJECT and SET parameters are ignored when ALL is specified.

• (optional) NOTE allows you to specify a reason for the action taken. By default, this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but if it is not specified, then the request is rejected. Error message MAMOD2035E is added to the log.

• (optional) OPT allows you to identify which actions for the named object are to be activated. 

• (optional) HOST specifies the system for IPLLEVEL, MANAGE, or EVAL. HOST is not valid with Object, Set or ALL.

  This keyword cannot be combined with the Object or Set keywords.

• MANAGE instructs TOM to resume managing objects. If TOM determines that an object needs to be started or stopped then the appropriate command in the object's definition will be used. MANAGE is valid with Object, Set or ALL.

This keyword cannot be combined with the Object or Set keywords

• EVAL instructs TOM to resume running evaluation cycles. This causes TOM to start or stop objects as needed. This keyword cannot be combined with the Object or Set keywords.
• IPLLEVEL enables the use of IPLLEVEL after the TOM PAS was started with IPLL=N or after the SUSPEND IPLLEVEL command was issued. It allows the use of the START or STOP IPLLEVEL commands.
• (optional) DEFBASE specifies the name of the Definition Base where the named object or set resides.
• (optional) SYSPLEX specifies the name of the sysplex where the named object or set resides.

Block

F tom,CMd Block Object(name)|Set(name)

Host(host) CMDNumber(nnn) NOTe('xxx')

• DB, DEFBase, and SYSPLEX parameters should be added to the BLOCK command:
• (optional) DEFBase or DB specifies the name of the Definition Base where the object or set is stored in the Registry.
• (optional) SYSPLEX specifies the name of the sysplex where the object or set is stored in the Registry.

Bounce

F tom,CMd Bounce Object(name) [FullAuto] [EVENTWAIT(YES|NO)] NOTe('xxx')

F tom,CMd Bounce Set(name) [FullAuto] NOTe('xxx')

• BOUNCE quickly brings down and restarts an object or set without affecting dependent objects that specify the dependency as @STATUS EQ ACTIVE.
• (optional)FULLAUTO specifies that the object's or set's members' pre-stop, post-stop, pre-start, and post-start commands should be executed.
• (optional) EVENTWAIT. The EVENTWAIT values are YES and NO.
  • Specify YES and TOM waits for the object's stop event before processing post-stop and pre-start commands and restarting the object.
  • Specify NO to indicate that TOM does not wait for the object's stop event before processing any post-stop commands, any pre-start commands and restarting the object

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

Lock

F tom,CMd Lock Object(name)|Set (name)

Host(host) CMDNumber(nnn) NOTe('xxx')

IPL(nn)

DEFBASE(‘name’)|DB(‘name’)

SYSPLEX(‘name’)

• LOCK makes the object or set unavailable for starting on the selected system until the next system IPL. The status of the object or set is LOCKED on the selected system.
• (optional) Host specifies the system where TOM will lock the object.
• (optional) CMDNUMBER specifies the number of the STOP command to use when multiple commands are defined.

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

• (optional) IPL specifies the object should be LOCKed starting with the next IPL of the system specified by the HOST() parameter.  If you want it processed for all systems in the valid system list (VSL) then you can specify HOST(*).  HOST(*) is valid only when IPL() is specified.
  When this parameter is specified, the object is not immediately stopped and is not LOCKed until the next IPL.  Valid values are:

• 
  
  • IPL(0) – Reset the “Lock for next nn IPLs” setting.  The object will no longer be LOCKed at IPL of the system specified by the HOST( ) parameter. If the object is currently LOCKed, it will remain LOCKed.  This only resets the LOCK at the next IPL setting.
  • IPL(nn) – Where nn is a number from 1-99 indicates how many IPLs of the system specified by the HOST( ) parameter that the object will be LOCKed.
  • IPL(ALL)–When you specify ALL, the object is locked at every IPL of the system specified by the HOST( ) parameter until LOCK IPL(0) is requested.
• (optional) DEFBase or DB specifies the name of the Definition Base where the object or set is stored in the Registry.
• (optional) SYSPLEX specifies the name of the sysplex where the object or set is stored in the Registry.

Move

F tom,CMd Move Object(name)|Set(name)

Host(host) Tohost(tohost) NOTe('xxx')

[MOVEDEPS]

[MOVEINACT]

[Resnextipl]

• MOVE stops the object or set on the system where it is running and starts it on the specified target system.
• (optional) Host represents the name of a system listed in the object’s valid systems list to move the object from. Do not use Host( ) with Set( ).
• Tothost is the name of a target system listed in the object’s valid systems list where TOM moves the object or set.

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

• MOVEDEPS stops the object and its children in dependency order. The objects have a status of BLOCKED (or LOCKED if RESNEXTIPL is specified) on the system they are being moved from. TOM starts the objects in dependency order on the target system.
• MOVEINACT allows you start an inactive object on the target system. Use MOVEINACT with MOVEDEPS to move an inactive object (and its children) from one system to another system. TOM starts the moved objects in dependency order.
• RESNEXTIPL determines if the status of moving objects will be BLOCKED or LOCKED on all of the systems listed in their VSL (except for the target system). If you specify RESNEXTIPL, TOM sets the status to LOCKED. If you do not specify RESNEXTIPL, TOM sets the status to BLOCKED.

Reset

F tom,CMd Reset

Object(name)|SETname)|DEFBASE(name)

Resetopt([ALl]| [ABendct] [Forced] [Inflight] [STARtcmdct] [STATus] [Runstat] [SUspend] [OMode] ) [CNTLMODE] [IPLOCCUR] | [Oper]

Scope ([All]| [Children] [Parents] [NONE]) NOTe('xxx')

SYSPLEX=name

• For information about the available parameters, see the syntax description for the TOMEXEC RESET command in RESET-function.

RESETOPT ( [IPL]   [LOCKED]  [RUNSTAT]  [TRANS]  [SUSPEND] )

SHUTSEt

F tom,CMd SHUTSEt Set(name) NOTe('xxx')

• SHUTSET shuts down objects within sets in an orderly way.

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

SHUTSYs

F tom,CMd SHUTSYs Host(host),[LOCK] NOTe('xxx')

• SHUTSYS shuts down all objects of a system in an orderly way.
• Host represents the name of the z/OS system where you want to stop all objects.
• (optional) LOCK when specified, TOM bypasses any attempt to restart the objects on alternate systems that have been defined as valid systems for the objects

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

If LOCK is not specified, TOM attempts to startup the objects on alternate systems that have been defined as valid systems for the object.

STArt

STOp

F tom,CMd STOp Object(‘name’)|Set(‘name’)|IPLLevel, Host(‘host’) [,FUllauto][,RESNextipl]

[,HOLd][,BYPASSCNtl] [,BYPASSStrength]

[,TOPtobottom][,BOTtomtotop]

CMDNumber(nnn)

CMDLabel(nnn)

[,FOrce]

[,RESOMode]

NOTe('xxx')

[,LOCKDeps]

• STOP stops an object (or set). If you specify IPLLEVEL, TOM stops the current level of objects.

  You cannot use IPLLEVEL with Object or Set. Only the NOTE or HOST parameters can be specified with IPLLEVEL.

• (optional) FULLAUTO specifies that the object's or set members' pre-stop and post-stop commands will be executed.
• (optional) RESNEXTIPL specifies that the object  or set members will be in LOCKED status when the stop completes. If RESNEXTIPL is not specified, the object(s) will be in BLOCKED status when the stop completes.
• (optional) HOST specifies the system where TOM will stop the object.
• HOLD specifies that the object or set members will be in ACTIVE-HOLD status when the stop completes. If dependent objects specify @STATUS EQ ACTIVE in the dependency property, TOM will not stop them.
• TOPTOBOTTOM stops the named object first. Any children of this object will, depending on relationship strength, stop after the named object.
• (optional) BYPASSCNTL specifies that the object or set members should be stopped even though it/they is/are in SUSPEND control mode.
• (optional) For a dependency-order stop (BOTTOMTOTOP), BYPASSSTRENGTH specifies that the objects in a dependency structure will be stopped even though they have a WEAK relationship with their parent(s).
• BOTTOMTOTOP specifies that the object or set's members and its/their dependents/children should be stopped in dependency order.
• (optional) CMDNUMBER specifies the number of the STOP command to use when multiple commands are defined.
• (optional) CMDLabel stops the object with the STOP commands (pre-stop, post-stop, retry-stop) that match the label specified by this parameter value. If there are pre-stop. stop, post-stop, retry-stop commands that are not labeled, they are also used.
• (optional) FORCE stops the object regardless of its status. For more information about using this subcommand, see the description of the FORCE parameter in the section STOP-function.
• (optional) RESOmode resets the operating mode (OMODE) of the object. When you specify this parameter, the OMODE is reset for an object and TOM might start or stop any objects that specify the @OMODE dependency property and depend on the object being stopped. This command resets only the OMODE setting for the Valid System List (VSL) entry where TOM is stopping the object.

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

• (optional) For a dependency-order stop (BOTTOMTOTOP), LOCKDEPS sets the status of the dependents/children of the object or set members to status LOCKED instead of STOPPED when the stop completes.

  LOCKDEPS is useful for preventing the children from being automatically started by TOM after the dependency order STOP completes in case a complex dependency formula might be satisfied by a different parent of the child.

SUspend

F tom,CMd SUspend Object(name)|Set(name)|ALL|MANAGE|EVAL|IPLLevel

NOTe('xxx')

OPT=(CNTL,PRESTArt,STARt,

           POSTSTArt,STARTRetry,

           ALLSTArt,PRESTOp,STOp,

           POSTSTOp,STOPRetry,

           ALLSTOp,RECovery)

Host(host)

DEFBASE(‘name’)|DB(‘name’)

SYSPLEX(‘name’)

• SUSPEND removes the object or set members or all objects from TOM control; or it disables IPLLEVEL, or MANAGE, or EVAL for the TOM system.
• The ALL parameter specifies that all of objects in the Definition Base are TOM's control. The OBJECT and SET parameters cannot be specified when ALL is specified.
  

• (optional) NOTE allows you to specify a reason for the action taken. By default, this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is added to the log.

• (optional) OPT allows you to identify which actions for the named object are to be suspended.  

•  (optional) HOST specifies the system for IPLLEVEL, MANAGE, or EVAL. It is not valid with Object, Set, or ALL.

   This keyword cannot be combined with the Object or Set keywords.

• MANAGE instructs TOM to suspend managing objects. If TOM determines that an object needs to be started or stopped, then no action will be taken. MANAGE can be specified with Object|Set|ALL.
• EVAL instructs TOM to halt running evaluation cycles. This will cause TOM to not start/stop objects as needed.
• IPLLEVEL disables the use of IPLLEVEL after the TOM PAS was started with IPLL=Y or after the ACTIVATE IPLLEVEL command was issued. It disallows the use of the START or STOP IPLLEVEL commands.
  
• DB|DEFBASE specifies the name of the Definition Base where the named object or set is stored in the Registry. If not specified, the currently active Definition Base is used.
• (optional) SYSPLEX specifies the name of the sysplex where the named object or set is stored in the Registry. If not specified, the local sysplex is used. 
• If SUSPEND OBJ() is specified but OPT() is not specified, OPT(CNTL) is the default.

UNBlock

F tom,CMd UNBlock Object(name)|Set(name) Host(host) CMDNumber(nnn) NOTe('xxx')

DEFBASE(‘name’)|DB(‘name’)

SYSPLEX(‘name’)

• UNBLOCK reverses the BLOCK command.
• (optional) HOST specifies the system where TOM will unblock the object.
• (optional) CMDNUMBER specifies the number of the START command to use when multiple commands are defined.

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

• DB|DEFBASE specifies the name of the Definition Base where the named object or set is stored in the Registry. If not specified, the currently active Definition Base is used.
• (optional) SYSPLEX specifies the name of the sysplex where the named object or set is stored in the Registry. If not specified, the local sysplex is used. 

UNLock

F tom,CMd UNLock Object(name)|Set (name) Host(host) CMDNumber(nnn) NOTe('xxx')

DEFBASE(‘name’)|DB(‘name’)

SYSPLEX(‘name’

• UNLOCK reverses the LOCK command.
• (optional) HOST specifies the system where TOM will unlock the object.
• (optional) CMDNUMBER specifies the number of the START command to use when multiple commands are defined.

• (optional) NOTE allows you to specify a reason for the action taken. By default this parameter is optional but is required when you specify OPER_NOTE_REQUIRED=YES in BBPARM member MAMINIxx.

  If NOTE(‘xxx’) is required but is not specified then the request is rejected. Error message MAMOD2035E is written to the log.

• DB|DEFBASE specifies the name of the Definition Base where the named object or set is stored in the Registry. If not specified, the currently active Definition Base is used.
• (optional) SYSPLEX specifies the name of the sysplex where the named object or set is stored in the Registry. If not specified, the local sysplex is used.