-- extracted from draft-glenn-mo-aggr-mib-00.txt
-- at Tue Nov 27 06:07:10 2001

      AGGREGATE-MIB DEFINITIONS ::= BEGIN
       IMPORTS
         MODULE-IDENTITY,  Counter32, Gauge32, OBJECT-TYPE,
         OBJECT-IDENTITY      FROM SNMPv2-SMI
         RowStatus
                    FROM SNMPv2-TC
         MODULE-COMPLIANCE, OBJECT-GROUP
                    FROM SNMPv2-CONF
         SnmpAdminString
                    FROM SNMP-FRAMEWORK-MIB;

     aggrMIB MODULE-IDENTITY
          LAST-UPDATED "200111160000Z"        --  14th November 2001
          ORGANIZATION "Cyber Solutions  NetMan Working Group"
          CONTACT-INFO
         "                      Glenn Mansfield
                        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 nnn } -- will be assigned by IANA


      AggrMOValue ::= TEXTUAL-CONVENTION
        STATUS       current
        DESCRIPTION
          "This data type is used to model the aggregate
           MOs. It will have a format dependent on the
           type of aggregation that is being carried out.
           for MO-based aggregation the format will be
               <separator><value><separator>....<value><separator>
           for time-based aggregation
               <timestamp><space><value><separator>....<value><separator>
           Note:
               o The command generator is expected to know
                     - the MO(s) that are being aggregated and,
                     - the length of the aggregation

                 to be able to correctly interpret the constants of this data
                 type.
               o The values are ordered according
                 to increasing order of aggrMOEntryID of the corresponding MOs
                 in the aggrMOTable
               o That the TimeStamp is not present for MO-based aggregation
                 [aggrTSLength <=  1]. "

        SYNTAX      OCTET STRING (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 a row for each agregate MO defined in the
   -- aggrMOTable. It drives the time-based aggregation.
   -- The attributes in a row pertain to the aggregation
   -- time samples of the corresponding MOs defined in the
   -- aggrMOTable.
   --
      aggrTSAttrsTable OBJECT-TYPE
           SYNTAX  SEQUENCE OF AggrAttrsEntry
           MAX-ACCESS  not-accessible
           STATUS current
           DESCRIPTION
             " A table that controls the aggregation of the MOs."
           ::= {aggrMIB 1}

       aggrTSAttrsEntry OBJECT-TYPE
           SYNTAX  AggrAttrsEntry
           MAX-ACCESS  not-accessible
           STATUS  current
           DESCRIPTION
             "A row of the control table that defines one aggregated
              MO."
           INDEX {aggrTSEntryID }
           ::= {aggrTSAttrsTable 1 }

       AggrAttrsEntry ::= SEQUENCE {
          aggrTSEntryID
                        INTEGER,
          aggrTSMOIndex
                        INTEGER,
          aggrTSObjectDescr
                        SnmpAdminString,
          aggrTSLength
                        Gauge32,
          aggrTSInterval
                        Gauge32,
          aggrTSSeparator
                        INTEGER,
          aggrTSCompressionAlgorithm
                        INTEGER,
          aggrTSEntryStatus
                        RowStatus
       }

      aggrTSEntryID OBJECT-TYPE
           SYNTAX INTEGER
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " An Index uniquely identifying the attributes in
               this row."
           ::= { aggrTSAttrsEntry 1 }

      aggrTSMOIndex OBJECT-TYPE
           SYNTAX INTEGER
           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."
           ::= { aggrTSAttrsEntry 2 }

      aggrTSObjectDescr OBJECT-TYPE
           SYNTAX SnmpAdminString (SIZE(0..64))
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " A textual description of the object that is
               being aggregated."
           ::= {aggrTSAttrsEntry 3}

      aggrTSLength OBJECT-TYPE
           SYNTAX Gauge32
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " The number of times the group of MO(s) pointed at by
               the aggrTSObject will be sampled and aggregated."
           ::= {aggrTSAttrsEntry 4}

      aggrTSInterval OBJECT-TYPE
           SYNTAX Gauge32
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " The interval at which the group of MO(s) pointed at by
               aggrTSObject, will be sampled for time-based
               aggregation. If the aggrTSLength = 1 then this
               field is irrelevant."
           ::= {aggrTSAttrsEntry 5}

      aggrTSSeparator OBJECT-TYPE
           SYNTAX INTEGER {
                  none      (1),
                  comma     (2),
                  period    (3),
                  slash     (4),
                  space     (5),
                  colon     (6),
                  semicolon (7),
                  dash      (8),
                  underbar  (9)
           }
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " The separator that will be used to separate
               the sampled values of the group of MO(s) pointed at by
               aggrTSObject."
           ::= {aggrTSAttrsEntry 6}

      aggrTSCompressionAlgorithm 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."
           ::= {aggrTSAttrsEntry 7}

      aggrTSEntryStatus OBJECT-TYPE
           SYNTAX RowStatus
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
              "The row status variable, used according to row
               installation and removal conventions."
           ::= {aggrTSAttrsEntry 8}

   --
   -- The Table of primary  managed MOs
   -- Each row in this table represents a primary 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
                        INTEGER,
          aggrMOEntryMOID
                        INTEGER,
          aggrMOObject
                        INTEGER,
          aggrMOObjectDescr
                        SnmpAdminString,
          aggrMOErrorIndicator
                        INTEGER,
          aggrMOSeparator
                        INTEGER,
          aggrMOEntryStatus
                        RowStatus
       }

      aggrMOEntryID OBJECT-TYPE
           SYNTAX INTEGER
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " An Index uniquely indentifying a group of MOs
               that will be aggregated."
           ::= { aggrMOEntry 1 }

      aggrMOEntryMOID OBJECT-TYPE
           SYNTAX INTEGER
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " An Index uniquely the MOs in the group of MOs
               that will be aggregated."
           ::= { aggrMOEntry 2 }

      aggrMOObject OBJECT-TYPE
           SYNTAX OBJECT IDENTIFIER
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " The OID of the MO - the value of which will
               being sampled by the agent. Note. this must be a
               leaf OID."
           ::= { aggrMOEntry 3 }

      aggrMOObjectDescr 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}


      aggrMOErrorIndicator OBJECT-TYPE
           SYNTAX INTEGER {
                  null      (1),
                  space     (2),
                  minusOne  (3),
                  hyphen    (4),
                  underbar  (5)
           }
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " An indicator that there was a problem in getting
               the value of this MO."
           ::= {aggrMOEntry 5}

      aggrMOSeparator OBJECT-TYPE
           SYNTAX INTEGER {
                  none      (1),
                  comma     (2),
                  period    (3),
                  slash     (4),
                  space     (5),
                  colon     (6),
                  semicolon (7),
                  dash      (8),
                  underbar  (9)
           }
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
             " The separator that will be used to separate
               the sampled values of the group of MOs identified by
               the aggrMOEntryID.
               Note that this separator should be
               separate from the separator used in the time-based
               aggregation of the groups specified in this table."
           ::= {aggrMOEntry 6}

      aggrMOEntryStatus OBJECT-TYPE
           SYNTAX RowStatus
           MAX-ACCESS read-create
           STATUS current
           DESCRIPTION
              "The row status variable, used according to row
               installation and removal conventions."
           ::= {aggrMOEntry 7}
   --
   -- The Aggregated MOs
   --
      aggrDataGroup OBJECT-IDENTITY
           STATUS current
           DESCRIPTION
             " This is the base object for the subtree of
               data objects."
           ::= {aggrMIB 3}

      --
      -- aggrDataTable: The Table of Data. Each row represents a Data set.
      -- aggrTSEntryID,aggrDataID is the key to the table. The number of
      -- instances of aggrDataID for each aggrTSEntryID determines the number
      -- of instances of the aggregated MO that will be present in the table.
      -- The size of will be implementation dependent - some implementors may
      -- choose to keep a maximum of one messages in this table (only the
      -- most recent snapshot of the aggregated MO will be serviced).
      --
      aggrDataTable OBJECT-TYPE
           SYNTAX  SEQUENCE OF AggrDataEntry
           MAX-ACCESS  not-accessible
           STATUS  current
           DESCRIPTION
             " Each row of this table contains information
               about a data indexed by aggrTSDataID."
           ::= {aggrDataGroup 1 }

      aggrDataEntry OBJECT-TYPE
           SYNTAX  AggrDataEntry
           MAX-ACCESS  not-accessible
           STATUS  current
           DESCRIPTION
             " Entry containing information pertaining
               an aggregate MO."
           INDEX {aggrTSEntryID, aggrDataID}
           ::= {aggrDataTable 1 }

      AggrDataEntry ::= SEQUENCE {
         aggrDataID
                    INTEGER,
         aggrDataRec
                    AggrMOValue,
         aggrDataRecC
                    CompressedAggrMOValue
         }

      aggrDataID OBJECT-TYPE
           SYNTAX INTEGER (1..65535)
           MAX-ACCESS read-only
           STATUS current
           DESCRIPTION
             " This along with the aggrTSEntryID uniquely
               identifies a snapshot value of an aggregate MO."
           ::= { aggrDataEntry 1}

      aggrDataRec OBJECT-TYPE
           SYNTAX AggrMOValue
           MAX-ACCESS read-only
           STATUS current
           DESCRIPTION
             "The snapshot value of the aggregated MO."
           ::= { aggrDataEntry 2}

      aggrDataRecC OBJECT-TYPE
           SYNTAX CompressedAggrMOValue
           MAX-ACCESS read-only
           STATUS current
           DESCRIPTION
             " The compressed value of the aggregated MO."
           ::= { aggrDataEntry 3}

       -- Conformance information
      aggrConformance OBJECT IDENTIFIER ::= { aggrMIB 3 }
      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 {
                      aggrTSEntryID,
                      aggrTSMOIndex,
                      aggrTSObjectDescr,
                      aggrTSLength,
                      aggrTSInterval,
                      aggrTSSeparator,
                      aggrTSCompressionAlgorithm,
                      aggrTSEntryStatus,
                      aggrMOEntryID,
                      aggrMOEntryMOID,
                      aggrMOObject,
                      aggrMOObjectDescr,
                      aggrMOErrorIndicator,
                      aggrMOSeparator,
                      aggrMOEntryStatus,
                      aggrDataID,
                      aggrDataRec,
                      aggrDataRecC
          }
           STATUS  current
           DESCRIPTION
                   " A collection of objects for aggregation of MOs."
           ::= { aggrGroups 1 }
      END

-- 
--          "Copyright (C) The Internet Society (date). 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."