TDX - SNMP Revision 02-01

Transcription

1 TDX - SNMP Revision Summary Status Approved by Revision 02-0 Page 1 of 17

2 Revision History Rev Date Author Description Erik Nielsen Draft Erik Nielsen Draft Erik Nielsen Release Erik Nielsen Release Erik Nielsen Release Erik Nielsen Release Revision 02-0 Page 2 of 17

3 Table of Contents 1. PREFACE PURPOSE AND SCOPE REFERENCES TERMS AND ABBREVIATIONS DOCUMENT STATUS MIB TRIAX MIB OID OVERVIEW EventMIB Miscellaneous TRAPS TRAP MIB Triax Trap MIB TRAP FORMAT APPENDEX TRIAX MIB DEFINITION TRIAX EVENT MIB Revision 02-0 Page 3 of 17

4 1. PREFACE 1.1 Purpose and Scope The purpose of this document is to describe the new SNMP functionality on the TDX. The SNMP implementation follow the MIB module SNMPv2-MIB from Standards/RFCs. The ecos software on the TDX do support some of the standard MIB. It do e.g. support the SNMP MIB-2 System (RFC 1213) that will be supported with Triax information. The document is a draft version, and a live document, it will change when the requirements change etc. The purpose with this document is to give an overview of the Triax MIB, so it is possible to make a plan and estimate for the further work. The SNMP functionality described in this document is divided into two deliveries. The individual functionality are marked with either Release 1 or Release 2. Release 1 is for the first delivery and Release 2 for the second delivery. 1.2 References Ref Reference Terms and Abbreviations Term Explanation SNMP Simple Network Management Protocol SNMPv2 Simple Network Management Protocol version 2 MIB Management Information Base OID Object Identifier IETF Internet Engineering Task Force RFC Request for Comments (IETF Standard) 1.4 Document Status The document is in its drafted state. Revision 02-0 Page 4 of 17

5 2. MIB Triax MIB is located at the below OID iso.org.dod.internet.private.enterprises.triax it is the same as Where is the IANA number, that Triax is registered with. After this number Triax defines its own MIB s. 2.1 Triax MIB OID overview Below is the overview of how Triax MIB OID is organized. Triax MIB OID Tree iso.org.dod.internet.private.enterprises triax he type Triax HeadEnd EventTraps EventMIB TDH TDX For the TDX is defined the MIB below Triax MIB OID Tree iso.org.dod.internet.private.enterprises triax he type MIB tdxsystemmib tdxservicemib tdxequipmentmib tdxrestartmib tdxsingelpsumib tdxredundantpsumib Revision 02-0 Page 5 of 17

6 2.1.1 EventMIB EventMIB is the extra information that is added to the Event Traps. iso.org.dod.internet.private.enterprises triax he type Current EventTable Current Event Entry managedobjectclass managedobjectinstance sequencenumber perceivedseverity eventtime eventtype probablecause entry managedobjectclass OID: Description: The Managed Object Class specifies the type of object that has issued the event. It is coded as a textual string.the code representation of Managed Object Class is shown in Table the below. Value TDH 800 TDX Representation An TDH 800 equipment An TDX equipment managedobjectinstance OID: Description: The Managed Object Instance specifies the object of the Managed Object Class that has issued the event. Examples of Managed Object Instances are shown in the Table below. Managed Object Instance Example Description TDH 800 TDH800=IPADR,Source=UNIT0SC Event generated by TDH 800 UNIT0=Master SC=SystemController FE=FrontEnd[1..N] BE=BackEnd[1..N] TDX TDX=IPADR,Source=UNIT0FE6 Event generated by TDX UNIT0=Master UNIT1=Subunit UNIT2=Subunit SC=SystemController FE=FrontEnd[1..N] BE=BackEnd[1..N] OUTPUT [A..B] Revision 02-0 Page 6 of 17

7 sequencenumber (EventID) OID: Description: The sequence number is a number that uniquely identifies a specific event. This is the unique id for an event. It is a combination of 2 distinct parts of information : the event type and the event number. The first half represents the type and the second (most right) part the event number. This event number represents the bit position of an event in a bitmap of an active event entry. Thus the value of event can be found using a simple formula: (EventType x 2^16) + AlarmNumber. E.g. an alarm with alarm type 5 and alarm number 3 is represented as 0x The code representation of sequence number is shown in the table below. Value Representation 0 Sequence number is Unknowen 1 Lowest possible sequence number Highest possible sequence number perceivedseverity OID: Description: The Perceived Severity of events is coded as an integer. The code representation of Perceived Severity is: - indeterminate(1) - info(2) - warning(3) - minor(4) - major(5) - critical(6) eventtime OID: Description: Event Time indicates the exact time at which the event is issued. It is coded as an octet string according to the DateAndTime parameter in SNMPv2. The actual coding in the octet string is binary, which means that the octet string is not immediately printable. In this protocol, the size of the Event Time string is eight octets. The code representation of Event Time is shown in Table below. By convention, if the value of the year is zero, it indicates that the Event Time is not available for the event. Revision 02-0 Page 7 of 17

8 Octet Field Range 1-2 Year 0 to Month 1 to 12 4 Day 1 to 31 5 Hour 0 to 23 6 Minutes 0 to 59 7 Seconds 0 to 59 8 Deci-seconds 0 to 9 9 Direction from UTC + / - 10 Hours from UTC 0 to Minutes from UTC 0 to 59 Note: If only the local time is known, then the time zone information (fields 9 to 11) is not present eventtype OID: Description: Event Type groups events. It is coded as an integer. The code representation of Event Type is: - GUI(1) - other(2) - equipment (3) - environmental(4) probablecause OID: Description: Probable Cause indicates (at a high level) a possible reason for the event being generated. It is coded as an integer. Revision 02-0 Page 8 of 17

9 There are several Probable Cause values; for example, - None(1) - PowerOn(2) - LossOffPower(3) - Reset(4) - Failure(5) - systemwasresetfromgui(6) - WatchdogReset(7) - SoftwareReset(8) - AssertFailure(9) - HWWatchdogTriggeredNoAssertsFound(10) - SystemMainsWasRemoved(11) - BackendRestarted(12) - FrontendRestarted(13) - InterlinkDisconnected(14) - VideoDecodingError(15) - CIDescramblingError(16) - CICommunicationDown(17) - InterlinkConnected(18) - CIDescramblingOK(19) - CICommunicationUp(20) - VideoDecodingOK(21) - PSUNoLongerWorks(22) - SDCorruptionDetected(23) Revision 02-0 Page 9 of 17

10 2.1.2 Miscellaneous The SNMP MIB-2 System (RFC 1213)[Ref 1] will be supported with Triax information, as it is showed below System Description OID: Description: A textual description of the entity. Access: Read Type: String Example: Triax TDX System Object ID OID: Description: The vendor's authoritative identification of the network management subsystem contained in the entity Access: Read Type: Object Identifier Example: System Uptime OID: Description: Getting the time since last restart. Access: Read Type: TimeTicks Example: 460 days, 1:43: System contact person OID: Description: The textual identification of the contact person for this managed node. Access: Read Type: String Example: System name OID: Description: An administratively-assigned name for this managed node. Access: Read Type: String Example: TDX System location OID: Description: The physical location of this node. Access: Read Type: String Example: Revision 02-0 Page 10 of 17

11 System service OID: Description: A value which indicates the set of services that this entity primarily offers. Access: Read Type: Integer Example: System up time OID: Description: The value of sysuptime at the time of the most recent change in state or value of any instance of sysorid.. Access: Read Type: TimeStamp Example: 0:00:00.00 Revision 02-0 Page 11 of 17

12 3. TRAPS 3.1 Trap MIB Triax Trap MIB Triax he tdtype entry triaxpoweruptrap triaxlogintrap triaxlogouttrap triaxtimeouttrap triaxfailedlogintrap triaxrestarttrap triaxinputerrortrap triaxciinsertiontrap triaxciremovaltrap triaxmoduleinsertiontrap triaxmoduleremovaltrap triaxcidescramblingerrortrap triaxcicommunicationdowntrap triaxvideodecodingerrortrap triaxinterlinkdisconnecttrap triaxconfigurationchangeappliedtrap triaxinputoktrapl triaxcidescramblingoktrap triaxcicommunicationuptrap triaxvideodecodingoktrap triaxinterlinkconnecttrap triaxpsunolongerworkstrap triaxsdcorruptiondetectedtrap triaxpoweruptrap OID: Description: This Trap is generated when the TDX is powered up triaxlogintrap OID: Description: This Trap is generated when the web configurator is logged on triaxlogouttrap OID: Description: This Trap is generated when the web configurator is logged out. Revision 02-0 Page 12 of 17

13 triaxtimeouttrap OID: Description: This Trap is generated when the web configurator login is timed out triaxfailedlogintrap OID: Description: This Trap is generated when the web configurator login is failed triaxrestarttrap OID: Description: This Trap is generated when the TDX restart the system controller, front end or a backend triaxinputerrortrap OID: Description: This Trap is generated when an input module has error. E.g Front End loses lock, missing module, etc triaxciinsertiontrap OID: Description: This Trap is generated when an CI module is inserted in TDX triaxciremovaltrap OID: Description: This Trap is generated when an CI module is removed in TDX triaxmoduleinsertiontrap OID: Description: This Trap is generated when an input or output module is inserted triaxmoduleremovaltrap OID: Description: This Trap is generated when an input or output module is removed triaxcidescramblingerrortrap OID: Description: This Trap is generated when a service descrambling has an error triaxcicommunicationdowntrap OID: Description: This Trap is generated when communication with CI module fails. Revision 02-0 Page 13 of 17

14 triaxvideodecodingerrortrap OID: Description: This Trap is generated when a video decoding of a service in PAL Back End fails triaxinterlinkdisconnecttrap OID: Description: This Trap is generated when master unit loses connection to a subunit triaxconfigurationchangeappliedtrap OID: Description: This Trap is generated when the user applies changes in the web configurator triaxinputoktrap OID: Description: This Trap is generated when an input module errors disappears. E.g errors there can disappear are Front End loses lock, missing module, e.t.c triaxcidescramblingoktrap OID: Description: This Trap is generated when a service descrambling error disappears triaxcicommunicationuptrap OID: Description: This Trap is generated when communication with the CI module do not fail any more triaxvideodecodingoktrap OID: Description: This Trap is generated when a video decoding of a service in PAL Back End do not fail any more triaxinterlinkconnecttrap OID: Description: This Trap is generated when master unit connect to a subunit triaxpsunolongerworkstrap OID: Description: This Trap is generated when one of the Power Supply(PSU) no longer works in the redundant PSU. Revision 02-0 Page 14 of 17

15 triaxsdcorruptiondetectedtrap OID: Description: This Trap is generated when the SD Card has been detected as corrupted. Supported: Release Revision 02-0 Page 15 of 17

16 3.2 Trap Format Below is showed how an event Trap look. processed=false, pdu=[trap[requestid= , errorstatus=success(0), errorindex=0, VBS[ = 152 days, 19:46:04.94; = ; = TDX; = TDX= ,Source=MAINSC; = 49; = 4; = 07:db:0b:04:08:30:0c:2a:2b:00:00; = 2; = 1; ] Revision 02-0 Page 16 of 17

17 4. APPENDEX 4.1 Triax MIB definition TRIAX EVENT MIB The MIB file TRIAX-EVENT-MIB.MIB can be found at TRIAX home page. The MIB file shall be opened with notepad or a similar text editor. TRIAX-EVENT-MIB contains only plain text. Revision 02-0 Page 17 of 17