NAFEM-UTILITYMANAGEMENT-MIB DEFINITIONS ::= BEGIN. -- From file: "utility-management.mib" IMPORTS

Size: px

Start display at page:

Download "NAFEM-UTILITYMANAGEMENT-MIB DEFINITIONS ::= BEGIN. -- From file: "utility-management.mib" IMPORTS"

Penelope Alexander
6 years ago
Views:

1 NAFEM-UTILITYMANAGEMENT-MIB DEFINITIONS ::= BEGIN From file: "utility-management.mib" IMPORTS OBJECT-TYPE IpAddress NafemDateTime, DisplayString, NafemChoice, NafemInterval, NafemAlarmStatus utilitymgmtgroup, utilitymgmtinstance, utilitymgmtcfg, utilitymgmtdata, utilitymgmtalarm, utilitymgmtlog, utilitymgmtloghist, utilitynotify FROM RFC-1212 FROM RFC1065-SMI FROM NAFEM-TC-MIB FROM NAFEM-REG-MIB; nafemutilmgmtmodule MODULE-IDENTITY LAST-UPDATED " " ORGANIZATION "NAFEM" ORGANIZATION "NAFEM" CONTACT-INFO " Contact: NAFEM Technical Liaison Committee Postal: North American Association of Food Equipment Manufacturers (NAFEM) 161 North Clark Street, Suite 2020 Chicago IL Phone: Fax: Web: " DESCRIPTION " The Utility Management Object Group module. Copyright (c) 2003 North American Association of Food Equipment Manufacturers (NAFEM). 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 NAFEM's proprietary intellectual property. NAFEM retains all title and ownership in the Specification, including any revisions. NAFEM grants all interested parties a non-exclusive license to use and distribute an unmodified copy of this Specification in connection with management of products that incorporate the NAFEM Communications Protocol, and without fee, provided this copyright notice and license appear on all copies. This Specification is supplied 'AS IS' and NAFEM makes not warranty, either expressed or implied, as to the use, operation, condition, or performance of the Specification. " 1

2 REVISION " 2.00 " DESCRIPTION " Updated version of MIB module NAFEM-UTILITYMANAGEMENT-MIB " begin definitions Utility Management CONFIGURATION Table utilitymgmtcfgtable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityMgmtCfgEntry DESCRIPTION " Table of utility systems within the hosted equipment that need to be monitored under utility management practices. Systems that have multiple utility types will have more than one entry in this table. " ::= { utilitymgmtcfg 1 utilitymgmtcfgentry OBJECT-TYPE SYNTAX UtilityMgmtCfgEntry DESCRIPTION " A utility type entry. " INDEX { utilitymgmtcfgentryindex ::= { utilitymgmtcfgtable 1 UtilityMgmtCfgEntry ::= SEQUENCE { UtilityMgmtCfgEntryIndex utilitymgmtcfgname utilitymgmtcfgtype utilitymgmtcfgdesc utilitymgmtcfgratedvalue utilitymgmtcfgunits DisplayString, DisplayString, INTEGER utilitymgmtcfgentryindex OBJECT-TYPE DESCRIPTION " Utility type sequence number to index within the table of configurations. " ::= { utilitymgmtcfgentry 1 utilitymgmtcfgname OBJECT-TYPE SYNTAX DisplayString (SIZE (0..32)) DESCRIPTION " A user/supplier textual description of the utility type. " ::= { utilitymgmtcfgentry 2 2

3 utilitymgmtcfgtype OBJECT-TYPE { not-available (1), gas (2), electricity (3), water (4), steam (5), compressed-gas (6), refrigerant (7), other (8) DESCRIPTION " A standardized utility descriptor. " ::= { utilitymgmtcfgentry 3 utilitymgmtcfgdesc OBJECT-TYPE SYNTAX DisplayString (SIZE (0..255)) DESCRIPTION " Textual description of utility type to communicate to the user the actual application or importance of this attribute. " ::= { utilitymgmtcfgentry 4 utilitymgmtcfgratedvalue OBJECT-TYPE DESCRIPTION " The manufacturer's rating of this utility based on name plate entry. " ::= { utilitymgmtcfgentry 5 utilitymgmtcfgunits OBJECT-TYPE enumerated parameters in NAFEM approved units DESCRIPTION " A standardized engineering units descriptor. " ::= { utilitymgmtcfgentry 6 Utility Management DATA Table utilitymgmtdatatable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityMgmtDataEntry DESCRIPTION " Table of utility current values within the hosted equipment that shall be monitored under utility management practices. Systems that have multiple utility types will have more than one entry in this table. " ::= { utilitymgmtdata 1 utilitymgmtdataentry OBJECT-TYPE SYNTAX UtilityMgmtDataEntry DESCRIPTION " An entry in the table of utility data properties for each utility type. " INDEX { utilitymgmtdataentryindex ::= { utilitymgmtdatatable 1 3

4 UtilityMgmtDataEntry ::= SEQUENCE { utilitymgmtdataentryindex utilitymgmtdatavalue utilitymgmtdatastatus utilitymgmtdatatimestamp NafemAlarmStatus, NafemDateTime utilitymgmtdataentryindex OBJECT-TYPE DESCRIPTION " Utility type sequence number to index within the table of utility types. " ::= { utilitymgmtdataentry 1 utilitymgmtdatavalue OBJECT-TYPE DESCRIPTION " Utility measured value expressed in utilitymgmtcfgunits. " ::= { utilitymgmtdataentry 2 utilitymgmtdatastatus OBJECT-TYPE SYNTAX NafemAlarmStatus DESCRIPTION " The status of a data object. " ::= { utilitymgmtdataentry 3 utilitymgmtdatatimestamp OBJECT-TYPE SYNTAX NafemDateTime DESCRIPTION " A time stamp when the data object was last updated. " ::= { utilitymgmtdataentry 4 Utility Management ALARM Table utilitymgmtalarmtable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityMgmtAlarmEntry DESCRIPTION " Table of utility alarm configuration and status attributes within the hosted equipment. Systems that have multiple utility types will have more than one entry in this table. Corresponding utility configuration information can be cross-reference by the INDEX field value in associated object tables. " ::= { utilitymgmtalarm 1 utilitymgmtalarmentry OBJECT-TYPE SYNTAX UtilityMgmtAlarmEntry DESCRIPTION " An entry in the table of history data for each utility type logged. " INDEX { utilitymgmtalarmentryindex ::= { utilitymgmtalarmtable 1 4

5 UtilityMgmtAlarmEntry ::= SEQUENCE { utilitymgmtalarmentryindex utilitymgmtalarmcritlimithigh utilitymgmtalarmcritlimitlow utilitymgmtalarmwarnlimithigh utilitymgmtalarmwarnlimitlow utilitymgmtalarmdeviation utilitymgmtalarmclear utilitymgmtalarmbypass NafemChoice, NafemChoice utilitymgmtalarmentryindex OBJECT-TYPE DESCRIPTION " Alarm sequence number to index within the table of utility types. " ::= { utilitymgmtalarmentry 1 utilitymgmtalarmcritlimithigh OBJECT-TYPE DESCRIPTION " The value of monitored attribute at which an notification trap is triggered. Either equal to or greater than. " ::= { utilitymgmtalarmentry 2 utilitymgmtalarmcritlimitlow OBJECT-TYPE DESCRIPTION " The value of monitored attribute at which an notification trap is triggered. Either equal to or less than. " ::= { utilitymgmtalarmentry 3 utilitymgmtalarmwarnlimithigh OBJECT-TYPE DESCRIPTION " The value of monitored attribute at which an notification trap is triggered. Either equal to or greater than. " ::= { utilitymgmtalarmentry 4 utilitymgmtalarmwarnlimitlow OBJECT-TYPE DESCRIPTION " The value of monitored attribute at which an notification trap is triggered. Either equal to or less than. " ::= { utilitymgmtalarmentry 5 utilitymgmtalarmdeviation OBJECT-TYPE DESCRIPTION " The change between consecutive readings in monitored attribute at which an alarm event is triggered. " ::= { utilitymgmtalarmentry 6 5

6 utilitymgmtalarmclear OBJECT-TYPE SYNTAX NafemChoice DESCRIPTION " Setting this attribute to 2 will signal the device to CLEAR the alarm status. If the alarm condition exists the reset attempt will have no effect, or else the status will be no alarm. " ::= { utilitymgmtalarmentry 7 utilitymgmtalarmbypass OBJECT-TYPE SYNTAX NafemChoice DESCRIPTION " Setting this attribute to 2 will signal the device to enable disable the alarm. Setting this value to 1 will enable the alarm. " ::= { utilitymgmtalarmentry 8 Utility Management LOG Table utilitymgmtlogtable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityMgmtLogEntry DESCRIPTION " Table of utility log configuration attribute within the hosted equipment that shall be logged under utility management practices. Systems that have multiple utility types will have more than one entry in this table. Corresponding utility configuration information can be cross-referenced by the NAME field value in associated object tables. " ::= { utilitymgmtlog 1 utilitymgmtlogentry OBJECT-TYPE SYNTAX UtilityMgmtLogEntry DESCRIPTION " Entry into the utility management log. " INDEX { utilitymgmtlogentryindex ::= { utilitymgmtlogtable 1 UtilityMgmtLogEntry ::= SEQUENCE { UtilityMgmtLogEntryIndex utilitymgmtlogname DisplayString, utilitymgmtlogenable NafemChoice, utilitymgmtloginterval NafemInterval, utilitymgmtlogdeviation utilitymgmtlogforcedinterval NafemInterval, utilitymgmtlogmaxholddays utilitymgmtloghistory OBJECT IDENTIFIER utilitymgmtlogentryindex OBJECT-TYPE DESCRIPTION " Log sequence number to index within the table of initialized devices. " ::= { utilitymgmtlogentry 1 6

7 utilitymgmtlogname OBJECT-TYPE SYNTAX DisplayString (SIZE (0..32)) DESCRIPTION " A textual name of the utility item from the configuration table." ::= { utilitymgmtlogentry 2 utilitymgmtlogenable OBJECT-TYPE SYNTAX NafemChoice DESCRIPTION " YES enables history table activation. " ::= { utilitymgmtlogentry 3 utilitymgmtloginterval OBJECT-TYPE SYNTAX NafemInterval DESCRIPTION " The minimum time in NafemInterval values that a value attribute shall be logged in to the history table. " ::= { utilitymgmtlogentry 4 utilitymgmtlogdeviation OBJECT-TYPE DESCRIPTION " The amount of change between consecutive monitoring events that would log a record to the history table. " ::= { utilitymgmtlogentry 5 utilitymgmtlogforcedinterval OBJECT-TYPE SYNTAX NafemInterval DESCRIPTION " The minimum time in NafemInterval Values that a value attribute must be forced to log to a history record. " ::= { utilitymgmtlogentry 6 utilitymgmtlogmaxholddays OBJECT-TYPE DESCRIPTION " The number of days that the logged history records are kept in memory before they can be over written by subsequent record logs. " ::= { utilitymgmtlogentry 7 utilitymgmtloghistory OBJECT-TYPE SYNTAX OBJECT IDENTIFIER DESCRIPTION " Oid for the utilitymgmtloghisttable sub-table. " ::= { utilitymgmtlogentry 8 utilitymgmtloghist OBJECT IDENTIFIER ::= {utilitymgmtlogentry 7 7

8 utilitymgmtloghisttable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityMgmtLogHistEntry DESCRIPTION " Table of utility history log records within the hosted equipment that shall be logged under utility management practices. Systems that have multiple recording events will have more than one entry in this table. " ::= { utilitymgmtloghist 1 utilitymgmtloghistentry OBJECT-TYPE SYNTAX UtilityMgmtLogHistEntry DESCRIPTION "An entry in the table of history properties for each utility type logged. " INDEX { utilitymgmtloghistentryindex ::= { utilitymgmtloghisttable 1 UtilityMgmtLogHistEntry ::= SEQUENCE { utilitymgmtloghistentryindex utilitymgmtloghistvalue utilitymgmtloghisttimestamp NafemDateTime utilitymgmtloghistentryindex OBJECT-TYPE DESCRIPTION " The index into the utilitymgmtloghisttable. " ::= { utilitymgmtloghistentry 1 utilitymgmtloghistvalue OBJECT-TYPE DESCRIPTION " The value of the associated attribute defined by the NAME field that is recorded due to a triggered log event. " ::= { utilitymgmtloghistentry 2 utilitymgmtloghisttimestamp OBJECT-TYPE SYNTAX NafemDateTime DESCRIPTION " The date and time that the value of the associated attribute defined by the NAME field was recorded due to a triggered log event. " ::= { utilitymgmtloghistentry 3 utilitynotifytable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityNotifyEntry DESCRIPTION " " ::= {utilitynotify 1 8

9 utilitynotifyentry OBJECT-TYPE SYNTAX UtilityNotifyEntry DESCRIPTION " " INDEX { utilitynotifytableindex ::= {utilitynotifytable 1 UtilityNotifyEntry ::= SEQUENCE { utilitynotifytableindex utilitynotifymessage DisplayString, utilitynotifycode utilitynotifytimestamp NafemDateTime, utilitynotifyenable NafemChoice utilitynotifytableindex OBJECT-TYPE DESCRIPTION " A textual description of the notify message Index for the rows of utilitynotifytable. " ::= { utilitynotifyentry 1 utilitynotifymessage OBJECT-TYPE SYNTAX DisplayString (SIZE (0..32)) DESCRIPTION " A textual description of the notify message. " ::= { utilitynotifyentry 2 utilitynotifycode OBJECT-TYPE NafemNotifyCode DESCRIPTION " A Code description of the notify message. " ::= {utilitynotifyentry 3 utilitynotifytimestamp OBJECT-TYPE SYNTAX NafemDateTime read-only DESCRIPTION " The date and time at which an event occurred. " ::= { utilitynotifyentry 4 utilitynotifyenable OBJECT-TYPE SYNTAX NafemChoice DESCRIPTION " 1 = No trap generation, 2 = Enable trap generation, Reference current NAFEM textual convention. " ::= { utilitynotifyentry 5 9

10 utilitynotifyacktable OBJECT-TYPE SYNTAX SEQUENCE OF UtilityNotifyAckEntry DESCRIPTION " Table of associated acknowledgement feature attribute to the notification message. This table is used when the system requires a response from a manager when a trap is sent. " ::= {utilitynotify 2 utilitynotifyackentry OBJECT-TYPE SYNTAX UtilityNotifyAckEntry DESCRIPTION " Entry in acknowledgement table. " INDEX { utilitynotifyacktableindex ::= {utilitynotifyacktable 1 UtilityNotifyAckEntry ::= SEQUENCE { utilitynotifyacktableindex utilitynotifyack utilitynotifyinterval utilitynotifyretries utilitynotifyresponse NafemChoice, NafemInterval, IpAddress utilitynotifyacktableindex OBJECT-TYPE DESCRIPTION " Index for the rows of the utilitynotifyacktable. " ::= { utilitynotifyackentry 1 utilitynotifyack OBJECT-TYPE SYNTAX NafemChoice DESCRIPTION " 1 = No acknowledgement required from manager, 2 = Acknowledgement required, Reference current NAFEM textual convention. " ::= { utilitynotifyackentry 2 utilitynotifyinterval OBJECT-TYPE SYNTAX NafemInterval DESCRIPTION " Delay interval between non-acknowledged trap events. Applicable only when acknowledgement required. Reference current NAFEM textual convention. " ::= { utilitynotifyackentry 3 utilitynotifyretries OBJECT-TYPE DESCRIPTION " Number of attempts of non-acknowledged trap events. Applicable only when acknowledgement required. " ::= { utilitynotifyackentry 4 10

11 utilitynotifyresponse OBJECT-TYPE SYNTAX IpAddress DESCRIPTION " Response word from SNMP Manager to acknowledge to. Manager writes his/her Ipaddress to confirm receipt. " ::= { utilitynotifyackentry 5 END MIB-utility-v2.00;

NAFEM-INVENTORY-MANAGEMENT-MIB DEFINITIONS ::= BEGIN. -- From file: "inventory-management.mib" IMPORTS -- enterprises FROM RFC1155-SMI

NAFEM-INVENTORY-MANAGEMENT-MIB DEFINITIONS ::= BEGIN From file: "inventory-management.mib" IMPORTS enterprises FROM RFC1155-SMI IpAddress, Counter FROM RFC1065-SMI OBJECT-TYPE FROM RFC-1212 DisplayString