Nortel DMS-100 Log Report Information


Understanding Log Reports

A log report is a message.  The DMS-100 switch generates a log report when an important event occurs in the switch or one of its peripherals.  Log reports include the following information:

A log report appears in response to either a system or a manual action.

Controlling Output from the Log System

Log output includes storage, distribution, prioritization, suppression, and thresholds.  There are two forms of log output control.  First, each office changes the appropriate Customer Data tables to customize the output from the log system to meet local requirements.  Second, Log Utility (LOGUTIL) commands can be executed in the LOGUTIL level of the MAP display.  The use of LOGUTIL commands can temporarily override parameters set in the Customer Data tables.  For example, commands can override parameters to turn log reports off, or to route output temporarily to a different device.

In most conditions, a restart will reset any temporary change made through LOGUTIL commands.  A restart is a reinitialization of the DMS-100 operating system and user processes.  Refer to the temporary Routing Commands section of the "Output Control Software" chapter of the Input/Output System Reference Manual.

Log Buffers

Each log buffer holds several hours of subsystem reports at peak output rates.  The value of the office parameter LOG_CENTRAL_BUFFER_SIZE in table OFCVAR determines the number of reports the log buffers held.  Refer to the OFCVAR parameters section in the Office Parameters Reference Manual.

Log buffers store the output reports in the order that they are generated.  A Central Message Controller (CMC) report that generates at 16:04:39 appears in the log buffer before a report that generates at 16:08:33.  When a subsystem buffer is full, the next report that generates displaces the oldest report.  Unless the displaced log report is routed to some type of external storage device, the log report is lost.  The user cannot retrieve the log report.

The Critical Message Prioritization feature provides an additional method to define the order log reports are output to a specified log device.  This office parameter LOG_PRIORITIZATION in table OFCENG activates or deactivates the feature.  Refer to the OFCENG parameters section in the Office Parameters Reference Manual.

Active log report alarm levels categorize log reports.  The log report alarm levels are Critical, Major, Minor, No Alarm.  The reports are output to specified devices in order of most critical to least critical alarm.  The log buffer stores reports of the same alarm category in order.

Routing Log Reports

In addition to storing the reports, the output reporting system can route the reports to devices which the operating company defines.  Devices which the operating company defines include MTD, DDU, Data Link, Printer, and VDU.

Each device has a buffer area, which under normal conditions can handle a large number of log reports.  If devices lose reports that the system indicates, increase the size of the log buffer.  To increase the size of the log buffer, change the office parameter LOG_DEVICE_BUFFER_SIZE in table OFCVAR.  Refer to the OFCVAR parameters section in the Office Parameters Reference Manual.

Routing and Reporting Subsystems

The routing and reporting subsystem routes reports from the log system buffers to an I/O device.  The I/O device prints, displays, or stores the reports.  Data tables LOGCLASS and LGDEV control the subsystem and provide basic permanent routing.

To route a log report to a device, the following units of information must be available to the DMS-100 switch.  Table LOGCLASS defines the class number of the report to be routed.  Table LOGDEV defines the device(s) that are to receive the class number of log reports.

The following table displays the assignment of class numbers to the CMC log reports.  When the CMC subsystem generates a log report, the routing and reporting subsystem references table LOGCLASS.  The routing and reporting subsystem discovers the log report is class 4.  When the class number is available, table LOGDEV searches for the device(s) which table LOGDEV defines to receive class 4 reports.  In this example, the device is PRT1.  The routing and reporting subsystem transmits the report through the log device buffer for PRT1 to the accurate device.

-----------------------------------------------------------------------------------------
          REPORTS    CLASS   DEVICE
-----------------------------------------------------------------------------------------
GROUP 1   NET 121    24      PRT1
GROUP 2   NET 115    24      PRT2
GROUP 3   PM 105     24      PRT3
GROUP 4   CMC 105     4      PRT1
GROUP 5   LINE 108   24      PRT2
GROUP 6   TRK 151    24      PRT3
-----------------------------------------------------------------------------------------

LOGUTIL Commands

The LOGUTIL commands allow the user to perform the following functions:

An example of temporary routing is an I/O device which malfunctions.  The I/O device and the associated log reports must be routed to another device.  Operating company personnel require temporary routing to route log reports to a Video Display Unit (VDU) for troubleshooting purposes.

Tables

The following tables appear in this document.  The tables list log header descriptions, log subsystems, event types, information-only logs, trouble codes, reason codes, equipment states, and call types.  The tables also list other information.  Spelling and capitalization of the table information are as they appear on the MAP terminal.

Option of Normal Log or Short Log Formats

The system displays log reports in the normal (long) format, or a short format.  The normal format is the default, and provides all the report information described above.  The system generates a short format if you request the short format through the LOGUTIL level of the MAP display.  The short format displays only the first line of the log report.  The short format allows you to view log reports at MAP levels where the viewing area is limited.

Log Report Formats

The first line of every log report contains the following elements:

The lines of the log report that remain, contain additional information about the event that the log report indicates.

The following sections examine each element of the log report in detail.

There are three formats for the header section of a log:

A comparison of each of the three header formats follows:

Logs in NT Standard Header Format (STD)

The format of the first line of a STD log is as follows:

-----------------------------------------------------------------------------------------
officeid  alarm  threshold  reportid  mmmdd  hh:mm:ss  ssdd  event_type  event_id
-----------------------------------------------------------------------------------------

Refer to Table A for a description of the header fields.  The second and following lines of the log report contain additional information about the event that the log report indicates.  An example of a LINE101 log report that uses the STD header format follows:

-----------------------------------------------------------------------------------------
COMS_0 * LINE101 OCT31 12:00:00 2112 FAIL LN_DIAG
         LEN HOST 03 0 14 24 DN 7811999
         DIAGNOSTIC RESULT No Response from Peripheral
         ACTION REQUIRED Chk Periphls
	 CARD TYPE 2X17AB
-----------------------------------------------------------------------------------------

This example indicates that the name or office identification of the switch that generated the log is COMS, side 0.  The switch generated the log on October 31 at 12:00 P.M.  The switch generated the log 21 times earlier, and generated for the 12th time at the device that displays this log.  The event type and description indicates a failed line diagnostic.  The variable message area provides more data about the defective line, and indicates the action required.

Logs in NT ECORE Office Header Format

The office identification for an ECORE office depends on the value of the ECORE_FORMAT parameter.  If an ECORE office, with an ECORE_FORMAT = TRUE value outputs the previous LINE101 log, it appears as follows:

-----------------------------------------------------------------------------------------
COMS_0 CM * LINE101 OCT31 12:00:00 2112 FAIL LN_DIAG
            LEN HOST 03 0 14 24 DN 7811999
            DIAGNOSTIC RESULT No Response from Peripheral
	    ACTION REQUIRED Chk Periphls
	    CARD TYPE 2X17AB
-----------------------------------------------------------------------------------------

The office identification includes an eight-character node name and one trailing space that follows the office name.  The same LINE101 log that an ECORE office, with ECORE_FORMAT = FALSE value generates, would appear as follows:

-----------------------------------------------------------------------------------------
COMS_0 * LINE101 OCT31 12:00:00 2112 FAIL LN_DIAG
         LEN HOST 03 0 14 24 DN 7811999
	 DIAGNOSTIC RESULT No Response from Peripheral
	 ACTION REQUIRED Chk Periphls
	 CARD TYPE 2X17AB
-----------------------------------------------------------------------------------------

The log report does not display the node with the standard office identification.  Table A lists and explains the standard (STD) headers that log reports include.

-----------------------------------------------------------------------------------------
Table A: DMS-100 Standard Header Format (STD)

Field                         Value        Description
-----------------------------------------------------------------------------------------
office identification         string       Identifies the switch that generates the log.
                                           This field is optional and does not normally
					   appear in the examples of log reports in this
					   manual.  The maximum length of this field is 12
					   characters.  Office parameter LOG_OFFICE_ID in
					   table OFCVAR sets the length of this field.
-----------------------------------------------------------------------------------------
alarm                         ***,         Indicates the alarm type of the log report.
                              **,          *** = critical alarm, ** = major alarm,
			      *,           * = minor alarm, blank = no alarm.
			      or blank
-----------------------------------------------------------------------------------------
threshold                     +,           Indicates if a threshold is set for the log report.
                              or blank     If + (plus sign), a threshold is set.  If blank, the
			                   threshold is not set.
-----------------------------------------------------------------------------------------
report identification         AAAAnnn      Identifies the log subsystem that generates the
                                           report of the log report in this subsystem.  Two
					   to four alphabetical characters and a number
					   between 100-999 identify the log report.  Refer
                                           to Table C of this document for a list of
					   log subsystems.
-----------------------------------------------------------------------------------------
mmmmdd                        JANUARY-DEC  Identifies the month and day the report 
                              01-31        generates.
-----------------------------------------------------------------------------------------
hh:mm:ss                      00-23        Identifies the hour, the minute, and the second
                                           the report generates.
			      00-59

			      00-59
-----------------------------------------------------------------------------------------
ssdd                          0000-9999    Defines the sequence number for each log
                                           report generated.  An ss increases each time a
					   report appears, and is reset to 00 after the ss
					   reaches 99.  The dd increases each time a
					   report shows at a device, and is reset to 00
					   after the dd reaches 99.
-----------------------------------------------------------------------------------------
-End-

Logs in Switch Control Center 2 Header Format (SCC2)

The format of the first line of a SCC2 log is as follows:

-----------------------------------------------------------------------------------------
alarm  mm  reportid  threshold  ssdd  event_type  event_id
-----------------------------------------------------------------------------------------

There are two main differences between the STD header format and the SCC2 header format.  The SCC2 header uses two spaces instead of three to display the alarm class.  A critical alarm shows as *C instead of ***.  Instead of a time and date stamp, the SCC2 header format provides only the minutes (mm) after the hour.  The header provides the time because the SCC2 processor time stamps each log it receives.

Refer to Table B for a detailed description of the SCC2 header fields.

The format of the following lines of the log report is the same as the format for offices with Standard or ECORE headers.

An example of LINE101 log report that uses the SCC2 header follows:

-----------------------------------------------------------------------------------------
* 27 LINE 101 2112 FAIL LN_DIAG
     LEN HOST 03 0 14 24 DN 7811999
     DIAGNOSTIC RESULT No Response from Peripheral
     ACTION REQUIRED Chk Periphls
     CARD TYPE 2X17AB
-----------------------------------------------------------------------------------------

Table B lists and explains the headers that log reports in SCC2 format include.

-----------------------------------------------------------------------------------------
Table B: DMS-100 SCC2 Header Format

Field                         Value        Description
-----------------------------------------------------------------------------------------        
alarm                         *C,          Indicates the report alarm type.  *C is critical,
                              **,          ** is major, * is minor, blank is no alarm.
			      *, 
			      or blank
-----------------------------------------------------------------------------------------
mm                            00-59        Identifies the number of minutes after the hour
                                           that the report generates.
-----------------------------------------------------------------------------------------
report identification         AAAA nnn     Identifies the log subsystem that generates the
                                           report.  This field uses two to four alphabetical
					   characters and the number (100-999) of the
					   log report in this subsystem.  Note the
					   subsystem name and the log number in this
                                           format.  Refer to Table C for a list of
					   log subsystems.
-----------------------------------------------------------------------------------------
threshold                     +,           Indicates if a threshold is set for the log report.
                              or blank     If + (plus sign), a threshold is set.  If blank, the
                                           threshold is not set.
-----------------------------------------------------------------------------------------
ssdd                          0000-9999    Defines the sequence number for each log
                                           report generated.  An ss increases each time a
                                           report appears, and is reset to 00 after the ss
                                           reaches 99.  The dd increases each time a
                                           report shows at a device, and is reset to 00
                                           after the dd reaches 99.
-----------------------------------------------------------------------------------------
-End-

Event Type and Identification

The Event Type and Event Identification follows the header.

The event type is a one-word, general description of the occurrence that caused the switch to generate the log report.  Some examples of events are FLT, INFO, and SYSB.  Refer to Table D for a list of event types and their meanings.

The event Identification is a string that provides additional information about the event.  Normally the string is abbreviated.  The event identification can be omitted when the event type and the text in the variable message/data area supply enough information.

Variable Message / Data Area

Lines of variable text and data fields normally follow the event type and identification.  These fields provide additional information about one or more of the following:

Log reports have a variable message / data area.  If the log report does not have a variable message data / area, the event type and identification provide information to determine the action required.

Structure of a Log Report Description

This section details the log reports that the DMS-100 outputs.  The following headings describe each log report, in detail:

Log report descriptions can include the following:

Report Format

The report format section is the first part of a log report description.  The report format description provides a general model of the log report, and identifies constant and variable text.  Refer to Log Report Formats in this document for additional information about the format fields.

Example

The example section is the second part of a log report description.  It contains an example of the log report as it comes from the DMS-100 switch.

Explanation

The explanation section is the third part of the log report description.  It contains a short description of the conditions that generate the report.

Explanation Table

The explanation table describes each field (logical part) of the log report in detail, under the columns: field, value, and description.


Field Column

The field column contains the following types of entry:

Variables Represented

A small number of text variables, known to the reader, are represented by their abbreviations.  For example: DN (Directory Number), LEN (Line Equipment Number), CLLI (Common Language Location Identifier), TRKID (Trunk Identifier).  For a complete list, refer to Table H.

Other text variables are represented by the suffix nm if they are names.  For example, modnm for module name.  The suffix txt represents any other sort of character string.  For example, stattxt for state text, fltxt for fault text (a character string that represents a fault).

Decimal numbers are represented by n (where n is zero to nine, unless specified).  Hexadecimal numbers are represented by h (where h is zero to F, unless specified).

Value Column

Five types of values are in the value column:

Description Column

The description may include the following information:

The general Action to be Taken section of this document gives the action for exact field values.  The system includes the action for exact field values in cases not covered in the document.

Action Taken

The Action to be Taken section explains what action should be taken by operating company personnel when the log report occurs.

Associated OM Registers

This section of the log report description lists Operational Measurements (OM) that associate with an exact log.

How to Understand Hex Tables in AUD and AUDT Log Reports

Most audit log reports (AUD and AUDT) output hex data blocks.  This section contains the information to understand the hex values.

The documentation that explains hex data blocks has two parts.  In the first part of the documentation, a diagram of the data fields contains the name of each field.  The diagram of the data fields contains the size of the field, and its location in the data blocks.  In the second part of the documentation, each page of the diagram has text that explains the purpose of the fields.

The following example is from a standard hex data diagram.  Notice that there are two 16-bit words in each row (in this occurrence, WORD 2 and 3).  WORD 2 contains bits 32 through 47 of the hex data blocks.  WORD 3 has bits 48 through 63.  The least significant bit in each word is on the right-hand side.

The field CPTLB extends across WORDS 2 and WORDS 3.  Under CPTLB are two rows of field names, one beginning with field MYINDEX and the other with field PRIMINDX.  Next to these names are numbers in brackets that identify the size of the fields in bits.

The size of the field is in brackets around the first word of a field.  A C for continuation replaces the size in any additional words used by the field.  For example, CPTLB begins in a word preceding WORD 2.

The diagram identifies some fields by number.  The names of the fields are too large for the space allotted in the diagram.  The numbers identify the numbered field names under the diagram.

In the preceding example, the diagram shows three rows of field names stacked on top of each other.  There are two possible relationships between these rows.  One possibility is that each row can represent a separate overlay.  This possibility means one or another displays, depending on the conditions software module, using a specified hexadecimal data structure.  The other possibility is that one row comprises subfields of the previous row.

The diagram alone does not specify which relationship exists.  An overlay chart defines which fields are overlays.  Where nested overlays are present, the overlay chart shows the link between them.  Fields that do not appear in the chart are subfields.

The overlay chart that accompanies WORD 3 in the previous example appears here.  The fields on either side of the word or can occupy WORD 3 but not at the same time.

OVERLAY STRUCTURE   WORD 3
   2,AUDIT,3,4 or LETTERC

The following figure provides a more detailed example.

The corresponding overlay chart for WORD 83 is:

In this example, the first set of overlay choices, includes subfield XLAB of the CHB field, TOPS_AREA, and FASTMOVE.

These overlays are present in both WORDS 82 and 83.

If you select XLAB, there are four new overlay choices in WORD 83, like LOG NETWORK, FILLER_BYTE.  If you select AMADATA, AMAINCCB and fields 3 through 7 are the overlay choices in bits 1328 through 1332.  The ENTRY_CODE, field 8, fields 9 through F, and SPARE8B are the overlay choices in bits 1336 through 1343.

Hexadecimal words in a diagram are numbered continuously from the beginning to the end of the hexadecimal data block.  Word 0 corresponds to the top left word in the top row of the accurate log output.

The following example shows how actual hexadecimal output relates to the model of hexadecimal output in the diagram.  For WORD 3 in the previous example, a dumped value of 9C5A is in the diagram as:

Unless stated, all numeric values that appear in the document audit log report descriptions are decimal.  Only the example of an accurate log report contains data in hexadecimal values.

Field descriptions for Boolean names are described as true or false.  A name is true (1) if the condition the field name defines exists.  The name is false (0) if the condition the field name defines does not exist.

Information Only Logs

The switch generates these information only logs to alert maintenance personnel of the following conditions:

This log type normally does not require maintenance personnel to take any action.  This log type does not affect service.  It is possible that this document does not include detailed log report descriptions for these information only logs.