FIAL-ENC-MIB
AI MIB Summary
The FIAL-ENC-MIB enables SNMPv2 monitoring of alarm states and analog sensor values, alongside write-access control of relay outputs and notification toggles, specifically for the Fial Model 2311 SNMP Encoder. This module facilitates direct hardware manipulation of remote equipment via the `encControlPointTable` and management of event alerting through the `encMgrNotifyTable`, requiring strict community string and IP-based access controls due to the critical nature of the SET operations.
This SNMPv2 MIB module defines MIB objects and notifications for monitoring alarms, analog values and controlling relays in the Fial Model 2311 SNMP Encoder. This MIB has a simple design that allows field personnel to check alarms and controls with a MIB Browser. There are a number of management objects defined in this MIB module with a MAX-ACCESS clause of read-write. Such objects may be considered sensitive or vulnerable in some network environments. The support for SET operations in a non-secure environment without proper protection can have a negative effect on network operations. These are the tables and objects and their sensitivity/vulnerability: 1) encControlPointTable and its encControlReqState object: 'Sets' to this object open and close relays that control remote equipment. Access is controlled by the write community string. 2) encMgrNotifyTable and its encMgrEventNotify object 'Sets' to this object switch notifications on and off for specific managers. Access is controlled by the write community string and restricted to the IP address of the manager. The key words MUST, MUST NOT, REQUIRED, SHALL SHALL NOT, sHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in [RFC2119]. Copyright 2002, 2004 Fial Incorporated All rights reserved Reproduction of this document is authorized on the condition that the foregoing copyright notice is included. This SNMP MIB module (Specification) embodies proprietary intellectual property of Fial Incorporated (hereafter referred to as Fial). Fial retains all title and ownership in the Specification, including any revisions. Fial grants all interested parties a non-exclusive license to use and distribute an unmodified copy of this Specification in connection with management of Fial products, and without fee, provided this copyright notice and license appear on all copies. This Specification is supplied 'AS IS,' and Fial makes no warranty, either express or implied, as to the use, operation, condition or performance of the Specification.
Main OID:
fialEncMIB.1.3.6.1.4.1.4822.1.2.3
64
Objects
Active
Status
4
Dependencies
Imported Objects
Objects
64 total| Object Name |
|---|
fialEncMIBThis SNMPv2 MIB module defines MIB objects and notifications for monitoring alarms, analog values and controlling relays in the Fial Model 2311 SNMP Encoder. This MIB has a simple design that allows field personnel to check alarms and controls with a MIB Browser. There are a number of management objects defined in this MIB module with a MAX-ACCESS clause of read-write. Such objects may be considered sensitive or vulnerable in some network environments. The support for SET operations in a non-secure environment without proper protection can have a negative effect on network operations. These are the tables and objects and their sensitivity/vulnerability: 1) encControlPointTable and its encControlReqState object: 'Sets' to this object open and close relays that control remote equipment. Access is controlled by the write community string. 2) encMgrNotifyTable and its encMgrEventNotify object 'Sets' to this object switch notifications on and off for specific managers. Access is controlled by the write community string and restricted to the IP address of the manager. The key words MUST, MUST NOT, REQUIRED, SHALL SHALL NOT, sHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in [RFC2119]. Copyright 2002, 2004 Fial Incorporated All rights reserved Reproduction of this document is authorized on the condition that the foregoing copyright notice is included. This SNMP MIB module (Specification) embodies proprietary intellectual property of Fial Incorporated (hereafter referred to as Fial). Fial retains all title and ownership in the Specification, including any revisions. Fial grants all interested parties a non-exclusive license to use and distribute an unmodified copy of this Specification in connection with management of Fial products, and without fee, provided this copyright notice and license appear on all copies. This Specification is supplied 'AS IS,' and Fial makes no warranty, either express or implied, as to the use, operation, condition or performance of the Specification. MODULE-IDENTITY .1.3.6.1.4.1.4822.1.2.3 |
fialEnc OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3 |
encNotifications OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3.0 |
encShutdownSent when SNMP Encoder program is shut down. NOTIFICATION-TYPE .1.3.6.1.4.1.4822.2.3.0.1 |
encStartupSent when SNMP Encoder program is started. This message indicates the start of an epoch. NOTIFICATION-TYPE .1.3.6.1.4.1.4822.2.3.0.2 |
encEventLogSent to report an alarm or control event, i.e. whenever a new row is appended to the encEventLogTable. The column values for the entire row are sent in the varbind list of this notification, so the manager may not need to fetch the row from that table. Values are assigned to encEventLogIndex in strictly increasing fashion, so the manager can use the value of that variable to verify that no notifications have been missed. For alarm and control points, severities CR, MJ and MN cause a notification to be sent when the on/off state changes. Severity ST (status) only causes a notification if 'Add ST events to the event Log' is set to 'Yes' in the 2311 web configuration page. The severity for Control points is always ST. Note that a notification is always sent when a control point changes state, regardless of the 'Add ST event ...' setting This notification is sent only to managers whose IPv4 address appears in the encMgrNotifyTable. A manager may enable or disable the sending of this notification to itself by setting encMgrEventNotify to true (1) or false (2) in the encMgrNotifyTable, in the row containing the manager's IP address. NOTIFICATION-TYPE .1.3.6.1.4.1.4822.2.3.0.3 |
encObjects OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3.1 |
encGlobals OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3.1.1 |
encSiteNameSite Name or designation for Encoder. A name or location code may be used. For example: PikesPeak, RadiumSprings, Spur17B35. Also see the sysDescr in the MIB-II system group for the factory model number and software revision.ro DisplayString (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.1.1 |
encMIBModuleRevThe revision of encMIB which is supported by the agent. This value should match the most recent REVISION field of the fialEncMIB MODULE-IDENTITY loaded at the management station (i.e. 200403010000Z).ro DisplayString .1.3.6.1.4.1.4822.2.3.1.1.2 |
encEventLogTableLastIndexThe value of the encEventLogIndex column for the last row appended to the encEventLogTable. A management station can use this value to periodically check whether new events have been entered in the event log without having to walk the entire table. A manager can also use this value to verify that it has not missed any notifications of encEventLogTable new rows. If the encEventLogTable contains no rows, this object will return a value of 0.ro Unsigned32 .1.3.6.1.4.1.4822.2.3.1.1.3 |
encAnalogCardIndicates whether the Encoder contains an analog-input card. The value is 1 for true, 2 for false. If false, accesses to encAlarmLogTable will return a noSuchInstance exception.ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.1.4 |
encEventLogTableA table of recent alarm, analog and control events indexed chronologically. Rows in this table reflect alarm (on/off) events,analog values transitioning accross upper or lower threshold limits, or control point (on/off) changes. This table is a log of the changes taking place in the encAlarmPointTable, encControlPointTable and the encAnalogPointTable. A notification can be sent to managers when a row is added to this table. The manager MUST be identified in a row of the encMgrNotifyTable, and encMgrEventNotify in that row MUST be true(1). When a row is added to encEventLogTable, The index value of the row is included in the varbind list of a notification. This provides a mechanism by which managers can verify that no notifications have been missed (there would be a gap in the sequence of indices received). The Encoder allows a maximum of 100 rows in this table. When the table has 100 rows, the oldest row is deleted before a new row is added. A new epoch starts when the MIB-II object SysUptime is zero or is less than the previous value of SysUptime. This happens whenever the unit is restarted, or when SysUptime rolls over to zero at 497 days after a restart. At that time all data in this MIB should be reloaded by the manager. SEQUENCE OF EncEventLogEntry .1.3.6.1.4.1.4822.2.3.1.2 |
encEventLogEntryA row in the Event log table. Rows cannot be created, deleted or modified via SNMP operations. EncEventLogEntry .1.3.6.1.4.1.4822.2.3.1.2.1 |
encEventLogIndexThe index for events in the Events log table. The index of an existing entry is not affected when an entry is added or removed from the table. Index values are non-zero and assigned in a strictly increasing fashion (beginning with 1 at system startup). Values are not re-used until the entire 32-bit range has been exhausted. Thus, the rows in the encEventLogTable are indexed chronologically. The value of encEventLogTableLastIndex is updated whenever a new row is added to the table. If there are 100,000 new table entries per day, the table index will not overflow for 109 years. Unsigned32 .1.3.6.1.4.1.4822.2.3.1.2.1.1 |
encEventLogTypeThe configured type of the Event. The Textual convention For EncPointType defines discrete alarm point as 1, analog alarm point as 2 and control point as 3.ro EncPointType .1.3.6.1.4.1.4822.2.3.1.2.1.2 |
encEventLogPointNameThe name of the point. The name will match the value seen in the encAlarmName, encControlName or encAnalogName objects of the alarm, control and analog tables escribed in this mib module. See encEventLogType to determine which table.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.2.1.3 |
encEventLogPointStateThe ON/OFF state of the alarm, analog or control point event being logged, encoded with the EncPointState textual convention.ro EncPointState .1.3.6.1.4.1.4822.2.3.1.2.1.4 |
encEventLogSeverityA short mnemonic representing the severity of the event. The possible values are CR, MJ, MN, or ST. For control points, this value is always ST (status). If notifications are enabled, a notification is always sent when a control point changes state, even if 'Add ST Events to the Event Log' is set to 'No' in the 2311's IP Settings web page. This object is similar to SyslogSeverity TC in the SYSLOG-DEVICE-MIB, however the CR, MJ, MN, ST values used here are more standard in the telecom industry.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.2.1.5 |
encEventLogSAIndicates whether the point is one which can affect service. This means dropping traffic in a telecommunications syatem. The value is 1 for true, 2 for false. This value is always 2 (false) for control points.ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.2.1.6 |
encEventLogDateAndTimeThe date and time on the local machine when the alarm event occurred. See SNMPv2-TC. For example, Tuesday May 11, 2002 at 2:30:15.0 PM EDT will be represented by OCTET STRING: '07D2050B0E1E0F002D0400'H Hexadecimal ---> 07D2 05 0B 0E 1E 0F 00 2D 04 00 Decimal/alpha -> 2002 5 11 14 30 15 0 - 4 0 hours,minutes,seconds,tenths ...^..^..^..^ time-zone-offset hours,minutes ..............^..^ Using DISPLAY-HINT 2d-1d-1d,1d:1d:1d.1d,1a1d:1d will display: 2002-5-11,14:30:15.0,-4:0 SNMP managers will reformat this per local custom.ro DateAndTime (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.2.1.7 |
encEventLogPointTableIndexEvery row in the encEventLogTable represents a point change-of-state event. If the event is a discrete alarm point, then this object returns the index of a row in the encAlarmPointTable which corresponds to the point that changed state. If the event is an analog threshold event, then this object returns the index of a row in the encAnalogPointTable. If the event is a control point change of state, then this object returns the index of a row in the encControlPointTable.ro Unsigned32 .1.3.6.1.4.1.4822.2.3.1.2.1.8 |
encAlarmPointTableThe table of information about alarm points. This table provides a set of points that are always visible to an SNMP manager. For all points, the encAlarmState column indicates if a point is ON (asserted) or OFF. The point names, severity etc. are configured with a web browser. A new epoch starts when SNMP MIB-II object SysUpTime is zero or is less than the previous value of SysUpTime. This happens whenever the unit is restarted, or when SysUptime rolls over to zero 497 days after a restart. At that time all data in this table is subject to change. During an Epoch, rows will not be added or deleted. SEQUENCE OF EncAlarmPointEntry .1.3.6.1.4.1.4822.2.3.1.3 |
encAlarmPointEntryA row in the table of alarms. Rows cannot be created, deleted or modified via SNMP operations. EncAlarmPointEntry .1.3.6.1.4.1.4822.2.3.1.3.1 |
encAlarmIndexAn arbitrary index to uniquely identify each row in the encPointTable. Unsigned32 .1.3.6.1.4.1.4822.2.3.1.3.1.1 |
encAlarmNameThe name of the alarm point.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.3.1.3 |
encAlarmStateThe current ON/OFF state of the point.ro EncPointState .1.3.6.1.4.1.4822.2.3.1.3.1.4 |
encAlarmSeverityNameA short mnemonic representing the severity of the point. The values CR, MJ, MN, ST are possible. This stands for critical, major minor and status respectively. The severity of a point is assigned with a web browser. This makes the severity value readily visible using a MIB browser.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.3.1.5 |
encAlarmServAffectingIndicates whether the point is one which can affect service. This means dropping traffic in a telecommunications syatem. For example, a door-open or tower-light alarm may be a major alarm but would not be classified as service-affecting. The value is 1 for true, 2 for false.ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.3.1.6 |
encControlPointTableThe table of control points. Each row contains information about a control point in the SNMP Encoder. The point names are configured with a web browser. A new epoch starts when SNMP MIB-II object SysUpTime is zero or is less than the previous value of SysUpTime. This happens whenever the unit is restarted, or when SysUptime rolls over to zero 497 days after a restart. At that time all data in this table is subject to change. During an Epoch, rows will not be added or deleted. SEQUENCE OF EncControlPointEntry .1.3.6.1.4.1.4822.2.3.1.4 |
encControlPointEntryA row in the table of controls. Rows cannot be created, deleted or modified via SNMP operations. EncControlPointEntry .1.3.6.1.4.1.4822.2.3.1.4.1 |
encControlIndexAn arbitrary index to uniquely identify each row in the encPointTable. Unsigned32 .1.3.6.1.4.1.4822.2.3.1.4.1.1 |
encControlNameThe name of the control point.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.4.1.2 |
encControlStateThe current ON/OFF state of the point.ro EncPointState .1.3.6.1.4.1.4822.2.3.1.4.1.3 |
encControlReqStateThe requested ON/OFF state of the control point. To turn a control ON or OFF a manager should set this variable to the desired state (1 for on, 2 for off) using an SNMP set request, and set encControlSpinLock to its current value in the same PDU. If the point is already in the requested state then the set request will fail, and the Encoder will return inconsistentValue. A successful result only indicates to the manager that the request has been queued. A successful result does NOT necessarily indicate that the requested control has been executed, since such operations can take about 0.1 second to complete. A manager should poll the encControlState object for the appropriate row for verification that the control was performed successfully.rw EncPointState .1.3.6.1.4.1.4822.2.3.1.4.1.4 |
encControlSpinLockA manager desiring to set the value of EncControlReqState must simultaneously (in the same PDU) set the value of encControlSpinLock to its current value. If the current value of encControlSpinLock is 2345, then a manager must set encControlSpinLock to 2345 in the same PDU that sets encControlReqState to a desired value. If the operation is successful, then encControlSpinLock will be incremented by one, and encControlState will be set to match the encReqControlState value that was 'set'. if encControlSpinLock reaches the maximum value of 2^31-1 (2147483647 decimal), then the value held by encControlSpinLock is wrapped to zero; otherwise, the value is incremented by one. If the set operation fails, an error of `inconsistentValue' is Returned. (Note that regardless of whether the management protocol set operation succeeds, the variable- binding in the request and the response PDUs are identical.) When the Encoder is restarted, the value this object will be set to 0.rw TestAndIncr (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.4.1.5 |
encAnalogPointTableA table of analog points. Each row contains information about an analog value as configured with a web configuration page. The point names, thresholds, etc. are configured with a web browser. The analog input module is an optional add-in feature for the encoder. If the module is not present, accesses to this object will return a noSuchInstance exception. A new epoch starts when SNMP MIB-II object SysUpTime is zero or is less than the previous value of SysUpTime. This happens whenever the unit is restarted, or when SysUptime rolls over to zero 497 days after a restart. At that time all data in this table is subject to change. During an Epoch, rows will not be added or deleted. SEQUENCE OF EncAnalogPointEntry .1.3.6.1.4.1.4822.2.3.1.5 |
encAnalogPointEntryA row in the table of analog points. Rows cannot be created, deleted or modified via SNMP operations. EncAnalogPointEntry .1.3.6.1.4.1.4822.2.3.1.5.1 |
encAnalogIndexAn arbitrary index to uniquely identify each row in the encAnalogTable. Unsigned32 .1.3.6.1.4.1.4822.2.3.1.5.1.1 |
encAnalogNameThe name of the analog point.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.5.1.2 |
encAnalogStateThe current ON/OFF state of the point.ro EncPointState .1.3.6.1.4.1.4822.2.3.1.5.1.3 |
encAnalogSeverityA short mnemonic representing the severity of the point. The values CR, MJ, MN, ST are possible. This stands for critical, major minor and status respectively. The severity of a point is assigned with a web browser. This makes the severity value readily visible using a MIB browser.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.5.1.4 |
encAnalogServAffectingIndicates whether the point is one which can affect service. This means dropping traffic in a telecommunications syatem. The value is 1 for true, 2 for false.ro TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.5.1.5 |
encAnalogValueThe analog value of the point encoded into an octet string. Examples: -2.123456E+03, +1.234567E-09, +8.000000E+00 See the EncFloat Textual-Convention in this MIB.ro EncFloat .1.3.6.1.4.1.4822.2.3.1.5.1.6 |
encAnalogLowThresholdIf encAnalogPointValue is ever less than encAnalogPointLowThreshold, then the analog point is said to be in alarm, and its encState value is set to ON.ro EncFloat .1.3.6.1.4.1.4822.2.3.1.5.1.7 |
encAnalogHighThresholdIf encAnalogPointValue is ever greater than encAnalogPointHighThreshold, then the analog point is said to be in alarm, and its encPointState value is set to ON.ro EncFloat .1.3.6.1.4.1.4822.2.3.1.5.1.8 |
encAnalogUnitsThe units that describe encAnalogPointValue, such as Volts, Amps, Gallons, Bit-error-rate. A web browser is used to specify the Input voltage range, offset, multiplier and units.ro DisplayString (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.5.1.9 |
encMgrNotifyTableThe manager notification table. This table provides information about which managers are sent notifications. This table is provisioned via a web interface. Only the encMgrEventNotify column is read-write. It is writeable ONLY by the manger whose IP address is provisioned in the same row, so no spinlocks, etc. are necessary. A new epoch starts when SNMP MIB-II object SysUpTime is zero or is less than the previous value of SysUpTime. This happens whenever the unit is restarted, or when SysUptime rolls over to zero 497 days after a restart. At that time all data in this table is subject to change. During an Epoch, only the encMgrEventNotify column can change. During an Epoch, rows will not be added or deleted. The SNMP-NOTIFICATION-MIB and SNMP-TARGET-MIB were deemed too complex for this product. Alarm monitoring applications using this product generate very few notifications per day, generally for one manager only. SEQUENCE OF EncMgrNotifyEntry .1.3.6.1.4.1.4822.2.3.1.6 |
encMgrNotifyEntryA row in the table of alarms. Rows cannot be created, deleted or modified via SNMP operations. EncMgrNotifyEntry .1.3.6.1.4.1.4822.2.3.1.6.1 |
encMgrIndexAn arbitrary index to uniquely identify each row in the encMgrNotifyTable. Unsigned32 .1.3.6.1.4.1.4822.2.3.1.6.1.1 |
encMgrIPAddrThe IPv4 address in nnn.nnn.nnn.nnn notation for an SNMP manager that is to receive notifications.ro IpAddress .1.3.6.1.4.1.4822.2.3.1.6.1.2 |
encMgrNameA short description of the Manager or Manager location.ro DisplayString .1.3.6.1.4.1.4822.2.3.1.6.1.3 |
encMgrEventNotifyInstructs the agent whether to send the manager notifications to report events as they happen and are added to the encEventLogTable. The manager may set this value to true(1) or false(2). On startup (new epoch) this value is set to the state that was provisioned in the IP Settings web- page.rw TruthValue (SNMPv2-TC) .1.3.6.1.4.1.4822.2.3.1.6.1.4 |
encConformance OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3.2 |
encMIBGroups OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3.2.1 |
encGlobalsGroupAll accessible global objects in the Encoder MIB. Unknown .1.3.6.1.4.1.4822.2.3.2.1.1 |
encEventLogGroupThe encAlarmLogTable Unknown .1.3.6.1.4.1.4822.2.3.2.1.2 |
encAlarmPointGroupThe encAlarmPointTable Unknown .1.3.6.1.4.1.4822.2.3.2.1.3 |
encControlPointGroupThe encControlPointTable Unknown .1.3.6.1.4.1.4822.2.3.2.1.4 |
encAnalogPointGroupThe encAnalogPointTable Unknown .1.3.6.1.4.1.4822.2.3.2.1.6 |
encMgrGroupThe encoder Manager Notify table Unknown .1.3.6.1.4.1.4822.2.3.2.1.7 |
encNotificationGroupEncoder Notifications Unknown .1.3.6.1.4.1.4822.2.3.2.1.8 |
encMIBCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.4822.2.3.2.2 |
encMIBComplianceThe compliance statement for SNMP entities that implement the FIAL-ENC-MIB. Unknown .1.3.6.1.4.1.4822.2.3.2.2.1 |