-- extracted from draft-glenn-mo-aggr-mib-04.txt -- at Wed Feb 18 06:17:19 2004 TIME-AGGREGATE-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, experimental, OBJECT-TYPE, Opaque FROM SNMPv2-SMI OwnerString FROM RMON-MIB RowStatus, StorageType, TEXTUAL-CONVENTION FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF SnmpAdminString FROM SNMP-FRAMEWORK-MIB; tAggrMIB MODULE-IDENTITY LAST-UPDATED "200312160000Z" -- 16th December 2003 ORGANIZATION "Cyber Solutions NetMan Working Group" CONTACT-INFO " Glenn Mansfield Keeni Postal: Cyber Solutions Inc. 6-6-3, Minami Yoshinari Aoba-ku, Sendai, Japan 989-3204. Tel: +81-22-303-4012 Fax: +81-22-303-4015 E-mail: glenn@cysols.com Support Group E-mail: mibsupport@cysols.com" DESCRIPTION " The MIB for servicing tAggregate objects." ::= { experimental 999 } -- will be assigned by IANA TAggrMOErrorStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This data type is used to model the error status of the sampled MO instance. The error status for a sampled MO instance is given in terms of two elements - o the moIndex which indicates the sample number of the MO instance (starting at 1) in the value of the time aggregated MO instance. o the moError which indicates the error that was encountered in sampling that MO instance. The syntax in ASN.1 Notation will be ErrorStatus :: = SEQUENCE { moIndex Integer32, moError SnmpPduErrorStatus } TAggrMOErrorStatus ::= SEQUENCE OF { ErrorStatus } Note1: the command responder will supply values for all the samplings of the MO instance. If an error is encountered for a sample then the corresponding value will have an ASN.1 value NULL and, an error flagged in the corresponding TAggrMOErrorStatus object. Only MOs for which errors have been encountered will have the corresponding moIndex and moError values set. Note2: the error code for the component MO instances will be in accordance with the SnmpPduErrorStatus TC defined in the DISMAN-SCHEDULE-MIB. " SYNTAX Opaque (SIZE (0..1024)) TimeAggrMOValue ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This data type is used to model the time aggregated MOs. It will be a sequence of values. The syntax in ASN.1 Notation will be MOValue :: = SEQUENCE { value ObjectSyntax } TimeAggrMOValue ::= SEQUENCE OF { MOSampleValue } Where, the first MOSampleValue will always be the timestamp of the first sample in the aggregated object. The subsequent values are the values of the MO instance sampled at the specified intervals for the specified number of times. Note: the command generator will need to know the the constituent MO instance and the sampling interval to correctly interpret TimeAggrMOValue. " SYNTAX Opaque (SIZE (0..1024)) CompressedTimeAggrMOValue ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This data type is used to model the compressed tAggregate MOs. " SYNTAX Opaque (SIZE (0..1024)) -- -- The tAggregation control table -- There will be a row for each tAggregate MO -- tAggrCtlTable OBJECT-TYPE SYNTAX SEQUENCE OF TAggrCtlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " A table that controls the tAggregation of the MOs." ::= {tAggrMIB 1} tAggrCtlEntry OBJECT-TYPE SYNTAX TAggrCtlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of the control table that defines one tAggregated MO." INDEX {tAggrEntryID } ::= {tAggrCtlTable 1 } TAggrCtlEntry ::= SEQUENCE { tAggrEntryID SnmpAdminString, tAggrMOInstance OBJECT IDENTIFIER, tAggrAgMODescr SnmpAdminString, tAggrInterval Gauge32, tAggrSamples Gauge32, tAggrCompressionAlgorithm INTEGER, tAggrEntryOwner OwnerString, tAggrEntryStorageType StorageType, tAggrEntryStatus RowStatus } tAggrEntryID OBJECT-TYPE SYNTAX SnmpAdminString (SIZE(1..32)) MAX-ACCESS not-accessible STATUS current DESCRIPTION " A locally-unique administratively assigned name for this aggregated MO. It is used as an index to uniquely identify this row in the table." ::= { tAggrCtlEntry 1 } tAggrMOInstance OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION " The sampled values of this MO instance will be aggregated by the tAggrMOObject. " ::= { tAggrCtlEntry 2 } tAggrAgMODescr OBJECT-TYPE SYNTAX SnmpAdminString (SIZE(0..64)) MAX-ACCESS read-create STATUS current DESCRIPTION " A textual description of the aggregate object." ::= {tAggrCtlEntry 3} tAggrInterval OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-create STATUS current DESCRIPTION " The interval at which the MO pointed at by tAaggrInstance, will be sampled for time-based aggregation. " ::= {tAggrCtlEntry 4} tAggrSamples OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-create STATUS current DESCRIPTION " The number of times at which the MO referred to by tAaggrInstance, will be sampled for time-based aggregation." ::= {tAggrCtlEntry 5} -- no compression algorithms are defined as of now. tAggrCompressionAlgorithm OBJECT-TYPE SYNTAX INTEGER { none (1) } MAX-ACCESS read-create STATUS current DESCRIPTION " The Compression algorithm that will be used by the agent to compress the tAggregated object. " DEFVAL { 1 } ::= {tAggrCtlEntry 6} tAggrEntryOwner OBJECT-TYPE SYNTAX OwnerString MAX-ACCESS read-create STATUS current DESCRIPTION " A textual description of the entity that created this entry. " ::= {tAggrCtlEntry 7} tAggrEntryStorageType OBJECT-TYPE SYNTAX StorageType MAX-ACCESS read-create STATUS current DESCRIPTION "This object defines whether the parameters defined in this row are kept in volatile storage and lost upon reboot or are backed up by non-volatile (permanent) storage. Conceptual rows having the value ''permanent'' need not allow write-access to any columnar objects in the row. " ::= {tAggrCtlEntry 8} tAggrEntryStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The row status variable, used according to row installation and removal conventions. Objects in a row can be modified only when the value of this object in the corresponding conceptual row is not ''active''. Thus to modify one or more of the objects in this conceptual row, a. change the row status to ''notInService'', b. change the values of the row c. change the row status to ''active'' The tAggrEntryStatus may be changed to ''active'' iff all the MOs in the conceptual row have been assigned valid values. " ::= {tAggrCtlEntry 9} -- -- tAggrDataTable: The Table of Data. Each row represents a Data set. -- tAggrEntryID is the key to the table. -- of instances of the tAggregated MO that will be present in the table. -- tAggrDataTable OBJECT-TYPE SYNTAX SEQUENCE OF TAggrDataEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " Each row of this table contains information about an tAggregateMO indexed by tAggrEntryID." ::= {tAggrMIB 2} tAggrDataEntry OBJECT-TYPE SYNTAX TAggrDataEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " Entry containing information pertaining an tAggregate MO." INDEX {tAggrEntryID} ::= {tAggrDataTable 1 } TAggrDataEntry ::= SEQUENCE { tAggrDataRec TimeAggrMOValue, tAggrDataRecC CompressedTimeAggrMOValue, tAggrErrorRec TAggrMOErrorStatus } tAggrDataRec OBJECT-TYPE SYNTAX TimeAggrMOValue MAX-ACCESS read-only STATUS current DESCRIPTION "The snapshot value of the tAggregated MO." ::= { tAggrDataEntry 1} tAggrDataRecC OBJECT-TYPE SYNTAX CompressedTimeAggrMOValue MAX-ACCESS read-only STATUS current DESCRIPTION "The compressed value of the tAggregated MO. The compression algorithm will depend on the tAggrCompressionAlgorithm given in the corresponding tAggrCtlEntry. In case the value of the corresponding tAggrCompressionAlgorithm is (1) 'none' then this MO will be inaccessible. Note that the access privileges to this object will be governed by the access privileges of the corresponding MO instance. Thus an entity attempting to access this MO MUST have access to the object pointed at by tAggrMOInstance and this MO. " ::= { tAggrDataEntry 2} tAggrErrorRec OBJECT-TYPE SYNTAX TAggrMOErrorStatus MAX-ACCESS read-only STATUS current DESCRIPTION " The error status corresponding to the MO instance samples aggregated in tAggrDataRec (and tAggrDataRecC)." ::= { tAggrDataEntry 3} -- Conformance information tAggrConformance OBJECT IDENTIFIER ::= { tAggrMIB 3 } tAggrGroups OBJECT IDENTIFIER ::= { tAggrConformance 1 } tAggrCompliances OBJECT IDENTIFIER ::= { tAggrConformance 2 } -- Compliance statements tAggrDataCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities which implement the AGGREGATE-MIB." MODULE -- this module MANDATORY-GROUPS { tAggrDataGroup } ::= { tAggrCompliances 1 } -- Units of conformance tAggrDataGroup OBJECT-GROUP OBJECTS { tAggrMOInstance, tAggrAgMODescr, tAggrInterval, tAggrSamples, tAggrCompressionAlgorithm, tAggrEntryOwner, tAggrEntryStorageType, tAggrEntryStatus, tAggrDataRec, tAggrDataRecC, tAggrErrorRec } STATUS current DESCRIPTION " A collection of objects for tAggregation of MOs." ::= { tAggrGroups 1 } END -- -- "Copyright (C) The Internet Society (2003). All Rights -- Reserved. -- -- This document and translations of it may be copied and -- furnished to others, and derivative works that comment on or -- otherwise explain it or assist in its implmentation may be -- prepared, copied, published and distributed, in whole or in -- part, without restriction of any kind, provided that the above -- copyright notice and this paragraph are included on all such -- copies and derivative works. However, this document itself may -- not be modified in any way, such as by removing the copyright -- notice or references to the Internet Society or other Internet -- organizations, except as needed for the purpose of developing -- Internet standards in which case the procedures for copyrights -- defined in the Internet Standards process must be followed, or -- as required to translate it into languages other than English. -- -- The limited permissions granted above are perpetual and will -- not be revoked by the Internet Society or its successors or -- assigns. -- -- This document and the information contained herein is provided -- on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET -- ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR -- IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE -- OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY -- IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A -- PARTICULAR PURPOSE."