Difference between revisions of "SNMP Device MIB"
Line 700: | Line 700: | ||
=Download= | =Download= | ||
Download the MIB from the [[Downloads#SNMP_Device_MIB|download page]] | Download the MIB from the [[Downloads#SNMP_Device_MIB|download page]] | ||
+ | |||
+ | [[Category:3rd party integration]] | ||
+ | [[Category:Exigo features]] |
Revision as of 10:20, 6 December 2016
This page briefly describes the content of the Vingtor-Stentofon MIB.
Simple Network Management Protocol (SNMP) is an Internet-standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behavior.
Devices that typically support SNMP include routers, switches, servers, workstations, printers, modem racks and more.
A Management Information Base (MIB) is a database used for managing the entities in a communication network.
Most often associated with the Simple Network Management Protocol.
Contents
Supported devices
ECPIR-1P, ECPIR-3P, EAPIR-8, EAPFX-1, EAPFX-6, EAPII-1, EAPII-6, ESC-1, ENA2200, ENA2400, TKIS-2, TKIE-1
Contents
Objects | Contents |
---|---|
Info | Contains information about the device such as name and type. |
Temp | Contains information about the different temperature sensors available (ESC-1, ENA2200, ENA2400-DC) |
Fan | Contains detailed information about the FANs (ESC-1, ENA2200, ENA2400-DC) |
Voltage | Contains detailed information about the internal voltagess (ESC-1, ENA2200, ENA2400-DC) |
Power | Contains information about how the device is powered and the current state of power sources. |
Linein | Contains status of audio inputs and microphone inputs. |
AmpChannel | Contains information and status of the amplifier modules (ENA2200 and ENA2400-DC) |
LetStatus | Contains information and status about any Line End Transponders used in the system |
ControlInput | Contains status, state and information about the control input. |
ControlOutput | Contains status, state and information about the control output. |
Eth | Contains information about the status of the network connections of the devices. |
Relay | Contains infromation about the relays located on the access panels. |
Consult the MIB file itself for additional details.
Network
Ethernet network state can also be monitored in MIB-2: MIB-2->Interfaces->ifTable->ifEntry->ifOperStatus. SW1 and SW2 corresponds to the physical network interfaces.
Description
Use area The following Vingtor-Stentofon devices can use the VS Device MIB:
1. Exigo ENA2200 (8330 Exigo Amplifier) 2. Exigo ENA2400 (8330 Exigo Amplifier) 3. Exigo ESC1 (8320 Exigo Controller) 4. Exigo Call Panel & Kits (8124 Turbine Extended) 4.1. EAPII-1 Industrial Access Panel w. 1 button 4.2. EAPII-6 Industrial Access Panel w. 6 buttons 4.3. ECPIR-P Call Panel w. PTT button 4.4. ECPIR-3P Call Panel w. PTT button and 3 programmable buttons 4.5. EAPIR-8 Alarm Panel w. 8 programmable buttons 4.6. TKIE-1 Turbine Extended IP Kit 4.7. TKIE-2 Turbine Extended IP Kit 5. Exigo TKIS-2 (8121 Turbine Compact) 6. Exigo EX (8511 Turbine EX proof)
Some objects in the VS-DEVICE-MIB is not relevant for all the listed devices and these objects will report default, unknown or no values at all when requested, i.e. fans is only part of the ENA2x00 and ESC1 devices and will report fan table count 0 to indicate that there are no fans available on any of the other devices. 3 Terminology
EMT Exigo Maintenance Tool Windows application used to configure Exigo system. OID Object Identifier OIDs uniquely identify managed objects in the MIB hierarchy. MIB Management Information Base Textual description in ASN.1 syntax of the managed object
The VS Device MIB
Use area
The following Vingtor-Stentofon devices can use the VS Device MIB:
1. Exigo ENA2200 (8330 Exigo Amplifier)
2. Exigo ENA2400 (8330 Exigo Amplifier)
3. Exigo ESC1 (8320 Exigo Controller)
4. Exigo Call Panel & Kits (8124 Turbine Extended)
4.1. EAPII-1 Industrial Access Panel w. 1 button
4.2. EAPII-6 Industrial Access Panel w. 6 buttons
4.3. ECPIR-P Call Panel w. PTT button
4.4. ECPIR-3P Call Panel w. PTT button and 3 programmable buttons
4.5. EAPIR-8 Alarm Panel w. 8 programmable buttons
4.6. TKIE-1 Turbine Extended IP Kit
4.7. TKIE-2 Turbine Extended IP Kit
5. Exigo TKIS-2 (8121 Turbine Compact)
6. Exigo EX (8511 Turbine EX proof)
Some objects in the VS-DEVICE-MIB is not relevant for all the listed devices and these objects will report default, unknown or no values at all when requested, i.e. fans is only part of the ENA2x00 and ESC1 devices and will report fan table count 0 to indicate that there are no fans available on any of the other devices.
Terminology
EMT |
Exigo Maintenance Tool |
Windows application used to configure Exigo system. |
OID |
Object Identifier |
OIDs uniquely identify managed objects in the MIB hierarchy. |
MIB |
Management Information Base |
Textual description in ASN.1 syntax of the managed object |
oid descriptions
The VS-DEVICE-MIB has OID 3 and is located under the Stentofon OID 26122 in the Enterprises OID.
There are 14 objects in the VS Device MIB and these are:
1. info
2. temp
3. fan
4. voltage
5. power
6. lineIn
7. ampChannel
8. letStatus
8.1. letChannel1
8.2. letChannel2
9. controlInput
10. controlOutput
11. eth
12. relay
info OID
1. infoPackageVersion shows the device software version, i.e. 4.2.3.12 (exi)
2. infoModelType shows a textual description of the device, i.e. Vingtor-Stentofon Amplifier ENA2200
3. infoModelNumber shows the device’s hardware model number, i.e. 8320
4. infoAmpliferType shows the device type number (not restricted to only amplifiers), i.e. ENA2200
5. infoKernelVersion shows the Linux kernel version and build date, i.e. 3.10.0 Fri Jul 15 09:13:35 CEST 2016
6. infoDeviceTreeVersion shows the device DeviceTree version, i.e. 06
7. infoDisablement shows the device disablement status, i.e. Online
temp OID
Only ENA2x00 and ESC1 devices has temperature sensors implemented and will report temperature values in this object identifier.
All reported temperature values is 10 times the real value, i.e. reported value 355 is 35.5 C and should be adjusted accordingly by the NMS before presented to the observer.
1. tempTableCount shows the number of temperature sensors reported and viewed in the tempTable, i.e. 5 for ENA2x00 and 4 for ESC1.
2. tempTable contains the items for temperature reporting.
2.1. tempIndex internal identifier.
2.2. tempSensorName shows the temperature sensor name, device dependent.
2.3. tempCurrentString, fixed text “Current Temperature” to identify current temperature item.
2.4. tempCurrentValue shows the current (last measured) temperature value. Temperatures for ENA2x00 ranges typically from 30.0 C to 75.0 C and is highly dependent on audio level, load and which temperature sensor measured. Temperatures for ESC1 ranges typically from 25.0 C to 40.0 C and will probably be more affected by the ambient temperature than the ENA2x00.
2.5. tempPeakString, fixed text “Peak Temperature” to identify peak temperature item.
2.6. tempPeakValue, shows the peak (highest measured) temperature since device was booted. Peak temperatures for the ENA2x00 ranges from typically 35.0 C to 75.0 C, although higher temperatures may be reported. Peak temperatures for the ESC1 ranges typically from 30.0 C to 40.0 C.
2.7. tempAverageString, fixed text “Average Temperature” to identify average temperature item.
2.8. tempAverageValue shows the average value of the last 8 measured current temperatures and will slowly follow the value in the tempCurrentValue and lags approx. 20 seconds after tempCurrentValue.
For ENA2x00 the following actions will be carried out based on the current value of any of the 5 temperature sensors:
· If the temperature on any of the sensors rises above 36.0 C both fans will start to run and will not stop running until the temperature on all sensors falls below 32.0 C for minimum 30 seconds.
· If the temperature on any of the sensors rises above 50.0 C, both fans will rotate at their maximum speed and will continue at maximum speed until the temperature on all sensors falls below 45.0 C.
· If the temperature on a sensor rises above 65.0 C a warning level message of type “Warning High” is generated and will not be cleared until the temperature on that sensor falls below 60.0 C. The warning message will be auto-cleared from the system when the temperature on that sensor falls below 60.0 C.
· If the temperature on a sensor rises above 83.0 C a warning level message of type “Alarm High” is generated and will not be cleared until the temperature on that sensor falls below 78.0 C. The warning message will be auto-cleared from the system when the temperature on that sensor falls below 78.0 C.
ENA2200 and ENA2400:
· If the Class D chip internal temperature sensor rises above approx. 125.0 C an alert level (crit) message of type “Graceful Degradation” is generated and will not be cleared until the temperature on the internal temperature sensor falls below approx. 110.0 C. Graceful degradation in this context means lowered audio output to self-protect the device from over-heating. The only way to remove the alert message from the system is to acknowledge the alert message and manually clear it on the ESC1 if it previously has been auto-cleared locally on that specific device.
ENA2400:
· If the DC Power temperature sensor rises above 100.0 C an alert level (crit) message of type “Graceful Degradation” is generated and will not be cleared until the temperature on the DC Power temperature sensor falls below 90.0 C. Graceful degradation in this context means lowered audio output to protect the DC Power unit from over-heating and subsequent power shutdown. The only way to remove the alert message from the system is to acknowledge the alert message and manually clear it on the ESC1 if it previously has been auto-cleared locally on that specific device.
· The AC Power temperature sensor is unused (at the time of writing) and is reported as 0 C.
For ESC1 the following actions will be carried out based on the current value of any of the 4 temperature sensors:
· If the temperature on any of the sensors rises above 41.0 C the fan will start run and will not stop running until the temperature on all sensors falls below 35.0 C for a minimum 30 seconds.
· If the temperature on any of the sensors rises above 55.0 C, the fan will rotate at its maximum speed and will continue at maximum speed until all sensors falls below 49.0 C.
· If the temperature on a sensor rises above 65.0 C a warning level message of type “Alarm High” is generated and will not be cleared until the temperature on that sensor falls below 60.0 C. The warning message will be auto-cleared from the system when temperature falls below 60.0 C.
fan OID
Only ENA2x00 and ESC1 devices has fan(s) and associated speed measurement sensor(s) implemented and will report its values to this object identifier.
1. fanTableCount shows the number of fan speed sensors reported and viewed in the fanTable, i.e. two for ENA2x00 and one for ESC1.
2. fanTable contains the fan speed reporting items.
2.1. fanIndex internal identifier.
2.2. fanString shows the fan speed sensor name, device dependent.
2.3. fanValue shows the current (last reported) fan speed value. Values can range from approx. 2500 RPM at minimum to 5100 RPM at maximum if fan is running. 0 is reported if fan is not running.
voltage OID
Only ENA2x00 and ESC1 devices has internal voltage measurement sensors implemented and will report its values to this object identifier.
All reported internal voltage values is in mV, i.e. reported value 12340 is 12.34 V and should be adjusted accordingly by the NMS before presented to the observer.
1. voltageTableCount shows the number of internal voltage sensors reported and viewed in the voltageTable and will vary according to model type and hardware revision.
2. voltageTable contains the internal voltage reporting items.
2.1. voltageIndex internal identifier.
2.2. voltageString shows the internal voltage sensor name. This is device and revision dependent.
2.3. voltageValue shows the current (last reported) internal voltage value (mV).
power OID
Only ENA2x00 and ESC1 devices will report its values to this object identifier. The reported item show if the power inlet is monitored and its connection status.
1. powerTable contains the items for power monitoring status.
1.1. powerIndex internal identifier.
1.2. powerType shows which power type reported, i.e. “acPower”, “dcPower” or “unknown”.
1.3. powerString shows the name of the power source reported.
1.4. powerMonitoring shows the monitoring status of the power inlet, i.e. “monitored”, “notMonitored” or “unknown”.
1.5. powerStatus shows the power inlets connection status, i.e. “connected”, “notConnected” or “unknown”.
lineIn OID
The lineIn object is used to show information about audio line in connection and monitoring status.
1. lineInTable contains the line items.
1.1. lineInIndex internal identifier.
1.2. lineInMonitoringState shows the monitoring state of the line in item, i.e. “notMonitored”, “monitored” or “unknown”.
1.3. lineInType shows the line in type, device dependent, i.e. “lineIn1”, “lineIn2”, “microphoneExtern”, “microphoneIntern” or “unknown”.
1.4. lineInString shows the textual description of the line in item, device dependent.
1.5. lineInStatus shows the status for the line in item, device dependent, i.e. “lineInOk”, “lineInFail”, “unknown”, “microphoneConnected”, “microphoneDisconnected”, “microphoneShorted” or “microphoneUnknown”.
ENA2x00 and ESC1 devices will report lineInType as “lineIn1” or “lineIn2”. Exigo panels based on 8124 and 8511 will report lineInType as “microphoneExtern” and “microphoneIntern”.
ENA2x00 and ESC1 devices will report lineInStatus as “lineInOK”, “lineInFail” or “unknown” and Exigo panels based on 8124 and 8511 will report lineInStatus as “microphoneConnected”, “microphoneDisconnected”, “microphoneShorted” or “microphoneUnknown”.
ampChannel OID
This OID will report the present status of the amplifier channel output(s), that is if the channel is operative (OK) or in any way disabled or impaired.
Only ENA2x00 and Exigo panels and kits based on 8121 or 8124 will report status to this OID although the panels and kits will only report “channelOK” or “unknown” in the ampChannelStatus field. The ENA2x00 devices will report all possible statuses as defined in the ampChannelStatus OID in the MIB.
1. ampChannelCount shows the number of amplifier channel outputs reported and viewed in the ampChannelTable and will vary according to model type.
2. ampType shows the type of amplifier reported, i.e. “turbine”, “ena2200”, “ena2400” or “unknown”.
3. ampChannelTable contains the amplifier output reporting items.
3.1. ampChannelIndex internal identifier.
3.2. ampChannelString shows the name of the channel output reported.
3.3. ampChannelStatus shows the status of the channel output i.e. “notOperative”, “channelOk”, “channelFail”, “channelShutdown”, “channelGracefulDegradation” or “unknown”.
For ENA2x00 the ampChannelStatus identifies the following statuses:
· “unknown” means the OID has not been updated with data from the monitoring software.
· “notOperative” means the amplifier output has been set in “Disabled” mode either by the operator from the ENA2x00 GUI or is configured as “Disabled” from EMT.
· “channelOk” means the amplifier output is on and working as intended.
· “channelFail” means the monitoring software has detected a hardware related fault. This fault can for instance be the “Ready” signal from the Class D amplifier chip not responding as expected.
· “channelShutdown” means the Class D amplifier chip has been overloaded for up to 5 times within a time-slot of 15 seconds. The overloaded amplifier output is set in “Shutdown” mode by the monitoring software and the output is “Disabled” (as in off) and reported as “Channel Shutdown” to the ESC1 system controller. Only manual operation on the local GUI on the ENA2x00 amplifier can clear the “Shutdown” mode and bring the amplifier output back into normal operation.
Note: Future versions of the ENA2x00 firmware may have an EMT selectable “channel shutdown auto-clear” option which, when enabled, will try to bring the amplifier output on and operative without manual interference.
· “channelGracefulDegradation” means either the Class D chips internal over-temperature self-protect circuitry has been activated (120.0 C) or any of the two the external temperature sensors adjacent to the Class D chip has reach the “Graceful Degradation” temperature (100.0 C). The amplifier will reduce audio output to self-protect the device. Once the temperature is below the safe temperature limit (90.0 C) the amplifier will resume normal output levels.
letStatus OID
The letStatus OID has two functional identical OID’s, the letChannel1 and letChannel2. These OID’s reflects the LET status for each of the ENA2x00 amplifier channels/outputs and letChannelX will be used as a reference in this description.
LETs can only be used with the ENA2x00 devices.
letChannelX
The maximum number of LETs connected to each ENA2x00 is 10. All the 10 LETs can be connected to one channel or evenly divided amongst the two channels, although all LETs connected to the same ENA2x00 need to be numbered uniquely, that is only one number 1 and only one number 2 and so forth.
1. letChannelXCount shows the number of LETs reported and viewed in the letChannelXTable and will vary according to the number configured in the EMT. This can be 0 if no LETs configured or a number between 1 and 10 reflecting the number of LETs configured for that channel.
2. letChannelTableX contains the LET reporting items.
2.1. letChannelXIndex internal identifier.
2.2. letChannelXDescription contains a descriptive text regarding the LET, i.e. LET physical placement “Floor 5, Door 2”.
2.3. letChannelXOperativeStatus shows the operative status of the LET i.e. “notEnabled”, “failed”, “ok” or “unknown”
2.4. letChannelXSoftwareVersion list the LETs software version, i.e. “2.0”
2.5. letChannelXHardwareVersion list the LETs hardware version, i.e. “1-1”
2.6. letChannelXVoltage shows the voltage [in mV] measured at the LET, i.e. “22000” which is 22V
controlInput OID
The controlInput OID shows the control input status for the ENA2x00, ESC1 and Exigo panels and kits.
The ENA2x00 and the ESC1 has 6 fixed inputs and the Exigo panel and kit has 6 GPIOs which can be configured to be any mix of inputs or outputs. The number of inputs configured are shown in the controlInputCount, i.e. if the Exigo panel has configured 4 inputs and 2 outputs the controlInputCount will show 4. For the ENA2x00 and the ESC1 the controlInputCount will always show 6.
1. controlInputCount shows the number of configured control inputs, device dependent, can be from 0 to 6.
2. controlInputTable contains the control input items.
2.1. controlInputIndex internal identifier.
2.2. controlInputString shows the name of the control input, fixed text i.e. “Control Input 1”.
2.3. controlInputStatus shows the status for the control input, i.e. “open”, “closed”, “failShorted”, “failOpen” or “unknown”.
2.4. controlInputMonitored shows the monitoring status of the control input, i.e. “notMonitored” or “monitored”.
Only ENA2x00 and ESC1 devices can configure the controlInputMonitored OID. For all other devices the OID has a fixed value of “notMonitored”. If this OID is configured to “monitored” the device’s monitoring software will extend the status reporting to include the “failShorted” and “failOpen”, else only “open”, “closed” or “unknown” will be reported for all devices regardless of controlInpitMonitored status.
controlOutput OID
The controlOutput OID shows the control output status for the ENA2x00, ESC1 and Exigo panels and kits.
The ENA2x00 and the ESC1 has 6 fixed outputs and the Exigo panel and kit has 6 GPIOs which can be configured to be any mix of inputs or outputs. The number of outputs configured are shown in the controlOutputCount, i.e. if the Exigo panel has configured 4 outputs and 2 inputs the controlOutputCount will show 4. For the ENA2x00 and the ESC1 the controlOutputCount will always show 6.
1. controlOutputCount shows the number of configured control outputs, device dependent, can be from 0 to 6.
2. controlOutputTable contains the control output items.
2.1. controlOutputIndex internal identifier.
2.2. controlOutputString shows the name of the control output, fixed text i.e. “Control Output 1”.
2.3. controlOutputStatus shows the status for the control output, i.e. “notActive”, “active”, “failNotActive”, “failActive” or “unknown”.
Only ENA2x00 and ESC1 devices will show the “failNotActive” and “failActive” statuses, else all devices will show the “notActive”, “active” and “unknown” status.
eth OID
The eth OID shows the monitoring state of the eth ports on the ENA2x00, ESC1 and Exigo panels with 8124 card and reflects the configuration set in the EMT.
1. ethMonitoringTable contains the eth monitored items.
1.1. ethMonitoringIndex internal identifier.
1.2. ethMonitoringString shows the name of the eth port, fixed text i.e. “Eth 1”.
1.3. ethMonitoringState shows the monitoring state for the eth port, i.e. “notMonitored”, “monitored” or “unknown”.
The RFC1213-MIB mib-2->interfaces->ifTable->ifDescr [sw1 and sw2] and ifOperStatus [up or down] will show the Ethernet ports connection status.
relay OID
The relay OID shows the relay status for the Exigo TKIS-2 kit and the Exigo call panel based on 8124 card.
1. relayTable contains the relay status items.
1.1. relayIndex internal identifier.
1.2. relayString shows the name of the relay item, fixed text i.e. “Internal Relay 1”.
1.3. relayIdleMode shows the idle position for the relay, i.e. “normallyClosed”, “normallyOpen” or “unknown”.
1.4. relayDelay shows the delayed activation time in seconds, values from 0 to 30 seconds.
1.5. relayState shows the state of the relay, i.e. “notActive”, “active” or “unknown”.
Download
Download the MIB from the download page