summaryrefslogtreecommitdiff
path: root/doc/rfc/rfc6727.txt
blob: de0f8bffde44a7e1f41ae931bec5ef8620499831 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
Internet Engineering Task Force (IETF)                     T. Dietz, Ed.
Request for Comments: 6727                               NEC Europe Ltd.
Category: Standards Track                                      B. Claise
ISSN: 2070-1721                                      Cisco Systems, Inc.
                                                              J. Quittek
                                                         NEC Europe Ltd.
                                                            October 2012


           Definitions of Managed Objects for Packet Sampling

Abstract

   This memo defines a portion of the Management Information Base (MIB)
   for use with network management protocols in the Internet community.
   In particular, it describes extensions to the IPFIX-SELECTOR-MIB
   module.  For IP Flow Information eXport (IPFIX) implementations that
   use Packet Sampling (PSAMP) techniques, this memo defines the PSAMP-
   MIB module containing managed objects for providing information on
   applied packet selection functions and their parameters.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 5741.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   http://www.rfc-editor.org/info/rfc6727.

















Dietz, et al.                Standards Track                    [Page 1]
^L
RFC 6727                        PSAMP MIB                   October 2012


Copyright Notice

   Copyright (c) 2012 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  The Internet-Standard Management Framework . . . . . . . . . .  3
   2.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
   3.  Overview of PSAMP Documents  . . . . . . . . . . . . . . . . .  4
   4.  Related IPFIX Documents  . . . . . . . . . . . . . . . . . . .  4
   5.  Structure of the PSAMP MIB module  . . . . . . . . . . . . . .  4
     5.1.  Textual Conventions  . . . . . . . . . . . . . . . . . . .  5
     5.2.  Packet Selection Functions . . . . . . . . . . . . . . . .  6
       5.2.1.  Systematic Count-Based Sampling  . . . . . . . . . . .  6
       5.2.2.  Systematic Time-Based Sampling . . . . . . . . . . . .  6
       5.2.3.  Random n-out-of-N Sampling . . . . . . . . . . . . . .  7
       5.2.4.  Uniform Probabilistic Sampling . . . . . . . . . . . .  7
       5.2.5.  Property Match Filtering . . . . . . . . . . . . . . .  7
       5.2.6.  Hash-Based Filtering . . . . . . . . . . . . . . . . .  8
   6.  Definitions  . . . . . . . . . . . . . . . . . . . . . . . . .  9
   7.  Security Considerations  . . . . . . . . . . . . . . . . . . . 25
   8.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 25
   9.  Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . 26
   10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 26
     10.1. Normative References . . . . . . . . . . . . . . . . . . . 26
     10.2. Informative References . . . . . . . . . . . . . . . . . . 27














Dietz, et al.                Standards Track                    [Page 2]
^L
RFC 6727                        PSAMP MIB                   October 2012


1.  The Internet-Standard Management Framework

   For a detailed overview of the documents that describe the current
   Internet-Standard Management Framework, please refer to section 7 of
   RFC 3410 [RFC3410].

   Managed objects are accessed via a virtual information store, termed
   the Management Information Base or MIB.  MIB objects are generally
   accessed through the Simple Network Management Protocol (SNMP).
   Objects in the MIB are defined using the mechanisms defined in the
   Structure of Management Information (SMI).  This memo specifies a MIB
   module that is compliant to the SMIv2, which is described in STD 58,
   RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58,RFC 2580
   [RFC2580].

2.  Introduction

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in RFC
   2119 [RFC2119].

   This document is a product of the IP Flow Information eXport (IPFIX)
   Working Group (WG).  Work on this document was started in the Packet
   Sampling (PSAMP) WG and moved to the IPFIX WG when the PSAMP WG was
   concluded.

   Its purpose is to define managed objects for monitoring, PSAMP
   Devices performing packet selection by Sampling and Filtering as
   described in [RFC5475].

   It is assumed that packet Sampling is performed according to the
   framework defined in [RFC5474].  In this document, the PSAMP terms
   that appear capitalized are used as defined in [RFC5475].

   Managed objects in the PSAMP MIB module are defined as an extension
   of the IPFIX-MIB and IPFIX-SELECTOR-MIB modules [RFC6615].  Since the
   IPFIX MIB module is only for monitoring the same holds true for the
   PSAMP MIB module defined in this document.  The definition of objects
   is in line with the PSAMP information model [RFC5477].

   Section 3 gives an overview of the PSAMP documents, while Section 4
   refers to the related IPFIX documents.  Section 5 describes the
   structure of the PSAMP MIB module, and Section 6 contains the formal
   definition.  Security issues are discussed in Section 7.






Dietz, et al.                Standards Track                    [Page 3]
^L
RFC 6727                        PSAMP MIB                   October 2012


3.  Overview of PSAMP Documents

   [RFC5474]: "A Framework for Packet Selection and Reporting" describes
   the PSAMP framework for network elements to select subsets of packets
   by statistical and other methods, and to export a stream of reports
   on the selected packets to a Collector.

   [RFC5475]: "Sampling and Filtering Techniques for IP Packet
   Selection" describes the set of packet selection techniques supported
   by PSAMP.

   [RFC5476]: "Packet Sampling (PSAMP) Protocol Specifications"
   specifies the export of packet information from a PSAMP Exporting
   Process to a PSAMP Collecting Process.

   [RFC5477]: "Information Model for Packet Sampling Exports" defines an
   information and data model for PSAMP.

   This document: "Definitions of Managed Objects for Packet Sampling"
   describes the PSAMP Management Information Base.

4.  Related IPFIX Documents

   The IPFIX protocol provides network administrators with access to IP
   Flow information.

   [RFC5101]: "Specification of the IP Flow Information Export (IPFIX)
   Protocol for the Exchange of IP Traffic Flow Information" specifies
   how IPFIX Data Records and Templates are carried via a congestion-
   aware transport protocol from IPFIX Exporting Processes to IPFIX
   Collecting Processes.  It also specifies the data types used in the
   PSAMP MIB module and their encoding.

   [RFC6615]: The IPFIX-MIB "Definitions of Managed Objects for IP Flow
   Information Export" is the basis for this document because it extends
   the IPFIX SELECTOR MIB module defined there.

5.  Structure of the PSAMP MIB module

   The IPFIX-MIB module defined in [RFC6615] has the concept of a packet
   Selection Process containing a set of Selector function instances.
   Selection Processes and functions are referenced in the
   ipfixSelectionProcessTable of the IPFIX-MIB module.  The
   ipfixSelectionProcessTable identifies an instance of a Selector
   function by an OID.  The OID points to an object that describes the
   Selector function.  For simple Selector functions without parameters,
   the OID refers to an object that contains only one additional object
   indicating the current availability of the function.  For functions



Dietz, et al.                Standards Track                    [Page 4]
^L
RFC 6727                        PSAMP MIB                   October 2012


   that have one or more parameters, the object has a subtree that, in
   addition to an availability object, contains a table with a
   conceptual column for each parameter.  Entries (conceptual rows) in
   this table represent different combinations of parameter values for
   instances of the Selector function.

   The object ipfixSelectorFunctions in the IPFIX SELECTOR MIB module
   serves as the root for objects that describe instances of packet
   Selector functions.  The IPFIX SELECTOR MIB module is a very small
   module that is defined in [RFC6615].  The top-level OIDs of the
   parameter trees located beneath ipfixSelectorFunctions are maintained
   by IANA.  In the IPFIX SELECTOR MIB module as defined by [RFC6615],
   the object ipfixSelectorFunctions contains just a single trivial
   packet Selector function called ipfixFuncSelectAll that selects every
   packet and has no parameter:

   ipfixSelectorMIB
   +- ipfixSelectorObjects(1)
      +- ipfixSelectorFunctions(1)
         +- ipfixFuncSelectAll(1)
            +- ipfixFuncSelectAllAvail(1)

   The PSAMP MIB module defined in this document registers additional
   top-level OIDs for the parameter subtrees of its Selector functions
   in the IPFIX-SELECTOR-MIB Function sub-registry according to the
   procedures defined in [RFC6615].  It introduces six new subtrees
   beneath ipfixSelectorFunctions.  Each of them describes a packet
   Selector function with one or more parameters.  Naming and ordering
   of objects is fully in line with the guidelines given in Section 6.1
   of [RFC6615].  All functions and their parameters are already listed
   in the overview of functions given by the table in Section 8.2.1 of
   [RFC5477].

5.1.  Textual Conventions

   The PSAMP MIB module imports two textual conventions that define data
   types used in this MIB module from other MIB modules.  The
   Unsigned64TC data type is imported from the APPLICATION MIB module
   [RFC2564], and the Float64TC data type is imported from the FLOAT-TC-
   MIB module [RFC6340].  Those data types are defined according to
   [RFC5101].  Those data types are not an integral part of [RFC2578]
   but are needed to define objects in this MIB module that conform to
   the Information Elements defined for those objects in [RFC5477].

   The Unsigned64TC textual convention describes an unsigned integer of
   64 bits.  It is imported from the APPLICATION MIB module.  The
   Float64TC textual convention describes the format that is used for
   64-bit floating point numbers.



Dietz, et al.                Standards Track                    [Page 5]
^L
RFC 6727                        PSAMP MIB                   October 2012


5.2.  Packet Selection Functions

   In general, different packet Selector functions have different
   parameters.  The PSAMP MIB module contains six objects with subtrees
   that provide information on parameters of function instances of
   different Selector functions.  All objects are named and structured
   according to Section 8.2.1 of [RFC5477]:

   ipfixSelectorFunctions(1)
   +-- psampSampCountBased(2)
   +-- psampSampTimeBased(3)
   +-- psampSampRandOutOfN(4)
   +-- psampSampUniProb(5)
   +-- psampFiltPropMatch(6)
   +-- psampFiltHash(7)

   Indexing of these functions in the PSAMP MIB module starts with index
   (2).  The function ipfixFuncSelectAll with index (1) is already
   defined in the IPFIX SELECTOR MIB module as shown above.

   The object tree for each of these functions is described below.
   Semantics of all functions and their parameters are described in
   detail in [RFC5475].  More information on the Selector Reports can
   also be found in Section 6.5.2 of [RFC5476].

5.2.1.  Systematic Count-Based Sampling

   The first Selector function is systematic count-based Sampling.  Its
   availability is indicated by object psampSampCountBasedAvail.  The
   function has two parameters: psampSampCountBasedInterval and
   psampSampCountBasedSpace.  Different combinations of values of these
   parameters for different instances of the Selector function are
   represented by different conceptual rows in the table
   psampSampCountBasedParamSetTable:

   psampSampCountBased(2)
   +-- psampSampCountBasedAvail(1)
   +-- psampSampCountBasedParamSetTable(2)
      +-- psampSampCountBasedParamSetEntry(1) [psampSampCountBasedIndex]
         +-- psampSampCountBasedIndex(1)
         +-- psampSampCountBasedInterval(2)
         +-- psampSampCountBasedSpace(3)

5.2.2.  Systematic Time-Based Sampling

   The second Selector function is systematic time-based Sampling.  The
   structure of the subtree for this function is similar to the
   psampSampCountBased subtree.  Parameters are



Dietz, et al.                Standards Track                    [Page 6]
^L
RFC 6727                        PSAMP MIB                   October 2012


   psampSampTimeBasedInterval and psampSampTimeBasedSpace.  They appear
   to be the same as for count-based Sampling, but their data types are
   different because they indicate time values instead of numbers of
   packets:

   psampSampTimeBased(3)
   +-- psampSampTimeBasedAvail(1)
   +-- psampSampTimeBasedParamSetTable(2)
      +-- psampSampTimeBasedParamSetEntry(1) [psampSampTimeBasedIndex]
         +-- psampSampTimeBasedIndex(1)
         +-- psampSampTimeBasedInterval(2)
         +-- psampSampTimeBasedSpace(3)

5.2.3.  Random n-out-of-N Sampling

   The third Selector function is random n-out-of-N Sampling.
   Parameters are psampSampRandOutOfNSize and
   psampSampRandOutOfNPopulation:

   psampSampRandOutOfN(4)
   +-- psampSampRandOutOfNAvail(1)
   +-- psampSampRandOutOfNParamSetTable(2)
      +-- psampSampRandOutOfNParamSetEntry(1) [psampSampRandOutOfNIndex]
         +-- psampSampRandOutOfNIndex(1)
         +-- psampSampRandOutOfNSize(2)
         +-- psampSampRandOutOfNPopulation(3)

5.2.4.  Uniform Probabilistic Sampling

   The fourth Selector function is uniform probabilistic Sampling.  It
   has just a single parameter called psampSampUniProbProbability:

   psampSampUniProb(5)
   +-- psampSampUniProbAvail(1)
   +-- psampSampUniProbParamSetTable(2)
      +-- psampSampUniProbParamSetEntry(1) [psampSampUniProbIndex]
         +-- psampSampUniProbIndex(1)
         +-- psampSampUniProbProbability(2)

5.2.5.  Property Match Filtering

   The fifth Selector function is property match Filtering.  For this
   Selector function, there is a broad variety of possible parameters
   that could be used.  But, as stated in Section 8.2.1 of [RFC5477],
   there are no agreed parameters specified and the subtree for this
   function only contains an object indicating the availability of this
   function.  Parameters cannot be retrieved via the PSAMP MIB module:




Dietz, et al.                Standards Track                    [Page 7]
^L
RFC 6727                        PSAMP MIB                   October 2012


   psampFiltPropMatch(6)
   +-- psampFiltPropMatchAvail(1)

5.2.6.  Hash-Based Filtering

   The sixth Selector function is hash-based Filtering.  The object
   psampFiltHashFunction is an enumeration that specifies the kind of
   hash function that is applied.  These hash functions have quite a
   number of parameters, and the actual number may vary with the choice
   of the hash function applied.  The common parameter set for all hash-
   based Filtering functions contains 7 parameters:
   psampFiltHashInitializerValue, psampFiltHashIpPayloadOffset,
   psampFiltHashIpPayloadSize, psampFiltHashSelectedRangeMin,
   psampFiltHashSelectedRangeMax, psampFiltHashOutputRangeMin, and
   psampFiltHashOutputRangeMax.

   psampFiltHash(7)
   +-- psampFiltHashAvail(1)
   +-- psampFiltHashCapabilities(2)
   +-- psampFiltHashParamSetTable(3)
      +-- psampFiltHashParamSetEntry(1) [psampFiltHashIndex]
         +-- psampFiltHashIndex(1)
         +-- psampFiltHashFunction(2)
         +-- psampFiltHashInitializerValue(3)
         +-- psampFiltHashIpPayloadOffset(4)
         +-- psampFiltHashIpPayloadSize(5)
         +-- psampFiltHashSelectedRangeMin(6)
         +-- psampFiltHashSelectedRangeMax(7)
         +-- psampFiltHashOutputRangeMin(8)
         +-- psampFiltHashOutputRangeMax(9)

   Further parameters depend on the applied hash function and are not
   specified within the PSAMP MIB module.


















Dietz, et al.                Standards Track                    [Page 8]
^L
RFC 6727                        PSAMP MIB                   October 2012


6.  Definitions

   PSAMP-MIB DEFINITIONS ::= BEGIN

   IMPORTS
       MODULE-IDENTITY, OBJECT-TYPE, Integer32, Unsigned32, mib-2
           FROM SNMPv2-SMI                  -- RFC 2578
       TruthValue
           FROM SNMPv2-TC                   -- RFC 2579
       MODULE-COMPLIANCE, OBJECT-GROUP
           FROM SNMPv2-CONF                 -- RFC 2580
       Unsigned64TC
           FROM APPLICATION-MIB             -- RFC 2564
       Float64TC
           FROM FLOAT-TC-MIB                -- RFC 6340
       ipfixSelectorFunctions
           FROM IPFIX-SELECTOR-MIB;         -- RFC 6615

   psampMIB MODULE-IDENTITY
       LAST-UPDATED "201209051200Z"         -- 5 September 2012
       ORGANIZATION "IETF IPFIX Working Group"
       CONTACT-INFO
           "WG charter:
             http://datatracker.ietf.org/wg/ipfix/charter/

           Mailing Lists:
             General Discussion: ipfix@ietf.org
             To Subscribe: https://www.ietf.org/mailman/listinfo/ipfix
             Archive:
        http://www.ietf.org/mail-archive/web/ipfix/current/maillist.html

             Thomas Dietz (editor)
             NEC Europe Ltd.
             NEC Laboratories Europe
             Network Research Division
             Kurfuersten-Anlage 36
             69115 Heidelberg
             Germany
             Phone: +49 6221 4342-128
             EMail: Thomas.Dietz@neclab.eu

             Benoit Claise
             Cisco Systems, Inc.
             De Kleetlaan 6a b1
             Diegem 1831
             Belgium
             Phone:  +32 2 704 5622
             EMail: bclaise@cisco.com



Dietz, et al.                Standards Track                    [Page 9]
^L
RFC 6727                        PSAMP MIB                   October 2012


             Juergen Quittek
             NEC Europe Ltd.
             NEC Laboratories Europe
             Network Research Division
             Kurfuersten-Anlage 36
             69115 Heidelberg
             Germany
             Phone: +49 6221 4342-115
             EMail: quittek@neclab.eu"
           DESCRIPTION
           "The PSAMP MIB defines managed objects for packet sampling
           and filtering.

           These objects provide information about managed nodes
           supporting packet sampling, including packet sampling
           capabilities, configuration, and statistics.
           The PSAMP MIB module registers additional top-level OIDs for
           the parameter subtrees of its Selector functions in the
           IPFIX-SELECTOR-MIB Function sub-registry according to the
           procedures defined in RFC 6615.

           Copyright (c) 2012 IETF Trust and the persons identified
           as authors of the code. All rights reserved.

           Redistribution and use in source and binary forms, with or
           without modification, is permitted pursuant to, and subject
           to the license terms contained in, the Simplified BSD License
           set forth in Section 4.c of the IETF Trust's Legal Provisions
           Relating to IETF Documents
           (http://trustee.ietf.org/license-info).

           This version of this MIB module is part of RFC 6727; see the
           RFC itself for full legal notices."
        --  Revision history
        REVISION     "201209051200Z"         -- 5 September 2012
        DESCRIPTION
            "Initial version, published as RFC 6727."
       ::= { mib-2 212 }

   -- Top-level structure of the MIB

   psampObjects     OBJECT IDENTIFIER ::= { psampMIB 1 }
   psampConformance OBJECT IDENTIFIER ::= { psampMIB 2 }

   --==================================================================
   -- Packet selection sampling methods group of objects
   --==================================================================




Dietz, et al.                Standards Track                   [Page 10]
^L
RFC 6727                        PSAMP MIB                   October 2012


   --==================================================================
   --* Method 1: Systematic count-based Sampling
   --==================================================================

   -- Reference: RFC 5475 (Section 5.1), RFC 5476 (Section 6.5.2.1),
   --            and RFC 5477 (Section 8.2)
   psampSampCountBased OBJECT IDENTIFIER
       ::= { ipfixSelectorFunctions 2 }

   psampSampCountBasedAvail OBJECT-TYPE
       SYNTAX      TruthValue
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object indicates the availability of systematic
           count-based sampling at the managed node.

           A Selector may be unavailable if it is implemented but
           currently disabled due to, e.g., administrative reasons, lack
           of resources, or similar."
       ::= { psampSampCountBased 1 }

   -- Parameter Set Table +++++++++++++++++++++++++++++++++++++++++++++

   psampSampCountBasedParamSetTable OBJECT-TYPE
       SYNTAX      SEQUENCE OF
                   PsampSampCountBasedParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "This table lists configurations of systematic count-based
           packet sampling.  A parameter set describing a
           configuration contains two parameters: the sampling
           interval length and space."
       ::= { psampSampCountBased 2 }

   psampSampCountBasedParamSetEntry OBJECT-TYPE
       SYNTAX      PsampSampCountBasedParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "Defines an entry in the psampSampCountBasedParamSetTable."
       INDEX { psampSampCountBasedIndex }
       ::= { psampSampCountBasedParamSetTable 1 }

   PsampSampCountBasedParamSetEntry ::=
       SEQUENCE {
           psampSampCountBasedIndex     Integer32,



Dietz, et al.                Standards Track                   [Page 11]
^L
RFC 6727                        PSAMP MIB                   October 2012


           psampSampCountBasedInterval  Unsigned32,
           psampSampCountBasedSpace     Unsigned32
       }

   psampSampCountBasedIndex OBJECT-TYPE
       SYNTAX      Integer32 (1..2147483647)
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "The index of this parameter set in the
           psampSampCountBasedParamSetTable.  It is used in the
           object ipfixSelectionProcessSelectorFunction entries of
           the ipfixSelectionProcessTable in the IPFIX-MIB as reference
           to this parameter set."
       ::= { psampSampCountBasedParamSetEntry 1 }

   psampSampCountBasedInterval OBJECT-TYPE
       SYNTAX      Unsigned32
       UNITS       "packets"
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the number of packets that are
           consecutively sampled.  A value of 100 means that 100
           consecutive packets are sampled."
       REFERENCE
           "RFC 5475 (Section 5.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampCountBasedParamSetEntry 2 }

   psampSampCountBasedSpace OBJECT-TYPE
       SYNTAX      Unsigned32
       UNITS       "packets"
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the number of packets between two
           intervals specified by the object
           psampSampCountBasedInterval.  A value of 100 means that
           the next interval starts 100 packets (which are not sampled)
           after the current psampSampCountBasedInterval is over."
       REFERENCE
           "RFC 5475 (Section 5.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampCountBasedParamSetEntry 3 }

   --==================================================================
   --* Method 2: Systematic time-based Sampling
   --==================================================================




Dietz, et al.                Standards Track                   [Page 12]
^L
RFC 6727                        PSAMP MIB                   October 2012


   -- Reference: RFC 5475 (Section 5.1), RFC 5476 (Section 6.5.2.2),
   --            and RFC 5477 (Section 8.2)
   psampSampTimeBased OBJECT IDENTIFIER
       ::= { ipfixSelectorFunctions 3 }

   psampSampTimeBasedAvail OBJECT-TYPE
       SYNTAX      TruthValue
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object indicates the availability of systematic
           time-based sampling at the managed node.

           A Selector may be unavailable if it is implemented but
           currently disabled due to, e.g., administrative reasons, lack
           of resources, or similar."
       ::= { psampSampTimeBased 1 }

   -- Parameter Set Table +++++++++++++++++++++++++++++++++++++++++++++

   psampSampTimeBasedParamSetTable OBJECT-TYPE
       SYNTAX      SEQUENCE OF
                   PsampSampTimeBasedParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "This table lists configurations of systematic time-based
           packet sampling.  A parameter set describing a configuration
           contains two parameters: the sampling interval length and
           the space."
       ::= { psampSampTimeBased 2 }

   psampSampTimeBasedParamSetEntry OBJECT-TYPE
       SYNTAX      PsampSampTimeBasedParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "Defines an entry in the psampSampTimeBasedParamSetTable."
       INDEX { psampSampTimeBasedIndex }
       ::= { psampSampTimeBasedParamSetTable 1 }

   PsampSampTimeBasedParamSetEntry ::=
       SEQUENCE {
           psampSampTimeBasedIndex     Integer32,
           psampSampTimeBasedInterval  Unsigned32,
           psampSampTimeBasedSpace     Unsigned32
       }




Dietz, et al.                Standards Track                   [Page 13]
^L
RFC 6727                        PSAMP MIB                   October 2012


   psampSampTimeBasedIndex OBJECT-TYPE
       SYNTAX      Integer32 (1..2147483647)
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "The index of this parameter set in the
           psampSampTimeBasedParamSetTable.  It is used in the
           object ipfixSelectionProcessSelectorFunction entries of
           the ipfixSelectionProcessTable in the IPFIX-MIB as reference
           to this parameter set."
       ::= { psampSampTimeBasedParamSetEntry 1 }

   psampSampTimeBasedInterval OBJECT-TYPE
       SYNTAX      Unsigned32
       UNITS       "microseconds"
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the time interval in microseconds
           during which all arriving packets are sampled."
       REFERENCE
           "RFC 5475 (Section 5.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampTimeBasedParamSetEntry 2 }

   psampSampTimeBasedSpace OBJECT-TYPE
       SYNTAX      Unsigned32
       UNITS       "microseconds"
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the time interval in microseconds
           between two intervals specified by the object
           psampSampTimeBasedInterval.  A value of 100 means that the
           next interval starts 100 microseconds (during which no
           packets are sampled) after the current
           psampSampTimeBasedInterval is over."
       REFERENCE
           "RFC 5475 (Section 5.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampTimeBasedParamSetEntry 3 }

   --==================================================================
   --* Method 3: Random n-out-of-N Sampling
   --==================================================================

   -- Reference: RFC 5475 (Section 5.2.1), RFC 5476 (Section 6.5.2.3),
   --            and RFC 5477 (Section 8.2)
   psampSampRandOutOfN OBJECT IDENTIFIER
       ::= { ipfixSelectorFunctions 4 }



Dietz, et al.                Standards Track                   [Page 14]
^L
RFC 6727                        PSAMP MIB                   October 2012


   psampSampRandOutOfNAvail OBJECT-TYPE
       SYNTAX      TruthValue
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object indicates the availability of random n-out-of-N
           sampling at the managed node.

           A Selector may be unavailable if it is implemented but
           currently disabled due to, e.g., administrative reasons, lack
           of resources, or similar."
       ::= { psampSampRandOutOfN 1 }

   -- Parameter Set Table +++++++++++++++++++++++++++++++++++++++++++++

   psampSampRandOutOfNParamSetTable OBJECT-TYPE
       SYNTAX      SEQUENCE OF
                   PsampSampRandOutOfNParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "This table lists configurations of random n-out-of-N
           sampling.  A parameter set describing a configuration
           contains two parameters: the sampling size and the
           parent population."
       ::= { psampSampRandOutOfN 2 }

   psampSampRandOutOfNParamSetEntry OBJECT-TYPE
       SYNTAX      PsampSampRandOutOfNParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "Defines an entry in the psampSampRandOutOfNParamSetTable."
       INDEX { psampSampRandOutOfNIndex }
       ::= { psampSampRandOutOfNParamSetTable 1 }

   PsampSampRandOutOfNParamSetEntry ::=
       SEQUENCE {
           psampSampRandOutOfNIndex        Integer32,
           psampSampRandOutOfNSize Unsigned32,
           psampSampRandOutOfNPopulation   Unsigned32
       }

   psampSampRandOutOfNIndex OBJECT-TYPE
       SYNTAX      Integer32 (1..2147483647)
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION



Dietz, et al.                Standards Track                   [Page 15]
^L
RFC 6727                        PSAMP MIB                   October 2012


           "The index of this parameter set in the
           psampSampRandOutOfNParamSetTable.  It is used in the
           object ipfixSelectionProcessSelectorFunction entries of
           the ipfixSelectionProcessTable in the IPFIX-MIB as reference
           to this parameter set."
       ::= { psampSampRandOutOfNParamSetEntry 1 }

   psampSampRandOutOfNSize OBJECT-TYPE
       SYNTAX      Unsigned32
       UNITS       "packets"
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the number of elements taken from the
           parent Population specified in
           psampSampRandOutOfNPopulation."
       REFERENCE
           "RFC 5475 (Section 5.2.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampRandOutOfNParamSetEntry 2 }

   psampSampRandOutOfNPopulation OBJECT-TYPE
       SYNTAX      Unsigned32
       UNITS       "packets"
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the number of elements in the parent
           Population."
       REFERENCE
           "RFC 5475 (Section 5.2.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampRandOutOfNParamSetEntry 3 }

   --==================================================================
   --* Method 4: Uniform probabilistic Sampling
   --==================================================================

   -- Reference: RFC 5475 (Section 5.2.2), RFC 5476 (Section 6.5.2.4),
   --            and RFC 5477 (Section 8.2)
   psampSampUniProb OBJECT IDENTIFIER ::= { ipfixSelectorFunctions 5 }

   psampSampUniProbAvail OBJECT-TYPE
       SYNTAX      TruthValue
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object indicates the availability of random uniform
           probabilistic sampling at the managed node.




Dietz, et al.                Standards Track                   [Page 16]
^L
RFC 6727                        PSAMP MIB                   October 2012


           A Selector may be unavailable if it is implemented but
           currently disabled due to, e.g., administrative reasons, lack
           of resources, or similar."
       ::= { psampSampUniProb 1 }

   -- Parameter Set Table +++++++++++++++++++++++++++++++++++++++++++++

   -- Reference: RFC 5475 (Section 5.2.2.1) and RFC 5477 (Section 8.2)
   psampSampUniProbParamSetTable OBJECT-TYPE
       SYNTAX      SEQUENCE OF
                   PsampSampUniProbParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "This table lists configurations of random probabilistic
           sampling.  A parameter set describing a configuration
           contains a single parameter only: the sampling probability."
       ::= { psampSampUniProb 2 }

   psampSampUniProbParamSetEntry OBJECT-TYPE
       SYNTAX      PsampSampUniProbParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "Defines an entry in the psampSampUniProbParamSetTable."
       INDEX { psampSampUniProbIndex }
       ::= { psampSampUniProbParamSetTable 1 }

   PsampSampUniProbParamSetEntry ::=
       SEQUENCE {
           psampSampUniProbIndex       Integer32,
           psampSampUniProbProbability Float64TC
       }

   psampSampUniProbIndex OBJECT-TYPE
       SYNTAX      Integer32 (1..2147483647)
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "The index of this parameter set in the
           psampSampUniProbParamSetTable.  It is used in the
           object ipfixSelectionProcessSelectorFunction entries of
           the ipfixSelectionProcessTable in the IPFIX-MIB as reference
           to this parameter set."
       ::= { psampSampUniProbParamSetEntry 1 }

   psampSampUniProbProbability OBJECT-TYPE
       SYNTAX      Float64TC



Dietz, et al.                Standards Track                   [Page 17]
^L
RFC 6727                        PSAMP MIB                   October 2012


       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the probability that a packet is
           sampled, expressed as a value between 0 and 1.  The
           probability is equal for every packet.  A value of 0 means
           no packet is sampled since the probability is 0.  A value
           of 1 means all packets are sampled since the
           probability is 1.  NaN (not a number) and infinity MUST NOT
           be used."
       REFERENCE
           "RFC 5475 (Section 5.2.2.1) and RFC 5477 (Section 8.2)"
       ::= { psampSampUniProbParamSetEntry 2 }

   --==================================================================
   -- Packet selection filtering methods for a group of objects
   --==================================================================

   --==================================================================
   --* Method 5: Property Match filtering
   --==================================================================

   -- Reserves Method 5; see RFC 5475 (Section 6.1), RFC 5476
   -- (Section 6.5.2.5), and RFC 5477
   psampFiltPropMatch OBJECT IDENTIFIER
       ::= { ipfixSelectorFunctions 6 }

   psampFiltPropMatchAvail OBJECT-TYPE
       SYNTAX      TruthValue
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object indicates the availability of property match
           filtering at the managed node.

           A Selector may be unavailable if it is implemented but
           currently disabled due to, e.g., administrative reasons, lack
           of resources, or similar."
       ::= { psampFiltPropMatch 1 }

   --==================================================================
   --* Method 6: Hash filtering
   --==================================================================

   -- Reference: RFC 5475 (Section 6.2), RFC 5476 (Section 6.5.2.6),
   --            and RFC 5477 (Section 8.3)
   psampFiltHash OBJECT IDENTIFIER ::= { ipfixSelectorFunctions 7 }




Dietz, et al.                Standards Track                   [Page 18]
^L
RFC 6727                        PSAMP MIB                   October 2012


   psampFiltHashAvail OBJECT-TYPE
       SYNTAX      TruthValue
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object indicates the availability of hash filtering
           at the managed node.

           A Selector may be unavailable if it is implemented but
           currently disabled due to, e.g., administrative reasons, lack
           of resources, or similar."
       ::= { psampFiltHash 1 }

   psampFiltHashCapabilities OBJECT IDENTIFIER
       ::= { psampFiltHash 2 }

   -- Parameter Set Table +++++++++++++++++++++++++++++++++++++++++++++

   -- Reference: RFC 5475, Sections 6.2, 3.8, and 7.1
   psampFiltHashParamSetTable OBJECT-TYPE
       SYNTAX      SEQUENCE OF
                   PsampFiltHashParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "This table lists configurations of hash filtering.  A
           parameter set describing a configuration contains eight
           parameters describing the hash function."
       ::= { psampFiltHash 3 }

   psampFiltHashParamSetEntry OBJECT-TYPE
       SYNTAX      PsampFiltHashParamSetEntry
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "Defines an entry in the psampFiltHashParamSetTable."
       INDEX { psampFiltHashIndex }
       ::= { psampFiltHashParamSetTable 1 }

   PsampFiltHashParamSetEntry ::=
       SEQUENCE {
           psampFiltHashIndex            Integer32,
           psampFiltHashFunction         INTEGER,
           psampFiltHashInitializerValue Unsigned64TC,
           psampFiltHashIpPayloadOffset  Unsigned64TC,
           psampFiltHashIpPayloadSize    Unsigned64TC,
           psampFiltHashSelectedRangeMin Unsigned64TC,
           psampFiltHashSelectedRangeMax Unsigned64TC,



Dietz, et al.                Standards Track                   [Page 19]
^L
RFC 6727                        PSAMP MIB                   October 2012


           psampFiltHashOutputRangeMin   Unsigned64TC,
           psampFiltHashOutputRangeMax   Unsigned64TC
       }

   psampFiltHashIndex OBJECT-TYPE
       SYNTAX      Integer32 (1..2147483647)
       MAX-ACCESS  not-accessible
       STATUS      current
       DESCRIPTION
           "The index of this parameter set in the
           psampFiltHashParamSetTable.  It is used in the
           object ipfixSelectionProcessSelectorFunction entries of
           the ipfixSelectionProcessTable in the IPFIX-MIB as reference
           to this parameter set."
       ::= { psampFiltHashParamSetEntry 1 }

   psampFiltHashFunction OBJECT-TYPE
       SYNTAX      INTEGER {
                       crc32(1),
                       ipsx(2),
                       bob(3)
                   }
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "The hash function used by this filter.  The PSAMP-MIB
           defines the following hash functions:

           crc32(1): The CRC-32 Hash Function as defined in RFC 1141.

           ipsx(2): The IPSX Hash Function as described in RFC 5475,
               Appendix A.1.

           bob(3): The BOB Hash Function as described in RFC 5475,
               Appendix A.2.
           "
       REFERENCE
           "RFC 5475 (Section 6.2 and Appendixes A.1 and A.2)
            and RFC 1141"
       ::= { psampFiltHashParamSetEntry 2 }

   psampFiltHashInitializerValue OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the initializer value to the hash
           function."



Dietz, et al.                Standards Track                   [Page 20]
^L
RFC 6727                        PSAMP MIB                   October 2012


       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 3 }

   psampFiltHashIpPayloadOffset OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the IP payload offset used by a
           Hash-based Selection Selector."
       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 4 }

   psampFiltHashIpPayloadSize OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the IP payload size used by a
           Hash-based Selection Selector."
       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 5 }

   psampFiltHashSelectedRangeMin OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the value for the beginning of a hash
           function's selected range."
       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 6 }

   psampFiltHashSelectedRangeMax OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the value for the end of a hash
           function's selected range."
       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 7 }




Dietz, et al.                Standards Track                   [Page 21]
^L
RFC 6727                        PSAMP MIB                   October 2012


   psampFiltHashOutputRangeMin OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the value for the beginning of a hash
           function's potential output range."
       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 8 }

   psampFiltHashOutputRangeMax OBJECT-TYPE
       SYNTAX      Unsigned64TC
       MAX-ACCESS  read-only
       STATUS      current
       DESCRIPTION
           "This object specifies the value for the end of a hash
           function's potential output range."
       REFERENCE
           "RFC 5475, Sections 6.2, 3.8, and 7.1"
       ::= { psampFiltHashParamSetEntry 9 }

   --==================================================================
   -- Conformance information
   --==================================================================

   psampCompliances OBJECT IDENTIFIER ::= { psampConformance 1 }
   psampGroups      OBJECT IDENTIFIER ::= { psampConformance 2 }

   --==================================================================
   -- Compliance statements
   --==================================================================

   psampCompliance MODULE-COMPLIANCE
       STATUS  current
       DESCRIPTION
           "The implementation of all objects is optional and depends
           on the implementation of the corresponding functionality in
           the equipment."
       MODULE  -- this module
           GROUP psampGroupSampCountBased
           DESCRIPTION
               "These objects must be implemented if systematic
               count-based sampling is implemented in the equipment."
           GROUP psampGroupSampTimeBased
           DESCRIPTION
               "These objects must be implemented if systematic
               time-based sampling is implemented in the equipment."



Dietz, et al.                Standards Track                   [Page 22]
^L
RFC 6727                        PSAMP MIB                   October 2012


           GROUP psampGroupSampRandOutOfN
           DESCRIPTION
               "These objects must be implemented if random n-out-of-N
               sampling is implemented in the equipment."
           GROUP psampGroupSampUniProb
           DESCRIPTION
               "These objects must be implemented if uniform
               probabilistic sampling is implemented in the equipment."
           GROUP psampGroupFiltPropMatch
           DESCRIPTION
               "These objects must be implemented if the property match
               filtering is implemented in the equipment."
           GROUP psampGroupFiltHash
           DESCRIPTION
               "These objects must be implemented if hash filtering
               is implemented in the equipment."
       ::= { psampCompliances 1 }

   --==================================================================
   -- MIB groupings
   --==================================================================

   psampGroupSampCountBased OBJECT-GROUP
       OBJECTS {
                 psampSampCountBasedAvail,
                 psampSampCountBasedInterval,
                 psampSampCountBasedSpace
               }
       STATUS  current
       DESCRIPTION
           "These objects are needed if count based sampling is
           implemented."
       ::= { psampGroups 1 }

   psampGroupSampTimeBased OBJECT-GROUP
       OBJECTS {
                 psampSampTimeBasedAvail,
                 psampSampTimeBasedInterval,
                 psampSampTimeBasedSpace
               }
       STATUS  current
       DESCRIPTION
           "These objects are needed if time based sampling is
           implemented."
       ::= { psampGroups 2 }

   psampGroupSampRandOutOfN OBJECT-GROUP
       OBJECTS {



Dietz, et al.                Standards Track                   [Page 23]
^L
RFC 6727                        PSAMP MIB                   October 2012


                 psampSampRandOutOfNAvail,
                 psampSampRandOutOfNSize,
                 psampSampRandOutOfNPopulation
               }
       STATUS  current
       DESCRIPTION
           "These objects are needed if random n-out-of-N sampling is
           implemented."
       ::= { psampGroups 3 }

   psampGroupSampUniProb OBJECT-GROUP
       OBJECTS {
                 psampSampUniProbAvail,
                 psampSampUniProbProbability
               }
       STATUS  current
       DESCRIPTION
           "These objects are needed if uniform probabilistic sampling
           is implemented."
       ::= { psampGroups 4 }

   psampGroupFiltPropMatch OBJECT-GROUP
       OBJECTS {
                 psampFiltPropMatchAvail
               }
       STATUS  current
       DESCRIPTION
           "These objects are needed if property match filtering is
           implemented."
       ::= { psampGroups 5 }

   psampGroupFiltHash OBJECT-GROUP
       OBJECTS {
                 psampFiltHashAvail,
                 psampFiltHashFunction,
                 psampFiltHashInitializerValue,
                 psampFiltHashIpPayloadOffset,
                 psampFiltHashIpPayloadSize,
                 psampFiltHashSelectedRangeMin,
                 psampFiltHashSelectedRangeMax,
                 psampFiltHashOutputRangeMin,
                 psampFiltHashOutputRangeMax
               }
       STATUS  current
       DESCRIPTION
           "These objects are needed if hash filtering is implemented."
       ::= { psampGroups 6 }




Dietz, et al.                Standards Track                   [Page 24]
^L
RFC 6727                        PSAMP MIB                   October 2012


   END

7.  Security Considerations

   There are no management objects defined in this MIB module that have
   a MAX-ACCESS clause of read-write and/or read-create.  So, if this
   MIB module is implemented correctly, then there is no risk that an
   intruder can alter or create any management objects of this MIB
   module via direct SNMP SET operations.

   All tables in this MIB module may be considered sensitive or
   vulnerable in some network environments because objects in the tables
   may reveal information about the network infrastructure and device
   configuration.  It is thus important to control even GET and/or
   NOTIFY access to these objects and possibly to even encrypt the
   values of these objects when sending them over the network via SNMP.

   SNMP versions prior to SNMPv3 did not include adequate security.
   Even if the network itself is secure (for example by using IPsec),
   there is no control as to who on the secure network is allowed to
   access and GET/SET (read/change/create/delete) the objects in this
   MIB module.

   It is RECOMMENDED that implementers consider the security features
   provided by the SNMPv3 framework (see [RFC3410], section 8),
   including full support for the SNMPv3 cryptographic mechanisms (for
   authentication and privacy).

   Further, deployment of SNMP versions prior to SNMPv3 is NOT
   RECOMMENDED.  Instead, it is RECOMMENDED to deploy SNMPv3 and to
   enable cryptographic security.  It is then a customer/operator
   responsibility to ensure that the SNMP entity giving access to an
   instance of this MIB module is properly configured to give access to
   the objects only to those principals (users) who have legitimate
   rights to GET or SET (change/create/delete) them.

8.  IANA Considerations

   The MIB module in this document uses the following IANA-assigned
   OBJECT IDENTIFIER value recorded in the SMI Numbers registry:

           Descriptor             OBJECT IDENTIFIER value
           ----------             -----------------------
           psampMIB               { mib-2 212 }







Dietz, et al.                Standards Track                   [Page 25]
^L
RFC 6727                        PSAMP MIB                   October 2012


   Further, IANA has registered the following top-level OIDs in the
   IPFIX-SELECTOR-MIB Functions sub-registry at
   http://www.iana.org/assignments/smi-numbers according to the
   procedures set forth in [RFC6615]:

  Decimal Name                Description                      Reference
  ------- ------------------- -------------------------------- ---------
  2       psampSampCountBased Systematic Count-based Sampling  [RFC6727]
  3       psampSampTimeBased  Systematic Time-based Sampling   [RFC6727]
  4       psampSampRandOutOfN Random n-out-of-N Sampling       [RFC6727]
  5       psampSampUniProb    Universal Probabilistic Sampling [RFC6727]
  6       psampFiltPropMatch  Property Match Filtering         [RFC6727]
  7       psampFiltHash       Hash-based Filtering             [RFC6727]

   The prerequisites set forth for addition of these OIDs are to be
   verified based on the content of this document.

9.  Acknowledgment

   This document is a product of the PSAMP and IPFIX WGs.  The authors
   would like to thank the following persons: Paul Aitken for his
   detailed review, Dan Romascanu, the MIB doctors, and many more, for
   the technical reviews and feedback.

10.  References

10.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, March 1997.

   [RFC2564]  Kalbfleisch, C., Krupczak, C., Presuhn, R., and J.
              Saperia, "Application Management MIB", RFC 2564, May 1999.

   [RFC2578]  McCloghrie, K., Ed., Perkins, D., Ed., and J.
              Schoenwaelder, Ed., "Structure of Management Information
              Version 2 (SMIv2)", STD 58, RFC 2578, April 1999.

   [RFC2579]  McCloghrie, K., Ed., Perkins, D., Ed., and J.
              Schoenwaelder, Ed., "Textual Conventions for SMIv2",
              STD 58, RFC 2579, April 1999.

   [RFC2580]  McCloghrie, K., Perkins, D., and J. Schoenwaelder,
              "Conformance Statements for SMIv2", STD 58, RFC 2580,
              April 1999.






Dietz, et al.                Standards Track                   [Page 26]
^L
RFC 6727                        PSAMP MIB                   October 2012


   [RFC5101]  Claise, B., "Specification of the IP Flow Information
              Export (IPFIX) Protocol for the Exchange of IP Traffic
              Flow Information", RFC 5101, January 2008.

   [RFC5477]  Dietz, T., Claise, B., Aitken, P., Dressler, F., and G.
              Carle, "Information Model for Packet Sampling Exports",
              RFC 5477, March 2009.

   [RFC6340]  Presuhn, R., "Textual Conventions for the Representation
              of Floating-Point Numbers", RFC 6340, August 2011.

   [RFC6615]  Dietz, T., Kobayashi, A., Claise, B., and G. Muenz,
              "Definitions of Managed Objects for IP Flow Information
              Export", RFC 6615, June 2012.

10.2.  Informative References

   [RFC3410]  Case, J., Mundy, R., Partain, D., and B. Stewart,
              "Introduction and Applicability Statements for Internet-
              Standard Management Framework", RFC 3410, December 2002.

   [RFC5474]  Duffield, N., Chiou, D., Claise, B., Greenberg, A.,
              Grossglauser, M., and J. Rexford, "A Framework for Packet
              Selection and Reporting", RFC 5474, March 2009.

   [RFC5475]  Zseby, T., Molina, M., Duffield, N., Niccolini, S., and F.
              Raspall, "Sampling and Filtering Techniques for IP Packet
              Selection", RFC 5475, March 2009.

   [RFC5476]  Claise, B., Johnson, A., and J. Quittek, "Packet Sampling
              (PSAMP) Protocol Specifications", RFC 5476, March 2009.




















Dietz, et al.                Standards Track                   [Page 27]
^L
RFC 6727                        PSAMP MIB                   October 2012


Authors' Addresses

   Thomas Dietz (editor)
   NEC Europe Ltd.
   NEC Laboratories Europe
   Kurfuersten-Anlage 36
   69115 Heidelberg
   Germany

   Phone: +49 6221 4342-128
   EMail: dietz@neclab.eu


   Benoit Claise
   Cisco Systems, Inc.
   De Kleetlaan 6a b1
   Diegem  1831
   Belgium

   Phone: +32 2 704 5622
   EMail: bclaise@cisco.com


   Juergen Quittek
   NEC Europe Ltd.
   NEC Laboratories Europe
   Kurfuersten-Anlage 36
   69115 Heidelberg
   Germany

   Phone: +49 6221 4342-115
   EMail: quittek@neclab.eu



















Dietz, et al.                Standards Track                   [Page 28]
^L