mibs/ietf/PerfHist-TC-MIB

   1 PerfHist-TC-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4    MODULE-IDENTITY,
   5    Gauge32, mib-2
   6        FROM SNMPv2-SMI
   7    TEXTUAL-CONVENTION
   8        FROM SNMPv2-TC;
   9
  10 perfHistTCMIB MODULE-IDENTITY
  11      LAST-UPDATED "200308130000Z"
  12      ORGANIZATION "IETF AToM MIB WG"
  13      CONTACT-INFO
  14         "WG charter:
  15            http://www.ietf.org/html.charters/atommib-charter.html
  16
  17          Mailing Lists:
  18            General Discussion: atommib@research.telcordia.com
  19            To Subscribe: atommib-request@research.telcordia.com
  20
  21          Editor:  Kaj Tesink
  22          Postal:  Telcordia Technologies
  23                   331 Newman Springs Road
  24                   Red Bank, NJ 07701
  25                   USA
  26          Tel:     +1 732 758 5254
  27          E-mail:  kaj@research.telcordia.com"
  28
  29      DESCRIPTION
  30       "This MIB Module provides Textual Conventions
  31        to be used by systems supporting 15 minute
  32        based performance history counts.
  33
  34        Copyright (C) The Internet Society (2003).
  35        This version of this MIB module is part of
  36        RFC 3593;  see the RFC itself for full
  37        legal notices."
  38      REVISION      "200308130000Z"
  39      DESCRIPTION
  40       "Contact information and references updated.
  41        No technical changes have been applied.
  42        Published as RFC 3593."
  43      REVISION      "199811071100Z"
  44      DESCRIPTION
  45       "The RFC 2493 version of this MIB module."
  46      ::= { mib-2 58 }
  47
  48
  49
  50 -- The Textual Conventions defined below are organized
  51 -- alphabetically
  52
  53 -- Use of these TCs assumes the following:
  54 -- 0  The agent supports 15 minute based history
  55 --    counters.
  56 -- 0  The agent is capable of keeping a history of n
  57 --    intervals of 15 minute performance data.  The
  58 --    value of n is defined by the specific MIB
  59 --    module but shall be 0 < n =< 96.
  60 -- 0  The agent may optionally support performance
  61 --    data aggregating the history intervals.
  62 -- 0  The agent will keep separate tables for the
  63 --    current interval, the history intervals, and
  64 --    the total aggregates.
  65 -- 0  The agent will keep the following objects.
  66 --    If performance data is kept for multiple instances
  67 --    of a measured entity, then
  68 --    these objects are applied to each instance of
  69 --    the measured entity (e.g., interfaces).
  70 --
  71 -- xyzTimeElapsed OBJECT-TYPE
  72 --       SYNTAX  INTEGER (0..899)
  73 --       MAX-ACCESS  read-only
  74 --       STATUS  current
  75 --       DESCRIPTION
  76 --       "The number of seconds that have elapsed since
  77 --       the beginning of the current measurement period.
  78 --       If, for some reason, such as an adjustment in the
  79 --       system's time-of-day clock, the current interval
  80 --       exceeds the maximum value, the agent will return
  81 --       the maximum value."
  82 --       ::= { xxx }
  83
  84 -- xyzValidIntervals OBJECT-TYPE
  85 --       SYNTAX  INTEGER (0..<n>)
  86 --       MAX-ACCESS  read-only
  87 --       STATUS  current
  88 --       DESCRIPTION
  89 --       "The number of previous near end intervals
  90 --       for which data was collected.
  91 --          [ The overall constraint on <n> is 1 =< n =< 96; ]
  92 --          [ Define any additional constraints on <n> here. ]
  93 --       The value will be <n> unless the measurement was
  94 --       (re-)started within the last (<n>*15) minutes, in which
  95 --       case the value will be the number of complete 15
  96 --       minute intervals for which the agent has at least
  97 --       some data.  In certain cases (e.g., in the case
  98
  99
 100
 101 --       where the agent is a proxy) it is possible that some
 102 --       intervals are unavailable.  In this case, this
 103 --       interval is the maximum interval number for
 104 --       which data is available."
 105 --       ::= { xxx }
 106
 107 -- xyzInvalidIntervals OBJECT-TYPE
 108 --     SYNTAX  INTEGER (0..<n>)
 109 --     MAX-ACCESS  read-only
 110 --     STATUS  current
 111 --     DESCRIPTION
 112 --       "The number of intervals in the range from
 113 --        0 to xyzValidIntervals for which no
 114 --        data is available.  This object will typically
 115 --        be zero except in cases where the data for some
 116 --        intervals are not available (e.g., in proxy
 117 --        situations)."
 118 --       ::= { xxx }
 119
 120 PerfCurrentCount ::= TEXTUAL-CONVENTION
 121       STATUS  current
 122       DESCRIPTION
 123          "A counter associated with a
 124           performance measurement in a current 15
 125           minute measurement interval.  The value
 126           of this counter starts from zero and is
 127           increased when associated events occur,
 128           until the end of the 15 minute interval.
 129           At that time the value of the counter is
 130           stored in the first 15 minute history
 131           interval, and the CurrentCount is
 132           restarted at zero.  In the
 133           case where the agent has no valid data
 134           available for the current interval the
 135           corresponding object instance is not
 136           available and upon a retrieval request
 137           a corresponding error message shall be
 138           returned to indicate that this instance
 139           does not exist (for example, a noSuchName
 140           error for SNMPv1 and a noSuchInstance for
 141           SNMPv2 GET operation)."
 142        SYNTAX  Gauge32
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152 PerfIntervalCount ::= TEXTUAL-CONVENTION
 153       STATUS  current
 154       DESCRIPTION
 155          "A counter associated with a
 156           performance measurement in a previous
 157           15 minute measurement interval.  In the
 158           case where the agent has no valid data
 159           available for a particular interval the
 160           corresponding object instance is not
 161           available and upon a retrieval request
 162           a corresponding error message shall be
 163           returned to indicate that this instance
 164           does not exist (for example, a noSuchName
 165           error for SNMPv1 and a noSuchInstance for
 166           SNMPv2 GET operation).
 167           In a system supporting
 168           a history of n intervals with
 169           IntervalCount(1) and IntervalCount(n) the
 170           most and least recent intervals
 171           respectively, the following applies at
 172           the end of a 15 minute interval:
 173           - discard the value of IntervalCount(n)
 174           - the value of IntervalCount(i) becomes that
 175             of IntervalCount(i-1) for n >= i > 1
 176           - the value of IntervalCount(1) becomes that
 177             of CurrentCount
 178           - the TotalCount, if supported, is adjusted."
 179        SYNTAX  Gauge32
 180
 181 PerfTotalCount ::= TEXTUAL-CONVENTION
 182       STATUS  current
 183       DESCRIPTION
 184          "A counter associated with a
 185           performance measurements aggregating the
 186           previous valid 15 minute measurement
 187           intervals.  (Intervals for which no valid
 188           data was available are not counted)"
 189        SYNTAX  Gauge32
 190
 191 END