-
Notifications
You must be signed in to change notification settings - Fork 4
/
ietf-ipfix-psamp@2012-09-05.yang
2232 lines (2162 loc) · 81.1 KB
/
ietf-ipfix-psamp@2012-09-05.yang
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
module ietf-ipfix-psamp {
namespace "urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp";
prefix ipfix;
import ietf-yang-types { prefix yang; }
import ietf-inet-types { prefix inet; }
organization
"IETF IPFIX Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/ipfix/>
WG List: <ipfix@ietf.org>
WG Chair: Nevil Brownlee
<n.brownlee@auckland.ac.nz>
WG Chair: Juergen Quittek
<quittek@neclab.eu>
Editor: Gerhard Muenz
<muenz@net.in.tum.de>";
description
"IPFIX/PSAMP Configuration Data Model
Copyright (c) 2012 IETF Trust and the persons identified as
the document authors. 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).";
revision 2012-09-05 {
description "Initial version";
reference "RFC 6728: Configuration Data Model for the IP Flow
Information Export (IPFIX) and Packet Sampling (PSAMP)
Protocols";
}
/*****************************************************************
* Features
*****************************************************************/
feature exporter {
description "If supported, the Monitoring Device can be used as
an Exporter. Exporting Processes can be configured.";
}
feature collector {
description "If supported, the Monitoring Device can be used as
a Collector. Collecting Processes can be configured.";
}
feature meter {
description "If supported, Observation Points, Selection
Processes, and Caches can be configured.";
}
feature psampSampCountBased {
description "If supported, the Monitoring Device supports
count-based Sampling. The Selector method sampCountBased can
be configured.";
}
feature psampSampTimeBased {
description "If supported, the Monitoring Device supports
time-based Sampling. The Selector method sampTimeBased can
be configured.";
}
feature psampSampRandOutOfN {
description "If supported, the Monitoring Device supports
random n-out-of-N Sampling. The Selector method
sampRandOutOfN can be configured.";
}
feature psampSampUniProb {
description "If supported, the Monitoring Device supports
uniform probabilistic Sampling. The Selector method
sampUniProb can be configured.";
}
feature psampFilterMatch {
description "If supported, the Monitoring Device supports
property match Filtering. The Selector method filterMatch
can be configured.";
}
feature psampFilterHash {
description "If supported, the Monitoring Device supports
hash-based Filtering. The Selector method filterHash can be
configured.";
}
feature immediateCache {
description "If supported, the Monitoring Device supports
Caches generating PSAMP Packet Reports by configuration with
immediateCache.";
}
feature timeoutCache {
description "If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
timeoutCache.";
}
feature naturalCache {
description "If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
naturalCache.";
}
feature permanentCache {
description "If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
permanentCache.";
}
feature udpTransport {
description "If supported, the Monitoring Device supports UDP
as the transport protocol.";
}
feature tcpTransport {
description "If supported, the Monitoring Device supports TCP
as the transport protocol.";
}
feature fileReader {
description "If supported, the Monitoring Device supports the
configuration of Collecting Processes as File Readers.";
}
feature fileWriter {
description "If supported, the Monitoring Device supports the
configuration of Exporting Processes as File Writers.";
}
/*****************************************************************
* Identities
*****************************************************************/
/*** Hash function identities ***/
identity hashFunction {
description "Base identity for all hash functions used for
hash-based packet Filtering. Identities derived from
this base are used by the leaf
/ipfix/selectionProcess/selector/filterHash/hashFunction.";
}
identity BOB {
base "hashFunction";
description "BOB hash function";
reference "RFC 5475, Section 6.2.4.1.";
}
identity IPSX {
base "hashFunction";
description "IPSX hash function";
reference "RFC 5475, Section 6.2.4.1.";
}
identity CRC {
base "hashFunction";
description "CRC hash function";
reference "RFC 5475, Section 6.2.4.1.";
}
/*** Export mode identities ***/
identity exportMode {
description "Base identity for different usages of export
destinations configured for an Exporting Process.
Identities derived from this base are used by the leaf
/ipfix/exportingProcess/exportMode.";
}
identity parallel {
base "exportMode";
description "Parallel export of Data Records to all
destinations configured for the Exporting Process.";
}
identity loadBalancing {
base "exportMode";
description "Load-balancing between the different destinations
configured for the Exporting Process.";
}
identity fallback {
base "exportMode";
description "Export to the primary destination (i.e., the first
SCTP, UDP, TCP, or file destination configured for the
Exporting Process). If the export to the primary destination
fails, the Exporting Process tries to export to the secondary
destination. If the secondary destination fails as well, it
continues with the tertiary, etc.";
}
/*** Options type identities ***/
identity optionsType {
description "Base identity for report types exported with
options. Identities derived from this base are used by the leaf
/ipfix/exportingProcess/options/optionsType.";
}
identity meteringStatistics {
base "optionsType";
description "Metering Process Statistics.";
reference "RFC 5101, Section 4.1.";
}
identity meteringReliability {
base "optionsType";
description "Metering Process Reliability Statistics.";
reference "RFC 5101, Section 4.2.";
}
identity exportingReliability {
base "optionsType";
description "Exporting Process Reliability
Statistics.";
reference "RFC 5101, Section 4.3.";
}
identity flowKeys {
base "optionsType";
description "Flow Keys.";
reference "RFC 5101, Section 4.4.";
}
identity selectionSequence {
base "optionsType";
description "Selection Sequence and Selector Reports.";
reference "RFC 5476, Sections 6.5.1 and 6.5.2.";
}
identity selectionStatistics {
base "optionsType";
description "Selection Sequence Statistics Report.";
reference "RFC 5476, Sections 6.5.3.";
}
identity accuracy {
base "optionsType";
description "Accuracy Report.";
reference "RFC 5476, Section 6.5.4.";
}
identity reducingRedundancy {
base "optionsType";
description "Enables the utilization of Options Templates to
reduce redundancy in the exported Data Records.";
reference "RFC 5473.";
}
identity extendedTypeInformation {
base "optionsType";
description "Export of extended type information for
enterprise-specific Information Elements used in the
exported Templates.";
reference "RFC 5610.";
}
/*****************************************************************
* Type definitions
*****************************************************************/
typedef ieNameType {
type string {
length "1..max";
pattern "\S+";
}
description "Type for Information Element names. Whitespaces
are not allowed.";
}
typedef ieIdType {
type uint16 {
range "1..32767" {
description "Valid range of Information Element
identifiers.";
reference "RFC 5102, Section 4.";
}
}
description "Type for Information Element identifiers.";
}
typedef nameType {
type string {
length "1..max";
pattern "\S(.*\S)?";
}
description "Type for 'name' leafs, which are used to identify
specific instances within lists, etc.
Leading and trailing whitespaces are not allowed.";
}
typedef ifNameType {
type string {
length "1..255";
}
description "This corresponds to the DisplayString textual
convention of SNMPv2-TC, which is used for ifName in the IF
MIB module.";
reference "RFC 2863 (ifName).";
}
typedef direction {
type enumeration {
enum ingress {
description "This value is used for monitoring incoming
packets.";
}
enum egress {
description "This value is used for monitoring outgoing
packets.";
}
enum both {
description "This value is used for monitoring incoming and
outgoing packets.";
}
}
description "Direction of packets going through an interface or
linecard.";
}
typedef transportSessionStatus {
type enumeration {
enum inactive {
description "This value MUST be used for Transport Sessions
that are specified in the system but currently not active.
The value can be used for Transport Sessions that are
backup (secondary) sessions.";
}
enum active {
description "This value MUST be used for Transport Sessions
that are currently active and transmitting or receiving
data.";
}
enum unknown {
description "This value MUST be used if the status of the
Transport Sessions cannot be detected by the device. This
value should be avoided as far as possible.";
}
}
description "Status of a Transport Session.";
reference "RFC 6615, Section 8 (ipfixTransportSessionStatus).";
}
/*****************************************************************
* Groupings
*****************************************************************/
grouping observationPointParameters {
description "Interface as input to Observation Point.";
leaf observationPointId {
type uint32;
config false;
description "Observation Point ID (i.e., the value of the
Information Element observationPointId) assigned by the
Monitoring Device.";
reference "IANA registry for IPFIX Entities,
http://www.iana.org/assignments/ipfix.";
}
leaf observationDomainId {
type uint32;
mandatory true;
description "The Observation Domain ID associates the
Observation Point to an Observation Domain. Observation
Points with identical Observation Domain IDs belong to the
same Observation Domain.
Note that this parameter corresponds to
ipfixObservationPointObservationDomainId in the IPFIX MIB
module.";
reference "RFC 5101; RFC 6615, Section 8
(ipfixObservationPointObservationDomainId).";
}
leaf-list ifName {
type ifNameType;
description "List of names identifying interfaces of the
Monitoring Device. The Observation Point observes packets at
the specified interfaces.";
}
leaf-list ifIndex {
type uint32;
description "List of ifIndex values pointing to entries in the
ifTable of the IF-MIB module maintained by the Monitoring
Device. The Observation Point observes packets at the
specified interfaces.
This parameter SHOULD only be used if an SNMP agent enables
access to the ifTable.
Note that this parameter corresponds to
ipfixObservationPointPhysicalInterface in the IPFIX MIB
module.";
reference "RFC 2863; RFC 6615, Section 8
(ipfixObservationPointPhysicalInterface).";
}
leaf-list entPhysicalName {
type string;
description "List of names identifying physical entities of the
Monitoring Device. The Observation Point observes packets at
the specified entities.";
}
leaf-list entPhysicalIndex {
type uint32;
description "List of entPhysicalIndex values pointing to
entries in the entPhysicalTable of the ENTITY-MIB module
maintained by the Monitoring Device. The Observation Point
observes packets at the specified entities.
This parameter SHOULD only be used if an SNMP agent enables
access to the entPhysicalTable.
Note that this parameter corresponds to
ipfixObservationPointPhysicalEntity in the IPFIX MIB
module.";
reference "RFC 4133; RFC 6615, Section 8
(ipfixObservationPointPhysicalInterface).";
}
leaf direction {
type direction;
default both;
description "Direction of packets. If not applicable (e.g., in
the case of a sniffing interface in promiscuous mode), this
parameter is ignored.";
}
}
grouping sampCountBasedParameters {
description "Configuration parameters of a Selector applying
systematic count-based packet Sampling to the packet
stream.";
reference "RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.1.";
leaf packetInterval {
type uint32;
units packets;
mandatory true;
description "The number of packets that are consecutively
sampled between gaps of length packetSpace.
This parameter corresponds to the Information Element
samplingPacketInterval and to psampSampCountBasedInterval
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.2.2; RFC 6727, Section 6
(psampSampCountBasedInterval).";
}
leaf packetSpace {
type uint32;
units packets;
mandatory true;
description "The number of unsampled packets between two
Sampling intervals.
This parameter corresponds to the Information Element
samplingPacketSpace and to psampSampCountBasedSpace
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.2.3; RFC 6727, Section 6
(psampSampCountBasedSpace).";
}
}
grouping sampTimeBasedParameters {
description "Configuration parameters of a Selector applying
systematic time-based packet Sampling to the packet
stream.";
reference "RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.2.";
leaf timeInterval {
type uint32;
units microseconds;
mandatory true;
description "The time interval in microseconds during
which all arriving packets are sampled between gaps
of length timeSpace.
This parameter corresponds to the Information Element
samplingTimeInterval and to psampSampTimeBasedInterval
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.2.4; RFC 6727, Section 6
(psampSampTimeBasedInterval).";
}
leaf timeSpace {
type uint32;
units microseconds;
mandatory true;
description "The time interval in microseconds during
which no packets are sampled between two Sampling
intervals specified by timeInterval.
This parameter corresponds to the Information Element
samplingTimeInterval and to psampSampTimeBasedSpace
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.2.5; RFC 6727, Section 6
(psampSampTimeBasedSpace).";
}
}
grouping sampRandOutOfNParameters {
description "Configuration parameters of a Selector applying
n-out-of-N packet Sampling to the packet stream.";
reference "RFC 5475, Section 5.2.1; RFC 5476, Section 6.5.2.3.";
leaf size {
type uint32;
units packets;
mandatory true;
description "The number of elements taken from the parent
population.
This parameter corresponds to the Information Element
samplingSize and to psampSampRandOutOfNSize in the PSAMP
MIB module.";
reference "RFC 5477, Section 8.2.6; RFC 6727, Section 6
(psampSampRandOutOfNSize).";
}
leaf population {
type uint32;
units packets;
mandatory true;
description "The number of elements in the parent
population.
This parameter corresponds to the Information Element
samplingPopulation and to psampSampRandOutOfNPopulation
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.2.7; RFC 6727, Section 6
(psampSampRandOutOfNPopulation).";
}
}
grouping sampUniProbParameters {
description "Configuration parameters of a Selector applying
uniform probabilistic packet Sampling (with equal
probability per packet) to the packet stream.";
reference "RFC 5475, Section 5.2.2.1;
RFC 5476, Section 6.5.2.4.";
leaf probability {
type decimal64 {
fraction-digits 18;
range "0..1";
}
mandatory true;
description "Probability that a packet is sampled,
expressed as a value between 0 and 1. The probability
is equal for every packet.
This parameter corresponds to the Information Element
samplingProbability and to psampSampUniProbProbability
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.2.8; RFC 6727, Section 6
(psampSampUniProbProbability).";
}
}
grouping filterMatchParameters {
description "Configuration parameters of a Selector applying
property match Filtering to the packet stream.
The field to be matched is specified as an Information
Element.";
reference "RFC 5475, Section 6.1; RFC 5476, Section 6.5.2.5.";
choice nameOrId {
mandatory true;
description "The field to be matched is specified by
either the name or the identifier of the Information
Element.";
leaf ieName {
type ieNameType;
description "Name of the Information Element.";
}
leaf ieId {
type ieIdType;
description "Identifier of the Information Element.";
}
}
leaf ieEnterpriseNumber {
type uint32;
default 0;
description "If this parameter is zero, the Information
Element is registered in the IANA registry of IPFIX
Information Elements.
If this parameter is configured with a non-zero private
enterprise number, the Information Element is
enterprise-specific.";
reference "IANA registry for Private Enterprise Numbers,
http://www.iana.org/assignments/enterprise-numbers;
IANA registry for IPFIX Entities,
http://www.iana.org/assignments/ipfix.";
}
leaf value {
type string;
mandatory true;
description "Matching value of the Information Element.";
}
}
grouping filterHashParameters {
description "Configuration parameters of a Selector applying
hash-based Filtering to the packet stream.";
reference "RFC 5475, Section 6.2; RFC 5476, Section 6.5.2.6.";
leaf hashFunction {
type identityref {
base "hashFunction";
}
default BOB;
description "Hash function to be applied. According to
RFC 5475, Section 6.2.4.1, 'BOB' must be used in order to
be compliant with PSAMP.
This parameter functionally corresponds to
psampFiltHashFunction in the PSAMP MIB module.";
reference "RFC 6727, Section 6 (psampFiltHashFunction)";
}
leaf initializerValue {
type uint64;
description "Initializer value to the hash function.
If not configured by the user, the Monitoring Device
arbitrarily chooses an initializer value.
This parameter corresponds to the Information Element
hashInitialiserValue and to psampFiltHashInitializerValue
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.9; RFC 6727, Section 6
(psampFiltHashInitializerValue).";
}
leaf ipPayloadOffset {
type uint64;
units octets;
default 0;
description "IP payload offset indicating the position of
the first payload byte considered as input to the hash
function.
Default value 0 corresponds to the minimum offset that
must be configurable according to RFC 5476, Section
6.5.2.6.
This parameter corresponds to the Information Element
hashIPPayloadOffset and to psampFiltHashIpPayloadOffset
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.2; RFC 6727, Section 6
(psampFiltHashIpPayloadOffset).";
}
leaf ipPayloadSize {
type uint64;
units octets;
default 8;
description "Number of IP payload bytes used as input to
the hash function, counted from the payload offset.
If the IP payload is shorter than the payload range,
all available payload octets are used as input.
Default value 8 corresponds to the minimum IP payload
size that must be configurable according to RFC 5476,
Section 6.5.2.6.
This parameter corresponds to the Information Element
hashIPPayloadSize and to psampFiltHashIpPayloadSize
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.3; RFC 6727, Section 6
(psampFiltHashIpPayloadSize).";
}
leaf digestOutput {
type boolean;
default false;
description "If true, the output from this Selector is
included in the Packet Report as a packet digest.
Therefore, the configured Cache Layout needs to contain
a digestHashValue field.
This parameter corresponds to the Information Element
hashDigestOutput.";
reference "RFC 5477, Section 8.3.8.";
}
leaf outputRangeMin {
type uint64;
config false;
description "Beginning of the hash function's potential
range.
This parameter corresponds to the Information Element
hashOutputRangeMin and to psampFiltHashOutputRangeMin
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.4; RFC 6727, Section 6
(psampFiltHashOutputRangeMin).";
}
leaf outputRangeMax {
type uint64;
config false;
description "End of the hash function's potential range.
This parameter corresponds to the Information Element
hashOutputRangeMax and to psampFiltHashOutputRangeMax
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.5; RFC 6727, Section 6
(psampFiltHashOutputRangeMax).";
}
list selectedRange {
key name;
min-elements 1;
description "List of hash function return ranges for
which packets are selected.";
leaf name {
type nameType;
description "Key of this list.";
}
leaf min {
type uint64;
description "Beginning of the hash function's selected
range.
This parameter corresponds to the Information Element
hashSelectedRangeMin and to psampFiltHashSelectedRangeMin
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.6; RFC 6727, Section 6
(psampFiltHashSelectedRangeMin).";
}
leaf max {
type uint64;
description "End of the hash function's selected range.
This parameter corresponds to the Information Element
hashSelectedRangeMax and to psampFiltHashSelectedRangeMax
in the PSAMP MIB module.";
reference "RFC 5477, Section 8.3.7; RFC 6727, Section 6
(psampFiltHashSelectedRangeMax).";
}
}
}
grouping selectorParameters {
description "Configuration and state parameters of a Selector.";
choice Method {
mandatory true;
description "Packet selection method applied by the Selector.";
leaf selectAll {
type empty;
description "Method that selects all packets.";
}
container sampCountBased {
if-feature psampSampCountBased;
description "Systematic count-based packet Sampling.";
uses sampCountBasedParameters;
}
container sampTimeBased {
if-feature psampSampTimeBased;
description "Systematic time-based packet Sampling.";
uses sampTimeBasedParameters;
}
container sampRandOutOfN {
if-feature psampSampRandOutOfN;
description "n-out-of-N packet Sampling.";
uses sampRandOutOfNParameters;
}
container sampUniProb {
if-feature psampSampUniProb;
description "Uniform probabilistic packet Sampling.";
uses sampUniProbParameters;
}
container filterMatch {
if-feature psampFilterMatch;
description "Property match Filtering.";
uses filterMatchParameters;
}
container filterHash {
if-feature psampFilterHash;
description "Hash-based Filtering.";
uses filterHashParameters;
}
}
leaf packetsObserved {
type yang:counter64;
config false;
description "The number of packets observed at the input of
the Selector.
If this is the first Selector in the Selection Process,
this counter corresponds to the total number of packets in
all Observed Packet Streams at the input of the Selection
Process. Otherwise, the counter corresponds to the total
number of packets at the output of the preceding Selector.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
selectorDiscontinuityTime.
Note that this parameter corresponds to
ipfixSelectorStatsPacketsObserved in the IPFIX MIB
module.";
reference "RFC 6615, Section 8
(ipfixSelectorStatsPacketsObserved).";
}
leaf packetsDropped {
type yang:counter64;
config false;
description "The total number of packets discarded by the
Selector.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
selectorDiscontinuityTime.
Note that this parameter corresponds to
ipfixSelectorStatsPacketsDropped in the IPFIX MIB
module.";
reference "RFC 6615, Section 8
(ipfixSelectorStatsPacketsDropped).";
}
leaf selectorDiscontinuityTime {
type yang:date-and-time;
config false;
description "Timestamp of the most recent occasion at which
one or more of the Selector counters suffered a
discontinuity.
Note that this parameter functionally corresponds to
ipfixSelectionProcessStatsDiscontinuityTime in the IPFIX
MIB module. In contrast to
ipfixSelectionProcessStatsDiscontinuityTime, the time is
absolute and not relative to sysUpTime.";
reference "RFC 6615, Section 8
(ipfixSelectionProcessStatsDiscontinuityTime).";
}
}
grouping cacheLayoutParameters {
description "Cache Layout parameters used by immediateCache,
timeoutCache, naturalCache, and permanentCache.";
container cacheLayout {
description "Cache Layout parameters.";
list cacheField {
key name;
min-elements 1;
description "Superset of fields that are included in the
Packet Reports or Flow Records generated by the Cache.";
leaf name {
type nameType;
description "Key of this list.";
}
choice nameOrId {
mandatory true;
description "Name or identifier of the Information
Element.";
reference "RFC 5102, Section 2; IANA registry for IPFIX
Entities, http://www.iana.org/assignments/ipfix.";
leaf ieName {
type ieNameType;
description "Name of the Information Element.";
}
leaf ieId {
type ieIdType;
description "Identifier of the Information Element.";
}
}
leaf ieLength {
type uint16;
units octets;
description "Length of the field in which the Information
Element is encoded. A value of 65535 specifies a
variable-length Information Element. For Information
Elements of integer and float type, the field length MAY
be set to a smaller value than the standard length of
the abstract data type if the rules of reduced size
encoding are fulfilled.
If not configured by the user, this parameter is set by
the Monitoring Device.";
reference "RFC 5101, Section 6.2.";
}
leaf ieEnterpriseNumber {
type uint32;
default 0;
description "If this parameter is zero, the Information
Element is registered in the IANA registry of IPFIX
Information Elements.
If this parameter is configured with a non-zero private
enterprise number, the Information Element is
enterprise-specific.
If the enterprise number is set to 29305, this field
contains a Reverse Information Element. In this case,
the Cache MUST generate Data Records in accordance to
RFC 5103.";
reference "RFC 5101; RFC 5103;
IANA registry for Private Enterprise Numbers,
http://www.iana.org/assignments/enterprise-numbers;
IANA registry for IPFIX Entities,
http://www.iana.org/assignments/ipfix.";
}
leaf isFlowKey {
when "(name(../../..) != 'immediateCache')
and
((count(../ieEnterpriseNumber) = 0)
or
(../ieEnterpriseNumber != 29305))" {
description "This parameter is not available for
Reverse Information Elements (which have enterprise
number 29305). It is also not available for
immediateCache.";
}
type empty;
description "If present, this is a flow key.";
}
}
}
}
grouping flowCacheParameters {
description "Configuration and state parameters of a Cache
generating Flow Records.";
leaf maxFlows {
type uint32;
units flows;
description "This parameter configures the maximum number of
Flows in the Cache, which is the maximum number of Flows
that can be measured simultaneously.
The Monitoring Device MUST ensure that sufficient resources
are available to store the configured maximum number of
Flows.
If the maximum number of Flows is measured, an additional
Flow can be measured only if an existing entry is removed.
However, traffic that pertains to existing Flows can
continue to be measured.";
}
leaf activeTimeout {
when "(name(..) = 'timeoutCache') or
(name(..) = 'naturalCache')" {
description "This parameter is only available for
timeoutCache and naturalCache.";
}
type uint32;
units seconds;
description "This parameter configures the time in
seconds after which a Flow is expired even though packets
matching this Flow are still received by the Cache.
The parameter value zero indicates infinity, meaning that
there is no active timeout.
If not configured by the user, the Monitoring Device sets
this parameter.
Note that this parameter corresponds to
ipfixMeteringProcessCacheActiveTimeout in the IPFIX
MIB module.";
reference "RFC 6615, Section 8
(ipfixMeteringProcessCacheActiveTimeout).";
}
leaf idleTimeout {
when "(name(..) = 'timeoutCache') or
(name(..) = 'naturalCache')" {
description "This parameter is only available for
timeoutCache and naturalCache.";
}
type uint32;
units seconds;
description "This parameter configures the time in
seconds after which a Flow is expired if no more packets
matching this Flow are received by the Cache.
The parameter value zero indicates infinity, meaning that
there is no idle timeout.
If not configured by the user, the Monitoring Device sets
this parameter.
Note that this parameter corresponds to
ipfixMeteringProcessCacheIdleTimeout in the IPFIX
MIB module.";
reference "RFC 6615, Section 8
(ipfixMeteringProcessCacheIdleTimeout).";
}
leaf exportInterval {
when "name(..) = 'permanentCache'" {
description "This parameter is only available for
permanentCache.";
}
type uint32;
units seconds;
description "This parameter configures the interval (in
seconds) for periodical export of Flow Records.
If not configured by the user, the Monitoring Device sets
this parameter.";
}
leaf activeFlows {
type yang:gauge32;
units flows;
config false;
description "The number of Flows currently active in this
Cache.
Note that this parameter corresponds to
ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB
module.";
reference "RFC 6615, Section 8
(ipfixMeteringProcessCacheActiveFlows).";
}
leaf unusedCacheEntries {
type yang:gauge32;
units flows;
config false;
description "The number of unused Cache entries in this
Cache.
Note that this parameter corresponds to
ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX
MIB module.";
reference "RFC 6615, Section 8
(ipfixMeteringProcessCacheUnusedCacheEntries).";
}
}
grouping exportingProcessParameters {
description "Parameters of an Exporting Process.";
leaf exportingProcessId {
type uint32;
config false;
description "The identifier of the Exporting Process.
This parameter corresponds to the Information Element
exportingProcessId. Its occurrence helps to associate
Exporting Process parameters with Exporing Process
statistics exported by the Monitoring Device using the
Exporting Process Reliability Statistics Template as
defined by the IPFIX protocol specification.";
reference "RFC 5101, Section 4.3; IANA registry for IPFIX
Entities, http://www.iana.org/assignments/ipfix.";
}
leaf exportMode {
type identityref {
base "exportMode";
}
default parallel;
description "This parameter determines to which configured
destination(s) the incoming Data Records are exported.";
}
list destination {
key name;
min-elements 1;
description "List of export destinations.";
leaf name {
type nameType;
description "Key of this list.";
}
choice DestinationParameters {
mandatory true;
description "Configuration parameters depend on whether
SCTP, UDP, or TCP is used as transport protocol, and
whether the destination is a file.";
container sctpExporter {
description "SCTP parameters.";