Mibs Cordex HP
Mibs Cordex HP
Mibs Cordex HP
List of Figures
Figure 1: CXC HP SNMP Agent Configured for an SNMPv3 NMS........................................................... 11
Figure 2: Notification Destination Table..................................................................................................... 12
Figure 3: System SNMP Component Reference....................................................................................... 12
Figure 4: Example of Discovery Using the MG-SOFT V10 SNMP Tool.....................................................13
Figure 5: Sample Data for a CXC HP SNMP Notification......................................................................... 14
Figure 6: Example of a Subtree Walk on the MIB-2 System Node........................................................... 15
Figure 7: SNMP Configuration Page..........................................................................................................16
Figure 8: Software / Firmware Downloads Page....................................................................................... 16
Figure 9: Example CXC HP SNMP Notification.........................................................................................17
Figure 10: Notification - Alarm Active........................................................................................................ 27
Figure 11: Notification - Alarm Clear..........................................................................................................27
Figure 12: Table View of Configuration List Table for Digital Alarm...........................................................29
Figure 13: Table View of Configuration List Table for Threshold Alarm..................................................... 29
Figure 14: Field List for SNMPv2-MIB....................................................................................................... 33
Figure 15: Table from Alpha Resource MIB...............................................................................................34
Figure 16: Tables from Alpha Resource MIB.............................................................................................35
Figure 17: Tables from Alpha Resource MIB.............................................................................................35
Figure 18: Table View for the ComponentTable.........................................................................................43
Figure 19: Table View for the DataListTable.............................................................................................. 44
Figure 20: Table View for the DataTable....................................................................................................45
Figure 21: Sample Query of System Voltage............................................................................................ 45
Figure 22: Table View for the ComponentTable.........................................................................................47
Figure 23: Table View for the ConfigurationListTable................................................................................ 47
Figure 24: Table View for the Configuration Table.....................................................................................48
Figure 25: Sample Set of Float Voltage.....................................................................................................48
Figure 26: Table View for the ComponentListTable................................................................................... 49
Figure 27: Table View for the ConfigurationListTable................................................................................ 50
Figure 28: Table View for the Configuration Table.....................................................................................51
Figure 29: Sample Set of Rectifier Assignment Rule................................................................................ 51
Figure 30: Table View for the ConfigurationChoiceList Table.................................................................... 52
Figure 31: Example: Available Alarm Type List......................................................................................... 53
Figure 32: Example Available Alarm List................................................................................................... 54
List of Tables
Table 1: Alarm Reference Table.................................................................................................................18
Table 2: Digital Alarm Configuration Fields................................................................................................ 28
Table 3: Threshold Alarm Configuration Fields.......................................................................................... 29
Table 4: The Controller Information Flat Table...........................................................................................36
Table 5: The Controller Information Full Table........................................................................................... 36
Table 6: Component List............................................................................................................................ 38
Table 7: Data Field Type............................................................................................................................ 41
Table 8: Data List....................................................................................................................................... 43
Table 9: Configuration Field Type.............................................................................................................. 46
Table 10: Configuration Choice List........................................................................................................... 52
Table 11: Alarm Type List...........................................................................................................................52
Table 12: Configuration Choice List........................................................................................................... 55
Table 13: Controller Fields SNMP IDs (Component Type #1)................................................................... 56
Table 14: DC System Fields SNMP IDs (Component Type #2).................................................................58
Table 15: Rectifier Fields SNMP IDs (Component Type #4)......................................................................60
Table 16: Converter Fields SNMP IDs (Component Type #5)................................................................... 60
Table 17: Shunt Fields SNMP IDs (Component Type #13)....................................................................... 60
Table 18: CAN Bus Fields SNMP IDs (Component Type #15).................................................................. 61
Table 19: Converter System Fields SNMP IDs (Component Type #16).................................................... 61
Table 20: Inverter System Fields SNMP IDs (Component Type #19)........................................................61
Table 21: Bypass Switch Fields SNMP IDs (Component Type #20)..........................................................66
Table 22: Delay Timer Fields SNMP IDs (Component Type #21)..............................................................66
Table 23: Interval Timer Fields SNMP IDs (Component Type #22)........................................................... 67
Table 24: Up Counter Fields SNMP IDs (Component Type #23).............................................................. 67
Table 25: Down Counter Fields SNMP IDs (Component Type #24).......................................................... 67
Table 26: Custom Data Fields SNMP IDs (Component Type #25)............................................................67
Table 27: CT Fields SNMP IDs (Component Type #26)............................................................................ 68
Table 28: Breaker or Fuse Fields SNMP IDs (Component Type #27)....................................................... 68
Table 29: Line Power System Fields SNMP IDs (Component Type #31).................................................. 68
Table 30: LPS Module Fields SNMP IDs (Component Type #32)............................................................. 68
Table 31: LP Load Fields SNMP IDs (Component Type #33)................................................................... 69
Table 32: 8R8D Fields SNMP IDs (Component Type #3)..........................................................................69
Table 101: Battery String Fields SNMP IDs (Component Type #50)......................................................... 98
Table 102: Timing Relay Fields SNMP IDs (Component Type #51).......................................................... 98
Table 103: DC Source System Fields (Component Type #52).................................................................. 99
Table 104: Basic DC Source Fields (Component Type #53)..................................................................... 99
Table 105: Data Subscription Fields (Component Type #54).................................................................. 100
Table 106: Generic Disconnect Fields SNMP IDs (Component Type #55)..............................................100
Table 107: AC Source System Fields (Component Type #56)................................................................ 101
Table 108: AC Source Fields (Component Type #57)............................................................................. 101
Table 109: Peak Shaving System Fields (Component Type #60)............................................................103
Table 110: Scheduled Time Span Fields (Component Type #61)............................................................103
Table 111: Bypass Switch XMBS Fields (Component Type #62).............................................................103
Table 112: SNMPv1 TRAPs vs. SNMPv2 NOTIFICATION...................................................................... 104
• Managed devices
• Agents
• Network management system (NMS)
A managed device is a node that has an SNMP agent. An agent is a software component that provides
device information using the SNMP protocol. An NMS collects data from SNMP agents, and then uses
that data to monitor and manage the associated devices.
To set up the SNMP agent on the CXC HP, you need to know how the NMS accessing the controller is set
up.
There are three main things you need to know:
1. From the main dashboard go to, Controller > Configure Controller > Communications > SNMP.
2. From the Configuration table, ensure the SNMP Agent is Enabled.
The device must be reset to complete the Enable/Disable SNMP Agent configuration.
If SNMP Agent is Discovery Only, the controller will be available to be discovered, but
nothing else. OID’s under controllerInfo (OID 1.3.6.1.4.1.7309.5.1) and MIB-2 system (OID
1.3.6.1.4.1.7309.5.1) can be queried, as these are commonly used to discover and identify
devices.
3. If the SNMP Client is allowed to set the configuration objects on the Configuration table (OID
1.3.6.1.4.1.7309.5.2.5.2), set SNMP Get and Set to Get And Set Allowed.
4. Enter the Read or Write Communities SNMP clients will be querying with in the Read
Communities and Write Communities tables.
If a query is made with a read community that does not match any of the configured Read
Communities, that query will not get a response.
5. From the SNMPv3 Configuration table
• For SNMPv1, set SNMPv3 Security to Disabled
• For SNMPv2, set SNMPv3 Security to Disabled
1. From the main dashboard go to, Controller > Configure Controller > Communications > SNMP
> SNMP Destination table.
2. On the Notification Destination line, click the more details icon.
3. From the Notification Destination table, ensure the following:
• the Destination is Enabled
• the IP Address is set to an appropriate machine name, IPv4 or IPv6 address.
• the Community string is set to the value used by the NMS for SNMPv2.
• the Port is set to the port used by the NMS to receive notifications.
4. Ensure that the Notification Timeout is set to:
• For Traps and Notifications, set the Notification Timeout to 0 seconds.
• For SNMP v2 and v3 Informs, set the Notification Timeout to 5 or more seconds.
Note:
With SNMP Acknowledged Notifications, the SNMP Agent waits for an acknowledgment
(ACK) from the NMS for every notification it sends. If the agent does not get an ACK within
the timeout period, the SNMP agent will retransmit the notification.
5. Ensure that the Notification Retries is set to a reasonable number (for example, between 3 to 5).
Retries only apply to inform notifications that have a Notification Timeout value. The number of
retries should be small as they are only meant to make the delivery of notifications more reliable.
Once complete the Notification Destination table should look similar to the following figure.
2.5. Discovery
SNMP discovery occurs by scanning IP address ranges for SNMP enabled devices, and then searching
the product identification fields for specific values. It is recommended that you use the SNMPv2-MIB
sysDescr field, to identify the CXC HP. This field’s purpose is described in RFC-1213.
The sysDescr field identifies a CXC HP as a “Power System Controller”. The following data is an example
value for the sysDescr field:
System Controller, SW: v2.1 Dev 209, OS: v2.0, HW: S1.I1.P1, SN: 5799854652
Note: If you can ping the CXC HP, but are having trouble with SNMP discovery, check to ensure that
the CXC HP’s SNMP agent is enabled.
Note: If sysDescr starts with “Discovery Only”, this indicates that the controller is only available for
discovery, and not all information is able to be queried. For full functionality, ensure that the controller’s
SNMP agent is enabled.
Note: If SNMPv3 Security is Enabled, then the discovery tool must use the corresponding
authentication, encryption protocols and settings.
2.6. Notifications
The CXC HP supports two notification types:
Both notifications share the same format, as defined in RFC 3877 - ALARM-MIB.
Note: alarmSeverity is mapped to Parameter 1 in the CXC HP alarm definitions. This type
of generic name is used for alarm data that is needed for remote communication, but not used for
local alarm processing.
• controllerInfoName - text name of the controller
• alarmCustomDescription - user configurable text name of the alarm
◦ Details about what caused the alarm. This is currently only provided for LP Modules.
• A Test Notification button is available to test connectivity to the configured destination(s). The
test NOTIFICATION has a reduced set of data points (Varbinds) populated with a unique set of
information to avoid confusion with a real NOTIFICATION. This item is NOT defined in any MIB as
it is not intended to be interpreted by a monitoring system.
Note:
If using SNMPv1: a difference you may see in an SNMPv1 NMS is in the way it performs a MIB WALK.
SNMPv2 or SNMPv3 NMS perform a GETBULK command to WALK an MIB. An SNMPv1 NMS performs
a sequence of GETNEXT commands to WALK an MIB. The SNMPv1 WALK will expose the fact that the
CXC HP MIBs are sparsely populated in some areas. The SNMPv1 WALK makes it look like the CXC HP
MIBs have more data values than expected, and most of those values are empty. When doing a SNMPv1
WALK, it is necessary to filter out those empty values.
As an alternative, visit the Alpha website to download the latest version of the MIB files for the controller
are available (http://www.alpha.ca/web2/software-firmware-downloads). Some registration information is
required to access the page.
Although there are a number of varbinds available for simple alarm mapping and matching, the Alarm
Model Pointer and the Alarm Resource Id provide access to a rich set of data. The Alarm Model Pointer
provides a pointer into the Alarm table where more details about the alarm are available. The Alarm
Resource Id provides a pointer to the resource or inventory item that the notification is about.
For example, if you had a Battery Disconnect and a Load Disconnect open at the same time, both
notifications would share the same Alarm Model Pointer of “Disconnect Open”, but one Alarm Resource
Id would point to the Battery Disconnect and the other Alarm Resource Id would point to the Load
Disconnect.
The following is a list of all possible alarms that exist in the CXC HP. Due to the dynamic nature and
variable setup of a power system, the alarm list is potentially different when monitoring different setups.
For example, if you have two CXC HPs, one controlling a rectifier system and another controlling a
converter system, the alarm lists for each one will not be identical. But even with the variable sets of
alarms available, a consolidated list of all alarms can provide a reference point to get information of
any and all possible notifications coming out of the CXC HP. This is because all alarms are defined with
unique identifying features that will not change or be duplicated. The following figure provides you a full
list of possible alarms.
Alarm severity is indicated by the last number in the assigned OID. The table below does not list all
possible alarm states. Reviewing the Alarm Model table using a SNMP tool will provide all instances of
possible alarms and their states.
• 1: Clear
• 2: Message
• 3: Minor
• 4: Major
• 5: Critical
As per the defined standards, all OID references to alarm models not only point to the entry of the model
in the table, but also to the corresponding state of that alarm.
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
2 DC System : Rectifier Fail Count Very High (previously: Rectifier Major Fail 20011
Count)
2 DC System : Rectifier Fail Count High (previously: Rectifier Minor Fail Count) 20012
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
Component
Alarm Name OID
List Type
Binding #3: Is a row pointer to the alarm model of the alarm being reported. This pointer will always
point to the original alarm and its priority. It is recommended that this value is used for active and clear
notification matching.
All other bindings are added to provide the details needed to identify and process the alarm being
reported.
being cleared, including the time of the event. This cleared alarm list provides a historical log of events. If
an alarm toggles between active and cleared, each cleared event is logged.
Alarm transitions are recognized as a change of state between active and clear. However, alarms on the
CXC HP can also go into an unknown state. This is particularly relevant at configuration time when alarms
are being added, removed, enabled and disabled (e.g. when a User Alarm is deleted). When an active
alarm is disabled or removed, the SNMP agent will treat the alarm as if it has cleared. The SNMP agent
will remove the alarm from the active table, and then add an entry to the cleared alarm table.
When the CXC HP is reset, the active and cleared alarm tables will be empty.
The OID for Controller: Clock Error Alarm is 10001; therefore, the base SNMP ID for Clock Error Alarm
configuration fields is 1000100.
Alarm Priority Base SNMP ID + 1 Priority at which alarm should be reported. The value
can be Warning, Minor, Major or Critical.
Parameter 1 Base SNMP ID + 2 A customizable user value to be used for filtering and/
or other monitoring activities for alarm notifications.
This correlates to the SNMP Severity varbind in the
Alpha Notification varbind list.
Custom Name (Pa- Base SNMP ID + 3 A user definable alarm name that replaces the default
rameter 2) alarm name on the UI. It also appears in the SNMP
Custom Description varbind in the Alpha Notification
varbind list.
Figure 12. Table View of Configuration List Table for Digital Alarm
Threshold Alarms
Alarm Priority Base SNMP ID + 1 Priority at which alarm should be reported. The value
can be Warning, Minor, Major or Critical.
Parameter 1 Base SNMP ID + 2 A customizable user value to be used for filtering and/
or other monitoring activities for alarm notifications.
This correlates to the SNMP Severity varbind in the
Alpha Notification varbind list.
Custom Name (Pa- Base SNMP ID + 3 A user definable alarm name that replaces the default
rameter 2) alarm name on the UI. It also appears in the SNMP
Custom Description varbind in the Alpha Notification
varbind list.
Limit Base SNMP ID + 4 The alarm will be active when the input is either above
or below this limit depending on if it is a high or low
threshold alarm
Hysteresis Base SNMP ID + 5 Size of dead zone between activation and deactiva-
tion.
Figure 13. Table View of Configuration List Table for Threshold Alarm
For additional information on how to set the values of configuration fields, refer to section Configuration
Field Type List.
SNMPv2-MIB
This MIB provides controller information allowing it to be easily identified as a network device. The
SNMP Discovery feature in most NMS systems uses the data published through the SNMPv2-MIB for
discovering network devices. Refer to RFC 3418, or the MIB file, for a more detailed explanation.
ALARM-MIB
The CXC HP takes advantage of the ALARM-MIB to define the structure and basic behavior of an Alarm
Notification. The following tables from the ALARM-MIB are used:
• Alarm Model
• Alarm Active
• Alarm Clear
This MIB defines the alarm modeling and auditing. The model table provides a list of alarms available on
the controller. The list follows the dynamic nature of the monitored systems and devices, and will add or
remove conceptual rows as alarms come in or out of availability. Refer to RFC 3877, or the MIB file, for a
more detailed explanation on alarm modeling.
Auditing for alarms can be done by looking at the Active Alarms and Cleared Alarms tables. Refer to
RFC3877, or the MIB file, for a more detailed explanation on these tables.
Note: The generic notification definition provided in the ALARM-MIB is not used by the controller.
The ALPHA-NOTIFICATION-MIB provides a more detailed varbind list applicable to power system
monitoring.
Note: For CXC-HP system using UPS-MIB such as FXM-HP, any changes to the alarm status would
send two notifications to the NMS. One notification is defined by ALPHA-NOTIFICATION-MIB, and the
second notification is defined by UPS-MIB. For a more detailed description on the UPS-MIB notification,
refer to RFC1628.
SNMP-TARGET-MIB
The CXC HP provides ten SNMP destinations for the NMS to configure notifications reporting, or
notification subscriptions. Providing IP addresses of the NMS sets the CXC HP to send alarm notifications
to these destinations. Refer to RFC 3413, or the MIB file, for a more detailed explanation.
The current implementation takes advantage of the following set of data for each destination:
• IP Address
• Time Out (for acknowledged notifications)
• Retry Count (for acknowledged notifications)
Configuring an IP address will activate notifications for that target. Entering a time out period greater then
zero (0) will send notifications that require acknowledgment from the NMS to the controller (INFORM).
ALPHA-NOTIFICATION-MIB
This MIB provides two custom-defined notifications for alarm reporting:
• Active Alarm
• Cleared Alarm
The payload of the notification (varbind list) provides all the details of the alarm and can be used for
filtering or monitoring specific alarms.
Note: Both definitions of the notification objects (active and cleared) carry the same varbind list. The
two notifications were defined to allow easier filtering and matching of active and clear notifications on the
NMS.
ALPHA-RESOURCE-MIB
The Alpha Resource MIB is designed with forward compatibility in mind. Using database type table design
and data referencing, the MIB structure will allow dynamic additions of new components and data to
the controller without any changes to the MIB. See the section on SNMP Reference for an SNMP table
indexing overview.
This MIB provides access to the information base of the controller. The major structures defined in the
MIB are:
• DataFields - data fields available from all component sources. Combine the unique index of the
DataFieldType row, along with the assigned ID of the component, to access this information.
• ConfigurationList - configuration fields available from a specific component source.
Configuration fields describe a set of read-write data access. For example, with a DC system and
ten rectifiers, the table would present a list of available configuration types of a DC system and a of
a rectifier.
• ConfigurationFields - configuration fields available from all component sources. Combine the
unique index of the ConfigurationFieldType row, along with the assigned ID of the component, to
access this information.
• CommandFieldType - (Currently not supported. Reserved for future development.)command
field types available from a specific component source. Command fields describe a set of write-
only data access. For example, with a DC system and ten rectifiers, the table would present a list
of available command types of a DC system and of a rectifier.
• CommandFields - (Currently not supported. Reserved for future development.)command fields
available from all component sources. Combine the unique index of the CommandFieldType row,
along with the assigned ID of the component to access this information.
• ConfigurationChoiceList - configuration choices provide lists of string values for the State data
type configuration fields.
ALPHA-RECTIFIER-SYS-MIB
For small systems with a single DC system monitored by the CXC HP, the ALPHA-RECTIFIER-SYS-
MIB provides a flat list of the most common data points used. Refer to the MIB for details of data points
available.
Note: This MIB does not provide any information in the case there are multiple DC Systems
monitored by the CXC HP controller. The ALPHA-RESOURCE-MIB is the source of data for multiple
systems monitoring.
ALPHA-CONVERTER-SYS-MIB
For small systems with a single converter system monitored by the CXC HP, the ALPHA-CONVERTER-
SYS-MIB provides a flat list of the most common data points used. Refer to the MIB for details of data
points available.
Note: This MIB does not provide any information in the case there are multiple converter systems
monitored by the CXC HP controller. The ALPHA-RESOURCE-MIB is the source of data for multiple
systems monitoring.
UPS-MIB
The CXC HP takes advantage of the UPS-MIB to define the structure and basic behavior of an
Uninterrupted Power Supply system. The following tables from the UPS-MIB are supported:
• Device Identification
• Battery
• Input
• Output
• Alarm
• Well Known Alarm
• Traps Notification
The tables provide a list of UPS specific objects available on the controller. Refer to RFC 1628, or the
UPS-MIB file, for a more detailed explanation and specification of the supported objects.
Note: For CXC-HP system using UPS-MIB such as FXM-HP, any changes to the alarm status would
send two notifications to the NMS. One notification is defined by ALPHA-NOTIFICATION-MIB, and the
second notification is defined by UPS-MIB. For a more detailed description on the UPS-MIB notification,
refer to RFC1628.
Flat Tables
Flat tables are the simplest and most commonly used technique of presenting a set of related data. The
word table is not the most accurate way to describe this structure. It is closer to a folder containing a set
of non-iterative data fields.
Data retrieval is a simple GET of the OID of interest. The image below shows a list of fields presented
in the system folder as described by the SNMPv2-MIB. The highlighted field is accessed by using OID:
1.3.6.1.2.1.1.1
Tables
From Figure 2, the highlighted folder at the bottom of the image is a representation of a standard table
with a set of columns and dynamic range of conceptual rows. Just like a flat table, each column has an
OID to get access to the represented data. The additional variable are the possibility of multiple instances
of rows that the table can have.
The highlighted folder, called the TableEntry, represents a conceptual row or instance of the row with the
fields within the folder as columns of the table.
Data access of the column within a particular row will need to contain the combination of the Entry OID,
column index and row index. For example, to access the name of the data held in the third row of the
table, the OID combination is as follows:
(Entry OID) 1.3.6.1.4.1.7309.5.1.100.1 + (Column Index) 2 + (Row Index) 3
Augmented Tables
Augmented tables describe the relationship between two or more tables whose conceptual rows have
a one to one relationship with each other. A row in one table directly extends a row in another table and
uses the same row index.
Note: The order of the indexes must match the order described in the defining MIB. The use of
multiple external, and/or internal indexes, follows the general pattern of database tables using private and
foreign keys.
Figure 14 shows three tables from the Alpha Resource MIB that have index dependencies. The
dataTable has dependencies from the componentListTable and from the dataListTable as described in
its properties, which is shown in Figure 15.
Access of information available in the dataTable would use the following index calculation:
(dataEntry OID) 1.3.6.1.4.1.7309.5.2.3.2.1 + (dataListReference) + (componentListReference)
• 1. controllerInfoTableIndex
• 2. controllerInfoTableName
• 3. controllerInfoTableStringValue
• 4. controllerInfoTableUnit
• 5. controllerInfoTableNumberValue
5 Technical Support Contact Number Phone number to call for technical support.
To access the desired data, add the column id and the row index to the end of the base OID of the table:
Base OID (1.3.6.1.4.1.7309.5.1.100.1) + Column ID (2) + Row ID (4)
1.3.6.1.4.1.7309.5.1.100.1.2.4 = "Controller: Site Number"
• Configuration Table
The tables only update during idle periods. After the last component change, an idle period of 1-minute
must occur before an update starts. Adding or removing any component resets the 1-minute idle timer.
The most effective way to view the data is in table format. The use of table format is dependent on the
software being used.
Column
Name Description
Number
1. Controller
2. DC System
3. ADIO
4. Rectifier
5. Converter
6. Inverter
7. Reserved
8. T2S
9. Reserved
Column
Name Description
Number
11. Disconnect
12. Load
13. Shunt
23. Up Counter
27. Breaker/Fuse
28. Reserved
38. Reserved
Column
Name Description
Number
39. Reserved
45. Reserved
46. Reserved
47. Reserved
53. DC Source
57. AC Source
64. Reserved
Column
Name Description
Number
1 dataListReference (IDX) Static ID value assigned to the field type and is unique
within the component that the field belongs to.
• 0. Unknown
• 1. Numeric
Data List
The Data List table displays all available live data that the CXC HP controller can report. The data points
and referencing are presented in logical groupings.
For example, to get the live data of the Total Output Current of a DC system. Use the dataFieldType
index and the componentList index to specifically call for an entry in the dataList table.
In the dataFieldType table:
Combine the dataFieldType index (2.1), and the DC system instance number (1), and you can get the
index of 2.1.1 which is the reference for the Output Current from DC system 1.
1.3.6.1.4.1.7309.5.2.3.2.1.(1).2.1.1 - the index of the row displaying 2.1.1 for convenient referencing.
Figure 17 shows the list of data field types available from the CXC HP controller and indicates the
System Voltage as row 2.10.
Access to the actual System Voltage combines the base OID of the DataEntry (row) of the DataTable,
the column index of the table, and the instance index value. The instance index is a combination of the
dataListReference value (2.10) and the componentListReference (1).
1.3.6.1.4.1.7309.5.2.3.2.1 (dataEntry OID) + 2 (dataNumberValue) + 2.10 (dataListReference) + 1
(componentListReference)
The DataTable output shows a list of live data available on the CXC HP controller. The row with reference
2.10.1, as high lighted in Figure 18, shows the System Voltage value.
Figure 19 shows a simple query of the full OID value, specific to the System Voltage of a rectifier system.
• 0. Unknown
• 1. Numeric
• 2. Boolean
• 3. Time
• 4. String - Human readable text data.
• 5. State - state represents a string value de-
scribing the condition the reference object is
in. For example, a DC System’s Voltage Regu-
lation field may have the value: Disabled.A list
of state values for each configuration field of
data type 5 is available in the Configuration
Choice List Table.
The following table shows the list of Configuration field types available from the CXC HP controller and
indicates the Float Voltage as row 2.12.
Access to the actual Float Voltage combines the base OID of the DataEntry (row) of the
ConfigurationTable, the column index of the table, and the instance index value. The instance index is a
combination of the configurationListReference value (2.12) and the componentListReference (1).
1.3.6.1.4.1.7309.5.2.5.2.1 (configurationEntry OID) + 2 (configurationNumberValue) + 2.12
(configurationListReference) + 1 (componentListReference). The complete OID for Float Voltage is
1.3.6.1.4.1.7309.5.2.5.2.1.2.2.12.1
The Configuration Table output shows a list of data available for set request on the CXC HP controller.
The row with reference 2.12.1, as highlighted in the above figure shows the Float Voltage value.
The above figure shows a simple set query of the full OID value, specific to the Float Voltage of a rectifier
system. The Value to Set is scaled by a 100. 5400 represents 54.00 volts.
The following table shows the list of Configuration field types available from the CXC HP controller for a
DC system. Note that the configurationListRefenence for all configuration fields of a DC System has a
prefix of 2. The Rectifier Assignment Rule is row 2.10.
Access to the actual Rectifier Assignment Rule field combines the base OID of the ConfigurationEntry
(row) of the ConfigurationTable, the column index of the table, and the instance index value. The instance
index is a combination of the configurationListReference value (2.12) and the componentListReference
(1).
1.3.6.1.4.1.7309.5.2.5.2.1 (configurationEntry OID) + 2 (configurationNumberValue) + 2.10
(configurationListReference) + 1 (componentListReference). The complete OID for Rectifier Assignment
Rule is 1.3.6.1.4.1.7309.5.2.5.2.1.2.2.10.1
The Configuration Table output shows a list of data available for set request on the CXC HP controller.
The row with reference 2.10.1, as highlighted in the above figure shows the Rectifier Assignment Rule
value.
The above figure shows a simple set query of the full OID value, specific to the Rectifier Assignment
Rule of a DC system. The Value to Set is changed to RectifierAssignmentManual.
The valid values of Value to Set for Rectifier Assignment Rule of a DC system are
RectifierAssignmentManual and RectifierAssignmentAutomatic. These two values are defined in the
configurationChoiceListTable.
The column numbers for the Configuration Choice List table are as follows:
3 configurationChoiceListName Static name for the choice to be used for setting con-
figuration fields with configurationListType = 5. This
text value is not translated for localization
The example provided shows a table that is simplified in data presentation to allow for efficient polling of
alarms. Using the base entry OID of the alarmState, together with the instance index, you can actively
poll an individual alarm. In this example, an active alarm is polled and then interpreted in the following
manner:
1.3.6.1.4.1.7309.5.2.9.2.1.1 (alarm table entry OID) + 1.10003 (alarm type) + 1 (instance Index) =
1.3.6.1.4.1.7309.5.2.9.2.1.1.1.10003.1 (OID for ADIO: Comms Lost alarm).
The value returned from a GET REQUEST is 4000. It is a scaled integer value presenting the number 4
for Major priority level. The 0 value represents a normal or inactive state.
In most cases, the instance index will be a value of 1 unless there are multiple instances of that alarm.
The instance is a reference to the instance of the component alarm source.
Note: Some of the field names may repeat due to field items that are in repeated groups. Their
indexes would remain unique to identify the individual fields. For example, AC Input Phase fields would
have repeating items.
Site Number 4
Contact Name 6
Contact Number 7
Street 9
City 10
Zip/Postal Code 11
Region/State/Province 12
Country 13
Latitude 14
Table 13. Controller Fields SNMP IDs (Component Type #1) (continued)
Longitude 15
Altitude 16
Serial Number 17
Part Number 18
Table 13. Controller Fields SNMP IDs (Component Type #1) (continued)
Table 14. DC System Fields SNMP IDs (Component Type #2) (continued)
System Voltage 10
Battery Voltage 12
Battery Current 13
Battery Temperature 14
System Number 15
Average Power 24
Modules In Standby 26
Table 14. DC System Fields SNMP IDs (Component Type #2) (continued)
Bay ID 1
Shelf ID 2
Slot ID 3
AC Input Voltage 4
Output Current 5
Ambient Temperature 6
Operating Time 7
Mode 8
Output Current 1
Input Current 2
Intake Temperature 3
Operating Hours 4
Current 1
Table 18. CAN Bus Fields SNMP IDs (Component Type #15)
Number of Devices 1
Table 19. Converter System Fields SNMP IDs (Component Type #16)
System Voltage 7
System Number 9
Table 20. Inverter System Fields SNMP IDs (Component Type #19)
DC Input 3
System Mode 4
DC Input Current 11
DC Input Voltage 12
DC Input Power 13
System On Bypass 14
Table 20. Inverter System Fields SNMP IDs (Component Type #19) (continued)
AC Input Power 15
# Communicating Inverters 30
# Failed Inverters 31
# T2S 39
Number Of Phases 50
Phase 1
Table 20. Inverter System Fields SNMP IDs (Component Type #19) (continued)
Phase 2
Phase 3
Table 20. Inverter System Fields SNMP IDs (Component Type #19) (continued)
AC Input Group 1
AC Input Group 2
Table 20. Inverter System Fields SNMP IDs (Component Type #19) (continued)
AC Input Group 3
DC Input Group 1
DC Input Group 2
DC Input Group 3
Table 20. Inverter System Fields SNMP IDs (Component Type #19) (continued)
DC Input Group 4
Table 21. Bypass Switch Fields SNMP IDs (Component Type #20)
Status 1
Table 22. Delay Timer Fields SNMP IDs (Component Type #21)
Output 1
Trigger 3
Reset 5
Table 23. Interval Timer Fields SNMP IDs (Component Type #22)
Output 1
Start Event 2
Stop Event 4
Input 1
Output 2
Reset Input 3
Terminal Reached 4
Table 25. Down Counter Fields SNMP IDs (Component Type #24)
Input 1
Output 2
Initialize Input 3
Counter at Zero 4
Table 26. Custom Data Fields SNMP IDs (Component Type #25)
Equation 1
Error Position 3
Error Token 4
Expected Token 5
Result as numeric 6
Result as boolean 7
Current 1
Table 28. Breaker or Fuse Fields SNMP IDs (Component Type #27)
State 1
Table 29. Line Power System Fields SNMP IDs (Component Type #31)
Modules 2
Maximum Temperature 6
Loads 7
Channels 8
System Number 9
Table 30. LPS Module Fields SNMP IDs (Component Type #32)
Temperature 1
Input Voltage 2
Bay ID 3
Shelf ID 4
Slot ID 5
Table 30. LPS Module Fields SNMP IDs (Component Type #32) (continued)
Channels 1
Channels Enabled 2
Current Capacity 6
Power Capacity 7
D1 40101
D2 40201
D3 40301
D4 40401
D5 40501
D6 40601
D7 40701
D8 40801
K1 50101
K2 50201
K3 50301
Table 32. 8R8D Fields SNMP IDs (Component Type #3) (continued)
K4 50401
K5 50501
K6 50601
K7 50701
K8 50801
V1 10101
V2 10201
V3 10301
V4 10401
I1 20101
I2 20201
I3 20301
I4 20401
T1 30101
T2 30201
T3 30301
T4 30401
D1 40101
D2 40201
D3 40301
D4 40401
D5 40501
D6 40601
D7 40701
D8 40801
K1 50101
Table 33. L-ADIO Fields SNMP IDs (Component Type #3) (continued)
K2 50201
K3 50301
K4 50401
K5 50501
K6 50601
K7 50701
K8 50801
K9 50901
K10 51001
K11 51101
K12 51201
V1 10101
V2 10201
I1 20101
T1 30101
T2 30201
D1 40101
D2 40201
K1 50101
K2 50201
K3 50301
K4 50401
V1 10101
Table 35. M1+ Fields SNMP IDs (Component Type #3) (continued)
V2 10201
I1 20101
T1 30101
T2 30201
D1 40101
D2 40201
D3 40301
D4 40401
D5 40501
D6 40601
K1 50101
K2 50201
K3 50301
K4 50401
K5 50501
K6 50601
K7 50701
V1 10101
V2 10201
I1 20101
T1 30101
T2 30201
D1 40101
D2 40201
K1 50101
K2 50201
Table 36. PSU Fields SNMP IDs (Component Type #3) (continued)
K3 50301
K4 50401
K5 50501
V1 10101
V2 10201
I1 20101
T1 30101
T2 30201
D1 40101
D2 40201
D3 40301
D4 40401
K1 50101
K2 50201
K3 50301
K4 50401
K5 50501
K6 50601
DCCT1 60101
DCCT2 60201
V1 10101
V2 10201
Table 38. BDFBi Fields SNMP IDs (Component Type #3) (continued)
V3 10301
V4 10401
V5 10501
V6 10601
V7 10701
V8 10801
I1 20101
I2 20201
I3 20301
I4 20401
I5 20501
I6 20601
I7 20701
I8 20801
T1 30101
T2 30201
D1 40101
D2 40201
D3 40301
D4 40401
D5 40501
D6 40601
D7 40701
D8 40801
I1 in Amps 60101
I2 in Amps 60201
I3 in Amps 60301
I4 in Amps 60401
I5 in Amps 60501
Table 38. BDFBi Fields SNMP IDs (Component Type #3) (continued)
I6 in Amps 60601
I7 in Amps 60701
I8 in Amps 60801
V1 10101
V2 10201
I1 20101
I2 20201
T1 30101
T2 30201
D1 40101
D2 40201
D3 40301
D4 40401
D5 40501
D6 40601
D7 40701
D8 40801
D9 40901
D10 41001
D11 41101
D12 41201
D13 41301
D14 41401
D15 41501
D16 41601
D17 41701
Table 39. Smart E2 Fields SNMP IDs (Component Type #3) (continued)
D18 41801
D19 41901
D20 42001
D21 42101
D22 42201
I1 in Amps 60101
I2 in Amps 60201
D1 40101
I1 20101
I2 20201
I3 20301
I4 20401
I5 20501
I6 20601
I7 20701
I8 20801
I9 20901
I10 21001
I11 21101
I12 21201
I13 21301
I14 21401
I15 21501
Table 41. ShuntMux Fields SNMP IDs (Component Type #3) (continued)
I16 21601
I1 20101
I2 20201
I3 20301
I4 20401
I5 20501
I6 20601
Table 43. Flex Air Controller Fields SNMP IDs (Component Type #3)
V1 10101
T1 30101
T2 30201
T3 30301
T4 30401
T5 30501
K1 50101
K2 50201
Fan 1 100101
Fan 2 100201
Fan 3 100301
Fan 4 100401
Fan 5 100501
Fan 6 100601
Fan 7 100701
Fan 8 100801
Table 44. Distribution System Fields SNMP IDs (Component Type #34)
Voltage 1
Current 2
Breaker Trips 3
Maximum Temperature 4
Active Alarms 5
Table 45. Distribution Panel Fields SNMP IDs (Component Type #35)
Voltage 1
Current 2
Active Alarms 3
Table 46. Distribution Subsystem Fields SNMP IDs (Component Type #36)
Voltage 1
Current 2
Breaker Trips 3
Maximum Temperature 4
Active Alarms 5
Table 47. Scheduled Action Fields SNMP IDs (Component Type #40)
Recurrence 1
End 2
Schedule Status 3
Last Run 4
Table 47. Scheduled Action Fields SNMP IDs (Component Type #40) (continued)
Action 7
Table 48. FXM-HP System Fields SNMP IDs (Component Type #41)
Operating Frequency 1
Nominal AC Voltage 2
AC Output Voltage 5
AC Output Frequency 6
AC Output Current 7
Battery Voltage 9
Battery Current 10
Battery Temperature 11
System Mode 13
Energy Delivered 20
Table 49. Change Relay Fields SNMP IDs (Component Type #43)
Condition Value 1
Relay Status 2
Table 49. Change Relay Fields SNMP IDs (Component Type #43) (continued)
Table 50. Change Field Fields SNMP IDs (Component Type #44)
Condition Value 1
Field Value 2
Table 51. General Purpose Transducer Fields SNMP IDs (Component Type #48)
Calculated Value 1
Table 52. Change Field To Variable Fields SNMP IDs (Component Type #49)
Field Value 2
Field Range 3
Voltage 1
Current 2
Power 3
Active Temperature 4
Minimum Temperature 5
Average Temperature 6
Maximum Temperature 7
Battery Mode 8
Charging 9
Time Remaining in EQ 10
Time Remaining in BT 12
Battery Temperature 13
Peukert Exponent 15
Conditioning Mode 21
Voltage 1
Current 2
Power 3
Minimum Temperature 4
Average Temperature 5
Maximum Temperature 6
Active Temperature 7
Midpoint Voltage 8
Breaker/Fuse 9
Average Voltage 1
Total Current 2
Voltage 1
Current 2
Breaker/Fuse Status 3
Number of Phases 1
Phase 1 Voltage 2
Phase 2 Voltage 3
Phase 3 Voltage 4
Bay ID 1
Shelf ID 2
Slot ID 3
Bay ID 1
Shelf ID 2
Slot ID 3
Bay ID 1
Shelf ID 2
Slot ID 3
DC Output Current 4
DC Output Voltage 5
DC Output Power 6
DC Output Mode 7
Operating Time 9
Table 62. Touch Safe Module Fields (Component Type #65) (continued)
DC Energy Delivered 10
Firmware Event 11
Number Of Alerts 12
Note: Some of the field names may repeat due to field items that are in repeated groups. Their
indexes would remain unique to identify the individual fields. For example, AC Input Phase fields would
have repeating items.
Name 1
Description 2
Site Number 10
Contact Name 12
Contact Number 13
Street 14
City 15
Zip/Postal Code 16
Region/State/Province 17
Country 18
Table 63. Controller Fields SNMP IDs (Component Type #1) (continued)
Latitude 19
Longitude 20
Altitude 21
Time Zone 22
Speaker Enable 29
Name Customization 33
LCD Timeout 37
Table 63. Controller Fields SNMP IDs (Component Type #1) (continued)
USB Port 56
Modbus Agent 80
Name 1
Description 2
System Number 3
Table 64. DC System Fields SNMP IDs (Component Type #2) (continued)
Loadsharing Enable 24
Name 1
Description 2
Rectifier Phase 10
Name 1
Description 2
Name 1
Description 2
Hysteresis Override 13
Equalize Duration 14
Equalize Voltage 15
Boost Duration 16
Boost Voltage 17
Load Model 35
Name 1
Description 2
Disconnect Enable 10
Disconnect Threshold 11
Connect Threshold 12
Name 1
Description 2
Name 1
Description 2
Range in Amps 10
Range in Millivolts 11
Offset 12
Table 72. SNMP Destination Fields SNMP IDs (Component Type #14)
Name 1
Description 2
Destination Enable 10
IP Address 11
Community 12
Port 13
Notification Timeout 14
Notification Retries 15
Table 73. CAN Bus Fields SNMP IDs (Component Type #15)
Name 1
Description 2
Bus Enable 10
Table 74. Converter System Fields SNMP IDs (Component Type #16)
Name 1
Description 2
System Number 3
Assignment Rule 10
Table 75. Digital User Alarm Fields SNMP IDs (Component Type #17)
Name 1
Description 2
Table 76. Threshold User Alarm Fields SNMP IDs (Component Type #18)
Name 1
Description 2
Table 77. Inverter System Fields SNMP IDs (Component Type #19)
Name 1
Description 2
System Number 3
Assignment Rule 10
Commissioning Method 11
Desired DC Input 14
Table 78. Bypass Switch Fields SNMP IDs (Component Type #20)
Name 1
Table 78. Bypass Switch Fields SNMP IDs (Component Type #20) (continued)
Description 2
Table 79. Delay Timer Fields SNMP IDs (Component Type #21)
Name 1
Description 2
Delay 10
Auto Reset 11
Retriggerable 13
Table 80. Interval Timer Fields SNMP IDs (Component Type #22)
Name 1
Description 2
Name 1
Description 2
Terminal Value 3
Table 82. Down Counter Fields SNMP IDs (Component Type #24)
Name 1
Description 2
Initial Value 3
Table 83. Custom Data Fields SNMP IDs (Component Type #25)
Name 1
Description 2
Equation 10
Name 1
Description 2
Range In Amp 10
Range In Volt 11
Offset 12
Table 85. Breaker Fuse Fields SNMP IDs (Component Type #27)
Name 1
Description 2
Usage 10
Size 11
AWG 12
Destination 13
Table 86. Email Destination Fields SNMP IDs (Component Type #29)
Name 1
Description 2
From Address 10
To Address 11
Send Interval 12
Table 87. Auxiliary System Fields SNMP IDs (Component Type #30)
Name 1
Description 2
Table 88. Line Power System Fields SNMP IDs (Component Type #31)
Name 1
Description 2
System Number 3
Assignment Rule 10
Name 1
Description 2
Table 90. Distribution System Fields SNMP IDs (Component Type #34)
Name 1
Description 2
System Number 3
Table 91. Distribution Panel Fields SNMP IDs (Component Type #35)
Name 1
Description 2
Fuse Number 10
Fuse Size 11
Table 92. Distribution Subsystem Fields SNMP IDs (Component Type #36)
Name 1
Description 2
Serial Number 4
Table 93. Reference Load Fields SNMP IDs (Component Type #37)
Name 1
Description 2
Table 94. Scheduled Action Fields SNMP IDs (Component Type #40)
Name 1
Description 2
Name 1
Description 2
System Number 3
AC Input Sense 13
Green LED 18
Table 95. FXM-HP System SNMP IDs (Component Type #41) (continued)
Table 96. Disconnect With Time of Day Fields SNMP IDs (Component Type #42)
Name 1
Description 2
Disconnect Enable 10
Delay 11
Table 97. Change Relay Fields SNMP IDs (Component Type #43)
Name 1
Description 2
Table 98. Change Field Fields SNMP IDs (Component Type #44)
Name 1
Description 2
Table 99. General Purpose Transducer Fields SNMP IDs (Component Type #48)
Name 1
Description 2
Table 99. General Purpose Transducer Fields SNMP IDs (Component Type #48) (continued)
Output Offset 14
Table 100. Change Field To Variable Fields SNMP IDs (Component Type #49)
Name 1
Description 2
Table 101. Battery String Fields SNMP IDs (Component Type #50)
Name 1
Description 2
Capacity Rating 10
Peukert Exponent 12
Table 102. Timing Relay Fields SNMP IDs (Component Type #51)
Name 1
Description 2
Relay Enable 10
Name 1
Description 2
Name 1
Description 2
Minimum Runtime 13
Maximum Runtime 14
Name 1
Description 2
IP Address 10
Table 106. Generic Disconnect Fields SNMP IDs (Component Type #55)
Name 1
Description 2
Disconnect Enable 10
Table 106. Generic Disconnect Fields SNMP IDs (Component Type #55) (continued)
Name 1
Description 2
Name 1
Description 2
Minimum Runtime 13
Maximum Runtime 14
Name 1
Description 2
Name 1
Description 2
Days to Run 10
Start Time 11
End Time 12
Name 1
Description 2
SNMPv2
In addition to the PDUs (Protocol Data Unit) supported by SNMPv1, SNMPv2 supports two additional
PDUs: GETBULK request and INFORM request.
A description can be found in RFC 1901.
Four variations of SNMPv2 were defined to handle different security:
Contains the agent address Does not contain the agent address
Has information about the specific TRAP and generic Has the TRAP OID in the second varbind
TRAP information
Does not have an error index and status Has an error index and status
Does not support confirmed / acknowledged TRAPs Supports confirmed / acknowledged NOTIFICATIONs
Another difference in an SNMPv1 NMS, is the way it performs a MIB WALK. When doing a WALK with an
SNMPv1 NMS tool, it is necessary to filter out empty values that show up in a sparsely populated area of
a MIB.
SNMPv3
SNMPv3 was developed to significantly improve security. SNMPv3 includes a requirement to login or
authenticate, as well as an encryption scheme for authentication and data transfer. A description can be
found in RFC 3410 to 3417.