1-- *****************************************************************
2-- CISCO-MEDIA-METRICS-MIB
3-- Definitions of managed objects describing Media flow metrics.
4--
5-- March 2011, Ganesan Rajam
6--
7-- Copyright (c) 2011 by Cisco Systems Inc.
8-- All rights reserved.
9-- *****************************************************************
10
11CISCO-MEDIA-METRICS-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    MODULE-IDENTITY,
15    OBJECT-TYPE,
16    Counter64,
17    Gauge32
18        FROM SNMPv2-SMI
19    MODULE-COMPLIANCE,
20    OBJECT-GROUP
21        FROM SNMPv2-CONF
22    TimeStamp
23        FROM SNMPv2-TC
24    cfmFlowMonitorId,
25    cfmFlowId,
26    cfmFlowMetricsIntNumber
27        FROM CISCO-FLOW-MONITOR-MIB
28    ReportIntervalCount
29        FROM CISCO-REPORT-INTERVAL-TC-MIB
30    FlowBitRateUnits
31        FROM CISCO-FLOW-MONITOR-TC-MIB
32    ciscoMgmt
33        FROM CISCO-SMI;
34
35
36ciscoMediaMetricsMIB MODULE-IDENTITY
37    LAST-UPDATED    "201103230000Z"
38    ORGANIZATION    "Cisco Systems, Inc."
39    CONTACT-INFO
40            "Cisco Systems
41            Customer Service
42
43
44            Postal: 170 W Tasman Drive
45
46            San Jose, CA  95134
47
48            USA
49
50
51            Tel: +1 800 553-NETS
52
53
54            E-mail: cs-snmp@cisco.com"
55    DESCRIPTION
56        "This MIB module defines objects that describe the quality
57        metrics of Media streams.
58
59        GLOSSARY
60        ============
61
62        Flow Monitor - a hardware or software entity that classifies
63            traffic flows, collects flow data, and periodically
64            computes flow metrics.
65
66        Flow Metric - a measurement that reflects the quality of a
67            traffic flow.
68
69        Measurement Interval - the length of time over which a flow
70            monitor collects data related to a traffic flow, after
71            which the flow monitor computes flow metrics using the
72            collected data.
73
74        Traffic Flow - a unidirectional stream of packets conforming to
75            a classifier.  For example, packets having a particular
76            source IP address, destination IP address, protocol type,
77            source port number, and destination port number.
78
79        Traffic Flow Stream - when the monitor identifies multiple
80            individual traffic flows based on the flow classificiation,
81            the monitor aggregates the flows and represents them as a
82            single entry in the cfmFlowTable.  The individual traffic
83            flows contributing to the metrics are called as individual
84            traffic flow stream. The metrics for the traffic flow with
85            multiple streams contributing, are determined either by
86            aggregating metrics of all individual streams, for example,
87            cumulative bit rate is computed by cumulative bits of all
88            streams divided by total duration, or by selecting the
89            metric for one of the individual stream, for example,
90            maximum bit rate of an individual stream."
91    REVISION        "201103230000Z"
92    DESCRIPTION
93        "Latest version of this MIB module."
94    ::= { ciscoMgmt 771 }
95
96
97-- Textual Conventions definition will be defined before this line
98
99ciscoMediaMetricsMIBNotifs  OBJECT IDENTIFIER
100    ::= { ciscoMediaMetricsMIB 0 }
101
102ciscoMediaMetricsMIBObjects  OBJECT IDENTIFIER
103    ::= { ciscoMediaMetricsMIB 1 }
104
105ciscoMediaMetricsMIBConform  OBJECT IDENTIFIER
106    ::= { ciscoMediaMetricsMIB 2 }
107
108ciscoMediaMetricsMIBIds  OBJECT IDENTIFIER
109    ::= { ciscoMediaMetricsMIB 3 }
110
111ciscoMediaMetricsMIBCompliances  OBJECT IDENTIFIER
112    ::= { ciscoMediaMetricsMIBConform 1 }
113
114cfmMediaMetrics  OBJECT IDENTIFIER
115    ::= { ciscoMediaMetricsMIBObjects 1 }
116
117
118cfmMediaMetricsTable OBJECT-TYPE
119    SYNTAX          SEQUENCE OF CfmMediaMetricsEntry
120    MAX-ACCESS      not-accessible
121    STATUS          current
122    DESCRIPTION
123        "This table contains aggregate data maintained by a flow monitor
124        for traffic flows for which it is computing Media metrics.
125
126        This table has an sparse dependent relationship on the
127        cfmFlowMetricsTable (defined by the CISCO-FLOW-MONITOR-MIB),
128        containing a row for each row in the cfmFlowMetricsTable having
129        a corresponding instance of cfmFlowMetricsCollected with the
130        'media' bit set to one."
131    ::= { cfmMediaMetrics 1 }
132
133cfmMediaMetricsEntry OBJECT-TYPE
134    SYNTAX          CfmMediaMetricsEntry
135    MAX-ACCESS      not-accessible
136    STATUS          current
137    DESCRIPTION
138        "An entry describes cumulative and aggregate Media metrics for a
139        single traffic flow.
140
141        The devices creates a row in the cfmMediaMetricsTable when a flow
142        monitor starts monitoring a traffic flow and has been configured
143        to compute Media metrics for the same traffic flow. Likewise, the
144        device destroys a row in the cfmMediaMetricsTable when the
145        corresponding flow monitor has ceased monitoring the traffic
146        flow (e.g., when a traffic flow has timed out)."
147    INDEX           {
148                        cfmFlowMonitorId,
149                        cfmFlowId
150                    }
151    ::= { cfmMediaMetricsTable 1 }
152
153CfmMediaMetricsEntry ::= SEQUENCE {
154        cfmMediaMetricsValid                 BITS,
155        cfmMediaMetricsPkts                  Counter64,
156        cfmMediaMetricsOctets                Counter64,
157        cfmMediaMetricsBitRateUnits          FlowBitRateUnits,
158        cfmMediaMetricsBitRate               Gauge32,
159        cfmMediaMetricsPktRate               Gauge32,
160        cfmMediaMetricsStreamBitRateUnits    FlowBitRateUnits,
161        cfmMediaMetricsStreamBitRate         Gauge32,
162        cfmMediaMetricsStreamBitRateMaxUnits FlowBitRateUnits,
163        cfmMediaMetricsStreamBitRateMax      Gauge32,
164        cfmMediaMetricsStreamBitRateMinUnits FlowBitRateUnits,
165        cfmMediaMetricsStreamBitRateMin      Gauge32
166}
167
168cfmMediaMetricsValid OBJECT-TYPE
169    SYNTAX          BITS {
170                        pkts(0),
171                        octets(1),
172                        bitRate(2),
173                        pktRate(3),
174                        streamBitRate(4),
175                        streamBitRateMax(5),
176                        streamBitRateMin(6)
177                    }
178    MAX-ACCESS      read-only
179    STATUS          current
180    DESCRIPTION
181        "This object indicates which metrics are valid for the traffic
182        flow:
183
184            'pkts'
185                If this bit is set to '1', then the corresponding
186                instance of cfmMediaMetricsPkts is valid.
187
188            'octets'
189                If this bit is set to '1', then the corresponding
190                instance of cfmMediaMetricsOctets is valid.
191
192            'bitRate'
193                If this bit is set to '1', then the corresponding
194                instances of cfmMediaMetricsBitRateUnits and
195                cfmMediaMetricsBitRate are valid.
196
197            'pktRate'
198                If this bit is set to '1', then the corresponding
199                instance of cfmMediaMetricsPktRate is valid.
200
201            'streamBitRate'
202                If this bit is set to '1', then the corresponding
203                instances of cfmMediaMetricsStreamBitRateUnits and
204                cfmMediaMetricsStreamBitRate are valid.
205
206            'streamBitRateMax'
207                If this bit is set to '1', then the corresponding
208                instances of cfmMediaMetricsStreamBitRateMaxUnits
209                and cfmMediaMetricsStreamBitRateMax are valid.
210
211            'streamBitRateMin'
212                If this bit is set to '1', then the corresponding
213                instances of cfmMediaMetricsStreamBitRateMinUnits
214                and cfmMediaMetricsStreamBitRateMin are valid."
215    ::= { cfmMediaMetricsEntry 1 }
216
217cfmMediaMetricsPkts OBJECT-TYPE
218    SYNTAX          Counter64
219    UNITS           "packets"
220    MAX-ACCESS      read-only
221    STATUS          current
222    DESCRIPTION
223        "This object indicates the total number of packets, containing
224        media payload, processed by the corresponding flow monitor for
225        the corresponding traffic flow."
226    ::= { cfmMediaMetricsEntry 2 }
227
228cfmMediaMetricsOctets OBJECT-TYPE
229    SYNTAX          Counter64
230    UNITS           "octets"
231    MAX-ACCESS      read-only
232    STATUS          current
233    DESCRIPTION
234        "This object indicates the total number of octets representing
235        media payload, processed by the corresponding flow monitor for
236        the corresponding traffic flow."
237    ::= { cfmMediaMetricsEntry 3 }
238
239cfmMediaMetricsBitRateUnits OBJECT-TYPE
240    SYNTAX          FlowBitRateUnits
241    MAX-ACCESS      read-only
242    STATUS          current
243    DESCRIPTION
244        "This object indicates the units for the corresponding instance
245        of cfmMediaMetricsBitRate."
246    ::= { cfmMediaMetricsEntry 4 }
247
248cfmMediaMetricsBitRate OBJECT-TYPE
249    SYNTAX          Gauge32
250    MAX-ACCESS      read-only
251    STATUS          current
252    DESCRIPTION
253        "This object indicates the average bit rate at which the
254        corresponding flow monitor is processing data, containing media
255        payload, for the corresponding traffic flow.  This value is
256        cumulative over the lifetime of the traffic flow."
257    ::= { cfmMediaMetricsEntry 5 }
258
259cfmMediaMetricsPktRate OBJECT-TYPE
260    SYNTAX          Gauge32
261    UNITS           "packets per second"
262    MAX-ACCESS      read-only
263    STATUS          current
264    DESCRIPTION
265        "This object indicates the average packet rate at which the
266        corresponding flow monitor is processing data, containing media
267        payload, for the corresponding traffic flow.  This value is
268        cumulative over the lifetime of the traffic flow."
269    ::= { cfmMediaMetricsEntry 6 }
270
271cfmMediaMetricsStreamBitRateUnits OBJECT-TYPE
272    SYNTAX          FlowBitRateUnits
273    MAX-ACCESS      read-only
274    STATUS          current
275    DESCRIPTION
276        "This object indicates the units for the corresponding instance
277        of cfmMediaMetricsStreamBitRate."
278    ::= { cfmMediaMetricsEntry 7 }
279
280cfmMediaMetricsStreamBitRate OBJECT-TYPE
281    SYNTAX          Gauge32
282    MAX-ACCESS      read-only
283    STATUS          current
284    DESCRIPTION
285        "This object indicates the average of media bit rates of all the
286        individual streams contributing to the traffic flow.  This
287        object is computed by dividing the average media bit rate,
288        indicated by 'cfmMediaMetricsBitRate', by the number of streams
289        which have contributed to the metrics over the lifetime of the
290        traffic flow."
291    ::= { cfmMediaMetricsEntry 8 }
292
293cfmMediaMetricsStreamBitRateMaxUnits OBJECT-TYPE
294    SYNTAX          FlowBitRateUnits
295    MAX-ACCESS      read-only
296    STATUS          current
297    DESCRIPTION
298        "This object indicates the units for the corresponding instance
299        of cfmMediaMetricsStreamBitRateMax."
300    ::= { cfmMediaMetricsEntry 9 }
301
302cfmMediaMetricsStreamBitRateMax OBJECT-TYPE
303    SYNTAX          Gauge32
304    MAX-ACCESS      read-only
305    STATUS          current
306    DESCRIPTION
307        "This object indicates the maximum media bit rate observed,
308        among the individual streams, that have contributed to the
309        metrics over the lifetime of the traffic flow."
310    ::= { cfmMediaMetricsEntry 10 }
311
312cfmMediaMetricsStreamBitRateMinUnits OBJECT-TYPE
313    SYNTAX          FlowBitRateUnits
314    MAX-ACCESS      read-only
315    STATUS          current
316    DESCRIPTION
317        "This object indicates the units for the corresponding instance
318        of cfmMediaMetricsStreamBitRateMin."
319    ::= { cfmMediaMetricsEntry 11 }
320
321cfmMediaMetricsStreamBitRateMin OBJECT-TYPE
322    SYNTAX          Gauge32
323    MAX-ACCESS      read-only
324    STATUS          current
325    DESCRIPTION
326        "This object indicates the minimum media bit rate observed,
327        among the individual streams, that have contributed to the
328        metrics over the lifetime of the traffic flow."
329    ::= { cfmMediaMetricsEntry 12 }
330
331
332
333cfmMediaMetricsTableChanged OBJECT-TYPE
334    SYNTAX          TimeStamp
335    MAX-ACCESS      read-only
336    STATUS          current
337    DESCRIPTION
338        "This object indicates the value of sysUpTime the last time the
339        device created/destroyed a row in the cfmMediaMetricsTable."
340    ::= { cfmMediaMetrics 2 }
341
342cfmMediaMetricsIntTable OBJECT-TYPE
343    SYNTAX          SEQUENCE OF CfmMediaMetricsIntEntry
344    MAX-ACCESS      not-accessible
345    STATUS          current
346    DESCRIPTION
347        "This table contains historic Media metrics for the traffic flows
348        monitored by each of the flow monitors supported by the device.
349
350        This table has an sparse dependent relationship on the
351        cfmFlowMetricsIntTable (defined by the CISCO-FLOW-MONITOR-MIB),
352        containing a row for each row in the cfmFlowMetricsIntTable
353        having a corresponding instance of cfmFlowMetricsCollected with
354        the 'media' bit set to one."
355    ::= { cfmMediaMetrics 3 }
356
357cfmMediaMetricsIntEntry OBJECT-TYPE
358    SYNTAX          CfmMediaMetricsIntEntry
359    MAX-ACCESS      not-accessible
360    STATUS          current
361    DESCRIPTION
362        "An entry describes Media metrics collected for a previous
363        measurement interval for a corresponding traffic flow."
364    INDEX           {
365                        cfmFlowMonitorId,
366                        cfmFlowId,
367                        cfmFlowMetricsIntNumber
368                    }
369    ::= { cfmMediaMetricsIntTable 1 }
370
371CfmMediaMetricsIntEntry ::= SEQUENCE {
372        cfmMediaMetricsIntValid                 BITS,
373        cfmMediaMetricsIntPkts                  ReportIntervalCount,
374        cfmMediaMetricsIntOctets                ReportIntervalCount,
375        cfmMediaMetricsIntBitRateUnits          FlowBitRateUnits,
376        cfmMediaMetricsIntBitRate               ReportIntervalCount,
377        cfmMediaMetricsIntPktRate               ReportIntervalCount,
378        cfmMediaMetricsIntStreamBitRateUnits    FlowBitRateUnits,
379        cfmMediaMetricsIntStreamBitRate         ReportIntervalCount,
380        cfmMediaMetricsIntStreamBitRateMaxUnits FlowBitRateUnits,
381        cfmMediaMetricsIntStreamBitRateMax      Gauge32,
382        cfmMediaMetricsIntStreamBitRateMinUnits FlowBitRateUnits,
383        cfmMediaMetricsIntStreamBitRateMin      Gauge32
384}
385
386cfmMediaMetricsIntValid OBJECT-TYPE
387    SYNTAX          BITS {
388                        pkts(0),
389                        octets(1),
390                        bitRate(2),
391                        pktRate(3),
392                        streamBitRate(4),
393                        streamBitRateMax(5),
394                        streamBitRateMin(6)
395                    }
396    MAX-ACCESS      read-only
397    STATUS          current
398    DESCRIPTION
399        "This object indicates which metrics are valid for the
400        measurement interval:
401
402            'pkts'
403                If this bit is set to '1', then the corresponding
404                instance of cfmMediaMetricsIntPkts is valid.
405
406            'octets'
407                If this bit is set to '1', then the corresponding
408                instance of cfmMediaMetricsIntOctets is valid.
409
410            'bitRate'
411                If this bit is set to '1', then the corresponding
412                instances of cfmMediaMetricsIntBitRateUnits and
413                cfmMediaMetricsIntBitRate are valid.
414
415            'pktRate'
416                If this bit is set to '1', then the corresponding
417                instance of cfmMediaMetricsIntPktRate is valid.
418
419            'streamBitRate'
420                If this bit is set to '1', then the corresponding
421                instances of cfmMediaMetricsIntStreamBitRateUnits
422                and cfmMediaMetricsIntStreamBitRate are valid.
423
424            'streamBitRateMax'
425                If this bit is set to '1', then the corresponding
426                instances of cfmMediaMetricsIntStreamBitRateMaxUnits
427                and cfmMediaMetricsIntStreamBitRateMax are valid.
428
429            'streamBitRateMin'
430                If this bit is set to '1', then the corresponding
431                instances of cfmMediaMetricsIntStreamBitRateMinUnits
432                and cfmMediaMetricsIntStreamBitRateMin are valid."
433    ::= { cfmMediaMetricsIntEntry 1 }
434
435cfmMediaMetricsIntPkts OBJECT-TYPE
436    SYNTAX          ReportIntervalCount
437    UNITS           "packets"
438    MAX-ACCESS      read-only
439    STATUS          current
440    DESCRIPTION
441        "This object indicates the total number of packets, containing
442        media payload, processed by the corresponding flow monitor for
443        the corresponding traffic flow during the measurement interval."
444    ::= { cfmMediaMetricsIntEntry 2 }
445
446cfmMediaMetricsIntOctets OBJECT-TYPE
447    SYNTAX          ReportIntervalCount
448    UNITS           "octets"
449    MAX-ACCESS      read-only
450    STATUS          current
451    DESCRIPTION
452        "This object indicates the total number of octets contained by
453        the packets, representing media payload, processed by the
454        corresponding flow monitor for the corresponding traffic flow
455        during the measurement interval."
456    ::= { cfmMediaMetricsIntEntry 3 }
457
458cfmMediaMetricsIntBitRateUnits OBJECT-TYPE
459    SYNTAX          FlowBitRateUnits
460    MAX-ACCESS      read-only
461    STATUS          current
462    DESCRIPTION
463        "This object indicates the units for the corresponding instance
464        of cfmMediaMetricsIntBitRate."
465    ::= { cfmMediaMetricsIntEntry 4 }
466
467cfmMediaMetricsIntBitRate OBJECT-TYPE
468    SYNTAX          ReportIntervalCount
469    MAX-ACCESS      read-only
470    STATUS          current
471    DESCRIPTION
472        "This object indicates the average bit rate at which the
473        corresponding flow monitor processed data, containing media
474        payload, for the corresponding traffic flow during the
475        measurement interval."
476    ::= { cfmMediaMetricsIntEntry 5 }
477
478cfmMediaMetricsIntPktRate OBJECT-TYPE
479    SYNTAX          ReportIntervalCount
480    UNITS           "packets per second"
481    MAX-ACCESS      read-only
482    STATUS          current
483    DESCRIPTION
484        "This object indicates the average packet rate at which the
485        corresponding flow monitor processed data, containing media
486        payload, for the corresponding traffic flow during the
487        measurement interval."
488    ::= { cfmMediaMetricsIntEntry 6 }
489
490cfmMediaMetricsIntStreamBitRateUnits OBJECT-TYPE
491    SYNTAX          FlowBitRateUnits
492    MAX-ACCESS      read-only
493    STATUS          current
494    DESCRIPTION
495        "This object indicates the units for the corresponding instance
496        of cfmMediaMetricsIntStreamBitRate."
497    ::= { cfmMediaMetricsIntEntry 7 }
498
499cfmMediaMetricsIntStreamBitRate OBJECT-TYPE
500    SYNTAX          ReportIntervalCount
501    MAX-ACCESS      read-only
502    STATUS          current
503    DESCRIPTION
504        "This object indicates the average of media bit rates of all the
505        individual streams which contributed to the traffic flow during
506        measurement interval."
507    ::= { cfmMediaMetricsIntEntry 8 }
508
509cfmMediaMetricsIntStreamBitRateMaxUnits OBJECT-TYPE
510    SYNTAX          FlowBitRateUnits
511    MAX-ACCESS      read-only
512    STATUS          current
513    DESCRIPTION
514        "This object indicates the units for the corresponding instance
515        of cfmMediaMetricsIntStreamBitRateMax."
516    ::= { cfmMediaMetricsIntEntry 9 }
517
518cfmMediaMetricsIntStreamBitRateMax OBJECT-TYPE
519    SYNTAX          Gauge32
520    MAX-ACCESS      read-only
521    STATUS          current
522    DESCRIPTION
523        "This object indicates the maximum media bit rate observed,
524        among the individual streams, which contributed to the traffic
525        flow during the measurement interval."
526    ::= { cfmMediaMetricsIntEntry 10 }
527
528cfmMediaMetricsIntStreamBitRateMinUnits OBJECT-TYPE
529    SYNTAX          FlowBitRateUnits
530    MAX-ACCESS      read-only
531    STATUS          current
532    DESCRIPTION
533        "This object indicates the units for the corresponding instance
534        of cfmMediaMetricsIntStreamBitRateMin."
535    ::= { cfmMediaMetricsIntEntry 11 }
536
537cfmMediaMetricsIntStreamBitRateMin OBJECT-TYPE
538    SYNTAX          Gauge32
539    MAX-ACCESS      read-only
540    STATUS          current
541    DESCRIPTION
542        "This object indicates the minimum media bit rate observed,
543        among the individual streams, which contributed to the traffic
544        flow during the measurement interval."
545    ::= { cfmMediaMetricsIntEntry 12 }
546
547
548ciscoMediaMetricsMIBGroups  OBJECT IDENTIFIER
549    ::= { ciscoMediaMetricsMIBConform 2 }
550
551
552ciscoMediaMetricsMIBCompliance01 MODULE-COMPLIANCE
553    STATUS          current
554    DESCRIPTION
555        "This compliance statement specifies the minimal requirements an
556        implementation must meet in order to claim full compliance with
557        the definition of the CISCO-MEDIA-METRICS-MIB."
558    MODULE          -- this module
559    MANDATORY-GROUPS { ciscoMediaMetricsGroup }
560    ::= { ciscoMediaMetricsMIBCompliances 1 }
561
562-- Units of Conformance
563
564ciscoMediaMetricsGroup OBJECT-GROUP
565    OBJECTS         {
566                        cfmMediaMetricsValid,
567                        cfmMediaMetricsPkts,
568                        cfmMediaMetricsOctets,
569                        cfmMediaMetricsBitRateUnits,
570                        cfmMediaMetricsBitRate,
571                        cfmMediaMetricsPktRate,
572                        cfmMediaMetricsStreamBitRateUnits,
573                        cfmMediaMetricsStreamBitRate,
574                        cfmMediaMetricsStreamBitRateMaxUnits,
575                        cfmMediaMetricsStreamBitRateMax,
576                        cfmMediaMetricsStreamBitRateMinUnits,
577                        cfmMediaMetricsStreamBitRateMin,
578                        cfmMediaMetricsTableChanged,
579                        cfmMediaMetricsIntValid,
580                        cfmMediaMetricsIntPkts,
581                        cfmMediaMetricsIntOctets,
582                        cfmMediaMetricsIntBitRateUnits,
583                        cfmMediaMetricsIntBitRate,
584                        cfmMediaMetricsIntPktRate,
585                        cfmMediaMetricsIntStreamBitRateUnits,
586                        cfmMediaMetricsIntStreamBitRate,
587                        cfmMediaMetricsIntStreamBitRateMaxUnits,
588                        cfmMediaMetricsIntStreamBitRateMax,
589                        cfmMediaMetricsIntStreamBitRateMinUnits,
590                        cfmMediaMetricsIntStreamBitRateMin
591                    }
592    STATUS          current
593    DESCRIPTION
594        "This group contains objects that describe Media metrics."
595    ::= { ciscoMediaMetricsMIBGroups 1 }
596
597END
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614