Blame mibs/ietf/TIME-AGGREGATE-MIB

Packit 022b05
   TIME-AGGREGATE-MIB DEFINITIONS ::= BEGIN
Packit 022b05
    IMPORTS
Packit 022b05
      MODULE-IDENTITY,  experimental,
Packit 022b05
      OBJECT-TYPE,      Opaque, Integer32
Packit 022b05
                 FROM SNMPv2-SMI
Packit 022b05
      OwnerString
Packit 022b05
                 FROM RMON-MIB
Packit 022b05
      RowStatus, StorageType, TEXTUAL-CONVENTION
Packit 022b05
                 FROM SNMPv2-TC
Packit 022b05
      MODULE-COMPLIANCE, OBJECT-GROUP
Packit 022b05
                 FROM SNMPv2-CONF
Packit 022b05
      SnmpAdminString
Packit 022b05
                 FROM SNMP-FRAMEWORK-MIB;
Packit 022b05
Packit 022b05
  tAggrMIB MODULE-IDENTITY
Packit 022b05
       LAST-UPDATED "200604270000Z"        --  27 April 2006
Packit 022b05
       ORGANIZATION "Cyber Solutions Inc. NetMan Working Group"
Packit 022b05
       CONTACT-INFO
Packit 022b05
      "                      Glenn Mansfield Keeni
Packit 022b05
                     Postal: Cyber Solutions Inc.
Packit 022b05
                             6-6-3, Minami Yoshinari
Packit 022b05
                             Aoba-ku, Sendai, Japan 989-3204.
Packit 022b05
                        Tel: +81-22-303-4012
Packit 022b05
                        Fax: +81-22-303-4015
Packit 022b05
                     E-mail: glenn@cysols.com
Packit 022b05
Packit 022b05
          Support Group E-mail: mibsupport@cysols.com"
Packit 022b05
Packit 022b05
          DESCRIPTION
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
                  "The MIB for servicing Time-Based aggregate
Packit 022b05
                    objects.
Packit 022b05
Packit 022b05
                    Copyright (C) The Internet Society (2006).  This
Packit 022b05
                    version of this MIB module is part of RFC 4498;
Packit 022b05
                    see the RFC itself for full legal notices.
Packit 022b05
                  "
Packit 022b05
          REVISION    "200604270000Z"      -- 27th April, 2006
Packit 022b05
          DESCRIPTION "Initial version, published as RFC 4498."
Packit 022b05
               ::= { experimental 124 }
Packit 022b05
Packit 022b05
   TAggrMOErrorStatus ::= TEXTUAL-CONVENTION
Packit 022b05
     STATUS       current
Packit 022b05
     DESCRIPTION
Packit 022b05
       "This data type is used to model the error status of the
Packit 022b05
        sampled MO instance.  The error status for a sampled MO
Packit 022b05
        instance is given in terms of two elements:
Packit 022b05
          o The moIndex, which indicates the sample number of the MO
Packit 022b05
            instance (starting at 1) in the value of the time-
Packit 022b05
            aggregated MO instance.
Packit 022b05
          o The moError, which indicates the error that was
Packit 022b05
            encountered in sampling that MO instance.
Packit 022b05
        The syntax in ASN.1 Notation will be
Packit 022b05
        ErrorStatus :: = SEQUENCE {
Packit 022b05
           moIndex  Integer32,
Packit 022b05
           moError  SnmpPduErrorStatus
Packit 022b05
        }
Packit 022b05
        TAggrMOErrorStatus ::= SEQUENCE OF {
Packit 022b05
           ErrorStatus
Packit 022b05
        }
Packit 022b05
        Note1: The command responder will supply values for all
Packit 022b05
               the samples of the MO instance.  If an error is
Packit 022b05
               encountered for a sample, then the corresponding
Packit 022b05
               value will have an ASN.1 value NULL, and an error
Packit 022b05
               will be flagged in the corresponding
Packit 022b05
               TAggrMOErrorStatus object.
Packit 022b05
               Only MOs for which errors have been encountered will
Packit 022b05
               the corresponding moIndex and moError values be set.
Packit 022b05
        Note2: The error code for the component MO instances will be
Packit 022b05
               in accordance with the SnmpPduErrorStatus TC defined
Packit 022b05
               in the DISMAN-SCHEDULE-MIB[RFC3231].
Packit 022b05
       "
Packit 022b05
     SYNTAX      Opaque (SIZE (0..1024))
Packit 022b05
Packit 022b05
   TimeAggrMOValue ::= TEXTUAL-CONVENTION
Packit 022b05
     STATUS       current
Packit 022b05
     DESCRIPTION
Packit 022b05
       "This data type is used to model the time-aggregated MOs.  It
Packit 022b05
Packit 022b05
Packit 022b05
        will be a sequence of values.  The syntax in ASN.1 Notation
Packit 022b05
        will be
Packit 022b05
        MOSampleValue :: = SEQUENCE {
Packit 022b05
             value ObjectSyntax
Packit 022b05
        }
Packit 022b05
        TimeAggrMOValue ::= SEQUENCE OF {
Packit 022b05
             MOSampleValue
Packit 022b05
        }
Packit 022b05
        where the first MOSampleValue, if any, will always be the
Packit 022b05
        timestamp of the first sample in the aggregated object.  The
Packit 022b05
        subsequent values are the values of the MO instance sampled
Packit 022b05
        at the specified intervals for the specified number of times.
Packit 022b05
        Note: The command generator will need to know the
Packit 022b05
              constituent MO instance and the sampling interval to
Packit 022b05
              correctly interpret TimeAggrMOValue.
Packit 022b05
       "
Packit 022b05
     SYNTAX      Opaque (SIZE (0..1024))
Packit 022b05
Packit 022b05
   CompressedTimeAggrMOValue ::= TEXTUAL-CONVENTION
Packit 022b05
     STATUS       current
Packit 022b05
     DESCRIPTION
Packit 022b05
       "This data type is used to model the compressed
Packit 022b05
        TAgMOs."
Packit 022b05
     SYNTAX      Opaque (SIZE (0..1024))
Packit 022b05
Packit 022b05
--
Packit 022b05
-- The Time-Based aggregation control table
Packit 022b05
--
Packit 022b05
   tAggrCtlTable OBJECT-TYPE
Packit 022b05
        SYNTAX  SEQUENCE OF TAggrCtlEntry
Packit 022b05
        MAX-ACCESS  not-accessible
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The Time-Based aggregation control table.  It controls
Packit 022b05
            the aggregation of the samples of MO instances.  There
Packit 022b05
            will be a row for each TAgMO.
Packit 022b05
           "
Packit 022b05
        ::= {tAggrMIB 1}
Packit 022b05
Packit 022b05
    tAggrCtlEntry OBJECT-TYPE
Packit 022b05
        SYNTAX  TAggrCtlEntry
Packit 022b05
        MAX-ACCESS  not-accessible
Packit 022b05
        STATUS  current
Packit 022b05
        DESCRIPTION
Packit 022b05
          "A row of the control table that defines one Time-Based
Packit 022b05
           aggregate MO (TAgMO)."
Packit 022b05
        INDEX {tAggrCtlEntryID }
Packit 022b05
        ::= {tAggrCtlTable 1 }
Packit 022b05
Packit 022b05
Packit 022b05
    TAggrCtlEntry ::= SEQUENCE {
Packit 022b05
       tAggrCtlEntryID
Packit 022b05
                     SnmpAdminString,
Packit 022b05
       tAggrCtlMOInstance
Packit 022b05
                     OBJECT IDENTIFIER,
Packit 022b05
       tAggrCtlAgMODescr
Packit 022b05
                     SnmpAdminString,
Packit 022b05
       tAggrCtlInterval
Packit 022b05
                     Integer32,
Packit 022b05
       tAggrCtlSamples
Packit 022b05
                     Integer32,
Packit 022b05
       tAggrCtlCompressionAlgorithm
Packit 022b05
                     INTEGER,
Packit 022b05
       tAggrCtlEntryOwner
Packit 022b05
                     OwnerString,
Packit 022b05
       tAggrCtlEntryStorageType
Packit 022b05
                     StorageType,
Packit 022b05
       tAggrCtlEntryStatus
Packit 022b05
                     RowStatus
Packit 022b05
    }
Packit 022b05
Packit 022b05
   tAggrCtlEntryID OBJECT-TYPE
Packit 022b05
        SYNTAX SnmpAdminString (SIZE(1..32))
Packit 022b05
        MAX-ACCESS not-accessible
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
          "A locally unique, administratively assigned name
Packit 022b05
            for this aggregated MO.  It is used as an index to
Packit 022b05
            uniquely identify this row in the table."
Packit 022b05
        ::= { tAggrCtlEntry 1 }
Packit 022b05
Packit 022b05
   tAggrCtlMOInstance OBJECT-TYPE
Packit 022b05
        SYNTAX OBJECT IDENTIFIER
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The sampled values of this MO instance will be
Packit 022b05
            aggregated by the TAgMO.
Packit 022b05
            "
Packit 022b05
        ::= { tAggrCtlEntry 2 }
Packit 022b05
Packit 022b05
   tAggrCtlAgMODescr OBJECT-TYPE
Packit 022b05
        SYNTAX SnmpAdminString (SIZE(0..64))
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "A textual description of the aggregate object."
Packit 022b05
        ::= {tAggrCtlEntry 3}
Packit 022b05
Packit 022b05
Packit 022b05
   tAggrCtlInterval OBJECT-TYPE
Packit 022b05
        SYNTAX Integer32
Packit 022b05
        UNITS  "micro seconds"
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The interval, in microseconds, at which the MO instance
Packit 022b05
            pointed at by tAggrInstance will be sampled for
Packit 022b05
            Time-Based aggregation.
Packit 022b05
          "
Packit 022b05
        ::= {tAggrCtlEntry 4}
Packit 022b05
Packit 022b05
   tAggrCtlSamples OBJECT-TYPE
Packit 022b05
        SYNTAX Integer32
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The number of times at which the MO instance referred
Packit 022b05
            to by tAggrInstance will be sampled for Time-Based
Packit 022b05
            aggregation."
Packit 022b05
        ::= {tAggrCtlEntry 5}
Packit 022b05
Packit 022b05
   -- only one compression algorithm is defined as of now.
Packit 022b05
   tAggrCtlCompressionAlgorithm OBJECT-TYPE
Packit 022b05
        SYNTAX INTEGER {
Packit 022b05
               none      (1),
Packit 022b05
               deflate   (2)
Packit 022b05
        }
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The compression algorithm that will be used by
Packit 022b05
            the agent to compress the value of the TAgMO.
Packit 022b05
            The deflate algorithm and corresponding data format
Packit 022b05
            specification is described in RFC 1951.  It is
Packit 022b05
            compatible with the widely used gzip utility.
Packit 022b05
          "
Packit 022b05
        REFERENCE
Packit 022b05
          "RFC1951 : DEFLATE Compressed Data Format Specification
Packit 022b05
           version 1.3
Packit 022b05
          "
Packit 022b05
        DEFVAL { none }
Packit 022b05
        ::= {tAggrCtlEntry 6}
Packit 022b05
Packit 022b05
   tAggrCtlEntryOwner OBJECT-TYPE
Packit 022b05
        SYNTAX OwnerString
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
        DESCRIPTION
Packit 022b05
           "A textual description of the entity that created
Packit 022b05
            this entry.
Packit 022b05
          "
Packit 022b05
        ::= {tAggrCtlEntry 7}
Packit 022b05
Packit 022b05
Packit 022b05
   tAggrCtlEntryStorageType OBJECT-TYPE
Packit 022b05
        SYNTAX StorageType
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "This object defines whether the parameters defined in
Packit 022b05
            this row are kept in volatile storage and lost upon
Packit 022b05
            reboot or backed up by non-volatile (permanent)
Packit 022b05
            storage.
Packit 022b05
            Conceptual rows having the value 'permanent' need not
Packit 022b05
            allow write-access to any columnar objects in the row.
Packit 022b05
           "
Packit 022b05
        ::= {tAggrCtlEntry 8}
Packit 022b05
Packit 022b05
   tAggrCtlEntryStatus OBJECT-TYPE
Packit 022b05
        SYNTAX RowStatus
Packit 022b05
        MAX-ACCESS read-create
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The row status variable, used according to row
Packit 022b05
            installation and removal conventions.
Packit 022b05
            Objects in a row can be modified only when the value of
Packit 022b05
            this object in the corresponding conceptual row is not
Packit 022b05
            'active'.
Packit 022b05
            Thus, to modify one or more of the objects in this
Packit 022b05
            conceptual row,
Packit 022b05
              a. change the row status to 'notInService',
Packit 022b05
              b. change the values of the row, and
Packit 022b05
              c. change the row status to 'active'.
Packit 022b05
            The tAggrCtlEntryStatus may be changed to 'active' iff
Packit 022b05
            all the MOs in the conceptual row have been assigned
Packit 022b05
            valid values.
Packit 022b05
           "
Packit 022b05
        ::= {tAggrCtlEntry 9}
Packit 022b05
Packit 022b05
Packit 022b05
   --
Packit 022b05
   -- tAggrDataTable: The data table.
Packit 022b05
   --
Packit 022b05
   tAggrDataTable OBJECT-TYPE
Packit 022b05
        SYNTAX  SEQUENCE OF TAggrDataEntry
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
        MAX-ACCESS  not-accessible
Packit 022b05
        STATUS  current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "This is the data table.  Each row of this table contains
Packit 022b05
            information about a TAgMO indexed by tAggrCtlEntryID.
Packit 022b05
            tAggrCtlEntryID is the key to the table.  It is used to
Packit 022b05
            identify instances of the TAgMO that are present in the
Packit 022b05
            table.
Packit 022b05
          "
Packit 022b05
        ::= {tAggrMIB 2}
Packit 022b05
Packit 022b05
   tAggrDataEntry OBJECT-TYPE
Packit 022b05
        SYNTAX  TAggrDataEntry
Packit 022b05
        MAX-ACCESS  not-accessible
Packit 022b05
        STATUS  current
Packit 022b05
        DESCRIPTION
Packit 022b05
          "Entry containing information pertaining
Packit 022b05
            to a TAgMO."
Packit 022b05
        INDEX {tAggrCtlEntryID}
Packit 022b05
        ::= {tAggrDataTable 1 }
Packit 022b05
Packit 022b05
   TAggrDataEntry ::= SEQUENCE {
Packit 022b05
      tAggrDataRecord
Packit 022b05
                 TimeAggrMOValue,
Packit 022b05
      tAggrDataRecordCompressed
Packit 022b05
                 CompressedTimeAggrMOValue,
Packit 022b05
      tAggrDataErrorRecord
Packit 022b05
                 TAggrMOErrorStatus
Packit 022b05
      }
Packit 022b05
Packit 022b05
   tAggrDataRecord OBJECT-TYPE
Packit 022b05
        SYNTAX TimeAggrMOValue
Packit 022b05
        MAX-ACCESS read-only
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
          "The snapshot value of the TAgMO."
Packit 022b05
        ::= { tAggrDataEntry 1}
Packit 022b05
Packit 022b05
   tAggrDataRecordCompressed OBJECT-TYPE
Packit 022b05
        SYNTAX CompressedTimeAggrMOValue
Packit 022b05
        MAX-ACCESS read-only
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
          "The compressed value of the TAgMO.
Packit 022b05
           The compression algorithm will depend on the
Packit 022b05
           tAggrCtlCompressionAlgorithm given in the corresponding
Packit 022b05
           tAggrCtlEntry.  If the value of the corresponding
Packit 022b05
           tAggrCtlCompressionAlgorithm is (1) 'none', then the
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
           value of all instances of this object will be a string
Packit 022b05
           of zero length.
Packit 022b05
           Note that the access privileges to this object will be
Packit 022b05
           governed by the access privileges of the corresponding MO
Packit 022b05
           instance.  Thus, an entity attempting to access an
Packit 022b05
           instance of this MO MUST have access rights to the
Packit 022b05
           instance object pointed at by tAggrCtlMOInstance and this
Packit 022b05
           MO instance.
Packit 022b05
          "
Packit 022b05
        ::= { tAggrDataEntry 2}
Packit 022b05
Packit 022b05
   tAggrDataErrorRecord OBJECT-TYPE
Packit 022b05
        SYNTAX TAggrMOErrorStatus
Packit 022b05
        MAX-ACCESS read-only
Packit 022b05
        STATUS current
Packit 022b05
        DESCRIPTION
Packit 022b05
           "The error status corresponding to the MO instance
Packit 022b05
            samples aggregated in tAggrDataRecord (and
Packit 022b05
            tAggrDataRecordCompressed)."
Packit 022b05
        ::= { tAggrDataEntry 3}
Packit 022b05
Packit 022b05
Packit 022b05
    -- Conformance information
Packit 022b05
   tAggrConformance OBJECT IDENTIFIER ::= { tAggrMIB 3 }
Packit 022b05
   tAggrGroups      OBJECT IDENTIFIER ::= { tAggrConformance 1 }
Packit 022b05
   tAggrCompliances OBJECT IDENTIFIER ::= { tAggrConformance 2 }
Packit 022b05
Packit 022b05
    -- Compliance statements
Packit 022b05
   tAggrMibCompliance MODULE-COMPLIANCE
Packit 022b05
        STATUS  current
Packit 022b05
        DESCRIPTION
Packit 022b05
                "The compliance statement for SNMP entities
Packit 022b05
                 that implement the TIME-AGGREGATE-MIB."
Packit 022b05
        MODULE  -- this module
Packit 022b05
            MANDATORY-GROUPS { tAggrMibBasicGroup }
Packit 022b05
        ::= { tAggrCompliances 1 }
Packit 022b05
Packit 022b05
    -- Units of conformance
Packit 022b05
   tAggrMibBasicGroup    OBJECT-GROUP
Packit 022b05
        OBJECTS {
Packit 022b05
                   tAggrCtlMOInstance,
Packit 022b05
                   tAggrCtlAgMODescr,
Packit 022b05
                   tAggrCtlInterval,
Packit 022b05
                   tAggrCtlSamples,
Packit 022b05
                   tAggrCtlCompressionAlgorithm,
Packit 022b05
                   tAggrCtlEntryOwner,
Packit 022b05
                   tAggrCtlEntryStorageType,
Packit 022b05
                   tAggrCtlEntryStatus,
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
                   tAggrDataRecord,
Packit 022b05
                   tAggrDataRecordCompressed,
Packit 022b05
                   tAggrDataErrorRecord
Packit 022b05
       }
Packit 022b05
        STATUS  current
Packit 022b05
        DESCRIPTION
Packit 022b05
                 "A collection of objects for Time-Based aggregation
Packit 022b05
                  of MOs."
Packit 022b05
        ::= { tAggrGroups 1 }
Packit 022b05
   END