1 FEEDBACK-FRAMEWORK-PIB PIB-DEFINITIONS ::= BEGIN
5 Unsigned32, Unsigned64,
6 Integer32, Integer64, MODULE-IDENTITY, OBJECT-TYPE, pib
8 TruthValue, TEXTUAL-CONVENTION
10 InstanceId, ReferenceId, TagReferenceId, TagId, Prid
13 FROM POLICY-DEVICE-AUX-MIB
19 feedbackPolFrameworkPib MODULE-IDENTITY
20 SUBJECT-CATEGORIES { all }
21 LAST-UPDATED "200011171000Z"
22 ORGANIZATION "IETF RAP WG"
26 901 International Parkway
29 Email: diana.rawlins@wcom.com
34 Hillsboro, Oregon 97124
36 Email: amol.kulkarni@intel.com
40 600 Technology Park Drive
41 Billerica, MA 01821 USA
43 Email: khchan@nortelnetworks.com
47 Kanata, ON, K2V 1C3, Canada
49 Email: mbokaemper@unispherenetworks.com"
53 "The PIB module containing the base set of policy rule
54 classes that are required for support of all policy
55 usage monitoring, tracking and reporting policies"
57 ::= { ibrpib 7 } -- to be assigned by IANA
59 -- The feedback report group
62 frwkFeedbackGroupClasses
63 OBJECT IDENTIFIER ::= { feedbackPolFrameworkPib 1 }
66 -- Feedback Action Table
69 frwkFeedbackActionTable OBJECT-TYPE
70 SYNTAX SEQUENCE OF FrwkFeedbackActionEntry
74 "This class contains a single PRI that indicates
75 that the PEP is to resume the sending of
76 feedback type reports."
78 ::= { frwkFeedbackGroupClasses 1}
80 frwkFeedbackActionEntry OBJECT-TYPE
81 SYNTAX FrwkFeedbackActionEntry
84 "An instance of this class can indicates a action
85 the PEP is to take regarding the usage policies."
86 PIB-INDEX { frwkFeedbackActionId}
88 ::= { frwkFeedbackActionTable 1}
90 FrwkFeedbackActionEntry ::= SEQUENCE {
91 frwkFeedbackActionId InstanceId,
92 frwkFeedbackActionIndicator INTEGER,
93 frwkFeedbackActionSpecificPri INTEGER,
94 frwkFeedbackActionList TagReferenceId
97 frwkFeedbackActionId OBJECT-TYPE
101 " An arbitrary integer index that uniquely identifies an
102 instance of the frwkFeedbackActionTable class."
104 ::= { frwkFeedbackActionEntry 1}
106 frwkFeedbackActionIndicator OBJECT-TYPE
108 suspendUsageMonitoringAndReports(0),
109 suspendReportsOnly(1),
110 resumeUsageAndReporting(2),
111 solicitUsageReportNow(3)
115 "The value indicates if the PEP is to send cached
116 usage policies via feedback type report messages.
117 The enumeration values are:
118 (0) SUSPEND USAGE MONITORING_AND_REPORTS
119 (1) SUSPEND_REPORTS_ONLY
120 (2) RESUME_USAGE AND REPORTING
121 (3) SOLICIT USAGE REPORT NOW "
123 ::= { frwkFeedbackActionEntry 2 }
125 frwkFeedbackActionSpecificPri OBJECT-TYPE
129 "A value of 0 indicates that the
130 frwkFeedbackActionListId attribute should be
131 ignored, and the action applied to all policies. A
132 value of 1 indicates that the action entry has a
133 specific list of policies to which it is to be
135 ::= { frwkFeedbackActionEntry 3}
137 frwkFeedbackActionList OBJECT-TYPE
138 SYNTAX TagReferenceId
139 PIB-TAG { frwkFeedbackActionListGroup }
142 "Identifies a list of
143 frwkFeedbackActionListTable instances
144 associated with the action described by
146 ::= { frwkFeedbackActionEntry 4}
149 -- Feedback Action List Table
151 frwkFeedbackActionListTable OBJECT-TYPE
152 SYNTAX SEQUENCE OF FrwkFeedbackActionListEntry
156 "This class contains the PRIDs of the
157 linkage instance which are to be impacted by
158 the frwkFeedbackActionIndicator for this
160 ::= { frwkFeedbackGroupClasses 2}
162 frwkFeedbackActionListEntry OBJECT-TYPE
163 SYNTAX FrwkFeedbackActionListEntry
166 "This class identifies a set of linkage instances
167 for which the PDP is suspending, resuming or
168 soliciting usage feedback."
170 PIB-INDEX {frwkFeedbackActionListId }
171 UNIQUENESS { frwkFeedbackActionListGroup,
172 frwkFeedbackActionListPRID
174 ::= { frwkFeedbackActionListTable 1}
176 FrwkFeedbackActionListEntry::= SEQUENCE {
177 frwkFeedbackActionListId InstanceId,
178 frwkFeedbackActionListGroup TagId,
179 frwkFeedbackActionListPRID Prid
182 frwkFeedbackActionListId OBJECT-TYPE
186 "Arbitrary integer index that uniquely
187 identifies an instance of the class."
189 ::= { frwkFeedbackActionListEntry 1 }
191 frwkFeedbackActionListGroup OBJECT-TYPE
195 "Represents the binding between the Action
196 table entry and the Action List table entries"
197 ::= { frwkFeedbackActionListEntry 2 }
199 frwkFeedbackActionListPRID OBJECT-TYPE
203 "The PRID of the linkage instance(s) belonging
204 to the list of instances identified by the
205 list id upon which the suspend, resume or
206 solicit action is directed."
208 ::= { frwkFeedbackActionListEntry 3 }
211 -- The Feedback Selection Usage Combination Capability Table
214 frwkFeedbackSelUsageComboCapsTable OBJECT-TYPE
215 SYNTAX SEQUENCE OF FrwkFeedbackSelUsageComboCapsEntry
219 "This table defines the valid combinations of the
220 selection criteria PRCs, the usage PRCs and the
221 threshold PRCs that the PEP supports."
222 ::= { frwkFeedbackGroupClasses 3}
225 frwkFeedbackSelUsageComboCapsEntry OBJECT-TYPE
226 SYNTAX FrwkFeedbackSelUsageComboCapsEntry
229 "The attributes of this class identify valid
230 combinations of selection criteria, usage and
231 threshold PRCs for feedback supported by the PEP
233 PIB-INDEX {frwkFeedbackSelUsageComboCapId}
234 UNIQUENESS { frwkFeedbackSelUsageComboCapId,
235 frwkFeedbackSelUsageComboCapSelection,
236 frwkFeedbackSelUsageComboCapUsage,
237 frwkFeedbackSelUsageComboCapThreshold
239 ::= {frwkFeedbackSelUsageComboCapsTable 1}
241 FrwkFeedbackSelUsageComboCapsEntry ::= SEQUENCE {
242 frwkFeedbackSelUsageComboCapId InstanceId,
243 frwkFeedbackSelUsageComboCapSelection OBJECT IDENTIFIER,
244 frwkFeedbackSelUsageComboCapUsage OBJECT IDENTIFIER,
245 frwkFeedbackSelUsageComboCapThreshold OBJECT IDENTIFIER
248 frwkFeedbackSelUsageComboCapId OBJECT-TYPE
252 " An arbitrary integer index that uniquely identifies an
253 instance of the frwkFeedbackSelUsageComboCapsEntry
255 ::= { frwkFeedbackSelUsageComboCapsEntry 1}
257 frwkFeedbackSelUsageComboCapSelection OBJECT-TYPE
258 SYNTAX OBJECT IDENTIFIER
261 "The PRC of the selection class that is supported by
262 the device in the combination defined by this instance."
263 ::= { frwkFeedbackSelUsageComboCapsEntry 2}
265 frwkFeedbackSelUsageComboCapUsage OBJECT-TYPE
266 SYNTAX OBJECT IDENTIFIER
269 "The PRC of the usage policy class that is supported by
270 the device in combination with the selection PRC and the
271 threshold PRC defined in this instance."
272 ::= { frwkFeedbackSelUsageComboCapsEntry 3}
275 frwkFeedbackSelUsageComboCapThreshold OBJECT-TYPE
276 SYNTAX OBJECT IDENTIFIER
279 "The PRC of the threshold class that is supported by
280 the device in the combination defined by this instance."
281 ::= { frwkFeedbackSelUsageComboCapsEntry 4}
284 -- The Feedback Report Linkage Table
287 frwkFeedbackLinkTable OBJECT-TYPE
288 SYNTAX SEQUENCE OF FrwkFeedbackLinkEntry
292 "This class associates the selection criteria with the
293 usage policy. It also permit the defining of the max
294 interval used for reporting the usage instance."
296 ::= { frwkFeedbackGroupClasses 4}
298 frwkFeedbackLinkEntry OBJECT-TYPE
299 SYNTAX FrwkFeedbackLinkEntry
302 "This class associates the selection criteria with the
303 usage policy. It also permits the defining of the max
304 interval used for reporting the usage instance."
305 PIB-INDEX {frwkFeedbackLinkId}
306 UNIQUENESS { frwkFeedbackLinkId,
308 frwkFeedbackLinkUsage }
309 ::= {frwkFeedbackLinkTable 1}
311 FrwkFeedbackLinkEntry ::= SEQUENCE {
312 frwkFeedbackLinkId InstanceId,
313 frwkFeedbackLinkSel Prid,
314 frwkFeedbackLinkUsage OBJECT IDENTIFIER,
315 frwkFeedbackLinkInterval Integer32,
316 frwkFeedbackLinkThreshold Prid,
317 frwkFeedbackLinkFlags BITS
320 frwkFeedbackLinkId OBJECT-TYPE
324 " An arbitrary integer index that uniquely identifies an
325 instance of the frwkFeedbackLinkTable class."
326 ::= { frwkFeedbackLinkEntry 1}
328 frwkFeedbackLinkSel OBJECT-TYPE
332 "The PRID of the selection criteria instance that
333 defines the conditions to use by the PEP for
334 monitoring the usage."
336 ::= { frwkFeedbackLinkEntry 2}
338 frwkFeedbackLinkUsage OBJECT-TYPE
339 SYNTAX OBJECT IDENTIFIER
342 "The PRC of the usage policy class that the PEP uses to
343 monitor, record and report."
345 ::= { frwkFeedbackLinkEntry 3}
347 frwkFeedbackLinkInterval OBJECT-TYPE
351 "Maximum interval in units of the value of the
352 Accounting Timer specified by the PDP in the client
353 accept message. A frwkFeedbackLinkInterval of 1 is
354 equal to the value of the Accounting Timer. This value
355 must be 1 or greater. "
357 ::= { frwkFeedbackLinkEntry 4}
359 frwkFeedbackLinkThreshold OBJECT-TYPE
363 "The PRID of the threshold class instance. This
364 instance specifies the threshold values for the usage
366 ::= { frwkFeedbackLinkEntry 5}
368 frwkFeedbackLinkFlags OBJECT-TYPE
376 "This value indicates the reporting basis of the usage
377 policy. The feed back may be generated on demand, on a
378 periodic basis regardless of a change in value from the
379 previous report, on a periodic basis if a change in
380 value has occurred, or the usage is reported when an
381 identified threshold value in the usage instance has
383 If the 'periodic' flag is set, the PEP will provide
384 unsolicited reports at the rate specified in
385 frwkFeedbackLinkInterval.
386 If the 'periodic' flag is not set, reports will only be
387 generated when solicited by the PDP.
388 The 'threshold' and 'changeOnly' flags make the
389 periodic reports conditional - these flags only make
390 sense in combination with the 'periodic' flag."
392 ::= { frwkFeedbackLinkEntry 6}
396 -- All actual usage classes are in the separate
397 -- FrwkFeedbackUsageClasses group
400 frwkFeedbackUsageClasses
401 OBJECT IDENTIFIER ::= { feedbackPolFrameworkPib 2 }
405 -- The generic traffic (byte & packet count) usage class
408 frwkFeedbackTrafficUsageTable OBJECT-TYPE
409 SYNTAX SEQUENCE OF FrwkFeedbackTrafficUsageEntry
410 PIB-ACCESS report-only
413 "This class defines the usage attributes that the PEP
414 is to monitor for plain traffic handling elements
415 like filters. All packets and the bytes contained in
416 these packets are counted. It also contains the PRID
417 of the linkage instance associating the selection
418 criteria instance with the usage instance."
420 ::= { frwkFeedbackUsageClasses 1}
422 frwkFeedbackTrafficUsageEntry OBJECT-TYPE
423 SYNTAX FrwkFeedbackTrafficUsageEntry
426 "Defines the attributes the PEP is to monitor,
428 PIB-INDEX {frwkFeedbackTrafficUsageId}
429 UNIQUENESS { frwkFeedbackTrafficUsageLinkPRID }
431 ::= {frwkFeedbackTrafficUsageTable 1}
433 FrwkFeedbackTrafficUsageEntry ::= SEQUENCE {
434 frwkFeedbackTrafficUsageId InstanceId,
435 frwkFeedbackTrafficUsageLinkPRID Prid,
436 frwkFeedbackTrafficUsagePacketCount Counter64,
437 frwkFeedbackTrafficUsageByteCount Counter64
441 frwkFeedbackTrafficUsageId OBJECT-TYPE
445 "Arbitrary integer index that uniquely identifies
446 an instance of the class."
447 ::= { frwkFeedbackTrafficUsageEntry 1 }
449 frwkFeedbackTrafficUsageLinkPRID OBJECT-TYPE
453 "The PRID of the Linkage policy instance used to base
454 this usage policy instance upon."
456 ::= { frwkFeedbackTrafficUsageEntry 2 }
458 frwkFeedbackTrafficUsagePacketCount OBJECT-TYPE
462 "The count of packets handled by the associated
463 element during the reporting interval."
465 ::= {frwkFeedbackTrafficUsageEntry 3}
467 frwkFeedbackTrafficUsageByteCount OBJECT-TYPE
471 "The byte count of packets handled by the associated
473 ::= { frwkFeedbackTrafficUsageEntry 4}
478 -- The traffic usage class, qualified for an interface
481 frwkFeedbackIfTrafficUsageTable OBJECT-TYPE
482 SYNTAX SEQUENCE OF FrwkFeedbackIfTrafficUsageEntry
483 PIB-ACCESS report-only
486 "A usage PRC similar to the basic TrafficUsage class
487 that also contains a reference to an interface. This
488 class should be used with a selection criteria that
489 matches an element that is assigned to multiple
490 interfaces. The interface field can be used to
491 associate the instances of this class with the specific
492 element's assignment."
493 ::= { frwkFeedbackUsageClasses 2 }
495 frwkFeedbackIfTrafficUsageEntry OBJECT-TYPE
496 SYNTAX FrwkFeedbackIfTrafficUsageEntry
499 "Defines the attributes the PEP is to monitor,
501 PIB-INDEX {frwkFeedbackIfTrafficUsageId}
502 UNIQUENESS { frwkFeedbackIfTrafficUsageLinkPRID,
503 frwkFeedbackIfTrafficUsageInterface }
505 ::= {frwkFeedbackIfTrafficUsageTable 1}
507 FrwkFeedbackIfTrafficUsageEntry ::= SEQUENCE {
508 frwkFeedbackIfTrafficUsageId InstanceId,
509 frwkFeedbackIfTrafficUsageLinkPRID Prid,
510 frwkFeedbackIfTrafficUsageInterface Prid,
511 frwkFeedbackIfTrafficUsagePacketCount Counter64,
512 frwkFeedbackIfTrafficUsageByteCount Counter64
516 frwkFeedbackIfTrafficUsageId OBJECT-TYPE
520 "Arbitrary integer index that uniquely identifies
521 an instance of the class."
522 ::= { frwkFeedbackIfTrafficUsageEntry 1 }
524 frwkFeedbackIfTrafficUsageLinkPRID OBJECT-TYPE
528 "The PRID of the Linkage policy instance used to base
529 this usage policy instance upon."
530 ::= { frwkFeedbackIfTrafficUsageEntry 2 }
532 frwkFeedbackIfTrafficUsageInterface OBJECT-TYPE
536 "The PRID of a frwkIfRoleCombo instance, uniquely
537 identifying a specific interface."
538 ::= { frwkFeedbackIfTrafficUsageEntry 3 }
540 frwkFeedbackIfTrafficUsagePacketCount OBJECT-TYPE
544 "The count of packets handled by the associated element
545 during the reporting interval."
546 ::= { frwkFeedbackIfTrafficUsageEntry 4 }
548 frwkFeedbackIfTrafficUsageByteCount OBJECT-TYPE
552 "The byte count of packets
553 handled by the associated element."
554 ::= { frwkFeedbackIfTrafficUsageEntry 5 }
559 -- The Threshold class that accompanies the above Usage PRCs
562 frwkFeedbackTrafficThresholdTable OBJECT-TYPE
563 SYNTAX SEQUENCE OF FrwkFeedbackTrafficThresholdEntry
567 "This class defines the threshold attributes
568 corresponding to usage attributes specified in
569 frwkFeedbackTrafficUsageTable,
570 frwkFeedbackIfTrafficUsageTable and other similar
572 The usage object is considered to match the threshold
573 condition if the following expression evaluates to
576 byteCond = (ByteThreshold != NULL) ?
577 (ByteThreshold > ByteCounter) : FALSE;
578 packetCond (PacketThreshold != NULL) ?
579 (PacketThreshold > PacketCounter) : FALSE;
580 return ( byteCond || packetCond );
583 ::= { frwkFeedbackUsageClasses 3}
585 frwkFeedbackTrafficThresholdEntry OBJECT-TYPE
586 SYNTAX FrwkFeedbackTrafficThresholdEntry
589 "Defines the attributes to hold threshold values."
590 PIB-INDEX {frwkFeedbackTrafficThresholdId}
592 ::= {frwkFeedbackTrafficThresholdTable 1}
594 FrwkFeedbackTrafficThresholdEntry ::= SEQUENCE {
595 frwkFeedbackTrafficThresholdId InstanceId,
596 frwkFeedbackTrafficThresholdPacketThreshold Integer64,
597 frwkFeedbackTrafficThresholdByteThreshold Integer64
600 frwkFeedbackTrafficThresholdId OBJECT-TYPE
604 "Arbitrary integer index that uniquely identifies
605 an instance of the class."
606 ::= { frwkFeedbackTrafficThresholdEntry 1 }
608 frwkFeedbackTrafficThresholdPacketThreshold OBJECT-TYPE
612 "The threshold, in terms of packets, that must be
613 exceeded to trigger a report in the next
615 ::= { frwkFeedbackTrafficThresholdEntry 2 }
617 frwkFeedbackTrafficThresholdByteThreshold OBJECT-TYPE
621 "The threshold, in terms of bytes, that must be
622 exceeded to trigger a report in the next
624 ::= { frwkFeedbackTrafficThresholdEntry 3 }
628 -- All Selection classes are in the separate
629 -- FrwkFeedbackSelectionClasses group
632 frwkFeedbackSelectionClasses
633 OBJECT IDENTIFIER ::= { feedbackPolFrameworkPib 3 }
636 -- The Set WatchPoint Table
639 frwkFeedbackSetWatchPointTable OBJECT-TYPE
640 SYNTAX SEQUENCE OF FrwkFeedbackSetWatchPointEntry
644 "This class defines a selection criteria that
645 identifies a specific processing point to watch
646 for the desired usage. This selection criteria
647 may be useful in PIBs that are designed using a
648 datapath approach where the policies are linked
649 and can be reused within the PIB."
651 ::= { frwkFeedbackSelectionClasses 1}
653 frwkFeedbackSetWatchPointEntry OBJECT-TYPE
654 SYNTAX FrwkFeedbackSetWatchPointEntry
657 "Defines the attributes the of the selection
658 criteria identifying a specific policy
659 where to monitor the associated usage."
660 PIB-INDEX { frwkFeedbackSetWatchPointId }
663 ::= {frwkFeedbackSetWatchPointTable 1}
665 FrwkFeedbackSetWatchPointEntry ::= SEQUENCE {
666 frwkFeedbackSetWatchPointId InstanceId,
667 frwkFeedbackSetWatchPointPolicyPRID Prid
671 frwkFeedbackSetWatchPointId OBJECT-TYPE
675 "Arbitrary integer index that uniquely identifies
676 an instance of the class."
677 ::= { frwkFeedbackSetWatchPointEntry 1 }
679 frwkFeedbackSetWatchPointPolicyPRID OBJECT-TYPE
683 "The PRID of the enforcement policy instance where
684 the associated usage is to be monitored."
686 ::= { frwkFeedbackSetWatchPointEntry 2 }
690 -- DPE Selection Class
693 frwkFeedbackDPESelectionTable OBJECT-TYPE
694 SYNTAX SEQUENCE OF FrwkFeedbackDPESelectionEntry
698 "This class defines a selection criteria that
699 identifies a specific data path element to collect
702 ::= { frwkFeedbackSelectionClasses 2}
704 frwkFeedbackDPESelectionEntry OBJECT-TYPE
705 SYNTAX FrwkFeedbackDPESelectionEntry
708 "Defines the attributes the of the selection
709 criteria identifying a specific policy
710 where to monitor the associated usage."
711 PIB-INDEX { frwkFeedbackDPESelectionId }
712 UNIQUENESS { frwkFeedbackDPESelectionDataPathElement,
713 frwkFeedbackDPESelectionInterface,
714 frwkFeedbackDPESelectionIfDirection }
716 ::= {frwkFeedbackDPESelectionTable 1}
718 FrwkFeedbackDPESelectionEntry ::= SEQUENCE {
719 frwkFeedbackDPESelectionId InstanceId,
720 frwkFeedbackDPESelectionDataPathElement Prid,
721 frwkFeedbackDPESelectionInterface Prid,
722 frwkFeedbackDPESelectionIfDirection IfDirection
725 frwkFeedbackDPESelectionId OBJECT-TYPE
729 "Arbitrary integer index that uniquely identifies
730 an instance of the class."
731 ::= { frwkFeedbackDPESelectionEntry 1 }
734 frwkFeedbackDPESelectionDataPathElement OBJECT-TYPE
738 "The PRID of the element in the data path that we
739 want to collect usage information from. This element
740 must be part of the data path assigned to the
741 interface/direction combination referenced in this
743 ::= { frwkFeedbackDPESelectionEntry 2 }
745 frwkFeedbackDPESelectionInterface OBJECT-TYPE
749 "The PRID of a frwkIfRoleCombo instance, uniquely
750 identifying a specific interface"
751 ::= { frwkFeedbackDPESelectionEntry 3 }
753 frwkFeedbackDPESelectionIfDirection OBJECT-TYPE
757 "The direction (ingress/egress) that to which the DPE
758 is attached that we want to match."
759 ::= { frwkFeedbackDPESelectionEntry 4 }
763 -- DPE Selection Query Class
766 frwkFeedbackDPESelectionQueryTable OBJECT-TYPE
767 SYNTAX SEQUENCE OF FrwkFeedbackDPESelectionQueryEntry
771 "This class defines a selection criteria that
772 identifies a set of assignments of a data path element
773 based on an entry in the Data Path Table
774 Each matched assignment will collect and report usage
775 independently, so this selection criteria should be
776 combined with a Usage PRC that includes an interface
779 ::= { frwkFeedbackSelectionClasses 3}
781 frwkFeedbackDPESelectionQueryEntry OBJECT-TYPE
782 SYNTAX FrwkFeedbackDPESelectionQueryEntry
785 "Defines the attributes the of the selection
786 criteria identifying a specific policy
787 where to monitor the associated usage."
788 PIB-INDEX { frwkFeedbackDPESelectionQueryId }
789 UNIQUENESS { frwkFeedbackDPESelectionQueryDataPath,
790 frwkFeedbackDPESelectionQueryDataPathElement }
792 ::= {frwkFeedbackDPESelectionQueryTable 1}
794 FrwkFeedbackDPESelectionQueryEntry ::= SEQUENCE {
795 frwkFeedbackDPESelectionQueryId InstanceId,
796 frwkFeedbackDPESelectionQueryDataPath Prid,
797 frwkFeedbackDPESelectionQueryDataPathElement Prid
800 frwkFeedbackDPESelectionQueryId OBJECT-TYPE
804 "Arbitrary integer index that uniquely identifies
805 an instance of the class."
806 ::= { frwkFeedbackDPESelectionQueryEntry 1 }
808 frwkFeedbackDPESelectionQueryDataPath OBJECT-TYPE
812 "The PRID of a Data Path instance, identifying a
813 group of data path assignments."
814 ::= { frwkFeedbackDPESelectionQueryEntry 2 }
816 frwkFeedbackDPESelectionQueryDataPathElement OBJECT-TYPE
820 "The PRID of the element in the data path that we
821 want to collect usage information from. This element
822 must be part of the data path referenced from the
823 frwkFeedbackDPESelectionQueryDataPath field."
824 ::= { frwkFeedbackDPESelectionQueryEntry 3 }