System Reports

This chapter is divided into sections—one for each report—and arranged according to each report's Function ID.

The description for each report contains the following information:

• Report Type—Indicates if this is a Configuration Control, System Status, or Resource Control report.
  
  
• Destination VCA (Virtual Communications Address)—Specifies the Network Header Destination VCA byte value for this report.
  
  
• Description—Contains a brief overview of the actions that can be accomplished with this report.
  
  
• Action Causing Report Generation—Lists system commands or conditions that could cause this report.
  
  
• Format—Shows an example of the report with each byte identified and defined.
  
  
• Examples—Shows sample reports with a byte-by-byte analysis.
  
  

Each byte in a report is a hexadecimal (base 16) number. Most reports require you to convert this hexadecimal number into binary (base 2) or decimal (base 10) numbers to interpret the byte. A Decimal-Hexadecimal-Binary conversion table is provided in Appendix B.

Byte offset values under the Format heading are counted from the initial byte of the Network Header (byte offset 0 to 3). Interpret these values according to the following list.

Note   Unless otherwise stated, all MF processing described in this chapter applies to both MF and MFCR2 processing.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Address Range and Resource Group (byte offset 5)—Specifies the range of port addresses and resource group shown in this report; convert byte from hexadecimal to binary and interpret the bits as follows.

RRGGGGGG

RR—Specifies the address range.

00—Ports $00 to $1FF (0 to 511).

01—Ports $200 to $3FF (512 to 1023).

10—Ports $400 to $5FF (1024 to 1535).

11—Ports $600 to $7FF (1536 to 2047).

GGGGGG—Specifies the resource group; convert binary to decimal for group number (1 to 63).

Status Bytes (byte offsets 6 to 133)—Each report contains 128 Status Bytes; each Status Byte contains information for four adjacent ports. Ports are counted from lowest address to highest address within the requested range. Convert the byte from hexadecimal to binary and interpret the bits in pairs as described below.

Bit pair = 00—Port is not in this resource group.

01—Port is in this resource group but off line (port has been deactivated via the system administration Card Maintenance screen, busied out from the distant end, or resides on a card that is out of service).

10—Reserved (no meaning in this report).

11—Port is in this resource group and on line.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Address Range (byte offset 5)—Specifies the port address range for which the report was generated. Interpret the byte according to the following list.

00—Ports $00 to $1FF (0 to 511).

40—Ports $200 to $3FF (512 to 1023).

80—Ports $400 to $5FF (1024 to 1535).

C0—Ports $600 to 7FF (1536 to 2047).

Function ID (byte offset 4)—Byte immediately following the network header; uniquely identifies the report from the system.

Lowest Port Affected (byte offsets 5 and 6)—Hexadecimal representation of the first port address on the card for which the report is sent. This is also useful in identifying the span for which the report is sent in the case of a multispan card. This field is set to $00 if the card is not found in the database.

Highest Port Affected (byte offsets 7 and 8)—Hexadecimal representation of the last port address on the card for which the report is sent. This is also useful in identifying the span for which the report is sent in the case of a multispan card. This field is set to $00 if the card is not found in the database.

Real Time Clock (byte offset 9 to 11)—Time represented in the format Hours:Minutes:Seconds; hours, minutes, and seconds are represented separately in hexadecimal.

Rack-Level-Slot Code (byte offsets 12 to 14)—Specifies the rack, level, and slot in which the card is located. Valid values are:

• 1 or 2—Rack.
  
  
• 0 through 3—Level.
  
  
• 1 to 21 (0 through 15 in hexadecimal)—Slot.
  
  

Convert the decimal value of the slot into hexadecimal for encoding. For multispan cards (4xE1/T1), if the query has a zero as the span specifier, (representing all four interfaces), there will be four responses, one for each interface. In this case, the $82 reports contain the same R-L-S for all the spans, but the lowest and highest ports affected are differentiated. The span specifier indicates the span for which the report is generated.

Span Code (byte offset 15)—Represents the interface (span) number for a multi-span card, for which the report is generated. The value is 1 for a single-span card status report.

Card Type (byte offset 16)—Type of the card for which the report is generated. This field is set to $00 if the card is not found in the database. The possible values of the field, if the card is present in the database, are as follows:

0x1—Subscriber Line Interface Card (SLIC-2)

0x3—E+M Trunk Card (E+M)

0x4—T1 Trunk Card (T1)

0x5—Digital Tone Generator (DTG)

0x6—Digital Voice Card (DVC)

0x8—DTMF Receiver Card 8 Port (DRC-8)

0xA—MF Receiver Card (MRC)

0xB—Direct Inward Dial Card (DID-2)

0xC—Universal Trunk Card (UTC-2)

0xD—Network Bus Controller (NBC)

0xE—Bus Repeater Card (BRC)

0xF— Digital Conference Card (DCC)

0x11—Speech Recognition Card (SRC)

0x12—Call Progress Analyzer (CPA)

0x13—Primary Rate Interface (PRI)

0x14—E1 Interface Card (E1)

0x15—MFCR2 Transceiver Card (MFCR2)

0x16—DTMF Receiver Card 24 Port (DRC-24)

0x17—DTMF Receiver Card 48 Port (DRC-48)

0x18—Integrated Play/Record Card 8 Port (IPRC-64)

0x19—Primary Rate Interface/NFAS (PRI/N)

0x1A—DPNSS E1-PRI (DPNSS)

0x1B—DASS2, Network Termination E1-PRI (NTDASS2)

0x1E—Four Span T1 Interface Card (4xT1)

0x1F—Four Span E1 Interface Card (4xE1)

0x20—Integrated Prompt/Record Card 8 Port (IPRC-8)

0x21—Integrated Prompt/Record Card 128 Port (IPRC-128)

0x22—MVDC-T1

0x23—MVDC-PRI

0x24—Net5 ISDN

0x27—Drop and Insert Card

0x28—Subrate Switch Card

0x29—J1 ISDN

0x46—Interface Controller Card/T1

0x47—Interface Controller Card/E1

0x50—Service Platform Card/DTMF

0x51—Service Platform Card/CPA

0x52—Service Platform Card/MFC

0x53—Service Platform Card/MFCR2

0x54—Service Platform Card/TONE

0x55—Service Platform Card/OUTP

0x56—Service Platform Card/CNF

0x60—Interface Controller Card/PRINI2

0x61—Interface Controller Card/PRI5ESS

0x62—Interface Controller Card/PRI4ESS

0x63—Interface Controller Card/PRINTI

0x64—Interface Controller Card/PRINTT

0x70—Interface Controller Card/PRI NET5

0x71—Interface Controller Card/PRI DPNSS

Card State (byte offset 17)—Card states are defined as follows:

00—Card not defined in database

01—Active

02—Maintenance

03—Diagnostic

04—Out of service

05—Standby

06—Camped on

07—Card in diagnostics mode with remote loopback

08—Card in diagnostics mode with payload loopback

FF—Unknown

The following $82 command requests the status of the cards 1, 1, 6 and 1, 1, 7.

Function ID = 82 (Card Status)

Starting RLS = 1, 1, 6

Span = all spans

Ending RLS = 1, 1, 7

Span = spans 1 and 2

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Access Code (byte offset 5)—Copied from the Port Status ($83) command for which the report is being generated. Only bit C is modified, if required.

A port address range can be specified in different ways. The access code specifies the way in which the port address range is chosen.

C000 AGR0

C—Specifies fragments of an $83 report.

C = 1—This is a fragment of a $83 report in response to a $83 command and more fragments will be sent.

C = 0—This is the last or only fragment of the $83 report

A—Specifies the port address range.

A = 1—If port address range is specified.

A = 0—If the port address range is not specified.

G—Specifies the resource group.

G = 1—A resource group is specified.

G = 0—A resource group is not specified.

R—Specifies R-L-S-S information.

R = 1—R-L-S of the card is specified, with the span information.

R = 0—No R-L-S-S information is specified.

Range Specifier 1 (byte offsets 6 and 7)—Copied from the $83 command for which the report is being generated.

Range Specifier 2 (byte offsets 8 and 9)—This is an optional field in $83 reports. Copied from the $83 command for which the report is being generated.

Report Element 1 (byte offsets 10 to 14)—If Range Specifier 2 is not present, the first Report Element starts at byte offset 8. This forms the single report element containing the port status report for one port. Other similar report elements follow.

The following command requests status reports for ports $27 and $28. The command specifies the range through port addresses:

Main command segment elements are as follows:

Function ID = 83 (Port Status)

Access Code = 0000 1000 (C000 AGRS)

C = 0; A = 1 (Address Range specified); G = 0; R = 0;

Starting Port Address = 0027

Ending Port Address = 0028

Function ID (byte offset 4)--Byte immediately following the Network Header; uniquely identifies this report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the incoming port from which the digits were collected. Omitted if the report is included as a segment in a $DD report.

Spacer Bytes (byte offsets 7 and 8)—Reserved for future enhancements; always returned as 00 00. Omitted if the report is included as a segment in a $DD report.

Receiver Address (byte offsets 9 and 10)—Hexadecimal representation of the MF/MFCR2 receiver port processing the incoming digits.

Status (byte offset 11)—In MF processing, this byte indicates the status of the digit report; convert byte from hexadecimal to binary and interpret the bits as described below.

VS000XYZ

V—Specifies if the report from the MF receiver was garbled (digit on time > 6 seconds).

V = 0—Report not garbled.

V = 1—Report garbled.

S—If a collection error occurred (garbled digit, collection timer fired), specifies if the Controlling port has been forced to idle or placed into CP_SETUP.

S = 0—Controlling port forced to idle; V or Y is set to 1.

S = 1—Controlling port placed into CP_SETUP state to await further host action; V or Y is set to 1.

X—Specifies if MF receiver was available when initially requested.

X = 0—MF receiver available on initial request.

X = 1—MF receiver not available on initial request.

Y—Specifies if MF digit collection timer fired (KP not received within 15 seconds, ST not received within 30 seconds, or off time > 6 seconds).

Y = 0—MF digit collection timer did not fire.

Y = 1—MF digit collection timer fired.

Z—Specifies if this report contains a valid MF digit string.

Z = 0—Not a valid MF digit report.

Z = 1—Valid MF digit report.

In MFCR2 processing, this byte also indicates the status of the digit report. However, only the Y and Z bytes are converted from hexadecimal to binary as described below.

Y—Specifies if MFCR2 digit collection timer fired after 30 seconds.

Y = 0—MFCR2 digit collection timer did not fire.

Y = 1—MFCR2 digit collection timer fired.

Z—Specifies if this report contains a valid MFCR2 digit string.

Z = 0—Not a valid MFCR2 digit report.

Z = 1—Valid MFCR2 digit report.

Optional Field Designator/Digit String (byte offsets 12 to n)—When the "Enable Digit Field Reporting" feature is enabled from either Data Base Administration Menu or Maintenance Menu of the System Administrator database, the byte at offset 12 indicates into what field the system stores the reported digits (refer to the Cisco VCO/4K System Administrator's Guide). Possible byte values are as follows:

00—ANI Field.

01—Field 1.

02—Field 2.

03—Field 3.

04—Field 4.

05—Not stored in any field.

Digit String (byte offsets 12 + n to n)—Collected MF digits; digits represented are from 1 to 9, and 0 ($A). Each nibble in the hexadecimal byte represents a single digit. The Digit String always ends with an $F. The KP, ST, ST1, ST2, and ST3 digits are stripped from the digit string before the report is sent. If the "Enable Digit Field Reporting" feature is not enabled, then the Digit String bytes begin at byte offset 12. The Optional Field Designator and Digit String are included only when Z = 1 in the MF Status byte.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies this report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the line/trunk from which the digits were collected. Omitted if report included as a segment in a $DD report.

Report Status (byte offset 7)—Indicates if an event condition is reflected in this report, such as voice prompt abort or outgoing port detached when the first digit is detected, collection was aborted because expected supervision was not detected, or digit field overflow occurred. Omitted if the report is included as a segment in a $DD report. Convert the byte from hexadecimal to binary and interpret the bits as described below.

0VDTA000

V—Specifies if a voice prompt was aborted when the user entered the first digit.

V = 0—No prompt abort performed.

V = 1—Prompt aborted on first digit detection; no effect to digit collection.

D—Specifies if the outgoing port was detached from the call when the user entered the first digit.

D = 0—No outgoing detach performed.

D = 1—Outgoing port detached on first digit detection.

T—Specifies if digit collection was aborted because the supervision timer fired; type of supervision expected indicated in the Supervision byte (offset 8).

T = 0—Supervision timer did not fire.

T = 1—Digit collection aborted on supervision timeout; receiver removed from call.

A—Specifies if the digits collected and appended to one of the controlling port's digit fields did not fit into the field.

A = 0—No digit field overflow.

A = 1—Digit field overflow; excess digits discarded.

Supervision (byte offset 8)—When T = 1 in the Report Status byte, indicates the type of supervision that was expected but not received before the supervision timer fired. If T = 0, this byte is set to $00. Omitted if report included as a segment in a $DD report. Interpret byte according to the following list.

01—Wink expected but not received.

02—Answer expected but not received.

DTMF Receiver Address (byte offsets 9 and 10)—Hexadecimal representation of the DTMF receiver port processing the incoming digits. For SLIC, DID, and UTC ports, this address is the same as the Controlling Port Address.

DTMF Status (byte offset 11)—Indicates the status of the digit report; convert byte from hexadecimal to binary and interpret the bits as described below.

0T0VWXYZ

T—Specifies if the interdigit timer fired.

T = 0—Interdigit timeout did not fire.

T = 1—Interdigit timer fired.

V—Specifies a first digit report.

V = 0—Not a first digit report.

V = 1—First digit report. If Z = 1, only one digit is reported in a string. If Z = 0, no digit is reported (first digit was a single-digit end-of-string character).

W—Specifies if DTMF receiver was available when initially requested.

W = 0—DTMF receiver available on initial request.

W = 1—DTMF receiver not available on initial request.

X—Specifies if the DTMF digit collection timer fired.

X = 0—DTMF digit collection timer did not fire.

X = 1—DTMF digit collection timer fired.

Y—Specifies if the first digit timer fired before the first DTMF digit was received.

Y = 0—DTMF first-digit collection timer did not fire.

Y = 1—DTMF first-digit collection timer fired.

Z—Specifies if this report contains a valid DTMF digit string.

Z = 0—No DTMF digits reported.

Z = 1—DTMF digits reported.

Optional Field Designator/Digit String (byte offset 12 to n) - When the "Enable Digit Field Reporting" feature is enabled from either Data Base Administration Menu or Maintenance Menu of the System Administrator database, the byte at offset 12 indicates into what field the system stores the reported digits (refer to the Cisco VCO/4K System Administrator's Guide). Possible values are as follows:

00—ANI Field.

01—Field 1.

02—Field 2.

03—Field 3.

04—Field 4.

05—Not stored in any field.

Digit String (byte offsets 12 + n to n)—The DTMF digits collected; digits represented are from 1 to 9, and 0 ($A), plus the special characters * ($B) and # ($C). The digit string always ends with an $F. Each nibble in the hexadecimal byte represents a single digit. If the "Enable Digit Field Reporting" feature is not enabled, then the Digit String bytes begin at byte offset 12. The Optional Field Designator and Digit String are included only when Z = 1 in the DTMF Status byte.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies this report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the line/trunk from which the digits were collected. Omitted if report included as a segment in a $DD report.

Report Status (byte offset 7)—Indicates the status of the digit report. Also, indicates if an event condition is reflected in this report, such as voice prompt abort or outgoing port detached when first digit detected, collection was aborted because expected supervision was not detected, or digit field overflow occurred. Omitted if the report is included as a segment in a $DD report. Convert the byte from hexadecimal to binary and interpret the bits as follows.

0VDTA000

V—Specifies if a voice prompt was aborted when the user entered the first digit.

V = 0—No prompt abort performed.

V = 1—Prompt aborted on first digit detection; no effect to digit collection.

D—Specifies if the outgoing port was detached from the call when the user entered the first digit.

D = 0—No outgoing detach performed.

D = 1—Outgoing port detached on first digit detection.

T—Specifies if digit collection was aborted because the supervision timer fired; the type of supervision expected is indicated in the Supervision byte (offset 8).

T = 0—Supervision timer did not fire.

T = 1—Digit collection aborted on supervision timeout; receiver removed from call.

A—Specifies if the digits collected and appended to one of the controlling port's digit fields did not fit into the field.

A = 0—No digit field overflow.

A = 1—Digit field overflow; excess digits discarded.

Supervision (byte offset 8)—When T = 1 in the Report Status byte, indicates the type of supervision that was expected but not received before the supervision timer fired. If T = 0, this byte is set to $00. Omitted if the report is included as a segment in a $DD report. Interpret the byte according to the following list:

01—Wink expected but not received.

02—Answer expected but not received.

DTMF Receiver Address (byte offsets 9 and 10)—Hexadecimal representation of the DTMF receiver port processing the incoming digits. For SLIC, DID, and UTC ports, this address is the same as the Controlling Port Address.

DTMF Status (byte offset 11)—Specifies that this report follows the enhanced report format; convert byte from hexadecimal to binary and interpret the bits as described below.

E—Specifies that this report is an enhanced DTMF digit report that is capable of reporting fourth-column DTMF digits.

E = 0—This report follows the old style report format.

E = 1—This report follows the enhanced report format.

T—Specifies if the interdigit timer fired.

T = 0—Interdigit timeout did not fire.

T = 1—Interdigit timer fired.

V—Specifies a first digit report.

V = 0—Not a first digit report.

V = 1—First digit report. If Z = 1, only one digit is reported in the string. If Z = 0, no digit is reported (first digit was a single-digit end-of-string character).

W—Specifies if DTMF receiver was available when initially requested.

W = 0—DTMF receiver available on initial request.

W = 1—DTMF receiver not available on initial request.

X—Specifies if DTMF digit collection timer fired.

X = 0—DTMF digit collection timer did not fire.

X = 1—DTMF digit collection timer fired.

Y—Specifies if the first digit timer fired before the first DTMF digit was received.

Y = 0—DTMF first-digit collection timer did not fire.

Y = 1—DTMF first-digit collection timer fired.

Z—Specifies if this report contains a valid DTMF digit string.

Z = 0—No DTMF digits reported.

Z = 1—DTMF digits reported.

Field Designator/Digit String (byte offset 12) - When the "Enable Digit Field Reporting" feature is enabled from the System Features screen of the System Configuration menu, this byte indicates into what field the system stores the reported digits (refer to the Cisco VCO/4K System Administrator's Guide). This byte is always present; if the feature is disabled, or if Z = 0 in the DTMF Status byte, then this byte is set to $05. Possible values are as follows:

00—ANI Field.

01—Field 1.

02—Field 2.

03—Field 3.

04—Field 4.

05—Not stored in any field.

Number of Digits (byte offset 13)—Specifies the number of digits contained in this report. This byte is set to $00 if Z = 0 in the DTMF status byte to indicate that there are no digits to be reported.

Digit String (byte offsets 14 - n)—The remaining bytes contain the DTMF digits collected. Digits are represented as 0 to 9, A to D, E (*), and F (#). Each byte in the digit string contains two digits. If the report contains an odd number of digits, the last nibble is set to $0; there is no digit string terminator.

The Digit string is included only when Z = 1 in the DTMF status byte to indicate that there are digits to be reported.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Port Address (byte offsets 5 and 6)—Hexadecimal representation of the port for which this report was generated.

Permanent Signal Condition Code (byte offset 7)—Specifies the reason this report was sent. If this byte = $00, the port has gone back on hook and the PSC no longer exists. Convert the byte from hexadecimal to binary and interpret the bits as follows:

ABCDEFGH

A—Specifies if Permanent Signal processing started because one end of a stable call disconnected (on hook/hung up).

A = 0—PSC was not due to on hook.

A = 1—PSC was due to on hook.

B—Specifies if Permanent Signal processing started due to an error condition, outgoing port supervision error, port out of service, card out of service.

B = 0—PSC was not due to error condition.

B = 1—PSC was due to error condition.

C—Specifies if Permanent Signal processing was started because the host did not respond to an initial call report (host setup timing feature enabled).

C = 0—Host timeout was not responsible for PSC.

C = 1—Host timeout was caused PSC by not responding to initial call report.

D—Specifies if Permanent Signal Condition processing was started because host command released port or caused a forced disconnect.

D = 0—Host command was not responsible for PSC

D = 1—Host command caused PSC.

E—Specifies if Permanent Signal processing was started because there are no available MF receivers to satisfy a command or inpulse rule.

E = 0—MF receiver resource limitation was not responsible for PSC.

E = 1—PSC was caused by MF receiver resource limitation.

F—Specifies if PSC processing was started because of a system internal problem.

F = 0—System internal problem was not responsible for PSC.

F = 1—PSC was caused by a system internal problem.

G—Specifies if PSC processing was started because of garbled MF digits or an MF collection timeout.

G = 0—PSC was not caused by MF garbled digits/timeout.

G = 1—PSC was caused by MF garbled digits or timeout.

H—Indicates if a PSC exists.

H = 0—PSC was cleared; all other Permanent Signal Condition Code bits should also = 0.

H = 1—PSC was exists; reason for PSC specified in other Permanent Signal Condition Code bits.

Resource Group (byte offset 8)—Specifies the resource group number to which the port belongs; convert byte from hexadecimal to decimal for the group number (1 to 63 inclusive).

Real Time Clock (byte offset 9 to 11)—24-hour system clock indicating the time the status change occurred; hours, minutes, and seconds are represented separately in hexadecimal. Convert each byte from hexadecimal to decimal for the time.

Assume an incoming port was linked to an outgoing port in resource group 5 and at address $0028. When the incoming port went back on hook to end the call, the outgoing port did not release within 30 seconds. The following report shows a PSC for the outgoing trunk.

Function ID = D2 (Permanent Signal Condition)

Port Address = 0028

Permanent Signal Condition Code = 10000001

A = 1 (other port that was on hook hung up)

B = 0 (PSC was not due to an error)

C = 0 (host was not responsible for the PSC)

D = 0 (host command was not responsible for the PSC)

E = 0 (MF Receiver limitation was not responsible for the PSC)

F = 0 (System internal problem was not responsible for the PSC)

G = 0 (MF garbled digits/timeout was not responsible for the PSC)

H = 1 (PSC exists)

Resource Group = 5

Real Time Clock = 6:30:00 pm ($12 = 18; $1E = 30; $00 = 00)

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Old Status/New Status (byte offset 5)—Specifies the status of the port before the change occurred and the present status of the port. Convert the byte from hexadecimal to binary and interpret the bits as follows.

MMMMNNNN

MMMM—Specifies the status of the port before the change occurred.

MMMM = 0001—Resource was unavailable (out of service).

MMMM = 0011—Resource was on line and available.

NNNN—Specifies the current status of the port.

NNNN = 0001—Resource is currently unavailable (out of service).

NNNN = 0011—Resource currently on line and available.

Port Address (byte offsets 6 and 7)—Hexadecimal representation of port address for which the report is generated.

Originator (byte offset 8)—Specifies whether the change in status was originated by the system or the host and the reason for the change. Interpret the byte as follows:

01—Reason for change unknown; caused by host.

02—Reason for change unknown; caused by system.

12—Port busied out with the system administration Card Maintenance screen.

22—Port busied out with the system administration Set Up Paths screen.

32—Port busied out from distant end.

42—Port busied out because auto makebusy error threshold reached.

52—Port busied out due to internal card error (currently SRC only).

61—Port status changed by host ($90) command.

Resource Group (byte offset 9)—Specifies the resource group number to which the port belongs; convert byte from hexadecimal to decimal for the group number (1 to 63).

Real Time Clock (byte offsets 10 to 12)—A 24-hour system clock indicating the time the status change occurred; hours, minutes, and seconds are represented separately in hexadecimal. Convert each byte from hexadecimal to decimal for the time.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Condition (byte offset 5)—Specifies whether a limitation condition is present and the resource group for which the request was made. Convert the byte from hexadecimal to binary and interpret the bits as follows.

C0GGGGGG

C—Specifies if a limitation condition is present.

C = 0—Limitation condition is clear.

C = 1—Limitation condition is present; resource unavailable.

GGGGGG—Specifies the resource group; convert binary to decimal for group number (1 to 63).

Requesting Port Address (byte offsets 6 and 7)—Hexadecimal representation of the port specified in the resource control command, inpulse rule, or outpulse rule for which a resource was requested. For a conference control command, this byte is the hexadecimal representation of the conference number for which the port was requested. If the port address is in the range $80 00 to $80 FF. The requesting port is a virtual port.

Real Time Clock (byte offsets 8 to 10)—A 24-hour system clock indicating the time the $D6 report was generated. Hours, minutes, and seconds are represented separately in hexadecimal. Convert each byte from hexadecimal to decimal for the time.

The following report indicates that all ports in resource group 3 are unavailable. This report is sent the first time an allocation attempt fails for this group until the condition has cleared.

Function ID = D6 (Resource Limitation)

Condition and Resource Group = 10000011

A = 1 (limitation condition present)

GGGGGG = 3 (resource group 3)

Requesting Port Address = 0020

Real Time Clock = 10:35:19am ($0A = 10; $23 = 35; $13 = 19)

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Lowest Port Address Affected (byte offsets 5 and 6)—Hexadecimal representation of the first port address on the card for which the report is sent.

Highest Port Address Affected (byte offsets 7 and 8)—Hexadecimal representation of the last port address on the card for which the report is sent.

Status and Originator (byte offset 9)—Specifies if the card is on line or off line, if the card was just added to or deleted from the database, and whether the change in status was originated by the system or the host. Convert the byte from hexadecimal to binary and interpret the bits as follows:

LDA000SH

L—Specifies if card is on line or off line.

L = 0—Card is on line.

L = 1—Card is off line.

D—Specifies if card was just deleted from the database.

D = 0—Card is not deleted from the database.

D = 1—Card was just deleted from the database.

A—Specifies if card was just added to the database.

A = 0—Card is not added to the database.

A = 1—Card was just added to the database.

S—Specifies if the change was due to some action by the system (such as an alarm/error condition or change made via system administration).

S = 0—System was not responsible for the change.

S = 1—System originated the change.

H—Specifies if the change was due to some action by the host computer.

H = 0—Host was not responsible for the change.

H = 1—Host originated the change.

Real Time Clock (byte offsets 10 to 12)—A 24-hour system clock indicating the time the status change occurred. Hours, minutes, and seconds are represented separately in hexadecimal. Convert each byte from hexadecimal to decimal for the time.

Card State (byte offset 13)—Indicates the present status of the card for which the report is generated. Interpret this byte as follows:

00—Card is in an unknown state.

01—Card is in the active state.

02—Card is in the maintenance state.

03—Card is in the diagnostic state (not valid for BRC).

04—Card is in the out of service state.

05—Card is in the standby state (valid for BRC and DTG only).

06—Card is in the camped on state. An attempt was made to place the card into the diagnostics state with the system administration Card Maintenance screen. The card remains in this state until further system administration action. Refer to the Cisco VCO/4K System Administrator's Guide for more information.

Rack-Level-Slot Code (byte offset 14)—Specifies the rack, level, and slot in which the card is located. Convert the byte from hexadecimal to binary and interpret as follows:

LLLSSSSS

LLL—Rack and level on which the card is located; interpret as follows:

001—Rack 1, Level 1.

010—Rack 1, Level 2.

011—Rack 1, Level 3.

100—Rack 2, Level 0.

101—Rack 2, Level 1.

110—Rack 2, Level 2.

111—Rack 2, Level 3.

SSSSS—Slot number in which the card is located. Convert the value from binary to decimal for the slot number (1 to 21).

---

Note   For a multispan card, the command includes a port range of 24 channels. If the card is removed or deleted, the report is issued multiple times.

---

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Resource Group (byte offset 5)—Specifies the resource group number to which the port belongs; convert byte from hexadecimal to decimal for the group number (1 to 63).

Change (byte offset 6)—Type of change detected. The following list provides a general indication of the change that occurred for the outgoing port.

01—Call attempt failed (FAIL token in answer supervision template).

02—Outgoing port rehunt performed due to supervision error; new outgoing port address supplied in byte offsets 14 and 15 (ERROR token in answer supervision template).

04—Outpulse rule processing has completed for this port; rule number specified in byte offset 11 (REP END in outpulse rule).

05—Outpulse rule processing aborted (QUIT token in answer supervision template).

08—Supervision detected outside of a rule (prior to executing a supervision control outpulse rule token or after the token is satisfied).

10—Supervision detected during rule processing (REP, OKREP or ANSREP token in answer supervision template).

20—Supervision error detected; no rehunt performed (ERROR token in answer supervision template).

40—Port became inactive (on hook).

80—Port became active (went off hook or REP, OKREP or ANSREP token in answer supervision template).

Outgoing Port Address (byte offsets 7 and 8)—Hexadecimal representation of the address of the port for which the state change was detected.

Incoming Port Address (byte offsets 9 and 10)—Hexadecimal representation of the incoming port address to which this outgoing port was connected.

Answer Supervision Code (byte offset 11 and 12)—For Change = 01, 02, 05, 08, 10, 20, or 80, indicates the type of answer supervision activity present on this outgoing port. If Change = 40, these bytes are set to 00 00. If Change = 04, byte offset 11 contains the number of the outpulse rule processed; byte offset 12 is set to 00.

Supervision Template (byte offset 13)—For MFCR2 processing, this byte indicates the outpulse rule used for R2 outdialing.

For MF processing, this byte indicates whether the outgoing port is considered answered (ANS condition token processed in answer supervision template or FINAL SUP [xx] outpulse rule token satisfied), and specifies the number of the answer supervision template used. The byte is set to 00 for call failures and supervision errors. Convert the byte from hexadecimal to binary and interpret the bits as follows:

A0NNNNNN

A—Indicates whether the outgoing port is considered answered.

A = 0—Outgoing port is not considered answered.

A = 1—Outgoing port is considered answered.

NNNNNN—Specifies the answer supervision template used. Convert the value from binary to decimal for the template number. When this value is zero, either the A template or W template was used. If the $DA report indicates the port is either on-hook or off-hook and A = 0, the W (wink) template was applied. If the $DA report indicates the port is off-hook and A = 1, the A (answer) template was applied.

New Outgoing Port (byte offset 14 and 15)—For Change = 02, indicates new Outgoing Port selected by the system as a result of a rehunt operation (outgoing supervision error encountered). The type of error is indicated in the Answer Supervision Code bytes. Not included unless Change = 02.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Resource Group (byte offset 5)—Specifies the resource group number to which the port belongs; convert byte from hexadecimal to decimal for the group number (1 to 63 inclusive). Omitted if the report is included as a segment in a $DD report.

Change (byte offset 6)—Type of change detected. Interpret the byte as follows:

01—Call attempt failed (FAIL token in answer supervision template).

02—Outgoing port rehunt was performed due to a supervision error; a new outgoing port address is supplied in byte offsets 14 and 15 (ERROR token in answer supervision template).

04—Outpulse rule processing has completed for this port; rule number is specified in byte offset 9 (REP END token in outpulse rule).

05—Outpulse rule processing was aborted (QUIT token in answer supervision template).

08—Supervision detected outside of a rule (prior to executing a supervision control outpulse rule token or after the token is satisfied).

10—Supervision was detected during rule processing (REP, OKREP or ANSREP token in answer supervision template).

20—Supervision error was detected; no rehunt performed (ERROR token in answer supervision template).

40—Port became inactive (on hook).

80—Port became active (went off hook or REP, OKREP or ANSREP token in answer supervision template).

Incoming Port Address (byte offsets 7 and 8)—Hexadecimal representation of the address of the port for which the state change was detected. Omitted if the report included as a segment in a $DD report.

Answer Supervision Code (byte offsets 9 and 10)—Specifies the supervision error or the number of the outpulse rule completed. If Change = 40, these bytes are set to 00 00. When Change = 01, 02, 05, 08, 10, 20, or 80, interpret the bytes as follows:

30 01—Simultaneous seizure at both ends of a trunk (glare condition).

30 02—Attempt made to answer a non-ringing port.

30 04—Supervision timer expired.

30 05—No current on line.

31 01—Reorder tone detected.

31 02—Busy signal detected.

31 03—Ringback detected.

31 04—Dial tone detected.

31 05—SIT tones detected.

31 06—Pager cue tone detected.

31 07—ISUP tone detected.

31 08—ISUP tone cessation.

32 01—Grace time completed.

32 02—Ringback cessation.

32 03—Wink detected.

32 04—Hook flash detected.

32 06—True answer detected.

32 07—Voice detected.

32 08—Voice cessation.

32 09—Outgoing port returned to CP_SETUP.

When Change = 04, byte offset 9 specifies the outpulse rule number completed; byte offset 10 is set to 00. Convert from hexadecimal to decimal for the rule number.

Supervision Template (byte offset 11)—Specifies the number of the answer supervision template used. The byte is set to 0 for call failures and supervision errors. Convert the byte from hexadecimal to binary and interpret the bits as follows:

A00NNNNNN

A—Indicates whether the outgoing port is answered.

A = 0—Outgoing port not answered.

A = 1—Outgoing port answered.

NNNNNN—Specifies the answer supervision template used. Convert from binary to decimal for the template number. When this value is zero, either the A template or W template was used. If an associated $DB report indicates the port is off-hook and A = 0, the W (wink) template was applied. If an associated $DB report indicates the port is off-hook and A = 1, the A (answer) template was applied.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Action Code (byte offset 5)—Specifies why the report is sent, which side sent the report, and whether that side is active or standby. Convert the byte from hexadecimal to binary and interpret the bits as follows:

RI0000SM

R—Specifies the reason the report is sent, either system boot/data link established or a run-time transfer.

R = 0—Run-time transfer.

R = 1—System boot or data link established.

I—Specifies that system initialization is complete and the system can process calls.

I = 1—System initialization complete.

S—Specifies the side of the system from which the report originated.

S = 0 —Report is from system A side.

S = 1—Report is from system B side.

M—Specifies whether the system side originating the report is currently the active or standby side

M = 0—Reporting side is currently standby.

M = 1—Reporting side is currently active.

Spacer Byte (byte offset 6)—Reserved for future enhancements; always = $00.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the port for which the inpulse rule is being executed.

Spacer Bytes (byte offsets 7 and 8) - Reserved for future enhancements; always returned as 00 00.

Segment Control (byte offset 9)—Specifies the number of segments included in this report, if the rule was processed for an incoming or outgoing port and if the TeleRouter overlay performed a routing action. Convert the byte from hexadecimal to binary and interpret the bits as described below. If inpulse rule executed specified REP EACH, this byte will be $00, indicating there are no segments.

ABC00NNN

A—Specifies if inpulse rule was processed for an incoming or outgoing port.

A = 0—Inpulse rule was processed for an incoming port.

A = 1—Inpulse rule was processed for an outgoing port.

B—Specifies if a looping rule was aborted.

B = 0—Rule not aborted because of looping.

B = 1—Looping rule was aborted automatically (S = 1 in byte offset 10).

C—Specifies if the TeleRouter overlay performed a routing action (ROUTE [Tx] token in inpulse rule).

C = 0—No routing performed.

C = 1—Routing action was performed by TeleRouter; a Routing Action ($D5) report follows the $DD report once the action is complete.

NNN—Specifies the number of segments included in this report; if inpulse rule specifies a REP EACH token, these bits are zero indicating there are no segments attached.

Inpulse Rule/Voice Port (byte offset 10)—Specifies the inpulse rule number executed, whether it completed normally or was aborted, whether rule was aborted due to outpulse channel exhaust (DO ORULE token in inpulse rule), and whether a voice port was available on the first attempt as required by that rule. Convert the byte from hexadecimal to binary and interpret the bits as follows:

ASTRRRRR

A—Specifies if a voice port was available when initially requested.

A = 0—Voice port was available on initial request.

A = 1—Voice port was not available on initial request.

S—Specifies if inpulse rule processing completed normally or was aborted; error conditions that can cause inpulse rule processing to abort are:

• MF receiver was unavailable.
  
  
• DTMF receiver was unavailable.
  
  
• Digit collection error or timeout (MF, DTMF, or DP).
  
  
• Voice port was unavailable.
  
  
• Host command was received.
  
  
• Port goes on hook (call abandon).
  
  
• Rule specifies digit collection but no DTMF or MF token was in rule.
  
  
• No outpulse channel was available (when rule includes DO ORULE token).
  
  
• Looping rule was detected.
  
  

S = 0—Inpulse rule processing completed normally.

S = 1—Inpulse rule processing was aborted.

T—When S = 1, specifies if rule was aborted because no outpulse channel was available; DO ORULE token was in rule.

T = 0—Rule was not aborted due to outpulse channel exhaust condition.

T = 1—Rule was aborted due to outpulse channel exhaust condition.

RRRRR—Specifies the inpulse rule that was executed; convert binary to decimal for the rule number (1 to 30).

Segments (byte offset 11 to n)—Resource report segments included in this macro; segment format follows that of the report the segment represents, with the following exceptions: the Controlling Port Address and Spacer Bytes are omitted in MF ($D0) collections, and the Controlling Port Address, Report Status and Supervision bytes are omitted in DTMF ($D1) collections, and Incoming Port Change of State ($DB) segments contain only the Function ID and Change Code.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the incoming port to which the voice prompts were played.

Spacer Bytes (byte offsets 7 and 8)—Reserved for future enhancements; always returned as 00 00.

Voice Port Address (byte offsets 9 and 10)—Hexadecimal representation of the port used to present prompts.

Status (byte offset 11)—Indicates the status of the digit report. A byte value of 10 indicates that all specified voice prompts have been presented.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the controlling port circuit address for which the report is sent. If the Controlling Address Identifier (byte offset 9) is $01, these bytes represent the specific B-channel assigned to the call or a non-ISDN port. If the Controlling Address Identifier is $02, these bytes represent the D-channel; the Controlling Call ID is identified in byte offset 7 and 8.

Controlling Call ID (byte offsets 7 and 8)—Specifies the ISDN Call ID for the controlling port. Use Call ID only when the controlling port is specified by the D-channel. You must set the Controlling Address Identifier (byte offset 9) to $02.

Controlling Address Identifier (byte offset 9)—Specifies whether the controlling port is identified by D-channel and Call ID or by B-channel/non-ISDN port address. Interpret the byte as follows:

01—Controlling port specified by B-channel or non-ISDN port address; Controlling Call ID = 00 00 for non-ISDN port address.

02—Controlling port specified by D-channel and Call ID.

Associated Port Address (byte offsets 10 and 11)—Hexadecimal representation of the report's associated (outgoing) port circuit address. If the Associated Address Identifier (byte offset 14) is $01, these bytes represent the specific B-channel used. If the Associated Address Identifier is $02, these bytes represent the D-channel and Call ID.

Associated Call ID (byte offsets 12 and 13)—Specifies the ISDN Call ID for the associated (outgoing) port.

Associated Address Identifier (byte offset 14)—Specifies whether the associated (outgoing) port is identified by D-channel or by B-channel/non-ISDN port/resource group. Interpret the byte as follows:

00—No associated port.

01—Associated port specified by B-channel or non-ISDN port address; Call ID = 00 00 for non-ISDN port address.

02—Associated port specified by D-channel.

Change (byte offset 15)—Specifies the type of change detected. The following list indicates the change that occurred for the outgoing port.

00—No change; report was issued to report an ISDN D-channel message (contained in Event byte).

01—Call attempt failed (FAIL token in the ISDN supervision template or ISDN protocol violation).

02—Reserved for future enhancements.

04—Outpulse rule processing has completed for this port; rule number specified in byte offset 19 (REP END in outpulse rule).

05—Quit token was processed in an ISDN supervision template.

08—Supervision was detected outside of a rule.

10—Supervision was detected during rule processing (REP, OKREP, ANSREP, or PRPREP token in ISDN supervision template).

20—Supervision error was detected (ERROR token in ISDN Supervision Template).

40—Port became inactive.

80—Port became active (SETUP received and processed or REP, OKREP, ANSREP, or PRPREP token in ISDN Supervision Template).

Event Code (byte offset 16)—Specifies the D-channel message received. Codeset 0 Q.931 message coding is used for all event codes. Interpret the byte as follows:

00 — Failed call attempt (error in template processing or no D-channel message was processed).

01 — ALERTING message was received.

02 — CALL PROCEEDING message was received.

03 — PROGRESS message was received.

05 — SETUP message was received.

07 — CONNECT message was received.

0C — SETUP ACKNOWLEDGE message was received.

0F — CONNECT ACKNOWLEDGE message was received.

20 — USER INFORMATION message was received.

45 — DISCONNECT message was received.

46 — RESTART message was received.

4D — RELEASE message was received.

5A — RELEASE COMPLETE message was received.

62 — FACILITY message was received.

6E — NOTIFY message was received.

---

Note   If the system receives a NOTIFY message from the network and the ISDN state is ACTIVE (10), the system passes the NOTIFY message to the host in bytes 26 to n. In all other states, the system ignores network NOTIFY messages.

---

79 — CONGESTION message was received.

FF — Timeout (in ISDN supervision template processing).

Supervision Template (byte offset 17)—Specifies whether the outgoing port is considered answered (ANS condition token processed in ISDN supervision template) and the number of the ISDN supervision template used. If no ISDN supervision template is being used, or call failures and errors occur, set the byte to 00. Convert the byte from hexadecimal to binary and interpret the bits according to the following descriptions:

A0NNNNNN

A—Indicates whether or not the Associated (outgoing) port is considered answered.

A = 0—Outgoing port not considered answered.

A = 1—Outgoing port considered answered.

NNNNNN—Specifies the ISDN supervision template used. Convert the value from binary to decimal for the template number.

Status Code (byte offset 18)—Indicates if an error was encountered. Interpret the byte as follows:

01—No error.

80—Inpulse rule processing was aborted.

81—RELEASE message was received over the D-channel; call has been abandoned.

82—RELEASE message was transmitted over the D-channel; call could not be processed.

83—B-channel was unavailable.

86—Not all requested IEs were present in the D-channel message.

87—Looping inpulse rule was detected; rule processing was aborted.

88—B-channel is in wrong call processing state for requested action.

89—DTMF collection failure or timeout.

8A—MF collection failure or timeout.

8B—D-channel failure.

8C—Glare condition was detected; outgoing port has released, incoming port in CP_SETUP state.

8F—Report has been truncated; report and IEs exceeded 255 bytes.

90—Digit collection timeout.

91—No digit collection mode was chosen in rule; digit collection failure.

A1—Host SETUP Timer fired; call has been cleared.

A2—Card or port in maintenance mode; call has been cleared.

A3—Looping outpulse rule was detected; rule processing was aborted.

A4—ISDN protocol violation.

C1—MF receiver was unavailable.

C2—DTMF receiver was unavailable.

C4—CPA port was unavailable.

C5—Outpulse channel was unavailable.

Rule Code (byte offset 19)—For Change = 04, indicates the number of the outpulse rule processed. Otherwise, this byte is 00.

Call Reference Number (byte offsets 20 and 21)—Indicates a call reference number that is reported to the host; call references are numbered sequentially.

Note   Set the Enable Host Call Reference feature flag to Y in the System Features administration screen when using the Call Reference Number bytes to enable the reporting of a call reference number to the host. Refer to the Cisco VCO/4K System Administrator's Guide for further information on the Enable Host Call Reference feature and feature flag setting instructions.

Optional Data (byte offsets 22 to 24)—Reserved for future enhancements.

IE Code (byte offset 25)—Indicates the number of IEs included in this report. IE reporting is controlled by ISDN message templates. A value of $00 indicates that no IEs follow this byte. IEs are reported exactly as they were received from the D-channel.

Digit segments follow the general format for their report, but the Controlling Port Address and Spacer Bytes are omitted in MF collections, and the Controlling Port Address, Report Status and Supervision bytes are omitted in DTMF collections.

This report may be truncated if the network header segment, base report, digit segments, and IEs exceed 255 bytes in length. Indication of truncation is provided as an Inpulse Rule Status byte value of 8F (byte offset 12-n).

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Controlling Port Address (byte offsets 5 and 6)—Hexadecimal representation of the controlling port circuit address for which the report is sent. If the Controlling Address Identifier (byte offset 9) is $01, these bytes represent the specific B-channel assigned to the call or a non-ISDN port. If the Controlling Address Identifier is $02, these bytes represent the D-channel; the Controlling Call ID is identified in byte offset 7 and 8.

Controlling Call ID (byte offsets 7 and 8)—Specifies the ISDN Call ID for the controlling port.

Controlling Address Identifier (byte offset 9)—Specifies whether the controlling port is identified by D-channel and Call ID or by B-channel/non-ISDN port address. Interpret the byte as follows:

01—Controlling port was specified by the B-channel.

02—Controlling port was specified by the D-channel and Call ID.

Inpulse Rule Number (byte offset 10)—Specifies the inpulse rule number executed. Convert from hexadecimal to decimal for the inpulse rule.

Status Control (byte offset 11)—Specifies the number of Inpulse Rule Status bytes that follow. At least one Inpulse Rule Status byte is included in the report. The maximum number of status bytes allowed in a report is 10.

Inpulse Rule Status (byte offsets 12 to n)—Specifies whether the inpulse rule completed normally or was aborted due to error condition. Multiple status bytes can be included in a single report; the number of status bytes is indicated by the Status Control value. Interpret the bytes as follows:

01—No error.

81—RELEASE message was received over the D-channel; call has been abandoned.

82—RELEASE message was transmitted over the D-channel; call could not be processed.

83—B-channel was unavailable.

86—Not all requested IEs were present in the D-channel message.

87—Looping inpulse rule was detected; rule processing was aborted.

88—B-channel is in wrong call processing state for the requested action.

89—DTMF collection failure or timeout.

8A—MF collection failure or timeout.

8F—Report has been truncated; report and IEs exceeded 255 bytes.

A3—Looping outpulse rule was detected; rule processing was aborted.

A4—ISDN protocol violation.

C1—MF receiver was unavailable.

C2—DTMF receiver was unavailable.

C4—CPA port was unavailable.

C5—Outpulse channel was unavailable.

D-Channel Message Offset (byte offset n + 1)—Specifies the number of hexadecimal bytes until the D-Channel Message byte (offset m + 1). This byte always contains a value of at least $02 to account for a Digit Segment Control byte (assuming no Digit Segments are included in the report).

Digit Segment Control (byte offset n + 2)—Specifies the number of DTMF or MF Digit report segments that follow. If this byte = 00, no digit segments are included in this report.

Digit Segments (byte offset n + 3 - m)—Optional DTMF and MF Digit report segments included in this macro; segment format follows that of the report the segment represents, with the exclusion of the Incoming Port Address byte.

D-Channel Message (byte offset m + 1)—Specifies the received D-channel message. When Digit Segment Control = 00, this byte immediately follows it. Otherwise, it appears after the final digit segment. Interpret this byte as follows:

00—No D-channel message was processed (rule without D-channel processing).

01—ALERTING message was received.

02—CALL PROCEEDING message was received.

03—PROGRESS message was received.

05—SETUP message was received.

07—CONNECT message was received.

0C—SETUP ACKNOWLEDGE message was received.

0F—CONNECT ACKNOWLEDGE message was received.

20—USER INFORMATION message was received.

45—DISCONNECT message was received.

5A—RELEASE COMPLETE message was received.

62—FACILITY message was received.

6E—NOTIFY message was received.

---

Note   If a NOTIFY message from the network is received by the system and the ISDN state is ACTIVE (10), the system passes the NOTIFY message to the host in bytes 26 through n. In all other states, the system ignores NOTIFY messages from the network.

---

79—CONGESTION message was received.

IE Code (byte offset m + 2)—Indicates the number of IEs included in this report. IE reporting is controlled by ISDN Message Templates. A value of $00 indicates that no IEs follow this byte. IEs are reported exactly as they were received from the D-channel.

Function ID (byte offset 4)—Byte immediately following the Network Header that identifies the report.

Severity (byte offset 6)—Indicates an alarm's severity. Possible severity levels are as follows:

00—Alarm has cleared.

01—Severity not applicable; nonalarmed event is being reported.

02—AUX 1 host alarm; set in response to a Set/Reset Host Alarm ($C0 03) command.

03—AUX 2 host alarm; set in response to a Set/Reset Host Alarm ($C0 03) command.

04—Minor alarm.

05—Major alarm.

06—Critical alarm.

07—Fatal alarm.

Occurrences (byte offset 7)—Indicates the number of alarm occurrences in hexadecimal. Convert to decimal for the number of occurrences.

Occurrence Severity (byte offset 8)—Indicates an alarm's occurrence severity. Possible severity levels are as follows:

00—Alarm has cleared.

01—Severity not applicable; nonalarmed event is being reported.

02—Aux 1 host alarm; set in response to a Set/Reset Host Alarm ($C0 03) command.

03—Aux 2 host alarm; set in response to a Set/Reset Host Alarm ($C0 03) command.

04—Minor alarm.

05—Major alarm.

06—Critical alarm.

07—Fatal alarm.