]> Simple Fixes to the IP Flow Information Export (IPFIX) Entities IANA Registry Orange
mohamed.boucadair@orange.com
Huawei
benoit.claise@huawei.com
OPS opsawg IPFIX Operations Network Providers Network Managment Anomaly detection Telemetry This document provides simple fixes to the IANA "IP Flow Information Export (IPFIX) Entities" registry. Specifically, this document provides updates to fix shortcomings in the description of some Information Elements (IEs), to ensure a consistent structure when citing an existing IANA registry, and to fix broken pointers, orphaned section references, etc. The updates are also meant to bring some consistency among the entries of the registry.
Introduction When the Operations and Management Area Working Group (OPSAWG) was considering , which obsoletes , the WG realized that some parts of the IANA "IP Flow Information Export (IPFIX) Entities" registry were not up to date. This document updates the IANA registry and brings some consistency among the entries of the registry. As discussed with IANA during the development of , the "Additional Information" entry in 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 registry . These fixes are classified as follows:
  • Updates to fix a shortcoming in the description of an IE ().
  • Updates to include a pointer to an existing IANA registry ().
  • Updates to ensure a consistent structure when calling an existing IANA registry ().
  • Miscellaneous updates to fix broken pointers, orphaned section references, etc. ().
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 , is the normative reference for the IPFIX IEs that were defined in . Therefore, the updates in this document do not update any part of . Likewise, this document is not marked as formally updating , , , , , , , , , , and .
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 when, and only when, they appear in all capitals, as shown here. This document uses the IPFIX-specific terminology (Information Element, Template, Collector, Data Record, Flow Record, Exporting Process, Collecting Process, etc.) defined in . As in , these IPFIX-specific terms have the first letter of a word capitalized.
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 ). However, and given that many of the impacted IEs were created via the IETF stream, the following from is 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.
Update the Descriptions in the IANA Registry
sourceTransportPort
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 for the definition of the UDP source port field. See for the definition of the TCP source port field. See for the definition of SCTP. Additional information on defined UDP and TCP port numbers can be found at [].
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.
Additional Information:
See for the definition of the UDP source port field. See for the definition of the TCP source port field. See for the definition of the SCTP source port number field. See for the definition of the DCCP source port field. See the assigned transport protocol (e.g., UDP, TCP, SCTP, and DCCP) port numbers [].
destinationTransportPort
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 for the definition of the UDP source port field. See for the definition of the TCP source port field. See 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.
NEW
Description:
The destination port identifier in the transport protocol header. For transport protocols such as UDP, TCP, SCTP, and DCCP, 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 for the definition of the UDP destination port field. See for the definition of the TCP destination port field. See for the definition of the SCTP destination port number field. See for the definition of the DCCP destination port field. See the assigned transport protocol (e.g., UDP, TCP, SCTP, and DCCP) port numbers [].
forwardingStatus The current forwardingStatus entry in deviates from what is provided in . 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 .
OLD
Description:
This Information Element describes the forwarding status of the flow and any attached reasons. The layout of the encoding is as follows: 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" .
Abstract Data Type:
unsigned8
NEW
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 least-significant 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: 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" . See the "Forwarding Status (Value 89)" registry [].
Abstract Data Type:
unsigned32
collectorTransportPort
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 for the definition of the UDP source port field. See for the definition of the TCP source port field. See 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].
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 for the definition of the UDP destination port field. See for the definition of the TCP destination port field. See for the definition of the SCTP destination port number field. See the assigned transport protocol (e.g., UDP, TCP, and SCTP) port numbers [].
exporterTransportPort
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 for the definition of the UDP source port field. See for the definition of the TCP source port field. See 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].
NEW
Description:
The source port identifier from 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 for the definition of the UDP source port field. See for the definition of the TCP source port field. See for the definition of the SCTP source port number field. See the assigned transport protocol (e.g., UDP, TCP, and SCTP) port numbers [].
Point to an Existing IANA Registry IANA has updated the following entries by adding the indicated "Additional Information" to the registry. (In , "ID" refers to "ElementID".) Cite an IANA Registry Under Additional Information
ID Name Additional Information
32 icmpTypeCodeIPv4 See the "ICMP Type Numbers" registry []
33 igmpType See the "IGMP Type Numbers" registry []
139 icmpTypeCodeIPv6 See the "ICMPv6 'type' Numbers" and "ICMPv6 'Code' Fields" registries []
176 icmpTypeIPv4 See the "ICMP Type Numbers" registry []
177 icmpCodeIPv4 See the "ICMP Type Numbers" registry []
178 icmpTypeIPv6 See the "ICMPv6 'type' Numbers" registry []
179 icmpCodeIPv6 See the "ICMPv6 'Code' Fields" registry []
346 privateEnterpriseNumber See the "Private Enterprise Numbers (PENs)" registry []
Consistent Citation of IANA Registries IANA has updated the "IP Flow Information Export (IPFIX) Entities" registry for each of the IE entries listed in the following subsections.
mplsTopLabelType
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. See https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-mpls-label-type.
Additional Information:
See for the MPLS label structure. See the list of MPLS label types assigned by IANA at [https://www.iana.org/assignments/mpls-label-values].
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 IPFIX MPLS label type (Value 46) []. See for the MPLS label structure.
classificationEngineId
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.
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 the "Classification Engine IDs (Value 101)" registry [].
flowEndReason
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.
NEW
Description:
The reason for Flow termination. Values are listed in the flowEndReason registry.
Additional Information:
See the "flowEndReason (Value 136)" registry [].
natOriginatingAddressRealm
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 for the definition of NAT.
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 "natOriginatingAddressRealm (Value 229)" registry []. See for the definition of NAT.
natEvent
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 for the definition of NAT. See for the definition of middleboxes. See for the definitions of values 4-16.
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 "NAT Event Type (Value 230)" registry []. See for the definition of NAT. See for the definitions of values 4-16.
firewallEvent
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.
NEW
Description:
Indicates a firewall event. Allowed values are listed in the firewallEvent registry.
Additional Information:
See the "firewallEvent (Value 233)" registry [].
biflowDirection
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].
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 "biflowDirection (Value 239)" registry [].
observationPointType
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.
NEW
Description:
Type of observation point. Values are listed in the observationPointType registry.
Additional Information:
See the "observationPointType (Value 277)" registry [].
anonymizationTechnique
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.
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 "anonymizationTechnique (Value 286)" registry [].
natType
OLD
Description:
Values are listed in the natType registry. See https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-type.
Additional Information:
See for the definition of NAT. See for the definition of NAT44. See for the definition of NAT64. See for the definition of NAT46. See for the definition of NAT66. See for the definition of IPv4. See for the definition of IPv6.
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 "natType (Value 297)" registry []. See for the definition of NAT (commonly named NAT44). See for the definition of NAT46. See for the definition of NAT64. See for the definition of NPTv6. See for the definition of IPv4. See for the definition of IPv6.
selectorAlgorithm
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 . 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.
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 of their parameters. For the methods parameters, Information Elements are defined in the IPFIX registry . 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 "Packet Sampling (PSAMP) Parameters" registry [].
informationElementDataType Note that the "informationElementDataType" registry has been renamed as the "IPFIX Information Element Data Types" registry.
OLD
Description:
A description of the abstract data type of an IPFIX information element. These are taken from the abstract data types defined in section of the IPFIX Information Model ; 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 to modify.
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 of the IPFIX Information Model ; see that section for more information on the types described in the "IPFIX Information Element Data Types" registry. These types are registered in the "IPFIX Information Element Data Types" registry. The "IPFIX Information Element Data Types" registry is intended to assign numbers for type names, not to provide a mechanism for adding data types to the IPFIX Protocol; as such, modifications require Standards Action .
Additional Information:
See the "IPFIX Information Element Data Types" registry [].
informationElementSemantics
OLD
Description:
A description of the semantics of an IPFIX Information Element. These are taken from the data type semantics defined in section of the IPFIX Information Model ; 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 to modify.
NEW
Description:
A description of the semantics of an IPFIX Information Element. These are taken from the data type semantics defined in Section of the IPFIX Information Model ; see that section for more information on the types defined in the "IPFIX Information Element Semantics" registry. This field may take the values in the "IPFIX Information Element 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. The "IPFIX Information Element Semantics" registry is intended to assign numbers for semantics names, not to provide a mechanism for adding semantics to the IPFIX Protocol; as such, modifications require Standards Action .
Additional Information:
See the "IPFIX Information Element Semantics" registry [].
informationElementUnits Note that the "informationElementsUnits" registry has been renamed as the "IPFIX Information Element Units" registry.
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 of the IPFIX Information Model ; 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.
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 of the IPFIX Information Model ; see that section for more information on the types described in the "IPFIX Information Element Units" registry. These types can take the values in the "IPFIX Information Element Units" registry. The special value 0x00 (none) is used to note that the field is unitless.
Additional Information:
See the "IPFIX Information Element Units" registry [].
portRangeStart
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.
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., UDP, TCP, SCTP, and DCCP) port numbers [].
portRangeEnd
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.
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., UDP, TCP, SCTP, and DCCP) port numbers [].
ingressInterfaceType
OLD
Description:
The type of interface where packets of this Flow are 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
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 "IANAifType-MIB" registry [].
egressInterfaceType
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
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 "IANAifType-MIB" registry [].
valueDistributionMethod
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 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.
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 (Value 384)" registry is intended to list a complete set of possible value distribution methods.
Additional Information:
See the "valueDistributionMethod (Value 384)" registry [].
flowSelectorAlgorithm
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.
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. Additional Information Elements are needed to fully specify packet selection with these methods and all of their parameters. Additional method identifiers may be added to the "flowSelectorAlgorithm (Value 390)" registry. It might be necessary to define new Information Elements to specify their parameters.
Additional Information:
See the "flowSelectorAlgorithm (Value 390)" registry [].
dataLinkFrameType
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)
NEW
Description:
This Information Element specifies the type of the selected data link frame. Data link types are defined in the "dataLinkFrameType (Value 408)" registry. Additional 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 "dataLinkFrameType (Value 408)" registry []. More information about the data link layer can be found in (IEEE802.3)(IEEE802.11)(ISO/IEC.7498-1:1994).
mibCaptureTimeSemantics
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 . 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.
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 . 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 (Value 448)" registry.
Additional Information:
See the "mibCaptureTimeSemantics (Value 448)" registry [].
natQuotaExceededEvent
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 for the definition of the IPv4 source address field. See for the definition of NAT. See for the definition of middleboxes.
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 (Value 466)" registry.
Additional Information:
See the "NAT Quota Exceeded Event Type (Value 466)" registry []. See for the definition of NAT.
natThresholdEvent
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.
Additional Information:
See for the definition of the IPv4 source address field. See for the definition of NAT. See for the definition of middleboxes.
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 (Value 467)" registry.
Additional Information:
See the "NAT Threshold Event Type (Value 467)" registry []). See for the definition of NAT.
Miscellaneous Updates IANA has updated the descriptions of the following entries in .
collectionTimeMilliseconds
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.
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.
messageMD5Checksum
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 , 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.
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 , 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.
anonymizationFlags
OLD
NEW
informationElementDescription
OLD
Description:
A UTF-8 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 , encoded in-line 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" language SHOULD be assumed. See the Security Considerations section for notes on string handling for Information Element type records.
NEW
Description:
A UTF-8 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 , encoded in-line 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" language SHOULD be assumed. See Section Security Considerations of for notes on string handling for Information Element type records.
distinctCountOfDestinationIPAddress
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.
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.
externalAddressRealm
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.
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.
Security Considerations This document does not add new security considerations to those already discussed for IPFIX in .
IANA Considerations Sections to include actions for IANA. These actions are not repeated here. IANA has added a reference to this document for each of the entries updated per this document. IANA has updated the note in the "IPFIX Information Elements" registry under the "IP Flow Information Export (IPFIX) Entities" registry group as follows:
OLD:
The columns previously titled "References" and "Requester" have been renamed "Additional Information" and "Reference", respectively.
NEW:
The columns previously titled "References" and "Requester" have been renamed "Additional Information" and "Reference", respectively. The initial values for this registry were provided in . has obsoleted and specifies that the current registry is the normative reference for these Information Elements.
IANA has added this document as a reference for the "IPFIX Information Elements" registry within the "IP Flow Information Export (IPFIX) Entities" registry group . IANA has also updated references to the "Service Name and Transport Protocol Port Number" consistently throughout 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., UDP, TCP, SCTP, and DCCP) port numbers [].
References Normative References IP Flow Information Export (IPFIX) Entities IANA Informative References NetFlow Version 9 Flow-Record Format Cisco
Acknowledgments Many thanks to for the review and many suggestions that enhanced this specification. Special thanks to for sharing data about scans of IPFIX data he collected. tagged an issue with the forwardingStatus Information Element and for the Shepherd review. Thanks to for the review and comments. Thanks to for the opsdir review, for the genart review, for the tsvart review, for the intdir review, and for the secdir review. Thanks to for the AD review. Thanks to for the IESG review.