Simple Fixes to the IP Flow Information Export (IPFIX) IANA Registry
draft-ietf-opsawg-ipfix-fixes-08
| Document | Type | Active Internet-Draft (opsawg WG) | |
|---|---|---|---|
| Authors | Mohamed Boucadair , Benoît Claise | ||
| Last updated | 2024-04-17 | ||
| Replaces | draft-boucla-opsawg-ipfix-fixes | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Intended RFC status | Proposed Standard | ||
| Formats | |||
| Reviews |
TSVART Last Call review
(of
-07)
by Martin Duke
Ready w/nits
GENART Early review
(of
-03)
by Behcet Sarikaya
Almost ready
INTDIR Last Call Review due 2024-04-26
Requested
|
||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Thomas Graf | ||
| Shepherd write-up | Show Last changed 2024-04-08 | ||
| IESG | IESG state | AD Evaluation | |
| Action Holder | |||
| Consensus boilerplate | Yes | ||
| Telechat date | (None) | ||
| Responsible AD | Mahesh Jethanandani | ||
| Send notices to | thomas.graf@swisscom.com |
draft-ietf-opsawg-ipfix-fixes-08
OPSAWG M. Boucadair
Internet-Draft Orange
Intended status: Standards Track B. Claise
Expires: 19 October 2024 Huawei
17 April 2024
Simple Fixes to the IP Flow Information Export (IPFIX) IANA Registry
draft-ietf-opsawg-ipfix-fixes-08
Abstract
This document provides simple fixes to the IANA IP Flow Information
Export (IPFIX) registry. Specifically, this document provides
updates to fix a shortcoming in the description of some Information
Elements (IE), updates to ensure a consistent structure when calling
an existing IANA registry, and updates to fix broken pointers,
orphaned section references, etc. The updates are also meant to
bring some consistency among the entries of the registry.
Discussion Venues
This note is to be removed before publishing as an RFC.
Discussion of this document takes place on the Operations and
Management Area Working Group Working Group mailing list
(opsawg@ietf.org), which is archived at
https://mailarchive.ietf.org/arch/browse/opsawg/.
Source for this draft and an issue tracker can be found at
https://github.com/boucadair/simple-ipfix-fixes.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 19 October 2024.
Boucadair & Claise Expires 19 October 2024 [Page 1]
Internet-Draft IPFIX IANA Fixes April 2024
Copyright Notice
Copyright (c) 2024 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 (https://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 Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Conventions and Definitions . . . . . . . . . . . . . . . . . 5
3. Why An RFC is Needed for These Updates? . . . . . . . . . . . 6
4. Update the Description . . . . . . . . . . . . . . . . . . . 6
4.1. sourceTransportPort . . . . . . . . . . . . . . . . . . . 6
4.1.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.1.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.2. destinationTransportPort . . . . . . . . . . . . . . . . 7
4.2.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.3. forwardingStatus . . . . . . . . . . . . . . . . . . . . 8
4.3.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.3.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.4. collectorTransportPort . . . . . . . . . . . . . . . . . 10
4.4.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.4.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.5. exporterTransportPort . . . . . . . . . . . . . . . . . . 11
4.5.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.5.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 12
5. Point to An Existing IANA Registry . . . . . . . . . . . . . 12
6. Consistent Citation of IANA Registries . . . . . . . . . . . 13
6.1. mplsTopLabelType . . . . . . . . . . . . . . . . . . . . 13
6.1.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 13
6.1.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.2. classificationEngineId . . . . . . . . . . . . . . . . . 14
6.2.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.2.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.3. flowEndReason . . . . . . . . . . . . . . . . . . . . . . 14
6.3.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.3.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.4. natOriginatingAddressRealm . . . . . . . . . . . . . . . 15
6.4.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 15
Boucadair & Claise Expires 19 October 2024 [Page 2]
Internet-Draft IPFIX IANA Fixes April 2024
6.4.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.5. natEvent . . . . . . . . . . . . . . . . . . . . . . . . 16
6.5.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.5.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.6. firewallEvent . . . . . . . . . . . . . . . . . . . . . . 16
6.6.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.6.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.7. biflowDirection . . . . . . . . . . . . . . . . . . . . . 17
6.7.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.7.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.8. observationPointType . . . . . . . . . . . . . . . . . . 18
6.8.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.8.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.9. anonymizationTechnique . . . . . . . . . . . . . . . . . 18
6.9.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.9.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.10. natType . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.10.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 18
6.10.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 19
6.11. selectorAlgorithm . . . . . . . . . . . . . . . . . . . . 20
6.11.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 20
6.11.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 20
6.12. informationElementDataType . . . . . . . . . . . . . . . 20
6.12.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 20
6.12.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 21
6.13. informationElementSemantics . . . . . . . . . . . . . . . 21
6.13.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 21
6.13.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 22
6.14. informationElementUnits . . . . . . . . . . . . . . . . . 22
6.14.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 22
6.14.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 22
6.15. portRangeStart . . . . . . . . . . . . . . . . . . . . . 23
6.15.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 23
6.15.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 23
6.16. portRangeEnd . . . . . . . . . . . . . . . . . . . . . . 23
6.16.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 23
6.16.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 23
6.17. ingressInterfaceType . . . . . . . . . . . . . . . . . . 23
6.17.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 23
6.17.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 24
6.18. egressInterfaceType . . . . . . . . . . . . . . . . . . . 24
6.18.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 24
6.18.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 24
6.19. valueDistributionMethod . . . . . . . . . . . . . . . . . 24
6.19.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 24
6.19.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 25
6.20. flowSelectorAlgorithm . . . . . . . . . . . . . . . . . . 25
6.20.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 25
Boucadair & Claise Expires 19 October 2024 [Page 3]
Internet-Draft IPFIX IANA Fixes April 2024
6.20.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 26
6.21. dataLinkFrameType . . . . . . . . . . . . . . . . . . . . 26
6.21.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 26
6.21.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 26
6.22. mibCaptureTimeSemantics . . . . . . . . . . . . . . . . . 27
6.22.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 27
6.22.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 27
6.23. natQuotaExceededEvent . . . . . . . . . . . . . . . . . . 28
6.23.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 28
6.23.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 28
6.24. natThresholdEvent . . . . . . . . . . . . . . . . . . . . 28
6.24.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . 28
6.24.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . 29
7. Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.1. collectionTimeMilliseconds . . . . . . . . . . . . . . . 29
7.1.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.1.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.2. messageMD5Checksum . . . . . . . . . . . . . . . . . . . 29
7.2.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.2.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.3. anonymizationFlags . . . . . . . . . . . . . . . . . . . 30
7.3.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.3.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 31
7.4. informationElementDescription . . . . . . . . . . . . . . 32
7.4.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 32
7.4.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 32
7.5. distinctCountOfDestinationIPAddress . . . . . . . . . . . 33
7.5.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.5.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.6. externalAddressRealm . . . . . . . . . . . . . . . . . . 33
7.6.1. OLD . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.6.2. NEW . . . . . . . . . . . . . . . . . . . . . . . . . 33
8. Security Considerations . . . . . . . . . . . . . . . . . . . 34
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 34
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 34
10.1. Normative References . . . . . . . . . . . . . . . . . . 34
10.2. Informative References . . . . . . . . . . . . . . . . . 35
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 39
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 39
1. Introduction
When OPSAWG was considering [RFC9565] which updates [RFC7125], the WG
realized that some other parts of the IANA IP Flow Information Export
(IPFIX) registry [IANA-IPFIX] were not up-to-date. This document
intends to update the IANA registry and bring some consistency among
the entries of the registry.
Boucadair & Claise Expires 19 October 2024 [Page 4]
Internet-Draft IPFIX IANA Fixes April 2024
As discussed with IANA during the publication process of [RFC9487],
the "Additional Information" entry in [IANA-IPFIX] should contain a
link to an existing registry, when applicable, as opposed to having:
* A link to an existing registry in the "Description" entry.
* The registry detailed values repeated in the "Description" entry.
This practice has the drawback that the description must be
updated each time the registry is updated.
Therefore, this document lists a set of simple fixes to the IPFIX
IANA registry [IANA-IPFIX]. These fixes are classified as follows:
* Updates that fix a shortcoming in the description of an IE
(Section 4).
* Updates that require adding a pointer to an existing IANA registry
(Section 5).
* Updates that are meant to ensure a consistent structure when
calling an existing IANA registry (Section 6).
* Miscellaneous updates that fix broken pointers, orphaned section
references, etc. (Section 7).
These updates are also meant to facilitate the automatic extraction
of the values maintained in IANA registries (e.g., with a cron job),
required by Collectors to be able to support new IPFIX IEs and, more
importantly, adequately interpret new values in registries specified
by those IPFIX IEs.
Note that, as per Section 5 of [RFC7012], [IANA-IPFIX] is the
normative reference for the IPFIX IEs that were defined in [RFC5102].
Therefore, the updates in this document do not update any part of
[RFC7011].
Likewise, this document is not marked as formally updating [RFC5477],
[RFC5610], [RFC5655], [RFC6235], [RFC6759], [RFC7014], [RFC7015],
[RFC7133], [RFC7270], [RFC8038], and [RFC8158].
2. Conventions and Definitions
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
BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
Boucadair & Claise Expires 19 October 2024 [Page 5]
Internet-Draft IPFIX IANA Fixes April 2024
This document uses the IPFIX-specific terminology (Information
Element, Template, Collector, Data Record, Flow Record, Exporting
Process, Collecting Process, etc.) defined in Section 2 of [RFC7011].
As in [RFC7011], these IPFIX-specific terms have the first letter of
a word capitalized.
3. Why An RFC is Needed for These Updates?
Many of the edits in this document may be handled by the IPFIX
Experts (informally called the IE-DOCTORS [RFC7013]). However, and
given that many of the impacted IEs were created via the IETF stream,
the following from Section 5.1 of [RFC7013] should be followed:
This process should not in any way be construed as allowing the
IE-DOCTORS to overrule IETF consensus. Specifically, Information
Elements in the IANA IE registry that were added with IETF
consensus require IETF consensus for revision or deprecation.
4. Update the Description
4.1. sourceTransportPort
4.1.1. OLD
Description: The source port identifier in the transport header.
For the transport protocols UDP, TCP, and SCTP, this is the source
port number given in the respective header. This field MAY also
be used for future transport protocols that have 16-bit source
port identifiers.
Additional Information: See [RFC0768] for the definition of the UDP
source port field.
See [RFC9293] for the definition of the TCP source port field.
See [RFC9260] for the definition of SCTP.
Additional information on defined UDP and TCP port numbers can be
found at [https://www.iana.org/assignments/service-names-port-
numbers].
4.1.2. NEW
Description: The source port identifier in the transport protocol
header. For transport protocols such as UDP, TCP, SCTP, and DCCP,
this is the source port number given in the respective header.
This field MAY also be used for future transport protocols that
have 16-bit source port identifiers.
Boucadair & Claise Expires 19 October 2024 [Page 6]
Internet-Draft IPFIX IANA Fixes April 2024
Additional Information: See [RFC0768] for the definition of the UDP
source port field.
See [RFC9293] for the definition of the TCP source port field.
See [RFC9260] for the definition of the SCTP source port number
field.
See [RFC4340] for the definition of the DCCP source port field.
See the assigned tranport protocol (e.g., TCP, UDP, DCCP, and
SCTP) port numbers at https://www.iana.org/assignments/service-
names-port-numbers.
4.2. destinationTransportPort
4.2.1. OLD
Description: The destination port identifier in the transport
header. For the transport protocols UDP, TCP, and SCTP, this is
the destination port number given in the respective header. This
field MAY also be used for future transport protocols that have
16-bit destination port identifiers.
Additional Information: See [RFC0768] for the definition of the UDP
source port field.
See [RFC9293] for the definition of the TCP source port field.
See [RFC9260] for the definition of SCTP.
Additional information on defined UDP and TCP port numbers can be
found at [https://www.iana.org/assignments/service-names-port-
numbers].
4.2.2. NEW
Description: The destination port identifier in the transport
protocol header. For transport protocols such as UDP, TCP, SCTP,
and DCCP, this is the source port number given in the respective
header. This field MAY also be used for future transport
protocols that have 16-bit source port identifiers.
Additional Information: See [RFC0768] for the definition of the UDP
destination port field.
See [RFC9293] for the definition of the TCP destination port
field.
Boucadair & Claise Expires 19 October 2024 [Page 7]
Internet-Draft IPFIX IANA Fixes April 2024
See [RFC9260] for the definition of the SCTP destination port
number field.
See [RFC4340] for the definition of the DCCP destination port
field.
See the assigned transport protocol (e.g., TCP, UDP, DCCP, and
SCTP) port numbers at https://www.iana.org/assignments/service-
names-port-numbers.
4.3. forwardingStatus
The current forwardingStatus entry in [IANA-IPFIX] deviates from what
is provided in [RFC7270]. In particular, the registered Abstract
Data Type is unsigned8, while it must be unsigned32. The following
update fixes that issue. The description is also updated to clarify
the use of the reduced-size encoding as per Section 6.2 of [RFC7011].
4.3.1. OLD
Boucadair & Claise Expires 19 October 2024 [Page 8]
Internet-Draft IPFIX IANA Fixes April 2024
- Description: This Information Element describes the forwarding
status of the flow and any attached reasons.
The layout of the encoding is as follows:
MSB - 0 1 2 3 4 5 6 7 - LSB
+---+---+---+---+---+---+---+---+
| Status| Reason code or flags |
+---+---+---+---+---+---+---+---+
See the Forwarding Status sub-registries at
[Forwarding-Status].
Examples:
value : 0x40 = 64
binary: 01000000
decode: 01 -> Forward
000000 -> No further information
value : 0x89 = 137
binary: 10001001
decode: 10 -> Drop
001001 -> Bad TTL
- Additional Information: See "NetFlow Version 9 Flow-Record Format"
[CCO-NF9FMT].
- Abstract Data Type: unsigned8
4.3.2. NEW
Boucadair & Claise Expires 19 October 2024 [Page 9]
Internet-Draft IPFIX IANA Fixes April 2024
- Description: This Information Element describes the forwarding
status of the flow and any attached reasons.
IPFIX reduced-size encoding is used as required.
A structure is currently associated with the first
byte. Future versions may be defined to associate
meanings with the remaining bits.
The current version of the Information Element
should be exported as unsigned8.
The layout of the encoding is as follows:
MSB - 0 1 2 3 4 5 6 7 - LSB
+---+---+---+---+---+---+---+---+
| Status| Reason code or flags |
+---+---+---+---+---+---+---+---+
Examples:
value : 0x40 = 64
binary: 01000000
decode: 01 -> Forward
000000 -> No further information
value : 0x89 = 137
binary: 10001001
decode: 10 -> Drop
001001 -> Bad TTL
- Additional Information: See "NetFlow Version 9 Flow-Record Format"
[CCO-NF9FMT]. See the Forwarding Status sub-registries
at [Forwarding-Status].
- Abstract Data Type: unsigned32
4.4. collectorTransportPort
4.4.1. OLD
Description: The destination port identifier to which the Exporting
Process sends Flow information. For the transport protocols UDP,
TCP, and SCTP, this is the destination port number. This field
MAY also be used for future transport protocols that have 16-bit
source port identifiers.
Additional Information: See [RFC0768] for the definition of the UDP
source port field.
Boucadair & Claise Expires 19 October 2024 [Page 10]
Internet-Draft IPFIX IANA Fixes April 2024
See [RFC9293] for the definition of the TCP source port field.
See [RFC9260] for the definition of SCTP.
Additional information on defined UDP and TCP port numbers can be
found at [https://www.iana.org/assignments/service-names-port-
numbers].
4.4.2. NEW
Description: The destination port identifier to which the Exporting
Process sends Flow information. For transport protocols such as
UDP, TCP, and SCTP, this is the destination port number. This
field MAY also be used for future transport protocols that have
16-bit source port identifiers.
Additional Information: See [RFC0768] for the definition of the UDP
destination port field.
See [RFC9293] for the definition of the TCP destination port
field.
See [RFC9260] for the definition of the SCTP destination port
number field.
See the assigned transport protocol (e.g., TCP, UDP, DCCP, and
SCTP) port numbers at https://www.iana.org/assignments/service-
names-port-numbers.
4.5. exporterTransportPort
4.5.1. OLD
Description: The source port identifier from which the Exporting
Process sends Flow information. For the transport protocols UDP,
TCP, and SCTP, this is the source port number. This field MAY
also be used for future transport protocols that have 16-bit
source port identifiers. This field may be useful for
distinguishing multiple Exporting Processes that use the same IP
address.
Additional Information: See [RFC0768] for the definition of the UDP
source port field.
See [RFC9293] for the definition of the TCP source port field.
See [RFC9260] for the definition of SCTP.
Boucadair & Claise Expires 19 October 2024 [Page 11]
Internet-Draft IPFIX IANA Fixes April 2024
Additional information on defined UDP and TCP port numbers can be
found at [https://www.iana.org/assignments/service-names-port-
numbers].
4.5.2. NEW
Description: The source port identifier to which the Exporting
Process sends Flow information. For transport protocols such as
UDP, TCP, and SCTP, this is the source port number. This field
MAY also be used for future transport protocols that have 16-bit
source port identifiers.
Additional Information: See [RFC0768] for the definition of the UDP
source port field.
See [RFC9293] for the definition of the TCP source port field.
See [RFC9260] for the definition of the SCTP source port number
field.
See the assigned transport protocol (e.g., TCP, UDP, DCCP, and
SCTP) port numbers at https://www.iana.org/assignments/service-
names-port-numbers.
5. Point to An Existing IANA Registry
This document requests IANA to update the following entries by adding
the indicated "Additional Information" to the [IANA-IPFIX] registry:
Boucadair & Claise Expires 19 October 2024 [Page 12]
Internet-Draft IPFIX IANA Fixes April 2024
+=======================+===========================================+
|IE |Additional Information |
+=======================+===========================================+
|icmpTypeCodeIPv4 |https://www.iana.org/assignments/icmp- |
| |parameters/icmp-parameters.xhtml |
+-----------------------+-------------------------------------------+
|igmpType |https://www.iana.org/assignments/igmp-type-|
| |numbers/igmp-type-numbers.xhtml#igmp-type- |
| |numbers-1 |
+-----------------------+-------------------------------------------+
|icmpTypeCodeIPv6 |https://www.iana.org/assignments/icmpv6- |
| |parameters/icmpv6-parameters.xhtml |
+-----------------------+-------------------------------------------+
|icmpTypeIPv4 |https://www.iana.org/assignments/icmp- |
| |parameters/icmp-parameters.xhtml#icmp- |
| |parameters-types |
+-----------------------+-------------------------------------------+
|icmpCodeIPv4 |https://www.iana.org/assignments/icmp- |
| |parameters/icmp-parameters.xhtml#icmp- |
| |parameters-codes |
+-----------------------+-------------------------------------------+
|icmpTypeIPv6 |https://www.iana.org/assignments/icmpv6- |
| |parameters/ |
| |icmpv6-parameters.xhtml#icmpv6-parameters-2|
+-----------------------+-------------------------------------------+
|icmpCodeIPv6 |https://www.iana.org/assignments/icmpv6- |
| |parameters/ |
| |icmpv6-parameters.xhtml#icmpv6-parameters-3|
+-----------------------+-------------------------------------------+
|privateEnterpriseNumber|https://www.iana.org/assignments/ |
| |enterprise-numbers/enterprise-numbers |
+-----------------------+-------------------------------------------+
Table 1: Cite an IANA Registry under Additional Information
6. Consistent Citation of IANA Registries
This document requests IANA to update [IANA-IPFIX] for each of the IE
entries listed in the following subsections.
6.1. mplsTopLabelType
6.1.1. OLD
Description: This field identifies the control protocol that
allocated the top-of-stack label. Values for this field are
listed in the MPLS label type registry.
Boucadair & Claise Expires 19 October 2024 [Page 13]
Internet-Draft IPFIX IANA Fixes April 2024
See https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-mpls-
label-type.
Additional Information: See [RFC3031] for the MPLS label structure.
See the list of MPLS label types assigned by IANA at
[https://www.iana.org/assignments/mpls-label-values].
6.1.2. NEW
Description: This field identifies the control protocol that
allocated the top-of-stack label. Values for this field are
listed in the MPLS label type registry.
Additional Information: See the list of MPLS label types assigned by
IANA at [https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
mpls-label-type].
See [RFC3031] for the MPLS label structure.
6.2. classificationEngineId
6.2.1. OLD
Description: A unique identifier for the engine that determined the
Selector ID. Thus, the Classification Engine ID defines the
context for the Selector ID. The Classification Engine can be
considered a specific registry for application assignments.
Values for this field are listed in the Classification Engine IDs
registry. See https://www.iana.org/assignments/ipfix/
ipfix.xhtml#classification-engine-ids.
6.2.2. NEW
Description: A unique identifier for the engine that determined the
Selector ID. Thus, the Classification Engine ID defines the
context for the Selector ID. The Classification Engine can be
considered a specific registry for application assignments.
Values for this field are listed in the Classification Engine IDs
registry.
Additional Information: See https://www.iana.org/assignments/ipfix/
ipfix.xhtml#classification-engine-ids.
6.3. flowEndReason
Boucadair & Claise Expires 19 October 2024 [Page 14]
Internet-Draft IPFIX IANA Fixes April 2024
6.3.1. OLD
Description: The reason for Flow termination. Values are listed in
the flowEndReason registry. See
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-flow-end-
reason.
6.3.2. NEW
Description: The reason for Flow termination. Values are listed in
the flowEndReason registry.
Additional Information: See the Classification Engine IDs registry
available at [https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-flow-end-reason].
6.4. natOriginatingAddressRealm
6.4.1. OLD
Description: Indicates whether the session was created because
traffic originated in the private or public address realm.
postNATSourceIPv4Address, postNATDestinationIPv4Address,
postNAPTSourceTransportPort, and postNAPTDestinationTransportPort
are qualified with the address realm in perspective.
Values are listed in the natOriginatingAddressRealm registry. See
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-
originating-address-realm.
Additional Information: See [RFC3022] for the definition of NAT.
6.4.2. NEW
Description: Indicates whether the session was created because
traffic originated in the private or public address realm.
postNATSourceIPv4Address, postNATDestinationIPv4Address,
postNAPTSourceTransportPort, and postNAPTDestinationTransportPort
are qualified with the address realm in perspective.
Values are listed in the natOriginatingAddressRealm registry.
Additional Information: See the assigned NAT originating address
realm at [https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-nat-originating-address-realm].
See [RFC3022] for the definition of NAT.
Boucadair & Claise Expires 19 October 2024 [Page 15]
Internet-Draft IPFIX IANA Fixes April 2024
6.5. natEvent
6.5.1. OLD
Description: This Information Element identifies a NAT event. This
IE identifies the type of a NAT event. Examples of NAT events
include, but are not limited to, NAT translation create, NAT
translation delete, Threshold Reached, or Threshold Exceeded, etc.
Values for this Information Element are listed in the "NAT Event
Type" registry, see https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-nat-event-type.
Additional Information: See [RFC3022] for the definition of NAT.
See [RFC3234] for the definition of middleboxes.
See [RFC8158] for the definitions of values 4-16.
6.5.2. NEW
Description: This Information Element identifies a NAT event. This
IE identifies the type of a NAT event. Examples of NAT events
include, but are not limited to, NAT translation create, NAT
translation delete, Threshold Reached, or Threshold Exceeded, etc.
Values for this Information Element are listed in the "NAT Event
Type" registry.
Additional Information: See the assigned NAT Event Types at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-
event-type].
See [RFC3022] for the definition of NAT.
See [RFC3234] for the definition of middleboxes.
See [RFC8158] for the definitions of values 4-16.
6.6. firewallEvent
6.6.1. OLD
Description: Indicates a firewall event. Allowed values are listed
in the firewallEvent registry.
See https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
firewall-event.
Boucadair & Claise Expires 19 October 2024 [Page 16]
Internet-Draft IPFIX IANA Fixes April 2024
6.6.2. NEW
Description: Indicates a firewall event. Allowed values are listed
in the firewallEvent registry.
Additional Information: See the assigned firewall events at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
firewall-event].
6.7. biflowDirection
6.7.1. OLD
Description: A description of the direction assignment method used
to assign the Biflow Source and Destination. This Information
Element MAY be present in a Flow Data Record, or applied to all
flows exported from an Exporting Process or Observation Domain
using IPFIX Options. If this Information Element is not present
in a Flow Record or associated with a Biflow via scope, it is
assumed that the configuration of the direction assignment method
is done out-of-band. Note that when using IPFIX Options to apply
this Information Element to all flows within an Observation Domain
or from an Exporting Process, the Option SHOULD be sent reliably.
If reliable transport is not available (i.e., when using UDP),
this Information Element SHOULD appear in each Flow Record.
Values are listed in the biflowDirection registry. See
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-biflow-
direction].
6.7.2. NEW
Description: A description of the direction assignment method used
to assign the Biflow Source and Destination. This Information
Element MAY be present in a Flow Data Record, or applied to all
flows exported from an Exporting Process or Observation Domain
using IPFIX Options. If this Information Element is not present
in a Flow Record or associated with a Biflow via scope, it is
assumed that the configuration of the direction assignment method
is done out-of-band. Note that when using IPFIX Options to apply
this Information Element to all flows within an Observation Domain
or from an Exporting Process, the Option SHOULD be sent reliably.
If reliable transport is not available (i.e., when using UDP),
this Information Element SHOULD appear in each Flow Record.
Values are listed in the biflowDirection registry.
Additional Information: See the assigned biflow direction values at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-biflow-
direction].
Boucadair & Claise Expires 19 October 2024 [Page 17]
Internet-Draft IPFIX IANA Fixes April 2024
6.8. observationPointType
6.8.1. OLD
Description: Type of observation point. Values are listed in the
observationPointType registry. See
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
observation-point-type.
6.8.2. NEW
Description: Type of observation point. Values are listed in the
observationPointType registry.
Additional Information: See the assigned observation point type at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
observation-point-type].
6.9. anonymizationTechnique
6.9.1. OLD
Description: A description of the anonymization technique applied to
a referenced Information Element within a referenced Template.
Each technique may be applicable only to certain Information
Elements and recommended only for certain Information Elements.
Values are listed in the anonymizationTechnique registry. See
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
anonymization-technique.
6.9.2. NEW
Description: A description of the anonymization technique applied to
a referenced Information Element within a referenced Template.
Each technique may be applicable only to certain Information
Elements and recommended only for certain Information Elements.
Values are listed in the anonymizationTechnique registry.
Additional Information: See the assigned anonymization techniques at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
anonymization-technique].
6.10. natType
6.10.1. OLD
Description: Values are listed in the natType registry.
Boucadair & Claise Expires 19 October 2024 [Page 18]
Internet-Draft IPFIX IANA Fixes April 2024
See https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-
type.
Additional Information: See [RFC3022] for the definition of NAT.
See [RFC1631] for the definition of NAT44.
See [RFC6144] for the definition of NAT64.
See [RFC6146] for the definition of NAT46.
See [RFC6296] for the definition of NAT66.
See [RFC0791] for the definition of IPv4.
See [RFC8200] for the definition of IPv6.
6.10.2. NEW
Description: This Information Element identifies the NAT type
applied to packets of the Flow.
Values are listed in the natType registry.
Additional Information: See the assigned NAT types at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-
type].
See [RFC3022] for the definition of NAT.
See [RFC3022] for the definition of NAT44.
See [RFC6144] for the definition of NAT46.
See [RFC6146] for the definition of NAT64.
See [RFC6296] for the definition of NPTv6.
See [RFC0791] for the definition of IPv4.
See [RFC8200] for the definition of IPv6.
Note to IANA: This change also corrects errors in the pointers
provided for NAT46/NAT64.
Boucadair & Claise Expires 19 October 2024 [Page 19]
Internet-Draft IPFIX IANA Fixes April 2024
6.11. selectorAlgorithm
6.11.1. OLD
Description: This Information Element identifies the packet
selection methods (e.g., Filtering, Sampling) that are applied by
the Selection Process. Most of these methods have parameters.
Further Information Elements are needed to fully specify packet
selection with these methods and all their parameters. The
methods listed below are defined in [RFC5475]. For their
parameters, Information Elements are defined in the information
model document. The names of these Information Elements are
listed for each method identifier. Further method identifiers may
be added to the list below. It might be necessary to define new
Information Elements to specify their parameters.
The following packet selection methods identifiers are defined
here: https://www.iana.org/assignments/psamp-parameters.
There is a broad variety of possible parameters that could be used
for Property match Filtering (5) but currently there are no agreed
parameters specified.
6.11.2. NEW
Description: This Information Element identifies the packet
selection methods (e.g., Filtering, Sampling) that are applied by
the Selection Process. Most of these methods have parameters.
Further Information Elements are needed to fully specify packet
selection with these methods and all their parameters. For the
methods parameters, Information Elements are defined in the
information model document. The names of these Information
Elements are listed for each method identifier. Further method
identifiers may be added to the list. It might be necessary to
define new Information Elements to specify their parameters.
There is a broad variety of possible parameters that could be used
for Property match Filtering (5) but currently there are no agreed
parameters specified.
Additional Information: See the assigned PSAMP parameters at
[https://www.iana.org/assignments/psamp-parameters].
6.12. informationElementDataType
6.12.1. OLD
Description: A description of the abstract data type of an IPFIX
Boucadair & Claise Expires 19 October 2024 [Page 20]
Internet-Draft IPFIX IANA Fixes April 2024
information element. These are taken from the abstract data types
defined in section 3.1 of the IPFIX Information Model [RFC5102];
see that section for more information on the types described in
the [informationElementDataType] subregistry. These types are
registered in the IANA IPFIX Information Element Data Type
subregistry. This subregistry is intended to assign numbers for
type names, not to provide a mechanism for adding data types to
the IPFIX Protocol, and as such requires a Standards Action
[RFC8126] to modify.
6.12.2. NEW
Description: A description of the abstract data type of an IPFIX
information element.These are taken from the abstract data types
defined in Section 3.1 of the IPFIX Information Model [RFC5102];
see that section for more information on the types described in
the [informationElementDataType] subregistry. These types are
registered in the IANA IPFIX Information Element Data Type
subregistry.
The [informationElementDataType] subregistry is intended to assign
numbers for type names, not to provide a mechanism for adding data
types to the IPFIX Protocol, and as such requires a Standards
Action [RFC8126] to modify.
Additional Information: See the assigned emelement data types at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
information-element-data-types].
6.13. informationElementSemantics
6.13.1. OLD
Description: A description of the semantics of an IPFIX Information
Element. These are taken from the data type semantics defined in
section 3.2 of the IPFIX Information Model [RFC5102]; see that
section for more information on the types defined in the [IPFIX
Information Element Semantics] subregistry. This field may take
the values in the semantics registry; the special value 0x00
(default) is used to note that no semantics apply to the field; it
cannot be manipulated by a Collecting Process or File Reader that
does not understand it a priori. These semantics are registered
in the IANA IPFIX Information Element Semantics subregistry. This
subregistry is intended to assign numbers for semantics names, not
to provide a mechanism for adding semantics to the IPFIX Protocol,
and as such requires a Standards Action [RFC8126] to modify.
Boucadair & Claise Expires 19 October 2024 [Page 21]
Internet-Draft IPFIX IANA Fixes April 2024
6.13.2. NEW
Description: A description of the semantics of an IPFIX Information
Element. These are taken from the data type semantics defined in
Section 3.2 of the IPFIX Information Model [RFC5102]; see that
section for more information on the types defined in the [IPFIX
Information Element Semantics] subregistry. This field may take
the values in the [IPFIX Information Element Semantics]
subregistry; the special value 0x00 (default) is used to note that
no semantics apply to the field; it cannot be manipulated by a
Collecting Process or File Reader that does not understand it a
priori.
The [IPFIX Information Element Semantics] subregistry is intended
to assign numbers for semantics names, not to provide a mechanism
for adding semantics to the IPFIX Protocol, and as such requires a
Standards Action [RFC8126] to modify.
Additional Information: See the assigned semantics of an IPFIX
Information Element at [https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-information-element-semantic].
6.14. informationElementUnits
6.14.1. OLD
Description: A description of the units of an IPFIX Information
Element. These correspond to the units implicitly defined in the
Information Element definitions in section 5 of the IPFIX
Information Model [RFC5102]; see that section for more information
on the types described in the informationElementsUnits
subregistry. This field may take the values in Table 3 below; the
special value 0x00 (none) is used to note that the field is
unitless. These types are registered in the [IANA IPFIX
Information Element Units] subregistry.
6.14.2. NEW
Description: A description of the units of an IPFIX Information
Element. These correspond to the units implicitly defined in the
Information Element definitions in Section 5 of the IPFIX
Information Model [RFC5102]; see that section for more information
on the types described in the informationElementsUnits
subregistry. These types can take the values in the [IANA IPFIX
Information Element Units] subregistry. The special value 0x00
(none) is used to note that the field is unitless.
Additional Information: See the assigned units of an IPFIX
Boucadair & Claise Expires 19 October 2024 [Page 22]
Internet-Draft IPFIX IANA Fixes April 2024
Information Element at [IANA IPFIX Information Element Units].
6.15. portRangeStart
6.15.1. OLD
Description: The port number identifying the start of a range of
ports. A value of zero indicates that the range start is not
specified, ie the range is defined in some other way.
Additional information on defined TCP port numbers can be found at
https://www.iana.org/assignments/service-names-port-numbers.
6.15.2. NEW
Description: The port number identifying the start of a range of
port numbers. A value of zero indicates that the range start is
not specified, i.e., the range is defined in some other way.
Additional Information: See the assigned transport protocol (e.g.,
TCP, UDP, DCCP, and SCTP) port numbers at
https://www.iana.org/assignments/service-names-port-numbers.
6.16. portRangeEnd
6.16.1. OLD
Description: The port number identifying the end of a range of
ports. A value of zero indicates that the range end is not
specified, ie the range is defined in some other way. Additional
information on defined TCP port numbers can be found at
https://www.iana.org/assignments/service-names-port-numbers.
6.16.2. NEW
Description: The port number identifying the end of a range of port
numbers. A value of zero indicates that the range end is not
specified, i.e., the range is defined in some other way.
Additional Information: See the assigned transport protocol (e.g.,
TCP, UDP, DCCP, and SCTP) port numbers at
https://www.iana.org/assignments/service-names-port-numbers.
6.17. ingressInterfaceType
6.17.1. OLD
Description: The type of interface where packets of this Flow are
Boucadair & Claise Expires 19 October 2024 [Page 23]
Internet-Draft IPFIX IANA Fixes April 2024
being received. The value matches the value of managed object
'ifType' as defined in https://www.iana.org/assignments/
ianaiftype-mib.
Additional Information: https://www.iana.org/assignments/ianaiftype-
mib
6.17.2. NEW
Description: The type of interface where packets of this Flow are
being received. The value matches the value of managed object
'ifType'.
Additional Information: See the assigned ingress interface types at
[https://www.iana.org/assignments/ianaiftype-mib].
6.18. egressInterfaceType
6.18.1. OLD
Description: The type of interface where packets of this Flow are
being sent. The value matches the value of managed object
'ifType' as defined in https://www.iana.org/assignments/
ianaiftype-mib.
Additional Information: https://www.iana.org/assignments/ianaiftype-
mib
6.18.2. NEW
Description: The type of interface where packets of this Flow are
being sent. The value matches the value of managed object
'ifType'.
Additional Information: See the assigned egress interface types at
[https://www.iana.org/assignments/ianaiftype-mib].
6.19. valueDistributionMethod
6.19.1. OLD
Description: A description of the method used to distribute the
counters from Contributing Flows into the Aggregated Flow records
described by an associated scope, generally a Template. The
method is deemed to apply to all the non-key Information Elements
in the referenced scope for which value distribution is a valid
operation; if the originalFlowsInitiated and/or
originalFlowsCompleted Information Elements appear in the
Boucadair & Claise Expires 19 October 2024 [Page 24]
Internet-Draft IPFIX IANA Fixes April 2024
Template, they are not subject to this distribution method, as
they each infer their own distribution method. The
valueDistributionMethod registry is intended to list a complete
set of possible value distribution methods.
See https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
value-distribution-method.
6.19.2. NEW
Description: A description of the method used to distribute the
counters from Contributing Flows into the Aggregated Flow records
described by an associated scope, generally a Template. The
method is deemed to apply to all the non-key Information Elements
in the referenced scope for which value distribution is a valid
operation; if the originalFlowsInitiated and/or
originalFlowsCompleted Information Elements appear in the
Template, they are not subject to this distribution method, as
they each infer their own distribution method. The
valueDistributionMethod registry is intended to list a complete
set of possible value distribution methods.
Additional Information: See the assigned value distribution methods
at [https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
value-distribution-method].
6.20. flowSelectorAlgorithm
6.20.1. OLD
Description: This Information Element identifies the Intermediate
Flow Selection Process technique (e.g., Filtering, Sampling) that
is applied by the Intermediate Flow Selection Process. Most of
these techniques have parameters. Its configuration parameter(s)
MUST be clearly specified. Further Information Elements are
needed to fully specify packet selection with these methods and
all their parameters. Further method identifiers may be added to
the flowSelectorAlgorithm registry. It might be necessary to
define new Information Elements to specify their parameters.
Please note that the purpose of the flow selection techniques
described in this document is the improvement of measurement
functions as defined in the Scope (Section 1).
The Intermediate Flow Selection Process Techniques identifiers are
defined at https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-flowselectoralgorithm.
Boucadair & Claise Expires 19 October 2024 [Page 25]
Internet-Draft IPFIX IANA Fixes April 2024
6.20.2. NEW
Description: This Information Element identifies the Intermediate
Flow Selection Process technique (e.g., Filtering, Sampling) that
is applied by the Intermediate Flow Selection Process. Most of
these techniques have parameters. Its configuration parameter(s)
MUST be clearly specified. Further Information Elements are
needed to fully specify packet selection with these methods and
all their parameters. Further method identifiers may be added to
the flowSelectorAlgorithm registry. It might be necessary to
define new Information Elements to specify their parameters.
Additional Information: See the assigned flow selector algorithms at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-
flowselectoralgorithm].
6.21. dataLinkFrameType
6.21.1. OLD
Description: This Information Element specifies the type of the
selected data link frame. Data link types are defined in the
dataLinkFrameType registry. See
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-data-
link-frame-type.
Further values may be assigned by IANA. Note that the assigned
values are bits so that multiple observations can be OR'd
together. The data link layer is defined in [ISO/
IEC.7498-1:1994].
Additional Information: (IEEE802.3)(IEEE802.11)(ISO/IEC.7498-1:1994)
6.21.2. NEW
Description: This Information Element specifies the type of the
selected data link frame. Data link types are defined in the
dataLinkFrameType registry.
Further values may be assigned by IANA. Note that the assigned
values are bits so that multiple observations can be OR'd
together.
Additional Information: See the assigned data link frame types at
[https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-data-
link-frame-type].
More information about the data link layer can be found in
Boucadair & Claise Expires 19 October 2024 [Page 26]
Internet-Draft IPFIX IANA Fixes April 2024
(IEEE802.3)(IEEE802.11)(ISO/IEC.7498-1:1994).
6.22. mibCaptureTimeSemantics
6.22.1. OLD
Description: Indicates when in the lifetime of the Flow the MIB
value was retrieved from the MIB for a mibObjectIdentifier. This
is used to indicate if the value exported was collected from the
MIB closer to Flow creation or Flow export time and refers to the
Timestamp fields included in the same Data Record.
This field SHOULD be used when exporting a mibObjectValue that
specifies counters or statistics. If the MIB value was sampled by
SNMP prior to the IPFIX Metering Process or Exporting Process
retrieving the value (i.e., the data is already stale) and it is
important to know the exact sampling time, then an additional
observationTime* element should be paired with the OID using IPFIX
Structured Data [RFC6313]. Similarly, if different MIB capture
times apply to different mibObjectValue elements within the Data
Record, then individual mibCaptureTimeSemantics Information
Elements should be paired with each OID using IPFIX Structured
Data.
Values are listed in the mibCaptureTimeSemantics registry. See
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-mib-
capture-time-semantics.
6.22.2. NEW
Description: Indicates when in the lifetime of the Flow the MIB
value was retrieved from the MIB for a mibObjectIdentifier. This
is used to indicate if the value exported was collected from the
MIB closer to Flow creation or Flow export time and refers to the
Timestamp fields included in the same Data Record.
This field SHOULD be used when exporting a mibObjectValue that
specifies counters or statistics. If the MIB value was sampled by
SNMP prior to the IPFIX Metering Process or Exporting Process
retrieving the value (i.e., the data is already stale) and it is
important to know the exact sampling time, then an additional
observationTime* element should be paired with the OID using IPFIX
Structured Data [RFC6313]. Similarly, if different MIB capture
times apply to different mibObjectValue elements within the Data
Record, then individual mibCaptureTimeSemantics Information
Elements should be paired with each OID using IPFIX Structured
Data.
Boucadair & Claise Expires 19 October 2024 [Page 27]
Internet-Draft IPFIX IANA Fixes April 2024
Values are listed in the mibCaptureTimeSemantics registry.
Additional Information: See the assigned values for the MIB capture
time semantics at [https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-mib-capture-time-semantics].
6.23. natQuotaExceededEvent
6.23.1. OLD
Description: This Information Element identifies the type of a NAT
Quota Exceeded event. Values for this Information Element are
listed in the "NAT Quota Exceeded Event Type" registry, see
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-
quota-exceeded-event.
Additional Information: See [RFC0791] for the definition of the IPv4
source address field.
See [RFC3022] for the definition of NAT.
See [RFC3234] for the definition of middleboxes.
6.23.2. NEW
Description: This Information Element identifies the type of a NAT
Quota Exceeded event. Values for this Information Element are
listed in the "NAT Quota Exceeded Event Type" registry.
Additional Information: See the assigned events for exceeded NAT
quota at [https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-nat-quota-exceeded-event].
See [RFC0791] for the definition of the IPv4 source address field.
See [RFC3022] for the definition of NAT.
See [RFC3234] for the definition of middleboxes.
6.24. natThresholdEvent
6.24.1. OLD
Description: This Information Element identifies a type of a NAT
Threshold event. Values for this Information Element are listed
in the "NAT Threshold Event Type" registry, see
https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-
threshold-event.
Boucadair & Claise Expires 19 October 2024 [Page 28]
Internet-Draft IPFIX IANA Fixes April 2024
Additional Information: See [RFC0791] for the definition of the IPv4
source address field.
See [RFC3022] for the definition of NAT.
See [RFC3234] for the definition of middleboxes.
6.24.2. NEW
Description: This Information Element identifies a type of a NAT
Threshold event. Values for this Information Element are listed
in the "NAT Threshold Event Type" registry.
Additional Information: See the assigned values for the NAT
Threshold events at [https://www.iana.org/assignments/ipfix/
ipfix.xhtml#ipfix-nat-threshold-event].
See [RFC0791] for the definition of the IPv4 source address field.
See [RFC3022] for the definition of NAT.
See [RFC3234] for the definition of middleboxes.
7. Misc
This document requests IANA to update the description of the
following entries in [IANA-IPFIX].
7.1. collectionTimeMilliseconds
7.1.1. OLD
Description: The absolute timestamp at which the data within the
scope containing this Information Element was received by a
Collecting Process. This Information Element SHOULD be bound to
its containing IPFIX Message via IPFIX Options and the
messageScope Information Element, as defined below.
7.1.2. NEW
Description: The absolute timestamp at which the data within the
scope containing this Information Element was received by a
Collecting Process. This Information Element SHOULD be bound to
its containing IPFIX Message via IPFIX Options and the
messageScope Information Element.
7.2. messageMD5Checksum
Boucadair & Claise Expires 19 October 2024 [Page 29]
Internet-Draft IPFIX IANA Fixes April 2024
7.2.1. OLD
Description: The MD5 checksum of the IPFIX Message containing this
record. This Information Element SHOULD be bound to its
containing IPFIX Message via an options record and the
messageScope Information Element, as defined below, and SHOULD
appear only once in a given IPFIX Message. To calculate the value
of this Information Element, first buffer the containing IPFIX
Message, setting the value of this Information Element to all
zeroes. Then calculate the MD5 checksum of the resulting buffer
as defined in [RFC1321], place the resulting value in this
Information Element, and export the buffered message.
This Information Element is intended as a simple checksum only;
therefore collision resistance and algorithm agility are not
required, and MD5 is an appropriate message digest. This
Information Element has a fixed length of 16 octets.
7.2.2. NEW
Description: The MD5 checksum of the IPFIX Message containing this
record. This Information Element SHOULD be bound to its
containing IPFIX Message via an options record and the
messageScope Information Element, and SHOULD appear only once in a
given IPFIX Message. To calculate the value of this Information
Element, first buffer the containing IPFIX Message, setting the
value of this Information Element to all zeroes. Then calculate
the MD5 checksum of the resulting buffer as defined in [RFC1321],
place the resulting value in this Information Element, and export
the buffered message.
This Information Element is intended as a simple checksum only;
therefore collision resistance and algorithm agility are not
required, and MD5 is an appropriate message digest. This
Information Element has a fixed length of 16 octets.
7.3. anonymizationFlags
7.3.1. OLD
Boucadair & Claise Expires 19 October 2024 [Page 30]
Internet-Draft IPFIX IANA Fixes April 2024
+--------+----------+-----------------------------------------------+
| bit(s) | name | description |
| (LSB = | | |
| 0) | | |
+--------+----------+-----------------------------------------------+
| 0-1 | SC | Stability Class: see the Stability Class |
| | | table below, and section Section 5.1. |
| 2 | PmA | Perimeter Anonymization: when set (1), |
| | | source- Information Elements as described in |
| | | [RFC5103] are interpreted as external |
| | | addresses, and destination- Information |
| | | Elements as described in [RFC5103] are |
| | | interpreted as internal addresses, for the |
| | | purposes of associating |
| | | anonymizationTechnique to Information |
| | | Elements only; see Section 7.2.2 for details. |
| | | This bit MUST NOT be set when associated with |
| | | a non-endpoint (i.e., source- or |
| | | destination-) Information Element. SHOULD be |
| | | consistent within a record (i.e., if a |
| | | source- Information Element has this flag |
| | | set, the corresponding destination- element |
| | | SHOULD have this flag set, and vice-versa.) |
+--------+----------+-----------------------------------------------+
7.3.2. NEW
Boucadair & Claise Expires 19 October 2024 [Page 31]
Internet-Draft IPFIX IANA Fixes April 2024
+--------+----------+-----------------------------------------------+
| bit(s) | name | description |
| (LSB = | | |
| 0) | | |
+--------+----------+-----------------------------------------------+
| 0-1 | SC | Stability Class: see the Stability Class |
| | | table below, and Section 5.1 of [RFC6235]. |
| 2 | PmA | Perimeter Anonymization: when set (1), |
| | | source- Information Elements as described in |
| | | [RFC5103] are interpreted as external |
| | | addresses, and destination- Information |
| | | Elements as described in [RFC5103] are |
| | | interpreted as internal addresses, for the |
| | | purposes of associating |
| | | anonymizationTechnique to Information |
| | | Elements only; see Section 7.2.2 of [RFC6235] |
| | | for details. |
| | | This bit MUST NOT be set when associated with |
| | | a non-endpoint (i.e., source- or |
| | | destination-) Information Element. SHOULD be |
| | | consistent within a record (i.e., if a |
| | | source- Information Element has this flag |
| | | set, the corresponding destination- element |
| | | SHOULD have this flag set, and vice versa.) |
+--------+----------+-----------------------------------------------+
7.4. informationElementDescription
7.4.1. OLD
Description: A UTF-8 [RFC3629] encoded Unicode string containing a
human-readable description of an Information Element. The content
of the informationElementDescription MAY be annotated with one or
more language tags [RFC4646], encoded in-line [RFC2482] within the
UTF-8 string, in order to specify the language in which the
description is written. Description text in multiple languages
MAY tag each section with its own language tag; in this case, the
description information in each language SHOULD have equivalent
meaning. In the absence of any language tag, the "i-default"
[RFC2277] language SHOULD be assumed.
See the Security Considerations section for notes on string
handling for Information Element type records.
7.4.2. NEW
Description: A UTF-8 [RFC3629] encoded Unicode string containing a
Boucadair & Claise Expires 19 October 2024 [Page 32]
Internet-Draft IPFIX IANA Fixes April 2024
human-readable description of an Information Element. The content
of the informationElementDescription MAY be annotated with one or
more language tags [RFC4646], encoded in-line [RFC2482] within the
UTF-8 string, in order to specify the language in which the
description is written. Description text in multiple languages
MAY tag each section with its own language tag; in this case, the
description information in each language SHOULD have equivalent
meaning. In the absence of any language tag, the "i-default"
[RFC2277] language SHOULD be assumed.
See the Security Considerations Section of [RFC5610] for notes on
string handling for Information Element type records.
7.5. distinctCountOfDestinationIPAddress
7.5.1. OLD
Description: The count of distinct destination IP address values for
Original Flows contributing to this Aggregated Flow, without
regard to IP version. This Information Element is preferred to
the version-specific counters below, unless it is important to
separate the counts by version.
7.5.2. NEW
Description: The count of distinct destination IP address values for
Original Flows contributing to this Aggregated Flow, without
regard to IP version. This Information Element is preferred to
the version-specific counters, unless it is important to separate
the counts by version.
7.6. externalAddressRealm
7.6.1. OLD
Description: This Information Element represents the external
address realm where the packet is originated from or destined to.
The detailed definition is in the internal address realm as
specified above.
7.6.2. NEW
Description: This Information Element represents the external
address realm where the packet is originated from or destined to.
See the internalAddressRealm IE for the detailed definition.
Boucadair & Claise Expires 19 October 2024 [Page 33]
Internet-Draft IPFIX IANA Fixes April 2024
8. Security Considerations
This document does not add new security considerations to those
already discussed for IPFIX in Section 8 of [RFC7012].
9. IANA Considerations
Sections 4 to 7 include actions for IANA. These actions are not
repeated here.
This document also requests IANA to update the reference clause of
the "IPFIX Information Elements" registry [IANA-IPFIX] with the
reference to this document.
Also, this document requests IANA to consistently reference the
"Service Name and Transport Protocol Port Number" through the
registry as follows
OLD: Additional information on defined UDP and TCP port numbers can
be found at http://www.iana.org/assignments/port-numbers.
NEW: See the assigned transport protocol (e.g., TCP, UDP, DCCP, and
SCTP) port numbers at https://www.iana.org/assignments/service-
names-port-numbers.
10. References
10.1. Normative References
[IANA-IPFIX]
IANA, "IP Flow Information Export (IPFIX) Entities",
<https://www.iana.org/assignments/ipfix/ipfix.xhtml>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/rfc/rfc2119>.
[RFC7011] Claise, B., Ed., Trammell, B., Ed., and P. Aitken,
"Specification of the IP Flow Information Export (IPFIX)
Protocol for the Exchange of Flow Information", STD 77,
RFC 7011, DOI 10.17487/RFC7011, September 2013,
<https://www.rfc-editor.org/rfc/rfc7011>.
[RFC7012] Claise, B., Ed. and B. Trammell, Ed., "Information Model
for IP Flow Information Export (IPFIX)", RFC 7012,
DOI 10.17487/RFC7012, September 2013,
<https://www.rfc-editor.org/rfc/rfc7012>.
Boucadair & Claise Expires 19 October 2024 [Page 34]
Internet-Draft IPFIX IANA Fixes April 2024
[RFC7013] Trammell, B. and B. Claise, "Guidelines for Authors and
Reviewers of IP Flow Information Export (IPFIX)
Information Elements", BCP 184, RFC 7013,
DOI 10.17487/RFC7013, September 2013,
<https://www.rfc-editor.org/rfc/rfc7013>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/rfc/rfc8174>.
10.2. Informative References
[CCO-NF9FMT]
Cisco, "NetFlow Version 9 Flow-Record Format", May 2011,
<https://www.cisco.com/en/US/technologies/tk648/tk362/
technologies_white_paper09186a00800a3db9.html>.
[Forwarding-Status]
IANA, "Forwarding Status (Value 89)",
<https://www.iana.org/assignments/ipfix/
ipfix.xhtml#forwarding-status>.
[RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768,
DOI 10.17487/RFC0768, August 1980,
<https://www.rfc-editor.org/rfc/rfc768>.
[RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791,
DOI 10.17487/RFC0791, September 1981,
<https://www.rfc-editor.org/rfc/rfc791>.
[RFC1321] Rivest, R., "The MD5 Message-Digest Algorithm", RFC 1321,
DOI 10.17487/RFC1321, April 1992,
<https://www.rfc-editor.org/rfc/rfc1321>.
[RFC1631] Egevang, K. and P. Francis, "The IP Network Address
Translator (NAT)", RFC 1631, DOI 10.17487/RFC1631, May
1994, <https://www.rfc-editor.org/rfc/rfc1631>.
[RFC2277] Alvestrand, H., "IETF Policy on Character Sets and
Languages", BCP 18, RFC 2277, DOI 10.17487/RFC2277,
January 1998, <https://www.rfc-editor.org/rfc/rfc2277>.
[RFC2482] Whistler, K. and G. Adams, "Language Tagging in Unicode
Plain Text", RFC 2482, DOI 10.17487/RFC2482, January 1999,
<https://www.rfc-editor.org/rfc/rfc2482>.
Boucadair & Claise Expires 19 October 2024 [Page 35]
Internet-Draft IPFIX IANA Fixes April 2024
[RFC3022] Srisuresh, P. and K. Egevang, "Traditional IP Network
Address Translator (Traditional NAT)", RFC 3022,
DOI 10.17487/RFC3022, January 2001,
<https://www.rfc-editor.org/rfc/rfc3022>.
[RFC3031] Rosen, E., Viswanathan, A., and R. Callon, "Multiprotocol
Label Switching Architecture", RFC 3031,
DOI 10.17487/RFC3031, January 2001,
<https://www.rfc-editor.org/rfc/rfc3031>.
[RFC3234] Carpenter, B. and S. Brim, "Middleboxes: Taxonomy and
Issues", RFC 3234, DOI 10.17487/RFC3234, February 2002,
<https://www.rfc-editor.org/rfc/rfc3234>.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
2003, <https://www.rfc-editor.org/rfc/rfc3629>.
[RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram
Congestion Control Protocol (DCCP)", RFC 4340,
DOI 10.17487/RFC4340, March 2006,
<https://www.rfc-editor.org/rfc/rfc4340>.
[RFC4646] Phillips, A. and M. Davis, "Tags for Identifying
Languages", RFC 4646, DOI 10.17487/RFC4646, September
2006, <https://www.rfc-editor.org/rfc/rfc4646>.
[RFC5102] Quittek, J., Bryant, S., Claise, B., Aitken, P., and J.
Meyer, "Information Model for IP Flow Information Export",
RFC 5102, DOI 10.17487/RFC5102, January 2008,
<https://www.rfc-editor.org/rfc/rfc5102>.
[RFC5103] Trammell, B. and E. Boschi, "Bidirectional Flow Export
Using IP Flow Information Export (IPFIX)", RFC 5103,
DOI 10.17487/RFC5103, January 2008,
<https://www.rfc-editor.org/rfc/rfc5103>.
[RFC5475] Zseby, T., Molina, M., Duffield, N., Niccolini, S., and F.
Raspall, "Sampling and Filtering Techniques for IP Packet
Selection", RFC 5475, DOI 10.17487/RFC5475, March 2009,
<https://www.rfc-editor.org/rfc/rfc5475>.
[RFC5477] Dietz, T., Claise, B., Aitken, P., Dressler, F., and G.
Carle, "Information Model for Packet Sampling Exports",
RFC 5477, DOI 10.17487/RFC5477, March 2009,
<https://www.rfc-editor.org/rfc/rfc5477>.
Boucadair & Claise Expires 19 October 2024 [Page 36]
Internet-Draft IPFIX IANA Fixes April 2024
[RFC5610] Boschi, E., Trammell, B., Mark, L., and T. Zseby,
"Exporting Type Information for IP Flow Information Export
(IPFIX) Information Elements", RFC 5610,
DOI 10.17487/RFC5610, July 2009,
<https://www.rfc-editor.org/rfc/rfc5610>.
[RFC5655] Trammell, B., Boschi, E., Mark, L., Zseby, T., and A.
Wagner, "Specification of the IP Flow Information Export
(IPFIX) File Format", RFC 5655, DOI 10.17487/RFC5655,
October 2009, <https://www.rfc-editor.org/rfc/rfc5655>.
[RFC6144] Baker, F., Li, X., Bao, C., and K. Yin, "Framework for
IPv4/IPv6 Translation", RFC 6144, DOI 10.17487/RFC6144,
April 2011, <https://www.rfc-editor.org/rfc/rfc6144>.
[RFC6146] Bagnulo, M., Matthews, P., and I. van Beijnum, "Stateful
NAT64: Network Address and Protocol Translation from IPv6
Clients to IPv4 Servers", RFC 6146, DOI 10.17487/RFC6146,
April 2011, <https://www.rfc-editor.org/rfc/rfc6146>.
[RFC6235] Boschi, E. and B. Trammell, "IP Flow Anonymization
Support", RFC 6235, DOI 10.17487/RFC6235, May 2011,
<https://www.rfc-editor.org/rfc/rfc6235>.
[RFC6296] Wasserman, M. and F. Baker, "IPv6-to-IPv6 Network Prefix
Translation", RFC 6296, DOI 10.17487/RFC6296, June 2011,
<https://www.rfc-editor.org/rfc/rfc6296>.
[RFC6313] Claise, B., Dhandapani, G., Aitken, P., and S. Yates,
"Export of Structured Data in IP Flow Information Export
(IPFIX)", RFC 6313, DOI 10.17487/RFC6313, July 2011,
<https://www.rfc-editor.org/rfc/rfc6313>.
[RFC6759] Claise, B., Aitken, P., and N. Ben-Dvora, "Cisco Systems
Export of Application Information in IP Flow Information
Export (IPFIX)", RFC 6759, DOI 10.17487/RFC6759, November
2012, <https://www.rfc-editor.org/rfc/rfc6759>.
[RFC7014] D'Antonio, S., Zseby, T., Henke, C., and L. Peluso, "Flow
Selection Techniques", RFC 7014, DOI 10.17487/RFC7014,
September 2013, <https://www.rfc-editor.org/rfc/rfc7014>.
[RFC7015] Trammell, B., Wagner, A., and B. Claise, "Flow Aggregation
for the IP Flow Information Export (IPFIX) Protocol",
RFC 7015, DOI 10.17487/RFC7015, September 2013,
<https://www.rfc-editor.org/rfc/rfc7015>.
Boucadair & Claise Expires 19 October 2024 [Page 37]
Internet-Draft IPFIX IANA Fixes April 2024
[RFC7125] Trammell, B. and P. Aitken, "Revision of the
tcpControlBits IP Flow Information Export (IPFIX)
Information Element", RFC 7125, DOI 10.17487/RFC7125,
February 2014, <https://www.rfc-editor.org/rfc/rfc7125>.
[RFC7133] Kashima, S., Kobayashi, A., Ed., and P. Aitken,
"Information Elements for Data Link Layer Traffic
Measurement", RFC 7133, DOI 10.17487/RFC7133, May 2014,
<https://www.rfc-editor.org/rfc/rfc7133>.
[RFC7270] Yourtchenko, A., Aitken, P., and B. Claise, "Cisco-
Specific Information Elements Reused in IP Flow
Information Export (IPFIX)", RFC 7270,
DOI 10.17487/RFC7270, June 2014,
<https://www.rfc-editor.org/rfc/rfc7270>.
[RFC8038] Aitken, P., Ed., Claise, B., S, S. B., McDowall, C., and
J. Schoenwaelder, "Exporting MIB Variables Using the IP
Flow Information Export (IPFIX) Protocol", RFC 8038,
DOI 10.17487/RFC8038, May 2017,
<https://www.rfc-editor.org/rfc/rfc8038>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/rfc/rfc8126>.
[RFC8158] Sivakumar, S. and R. Penno, "IP Flow Information Export
(IPFIX) Information Elements for Logging NAT Events",
RFC 8158, DOI 10.17487/RFC8158, December 2017,
<https://www.rfc-editor.org/rfc/rfc8158>.
[RFC8200] Deering, S. and R. Hinden, "Internet Protocol, Version 6
(IPv6) Specification", STD 86, RFC 8200,
DOI 10.17487/RFC8200, July 2017,
<https://www.rfc-editor.org/rfc/rfc8200>.
[RFC9260] Stewart, R., Tüxen, M., and K. Nielsen, "Stream Control
Transmission Protocol", RFC 9260, DOI 10.17487/RFC9260,
June 2022, <https://www.rfc-editor.org/rfc/rfc9260>.
[RFC9293] Eddy, W., Ed., "Transmission Control Protocol (TCP)",
STD 7, RFC 9293, DOI 10.17487/RFC9293, August 2022,
<https://www.rfc-editor.org/rfc/rfc9293>.
Boucadair & Claise Expires 19 October 2024 [Page 38]
Internet-Draft IPFIX IANA Fixes April 2024
[RFC9487] Graf, T., Claise, B., and P. Francois, "Export of Segment
Routing over IPv6 Information in IP Flow Information
Export (IPFIX)", RFC 9487, DOI 10.17487/RFC9487, November
2023, <https://www.rfc-editor.org/rfc/rfc9487>.
[RFC9565] Boucadair, M., "An Update to the tcpControlBits IP Flow
Information Export (IPFIX) Information Element", RFC 9565,
DOI 10.17487/RFC9565, March 2024,
<https://www.rfc-editor.org/rfc/rfc9565>.
Acknowledgments
Many thanks to Paul Aitken for the review and many suggestions that
enhanced this specification. Special thanks to Andrew Feren for
sharing data about scans of IPFIX data he collected.
Thomas Graf tagged an issue with the forwardingStatus Information
Element and for the Shepherd review.
Thanks to Eric Vyncke for the review and comments.
Thanks to Qin Wu for the opsdir review, Behcet Sarikay for the genart
review, and Martin Duke for the tsvart review.
Thanks to Mahesh Jethanandani for the AD review.
Authors' Addresses
Mohamed Boucadair
Orange
Email: mohamed.boucadair@orange.com
Benoit Claise
Huawei
Email: benoit.claise@huawei.com
Boucadair & Claise Expires 19 October 2024 [Page 39]