Blame mibs/ietf/TIME-AGGREGATE-MIB

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