TOM console commands coding conventions

The general format of the console command is

F tom,command[subcommand]commandOptions

where tom is the name of your TOM procedure or identifier, command [subcommand] is one of the MODIFY commands from Table 1, and commandOptions are optional parameters.

If an object, set, object definition base, or calendar definition base name contains lowercase characters, you must enclose the name within single quotation marks in the syntax of your TOM console command. You can enter:
F tom,CMD activate object('cicsprod.sysa') to process an object name that contains lowercase characters. When you do not use single quotation marks, the name is translated to uppercase characters.
Note

For TOM console commands, always enclose an object, set, object definition base, or calendar definition base name within single quotation marks (’).
If an object, set, object definition base, or calendar definition base name contains mixed-case characters, use the Sysout Display and Search Facility (SDSF), enter a single forward slash (/) to invoke the System Command Extension dialog where you can use single quotation marks to issue the command:
F tom,CMD activate object('cicsPROD.sysB') to process an object name that contains mixed-case characters. Parts of the command that do not use single quotation marks are translated as uppercase characters.
The message CK1005I echoes the command in the TOM log that is received by the TOM PAS. You can search for and view this message to see which portions have been processed as uppercase characters.

To issue commands from a program or EXEC, use the TOM functions as described in Command syntax for TOMEXEC functions instead of using the console commands. The TOM programming interface provides return codes, which are much easier to process and more efficient than text responses.

Warning

To avoid high volumes of messages to CONSOLE, SYSLOG, or TOMLOG, use the DEBUG parameter with any of the applicable console commands ONLY when instructed by BMC customer support. Be sure to turn off the DEBUG feature after gathering sufficient documentation.

YES, START, and ON are synonyms, any of which will initiate debugging of a TOM component. NO, STOP, and OFF are synonyms, any of which will halt debugging of a TOM component.

TOM MODIFY console commands and keywords are listed in the following table.

TOM MODIFY commands and keywords

TOM console command	Keywords	Notes
CAlendar	Debug=Yes\|No\|STArt\|STOp\|ON\|OFf	DEBUG turns on or off debugging. Use this only at the request of BMC support.
CMd	See Console command CMD subcommands.
HELP	Not applicable	HELP shows the help available.
IC	Debug=Yes\|No\|STArt\|STOp\|ON\|OFf	DEBUG turns on or off debugging. Use this only at the request of BMC support.
IPc	Debug=YES\|NO\|STArt\|STOp\|ON\|OFf\|Reset	DEBUG turns on or off intersystem communication debugging. Use this only at the request of BMC support.
Logger	Debug=Yes\|No\|STArt\|STOp\|ON\|OFf Forcewto=Yes\|No	DEBUG turns on or off log processing debugging. Use this only at the request of BMC support.
Object	Debug=Yes\|No\|STArt\|STOp\|ON\|OFf Evaluate External,status=Active\|Stopped\|Suspend Show[,Object=x] [,Sort=Ascending\|Descending] [,Tomid=x\|,SYstem=x] [,REL=Children\|Parents],[LEVels=ALL\|n] Variable[,STARt=Yes\|No] [,General=Yes\|No] [,STATe=Yes\|No] [,PRESTArt=Yes\|No] [,PRESTOp=Yes\|No] [,STAretry=Yes\|No] [,STPretry=Yes\|No] [,POSTSTRt=Yes\|No] [,POSTSTOp=Yes\|No] [,Depclnt=Yes\|No] [,STOp=Yes\|No] [,REFRESH]	DEBUG turns on or off object manager debugging. Use this only at the request of BMC support. EVALUATE forces an object evaluation cycle to identify any anomalies. TOM goes through this process automatically when certain activities occur such as the change of an object status. Issuing the OBJECT command with the EVALUATE keyword, allows you to trigger an evaluation at the time of choosing the purposes such as testing or resolution for possible problem. EXTERNAL STATUS allows you to determine whether objects are restarted in order of defined dependencies if they are stopped externally. ACTIVE assigns the status of ACTIVE-ERR to all externally stopped objects. This status unconditionally ensures that any children of the externally stopped parent object will remain active while that object is being restarted. Objects in a status of ACTIVE-ERR will be restarted, but not necessarily in their order of dependency. STOPPED assigns the status of STOPPED-EXTERNAL to all externally stopped objects. This status allows any children of the externally stopped object to remain active if they have a weak dependency relationship with their parent. If a strong dependency relationship is present, the child will be stopped by TOM. Objects stopped and having a status of STOPPED-EXTERNAL will be restarted in their order of dependency. SUSPEND assigns the status of STOPPED to an object which TOM's control has been suspended. SHOW provides a report on the STATUS of each object in the valid system list for the active definition base, summarizing How many objects have been processed. How many of the objects are generated objects (from layers). How many of the objects are in a SUSPEND control mode. SHOW does not report the status of layer or model objects. Sort: sorts the list of objects returned in ascending or descending order. Tomid: returns objects that contains a Valid System List (VSL) entry for the specified TOM ID. If an object has multiple VSL entries then it only shows the entry for the specified TOM ID. SYstem: returns objects containing a VSL entry for the specified system name. If an object has multiple VSL entries then it only shows the entry for the specified system name. REL and LEVels: returns a list of Children or Parent objects for the targeted object VARIABLE causes the addition, update, and deletion of variables in the MainView AutoOPERATOR shared variable pool for objects with a short name attribute specified. You can select which type of variables are to be created for objects. VARIABLE REFRESH forces the refresh of all TOM automation variables. The current automation variables will be deleted and a new set will be added to the shared pool.
PArm	Install=ALL\|INI\|DBG [,TOMPLex=Yes\|No] PArm DIsplay=ALL\|INI\|DBG\|TOM\|PLX\|PLG\|CFG[,Verbose]	INSTALL implements changes made to all of the eligible TOM parameter members, only the MAMINIxx member or only the MAMDBGxx member. TOMPLEX indicates the scope of the parameter install. Yes indicates that all of the TOMs in the TOMPLEX will install the requested member. No means that the change will only be made to the local TOM. PARM DISPLAY shows the parameters and their variable-resolved values for either all of the BBPARM members or the specified BBPARM member. The Verbose (optional) keyword displays the installed, saved, and default values.
REgistry	Debug=Yes\|No DIsplay DUmp,DD(ddname) DUmp,Interval=ON\|OFF\|nnn DUmp,RECDUMP1=dsname DUmp,RECDUMP2=dsname Listbase	DEBUG turns on or off registry debugging. Use this only at the request of BMC support. DISPLAY shows various information about the registry. DUMP DD writes an internal dump of the registry to the data set allocated to the TOM PAS under the given ddname. Recommended DCB is VB, LRECL=8192, BLKSIZE=32760 (or another appropriate BLKSIZE). Use this command to enlarge or decrease the size of the TOM registry. When first using the DUMP command and subsequently the PRIMEDD() keyword in MAMINI00 the registry can be reloaded into a fresh data set. DUMP,Interval is the space of time between periodic registry dumps. The minimum is 5 minutes and the maximum is 720 minutes (12 hours). Specifying YES turns on registry dumps and NO turns off registry dumps. DUMP,RECDUMP1&2 are the data sets for periodic backup used by the Automated Registry Backup facility LISTBASE displays the name of the definition bases defined in the registry and indicates the active definition base.
RTcs	Debug=Yes\|No\|STArt\|STOp\|ON\|OFf Stgtrc=Yes\|No Warnmsg=Yes\|No	Use the RTCS keywords only at the request of BMC support.
SErver	DEBUG=YES\|NO	DEBUG turns on or off debugging. Use this only at the request of BMC support.
SHutdown	Continue Display Set,SHUTMode(Force\| Norm) Set,SHUTTime(nn)	CONTINUE restarts the shutdown logic if it is stuck due to a conflict. Issue this command after you have resolved the conflict (for example by modifying an object definition). DISPLAY shows shutdown status, active objects, objects to be shut down, whether any shutdown conflicts exist, and if so, which objects are involved. SET SHUTMODE(NORM) checks for object dependencies, which might prevent a complete shutdown if objects have cross-system dependencies for systems where TOM is not active. NORM is the default. SET SHUTMODE(FORCE) ignores object dependencies for systems where TOM is not active, ensuring that those dependencies do not interfere with the shutdown. (Object dependencies are still checked on systems where TOM is active.) SET SHUTMODE overrides the SHUTMODE parameter that can optionally be specified in the BBPARM member MAMINInn. For more information, see Parameters that affect shutdown. SET SHUTTIME(nn) modifies how long (up to 60 minutes) TOM attempts to resolve object definition conflicts that would prevent an orderly shutdown. This parameter overrides the SHUTTIME parameter that can optionally be specified in the BBPARM member MAMINInn. For more information, see Parameters that affect shutdown.
SYstem	Debug=Yes\|No	DEBUG turns on or off intersystem communication debugging. Use this only at the request of BMC support.
Tom	DEbug=Yes\|No Plugin=prodName,DEbug=Yes\|No IAM=Calent\|Defbase\|Layerplx\|Object\|SEt\|\|SYslayer\|Tomsys\|Plxlayer,DEbug=Yes\|No	DEBUG turns on or off PAS debugging. Use this only at the request of BMC support. IAM enables/disables tracing for registry access method storage obtain/release requests. You can specify the component that you want to trace and specify DEBUG=YES to begin the trace. Issue the command again with DEBUG=NO to stop the trace. You can use this only at the request of BMC support.
UTility	Debug=Yes\|No, STATS=OD\|PS\|IC\|CN\|TF	DEBUG turns on or off utility debugging. Use this only at the request of BMC support. STATS provides statistical information for the TOM task specified. This information may be requested by BMC support in order to diagnose a problem.

TOM console commands coding conventions

Comments