-- extracted from draft-glenn-mo-aggr-mib-03.txt -- at Wed Jul 2 06:13:47 2003 AGGREGATE-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, experimental, Unsigned32, 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; aggrMIB MODULE-IDENTITY LAST-UPDATED "200207140000Z" -- 14th July 2002 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 aggregate objects." ::= { experimental 999 } -- will be assigned by IANA AggrMOErrorStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This data type is used to model the error status of the constituent MO instances. The error status for a constituent MO instance is given in terms of two elements - o the moIndex which indicates the position of the MO instance (starting at 1) in the value of the aggregated MO instance. o the moError which indicates the error that was encountered in fetching that MO instance. The syntax in ASN.1 Notation will be ErrorStatus :: = SEQUENCE { moIndex Integer32, moError SnmpPduErrorStatus } AggrMOErrorStatus ::= SEQUENCE OF { ErrorStatus } Note1: the command responder will supply values for all constituent MO instances and in the same order in which AggrMO is defined. If an error is encountered for an MO instance then the corresponding value will have an ASN.1 value NULL and, an error flagged in the corresponding AggrMOErrorStatus 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. Note3: the command generator will need to know the constituent MO instances and their order to correctly interpret AggrMOErrorStatus. " SYNTAX Opaque (SIZE (0..1024)) AggrMOValue ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This data type is used to model the aggregate MOs. It will have a format dependent on the constituent MOs, a sequence of values. The syntax in ASN.1 Notation will be MOValue :: = SEQUENCE { value ObjectSyntax } Where, 'value' is the value of a constituent MO instance. AggrMOValue :: = SEQUENCE OF { MOValue } Note: the command generator will need to know the the constituent MO instances and their order to correctly interpret AggrMOValue." SYNTAX Opaque (SIZE (0..1024)) CompressedAggrMOValue ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This data type is used to model the compressed aggregate MOs. " SYNTAX OCTET STRING (SIZE (0..1024)) -- -- The aggregation control table -- There will be a row for each aggregate MO -- aggrCtlTable OBJECT-TYPE SYNTAX SEQUENCE OF AggrCtlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " A table that controls the aggregation of the MOs." ::= {aggrMIB 1} aggrCtlEntry OBJECT-TYPE SYNTAX AggrCtlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of the control table that defines one aggregated MO." INDEX {aggrEntryID } ::= {aggrCtlTable 1 } AggrCtlEntry ::= SEQUENCE { aggrEntryID SnmpAdminString, aggrAgMOIndex Unsigned32, aggrAgMODescr SnmpAdminString, aggrCompressionAlgorithm INTEGER, aggrEntryOwner OwnerString, aggrEntryStorageType StorageType, aggrEntryStatus RowStatus } aggrEntryID 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." ::= { aggrCtlEntry 1 } aggrAgMOIndex OBJECT-TYPE SYNTAX Unsigned32 (1..2147483647) MAX-ACCESS read-create STATUS current DESCRIPTION " A pointer to a group of MOs identified by aggrMOEntryID in the aggrMOTable. This is the group of MOs that will be aggregated." ::= { aggrCtlEntry 2 } aggrAgMODescr OBJECT-TYPE SYNTAX SnmpAdminString (SIZE(0..64)) MAX-ACCESS read-create STATUS current DESCRIPTION " A textual description of the object that is being aggregated." ::= {aggrCtlEntry 3} aggrCompressionAlgorithm 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 aggregated object." DEFVAL { 1 } ::= {aggrCtlEntry 4} aggrEntryOwner OBJECT-TYPE SYNTAX OwnerString MAX-ACCESS read-create STATUS current DESCRIPTION " The entity that created this entry." ::= {aggrCtlEntry 5} aggrEntryStorageType 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. " ::= {aggrCtlEntry 6} aggrEntryStatus 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 aggrEntryStatus may be changed to ''active'' iff all the MOs in the conceptual row have been assigned valid values. " ::= {aggrCtlEntry 7} -- -- The Table of primary MOs -- Each row in this table represents a MO which will be aggregated. -- The aggrMOEntryID index is used to identify the group of MOs -- that will be aggregated. The aggrMOEntryMOID index is used to -- identify an MO in the group. -- aggrMOTable OBJECT-TYPE SYNTAX SEQUENCE OF AggrMOEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " A table of the MOs that will be aggregated." ::= {aggrMIB 2} aggrMOEntry OBJECT-TYPE SYNTAX AggrMOEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row of the table that specifies one MO." INDEX { aggrMOEntryID, aggrMOEntryMOID } ::= {aggrMOTable 1 } AggrMOEntry ::= SEQUENCE { aggrMOEntryID Unsigned32, aggrMOEntryMOID Unsigned32, aggrMOInstance OBJECT IDENTIFIER, aggrMODescr SnmpAdminString, aggrMOEntryStorageType StorageType, aggrMOEntryStatus RowStatus } aggrMOEntryID OBJECT-TYPE SYNTAX Unsigned32 (0..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION " An index uniquely indentifying a group of MOs that will be aggregated." ::= { aggrMOEntry 1 } aggrMOEntryMOID OBJECT-TYPE SYNTAX Unsigned32 (0..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION " An index to uniquely identify an MO instance in the group of MO instances that will be aggregated." ::= { aggrMOEntry 2 } aggrMOInstance OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION " The OID of the MO instance - the value of which will being sampled by the agent." ::= { aggrMOEntry 3 } aggrMODescr OBJECT-TYPE SYNTAX SnmpAdminString (SIZE(0..64)) MAX-ACCESS read-create STATUS current DESCRIPTION " A textual description of the object that will be aggregated." ::= {aggrMOEntry 4} aggrMOEntryStorageType 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. " ::= {aggrMOEntry 5} aggrMOEntryStatus 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 aggrMOEntryStatus may be changed to ''active'' iff all the MOs in the conceptual row have been assigned valid values. " ::= {aggrMOEntry 6} -- -- aggrDataTable: The Table of Data. Each row represents a Data set. -- aggrEntryID is the key to the table. -- of instances of the aggregated MO that will be present in the table. -- aggrDataTable OBJECT-TYPE SYNTAX SEQUENCE OF AggrDataEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " Each row of this table contains information about an aggregateMO indexed by aggrEntryID." ::= {aggrMIB 3} aggrDataEntry OBJECT-TYPE SYNTAX AggrDataEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " Entry containing information pertaining an aggregate MO." INDEX {aggrEntryID} ::= {aggrDataTable 1 } AggrDataEntry ::= SEQUENCE { aggrDataRec AggrMOValue, aggrDataRecC CompressedAggrMOValue, aggrErrorRec AggrMOErrorStatus } aggrDataRec OBJECT-TYPE SYNTAX AggrMOValue MAX-ACCESS read-only STATUS current DESCRIPTION "The snapshot value of the aggregated MO. Note that the access privileges to this object will be governed by the access privileges of the component objects. Thus an entity attempting to access this MO MUST have access to all the component objects and this MO. " ::= { aggrDataEntry 1} aggrDataRecC OBJECT-TYPE SYNTAX CompressedAggrMOValue MAX-ACCESS read-only STATUS current DESCRIPTION "The compressed value of the aggregated MO. The compression algorithm will depend on the aggrCompressionAlgorithm given in the corresponding aggrCtlEntry. In case the value of the corresponding aggrCompressionAlgorithm 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 component objects. Thus an entity attempting to access this MO MUST have access to all the component objects and this MO. " ::= { aggrDataEntry 2} aggrErrorRec OBJECT-TYPE SYNTAX AggrMOErrorStatus MAX-ACCESS read-only STATUS current DESCRIPTION " The error status corresponding to the MO instances aggregated in aggrDataRec (and aggrDataRecC)." ::= { aggrDataEntry 3} -- Conformance information aggrConformance OBJECT IDENTIFIER ::= { aggrMIB 4 } aggrGroups OBJECT IDENTIFIER ::= { aggrConformance 1 } aggrCompliances OBJECT IDENTIFIER ::= { aggrConformance 2 } -- Compliance statements aggrDataCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities which implement the AGGREGATE-MIB." MODULE -- this module MANDATORY-GROUPS { aggrDataGroup } ::= { aggrCompliances 1 } -- Units of conformance aggrDataGroup OBJECT-GROUP OBJECTS { aggrAgMOIndex, aggrAgMODescr, aggrCompressionAlgorithm, aggrEntryOwner, aggrEntryStorageType, aggrEntryStatus, aggrMOInstance, aggrMODescr, aggrMOEntryStorageType, aggrMOEntryStatus, aggrDataRec, aggrDataRecC, aggrErrorRec } STATUS current DESCRIPTION " A collection of objects for aggregation of MOs." ::= { aggrGroups 1 } END -- -- "Copyright (C) The Internet Society (2002). 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."