IVR: 'Display messages (display error)' Command

display messages
[priority <alarms, critical, "*C", major, "**",minor,"*",events, all>] [-c]

[start <mm/dd HH:MM:SS>]
[stop <mm/dd HH:MM:SS>]
[card <range,T1,TR,SP,...,all>]
[channel <range,T1,TR,SP,...,all>]
[ID <message ID1,message ID2,all>]
[source <TSM,VROP,SPIP,TRIP,...,all>]
[pattern <regular expression search pattern>]
[number,all]

Description

The display messages command displays error and status messages that have been logged by the voice system. Various options are provided so that the display can be limited to specific types of messages. If no arguments are supplied to display messages, information is displayed on how to read the messages (the message format) as well as command usage. The messages are written to standard output.

If more messages exist than can be displayed on the screen, you will be prompted with "Press the ENTER key to see more, or enter "q" to quit." If you do not wish to be prompted to press ENTER (that is, display all of the messages at once), you may use the -c option.

The priority argument should be used to display messages with specific types of urgencies. Two groups of priorities exist: alarms and events. Alarms are messages that have been reported as *C (critical), ** (major), or * (minor) priorities. Events are all the remaining messages that have no priority (for example, status messages). For example, to display the last 100 alarms, type the following:

display messages priority alarms 100

You can also display specific priorities using the priority option. You can specify either the name of the priority or its symbol (for example, critical or *C) To display all of the critical messages, type the following:

display messages priority critical all

NOTE:  You should use the priority alarm argument when alarms are needed, otherwise use thepriority events argument. The priority argument must be used with this command.

Combinations of priorities can also be displayed by listing each priority separated with a comma. For example, to display the last 100 alarms messages, type the following:

display messages priority "*C","**","*" all

where *C, **, and * must be enclosed in quotes.

Display Message Options

If you wish to display only specific types of messages, you may precede the number of messages to be displayed with one or more of the following options:

• start
• stop
• card
• channel
• id
• source
• pattern
• number

If more than one of the options is specified, the system displays only messages that meet all of the specifications.

start
The start option allows you to specify a starting time for display of messages. The system displays only messages that were logged on or after the time you specify. The time can be specified by date and/or a time. The word "today" is equivalent to specifying the current date. Examples of specifying the date are:

• "May 1, 1992"
• "05/01/93"
• "05-01-93"

Examples of specifying the time are:

• hh:mm:ss
• hour=hh
• min=mm
• sec=ss

where hh is 0 to 23, and mm and ss can be 0 to 59.

DO NOT mix the hh:mm:ss format with the item==xx format. If portions of the time are not specified, the time default is 0 hours, 0 minutes, and 0 seconds.

Also, giving only the time of day indicates the current date. For example, if today is January 15, 1993, the command display messages start "12/31 09:00" displays all of the messages that were logged starting at 9 am on December 31, 1993. In order to display messages from a previous year, you must specify the year. The entire start date and time must be enclosed in quotes (for example,

display messages start "April 21, 1993 13:00:00").

If only the date is specified, the time defaults to the beginning of the day. For example, display messages start today displays all of the messages that were logged today (the day in which the command is executed).

stop
The stop option allows you to display messages logged up to a specific time. The date and time syntax is the same as that for the start option. Therefore, displaymessages stop today displays all messages that were logged before today. 

The start and stop options can be used together to display messages that were logged over a specific period of time. For example, display messages start"May 1" stop "May 2" displays all messages logged on May 1 of this year.

If you want the start and stop options to be the same day (for example, May 1), you must specify the hours and minutes for which you want to display messages. Otherwise, the time defaults to 00:00 for both the start and stop options and no messages are displayed.

card
The card option allows you to specify messages logged about a specific card or cards. For example, display messages card 2 displays all messages logged that are associated with card 2. You can display combinations of cards. For example, display messages card 2,3 displays messages for cards 2 and 3 and display messages card 0-2 displays messages for cards 0, 1, and 2.

You can also use the card option to display messages logged about a specific type of card. For example,display messages card t1 displays all messages logged about T1 cards.

channel
The channel option works like the card option. For example,display messageschannel tr displays all messages logged about Tip/Ring channels, whereas display messages channel 5 displays all messages logged about channel 5.

NOTE:  The channel option requires an argument. Typing displaymessages channel 100 attempts to display all messages pertaining to channel 100. If you want to display the last 100 messages pertaining to any channel, type display messages channel all 100.) Note that specifying both the card option and the channel option displays all of the specified card-related messages but, of the channels that are specified, only those that reside on the specified cards are displayed. For example, displaymessages card t1 channel all 100 displays the last 100 messages logged for T1 cards and T1 channels, whereas display messages card t1 channel trnever displays no messages because it is impossible for a Tip/Ring channel to reside on a T1 card.

id
The id option allows you to display specific message ids that have been logged. For example, display messages id TWIP004 displays all occurrences of that message. For example, display messages id TWIP004,TWIP009 displays all occurrences of both messages.

source
The source option allows you to display messages logged by a particular system process. For example, some of the standard system processes are listed in the following table:

For example, display messages source TRIP displays all messages logged regarding Tip/Ring cards and channels.

pattern
The pattern option allows you to specify a regular expression as accepted by logCat that may appear in any part of a message. (See the logCat command later in this book for additional information.) The pattern must enclosed in quotes and surrounded by slashes (/). For example, display messages pattern "/XYZ/" provides all messages that use the pattern XYZ anywhere in the message.

NOTE:  The pattern option is case-sensitive.

number
The number option specifies the number of messages you want to display, or you can use the all value to display all messages. The command accepts a three-digit number so you can display up to 999 messages.

NOTE:  Although the number option only allows up to 3 digits, you may have more than 999 messages logged. Therefore, you can only view up to 999 messages in the message log report with the display messages command. The logCat command with the -t option can be used to display all logged messages. See the logCat command for more information.

Display Format

All messages are displayed with two or three lines of information. Messages are separated by a blank line to ease viewing.  The table below lists the system message formats along with definitions and examples. Each message displayed conforms to the format shown as follows:

PR DAY MON DD HH:MM:SS ZZZ YYYY SOURCE
TTTTTTTT YY UU NUM TEXT...
TEXT (Continuation if necessary.)
blank line