|
|
|
Parsing, syntax analysis, and semantic analysis |
Generic command interface for multiple executable routines having character-based command tree6738781
Abstract
A processor based system includes a parser, configured for identifying whether an input word received from a user is a new command word relative to a character-based command parse tree, and a tree management process configured for managing the character-based command parse tree. The character-based command parse tree includes multiple element levels for respective character positions for each known command word, and at least one character element at each level. Each character element specifies at least one corresponding character component and a corresponding at least one index value. The parser determines whether the input word is a new command word based on whether the characters of the input word match successive elements, with the last character matching an end node, within the character-based parse tree; if the parser determines that the input word is a new command word, the tree management process performs update operations to accommodate the new command word, including updating the character-based command parse tree with the new command word.
Claims
What is claimed is:
1. A method in a processor-based system configured for executing a plurality of management programs according to respective command formats, the method comprising:
receiving from a user an input word representing at least a portion of a generic command;
determining whether the input word is a new command word relative to a character-based command parse tree configured for identifying known command words;
selectively adding the input word to the character-based command parse tree based on determining that the input word is a new command word;
validating the generic command following the selectively adding step; and issuing a prescribed command of a selected one of the management programs according to the corresponding command format, based on validating the generic command;
wherein the determining step includes:
comparing a first character of the input word with a group of first character elements at a root level of the character-based command parse tree, the first character elements including respective initial characters of the known command words;
successively traversing to a linked character element in an adjacent level of the character-based command parse tree based on a corresponding match between a corresponding character of the input word and a corresponding matched character element of the character-based a command parse tree; and
identifying the input word as a new command word based on a determined absence of a match for one character of the input word relative to the linked character elements.
2. The method of claim 1, wherein the successively traversing step includes identifying the linked character element in the adjacent level based on a linked index value.
3. The method of claim 1, wherein the validating step includes:
comparing each input command word, including the input word, to a command word translation table, configured for storing for each prescribed command word a corresponding token, for identification of a matching token; and
determining a presence of the matching token within the command parse tree for each input command word.
4. The method of claim 3, wherein the determining step includes recursively traversing the command parse tree based on an order of the input command words for identification of the matching token within the identified one element.
5. the method of claim 4, wherein the issuing step includes issuing the prescribed command based on a corresponding command key specified for the matching token within the identified one element.
6. The method of claim 5, wherein the issuing step further includes accessing a prescribed translator configured for converting the generic command according to the corresponding command format into the prescribed command based on the corresponding command key.
7. The method of claim 1, wherein the validating step includes:
traversing a command parse tree that specifies valid generic commands relative to a prescribed generic command format, the command parse tree having elements each specifying at least one corresponding generic command component and a corresponding at least one command action value; and
identifying one of the elements of the command parse tree as a best match relative to the generic command.
8. The method of claim 7, wherein the issuing step includes issuing the prescribed command based on the identified one element corresponding to the portion of the generic command.
9. The method of claim 8, further comprising executing the prescribed command within the corresponding selected one management program.
10. A computer readable medium having stored thereon sequences of instructions for executing a plurality of management programs according to respective command formats, the sequences of instructions including instructions for performing the steps of:
receiving from a user an input word representing at least a portion of a generic command;
determining whether the input word is a new command word relative to a character-based command parse tree configured for identifying known command words;
selectively adding the input word to the character-based command parse tree based on determining that the input word is a new command word;
validating the generic command following the selectively adding step; and issuing a prescribed command of a selected one of the management programs according to the corresponding command format, based on validating the generic command;
wherein the determining step includes:
comparing a first character of the input word with a group of first character elements at a root level of the character-based command parse tree, the first character elements including respective initial characters of the known command words;
successively traversing to a linked character element in an adjacent level of the character-based command parse tree based on a corresponding match between a corresponding character of the input word and a corresponding matched character element of the character-based a command parse tree; and
identifying the input word as a new command word based on a determined. absence of a match for one character of the input word relative to the linked character elements.
11. The medium of claim 10, wherein the successively traversing step includes identifying the linked character element in the adjacent level based on a linked index value.
12. The medium of claim 10, wherein the validating step includes:
comparing each input command word, including the input word, to a command word translation table, configured for storing for each prescribed command word a corresponding token, for identification of a matching token; and
determining a presence of the matching token within the command parse tree for each input command word.
13. The medium of claim 12, wherein the determining step includes recursively traversing the command parse tree based on an order of the input command words for identification of the matching token within the identified one element.
14. The medium of claim 13, wherein the issuing step includes issuing the prescribed command based on a corresponding command key specified for the matching token within the identified one element.
15. The medium of claim 14, wherein the issuing step further includes accessing a prescribed translator configured for converting the generic command according to the corresponding command format into the prescribed command based on the corresponding command key.
16. The medium of claim 10, wherein the validating step includes:
traversing a command parse tree that specifies valid generic commands relative to a prescribed generic command format, the command parse tree having elements each specifying at least one corresponding generic command component and a corresponding at least one command action value; and
identifying one of the elements of the command parse tree as a best match relative to the generic command.
17. The medium of claim 16, wherein the issuing step includes issuing the prescribed command based on the identified one element corresponding to the portion of the generic command.
18. The medium of claim 17, further comprising instructions for performing the step of executing the prescribed command within the corresponding selected one management program.
19. A system configured for executing a plurality of management programs according to respective command formats, the system comprising:
means for receiving from a user an input word representing at least a portion of a generic command;
means for determining whether the input word is a new command word relative to a character-based command parse tree configured for identifying known command words;
means for selectively adding the input word to the character-based command parse tree based on determining that the input word is a new command word;
means for validating the generic command following the selectively adding step; and
means for issuing a prescribed command of a selected one of the management programs according to the corresponding command format, based on validating the generic command;
wherein the determining means includes:
means for comparing a first character of the input word with a group of first character elements at a root level of the character-based command parse tree, the first character elements including respective initial characters of the known command words;
means for successively traversing to a linked character element in an adjacent level of the character-based command parse tree based on a corresponding match between a corresponding character of the input word and a corresponding matched character element of the character-based a command parse tree; and
means for identifying the input word as a new command word based on a determined absence of a match for one character of the input word relative to the linked character elements.
20. The system of claim 19, wherein the successively traversing means is configured for identifying the linked character element in the adjacent level based on a linked index value.
21. The system of claim 19, wherein the validating means includes:
means for comparing each input command word, including the input word, to a command word translation table, configured for storing for each prescribed command word a corresponding token, for identification of a matching token; and
means for determining a presence of the matching token within the command parse tree for each input command word.
22. The system of claim 21, wherein the determining means is configured for recursively traversing the command parse tree based on an order of the input command words for identification of the matching token within the identified one element.
23. The system of claim 22, wherein the issuing means is configured for issuing the prescribed command based on a corresponding command key specified for the matching token within the identified one element.
24. The system of claim 23, wherein the issuing means is configured for accessing a prescribed translator configured for converting the generic command according to the corresponding command format into the prescribed command based on the corresponding command key.
25. The system of claim 19, wherein the validating means includes:
means for traversing a command parse tree that specifies valid generic commands relative to a prescribed generic command format, the command parse tree having elements each specifying at least one corresponding generic command component and a corresponding at least one command action value; and
means for identifying one of the elements of the command parse tree as a best match relative to the generic command.
26. The system of claim 25, wherein the issuing means is configured for issuing the prescribed command based on the identified one element corresponding to the portion of the generic command.
27. The system of claim 26, further comprising means for executing the prescribed command within the corresponding selected one management program.
Description
BACKGROUND OF THE INVENTION
1. Field of the Invention
The present invention relates to command and interface control of Operating Administration and Monitoring (OAM) executable routines within software systems.
2. Description of the Related Art
Operating Administration and Monitoring (OAM) tools are software-based resources used as administration and/or diagnostic tools for complex processor-based executable software systems, such as software-based unified messaging software systems. A subset of OAM tools includes Real Time Monitoring (RTM) programs, used to monitor and control selected states and processes within the software based system. For example, a given RTM program may generate a real-time display (i.e., "a screen") of selected parameters during execution of a prescribed process; the RTM program may also provide a diagnostic resource that enables resetting of various states or variables within the prescribed process. Other administration and diagnostic tools include external binary files that execute in response to a procedure call, and Simple Network Management Protocol (SNMP) agents or scripts configured for generating an e-mail message as an alarm in response to a detected event.
Hence, system administrators may attempt to utilize multiple tools within a software system in order to increase the available administration and diagnostic tools for improved system performance. The use of multiple RTM programs and other OAM tools, however, requires the users to remember the names and syntaxes of numerous commands for the respective RTM programs and OAM tools. Hence, an increase in the number of OAM tools would result in the system administrator needing to develop expertise in the command names and syntaxes for the respective OAM tools.
The commonly-assigned, copending application Ser. No. 09/604,880 discloses validation of a generic command relative to a command parse tree. The command parse tree includes multiple elements, each specifying at least one corresponding generic command component and a corresponding command action value. A parser, upon identifying a best match between the command parse tree elements and the received generic command, issues a prescribed command for a selected management program according to the corresponding command format. Hence, a user may control multiple management programs having respective command formats in a manner that eliminates the necessity that the user needs to know detailed command formats and syntaxes of each management program.
The addition of new commands, however, requires maintenance processing for the addition of new elements to the command parse tree. For example, each word in the new command needs to be compared to a dictionary of valid words in the system. In addition, for any new words found, a token number needs to be defined, and the word to token algorithm needs to be modified to include any new word in the string to token encoding.
SUMMARY OF THE INVENTION
There is a need for an arrangement that enables a simple command language to be utilized for control of multiple RTM programs having respective command formats, wherein new commands can be automatically added without manual reconfiguration of the system by a system administrator.
These and other needs are attained by the present invention, where a processor based system includes a parser, configured for identifying whether an input word received from a user is a new command word relative to a character-based command parse tree, and a tree management process configured for managing the character-based command parse tree. The character-based command parse tree includes multiple element levels for respective character positions for each known command word, and at least one character element at each level. Each character element specifies at least one corresponding character component and a corresponding at least one index value. The parser determines whether the input word is a new command word based on whether the characters of the input word match successive elements, with the last character matching an end node, within the character-based parse tree; if the parser determines that the input word is a new command word, the tree management process performs update operations to accommodate the new command word, including updating the character-based command parse tree with the new command word.
One aspect of the present invention provides a method in a processor-based system configured for executing a plurality of management programs according to respective command formats. The method includes receiving from a user an input word representing at least a portion of a generic command, and determining whether the input word is a new command word relative to a character-based command parse tree configured for identifying known command words. The method also includes selectively adding the input word to the character-based command parse tree based on determining that the input word is a new command word. The method also includes validating the generic command, and issuing a prescribed command of a selected one of the management programs according to the corresponding command format, based on validating the generic command.
Another aspect of the present invention provides a system configured for executing a plurality of management programs according to respective command formats. The system includes a parser configured for accessing a character-based command parse tree for identifying whether an input word of a generic command received from a user is a new command word, and a command parse tree for validating the generic command. The system also includes a tree management process configured for selectively adding the input word to the character-based command parse tree and the command parse tree based on a determination that the input word is a new command word, and translators. The translators are configured for issuing commands for the management programs according to respective command formats, the parser outputting a prescribed command to a selected one of the translators based on the validating of the generic command.
Additional advantages and novel features of the invention will be set forth in part in the description which follows and in part will become apparent to those skilled in the art upon examination of the following or may be learned by practice of the invention. The advantages of the present invention may be realized and attained by means of instrumentalities and combinations particularly pointed out in the appended claims.
BRIEF DESCRIPTION OF THE DRAWINGS
Reference is made to the attached drawings, wherein elements having the same reference numeral designations represent like elements throughout and wherein:
FIG. 1 is a diagram of a system configured for executing multiple management programs according to respective command formats based on a generic command set according to an embodiment of the present invention.
FIGS. 2A and 2B are diagrams illustrating a command parse tree and the character-based command parse tree used by the parser of FIG. 1, respectively, according to an embodiment of the present invention.
FIGS. 3A and 3B are diagrams summarizing the method of validating and adding generic commands by the parser of FIG. 1 according to an embodiment of the present invention.
BEST MODE FOR CARRYING OUT THE INVENTION
The disclosed embodiment is directed to an improvement of the generic command interface disclosed in the above-incorporated application Ser. No. 09/604,880, where a character-based command parse tree and a tree management process is added to enable the generic command interface system to automatically update itself upon detecting a new command word. In particular, the character-based command parse tree is used to determine whether an input word is a new command word relative to known command words; if the input word is determined to be a new command word, the tree management process updates the character-based command parse tree and existing data structures within the generic command interface (e.g., the command parse tree and associated command word translation tables), enabling the automatic addition of the new command word.
Hence, the disclosed arrangement eliminates the necessity for manually modifying hard-coded data structures in response to the addition of new command words to the generic command interface, improving the overall flexibility of the generic command interface.
FIG. 1 is a diagram of a system configured for executing a plurality of management programs according to respective command formats according to an embodiment of the present invention. The processor based system 10 includes a user input interface 12, for example a terminal interface, that enables a user to input a generic command string, described below. The processor based system 10 also includes a parser 14 configured for validating the generic command received by the user input interface 12 from the user, an executable tree management process 15 configured for managing parse trees 22 and 23 accessible by the parser 14, and translators 16 configured for issuing commands to respective management programs 18 according to respective command formats. The parse trees 22 and 23 are described below with reference to FIGS. 2A and 2B.
As shown in FIG. 1, the management programs 18, implemented for example by different OAM tools such as RTM programs, may be executed within the processor based system or externally as external agents accessible using a prescribed application programming interface (API). The management programs 18 may provide different administration and maintenance functions, for example initiating various real-time screens used to monitor the internal state of executable processes within the software based system 10; alternately, different tools 18 may allow the user to control the various states within the various component of the software based system 10 via external programs (e.g., programs 18c or 18d), or may be used to issue external alarms (e.g., SNMP manager scripts) for external routines such as message waiting indicator routines.
A disadvantage of utilizing many different tools 18 is that each tool 18 tends to have its own screen and/or command, providing difficulties for the system administrator to determine which tool is the best tool (and/or which is the best syntax) to use for a given problem.
According to the disclosed embodiment, the parser 14 and the translators 16 provide a unified administration and diagnostic tool which incorporates the functionality of all external administrative executable binary files, RTM programs, agent manipulation scripts, and various requested snapshot queries, as well as including an extensive help system. In particular, the parser 14 and the translators 16 provide a generic command syntax that integrates the functionality of the different tools 18 and that automatically selects the appropriate command for the best tool for executing a given generic command. As illustrated in Part A. of the attached appendix, the new syntax provides a generic instruction set that provides an abstraction of the tool-specific command formats and syntax, enabling a user to issue command based on the relative functions, as opposed to the specific syntax for a corresponding tool 18.
In addition, the tree management process 15 enables the data structures within the processor based system 10 to be dynamically updated upon detecting a new command word using the character-based command parse tree 23, described below with respect to FIG. 2B.
FIG. 2A is a diagram illustrating in detail the parser 14 of FIG. 1 according to an embodiment of the present invention. The parser 14 includes a command word translation table 20, a (word/token based) command parse tree 22, and a character-based command parse tree 23. The character-based command parse tree 23 is illustrated in further detail in FIG. 2B.
The command word translation table 20 of FIG. 2A is configured for storing, for each prescribed command word 26, a corresponding token value 28 that is used by the parser 14 to identify a specific command for a selected one of the translators 16. In particular, the command word translation table 20 includes all the command words 26 that are valid according to the generic syntax, illustrated for example in Part B of the attached appendix.
The parser 14 is configured for determining whether an input word is a new command word or a known command word using the character-based command parse tree 23, and validating a received generic command. In particular, assuming an input generic command includes all known command words, the parser 14 validates the received generic command by comparing each input command word to the command parse tree 22 to determine for the received generic command a tree element 24 identified as a best match. Each tree element 24 includes at least one token-command key pair 30 that specifies a token (T) 28 and a corresponding command key (CK) 32, enabling the parser 14 to identify the appropriate prescribed command based on the command key specified for the matching token. In particular, the parser 14 recursively traverses the command parse tree 22 for each command word to identify the best match for the generic command. If only a portion of the generic command is identified as valid (e.g., only the first three command words are valid), the parser 14 selects the command key 32 for the matching token 28 from the last valid tree element 24.
As described above, the parser 14 is configured for accessing whether an input word is a new command word or a known command word using the character-based command parse tree 23. The character-based command parse tree 23, illustrated in FIG. 2B, includes multiple levels 60 of character elements 62 representing characters of known command words. Each character element 62 has a corresponding character component and a corresponding integer word key 68 (i.e., index value) that uniquely identifies the character element 62. Hence, each known known command word is identified by a corresponding word token identified by the word key 68 of the last character of the word, where the word "get" has a corresponding word token "3" from the word key 68 of character element 62c, and the word "watch" has a corresponding word token "A" (hexadecimal representation for "10") from the word key 68 of character element 62j. In addition, each level 60 corresponds to a character position of a known command word, where the root level 60a includes character elements 62a and 62d that correspond to the initial character of known command words "get", "wait", and "watch". The adjacent levels 60b, 60c, 60d, and 60e are used to identify the second, third, fourth, and fifth character positions of a command word, respectively.
Hence, the parser 14 is able to determine that the input word "get" is a known command word based on parsing the tree 23 on a character by character basis until the last character of the word matches an end node. Similarly, the parser 14 is able to determine that the input word "wait" is a known command word based on parsing the tree 23 to reach the end node 62g having the word key "7". The parser 14 is able to determine that the input word "watch" is a known command word based on parsing the tree 23 to reach the end node 62j having the word key "A".
FIGS. 3A and 3B are diagrams summarizing the method of validating a received generic command and translating the received generic command into a command for a specific management program according to an embodiment of the present invention. The operations described with respect to FIGS. 2A, 2B, 3A, and 3B can be implemented as executable code that is stored on a computer readable medium (e.g., a hard disk drive, a floppy drive, a random access memory, a read only memory, an EPROM, a compact disk, etc).
The method begins in step 40, where the parser 14 receives an input word from the user input interface 12. The parser 14 compares in step 42 the first character of the input word with the character elements 62a, 62d at the root level 60a. If in step 44 the parser 14 does not detect a match between the first character and the root level character elements, the parser 14 notifies the tree management process 15, causing the tree management process 15 to add in step 56 the new word to the trees 22 and 23, as well as the translation table 20. If the parser 14 detects in step 44 a match between the first character and one of the root level character elements, the parser checks in step 46 whether there are additional characters for comparison. If there are more characters for comparison, the parser 14 compares the next character with the linked character elements of the next (adjacent) level in step 48 and checks for a match in step 50, similar to step 44. The parser 14 then checks for more characters in step 52, and continues until all characters of the input word have been parsed relative to the tree 23.
After all the characters of the input word have been parsed, if the parser 14 determines in step 54 that the last matching character does not correspond to an end node (i.e., the matching character element 62 for the last character was not an end node), the tree management process adds the new word in step 56; however if the last matching character corresponds to an end node (e.g., 62c, 62g, or 62j), the parser 14 identifies in step 55 the command word by the corresponding word key in the end node. Hence, the new word can be dynamically added to the data structures, without the necessity of manual manipulation by a software engineer.
FIG. 3B illustrates validation of the generic command following identification of an input word as a new command word or a known command word. The parser begins in step 140 by parsing the first word of the received generic command by comparing the first input command word to the command word translation table 20 for identification of a matching token 28. For example, assume that the parser 14 receives the valid command "watch tcp connections". The parser identifies the token value "8" as corresponding to the first command word "watch". The parser 14 than traverses the command parse tree 22 in step 142 to search for the matching token 28. As illustrated in FIG. 2A, the parser 14 locates the matching token in the first tree element 24a. If the parser 14 determines in step 144 that the first command word is valid, the parser 14 continues searching the next command word in step 146. If the first command word is invalid based on no match in the first element 24a of the command parse tree, the parser 14 returns an invalid command message to the user in step 156.
The parser 14 then parses the next word (e.g., "tcp") of the received generic command in step 146 by locating the corresponding token 28 (e.g., "6" for "tcp") in the table 20, and then traversing in step 148 the tree elements that depend from the matched tree element 24a (e.g., 24b). The parser 14 determines a match between the token 28 ("6") corresponding to the command word "tcp" in the token-command key pair 30d in step 150, enabling the parser to continue for the next command word. As described above, the parser 14 repeats the process in step 152 for the third command word "connections" having the token "2" and identifying a match between the entire generic command and the token-command key 30 specified in the tree element 24c. The parser 14 identifies in step 154 the prescribed command for a selected one of the translators 16 based on the value of the command key 32 within the matching token-command key pair 30 (e.g., "CK=3") of the last valid command word, which maps to a translation table that specifies a specific command for a specific translator 16.
As described above, the parser 14 can identify a command key 32 even if only a portion of the command is valid. Assume for example that the parser 14 receives the invalid command "get udp connection info". In this case, the individual command words are valid from the command word translation table 20, however, the sequence is invalid. In particular, the command word "get" having a token value of "3" reaches the token-command key pair 30b, however the command word "udp" having a token value of "7" does not reach any child of the tree element 24a. Hence, the parser 14 uses the last valid command key ("6") in step 154 based on the matching token for the first valid word located in the token-command key pair 30b. The command key is mapped to a selected one of the translators 16 in an attempt to provide a command to the corresponding resource 18. If the selected resource 18 determines that the command is invalid, the selected resource 18 at that time may prompt the user for a correct command.
The disclosed arrangement enables the use of generic commands for multiple OAM tools that have respective command syntax, resulting in a single point of entry for administering and maintaining complex software based systems. The disclosed arrangement provides the user a single set of commands and syntax to learn, facilitating the use of multiple administrative and maintenance tools. Moreover, the disclosed arrangement enables new command words to be identified and automatically added without manual reconfiguration of executable code or data structures.
While this invention has been described in connection with what is presently considered to be the most practical and preferred embodiment, it is to be understood that the invention is not limited to the disclosed embodiments, but, on the contrary, is intended to cover various modifications and equivalent arrangements included within the spirit and scope of the appended claims.
APPENDIX PART A: Command Syntax Mapping
Old Command/
Functional Item New Syntax Line/Syntax
Set RTM Sample set watchtime <Object>view
Times <# in ms> -t <# in ms>
(from command line only)
Get RTM Sample get watchtime - None -
Times
Watch BASE Global watch acb globals BASEview
Client/Server BASEview -g
Server Information BASEview -h then press g
Watch BASE Thread watch acb threads BASEview -h[<Rec#>]
Information BASEview then press h
Watch APP Global watch acb globals APPview
Information APPview -g
APPview -i then press g
Watch APP ICT Table watch acb entries APPview -i[<Rec#>]
Entry Information APPview then press i
Watch TNT Group watch cma groups TNTview then press g
Information
Watch TNT Session watch cma sessions TNTview
Information
Watch H323 watch h323 entries H323view
Information H323view -h .vertline. H<Rec#>
H323view -r .vertline. -s then
press h
Watch Radvision watch h323 H323view -r .vertline. R<Rec#>
Information radvision H323view then press r
Watch H323 State watch h323 states H323view -s .vertline. S<Rec#>
Information H323view [-r] then press s
Start BASE start system obs -o APP -s up
possibly startobj.ksh
Quiesce BASE quiesce acb obs -o APP -s quiesce
Stop BASE stop system obs -o APP -s down
Start TNT start cma obs -o TNT -s up
Stop TNT stop cma obs -o TNT -s down
Quiesce TNT quiesce cma obs -o APP -s quiesce
Get BASE status get system status obs -o APP
Get Application status watch acb entries obs -o TNT
ps -eaf .vertline. grep
<Application>
Reload all ICT entries reload sched all reloadsched
Reload specific reload sched static reloadstatic <APP>
ICT entry <Static Application> possibly startapp <APP>
(where <Static
Application> could
be TNT,
LogRemover, etc.)
Get schedule table watch acb entries More $PARMLIB/parms/
APP/Sched*
Get current logging get loglevels - None - ?
level for APP
Set error logging level set loglevel loglevel APP error <off
.vertline.
for APP acb error local >
<off .vertline. local>
Set warning logging set loglevel acb loglevel APP warning
level for APP warning <off .vertline. local>
<off .vertline. local>
Set info logging level set loglevel acb info loglevel APP info
for APP <off .vertline. local> <off .vertline.
local>
Set debug logging set loglevel acb de- Loglevel APP debug
level for APP bug <off .vertline. local> <off .vertline.
local>
Get current logging get loglevels - None - ?
level for TNT
Set error logging set loglevel cma er- loglevel TNT error
level for TNT ror <off .vertline. local> <off .vertline.
local>
Set warning logging set loglevel cma loglevel TNT warning
level for TNT warning <off .vertline. local>
<off .vertline. local>
Set debug logging Set loglevel cma de- loglevel TNT debug
level for TNT bug <off .vertline. local> <off .vertline.
local>
Get Help for RTM help watch <Object>view -?
functions
Get Help for SNMP help [start .vertline. obs
functions stop .vertline. quiesce]
Get Help for reload help reload reloadsched (no parms,
functions no help) reloadstatic
Get Help for logging help set loglevel
functions
Get Help for query help get Obs
functions
Get Help on help help help
Exit utility exit Q key on RTMs
APPENDIX PART B: Generic Command Examples
Watch
This command displays the requested RTM screen
Command Usage: Watch <Object> [<Screen>]
Valid Object/Screen Pairs:
Valid
Obj Screens Description
acb globals Displays ACB Global counters information
entries Displays ACB Entry information
states Displays ACB States information
comm Displays ACB Communication Layer information
threads Displays ACB Thread information
cma groups Display group information
sessions Display session information
scr Display CMA System Call Router information
h323 entries Display the full H323 information screen
radvision Display the full radvision information screen
states Displays the combined (H323/Rad) states info
(Note: CMA allocates double the MaxPorts
configurable in H323.ini, so this screen
will show double the MaxPorts entries)
sms Displays SMS information
faxprint Displays FaxPrint process information
notify Displays MWI_OnOffNotification info
Get
This command allows the user to request
certain system variable values.
Command Usage: get <Variable>
Valid Variables:
Variable Description
watchtime Gets the number of milliseconds between
RTM (watch) screen refreshes
system status Gets the current status of the system
(up, down, quiesce)
loglevels Gets the current run-time logging
levels for ACB, CMA, and all loaded
STATIC/STATIC_NOWAIT agents
Set
This command allows the user to set either
UMCLI variables or overall system variables.
Command Usage: set <variable> <value>
Valid Variable/Value Pairs:
Variable Valid Values Description
watchtime Numeric in Sets the refresh time for RTM
milliseconds screens in milliseconds. Any
values less than 500 will
be set to 500.
loglevel acb error "off" or "local" Turns ACT Error level
logging off or local
loglevel acb warning "off" or "local" Turns ACT Warning level
logging off or local
loglevel acb info "off" or "local" Turns ACT Info level
logging off or local
loglevel acb debug "off" or "local" Turns ACT Debug level
logging offer local
loglevel cma error "off" or "local" Turns CMA Error level
logging off or local
loglevel cma warning "off" or "local" Turns CMA Warning level
logging off or local
loglevel cma info "off" or "local" Turns CMA Info level
logging off or local
loglevel cma debug "off" or "local" Turns CMA Debug level
logging off or local
loglevel <PID> error "off" or "local" Turns <PID> Error
level logging off or local
(where <PID> is the
PID of any scheduled agent)
loglevel <PID> warning "off" or "local" Turns <PID> Warning
level logging off or local
(where <PID> is the
PID of any scheduled agent)
loglevel <PID> info "off" or "local" Turns <PID> Info
level logging off or local
(where <PID> is the
PID of any scheduled agent)
loglevel <PID> debug "off" or "local" Turns <PID> Debug
level logging off or local
(where <PID> is the
PID of any scheduled agent)
Start
This command allows the user to start
various system agents or the entire system.
Command Usage: start <Agent>
Valid Agents:
Agent Description
system Starts the entire system
acb Starts a manually stopped or quiesced ACB agent
cma Starts a manually stopped or quiesced CMA agent
(new functionality coming to allow
quiesce of CMA . . . start will be implemented
with a spobjstate CMA R command)
logging Starts the logging subsystem
Stop
This command allows the user to stop the TNT agent
or the entire system. This command does NOT bring
any running LOGSUB process down, since it is a peer
process to the system and could be used by external
agents which could still be running and need the service.
Command Usage: stop <Agent> <Screen>
Valid Agents:
Agent Description
system Stops the entire system (including Logging)
acb Stops a running or quiesced ACB agent
cma Stops a running or quiesced CMA agent
logging Stops the logging subsystem only
if the ACB agent is down
Quiesce
This command allows the user to
quiesce the APP or TNT agent.
Command Usage: quiesce <Agent>
Valid Agents:
Agent Description
acb Quiesces acb
cma Quiesces a running CMA agent
Reload
This command allows the user to
reload various configuration files.
Command Usage: reload
<Agent> [<Parameters>]
Valid Applications:
Application Parameters Description
cmaloglevels Causes CMA to reload the DBG
and TRACE sections of the
SPARMLIB/TNT/parms/TNT.ini
configuration file.
Dialmap Causes CMA to reload $PARMLIB/
TNT/parms/DialMap.ini
Route "acb" or "cma" Causes ACB to reload either $PARMLIB/
parms/APP/Route.<hostname>
(acb) or $PARMLIB/parms/TNT/Route.
<hostname> (cma)
Sched "all" or "static Causes ACB to reschedule either all or
<token>" a single agent defined in $PARMLIB/
parms/APP/Schedule.<hostname>
(Use of the static <token> parameter
requires that <token> had previously
been scheduled either as a STATIC or
STATIC_NOWAIT.)
Help
This command allows the user to get
help on the valid commands available,
their usage, and what they mean.
Command Usage: help [<command>]
Valid Commands:
Commands Description
<None> Help without any parameters gives the users
either a list of the top level commands (help
set to "short") or the top level commands
and all valid sub commands under each top
level commands (help set to "full")
watch Gives the user a list of valid screens and what each one is
get Gives the user a list of valid variables to query
set Gives the user a list of valid variables and
valid values for each variable
art Gives the user a list of valid Agents to start
stop Gives the user a list of valid Agents to stop
quiesce Gives the user a list of valid Agents to quiesce
reload Gives the user a list of valid Configurables
(and possibly optional parameters) to reload.
help The ubiquitous help on help (probably not necessary . . . )
| «Previous |
Next» |
| Computer programming language pronouns |
Compiler device and computer-readable recording medium with a compiler recorded therein |
|
- Inventors
Mustoe, Paul Leon; Raut, Monica;
- Assignee
Cisco Technology, Inc. (San Jose, CA)
- Published
May-18-2004
- Current US Classes:
707/10
707/102
707/3
717/143
- Application #
778773
- International Classes
G06F 017/30
- Field of Search
707/100 707/102 707/2 707/3 707/10 707/4 717/143 717/144 717/109 709/200-224
- Examiner
Alam; Shahid
- Agent
Turkevich; Leon R.
- US Patent References:
5086504
5379419
5491796
5680622
5732274
5790863
5835757
5911072
6134709
6226655
6263339
6282547
6654747
|
