One document matched: draft-ietf-ipfix-configuration-model-11.xml
<?xml version="1.0"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!-- keywords -->
<!ENTITY rfc2119 SYSTEM 'reference.RFC.2119.xml'>
<!-- IF-MIB, ENTITY-MIB -->
<!ENTITY rfc2863 SYSTEM 'reference.RFC.2863.xml'>
<!ENTITY rfc4133 SYSTEM 'reference.RFC.4133.xml'>
<!-- IPFIX, PSAMP -->
<!ENTITY rfc3917 SYSTEM 'reference.RFC.3917.xml'>
<!ENTITY rfc5101 SYSTEM 'reference.RFC.5101.xml'>
<!ENTITY rfc5102 SYSTEM 'reference.RFC.5102.xml'>
<!ENTITY rfc5103 SYSTEM 'reference.RFC.5103.xml'>
<!ENTITY rfc5470 SYSTEM 'reference.RFC.5470.xml'>
<!ENTITY rfc6615 SYSTEM 'reference.RFC.6615.xml'>
<!ENTITY rfc5472 SYSTEM 'reference.RFC.5472.xml'>
<!ENTITY rfc5610 SYSTEM 'reference.RFC.5610.xml'>
<!ENTITY rfc5655 SYSTEM 'reference.RFC.5655.xml'>
<!ENTITY rfc5473 SYSTEM 'reference.RFC.5473.xml'>
<!--
<!ENTITY ipfixmediator SYSTEM 'reference.I-D.kobayashi-ipfix-mediator-model.xml'>
<!ENTITY ipfixaggr SYSTEM 'reference.I-D.dressler-ipfix-aggregation.xml'>
-->
<!ENTITY rfc5475 SYSTEM 'reference.RFC.5475.xml'>
<!ENTITY rfc5474 SYSTEM 'reference.RFC.5474.xml'>
<!ENTITY psampmib SYSTEM 'reference.I-D.ietf-ipfix-psamp-mib.xml'>
<!ENTITY rfc6526 SYSTEM 'reference.RFC.6526.xml'>
<!ENTITY rfc5476 SYSTEM 'reference.RFC.5476.xml'>
<!ENTITY rfc5477 SYSTEM 'reference.RFC.5477.xml'>
<!-- SCTP related -->
<!ENTITY rfc3758 SYSTEM 'reference.RFC.3758.xml'>
<!ENTITY rfc3871 SYSTEM 'reference.RFC.3871.xml'>
<!ENTITY rfc4960 SYSTEM 'reference.RFC.4960.xml'>
<!-- Netconf related -->
<!ENTITY rfc6241 SYSTEM 'reference.RFC.6241.xml'>
<!ENTITY rfc6242 SYSTEM 'reference.RFC.6242.xml'>
<!ENTITY rfc6020 SYSTEM 'reference.RFC.6020.xml'>
<!ENTITY rfc6021 SYSTEM 'reference.RFC.6021.xml'>
<!ENTITY rfc6110 SYSTEM 'reference.RFC.6110.xml'>
<!ENTITY rfc3688 SYSTEM 'reference.RFC.3688.xml'>
<!-- CRC -->
<!ENTITY rfc1141 SYSTEM 'reference.RFC.1141.xml'>
<!-- other -->
<!ENTITY xml SYSTEM 'reference.W3C.REC-xml-20081126.xml'>
<!ENTITY xmlschema SYSTEM 'reference.W3C.REC-xmlschema-0-20041028.xml'>
<!--ENTITY xmlpath SYSTEM 'reference.W3C.REC-xpath-19991116.xml'-->
<!--<!ENTITY soap SYSTEM 'reference.W3C.REC-soap12-part1-20070427.xml'>-->
<!-- TLS/DTLS/X.509 -->
<!ENTITY rfc5246 SYSTEM 'reference.RFC.5246.xml'>
<!ENTITY rfc6347 SYSTEM 'reference.RFC.6347.xml'>
<!ENTITY rfc5280 SYSTEM 'reference.RFC.5280.xml'>
]>
<!--<?rfc strict="yes"?>-->
<?rfc toc="yes"?>
<?rfc tocompact="no"?>
<?rfc footer="draft-ietf-ipfix-configuration-model-11.txt"?>
<?rfc compact="yes"?>
<!--<?rfc subcompact="compact"?>-->
<?rfc symrefs="yes"?>
<!--<rfc category="std" ipr="trust200811" docName="<draft-ietf-ipfix-configuration-model-04>">-->
<rfc category="std" ipr="pre5378Trust200902" docName="<draft-ietf-ipfix-configuration-model-11>">
<front>
<title abbrev="IPFIX/PSAMP Configuration Data Model">Configuration Data Model for IPFIX and PSAMP</title>
<author fullname="Gerhard Muenz" initials="G." surname="Muenz">
<organization abbrev='TU Muenchen'>Technische Universitaet Muenchen</organization>
<address>
<postal>
<street>Department of Informatics</street>
<street>Chair for Network Architectures and Services (I8)</street>
<street>Boltzmannstr. 3</street>
<city>Garching</city>
<code>85748</code>
<country>Germany</country>
</postal>
<!--<phone>+49 89 289-18008</phone>-->
<email>muenz@net.in.tum.de</email>
<uri>http://www.net.in.tum.de/~muenz</uri>
</address>
</author>
<author fullname="Benoit Claise" initials="B." surname="Claise">
<organization>Cisco Systems, Inc.</organization>
<address>
<postal>
<street>De Kleetlaan 6a b1</street>
<city>Diegem</city>
<code>1831</code>
<country>Belgium</country>
</postal>
<phone>+32 2 704 5622</phone>
<email>bclaise@cisco.com</email>
</address>
</author>
<author fullname="Paul Aitken" initials="P." surname="Aitken">
<!--<organization>Cisco Systems (Scotland) Ltd.</organization>-->
<organization>Cisco Systems, Inc.</organization>
<address>
<postal>
<street>96 Commercial Quay</street>
<street>Commercial Street</street>
<city>Edinburgh</city>
<code>EH6 6LX</code>
<country>United Kingdom</country>
</postal>
<phone>+44 131 561 3616</phone>
<email>paitken@cisco.com</email>
</address>
</author>
<date day="12" month="June" year="2012"/>
<area>Operations and Management</area>
<workgroup>IP Flow Information Export WG</workgroup>
<abstract>
<!-- don't use capitalized terms in abstract, before the definitions -->
<t>
This document specifies a data model for configuring and monitoring Selection Processes, Caches, Exporting Processes, and Collecting Processes of IPFIX and PSAMP compliant Monitoring Devices using the NETCONF protocol.
The data model is defined using UML (Unified Modeling Language) class diagrams and formally specified using YANG.
The configuration data is encoded in Extensible Markup Language (XML).
</t>
</abstract>
</front>
<middle>
<!--
<section anchor="sec:issues" title="Open Issues">
<t>
Depending on the future of <xref target="I-D.ietf-psamp-mib"/>, references to this document have to be replaced by references to <xref target="RFC5476"/>, <xref target="RFC5477"/>, and <xref target="RFC5475"/>.
</t>
<t>
Solved issues and answers to reviewer comments:
<list style="hanging">
<t hangText="TLS/DTLS parameters:">
IPFIX WG lacks experience with IPFIX implementations supporting TLS/DTLS.
Is TLS/DTLS configuration out of scope of IPFIX anyway?
</t>
<t hangText="Relationship to IPFIX and PSAMP MIB:">
Check if operational data (read-only, non-configurable parameters) is included as far as possible.
</t>
<t hangText="Parameters:">
Review specification of configuration data model w/r to mandatory/optional parameters and default values.
Replace timeticks by other data type (e.g., milliseconds) as soon as yang-types supports it.
</t>
<t hangText="Keep up with NETMOD WG:">
Make use of new language features to come, e.g. support of features, default values provided by device.
</t>
</list>
<list style="symbols">
<t>Metering Process as envelop for Selection Processes and Cache was removed because it caused some confusion.
Observation Points now refer to Selection Processes which process the observed packets.
A Selection Process can pass selected packets to another Selection Process to form a Selection Sequence.</t>
<t>Cache configuration includes "cacheLayout", which replaced "template" parameter.
Thus, Templates are not longer configurable for Data Records.
The Exporting Process generates Templates automatically according to the packets or Flows received from the Cache.</t>
<t>Premature support of IPFIX Mediators/Concentrators was removed.</t>
<t>Several SCTP parameters have been added</t>
<t>NETCONF compliance: ensured by using YANG instead of XSD.</t>
<t>Direction attribute of interface/linecard can be on of "ingress", "egress", or "both".</t>
<t>observationPointId, exportingProcessId, and selectorId have been added as optional configuration parameters, setting the values of the corresponding Information Elements.
Note that monitoring device implementations are not obliged to support the configuration of these ids, but may set them dynamically.
Currently not included are selectionSequenceId and meteringProcessId.
<list style="symbols">
<t>
Observation Points and Metering Processes do not have identifiers in the configuration data model, but observationPointId and meteringProcessId could be configuration parameters.
</t>
<t>
exportingProcessId could replace the identifier of the ExportingProcess class in the configuration data model.
</t>
<t>
selectorId could become a configuration parameter of the selection methods specified within the SelectionProcess class.
selectionSequenceId could be a configuration parameter of the SelectionProcess class or replace the identifier of the SelectionProcess class.
Yet, the configuration data model allows deploying the same Selection Process at different Observation Points, and in this case, the identifiers would always be the same.
</t>
</list>
<vspace blankLines="0" />
Gerhard's opinion: Similar to ifIndex, these IDs are internal properties of the monitoring device and cannot be configured.
</t>
<t>
Request for additional parameters concerning the composition of IPFIX Messages at the exporter, e.g. how long may the exporter wait until an expired record is exported?
Waiting may be useful in order to fill up IPFIX Messages.
<vspace blankLines="0" />
We (the authors) decided not to add such parameters for the following reasons: 1) the composition of IPFIX Messages has not been described as configurable or managable in any other IPFIX document, and 2) today's configuration possibilities depend very much on the device or manufacturer. We propose to use device or manufacturer-dependent extensions of the configuration data model.
</t>
</list>
</t>
</section>
-->
<section title="Introduction">
<t>
Editor's note (to be removed prior to publication):
This draft is to be published as RFC after ietf-ipfix-psamp-mib has become RFC.
The RFC Editor is asked to replace references to ietf-ipfix-psamp-mib by references to the corresponding RFC.
In the YANG module (<xref target="sec:yang"/>), occurrences of "yyyy" shall be replaced by the RFC number of draft-ietf-ipfix-psamp-mib.
In the YANG module (<xref target="sec:yang"/>) and in <xref target="sec:iana"/>, occurrences of "xxxx" shall be replaced by the RFC number of this document.
</t>
<t>
IPFIX and PSAMP compliant Monitoring Devices (routers, switches, monitoring probes, Collectors etc.) offer various configuration possibilities that allow adapting network monitoring to the goals and purposes of the application, such as accounting and charging, traffic analysis, performance monitoring, security monitoring.
The use of a common vendor-independent configuration data model for IPFIX and PSAMP compliant Monitoring Devices facilitates network management and configuration, especially if Monitoring Devices of different implementers or manufacturers are deployed simultaneously.
On the one hand, a vendor-independent configuration data model helps storing and managing the configuration data of Monitoring Devices in a consistent format.
On the other hand, it can be used for local and remote configuration of Monitoring Devices.
</t>
<t>
The purpose of this document is the specification of a vendor-independent configuration data model that covers the commonly available configuration parameters of Selection Processes, Caches, Exporting Processes, and Collecting Processes.
In addition, it includes common states parameters of a Monitoring Device.
The configuration data model is defined using UML (Unified Modeling Language) class diagrams <xref target="UML"/> while the actual configuration data is encoded in Extensible Markup Language (XML) <xref target="W3C.REC-xml-20081126"/>.
An XML document conforming to the configuration data model contains the configuration data of one Monitoring Device.
</t>
<t>
The configuration data model is designed for being used with the NETCONF protocol <xref target="RFC6241"/> in order to configure remote Monitoring Devices.
With the NETCONF protocol, it is possible to transfer a complete set of configuration data to a Monitoring Device, to query the current configuration and state parameters of a Monitoring Device, and to change specific parameter values of an existing Monitoring Device configuration.
</t>
<t>
In order to ensure compatibility with the NETCONF protocol <xref target="RFC6241"/>, YANG <xref target="RFC6020"/> is used to formally specify the configuration data model.
If required, the YANG specification of the configuration data model can be converted into XML Schema language <xref target="W3C.REC-xmlschema-0-20041028"/> or DSDL (Document Schema Definition Languages) <xref target="RFC6110"/>, for example by using the pyang tool <xref target="YANG-WEB"/>.
YANG provides mechanisms to adapt the configuration data model to device-specific constraints and to augment the model with additional device-specific or vendor-specific parameters.
<!--
On the other hand, the configuration data model optional parameters not supported by a particular monitoring device implementation can be simply omitted in the XML document.
However, for the creation and manipulation of configuration data for a specific monitoring device, any restrictions and extensions of the data model should be known.
This is to avoid the generation of unsupported configuration data and to profit from extended device capabilities.
Note that the description of monitoring device capabilities is currently out of scope of this document.
</t>
<t>
For the configuration of remote Monitoring Devices, an appropriate protocol is needed to transfer the XML encoded configuration data.
The configuration data model is compatible with the NETCONF protocol <xref target="RFC4741"/>.
However, alternative protocols, such as the Simple Object Access Protocol (SOAP) <xref target="W3C.REC-soap12-part1-20070427"/>, are also suitable for transferring XML data from a network management system to a Monitoring Device.
-->
</t>
<t>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in <xref target="RFC2119"/>.
</t>
<section title="IPFIX Documents Overview">
<t>
The IPFIX protocol <xref target="RFC5101"/> provides network administrators with access to IP Flow information.
The architecture for the export of measured IP Flow information out of an IPFIX Exporting Process to a Collecting Process is defined in <xref target="RFC5470"/>, per the requirements defined in <xref target="RFC3917"/>.
The IPFIX protocol <xref target="RFC5101"/> specifies how IPFIX Data Records and Templates are carried via a number of transport protocols from IPFIX Exporting Processes to IPFIX Collecting Process.
IPFIX has a formal description of IPFIX Information Elements, their name, type and additional semantic information, as specified in <xref target="RFC5102"/>.
<xref target="RFC6615"/> specifies the IPFIX Management Information Base, consisting of the IPFIX MIB module and the IPFIX SELECTOR MIB module.
Finally, <xref target="RFC5472"/> describes what type of applications can use the IPFIX protocol and how they can use the information provided.
It furthermore shows how the IPFIX framework relates to other architectures and frameworks.
Methods for efficient export of bidirectional Flow information and common properties in Data Records are specified in <xref target="RFC5103"/> and <xref target="RFC5473"/>, respectively.
<xref target="RFC5610"/> addresses the export of extended type information for enterprise-specific Information Elements.
The storage of IPFIX Messages in a file is specified in <xref target="RFC5655"/>.
</t>
</section>
<section title="PSAMP Documents Overview">
<t>
The framework for packet selection and reporting <xref target="RFC5474"/> enables network elements to select subsets of packets by statistical and other methods, and to export a stream of reports on the selected packets to a Collector.
The set of packet selection techniques (Sampling, Filtering, and hashing) standardized by PSAMP are described in <xref target="RFC5475"/>.
The PSAMP protocol <xref target="RFC5476"/> specifies the export of packet information from a PSAMP Exporting Process to a PSAMP Collector.
Instead of exporting PSAMP Packet Reports, the stream of selected packets may also serve as input to the generation of IPFIX Flow Records.
Like IPFIX, PSAMP has a formal description of its Information Elements, their name, type and additional semantic information.
The PSAMP information model is defined in <xref target="RFC5477"/>.
<xref target="I-D.ietf-ipfix-psamp-mib"/> specifies the PSAMP MIB module as an extension of the IPFIX SELECTOR MIB module defined in <xref target="RFC6615"/>.
</t>
</section>
</section>
<section anchor="sec:terminology" title="Terminology">
<t>
This document adopts the terminologies used in <xref target="RFC5101"/>, <xref target="RFC5103"/>, <xref target="RFC5655"/>, and <xref target="RFC5476"/>.
As in these documents, all specific terms have the first letter of a word capitalized when used in this document.
The following listing indicates in which references the definitions of those terms that are commonly used throughout this document can be found:
</t>
<t>
<list style='symbols'>
<t>Definitions adopted from <xref target="RFC5101"/>:
<list style='symbols'>
<t>Collection Process</t>
<t>Collector</t>
<t>Data Record</t>
<t>Exporter</t>
<t>Flow</t>
<t>Flow Key</t>
<t>Flow Record</t>
<t>Information Element</t>
<t>IPFIX Device</t>
<t>IPFIX Message</t>
<t>Observation Domain</t>
<t>Observation Point</t>
<t>(Options) Template</t>
</list>
</t>
<vspace blankLines="1" />
<t>Definitions adopted from <xref target="RFC5103"/>:
<list style='symbols'>
<t>Reverse Information Element</t>
</list>
</t>
<vspace blankLines="1" />
<t>Definitions adopted from <xref target="RFC5655"/>:
<list style='symbols'>
<t>File Reader</t>
<t>File Writer</t>
</list>
</t>
<vspace blankLines="1" />
<t>Definitions adopted from <xref target="RFC5476"/>:
<list style='symbols'>
<t>Filtering</t>
<t>Observed Packet Stream</t>
<t>Packet Report</t>
<t>PSAMP Device</t>
<t>Sampling</t>
<t>Selection Process</t>
<t>Selection Sequence</t>
<t>Selection Sequence Report Interpretation</t>
<t>Selection Sequence Statistics Report Interpretation</t>
<t>Selection State</t>
<t>Selector, Primitive Selector, Composite Selector</t>
<t>Selector Report Interpretation</t>
</list>
</t>
</list>
</t>
<t>
The terms Metering Process and Exporting Process have different definitions in <xref target="RFC5101"/> and <xref target="RFC5476"/>.
In the scope of this document, these terms are used according to the following definitions which cover the deployment in both PSAMP Devices and IPFIX Devices:
</t>
<t>
<list style='hanging'>
<t hangText="Metering Process">
<vspace blankLines="1" />
The Metering Process generates IPFIX Flow Records or PSAMP Packet Reports, depending on its deployment as part of an IPFIX Device or PSAMP Device.
Inputs to the process are packets observed at one or multiple Observation Points, as well as characteristics describing the packet treatment at these Observation Points.
If IPFIX Flow Records are generated, the Metering Process MUST NOT aggregate packets observed at different Observation Domains in the same Flow.
The function of the Metering Process is split into two functional blocks: Selection Process and Cache.
<vspace blankLines="1" />
</t>
<t hangText="Exporting Process">
<vspace blankLines="1" />
Depending on its deployment as part of an IPFIX Device or PSAMP Device, the Exporting Process sends IPFIX Flow Records or PSAMP Packet Reports to one or more Collecting Processes.
The IPFIX Flow Records or PSAMP Packet Reports are generated by one or more Metering Processes.
</t>
</list>
</t>
<t>
In addition to the existing IPFIX and PSAMP terminology, the following terms are defined:
</t>
<t>
<list style='hanging'>
<!-- FIXME: new Cache definition agreed by Atsushi -->
<t hangText="Cache">
<vspace blankLines="1" />
The Cache is a functional block in a Metering Process which generates IPFIX Flow Records or PSAMP Packet Reports from a Selected Packet Stream, in accordance with its configuration.
If Flow Records are generated, the Cache performs tasks like creating new records, updating existing ones, computing Flow statistics, deriving further Flow properties, detecting Flow expiration, passing Flow Records to the Exporting Process, and deleting Flow Records.
If Packet Reports are generated, the Cache performs tasks like extracting packet contents and derived packet properties from the Selected Packet Stream, creating new records, and passing them as Packet Reports to the Exporting Process.
<vspace blankLines="1" />
</t>
<t hangText="Cache Layout">
<vspace blankLines="1" />
The Cache Layout defines the superset of fields that are included in the Packet Reports or Flow Records maintained by the Cache.
The fields are specified by the corresponding Information Elements.
In general, the largest possible subset of the specified fields is derived for every Packet Report or Flow Record.
More specific rules about which fields must be included are given in <xref target="sec:cache-layout"/>.
<vspace blankLines="1" />
</t>
<!--
<t hangText="Cache Mode">
<vspace blankLines="1" />
The Cache Mode specifies whether Packet Reports or Flow Records are generated by the Cache.
In the case of Flow Records, it also specifies the Flow expiration policy.
<vspace blankLines="1" />
</t>
-->
<t hangText="Monitoring Device">
<vspace blankLines="1" />
A Monitoring Device implements at least one of the functional blocks specified in the context of IPFIX or PSAMP.
In particular, the term Monitoring Device encompasses Exporters, Collectors, IPFIX Devices, and PSAMP Devices.
<vspace blankLines="1" />
</t>
<t hangText="Selected Packet Stream">
<vspace blankLines="1" />
The Selected Packet Stream is the set of all packets selected by a Selection Process.
</t>
</list>
</t>
</section>
<section anchor="sec:structure" title="Structure of the Configuration Data Model">
<t>
The IPFIX reference model in <xref target="RFC5470"/> describes Metering Processes, Exporting Processes, and Collecting Processes as functional blocks of IPFIX Devices.
The PSAMP framework <xref target="RFC5474"/> provides the corresponding information for PSAMP Devices and introduces the Selection Process as a functional block within Metering Processes.
In <xref target="sec:terminology"/> of the document, the Cache is defined as another functional block within Metering Processes.
Further explanations about the relationship between Selection Process and Cache are given in <xref target="sec:metering-process"/>.
IPFIX File Reader and File Writer are defined as specific kinds of Exporting and Collecting Processes in <xref target="RFC5655"/>.
</t>
<t>
Monitoring Device implementations usually maintain the separation of various functional blocks although they do not necessarily implement all of them.
Furthermore, they provide various configuration possibilities; some of them are specified as mandatory by the IPFIX protocol <xref target="RFC5101"/> or PSAMP protocol <xref target="RFC5476"/>.
The configuration data model enables the setting of commonly available configuration parameters for Selection Processes, Caches, Exporting Processes, and Collecting Processes.
In addition, it allows specifying the composition of functional blocks within a Monitoring Device configuration and their linkage with Observation Points.
</t>
<t>
The selection of parameters in the configuration data model is based on configuration issues discussed in the IPFIX and PSAMP documents <xref target="RFC3917"/>, <xref target="RFC5101"/>, <xref target="RFC5470"/>, <xref target="RFC5476"/>, <xref target="RFC5474"/>, and <xref target="RFC5475"/>.
Furthermore, the structure and content of the IPFIX MIB module <xref target="RFC6615"/> and the PSAMP MIB module <xref target="I-D.ietf-ipfix-psamp-mib"/> have been taken into consideration.
Consistency between the configuration data model and the IPFIX and PSAMP MIB modules is an intended goal.
Therefore, parameters in the configuration data model are named according to corresponding managed objects. <!--, while names of the corresponding Information Elements in <xref target="RFC5102"/> or <xref target="RFC5477"/> should be adopted where they exist.-->
Certain IPFIX MIB objects containing state data have been adopted as state parameters in the configuration data model.
<!-- FIXME: by NMS? -->
State parameters cannot be configured, yet their values can be queried from the Monitoring Device by a network manager.
</t>
<t>
<xref target="sec:uml"/> explains how UML class diagrams are deployed to illustrate the structure of the configuration data model.
Thereafter, <xref target="sec:exporter"/> and <xref target="sec:collector"/> explain the class diagrams for the configuration of Exporters and Collectors, respectively.
Each of the presented classes contains specific configuration parameters which are specified in <xref target="sec:parameters"/>.
<xref target="sec:adaptation"/> gives a short introduction to YANG concepts that allow adapting the configuration data model to the capabilities of a device.
The formal definition of the configuration data model in YANG is given in <xref target="sec:yang"/>.
<xref target="sec:examples"/> illustrates the usage of the model with example configurations in XML.
</t>
<section anchor="sec:metering-process" title="Metering Process Decomposition in Selection Process and Cache">
<t>
In a Monitoring Device implementation, the functionality of the Metering Process is commonly split into packet Sampling and Filtering functions performed by Selection Processes, and the maintenance of Flow Records and Packet Reports performed by a Cache.
<xref target="fig:mp-architecture" /> illustrates this separation with the example of a basic Metering Process.
</t>
<figure anchor="fig:mp-architecture" title="Selection Process and Cache forming a Metering Process" align="center">
<artwork>
<![CDATA[ +-----------------------------------+
| Metering Process |
| +-----------+ Selected |
Observed | | Selection | Packet +-------+ | Stream of
Packet -->| Process |---------->| Cache |--> Flow Records or
Stream | +-----------+ Stream +-------+ | Packet Reports
+-----------------------------------+]]>
</artwork>
</figure>
<t>
The configuration data model adopts the separation of Selection Processes and Caches in order to support the flexible configuration and combination of these functional blocks.
As defined in <xref target="RFC5476"/>, the Selection Process takes an Observed Packet Stream as its input and selects a subset of that stream as its output (Selected Packet Stream).
The action of the Selection Process on a single packet of its input is defined by one Selector (called Primitive Selector) or an ordered composition of multiple Selectors (called Composite Selector).
The Cache generates Flow Records or Packet Reports from the Selected Packet Stream, depending on its configuration.
</t>
<t>
The configuration data model does not allow configuring a Metering Process without any Selection Process in front of the Cache.
If all packets in the Observed Packet Stream shall be selected and passed to the Cache without any Filtering or Sampling, a Selection Process needs to be configured with a Selector which selects all packets ("SelectAll" class in <xref target="sec:selector"/>).
</t>
<t>
The configuration data model enables the configuration of a Selection Process which receives packets from multiple Observation Points as its input.
In this case, the Observed Packet Streams of the Observation Points are processed in independent Selection Sequences.
As specified in <xref target="RFC5476"/>, a distinct set of Selector instances needs to be maintained per Selection Sequence in order to keep the Selection States and statistics separate.
</t>
<t>
With the configuration data model, it is possible to configure a Metering Process with more than one Selection Processes whose output is processed by a single Cache.
This is illustrated in <xref target="fig:mp-architecture2" />.
</t>
<figure anchor="fig:mp-architecture2" title="Metering Process with multiple Selection Processes" align="center">
<artwork>
<![CDATA[ +-------------------------------------+
| Metering Process |
| +-----------+ Selected |
Observed | | Selection | Packet |
Packet -->| Process |----------+ +-------+ |
Stream | +-----------+ Stream +->| | | Stream of
| ... | Cache |--> Flow Records or
| +-----------+ Selected +->| | | Packet Reports
Observed | | Selection | Packet | +-------+ |
Packet -->| Process |----------+ |
Stream | +-----------+ Stream |
+-------------------------------------+]]>
</artwork>
</figure>
<t>
The Observed Packet Streams at the input of a Metering Process may originate from Observation Points belonging to different Observation Domains.
By definition of the Observation Domain (see <xref target="RFC5101"/>), however, a Cache MUST NOT aggregate packets observed at different Observation Domains in the same Flow.
Hence, if the Cache is configured to generate Flow Records, it needs to distinguish packets according to their Observation Domains.
</t>
<!-- FIXME: remove because of changes in IPFIX-MIB
<t>
The Observed Packet Stream at the input of a Selection Process MUST only contain packets originating from a single Observation Domain.
Similarly, the Selected Packet Stream at the input of a Cache MUST only contain packets originating from a single Observation Domain.
Packets from Observation Points belonging to different Observation Domains MUST NOT enter the same Selection Process or the same Cache.
</t>
-->
</section>
<section anchor="sec:uml" title="UML Representation">
<t>
We use UML class diagrams <xref target="UML"/> to explain the structure of the configuration data model.
The attributes of the classes are the configuration or state parameters.
The configuration and state parameters of a given Monitoring Device are represented as objects of these classes encoded in XML.
</t>
<figure anchor="fig:destination-example" title="UML example: SctpExporter class" align="center">
<artwork>
<![CDATA[+------------------------------+
| SctpExporter |
+------------------------------+ 0..1 +------------------------+
| name |<>-------| TransportLayerSecurity |
| ipfixVersion = 10 | +------------------------+
| sourceIPAddress[0..*] |
| destinationIPAddress[1..*] | 0..1 +------------------------+
| destinationPort = 4739|4740 |<>-------| TransportSession |
| ifName/ifIndex[0..1] | +------------------------+
| sendBufferSize {opt.} |
| rateLimit[0..1] |
| timedReliability = 0 |
+------------------------------+]]>
</artwork>
</figure>
<t>
As an example, <xref target="fig:destination-example"/> shows the UML diagram of the SctpExporter class, which is specified in more detail in <xref target="sec:sctp-export"/>.
The upper box contains the name of the class.
The lower box lists the attributes of the class.
Each attribute corresponds to a parameter of the configuration data model.
</t>
<t>
Behind an attribute's name, there may appear a multiplicity indicator in brackets (i.e., between "[" and "]").
An attribute with multiplicity indicator "[0..1]" represents an OPTIONAL configuration parameter which is only included in the configuration data if the user configures it.
Typically, the absence of an OPTIONAL parameter has a specific meaning.
For example, not configuring rateLimit in an object of the SctpExporter class means that no rate limiting will be applied to the exported data.
In YANG, an OPTIONAL parameter is specified as a "leaf" without "mandatory true" substatement.
The "description" substatement specifies the behavior for the case that the parameter is not configured.
</t>
<t>
The multiplicity indicator "[0..*]" means that this parameter is OPTIONAL and MAY be configured multiple times with different values.
In the example, multiple source IP addresses (sourceIPAddress) may be configured for a multi-homed Exporting Process.
In YANG, an attribute with multiplicity indicator "[0..*]" corresponds to a "leaf-list".
</t>
<t>
The multiplicity indicator "[1..*]" means that this parameter MUST be configured at least once and MAY be configured multiple times with different values.
In the example, one or more destination IP addresses (destinationIPAddress) must be configured to specify the export destination.
In YANG, an attribute with multiplicity indicator "[1..*]" corresponds to a "leaf-list" with "min-elements 1" substatement.
Note that attributes without this multiplicity indicator MUST NOT appear more than once in each object of the class.
</t>
<t>
Attributes without multiplicity indicator may be endued with a default value which is indicated behind the equality symbol ("=").
If a default value exists, the parameter does not have to be explicitly configured by the user.
If the parameter is not configured by the user, the Monitoring Device MUST use the specified default value for the given parameter.
In the example, IPFIX version 10 must be used unless a different value is configured for ipfixVersion.
In YANG, an attribute with default value corresponds to a "leaf" with "default" substatement.
</t>
<t>
In the example, there exist two default values for the destination port (destinationPort), namely the registered ports for IPFIX with and without transport layer security (i.e., DTLS or TLS), which are 4740 and 4739, respectively.
In the UML diagram, the two default values are separated by a vertical bar ("|").
In YANG, such conditional default value alternatives cannot be specified formally.
Instead, they are defined in the "description" substatement of the "leaf".
</t>
<t>
Further attribute properties are denoted in braces (i.e., between "{" and "}").
An attribute with property "{opt.}", such as sendBufferSize in the SctpExporter class, represents a parameter that MAY be configured by the user.
If not configured by the user, the Monitoring Device MUST set an appropriate value for this parameter at configuration time.
As a result, the parameter will always exist in the configuration data, yet it is not mandatory for the user to configure it.
This behavior can be implemented as a static device-specific default value, but does not have to.
Therefore, the user MUST NOT expect that the device always sets the same values for the same parameter.
Regardless of whether the parameter value has been configured by the user or set by the device, the parameter value MUST NOT be changed by the device after configuration.
Since this behavior cannot be specified formally in YANG, it is specified in the "description" substatement of the "leaf".
</t>
<t>
The availability of a parameter may depend on another parameter value.
In the UML diagram, such restrictions are indicated as attribute properties (e.g., "{SCTP only}").
The given example does not show such restrictions.
In YANG, the availability of a parameter is formally restricted with the "when" substatement of the "leaf".
</t>
<t>
Another attribute property not shown in the example is "{readOnly}" specifying state parameters which cannot be configured.
In YANG, this corresponds to the "config false" substatement.
</t>
<t>
Attributes without multiplicity indicator, without default value, and without "{readOnly}" property are mandatory configuration parameters.
These parameters MUST be configured by the user unless an attribute property determines that the parameter is not available.
In YANG, a mandatory parameter corresponds to a "leaf" with "mandatory true" substatement.
In the example, the user MUST configure the name parameter.
</t>
<t>
If some parameters are related to each other, it makes sense to group these parameters in a subclass.
This is especially useful if different subclasses represent choices of different parameter sets, or if the parameters of a subclass may appear multiple times.
For example, the SctpExporter class MAY contain the parameters of the TransportLayerSecurity subclass.
</t>
<t>
An object of a class is encoded as an XML element.
In order to distinguish between classes and objects, class names start with an upper case character while the associated XML elements start with lower case characters.
Parameters appear as XML elements which are nested in the XML element of the object.
In XML, the parameters of an object can appear in any order and do not have to follow the order in the UML class diagram.
Unless specified differently, the order in which parameters appear does not have a meaning.
As an example, an object of the SctpExporter class corresponds to one occurrence of
<artwork align="left">
<![CDATA[ <sctpExporter>
<name>my-sctp-export</name>
...
</sctpExporter> ]]>
</artwork>
</t>
<t>
There are various possibilities how objects of classes can be related to each other.
In the scope of this document, we use two different types of relationship between objects: aggregation and unidirectional association.
In UML class diagrams, two different arrow types are used as shown in <xref target="fig:uml"/>.
</t>
<figure anchor="fig:uml" title="Class relationships in UML class diagrams" align="center">
<artwork align="center">
<![CDATA[+---+ 0..* +---+ +---+ 0..* 1 +---+
| A |<>------| B | | A |-------->| B |
+---+ +---+ +---+ +---+
(a) Aggregation (b) Unidirectional association]]>
</artwork>
</figure>
<t>
Aggregation means that one object is part of the other object.
In <xref target="fig:uml" /> (a), an object of class B is part of an object of class A.
This corresponds to nested XML elements:
<artwork align="left">
<![CDATA[ <a>
<b>
...
</b>
...
</a> ]]>
</artwork>
In the example, objects of the TransportLayerSecurity class and the TransportSession class appear as nested XML elements <transportLayerSecurity> and <transportSession> within an object of the SctpExporter class <sctpExporter>.
</t>
<t>
A unidirectional association is a reference to an object.
In <xref target="fig:uml" /> (b), an object of class A contains a reference to an object of class B.
This corresponds to separate XML elements that are not nested.
To distinguish different objects of class B, class B must have a key.
In the configuration data model, keys are string parameters called "name", corresponding to XML elements <name>.
The names MUST be unique within the given XML subtree.
The reference to a specific object of class B is encoded with an XML element <b> which contains the name of an object.
If an object of class A refers to the object of class B with name "foo", this looks as follows:
<artwork align="left">
<![CDATA[ <a>
...
<b>foo</b>
...
</a>
<b>
<name>foo</name>
...
</b> ]]>
</artwork>
</t>
<t>
In <xref target="fig:uml" />, the indicated numbers define the multiplicity:
</t>
<t>
<list style="empty">
<t>
"1": one only
</t>
<t>
"0..*": zero or more
</t>
<t>
"1..*": one or more
</t>
</list>
</t>
<t>
In the case of aggregation, the multiplicity indicates how many objects of one class may be included in one object of the other class.
In <xref target="fig:uml" /> (a), an object of class A may contain an arbitrary number of objects of class B.
In the case of unidirectional association, the multiplicity at the arrowhead specifies the number of objects of a given class that may be referred to.
The multiplicity at the arrow tail specifies how many different objects of one class may refer to a single object of the other class.
In <xref target="fig:uml" /> (b), an object of class A refers to single object of class B.
One object of class B can be referred to from an arbitrary number of objects of class A.
</t>
<t>
Similar to classes that are referenced in UML associations, classes which contain configuration parameters and which occur in an aggregation relationship with multiplicity greater than one must have a key.
This key is necessary because every configuration parameter must be addressable in order to manipulate or delete it.
The key values MUST be unique in the given XML subtree (i.e., unique within the aggregating object).
Hence, if class B in <xref target="fig:uml" /> (a) contains a configuration parameter, all objects of class B belonging to the same object of class A must have different key values.
Again, the key appears as an attribute called "name" in the concerned classes.
</t>
<t>
A class which contains state parameters but no configuration parameters, such as the Template class (see <xref target="sec:template"/>), does not have a key.
This is because state parameters cannot be manipulated or deleted, and therefore do not need to be addressable.
</t>
<t>
Note that the usage of keys as described above is required by YANG <xref target="RFC6020"/> which mandates the existence of a key for elements which appear in a list of configuration data.
<!--In the configuration data model, the key is a string parameter called "name" in all concerned classes, corresponding to XML elements <name> in the XML document.
Note that the "name" parameters are not displayed in the UML class diagrams.
Arbitrary annotations can be assigned to the main classes of the data model using string attributes named "description".
Values of this attribute have no effect on the configuration and purely serve to provide some context information to the (human) reader.-->
</t>
<t>
The configuration data model for IPFIX and PSAMP makes use of unidirectional associations to specify the data flow between different functional blocks.
For example, if the output of a Selection Process is processed by a Cache, this corresponds to an object of the SelectionProcess class that contains a reference to an object of the Cache class.
The configuration data model does not mandate that such a reference exists for every functional block that has an output.
If such a reference is absent, the output is dropped without any further processing.
<!--The motivation for allowing such incomplete configurations is that stand-by processes can be specified.-->
Although such configurations are incomplete, we do not consider them as invalid as they may temporarily occur if a Monitoring Device is configured in multiple steps.
Also, it might be useful to pre-configure certain functions of a Monitoring Device in order to be able to switch to a new configuration more quickly.
</t>
</section>
<section anchor="sec:exporter" title="Exporter Configuration">
<t>
<xref target="fig:classes"/> below shows the main classes of the configuration data model which are involved in the configuration of an IPFIX or PSAMP Exporter.
The role of the classes can be briefly summarized as follows:
</t>
<t>
<list style="symbols">
<t>
The ObservationPoint class specifies an Observation Point (i.e., an interface or linecard) of the Monitoring Device at which packets are captured for traffic measurements.
An object of the ObservationPoint class may be associated with one or more objects of the SelectionProcess class configuring Selection Processes that process the observed packets in parallel.
As long as an ObservationPoint object is specified without any references to SelectionProcess objects, the captured packets are not considered by any Metering Process.
</t>
<vspace blankLines="1" />
<t>
The SelectionProcess class contains the configuration and state parameters of a Selection Process.
The Selection Process may be composed of a single Selector or a sequence of Selectors, defining a Primitive or Composite Selector, respectively.
<vspace blankLines="1" />
<!-- FIXME: only one OP at the input of a Selection Process, agreed by Atsushi -->
The Selection Process selects packets from one or more Observed Packet Streams, each originating from a different Observation Point.
Therefore, a SelectionProcess object MAY be referred to from one or more ObservationPoint objects.
<vspace blankLines="1" />
A Selection Process MAY pass the Selected Packet Stream to a Cache.
Therefore, the SelectionProcess class contains a reference to an object of the Cache class.
If a Selection Process is configured without any reference to a Cache, the selected packets are not accounted in any Packet Report or Flow Record.
<!-- FIXME: possible explanation, currently not added
A Selection Process MUST NOT be referred to from multiple instances of the ObservationPoint and SelectionProcess classes in order to conform to <xref target="RFC5476"/>.
Otherwise, the Selection Sequence (Statistics) Report Interpretation cannot be determined per Observation Point.
<vspace blankLines="0" />-->
<!-- FIXME: Change agreed by Atsushi
A Selection Process MAY be configured without any reference to Selection Processes or Caches that receive the selected packets, which is useful for the configuration of standby processes.
In this case, the selected packets are not accounted in any Packet Report or Flow Record.
-->
</t>
<vspace blankLines="1" />
<t>
The Cache class contains configuration and state parameters of a Cache.
A Cache may receive the output of one or more Selection Processes and maintains corresponding Packet Reports or Flow Records.
Therefore, an object of the Cache class MAY be referred to from multiple SelectionProcess objects.
<!-- FIXME: remove because of change in IPFIX-MIB
However, the configuration MUST ensure that all packets entering the Selection Process have been observed at Observation Points belonging to the same Observation Domain.
-->
<vspace blankLines="1" />
Configuration parameters of the Cache class specify the size of the Cache, the Cache Layout, and expiration parameters if applicable.
The Cache configuration also determines whether Packet Reports or Flow Records are generated.
<vspace blankLines="1" />
A Cache MAY pass its output to one or multiple Exporting Process.
Therefore, the Cache class enables references to one or multiple objects of the ExportingProcess class.
<!--
A Cache object without any reference to an ExportingProcess object represents a standby Cache.
In this case, the Cache output is dropped.
-->
If a Cache object does not specify any reference to an ExportingProcess object, the Cache output is dropped.
</t>
<vspace blankLines="1" />
<t>
The ExportingProcess class contains configuration and state parameters of an Exporting Process.
It includes various transport protocol specific parameters and the export destinations.
An object of the ExportingProcess class MAY be referred to from multiple objects of the Cache class.
<vspace blankLines="1" />
An Exporting Process MAY be configured as a File Writer according to <xref target="RFC5655"/>.
</t>
</list>
</t>
<figure anchor="fig:classes" title="Class diagram of Exporter configuration" align="center">
<artwork>
<![CDATA[+------------------+
| ObservationPoint |
+------------------+
0..* |
|
0..* V
+------------------+
| SelectionProcess |
+------------------+
0..* |
|
0..1 V
+------------------+
| Cache |
+------------------+
0..* |
|
0..* V
+------------------+
| ExportingProcess |
+------------------+]]>
</artwork>
</figure>
<!--
<t>
As can be seen in <xref target="fig:classes" />, the MeteringProcess class defines references to instances of the SelectionProcess class and the Cache class.
It acts as an envelope element specifying a series of Selection Processes, forming a Selection Sequence, and a record cache.
The order in which the user specifies Selection Processes in the XML document corresponds to the order in which they are applied.
Hence, by using UML associations instead of aggregation relationships, the same Selection Processes and record caches can be deployed in different Metering Processes.
An example is given in <xref target="sec:psamp-example" />.
The MeteringProcess class itself is not instantiated, but specified as part of the ObservationPoint class.
Using the same Metering Process with different Observation Points is achieved by referring to the same instances of the SelectionProcess class and the Cache class.
Considering Selection Processes and Cache Parameters as instances (and not the complete Metering Process) corresponds to the common practice to implement Selection Processes and record caches as independent modules.
</t>
<t>
The Cache class refers to instances of the ExportingProcess class, which enables using the same Exporting Process for different Metering Processes.
</t>
-->
</section>
<section anchor="sec:collector" title="Collector Configuration">
<t>
<xref target="fig:classes2"/> below shows the main classes of the configuration data model which are involved in the configuration of a Collector.
An object of the CollectingProcess class specifies the local IP addresses, transport protocols and port numbers of a Collecting Process.
Alternatively, the Collecting Process MAY be configured as a File Reader according to <xref target="RFC5655"/>.
<!--
If the Monitoring Device acts as a mediator or concentrator, an instance of the CollectingProcess refers to one or more Caches which use the information in the received Flow Records to create new Flow Records.
Records which are expired or timed out are exported by the Exporting Processes the Cache refers to.
If the Monitoring Device is to export the received Flow Records without modification to a file or another collector, the instance of the CollectingProcess class refers to instances of the ExportingProcess class directly.
-->
</t>
<t>
An object of the CollectingProcess class may refer to one or multiple ExportingProcess objects configuring Exporting Processes that reexport the received data.
As an example, an Exporting Process can be configured as a File Writer in order to save the received IPFIX Messages in a file.
</t>
<figure anchor="fig:classes2" title="Class diagram of Collector configuration" align="center">
<artwork>
<![CDATA[+-------------------+
| CollectingProcess |
+-------------------+
0..* |
|
0..* V
+-------------------+
| ExportingProcess |
+-------------------+]]>
</artwork>
</figure>
</section>
</section>
<section anchor="sec:parameters" title="Configuration Parameters">
<t>
This section specifies the configuration and state parameters of the configuration data model separately for each class.
</t>
<section anchor="sec:observation-point" title="ObservationPoint Class">
<figure anchor="fig:observation-point" title="ObservationPoint class" align="center">
<artwork>
<![CDATA[+-------------------------------+
| ObservationPoint |
+-------------------------------+
| name |
| observationPointId {readOnly} |
| observationDomainId | 0..*
| ifName[0..*] |-------------+
| ifIndex[0..*] | | 0..*
| entPhysicalName[0..*] | V
| entPhysicalIndex[0..*] | +------------------+
| direction = "both" | | SelectionProcess |
+-------------------------------+ +------------------+]]>
</artwork>
</figure>
<t>
<xref target="fig:observation-point" /> shows the ObservationPoint class that specifies an Observation Point of the Monitoring Device.
</t>
<t>
As defined in <xref target="RFC5101"/>, an Observation Point can be any location where packets are observed.
A Monitoring Device potentially has more than one such location.
An instance of ObservationPoint class defines which location is associated with a specific Observation Point.
For this purpose, interfaces and physical entities are identified using their names.
Alternatively, index values of the corresponding entries in the ifTable (IF-MIB module <xref target="RFC2863"/>) or the entPhysicalTable (ENTITY-MIB modules <xref target="RFC4133"/>) can be used as identifiers.
However, indices SHOULD only be used as identifiers if an SNMP agent on the same Monitoring Device enables access to the corresponding MIB tables.
</t>
<t>
By its definition in <xref target="RFC5101"/>, an Observation Point may be associated with a set of interfaces.
Therefore, the configuration data model allows configuring multiple interfaces and physical entities for a single Observation Point.
</t>
<t>
The Observation Point ID (i.e., the value of the Information Element observationPointId <xref target="RFC5102"/>) is assigned by the Monitoring Device.
It appears as a state parameter in the ObservationPoint class.
</t>
<t>
The configuration parameters of the Observation Point are:
</t>
<t>
<list style="hanging">
<t hangText="observationDomainId:">
This parameter defines the identifier of the Observation Domain the Observation Point belongs to.
Observation Points that are configured with the same Observation Domain ID belong to the same Observation Domain.
<vspace blankLines="0" />
Note that this parameter corresponds to ipfixObservationPointObservationDomainId in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="ifName/ifIndex/entPhysicalName/entPhysicalIndex:">
These parameters identify interfaces and physical entities (e.g., linecards) on the Monitoring Device which are associated with the given Observation Point.
<vspace blankLines="0" />
An interface is either identified by its name (ifName) or the ifIndex value of the corresponding object in the IF-MIB module <xref target="RFC2863"/>.
ifIndex SHOULD only be used if an SNMP agent enables access to the ifTable.
<vspace blankLines="0" />
Similarly, a physical entity is either identified by its name (entPhysicalName) or the entPhysicalIndex value of the corresponding object in the ENTITY-MIB module <xref target="RFC4133"/>.
entPhysicalIndex SHOULD only be used if an SNMP agent enables access to the entPhysicalTable.
<vspace blankLines="0" />
Note that the parameters ifIndex and entPhysicalIndex correspond to ipfixObservationPointPhysicalInterface and ipfixObservationPointPhysicalEntity in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="direction:">
This parameter specifies if ingress traffic, egress traffic, or both ingress and egress traffic is captured, using the values "ingress", "egress", and "both", respectively.
If not configured, ingress and egress traffic is captured (i.e., the default value is "both").
If not applicable (e.g., in the case of a sniffing interface in promiscuous mode), the value of this parameter is ignored.
</t>
</list>
</t>
<t>
An ObservationPoint object MAY refer to one or multiple SelectionProcess objects configuring Selection Processes that process the observed packets in parallel.
</t>
</section>
<section anchor="sec:selection-process" title="SelectionProcess Class">
<figure anchor="fig:selection-process" title="SelectionProcess class" align="center">
<artwork>
<![CDATA[+------------------+
| SelectionProcess |
+------------------+ 1..* +----------+
| name |<>------| Selector |
| | +----------+
| |
| | 0..* +--------------------------------+
| |<>------| SelectionSequence |
| | +--------------------------------+
| | | observationDomainId {readOnly} |
| | | selectionSequenceId {readOnly} |
| | +--------------------------------+
| |
| | 0..* 0..1 +-------+
| |----------->| Cache |
+------------------+ +-------+]]>
</artwork>
</figure>
<t>
<xref target="fig:selection-process" /> shows the SelectionProcess class.
The SelectionProcess class contains the configuration and state parameters of a Selection Process which selects packets from one or more Observed Packet Streams and generates a Selected Packet Stream as its output.
A non-empty ordered list defines a sequence of Selectors.
The actions defined by the Selectors are applied to the stream of incoming packet in the specified order.
</t>
<t>
If the Selection Process receives packets from multiple Observation Points, the Observed Packet Streams need to be processed independently in separate Selection Sequences.
Each Selection Sequence is identified by a Selection Sequence ID which is unique within the Observation Domain the Observation Point belongs to (see <xref target="RFC5477"/>).
Selection Sequence IDs are assigned by the Monitoring Device.
As state parameters, the SelectionProcess class contains a list of (observationDomainId, selectionSequenceId) tuples specifying the assigned Selection Sequence IDs and corresponding Observation Domain IDs.
With this information, it is possible to associate Selection Sequence (Statistics) Report Interpretations exported according to the PSAMP protocol specification <xref target="RFC5476"/> with the corresponding object of the SelectionProcess class.
</t>
<t>
A SelectionProcess object MAY include a reference to an object of the Cache class to generate Packet Reports or Flow Records from the Selected Packet Stream.
</t>
<section anchor="sec:selector" title="Selector Class">
<figure anchor="fig:selector" title="Selector class" align="center">
<artwork>
<![CDATA[+--------------------------------------+
| Selector |
+--------------------------------------+ 1 +-----------------+
| name |<>------+ SelectAll/ |
| packetsObserved {readOnly} | | SampCountBased/ |
| packetsDropped {readOnly} | | SampTimeBased/ |
| selectorDiscontinuityTime {readOnly} | | SampRandOutOfN/ |
| | | SampUniProb/ |
| | | FilterMatch/ |
| | | FilterHash/ |
+--------------------------------------+ +-----------------+]]>
</artwork>
</figure>
<t>
The Selector class in <xref target="fig:selector"/> contains the configuration and state parameters of a Selector.
Standardized PSAMP Sampling and Filtering methods are described in <xref target="RFC5475"/>; their configuration parameters are specified in the classes SampCountBased, SampTimeBased, SampRandOutOfN, SampUniProb, FilterMatch, and FilterHash.
In addition, the SelectAll class, which has no parameters, is used for a Selector that selects all packets.
The Selector class includes exactly one of these sampler and filter classes, depending on the applied method.
</t>
<!--
<t>
The state parameter selectorId contains the Selector ID (i.e., the value of the Information Element selectorId <xref target="RFC5477"/>) assigned by the Monitoring Device.
The Selector ID MUST be unique within the Observation Domain as required by <xref target="RFC5477"/>.
</t>
-->
<t>
As state parameters, the Selector class contains the Selector statistics packetsObserved and packetsDropped as well as selectorDiscontinuityTime, which correspond to the IPFIX MIB module objects ipfixSelectionProcessStatsPacketsObserved, ipfixSelectionProcessStatsPacketsDropped, and ipfixSelectionProcessStatsDiscontinuityTime, respectively <xref target="RFC6615"/>:
</t>
<t>
<list style="hanging">
<t hangText="packetsObserved:">
The total number of packets observed at the input of the Selector.
If this is the first Selector in the Selection Process, this counter corresponds to the total number of packets in all Observed Packet Streams at the input of the Selection Process.
Otherwise, the counter corresponds to the total number of packets at the output of the preceding Selector.
Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of selectorDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="packetsDropped:">
The total number of packets discarded by the Selector.
Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of selectorDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="selectorDiscontinuityTime:">
Timestamp of the most recent occasion at which one or more of the Selector counters suffered a discontinuity.
In contrast to ipfixSelectionProcessStatsDiscontinuityTime, the time is absolute and not relative to sysUpTime.
</t>
</list>
</t>
<t>
Note that packetsObserved and packetsDropped are aggregate statistics calculated over all Selection Sequences of the Selection Process.
This is in contrast to the counter values in the Selection Sequence Statistics Report Interpretation <xref target="RFC5476"/> which are related to a single Selection Sequence only.
</t>
</section>
<section anchor="sec:samler" title="Sampler Classes">
<figure anchor="fig:sampler" title="Sampler classes" align="center">
<artwork>
<![CDATA[+----------------+ +----------------+ +----------------+
| SampCountBased | | SampTimeBased | | SampRandOutOfN |
+----------------+ +----------------+ +----------------+
| packetInterval | | timeInterval | | population |
| packetSpace | | timeSpace | | size |
+----------------+ +----------------+ +----------------+
+----------------+
| SampUniProb |
+----------------+
| probability |
+----------------+]]>
</artwork>
</figure>
<t>
The Sampler classes in <xref target="fig:sampler"/> contain the configuration parameters of specific Sampling algorithms:
</t>
<t>
<list style="hanging">
<t hangText="packetInterval, packetSpace:">
For systematic count-based sampling, packetInterval defines the number of packets that are consecutively sampled between gaps of length packetSpace.
These parameters correspond to the Information Elements samplingPacketInterval and samplingPacketSpace <xref target="RFC5477"/>, as well as to the PSAMP MIB objects psampSampCountBasedInterval and psampSampCountBasedSpace <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
<vspace blankLines="1" />
<t hangText="timeInterval, timeSpace:">
For systematic time-based sampling, timeInterval defines the time interval during which all arriving packets are sampled.
timeSpace is the gap between two sampling intervals.
These parameters correspond to the Information Elements samplingTimeInterval and samplingTimeSpace <xref target="RFC5477"/>, as well as to the PSAMP MIB objects psampSampTimeBasedInterval and psampSampTimeBasedSpace <xref target="I-D.ietf-ipfix-psamp-mib"/>.
The unit is microseconds.
</t>
<vspace blankLines="1" />
<t hangText="size, population:">
For n-out-of-N random sampling, size defines the number of elements taken from the parent population.
population defines the number of elements in the parent population.
These parameters correspond to the Information Elements samplingSize and samplingPopulation <xref target="RFC5477"/>, as well as to the PSAMP MIB objects psampSampRandOutOfNSize and psampSampRandOutOfNPopulation <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
<vspace blankLines="1" />
<t hangText="probability:">
For uniform probabilistic sampling, probability defines the sampling probability.
The probability is expressed as a value between 0 and 1.
This parameter corresponds to the Information Element samplingProbability <xref target="RFC5477"/>, as well as to the PSAMP MIB object psampSampUniProbProbability <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
</list>
</t>
</section>
<section anchor="sec:filter" title="Filter Classes">
<figure anchor="fig:filter" title="Filter classes" align="center">
<artwork>
<![CDATA[+---------------------------+
| FilterMatch |
+---------------------------+
| ieId/ieName |
| ieEnterpriseNumber = 0 |
| value |
+---------------------------+
+---------------------------+
| FilterHash |
+---------------------------+ 1..* +---------------+
| hashFunction = "BOB" |<>-------| SelectedRange |
| initializerValue[0..1] | +---------------+
| ipPayloadOffset = 0 | | name |
| ipPayloadSize = 8 | | min |
| digestOutput = "false" | | max |
| outputRangeMin {readOnly} | +---------------+
| outputRangeMax {readOnly} |
+---------------------------+]]>
</artwork>
</figure>
<t>
The Filter classes in <xref target="fig:filter"/> contain the configuration parameters of specific Filtering methods.
For property match filtering, the configuration parameters are:
</t>
<t>
<list style="hanging">
<t hangText="ieId, ieName, ieEnterpriseNumber:">
The property to be matched is specified by either ieId or ieName, specifying the ID or name of the Information Element, respectively.
If ieEnterpriseNumber is zero (which is the default), this Information Element is registered in the IANA registry of IPFIX Information Elements <xref target="IANA-IPFIX"/>.
A non-zero value of ieEnterpriseNumber specifies an enterprise-specific Information Element.
</t>
<vspace blankLines="1" />
<t hangText="value:">
Matching value.
</t>
</list>
</t>
<t>
For hash-based filtering, the configuration and state parameters are:
</t>
<t>
<list style="hanging">
<t hangText="hashFunction:">
Hash function to be used.
The following parameter values are defined by the configuration data model:
<list style="symbols">
<t>BOB: BOB Hash Function as specified in <xref target="RFC5475"/>, Appendix A.2</t>
<t>IPSX: IP Shift-XOR (IPSX) Hash Function as specified in <xref target="RFC5475"/>, Appendix A.1</t>
<t>CRC: CRC-32 function as specified in <xref target="RFC1141"/></t>
</list>
Default value is "BOB".
This parameter corresponds to the PSAMP MIB object psampFiltHashFunction <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
<vspace blankLines="1" />
<t hangText="initializerValue:">
Initializer value to the hash function.
This parameter corresponds to the Information Element hashInitialiserValue <xref target="RFC5477"/>, as well as to the PSAMP MIB object psampFiltHashInitializerValue <xref target="I-D.ietf-ipfix-psamp-mib"/>.
If not configured by the user, the Monitoring Device arbitrarily chooses an initializer value.
</t>
<vspace blankLines="1" />
<t hangText="ipPayloadOffset, ipPayloadSize:">
ipPayloadOffset and ipPayloadSize configure the offset and the size of the payload section used as input to the hash function.
Default values are 0 and 8, respectively, corresponding to the minimum configurable values according to <xref target="RFC5476"/>, Section 6.2.5.6.
These parameters correspond to the Information Elements hashIPPayloadOffset and hashIPPayloadSize <xref target="RFC5477"/>, as well as to the PSAMP MIB objects psampFiltHashIpPayloadOffset and psampFiltHashIpPayloadSize <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
<vspace blankLines="1" />
<t hangText="digestOutput:">
digestOutput enables or disables the inclusion of the packet digest in the resulting PSAMP Packet Report.
This requires that the Cache Layout of the Cache generating the Packet Reports includes a digestHashValue field.
This parameter corresponds to the Information Element hashDigestOutput <xref target="RFC5477"/>.
</t>
<vspace blankLines="1" />
<t hangText="outputRangeMin, outputRangeMax:">
The values of these two state parameters are the beginning and end of the hash function's potential output range.
These parameters correspond to the Information Elements hashOutputRangeMin and hashOutputRangeMax <xref target="RFC5477"/>, as well as to the PSAMP MIB objects psampFiltHashOutputRangeMin and psampFiltHashOutputRangeMax <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
</list>
</t>
<t>
One or more ranges of matching hash values are defined by the min and max parameters of the SelectedRange subclass.
These parameters correspond to the Information Elements hashSelectedRangeMin and hashSelectedRangeMax <xref target="RFC5477"/>, as well as to the PSAMP MIB objects psampFiltHashSelectedRangeMin and psampFiltHashSelectedRangeMax <xref target="I-D.ietf-ipfix-psamp-mib"/>.
</t>
</section>
</section>
<section anchor="sec:cache" title="Cache Class">
<figure anchor="fig:cache" title="Cache class" align="center">
<artwork>
<![CDATA[+-----------------------------------+
| Cache |
+-----------------------------------+ 1 +------------------+
| name |<>--------| immediateCache/ |
| meteringProcessId {readOnly} | | timeoutCache/ |
| dataRecords {readOnly} | | naturalCache/ |
| cacheDiscontinuityTime {readOnly} | | permanentCache |
| | +------------------+
| |
| | 0..* +------------------+
| |--------->| ExportingProcess |
+-----------------------------------+ +------------------+]]>
</artwork>
</figure>
<t>
<xref target="fig:cache"/> shows the Cache class that contains the configuration and state parameters of a Cache.
Most of these parameters are specific to the type of the Cache and therefore contained in the subclasses immediateCache, timeoutCache, naturalCache, and permanentCache, which are presented below in <xref target="sec:immediate-cache" /> and <xref target="sec:other-cache"/>.
The following three state parameters are common to all Caches and therefore included in the Cache class itself:
</t>
<t>
<list style="hanging">
<t hangText="meteringProcessId:">
The identifier of the Metering Process the Cache belongs to.
<vspace blankLines="0" />
This parameter corresponds to the Information Element meteringProcessId <xref target="RFC5102"/>.
Its occurrence helps to associate Metering Process (Reliability) Statistics exported according to the IPFIX protocol specification <xref target="RFC5101"/> with the corresponding object of the MeteringProcess class.
</t>
<vspace blankLines="1" />
<t hangText="dataRecords:">
The number of Data Records generated by this Cache.
Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of cacheDiscontinuityTime.
<vspace blankLines="0" />
Note that this parameter corresponds to ipfixMeteringProcessDataRecords in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="cacheDiscontinuityTime:">
Timestamp of the most recent occasion at which dataRecords suffered a discontinuity.
In contrast to ipfixMeteringProcessDiscontinuityTime, the time is absolute and not relative to sysUpTime.
<vspace blankLines="0" />
Note that this parameter functionally corresponds to ipfixMeteringProcessDiscontinuityTime in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
</list>
</t>
<t>
A Cache object MAY refer to one or multiple ExportingProcess objects configuring different Exporting Processes.
</t>
<section anchor="sec:immediate-cache" title="ImmediateCache Class">
<figure anchor="fig:immediate-cache" title="ImmediateCache class" align="center">
<artwork>
<![CDATA[+-------------------------------+
| ImmediateCache |
+-------------------------------+ 1 +-------------+
| |<>-------| CacheLayout |
+-------------------------------+ +-------------+]]>
</artwork>
</figure>
<t>
The ImmediateCache class depicted in <xref target="fig:immediate-cache"/> is used to configure a Cache which generates a PSAMP Packet Report for each packet at its input.
The fields contained in the generated Data Records are defined in an object of the CacheLayout class which is defined below in <xref target="sec:cache-layout"/>.
</t>
</section>
<section anchor="sec:other-cache" title="TimeoutCache, NaturalCache, and PermanentCache Class">
<figure anchor="fig:other-cache" title="TimeoutCache, NaturalCache, and PermanentCache class" align="center">
<artwork>
<![CDATA[+-------------------------------+
| TimeoutCache |
+-------------------------------+ 1 +-------------+
| maxFlows {opt.} |<>-------| CacheLayout |
| activeTimeout {opt.} | +-------------+
| idleTimeout {opt.} |
| activeFlows {readOnly} |
| unusedCacheEntries {readOnly} |
+-------------------------------+
+-------------------------------+
| NaturalCache |
+-------------------------------+ 1 +-------------+
| maxFlows {opt.} |<>-------| CacheLayout |
| activeTimeout {opt.} | +-------------+
| idleTimeout {opt.} |
| activeFlows {readOnly} |
| unusedCacheEntries {readOnly} |
+-------------------------------+
+-------------------------------+
| PermanentCache |
+-------------------------------+ 1 +-------------+
| maxFlows {opt.} |<>-------| CacheLayout |
| exportInterval {opt.} | +-------------+
| activeFlows {readOnly} |
| unusedCacheEntries {readOnly} |
+-------------------------------+]]>
</artwork>
</figure>
<t>
<xref target="fig:other-cache"/> shows the TimeoutCache class, the NaturalCache class, and the PermanentCache class.
These classes are used to configure a Cache which aggregates the packets at its input and generates IPFIX Flow Records.
The three classes differ in when Flows expire:
</t>
<t>
<list style="symbols">
<t>TimeoutCache: Flows expire after active or idle timeout.</t>
<t>NaturalCache: Flows expire after active or idle timeout, or on natural termination (e.g., TCP FIN, or TCP RST) of the Flow.</t>
<t>PermanentCache: Flows never expire, but are periodically exported with the interval set by exportInterval.</t>
</list>
</t>
<t>
The following configuration and state parameters are common to the three classes:
</t>
<t>
<list style="hanging">
<t hangText="maxFlows:">
This parameter configures the maximum number of entries in the Cache, which is the maximum number of Flows that can be measured simultaneously.
<vspace blankLines="0" />
If this parameter is configured, the Monitoring Device MUST ensure that sufficient resources are available to store the configured maximum number of Flows.
If the maximum number of Cache entries is in use, no additional Flows can be measured.
However, traffic which pertains to existing Flows can continue to be measured.
</t>
<vspace blankLines="1" />
<t hangText="activeFlows:">
This state parameter indicates the number of Flows currently active in this Cache (i.e., the number of Cache entries currently in use).
<vspace blankLines="0" />
Note that this parameter corresponds to ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="unusedCacheEntries:">
The number of unused cache entries.
Note that the sum of activeFlows and unusedCacheEntries equals maxFlows if maxFlows is configured.
<vspace blankLines="0" />
Note that this parameter corresponds to ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
</list>
</t>
<t>
The following timeout parameters are only available in the TimeoutCache class and the NaturalCache class:
</t>
<t>
<list style="hanging">
<t hangText="activeTimeout:">
This parameter configures the time in seconds after which a Flow is expired even though packets matching this Flow are still received by the Cache.
The parameter value zero indicates infinity, meaning that there is no active timeout.
<vspace blankLines="0" />
If not configured by the user, the Monitoring Device sets this parameter.
<vspace blankLines="0" />
Note that this parameter corresponds to ipfixMeteringProcessCacheActiveTimeout in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="idleTimeout:">
This parameter configures the time in seconds after which a Flow is expired if no more packets matching this Flow are received by the Cache.
The parameter value zero indicates infinity, meaning that there is no idle timeout.
<vspace blankLines="0" />
If not configured by the user, the Monitoring Device sets this parameter.
<vspace blankLines="0" />
Note that this parameter corresponds to ipfixMeteringProcessCacheIdleTimeout in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
</list>
</t>
<t>
The following interval parameter is only available in the PermanentCache class:
</t>
<t>
<list style="hanging">
<t hangText="exportInterval:">
This parameter configures the interval (in seconds) for periodical export of Flow Records.
<vspace blankLines="0" />
If not configured by the user, the Monitoring Device sets this parameter.
</t>
</list>
</t>
<t>
Every generated Flow Record MUST be associated with a single Observation Domain.
Hence, although a Cache MAY be configured to process packets observed at multiple Observation Domains, the Cache MUST NOT aggregate packets observed at different Observation Domains in the same Flow.
</t>
<t>
An object of the Cache class contains an object of the CacheLayout class that defines which fields are included in the Flow Records.
</t>
</section>
<section anchor="sec:cache-layout" title="CacheLayout Class">
<figure anchor="fig:cache-layout" title="CacheLayout class" align="center">
<artwork>
<![CDATA[+--------------+
| CacheLayout |
+--------------+ 1..* +--------------------------------+
| |<>------| CacheField |
| | +--------------------------------+
| | | name |
| | | ieId/ieName |
| | | ieLength {opt.} |
| | | ieEnterpriseNumber = 0 |
| | | isFlowKey[0..1] {not used with |
| | | ImmediateCache class} |
+--------------+ +--------------------------------+]]>
</artwork>
</figure>
<t>
A Cache generates and maintains Packet Reports or Flow Records containing information that has been extracted from the incoming stream of packets.
Using the CacheField class, the CacheLayout class specifies the superset of fields that are included in the Packet Reports or Flow Records (see <xref target="fig:cache-layout"/>).
</t>
<t>
If Packet Reports are generated (i.e., if ImmediateCache class is used to configure the Cache), every field specified by the Cache Layout MUST be included in the resulting Packet Report unless the corresponding Information Element is not applicable or cannot be derived from the content or treatment of the incoming packet.
Any other field specified by the Cache Layout MAY only be included in the Packet Report if it is obvious from the field value itself or from the values of other fields in same Packet Report that the field value was not determined from the packet.
</t>
<t>
<!-- FIXME: example as proposed by Lothar -->
For example, if a field is configured to contain the TCP source port (Information Element tcpSourcePort <xref target="RFC5102"/>), the field MUST be included in all Packet Reports which are related to TCP packets.
Although the field value cannot be determined for non-TCP packets, the field MAY be included in the Packet Reports if another field contains the transport protocol identifier (Information Element protocolIdentifier <xref target="RFC5102"/>).
</t>
<t>
If Flow Records are generated (i.e., if TimeoutCache, NaturalCache, or PermanentCache class is used to configure the Cache), the Cache Layout differentiates between Flow Key fields and non-key fields.
Every Flow Key field specified by the Cache Layout MUST be included as Flow Key in the resulting Flow Record unless the corresponding Information Element is not applicable or cannot be derived from the content or treatment of the incoming packet.
Any other Flow Key field specified by the Cache Layout MAY only be included in the Flow Record if it is obvious from the field value itself or from the values of other Flow Key fields in same Flow Record that the field value was not determined from the packet.
<!-- FIXME: change proposed by Lothar
Two packets MUST be accounted by different Flow Records if different subsets of the Flow Key fields are applicable or derivable.
Two packets MUST be accounted by different Flow Records if they differ in at least one Flow Key field.
Paul proposes to put this in a positive form (23.03.10):
-->
Two packets are accounted by the same Flow Record if none of their Flow Key fields differ.
If a Flow Key field can be determined for one packet but not for the other, the two packets are accounted in different Flow Records.
</t>
<t>
Every non-key field specified by the Cache Layout MUST be included in the resulting Flow Record unless the corresponding Information Element is not applicable or cannot be derived for the given Flow.
Any other non-key field specified by the Cache Layout MAY only be included in the Flow Record if it is obvious from the field value itself or from the values of other fields in same Flow Record that the field value was not determined from the packet.
Packets which are accounted by the same Flow Record may differ in their non-key fields, or one or more of the non-key fields can be undetermined for all or some of the packets.
</t>
<t>
For example, if a non-key field specifies an Information Element whose value is determined by the first packet observed within a Flow (which is the default rule according to <xref target="RFC5102"/> unless specified differently in the description of the Information Element), this field MUST be included in the resulting Flow Record if it can be determined from the first packet of the Flow.
</t>
<t>
The CacheLayout class does not have any parameters.
The configuration parameters of the CacheField class are as follows:
</t>
<t>
<list style="hanging">
<!--
<t>
templateId: This is an optional parameter which allows specifying a Template ID value for the Template.
As specified in the IPFIX protocol <xref target="RFC5101"/>, the Template ID must be locally unique per Observation Domain and Transport Session, which restricts the usage of identical values for multiple Template definitions within the same Monitoring Device configuration.
If this parameter is omitted, the Template ID will be assigned automatically by the Monitoring Device.
</t>
-->
<t hangText="ieId, ieName, ieEnterpriseNumber:">
These parameters specify a field by the combination of the Information Element identifier or name, and the Information Element enterprise number.
Either ieId or ieName MUST be specified.
If ieEnterpriseNumber is zero (which is the default), this Information Element is registered in the IANA registry of IPFIX Information Elements <xref target="IANA-IPFIX"/>.
A non-zero value of ieEnterpriseNumber specifies an enterprise-specific Information Element.
<vspace blankLines="0" />
If the enterprise number is set to 29305, this field contains a Reverse Information Element.
In this case, the Cache MUST generate Data Records in accordance to <xref target="RFC5103"/>.
</t>
<vspace blankLines="1" />
<t hangText="ieLength:">
This parameter specifies the length of the field in octets.
A value of 65535 means that the field is encoded as variable-length Information Element.
For Information Elements of integer and float type, the field length MAY be set to a smaller value than the standard length of the abstract data type if the rules of reduced size encoding are fulfilled (see <xref target="RFC5101"/>, Section 6.2).
If not configured by the user, the field length is set by the Monitoring Device.
</t>
<vspace blankLines="1" />
<t hangText="isFlowKey:">
If present, this field is a Flow Key.
If the field contains a Reverse Information Element, it MUST NOT be configured as Flow Key.
<vspace blankLines="0" />
This parameter is not available if the Cache is configured using the ImmediateCache class since there is no distinction between Flow Key fields and non-key fields in Packet Reports.
</t>
</list>
</t>
<t>
Note that the use of Information Elements can be restricted to certain Cache types as well as to Flow Key or non-key fields.
Such restrictions may result from Information Element definitions or from device-specific constraints.
According to <xref target="sec:adaptation"/>, the Monitoring Device MUST notify the user if a Cache field cannot be configured with the given Information Element.
</t>
<!--
<t>
The order of the fields in the XML document corresponds to the order in the Template.
</t>
-->
</section>
</section>
<section anchor="sec:exporting-process" title="ExportingProcess Class">
<figure anchor="fig:exporting-process" title="ExportingProcess class" align="center">
<artwork>
<![CDATA[+-------------------------------+
| ExportingProcess |
+-------------------------------+ 1..* +-------------+
| name |<>------| Destination |
| exportingProcessId {readOnly} | +-------------+
| exportMode = "parallel" | | name |<>-+
| | +-------------+ | 1
| | |
| | +---------------+
| | | SctpExporter/ |
| | | UdpExporter/ |
| | | TcpExporter/ |
| | | FileWriter |
| | +---------------+
| |
| | 0..* +------------------+
| |<>------| Options |
+-------------------------------+ +------------------+]]>
</artwork>
</figure>
<t>
The ExportingProcess class in <xref target="fig:exporting-process"/> specifies destinations to which the incoming Packet Reports and Flow Records are exported using objects of the Destination class.
The Destination class includes one object of the SctpExporter, UdpExporter, TcpExporter, or FileWriter class which contains further configuration parameters.
These classes are described in <xref target="sec:sctp-export"/>, <xref target="sec:udp-export"/>, <xref target="sec:tcp-export"/>, and <xref target="sec:file-writer"/>.
</t>
<t>
As state parameter, the ExporingProcess class contains the identifier of the Exporing Process (exportingProcessId).
This parameter corresponds to the Information Element exportingProcessId <xref target="RFC5102"/>.
Its occurrence helps to associate Exporting Process Reliability Statistics exported according to the IPFIX protocol specification <xref target="RFC5101"/> with the corresponding object of the ExportingProcess class.
</t>
<t>
The order in which objects of the Destination class appear is defined by the user.
However, the order has a specific meaning only if the exportMode parameter is set to "fallback".
The exportMode parameter is defined as follows:
</t>
<t>
<list style="hanging">
<t hangText="exportMode:">
This parameter determines to which configured destination(s) the incoming Data Records are exported.
The following parameter values are specified by the configuration data model:
<list style="symbols">
<t>parallel: every Data Record is exported to all configured destinations in parallel</t>
<t>loadBalancing: every Data Record is exported to exactly one configured destination according to a device-specific load-balancing policy</t>
<t>fallback: every Data Record is exported to exactly one configured destination according to the fallback policy described below</t>
</list>
If exportMode is set to "fallback", the first object of the Destination class defines the primary destination; the second object of the Destination class defines the secondary destination, and so on.
If the Exporting Process fails to export Data Records to the primary destination, it tries to export them to the secondary one.
If the secondary destination fails as well, it continues with the tertiary, etc.
<vspace blankLines="0" />
"parallel" is the default value if exportMode is not configured.
</t>
</list>
</t>
<t>
Note that the exportMode parameter is related to the ipfixExportMemberType object in <xref target="RFC6615" />.
If exportMode is "parallel", the ipfixExportMemberType values of the corresponding entries in ipfixExportTable are set to parallel(3).
If exportMode is "loadBalancing", the ipfixExportMemberType values of the corresponding entries in ipfixExportTable are set to loadBalancing(4).
If exportMode is "fallback", the ipfixExportMemberType value which refers to the primary destination is set to primary(1); the ipfixExportMemberType values which refer to the remaining destinations need to be set to secondary(2).
The IPFIX MIB module does not define any value for tertiary destination, etc.
</t>
<t>
The reporting of information with Options Templates is defined with objects of the Options class.
</t>
<t>
The Exporting Process may modify the Packet Reports and Flow Records to enable a more efficient transmission or storage under the condition that no information is changed or suppressed.
For example, the Exporting Process may shorten the length of a field according to the rules of reduced size encoding <xref target="RFC5101"/>.
The Exporting Process may also export certain fields in a separate Data Record as described in <xref target="RFC5476"/>.
</t>
<section anchor="sec:sctp-export" title="SctpExporter Class">
<figure anchor="fig:sctp-export" title="SctpExporter class" align="center">
<artwork>
<![CDATA[+------------------------------+
| SctpExporter |
+------------------------------+ 0..1 +------------------------+
| ipfixVersion = 10 |<>-------| TransportLayerSecurity |
| sourceIPAddress[0..*] | +------------------------+
| destinationIPAddress[1..*] |
| destinationPort = 4739|4740 | 0..1 +------------------------+
| ifName/ifIndex[0..1] |<>-------| TransportSession |
| sendBufferSize {opt.} | +------------------------+
| rateLimit[0..1] |
| timedReliability = 0 |
+------------------------------+]]>
</artwork>
</figure>
<t>
The SctpExporter class shown in <xref target="fig:sctp-export"/> contains the configuration parameters of an SCTP export destination.
The configuration parameters are:
</t>
<t>
<list style="hanging">
<t hangText="ipfixVersion:">
Version number of the IPFIX protocol used.
If omitted, the default value is 10 (=0x000a) as specified in <xref target="RFC5101"/>.
</t>
<vspace blankLines="1" />
<t hangText="sourceIPAddress:">
List of source IP addresses used by the Exporting Process.
If configured, the specified addresses are eligible local IP addresses of the multi-homed SCTP endpoint.
If not configured, all locally assigned IP addresses are eligible local IP addresses.
</t>
<vspace blankLines="1" />
<t hangText="destinationIPAddress:">
One or multiple IP addresses of the Collecting Process to which IPFIX Messages are sent.
The user must ensure that all configured IP addresses belong to the same Collecting Process.
The Exporting Process tries to establish an SCTP association to any of the configured destination IP addresses.
</t>
<vspace blankLines="1" />
<t hangText="destinationPort:">
Destination port number to be used.
If not configured, standard port 4739 (IPFIX without TLS and DTLS) or 4740 (IPFIX over TLS or DTLS) is used.
</t>
<vspace blankLines="1" />
<t hangText="ifIndex/ifName:">
Either the index or the name of the interface used by the Exporting Process to export IPFIX Messages to the given destination MAY be specified according to corresponding objects in the IF-MIB <xref target="RFC2863"/>.
If omitted, the Exporting Process selects the outgoing interface based on local routing decision and accepts return traffic, such as transport layer acknowledgments, on all available interfaces.
</t>
<vspace blankLines="1" />
<t hangText="sendBufferSize:">
Size of the socket send buffer in bytes.
If not configured by the user, the buffer size is set by the Monitoring Device.
</t>
<vspace blankLines="1" />
<t hangText="rateLimit:">
Maximum number of bytes per second the Exporting Process may export to the given destination as required by <xref target="RFC5476"/>.
The number of bytes is calculated from the lengths of the IPFIX Messages exported.
If this parameter is not configured, no rate limiting is performed for this destination.
</t>
<vspace blankLines="1" />
<t hangText="timedReliability:">
Lifetime in milliseconds until an IPFIX Message containing Data Sets only is "abandoned" due to the timed reliability mechanism of PR-SCTP <xref target="RFC3758" />.
If this parameter is set to zero, reliable SCTP transport MUST be used for all Data Records.
Regardless of the value of this parameter, the Exporting Process MAY use reliable SCTP transport for Data Sets associated with certain Options Templates, such as the Data Record Reliability Options Template specified in <xref target="RFC6526"/>.
</t>
</list>
</t>
<t>
Using the TransportLayerSecurity class described in <xref target="sec:transportlayersecurity"/>, datagram transport layer security (DTLS) is enabled and configured for this export destination.
</t>
<t>
If a Transport Session is established to the configured destination, the SctpExporter class includes an object of the TransportSession class containing state parameters of the Transport Session.
The TransportSession class is specified in <xref target="sec:transportsession" />.
</t>
</section>
<section anchor="sec:udp-export" title="UdpExporter Class">
<figure anchor="fig:udp-export" title="UdpExporter class" align="center">
<artwork>
<![CDATA[+-------------------------------------+
| UdpExporter |
+-------------------------------------+ 0..1 +------------------+
| ipfixVersion = 10 |<>------| TransportLayer- |
| sourceIPAddress[0..1] | | Security |
| destinationIPAddress | +------------------+
| destinationPort = 4739|4740 |
| ifName/ifIndex[0..1] | 0..1 +------------------+
| sendBufferSize {opt.} |<>------| TransportSession |
| rateLimit[0..1] | +------------------+
| maxPacketSize {opt.} |
| templateRefreshTimeout = 600 |
| optionsTemplateRefreshTimeout = 600 |
| templateRefreshPacket[0..1] |
| optionsTemplateRefreshPacket[0..1] |
+-------------------------------------+]]>
</artwork>
</figure>
<t>
The UdpExporter class shown in <xref target="fig:udp-export"/> contains the configuration parameters of a UDP export destination.
The parameters ipfixVersion, destinationPort, ifName, ifIndex, sendBufferSize, and rateLimit have the same meaning as in the SctpExporter class (see <xref target="sec:sctp-export"/>).
The remaining configuration parameters are:
</t>
<t>
<list style="hanging">
<t hangText="sourceIPAddress:">
This parameter specifies the source IP address used by the Exporting Process.
If this parameter is omitted, the IP address assigned to the outgoing interface is used as source IP address.
</t>
<vspace blankLines="1" />
<t hangText="destinationIPAddress:">
Destination IP address to which IPFIX Messages are sent (i.e., the IP address of the Collecting Process).
</t>
<vspace blankLines="1" />
<t hangText="maxPacketSize:">
This parameter specifies the maximum size of IP packets sent to the Collector.
If set to zero, the Exporting Device MUST derive the maximum packet size from path MTU discovery mechanisms.
If not configured by the user, this parameter is set by the Monitoring Device.
</t>
<vspace blankLines="1" />
<t hangText="templateRefreshTimeout, optionsTemplateRefreshTimeout, templateRefreshPacket, optionsTemplateRefreshPacket:">
These parameters specify when (Options) Templates are refreshed by the Exporting Process.
<vspace blankLines="0" />
templateRefreshTimeout and optionsTemplateRefreshTimeout are specified in seconds between resendings of (Options) Templates.
If omitted, the default value of 600 seconds (10 minutes) is used <xref target="RFC5101"/>.
<vspace blankLines="0" />
templateRefreshPacket and optionsTemplateRefreshPacket specify the number of IPFIX Messages after which (Options) Templates are resent.
If omitted, the (Options) Templates are only resent after timeout.
<vspace blankLines="0" />
Note that the values configured for templateRefreshTimeout and optionsTemplateRefreshTimeout MUST be adapted to the templateLifeTime and optionsTemplateLifeTime parameter settings at the receiving Collecting Process (see <xref target="sec:udp-receiver"/>).
<vspace blankLines="0" />
Note that these parameters correspond to ipfixTransportSessionTemplateRefreshTimeout, ipfixTransportSessionOptionsTemplateRefreshTimeout, ipfixTransportSessionTemplateRefreshPacket, and ipfixTransportSessionOptionsTemplateRefreshPacket in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
</list>
</t>
<t>
Using the TransportLayerSecurity class described in <xref target="sec:transportlayersecurity"/>, datagram transport layer security (DTLS) is enabled and configured for this export destination.
</t>
<t>
If a Transport Session is established to the configured destination, the UdpExporter class includes an object of the TransportSession class containing state parameters of the Transport Session.
The TransportSession class is specified in <xref target="sec:transportsession" />.
</t>
</section>
<section anchor="sec:tcp-export" title="TcpExporter Class">
<figure anchor="fig:tcp-export" title="TcpExporter class" align="center">
<artwork>
<![CDATA[+------------------------------+
| TcpExporter |
+------------------------------+ 0..1 +------------------------+
| ipfixVersion = 10 |<>-------| TransportLayerSecurity |
| sourceIPAddress[0..1] | +------------------------+
| destinationIPAddress |
| destinationPort = 4739|4740 | 0..1 +------------------------+
| ifName/ifIndex[0..1] |<>-------| TransportSession |
| sendBufferSize {opt.} | +------------------------+
| rateLimit[0..1] |
+------------------------------+]]>
</artwork>
</figure>
<t>
The TcpExporter class shown in <xref target="fig:tcp-export"/> contains the configuration parameters of a TCP export destination.
The parameters have the same meaning as in the UdpExporter class (see <xref target="sec:udp-export"/>).
</t>
<t>
Using the TransportLayerSecurity class described in <xref target="sec:transportlayersecurity"/>, transport layer security (TLS) is enabled and configured for this export destination.
</t>
<t>
If a Transport Session is established to the configured destination, the TcpExporter class includes an object of the TransportSession class containing state parameters of the Transport Session.
The TransportSession class is specified in <xref target="sec:transportsession" />.
</t>
</section>
<section anchor="sec:file-writer" title="FileWriter Class">
<figure anchor="fig:file-writer" title="FileWriter classes" align="center">
<artwork>
<![CDATA[+-----------------------------------------+
| FileWriter |
+-----------------------------------------+ 0..* +----------+
| ipfixVersion = 10 |<>-------| Template |
| file | +----------+
| status {readOnly} |
| bytes {readOnly} |
| messages {readOnly} |
| discardedMessages {readOnly} |
| records {readOnly} |
| templates {readOnly} |
| optionsTemplates {readOnly} |
| fileWriterDiscontinuityTime {readOnly} |
+-----------------------------------------+]]>
</artwork>
</figure>
<t>
If an object of the FileWriter class is included in an object of the Destination class, IPFIX Messages are written into a file as specified in <xref target="RFC5655"/>.
The FileWriter class contains the following configuration parameters:
</t>
<t>
<list style="hanging">
<t hangText="ipfixVersion:">
Version number of the IPFIX protocol used.
If omitted, the default value is 10 (=0x000a) as specified in <xref target="RFC5101"/>.
</t>
<vspace blankLines="1" />
<t hangText="file:">
File name and location specified as URI.
</t>
</list>
</t>
<t>
The state parameters of the FileWriter class are:
</t>
<t>
<list style="hanging">
<t hangText="bytes, messages, records, templates, optionsTemplates:">
The number of bytes, IPFIX Messages, Data Records, Template Records, and Options Template Records written by the File Writer.
Discontinuities in the values of these counters can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="discardedMessages:">
The number of IPFIX Messages that could not be written by the File Writer due to internal buffer overflows, limited storage capacity etc.
Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fileWriterDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="fileWriterDiscontinuityTime:">
Timestamp of the most recent occasion at which one or more File Writer counters suffered a discontinuity.
In contrast to discontinuity times in the IPFIX MIB module, the time is absolute and not relative to sysUpTime.
</t>
</list>
</t>
<t>
Each object of the FileWriter class includes a list of objects of the Template class with information and statistics about the Templates written to the file.
The Template class is specified in <xref target="sec:template" />.
</t>
</section>
<section anchor="sec:option" title="Options Class">
<figure anchor="fig:option" title="Options class" align="center">
<artwork>
<![CDATA[+-----------------------+
| Options |
+-----------------------+
| name |
| optionsType |
| optionsTimeout {opt.} |
+-----------------------+]]>
</artwork>
</figure>
<t>
The Options class in <xref target="fig:option"/> defines the type of specific information to be reported, such as statistics, flow keys, Sampling and Filtering parameters etc.
<xref target="RFC5101"/> and <xref target="RFC5476"/> specify several types of reporting information which may be exported.
The following parameter values are specified by the configuration data model:
</t>
<t>
<list style="hanging">
<t hangText="meteringStatistics:">
Export of Metering Process statistics using the Metering Process Statistics Options Template <xref target="RFC5101"/>.
</t>
<vspace blankLines="1" />
<t hangText="meteringReliability:">
Export of Metering Process reliability statistics using the Metering Process Reliability Statistics Options Template <xref target="RFC5101"/>.
</t>
<vspace blankLines="1" />
<t hangText="exportingReliability:">
Export of Exporting Process reliability statistics using the Exporting Process Reliability Statistics Options Template <xref target="RFC5101"/>.
</t>
<vspace blankLines="1" />
<t hangText="flowKeys:">
Export of the Flow Key specification using the Flow Keys Options Template <xref target="RFC5101"/>.
</t>
<vspace blankLines="1" />
<t hangText="selectionSequence:">
Export of Selection Sequence Report Interpretation and Selector Report Interpretation <xref target="RFC5476"/>.
</t>
<vspace blankLines="1" />
<t hangText="selectionStatistics:">
Export of Selection Sequence Statistics Report Interpretation <xref target="RFC5476"/>.
</t>
<vspace blankLines="1" />
<t hangText="accuracy:">
Export of Accuracy Report Interpretation <xref target="RFC5476"/>.
</t>
<vspace blankLines="1" />
<t hangText="reducingRedundancy:">
Enables the utilization of Options Templates to reduce redundancy in the exported Data Records according to <xref target="RFC5473"/>.
The Exporting Process decides when to apply these Options Templates.
</t>
<vspace blankLines="1" />
<t hangText="extendedTypeInformation:">
Export of extended type information for enterprise-specific Information Elements used in the exported Templates <xref target="RFC5610"/>.
</t>
</list>
</t>
<t>
The Exporting Process MUST choose a Template definition according to the options type and available options data.
</t>
<t>
The optionsTimeout parameter specifies the reporting interval (in milliseconds) for periodic export of the option data.
A parameter value of zero means that the export of the option data is not triggered periodically, but whenever the available option data has changed.
This is the typical setting for options types flowKeys, selectionSequence, accuracy, and reducingRedundancy.
If optionsTimeout is not configured by the user, it is set by the Monitoring Device.
</t>
</section>
</section>
<section anchor="sec:collecting-process" title="CollectingProcess Class">
<figure anchor="fig:collecting-process" title="CollectingProcess class" align="center">
<artwork>
<![CDATA[+-------------------+
| CollectingProcess |
+-------------------+
| name | 0..* +------------------+
| |<>----------| SctpCollector |
| | +------------------+
| |
| | 0..* +------------------+
| |<>----------| UdpCollector |
| | +------------------+
| |
| | 0..* +------------------+
| |<>----------| TcpCollector |
| | +------------------+
| |
| | 0..* +------------------+
| |<>----------| FileReader |
| | +------------------+
| |
| | 0..* 0..* +------------------+
| |----------->| ExportingProcess |
+-------------------+ +------------------+]]>
</artwork>
</figure>
<t>
<xref target="fig:collecting-process"/> shows the CollectingProcess class that contains the configuration and state parameters of a Collecting Process.
Objects of the SctpCollector, UdpCollector, and TcpCollector classes specify how IPFIX Messages are received from remote Exporters.
The Collecting Process can also be configured as a File Reader using objects of the FileReader class.
These classes are described in <xref target="sec:sctp-receiver"/>, <xref target="sec:udp-receiver"/>, <xref target="sec:tcp-receiver"/>, and <xref target="sec:file-reader"/>.
</t>
<!--
<t>
If the Monitoring Device is an IPFIX mediator or concentrator as described in <xref target="I-D.kobayashi-ipfix-mediator-model"/> and <xref target="I-D.dressler-ipfix-aggregation"/>, the CollectingProcess class refers to one or multiple Caches which generate new Flow Records with information extracted from the received Flow Records.
</t>
-->
<t>
An CollectingProcess object MAY refer to one or multiple ExportingProcess objects configuring Exporting Processes that export the received data without modifications to a file or to another Collector.
</t>
<section anchor="sec:sctp-receiver" title="SctpCollector Class">
<figure anchor="fig:sctp-receiver" title="SctpCollector class" align="center">
<artwork>
<![CDATA[+--------------------------+
| SctpCollector |
+--------------------------+ 0..1 +------------------------+
| name |<>-------| TransportLayerSecurity |
| localIPAddress[0..*] | +------------------------+
| localPort = 4739|4740 |
| | 0..* +------------------------+
| |<>-------| TransportSession |
+--------------------------+ +------------------------+]]>
</artwork>
</figure>
<t>
The SctpCollector class contains the configuration parameters of a listening SCTP socket at a Collecting Process.
The parameters are:
</t>
<t>
<list style="hanging">
<t hangText="localIPAddress:">
List of local IP addresses on which the Collecting Process listens for IPFIX Messages.
The IP addresses are used as eligible local IP addresses of the multi-homed SCTP endpoint <xref target="RFC4960"/>.
If omitted, the Collecting Process listens on all local IP addresses.
</t>
<vspace blankLines="1" />
<t hangText="localPort:">
Local port number on which the Collecting Process listens for IPFIX Messages.
If omitted, standard port 4739 (IPFIX without TLS and DTLS) or 4740 (IPFIX over TLS or DTLS) is used.
</t>
</list>
</t>
<t>
Using the TransportLayerSecurity class described in <xref target="sec:transportlayersecurity"/>, datagram transport layer security (DTLS) is enabled and configured for this receiving socket.
</t>
<t>
As state data, the SctpCollector class contains the list of currently established Transport Sessions that terminate at the given SCTP socket of the Collecting Process.
The TransportSession class is specified in <xref target="sec:transportsession" />.
</t>
</section>
<section anchor="sec:udp-receiver" title="UdpCollector Class">
<figure anchor="fig:udp-receiver" title="UdpCollector class" align="center">
<artwork>
<![CDATA[+---------------------------------+
| UdpCollector |
+---------------------------------+ 0..1 +------------------------+
| name |<>------| TransportLayerSecurity |
| localIPAddress[0..*] | +------------------------+
| localPort = 4739|4740 |
| templateLifeTime = 1800 | 0..* +------------------------+
| optionsTemplateLifeTime = 1800 |<>------| TransportSession |
| templateLifePacket[0..*] | +------------------------+
| optionsTemplateLifePacket[0..*] |
+---------------------------------+]]>
</artwork>
</figure>
<t>
The UdpCollector class contains the configuration parameters of a listening UDP socket at a Collecting Process.
The parameter localPort has the same meaning as in the SctpCollector class (see <xref target="sec:sctp-receiver"/>).
The remaining parameters are:
</t>
<t>
<list style="hanging">
<t hangText="localIPAddress:">
List of local IP addresses on which the Collecting Process listens for IPFIX Messages.
If omitted, the Collecting Process listens on all local IP addresses.
</t>
<vspace blankLines="1" />
<t hangText="templateLifeTime, optionsTemplateLifeTime:">
(Options) Template lifetime in seconds for all UDP Transport Sessions terminating at this UDP socket.
(Options) Templates which are not received again within the configured lifetime become invalid at the Collecting Process.
<vspace blankLines="0" />
As specified in <xref target="RFC5101"/>, Section 10.3.7, the lifetime of Templates and Options Templates MUST be at least three times higher than the templateRefreshTimeout and optionTemplatesRefreshTimeout parameter values configured on the corresponding Exporting Processes.
<vspace blankLines="0" />
If not configured, the default value 1800 is used, which is three times the default (Options) Template refresh timeout (see <xref target="sec:udp-export"/>) as specified in <xref target="RFC5101"/>.
<vspace blankLines="0" />
Note that these parameters correspond to ipfixTransportSessionTemplateRefreshTimeout and ipfixTransportSessionOptionsTemplateRefreshTimeout in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="templateLifePacket, optionsTemplateLifePacket:">
If templateLifePacket is configured, Templates defined in a UDP Transport Session become invalid if they are neither included in a sequence of more than this number of IPFIX Messages nor received again within the period of time specified by templateLifeTime.
Similarly, if optionsTemplateLifePacket is configured, Options Templates become invalid if they are neither included in a sequence of more than this number of IPFIX Messages nor received again within the period of time specified by optionsTemplateLifeTime.
<vspace blankLines="0" />
If not configured, Templates and Options Templates only become invalid according to the lifetimes specified by templateLifeTime and optionsTemplateLifeTime, respectively.
<vspace blankLines="0" />
Note that these parameters correspond to ipfixTransportSessionTemplateRefreshPacket and ipfixTransportSessionOptionsTemplateRefreshPacket in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
</list>
</t>
<t>
Using the TransportLayerSecurity class described in <xref target="sec:transportlayersecurity"/>, datagram transport layer security (DTLS) is enabled and configured for this receiving socket.
</t>
<t>
As state data, the UdpCollector class contains the list of currently established Transport Sessions that terminate at the given UDP socket of the Collecting Process.
The TransportSession class is specified in <xref target="sec:transportsession" />.
</t>
</section>
<section anchor="sec:tcp-receiver" title="TcpCollector Class">
<figure anchor="fig:tcp-receiver" title="TcpCollector class" align="center">
<artwork>
<![CDATA[+--------------------------+
| TcpCollector |
+--------------------------+ 0..1 +------------------------+
| name |<>-------| TransportLayerSecurity |
| localIPAddress[0..*] | +------------------------+
| localPort = 4739|4740 |
| | 0..* +------------------------+
| |<>-------| TransportSession |
+--------------------------+ +------------------------+]]>
</artwork>
</figure>
<t>
The TcpCollector class contains the configuration parameters of a listening TCP socket at a Collecting Process.
The parameters have the same meaning as in the UdpCollector class (see <xref target="sec:udp-receiver"/>).
</t>
<t>
Using the TransportLayerSecurity class described in <xref target="sec:transportlayersecurity"/>, transport layer security (TLS) is enabled and configured for this receiving socket.
</t>
<t>
As state data, the TcpCollector class contains the list of currently established Transport Sessions that terminate at the given TCP socket of the Collecting Process.
The TransportSession class is specified in <xref target="sec:transportsession" />.
</t>
</section>
<section anchor="sec:file-reader" title="FileReader Class">
<figure anchor="fig:file-reader" title="FileReader classes" align="center">
<artwork>
<![CDATA[+-----------------------------------------+
| FileReader |
+-----------------------------------------+ 0..* +----------+
| name |<>-------| Template |
| file | +----------+
| bytes {readOnly} |
| messages {readOnly} |
| records {readOnly} |
| templates {readOnly} |
| optionsTemplates {readOnly} |
| fileReaderDiscontinuityTime {readOnly} |
+-----------------------------------------+]]>
</artwork>
</figure>
<t>
The Collecting Process may import IPFIX Messages from a file as specified in <xref target="RFC5655"/>.
The FileReader class defines the following configuration parameter:
</t>
<t>
<list style="hanging">
<t hangText="file:">
File name and location specified as URI.
</t>
</list>
</t>
<t>
The state parameters of the FileReader class are:
</t>
<t>
<list style="hanging">
<t hangText="bytes, messages, records, templates, optionsTemplates:">
The number of bytes, IPFIX Messages, Data Records, Template Records, and Options Template Records read by the File Reader.
Discontinuities in the values of these counters can occur at re-initialization of the management system, and at other times as indicated by the value of fileReaderDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="fileReaderDiscontinuityTime:">
Timestamp of the most recent occasion at which one or more File Reader counters suffered a discontinuity.
In contrast to discontinuity times in the IPFIX MIB module, the time is absolute and not relative to sysUpTime.
</t>
</list>
</t>
<t>
Each object of the FileReader class includes a list of objects of the Template class with information and statistics about the Templates read from the file.
The Template class is specified in <xref target="sec:template" />.
</t>
</section>
</section>
<section anchor="sec:transportlayersecurity" title="Transport Layer Security Class">
<figure anchor="fig:transportlayersecurity" title="TransportLayerSecurity class" align="center">
<artwork>
<![CDATA[+--------------------------------------+
| TransportLayerSecurity |
+--------------------------------------+
| localCertificationAuthorityDN[0..*] |
| localSubjectDN[0..*] |
| localSubjectFQDN[0..*] |
| remoteCertificationAuthorityDN[0..*] |
| remoteSubjectDN[0..*] |
| remoteSubjectFQDN[0..*] |
+--------------------------------------+]]>
</artwork>
</figure>
<t>
The TransportLayerSecurity class is used in the Exporting Process's SctpExporter, UdpExporter, and TcpExporter classes and the Collecting Process's SctpCollector, UdpCollector, and TcpCollector classes to enable and configure transport layer security for IPFIX.
Transport layer security can be enabled without configuring any additional parameters.
In this case, an empty XML element <transportLayerSecurity /> appears in the configuration.
If transport layer security is enabled, the endpoint must use DTLS <xref target="RFC6347"/> if the transport protocol is SCTP or UDP, and TLS <xref target="RFC5246" /> if the transport protocol is TCP.
</t>
<t>
<xref target="RFC5101"/> mandates strong mutual authentication of Exporting Processes and Collecting Process:
</t>
<t>
<list style="empty">
<t>
"IPFIX Exporting Processes and IPFIX Collecting Processes are identified by the fully qualified domain name of the interface on which IPFIX Messages are sent or received, for purposes of X.509 client and server certificates as in <xref target="RFC5280"/>.
</t>
<vspace blankLines="1" />
<t>
To prevent man-in-the-middle attacks from impostor Exporting or Collecting Processes, the acceptance of data from an unauthorized Exporting Process, or the export of data to an unauthorized Collecting Process, strong mutual authentication via asymmetric keys MUST be used for both TLS and DTLS.
Each of the IPFIX Exporting and Collecting Processes MUST verify the identity of its peer against its authorized certificates, and MUST verify that the peer's certificate matches its fully qualified domain name, or, in the case of SCTP, the fully qualified domain name of one of its endpoints.
</t>
<vspace blankLines="1" />
<t>
The fully qualified domain name used to identify an IPFIX Collecting Process or Exporting Process may be stored either in a subjectAltName extension of type dNSName, or in the most specific Common Name field of the Subject field of the X.509 certificate.
If both are present, the subjectAltName extension is given preference."
</t>
</list>
</t>
<t>
In order to use transport layer security, appropriate certificates and keys have to be previously installed on the Monitoring Devices.
For security reasons, the configuration data model does not offer the possibility to upload any certificates or keys on a Monitoring Device.
If transport layer security is enabled on a Monitoring Device which does not dispose of appropriate certificates and keys, the configuration MUST be rejected with an error.
</t>
<t>
The configuration data model allows restricting the authorization of remote endpoints to certificates issued by specific certification authorities or identifying specific fully qualified domain names for authorization.
Furthermore, the configuration data model allows restricting the utilization of certificates identifying the local endpoint.
This is useful if the Monitoring Device disposes of more than one certificate for the given local endpoint.
</t>
<t>
The configuration parameters are defined as follows:
</t>
<t>
<list style="hanging">
<t hangText="localCertificationAuthorityDN:">
This parameter MAY appear one or multiple times to restrict the identification of the local endpoint during the TLS/DTLS handshake to certificates issued by the configured certification authorities.
Each occurrence of this parameter contains the distinguished name of one certification authority.
<vspace blankLines="0" />
To identify the local endpoint, the Exporting Process or Collecting Process MUST use a certificate issued by one of the configured certification authority.
Certificates issued by any other certification authority MUST NOT be sent to the remote peer during TLS/DTLS handshake.
If none of the certificates installed on the Monitoring Device fulfills the specified restrictions, the configuration MUST be rejected with an error.
<vspace blankLines="0" />
If localCertificationAuthorityDN is not configured, the choice of certificates identifying the local endpoint is not restricted with respect to the issuing certification authority.
</t>
<vspace blankLines="1" />
<t hangText="localSubjectDN, localSubjectFQDN:">
Each of these parameters MAY appear one or multiple times to restrict the identification of the local endpoint during the TLS/DTLS handshake to certificates issued for specific subjects or for specific fully qualified domain names.
Each occurrence of localSubjectDN contains a distinguished name identifying the local endpoint.
Each occurrence of localSubjectFQDN contains a fully qualified domain name which is assigned to the local endpoint.
<vspace blankLines="0" />
To identify the local endpoint, the Exporting Process or Collecting Process MUST use a certificate that contains either one of the configured distinguished names in the subject field or at least one of the configured fully qualified domain names in a dNSName component of the subject alternative extension field or in the most specific commonName component of the subject field.
If none of the certificates installed on the Monitoring Device fulfills the specified restrictions, the configuration MUST be rejected with an error.
<!--<vspace blankLines="0" />
The Monitoring Device MUST ensure that the X.509 certificate actually identifies the local endpoint before sending it to the remote peer during the TLS/DTLS handshake.-->
<vspace blankLines="0" />
If any of the parameters localSubjectDN and localSubjectFQDN is configured at the same time as the localCertificationAuthorityDN parameter, certificates MUST also fulfill the specified restrictions regarding the certification authority.
<vspace blankLines="0" />
If localSubjectDN and localSubjectFQDN are not configured, the choice of certificates identifying the local endpoint is not restricted with respect to the subject's distinguished name or fully qualified domain name.
</t>
<vspace blankLines="1" />
<t hangText="remoteCertificationAuthorityDN:">
This parameter MAY appear one or multiple times to restrict the authentication of remote endpoints during the TLS/DTLS handshake to certificates issued by the configured certification authorities.
Each occurrence of this parameter contains the distinguished name of one certification authority.
<vspace blankLines="0" />
To authenticate the remote endpoint, the remote Exporting Process or Collecting Process MUST provide a certificate issued by one of the configured certification authority.
Certificates issued by any other certification authority MUST be rejected during TLS/DTLS handshake.
<vspace blankLines="0" />
If the Monitoring Device is not able to validate certificates issued by the configured certification authorities (e.g., because of missing public keys), the configuration must be rejected with an error.
<vspace blankLines="0" />
If remoteCertificationAuthorityDN is not configured, the authorization of remote endpoints is not restricted with respect to the issuing certification authority of the delivered certificate.
</t>
<vspace blankLines="1" />
<t hangText="remoteSubjectDN, remoteSubjectFQDN:">
Each of these parameters MAY appear one or multiple times to restrict the authentication of remote endpoints during the TLS/DTLS handshake to certificates issued for specific subjects or for specific fully qualified domain names.
Each occurrence of remoteSubjectDN contains a distinguished name identifying a remote endpoint.
Each occurrence of remoteSubjectFQDN contains a fully qualified domain name which is assigned to a remote endpoint.
<vspace blankLines="0" />
To authenticate a remote endpoint, the remote Exporting Process or Collecting Process MUST provide a certificate that contains either one of the configured distinguished names in the subject field or at least one of the configured fully qualified domain names in a dNSName component of the subject alternative extension field or in the most specific commonName component of the subject field.
Certificates not fulfilling this condition MUST be rejected during TLS/DTLS handshake.
<vspace blankLines="0" />
If any of the parameters remoteSubjectDN and remoteSubjectFQDN is configured at the same time as the remoteCertificationAuthorityDN parameter, certificates MUST also fulfill the specified restrictions regarding the certification authority in order to be accepted.
<vspace blankLines="0" />
If remoteSubjectDN and remoteSubjectFQDN are not configured, the authorization of remote endpoints is not restricted with respect to the subject's distinguished name or fully qualified domain name of the delivered certificate.
</t>
</list>
</t>
</section>
<section anchor="sec:transportsession" title="Transport Session Class">
<figure anchor="fig:transportsession" title="TransportSession class" align="center">
<artwork>
<![CDATA[+----------------------------------------------+
| TransportSession |
+----------------------------------------------+ 0..* +----------+
| ipfixVersion {readOnly} |<>-------| Template |
| sourceAddress {readOnly} | +----------+
| destinationAddress {readOnly} |
| sourcePort {readOnly} |
| destinationPort {readOnly} |
| sctpAssocId {readOnly} {SCTP only} |
| status {readOnly} |
| rate {readOnly} |
| bytes {readOnly} |
| messages {readOnly} |
| discardedMessages {readOnly} |
| records {readOnly} |
| templates {readOnly} |
| optionsTemplates {readOnly} |
| transportSessionStartTime {readOnly} |
| transportSessionDiscontinuityTime {readOnly} |
+----------------------------------------------+]]>
</artwork>
</figure>
<t>
The TransportSession class contains state data about Transport Sessions originating from an Exporting Process or terminating at a Collecting Process.
In general, the state parameters correspond to the managed objects in the ipfixTransportSessionTable and ipfixTransportSessionStatsTable of the IPFIX MIB module <xref target="RFC6615"/>.
An exception is the usage of the parameters sourceAddress and destinationAddress.
If SCTP is transport protocol, Exporter or Collector MAY be multi-homed SCTP endpoints (see <xref target="RFC4960"/>, Section 6.4) and use more than one IP address.
In the IPFIX MIB module, ipfixTransportSessionSctpAssocId is used instead of ipfixTransportSessionSourceAddress and ipfixTransportSessionDestinationAddress to point to an entry in the sctpAssocTable defined in the SCTP MIB module <xref target="RFC3871"/>.
Since we cannot assume that an SNMP agent offering access to the SCTP MIB module exists on the Monitoring Device, the configuration data model cannot rely on this parameter.
Therefore, the state parameters sourceAddress and destinationAddress are used for SCTP as well, containing one of the potentially many Exporter and Collector IP addresses in the SCTP association.
Preferably, the IP addresses of the path which is usually selected by the Exporter to send IPFIX Messages to the Collector SHOULD be contained.
</t>
<t>
Several MIB objects of the ipfixTransportSessionTable are omitted in the TransportSession class.
The MIB object ipfixTransportSessionDeviceMode is not included because its value can be derived from the context in which a TransportSession object appears: exporting(1) if it belongs to an Exporting Process, collecting(2) if it belongs to a Collecting Process.
Similarly, the MIB object ipfixTransportSessionProtocol is not included as the transport protocol is known from the context as well.
The MIB objects ipfixTransportSessionTemplateRefreshTimeout, ipfixTransportSessionOptionsTemplateRefreshTimeout, ipfixTransportSessionTemplateRefreshPacket, and ipfixTransportSessionOptionsTemplateRefreshPacket are not included since they correspond to configuration parameters of the UdpExporter class (templateRefreshTimeout, optionsTemplateRefreshTimeout, templateRefreshPacket, optionsTemplateRefreshPacket) and the UdpCollector class (templateLifeTime, optionsTemplateLifeTime, templateLifePacket, optionsTemplateLifePacket).
</t>
<t>
<list style="hanging">
<t hangText="ipfixVersion:">
Used for Exporting Processes, this parameter contains the version number of the IPFIX protocol that the Exporter uses to export its data in this Transport Session.
Hence, it is identical to the value of the configuration parameter ipfixVersion of the outer SctpExporter, UdpExporter, or TcpExporter object.
<vspace blankLines="0" />
Used for Collecting Processes, this parameter contains the version number of the IPFIX protocol it receives for this Transport Session.
If IPFIX Messages of different IPFIX protocol versions are received, this parameter contains the maximum version number.
<vspace blankLines="0" />
This state parameter is identical to ipfixTransportSessionIpfixVersion in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="sourceAddress, destinationAddress:">
If TCP or UDP is transport protocol, sourceAddress contains the IP address of the Exporter; destinationAddress contains the IP addresses of the Collector.
Hence, the two parameters have identical values as ipfixTransportSessionSourceAddress and ipfixTransportSessionDestinationAddress in the IPFIX MIB module <xref target="RFC6615"/>.
<vspace blankLines="0" />
If SCTP is transport protocol, sourceAddress contains one of the IP addresses of the Exporter and destinationAddress one of the IP addresses of the Collector.
Preferably, the IP addresses of the path which is usually selected by the Exporter to send IPFIX Messages to the Collector SHOULD be contained.
</t>
<vspace blankLines="1" />
<t hangText="sourcePort, destinationPort:">
These state parameters contain the transport protocol port numbers of the Exporter and the Collector of the Transport Session and thus are identical to ipfixTransportSessionSourcePort and ipfixTransportSessionDestinationPort in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="sctpAssocId:">
The association id used for the SCTP session between the Exporter and the Collector of the Transport Session.
It is equal to the sctpAssocId entry in the sctpAssocTable defined in the SCTP-MIB <xref target="RFC3871"/>.
<vspace blankLines="0" />
This parameter is only available if the transport protocol is SCTP and if an SNMP agent on the same Monitoring Device enables access to the corresponding MIB objects in the sctpAssocTable.
<vspace blankLines="0" />
This state parameter is identical to ipfixTransportSessionSctpAssocId in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="status:">
Status of the Transport Session, which can be one of the following:
<list style="symbols">
<t>inactive: Transport Session is established, but no IPFIX Messages are currently transferred (e.g., because this is a backup (secondary) session)</t>
<t>active: Transport Session is established and transfers IPFIX Messages</t>
<t>unknown: Transport Session status cannot be determined</t>
</list>
<vspace blankLines="0" />
This state parameter is identical to ipfixTransportSessionStatus in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="rate:">
The number of bytes per second transmitted by the Exporting Process or received by the Collecting Process.
This parameter is updated every second.
<vspace blankLines="0" />
This state parameter is identical to ipfixTransportSessionRate in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="bytes, messages, records, templates, optionsTemplates:">
The number of bytes, IPFIX Messages, Data Records, Template Records, and Options Template Records transmitted by the Exporting Process or received by the Collecting Process.
Discontinuities in the values of these counters can occur at re-initialization of the management system, and at other times as indicated by the value of transportSessionDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="discardedMessages:">
Used for Exporting Processes, this parameter indicates the number of messages that could not be sent due to internal buffer overflows, network congestion, routing issues, etc.
<vspace blankLines="0" />
Used for Collecting Process, this parameter indicates the number of received IPFIX Message that are malformed, cannot be decoded, are received in the wrong order or are missing according to the sequence number.
<vspace blankLines="0" />
Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of transportSessionDiscontinuityTime.
</t>
<vspace blankLines="1" />
<t hangText="transportSessionStartTime:">
Timestamp of the start of the given Transport Session.
<vspace blankLines="0" />
This state parameter does not correspond to any object in the IPFIX MIB module.
</t>
<vspace blankLines="1" />
<t hangText="transportSessionDiscontinuityTime:">
Timestamp of the most recent occasion at which one or more of the Transport Session counters suffered a discontinuity.
In contrast to ipfixTransportSessionDiscontinuityTime, the time is absolute and not relative to sysUpTime.
</t>
</list>
</t>
<t>
Note that, if used for Exporting Processes, the values of the state parameters destinationAddress and destinationPort match the values of the configuration parameters destinationIPAddress and destinationPort of the outer SctpExporter, TcpExporter, and UdpExporter objects (in the case of SctpExporter, one of the configured destinationIPAddress values); if the transport protocol is UDP or SCTP and if the parameter sourceIPAddress is configured in the outer UdpExporter or SctpExporter object, the value of sourceAddress equals the configured value or one of the configured values.
Used for Collecting Processes, the value of destinationAddress equals the value (or one of the values) of the parameter localIPAddress if this parameter is configured in the outer UdpCollector, TcpCollector, or SctpCollector object; destinationPort equals the value of the configuration parameter localPort.
</t>
<t>
Each object of the TransportSession class includes a list of objects of the Template class with information and statistics about the Templates transmitted or received on the given Transport Session.
The Template class is specified in <xref target="sec:template" />.
</t>
</section>
<section anchor="sec:template" title="Template Class">
<figure anchor="fig:template" title="Template class" align="center">
<artwork>
<![CDATA[+--------------------------------------+
| Template |
+--------------------------------------+
| observationDomainId {readOnly} |<>---+ 0..*
| templateId {readOnly} | |
| setId {readOnly} | |
| accessTime {readOnly} | |
| templateDataRecords {readOnly} | |
| templateDiscontinuityTime {readOnly} | |
+--------------------------------------+ |
|
+--------------------------------------+
| Field |
+--------------------------------------+
| ieId {readOnly} |
| ieLength {readOnly} |
| ieEnterpriseNumber {readOnly} |
| isFlowKey {readOnly} {non-Options |
| Template only} |
| isScope {readOnly} {Options Template |
| only} |
+--------------------------------------+]]>
</artwork>
</figure>
<t>
The Template class contains state data about Templates used by an Exporting Process or received by a Collecting Process in a specific Transport Session.
The Field class defines one field of the Template.
The names and semantics of the state parameters correspond to the managed objects in the ipfixTemplateTable, ipfixTemplateDefinitionTable, and ipfixTemplateStatsTable of the IPFIX MIB module <xref target="RFC6615"/>:
</t>
<t>
<list style="hanging">
<t hangText="observationDomainId:">
The ID of the Observation Domain for which this Template is defined.
</t>
<vspace blankLines="1" />
<t hangText="templateId:">
This number indicates the Template Id in the IPFIX message.
</t>
<vspace blankLines="1" />
<t hangText="setId:">
This number indicates the Set ID of the Template.
<vspace blankLines="0" />
Currently, there are two values defined <xref target="RFC5101"/>.
The value 2 is used for Sets containing Template definitions.
The value 3 is used for Sets containing Options Template definitions.
</t>
<vspace blankLines="1" />
<t hangText="accessTime:">
Used for Exporting Processes, this parameter contains the time when this (Options) Template was last sent to the Collector or written to the file.
<vspace blankLines="0" />
Used for Collecting Processes, this parameter contains the time when this (Options) Template was last received from the Exporter or read from the file.
</t>
<vspace blankLines="1" />
<t hangText="templateDataRecords:">
The number of transmitted or received Data Records defined by this (Options) Template since the point in time indicated by templateDefinitionTime.
</t>
<vspace blankLines="1" />
<t hangText="templateDiscontinuityTime:">
Timestamp of the most recent occasion at which the counter templateDataRecords suffered a discontinuity.
In contrast to ipfixTemplateDiscontinuityTime, the time is absolute and not relative to sysUpTime.
</t>
<vspace blankLines="1" />
<t hangText="ieId, ieLength, ieEnterpriseNumber:">
Information Element ID, length, and enterprise number of a field in the Template.
If this is not an enterprise-specific Information Element, ieEnterpriseNumber is zero.
<vspace blankLines="0" />
These state parameters are identical to ipfixTemplateDefinitionIeId, ipfixTemplateDefinitionIeLength, and ipfixTemplateDefinitionIeEnterpriseNumber in the IPFIX MIB module <xref target="RFC6615"/>.
</t>
<vspace blankLines="1" />
<t hangText="isFlowKey:">
If this state parameter is present, this is a Flow Key field.
<vspace blankLines="0" />
This parameter is only available for non-Options Templates (i.e., if setId is 2).
</t>
<vspace blankLines="1" />
<t hangText="isFlowKey:">
If this state parameter is present, this is a scope field.
<vspace blankLines="0" />
This parameter is only available for Options Templates (i.e., if setId is 3).
</t>
</list>
</t>
</section>
</section>
<section anchor="sec:adaptation" title="Adaptation to Device Capabilities">
<t>
The configuration data model standardizes a superset of common IPFIX and PSAMP configuration parameters.
A typical Monitoring Device implementation will not support the entire range of possible configurations.
Certain functions may not be supported, such as the Collecting Process that does not exist on a Monitoring Device which is conceived as Exporter only.
The configuration of other functions may be subject to resource limitations or functional restrictions.
For example, the Cache size is typically limited according to the available memory on the device.
It is also possible that a Monitoring Device implementation requires the configuration of additional parameters which are not part of the configuration data model in order to function properly.
</t>
<t>
YANG <xref target="RFC6020"/> offers several possibilities to restrict and adapt a configuration data model.
The current version of YANG defines the concepts of features, deviations, and extensions.
</t>
<t>
The feature concept allows the author of a configuration data model to make proportions of the model conditional in a manner that is controlled by the device.
Devices do not have to support these conditional parts to conform to the model.
If the NETCONF protocol is used, features which are supported by the device are announced in the <hello> message <xref target="RFC6241"/>.
</t>
<t>
The configuration data model for IPFIX and PSAMP covers the configuration of Exporters, Collectors, and devices that may act as both.
As Exporters and Collectors implement different functions, the corresponding proportions of the model are conditional on the following features:
</t>
<t>
<list style="hanging">
<t hangText="exporter:">
If this feature is supported, Exporting Processes can be configured.
</t>
<vspace blankLines="1" />
<t hangText="collector:">
If this feature is supported, Collecting Processes can be configured.
</t>
</list>
</t>
<t>
Exporters do not necessarily implement any Selection Processes, Caches, or even Observation Points in particular cases.
Therefore, the corresponding proportions of the model are conditional on the following feature:
</t>
<t>
<list style="hanging">
<t hangText="meter:">
If this feature is supported, Observation Points, Selection Processes, and Caches can be configured.
</t>
</list>
</t>
<t>
Additional features refer to different PSAMP Sampling and Filtering methods as well as to the supported types of Caches:
</t>
<t>
<list style="hanging">
<t hangText="psampSampCountBased:">
If this feature is supported, Sampling method sampCountBased can be configured.
</t>
<vspace blankLines="1" />
<t hangText="psampSampTimeBased:">
If this feature is supported, Sampling method sampTimeBased can be configured.
</t>
<vspace blankLines="1" />
<t hangText="psampSampRandOutOfN:">
If this feature is supported, Sampling method sampRandOutOfN can be configured.
</t>
<vspace blankLines="1" />
<t hangText="psampSampUniProb:">
If this feature is supported, Sampling method sampUniProb can be configured.
</t>
<vspace blankLines="1" />
<t hangText="psampFilterMatch:">
If this feature is supported, Filtering method filterMatch can be configured.
</t>
<vspace blankLines="1" />
<t hangText="psampFilterHash:">
If this feature is supported, Filtering method filterHash can be configured.
</t>
<vspace blankLines="1" />
<t hangText="immediateCache:">
If this feature is supported, a Cache generating PSAMP Packet Reports can be configured using the ImmediateCache class.
</t>
<vspace blankLines="1" />
<t hangText="timeoutCache:">
If this feature is supported, a Cache generating IPFIX Flow Records can be configured using the TimeoutCache class.
</t>
<vspace blankLines="1" />
<t hangText="naturalCache:">
If this feature is supported, a Cache generating IPFIX Flow Records can be configured using the NaturalCache class.
</t>
<vspace blankLines="1" />
<t hangText="permanentCache:">
If this feature is supported, a Cache generating IPFIX Flow Records can be configured using the PermanentCache class.
</t>
</list>
</t>
<t>
The following features concern the support of UDP and TCP as transport protocols and the support of File Readers and File Writers:
</t>
<t>
<list style="hanging">
<t hangText="udpTransport:">
If this feature is supported, UDP can be used as transport protocol by Exporting Processes and Collecting Processes.
</t>
<vspace blankLines="1" />
<t hangText="tcpTransport:">
If this feature is supported, TCP can be used as transport protocol by Exporting Processes and Collecting Processes.
</t>
<vspace blankLines="1" />
<t hangText="fileReader:">
If this feature is supported, File Readers can be configured as part of Collecting Processes.
</t>
<vspace blankLines="1" />
<t hangText="fileWriter:">
If this feature is supported, File Writers can be configured as part of Exporting Processes.
</t>
</list>
</t>
<t>
The deviation concept enables a device to announce deviations from the standard model using the "deviation" statement.
For example, it is possible to restrict the value range of a specific parameter or to define that the configuration of a certain parameter is not supported at all.
Hence, deviations are typically used to specify limitations due to resource constraints or functional restrictions.
Deviations concern existing parameters of the original configuration data model and must not be confused with model extensions.
Model extensions are specified with the "augment" statement and allow adding new parameters to the original configuration data model.
</t>
<t>
If certain device-specific constraints cannot be formally specified with YANG, they MUST be expressed with human-readable text using the "description" statement.
The provided information MUST enable the user to define a configuration which is entirely supported by the Monitoring Device.
On the other hand, if a Monitoring Device is configured, it MUST notify the user about any part of the configuration which is not supported.
The Monitoring Device MUST NOT silently accept configuration data which cannot be completely enforced.
If the NETCONF protocol is used to send configuration data to the Monitoring Device, the error handling is specified in the NETCONF protocol specification <xref target="RFC6241"/>.
</t>
<t>
Just like features, deviations and model extensions are announced in NETCONF's <hello> message.
A usage example of deviations is given in <xref target="sec:deviation"/>.
</t>
</section>
<section anchor="sec:yang" title="YANG Module of the IPFIX/PSAMP Configuration Data Model">
<t>
The YANG module specification of the configuration data model is listed below.
It makes use of the common YANG types defined in the modules urn:ietf:params:xml:ns:yang:ietf-yang-types and urn:ietf:params:xml:ns:yang:ietf-inet-types <xref target="RFC6021"/>.
</t>
<artwork>
<![CDATA[<CODE BEGINS> file "ietf-ipfix-psamp@2012-06-12.yang"
module ietf-ipfix-psamp {
namespace "urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp";
prefix ipfix;
import ietf-yang-types { prefix yang; }
import ietf-inet-types { prefix inet; }
organization
"IETF IPFIX Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/ipfix/>
WG List: <mailto:ipfix@ietf.org>
WG Chair: Nevil Brownlee
<n.brownlee@auckland.ac.nz>
WG Chair: Juergen Quittek
<quittek@neclab.eu>
Editor: Gerhard Muenz
<mailto:muenz@net.in.tum.de>";
description
"IPFIX/PSAMP Configuration Data Model
Copyright (c) 2010 IETF Trust and the persons identified as
the document authors. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).";
revision 2012-06-12 {
description "Version of
draft-ietf-ipfix-configuration-model-11";
reference "RFCxxxx: IPFIX/PSAMP Configuration Data Model";
}
/*****************************************************************
* Features
*****************************************************************/
feature exporter {
description "If supported, the Monitoring Device can be used as
an Exporter. Exporting Processes can be configured.";
}
feature collector {
description "If supported, the Monitoring Device can be used as
a Collector. Collecting Processes can be configured.";
}
feature meter {
description "If supported, Observation Points, Selection
Processes, and Caches can be configured.";
}
feature psampSampCountBased {
description "If supported, the Monitoring Device supports
count-based Sampling. The Selector method sampCountBased can
be configured.";
}
feature psampSampTimeBased {
description "If supported, the Monitoring Device supports
time-based Sampling. The Selector method sampTimeBased can
be configured.";
}
feature psampSampRandOutOfN {
description "If supported, the Monitoring Device supports
random n-out-of-N Sampling. The Selector method
sampRandOutOfN can be configured.";
}
feature psampSampUniProb {
description "If supported, the Monitoring Device supports
uniform probabilistic Sampling. The Selector method
sampUniProb can be configured.";
}
feature psampFilterMatch {
description "If supported, the Monitoring Device supports
property match Filtering. The Selector method filterMatch
can be configured.";
}
feature psampFilterHash {
description "If supported, the Monitoring Device supports
hash-based Filtering. The Selector method filterHash can be
configured.";
}
feature immediateCache {
description "If supported, the Monitoring Device supports
Caches generating PSAMP Packet Reports by configuration with
immediateCache.";
}
feature timeoutCache {
description "If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
timeoutCache.";
}
feature naturalCache {
description "If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
naturalCache.";
}
feature permanentCache {
description "If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
permanentCache.";
}
feature udpTransport {
description "If supported, the Monitoring Device supports UDP
as transport protocol.";
}
feature tcpTransport {
description "If supported, the Monitoring Device supports TCP
as transport protocol.";
}
feature fileReader {
description "If supported, the Monitoring Device supports the
configuration of Collecting Processes as File Readers.";
}
feature fileWriter {
description "If supported, the Monitoring Device supports the
configuration of Exporting Processes as File Writers.";
}
/*****************************************************************
* Identities
*****************************************************************/
/*** Hash function identities ***/
identity hashFunction {
description "Base identity for all hash functions used for
hash-based packet filtering. Identities derived from
this base are used by the leaf
/ipfix/selectionProcess/selector/filterHash/hashFunction.";
}
identity BOB {
base "hashFunction";
description "BOB hash function";
reference "RFC5475, Section 6.2.4.1.";
}
identity IPSX {
base "hashFunction";
description "IPSX hash function";
reference "RFC5475, Section 6.2.4.1.";
}
identity CRC {
base "hashFunction";
description "CRC hash function";
reference "RFC5475, Section 6.2.4.1.";
}
/*** Export mode identities ***/
identity exportMode {
description "Base identity for different usages of export
destinations configured for an Exporting Process.
Identities derived from this base are used by the leaf
/ipfix/exportingProcess/exportMode.";
}
identity parallel {
base "exportMode";
description "Parallel export of Data Records to all
destinations configured for the Exporting Process.";
}
identity loadBalancing {
base "exportMode";
description "Load-balancing between the different destinations
configured for the Exporting Process.";
}
identity fallback {
base "exportMode";
description "Export to the primary destination (i.e., the first
SCTP, UDP, TCP, or file destination configured for the
Exporting Process). If the export to the primary destination
fails, the Exporting Process tries to export to the secondary
destination. If the secondary destination fails as well, it
continues with the tertiary, etc.";
}
/*** Options type identities ***/
identity optionsType {
description "Base identity for report types exported with
options. Identities derived from this base are used by the leaf
/ipfix/exportingProcess/options/optionsType.";
}
identity meteringStatistics {
base "optionsType";
description "Metering Process Statistics.";
reference "RFC 5101, Section 4.1.";
}
identity meteringReliability {
base "optionsType";
description "Metering Process Reliability Statistics.";
reference "RFC 5101, Section 4.2.";
}
identity exportingReliability {
base "optionsType";
description "Exporting Process Reliability
Statistics.";
reference "RFC 5101, Section 4.3.";
}
identity flowKeys {
base "optionsType";
description "Flow Keys.";
reference "RFC 5101, Section 4.4.";
}
identity selectionSequence {
base "optionsType";
description "Selection Sequence and Selector Reports.";
reference "RFC5476, Sections 6.5.1 and 6.5.2.";
}
identity selectionStatistics {
base "optionsType";
description "Selection Sequence Statistics Report.";
reference "RFC5476, Sections 6.5.3.";
}
identity accuracy {
base "optionsType";
description "Accuracy Report.";
reference "RFC5476, Section 6.5.4.";
}
identity reducingRedundancy {
base "optionsType";
description "Enables the utilization of Options Templates to
reduce redundancy in the exported Data Records.";
reference "RFC5473.";
}
identity extendedTypeInformation {
base "optionsType";
description "Export of extended type information for
enterprise-specific Information Elements used in the
exported Templates.";
reference "RFC5610.";
}
/*****************************************************************
* Type definitions
*****************************************************************/
typedef ieNameType {
type string {
length "1..max";
pattern "\S+";
}
description "Type for Information Element names. Whitespaces
are not allowed.";
}
typedef ieIdType {
type uint16 {
range "1..32767" {
description "Valid range of Information Element
identifiers.";
reference "RFC5102, Section 4.";
}
}
description "Type for Information Element identifiers.";
}
typedef nameType {
type string {
length "1..max";
pattern "\S(.*\S)?";
}
description "Type for 'name' leafs which are used to identify
specific instances within lists etc.
Leading and trailing whitespaces are not allowed.";
}
typedef ifNameType {
type string {
length "1..255";
}
description "This corresponds to the DisplayString textual
convention of SNMPv2-TC, which is used for ifName in the IF
MIB module.";
reference "RFC2863 (ifName).";
}
typedef direction {
type enumeration {
enum ingress {
description "This value is used for monitoring incoming
packets.";
}
enum egress {
description "This value is used for monitoring outgoing
packets.";
}
enum both {
description "This value is used for monitoring incoming and
outgoing packets.";
}
}
description "Direction of packets going through an interface or
linecard.";
}
typedef transportSessionStatus {
type enumeration {
enum inactive {
description "This value MUST be used for Transport Sessions
that are specified in the system but currently not active.
The value can be used for Transport Sessions that are
backup (secondary) sessions.";
}
enum active {
description "This value MUST be used for Transport Sessions
that are currently active and transmitting or receiving
data.";
}
enum unknown {
description "This value MUST be used if the status of the
Transport Sessions cannot be detected by the device. This
value should be avoided as far as possible.";
}
}
description "Status of a Transport Session.";
reference "RFC6615, Section 8 (ipfixTransportSessionStatus).";
}
/*****************************************************************
* Groupings
*****************************************************************/
grouping observationPointParameters {
description "Interface as input to Observation Point.";
leaf observationPointId {
type uint32;
config false;
description "Observation Point ID (i.e., the value of the
Information Element observationPointId) assigned by the
Monitoring Device.";
reference "RFC5102, Section 5.1.10.";
}
leaf observationDomainId {
type uint32;
mandatory true;
description "The Observation Domain ID associates the
Observation Point to an Observation Domain. Observation
Points with identical Observation Domain ID belong to the
same Observation Domain.
Note that this parameter corresponds to
ipfixObservationPointObservationDomainId in the IPFIX MIB
module.";
reference "RFC5101; RFC6615, Section 8
(ipfixObservationPointObservationDomainId).";
}
leaf-list ifName {
type ifNameType;
description "List of names identifying interfaces of the
Monitoring Device. The Observation Point observes packets at
the specified interfaces.";
}
leaf-list ifIndex {
type uint32;
description "List of ifIndex values pointing to entries in the
ifTable of the IF-MIB module maintained by the Monitoring
Device. The Observation Point observes packets at the
specified interfaces.
This parameter SHOULD only be used if an SNMP agent enables
access to the ifTable.
Note that this parameter corresponds to
ipfixObservationPointPhysicalInterface in the IPFIX MIB
module.";
reference "RFC 1229; RFC6615, Section 8
(ipfixObservationPointPhysicalInterface).";
}
leaf-list entPhysicalName {
type string;
description "List of names identifying physical entities of the
Monitoring Device. The Observation Point observes packets at
the specified entities.";
}
leaf-list entPhysicalIndex {
type uint32;
description "List of entPhysicalIndex values pointing to
entries in the entPhysicalTable of the ENTITY-MIB module
maintained by the Monitoring Device. The Observation Point
observes packets at the specified entities.
This parameter SHOULD only be used if an SNMP agent enables
access to the entPhysicalTable.
Note that this parameter corresponds to
ipfixObservationPointPhysicalEntity in the IPFIX MIB
module.";
reference "RFC 4133; RFC6615, Section 8
(ipfixObservationPointPhysicalInterface).";
}
leaf direction {
type direction;
default both;
description "Direction of packets. If not applicable (e.g., in
the case of a sniffing interface in promiscuous mode), this
parameter is ignored.";
}
}
grouping sampCountBasedParameters {
description "Configuration parameters of a Selector applying
systematic count-based packet sampling to the packet
stream.";
reference "RFC5475, Section 5.1; RFC5476, Section 6.5.2.1.";
leaf packetInterval {
type uint32;
units packets;
mandatory true;
description "The number of packets that are consecutively
sampled between gaps of length packetSpace.
This parameter corresponds to the Information Element
samplingPacketInterval and to psampSampCountBasedInterval
in the PSAMP MIB module.";
reference "RFC5477, Section 8.2.2; RFCyyyy, Section 6
(psampSampCountBasedInterval).";
}
leaf packetSpace {
type uint32;
units packets;
mandatory true;
description "The number of unsampled packets between two
sampling intervals.
This parameter corresponds to the Information Element
samplingPacketSpace and to psampSampCountBasedSpace
in the PSAMP MIB module.";
reference "RFC5477, Section 8.2.3; RFCyyyy, Section 6
(psampSampCountBasedSpace).";
}
}
grouping sampTimeBasedParameters {
description "Configuration parameters of a Selector applying
systematic time-based packet sampling to the packet
stream.";
reference "RFC5475, Section 5.1; RFC5476, Section 6.5.2.2.";
leaf timeInterval {
type uint32;
units microseconds;
mandatory true;
description "The time interval in microseconds during
which all arriving packets are sampled between gaps
of length timeSpace.
This parameter corresponds to the Information Element
samplingTimeInterval and to psampSampTimeBasedInterval
in the PSAMP MIB module.";
reference "RFC5477, Section 8.2.4; RFCyyyy, Section 6
(psampSampTimeBasedInterval).";
}
leaf timeSpace {
type uint32;
units microseconds;
mandatory true;
description "The time interval in microseconds during
which no packets are sampled between two sampling
intervals specified by timeInterval.
This parameter corresponds to the Information Element
samplingTimeInterval and to psampSampTimeBasedSpace
in the PSAMP MIB module.";
reference "RFC5477, Section 8.2.5; RFCyyyy, Section 6
(psampSampTimeBasedSpace).";
}
}
grouping sampRandOutOfNParameters {
description "Configuration parameters of a Selector applying
n-out-of-N packet sampling to the packet stream.";
reference "RFC5475, Section 5.2.1; RFC5476, Section 6.5.2.3.";
leaf size {
type uint32;
units packets;
mandatory true;
description "The number of elements taken from the parent
population.
This parameter corresponds to the Information Element
samplingSize and to psampSampRandOutOfNSize in the PSAMP
MIB module.";
reference "RFC5477, Section 8.2.6; RFCyyyy, Section 6
(psampSampRandOutOfNSize).";
}
leaf population {
type uint32;
units packets;
mandatory true;
description "The number of elements in the parent
population.
This parameter corresponds to the Information Element
samplingPopulation and to psampSampRandOutOfNPopulation
in the PSAMP MIB module.";
reference "RFC5477, Section 8.2.7; RFCyyyy, Section 6
(psampSampRandOutOfNPopulation).";
}
}
grouping sampUniProbParameters {
description "Configuration parameters of a Selector applying
uniform probabilistic packet sampling (with equal
probability per packet) to the packet stream.";
reference "RFC5475, Section 5.2.2.1;
RFC5476, Section 6.5.2.4.";
leaf probability {
type decimal64 {
fraction-digits 18;
range "0..1";
}
mandatory true;
description "Probability that a packet is sampled,
expressed as a value between 0 and 1. The probability
is equal for every packet.
This parameter corresponds to the Information Element
samplingProbability and to psampSampUniProbProbability
in the PSAMP MIB module.";
reference "RFC5477, Section 8.2.8; RFCyyyy, Section 6
(psampSampUniProbProbability).";
}
}
grouping filterMatchParameters {
description "Configuration parameters of a Selector applying
property match filtering to the packet stream.
The field to be matched is specified as Information
Element.";
reference "RFC5475, Section 6.1; RFC5476, Section 6.5.2.5.";
choice nameOrId {
mandatory true;
description "The field to be matched is specified by
either the name or the ID of the Information
Element.";
leaf ieName {
type ieNameType;
description "Name of the Information Element.";
}
leaf ieId {
type ieIdType;
description "ID of the Information Element.";
}
}
leaf ieEnterpriseNumber {
type uint32;
default 0;
description "If this parameter is zero, the Information
Element is registered in the IANA registry of IPFIX
Information Elements.
If this parameter is configured with a non-zero private
enterprise number, the Information Element is
enterprise-specific.";
reference "RFC5102.";
}
leaf value {
type string;
mandatory true;
description "Matching value of the Information Element.";
}
}
grouping filterHashParameters {
description "Configuration parameters of a Selector applying
hash-based filtering to the packet stream.";
reference "RFC5475, Section 6.2; RFC5476, Section 6.5.2.6.";
leaf hashFunction {
type identityref {
base "hashFunction";
}
default BOB;
description "Hash function to be applied. According to
RFC5475, Section 6.2.4.1, 'BOB' must be used in order to
be compliant with PSAMP.
This parameter functionally corresponds to
psampFiltHashFunction in the PSAMP MIB module.";
reference "RFCyyyy, Section 6 (psampFiltHashFunction)";
}
leaf initializerValue {
type uint64;
description "Initializer value to the hash function.
If not configured by the user, the Monitoring Device
arbitrarily chooses an initializer value.
This parameter corresponds to the Information Element
hashInitialiserValue and to psampFiltHashInitializerValue
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.9; RFCyyyy, Section 6
(psampFiltHashInitializerValue).";
}
leaf ipPayloadOffset {
type uint64;
units octets;
default 0;
description "IP payload offset indicating the position of
the first payload byte considered as input to the hash
function.
Default value 0 corresponds to the minimum offset that
must be configurable according to RFC5476, Section
6.2.5.6.
This parameter corresponds to the Information Element
hashIPPayloadOffset and to psampFiltHashIpPayloadOffset
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.2; RFCyyyy, Section 6
(psampFiltHashIpPayloadOffset).";
}
leaf ipPayloadSize {
type uint64;
units octets;
default 8;
description "Number of IP payload bytes used as input to
the hash function, counted from the payload offset.
If the IP payload is shorter than the payload range,
all available payload octets are used as input.
Default value 8 corresponds to the minimum IP payload
size that must be configurable according to RFC5476,
Section 6.2.5.6.
This parameter corresponds to the Information Element
hashIPPayloadSize and to psampFiltHashIpPayloadSize
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.3; RFCyyyy, Section 6
(psampFiltHashIpPayloadSize).";
}
leaf digestOutput {
type boolean;
default false;
description "If true, the output from this Selector is
included in the Packet Report as a packet digest.
Therefore, the configured Cache Layout needs to contain
a digestHashValue field.
This parameter corresponds to the Information Element
hashDigestOutput.";
reference "RFC5477, Section 8.3.8.";
}
leaf outputRangeMin {
type uint64;
config false;
description "Beginning of the hash function's potential
range.
This parameter corresponds to the Information Element
hashOutputRangeMin and to psampFiltHashOutputRangeMin
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.4; RFCyyyy, Section 6
(psampFiltHashOutputRangeMin).";
}
leaf outputRangeMax {
type uint64;
config false;
description "End of the hash function's potential range.
This parameter corresponds to the Information Element
hashOutputRangeMax and to psampFiltHashOutputRangeMax
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.5; RFCyyyy, Section 6
(psampFiltHashOutputRangeMax).";
}
list selectedRange {
key name;
min-elements 1;
description "List of hash function return ranges for
which packets are selected.";
leaf name {
type nameType;
description "Key of this list.";
}
leaf min {
type uint64;
description "Beginning of the hash function's selected
range.
This parameter corresponds to the Information Element
hashSelectedRangeMin and to psampFiltHashSelectedRangeMin
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.6; RFCyyyy, Section 6
(psampFiltHashSelectedRangeMin).";
}
leaf max {
type uint64;
description "End of the hash function's selected range.
This parameter corresponds to the Information Element
hashSelectedRangeMax and to psampFiltHashSelectedRangeMax
in the PSAMP MIB module.";
reference "RFC5477, Section 8.3.7; RFCyyyy, Section 6
(psampFiltHashSelectedRangeMax).";
}
}
}
grouping selectorParameters {
description "Configuration and state parameters of a Selector.";
choice Method {
mandatory true;
description "Packet selection method applied by the Selector.";
leaf selectAll {
type empty;
description "Method which selects all packets.";
}
container sampCountBased {
if-feature psampSampCountBased;
description "Systematic count-based packet sampling.";
uses sampCountBasedParameters;
}
container sampTimeBased {
if-feature psampSampTimeBased;
description "Systematic time-based packet sampling.";
uses sampTimeBasedParameters;
}
container sampRandOutOfN {
if-feature psampSampRandOutOfN;
description "n-out-of-N packet sampling.";
uses sampRandOutOfNParameters;
}
container sampUniProb {
if-feature psampSampUniProb;
description "Uniform probabilistic packet sampling.";
uses sampUniProbParameters;
}
container filterMatch {
if-feature psampFilterMatch;
description "Property match filtering.";
uses filterMatchParameters;
}
container filterHash {
if-feature psampFilterHash;
description "Hash-based filtering.";
uses filterHashParameters;
}
}
leaf packetsObserved {
type yang:counter64;
config false;
description "The number of packets observed at the input of
the Selector.
If this is the first Selector in the Selection Process,
this counter corresponds to the total number of packets in
all Observed Packet Streams at the input of the Selection
Process. Otherwise, the counter corresponds to the total
number of packets at the output of the preceding Selector.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
selectorDiscontinuityTime.
Note that this parameter corresponds to
ipfixSelectorStatsPacketsObserved in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixSelectorStatsPacketsObserved).";
}
leaf packetsDropped {
type yang:counter64;
config false;
description "The total number of packets discarded by the
Selector.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
selectorDiscontinuityTime.
Note that this parameter corresponds to
ipfixSelectorStatsPacketsDropped in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixSelectorStatsPacketsDropped).";
}
leaf selectorDiscontinuityTime {
type yang:date-and-time;
config false;
description "Timestamp of the most recent occasion at which
one or more of the Selector counters suffered a
discontinuity.
Note that this parameter functionally corresponds to
ipfixSelectionProcessStatsDiscontinuityTime in the IPFIX
MIB module. In contrast to
ipfixSelectionProcessStatsDiscontinuityTime, the time is
absolute and not relative to sysUpTime.";
reference "RFC6615, Section 8
(ipfixSelectionProcessStatsDiscontinuityTime).";
}
}
grouping cacheLayoutParameters {
description "Cache Layout parameters used by immediateCache,
timeoutCache, naturalCache, and permanentCache.";
container cacheLayout {
description "Cache Layout parameters.";
list cacheField {
key name;
min-elements 1;
description "Superset of fields that are included in the
Packet Reports or Flow Records generated by the Cache.";
leaf name {
type nameType;
description "Key of this list.";
}
choice nameOrId {
mandatory true;
description "Name or ID of the Information Element.";
reference "RFC5102.";
leaf ieName {
type ieNameType;
description "Name of the Information Element.";
}
leaf ieId {
type ieIdType;
description "ID of the Information Element.";
}
}
leaf ieLength {
type uint16;
units octets;
description "Length of the field in which the Information
Element is encoded. A value of 65535 specifies a
variable-length Information Element. For Information
Elements of integer and float type, the field length MAY
be set to a smaller value than the standard length of
the abstract data type if the rules of reduced size
encoding are fulfilled.
If not configured by the user, this parameter is set by
the Monitoring Device.";
reference "RFC5101, Section 6.2; RFC5102.";
}
leaf ieEnterpriseNumber {
type uint32;
default 0;
description "If this parameter is zero, the Information
Element is registered in the IANA registry of IPFIX
Information Elements.
If this parameter is configured with a non-zero private
enterprise number, the Information Element is
enterprise-specific.
If the enterprise number is set to 29305, this field
contains a Reverse Information Element. In this case,
the Cache MUST generate Data Records in accordance to
RFC5103.";
reference "RFC5101; RFC5102; RFC5103.";
}
leaf isFlowKey {
when "(name(../../..) != 'immediateCache')
and
((count(../ieEnterpriseNumber) = 0)
or
(../ieEnterpriseNumber != 29305))" {
description "This parameter is not available for
Reverse Information Elements (which have enterprise
number 29305). It is also not available for
immediateCache.";
}
type empty;
description "If present, this is a flow key.";
}
}
}
}
grouping flowCacheParameters {
description "Configuration and state parameters of a Cache
generating Flow Records.";
leaf maxFlows {
type uint32;
units flows;
description "This parameter configures the maximum number of
Flows in the Cache, which is the maximum number of Flows
that can be measured simultaneously.
The Monitoring Device MUST ensure that sufficient resources
are available to store the configured maximum number of
Flows.
If the maximum number of Flows is measured, no additional
Flows can be measured before any of the existing entries is
removed. However, traffic which pertains to existing Flows
can continue to be measured.";
}
leaf activeTimeout {
when "(name(..) = 'timeoutCache') or
(name(..) = 'naturalCache')" {
description "This parameter is only available for
timeoutCache and naturalCache.";
}
type uint32;
units seconds;
description "This parameter configures the time in
seconds after which a Flow is expired even though packets
matching this Flow are still received by the Cache.
The parameter value zero indicates infinity, meaning that
there is no active timeout.
If not configured by the user, the Monitoring Device sets
this parameter.
Note that this parameter corresponds to
ipfixMeteringProcessCacheActiveTimeout in the IPFIX
MIB module.";
reference "RFC6615, Section 8
(ipfixMeteringProcessCacheActiveTimeout).";
}
leaf idleTimeout {
when "(name(..) = 'timeoutCache') or
(name(..) = 'naturalCache')" {
description "This parameter is only available for
timeoutCache and naturalCache.";
}
type uint32;
units seconds;
description "This parameter configures the time in
seconds after which a Flow is expired if no more packets
matching this Flow are received by the Cache.
The parameter value zero indicates infinity, meaning that
there is no idle timeout.
If not configured by the user, the Monitoring Device sets
this parameter.
Note that this parameter corresponds to
ipfixMeteringProcessCacheIdleTimeout in the IPFIX
MIB module.";
reference "RFC6615, Section 8
(ipfixMeteringProcessCacheIdleTimeout).";
}
leaf exportInterval {
when "name(..) = 'permanentCache'" {
description "This parameter is only available for
permanentCache.";
}
type uint32;
units seconds;
description "This parameter configures the interval (in
seconds) for periodical export of Flow Records.
If not configured by the user, the Monitoring Device sets
this parameter.";
}
leaf activeFlows {
type yang:gauge32;
units flows;
config false;
description "The number of Flows currently active in this
Cache.
Note that this parameter corresponds to
ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixMeteringProcessCacheActiveFlows).";
}
leaf unusedCacheEntries {
type yang:gauge32;
units flows;
config false;
description "The number of unused Cache entries in this
Cache.
Note that this parameter corresponds to
ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX
MIB module.";
reference "RFC6615, Section 8
(ipfixMeteringProcessCacheUnusedCacheEntries).";
}
}
grouping exportingProcessParameters {
description "Parameters of an Exporting Process.";
leaf exportingProcessId {
type uint32;
config false;
description "The identifier of the Exporting Process.
This parameter corresponds to the Information Element
exporintProcessId. Its occurrence helps to associate
Exporting Process parameters with Exporing Process
statistics exported by the Monitoring Device using the
Exporting Process Reliability Statistics Template as
defined by the IPFIX Protocol Specification.";
reference "RFC5101, Section 4.3; RFC5102, Section 5.1.6.";
}
leaf exportMode {
type identityref {
base "exportMode";
}
default parallel;
description "This parameter determines to which configured
destination(s) the incoming Data Records are exported.";
}
list destination {
key name;
min-elements 1;
description "List of export destinations.";
leaf name {
type nameType;
description "Key of this list.";
}
choice DestinationParameters {
mandatory true;
description "Configuration parameters depend on whether
SCTP, UDP, or TCP are used as transport protocol, and
whether the destination is a file.";
container sctpExporter {
description "SCTP parameters.";
uses sctpExporterParameters;
}
container udpExporter {
if-feature udpTransport;
description "UDP parameters.";
uses udpExporterParameters;
}
container tcpExporter {
if-feature tcpTransport;
description "TCP parameters.";
uses tcpExporterParameters;
}
container fileWriter {
if-feature fileWriter;
description "File Writer parameters.";
uses fileWriterParameters;
}
}
}
list options {
key name;
description "List of options reported by the Exporting
Process.";
leaf name {
type nameType;
description "Key of this list.";
}
uses optionsParameters;
}
}
grouping commonExporterParameters {
description "Parameters of en export destination which are
common to all transport protocols.";
leaf ipfixVersion {
type uint16;
default 10;
description "IPFIX version number.";
reference "RFC 5101.";
}
leaf destinationPort {
type inet:port-number;
description "If not configured by the user, the Monitoring
Device uses the default port number for IPFIX, which is
4739 without transport layer security and 4740 if transport
layer security is activated.";
}
choice indexOrName {
description "Index or name of the interface as stored in the
ifTable of IF-MIB.
If configured, the Exporting Process MUST use the given
interface to export IPFIX Messages to the export
destination.
If omitted, the Exporting Process selects the outgoing
interface based on local routing decision and accepts
return traffic, such as transport layer acknowledgments,
on all available interfaces.";
reference "RFC 1229.";
leaf ifIndex {
type uint32;
description "Index of an interface as stored in the ifTable
of IF-MIB.";
reference "RFC 1229.";
}
leaf ifName {
type string;
description "Name of an interface as stored in the ifTable
of IF-MIB.";
reference "RFC 1229.";
}
}
leaf sendBufferSize {
type uint32;
units bytes;
description "Size of the socket send buffer.
If not configured by the user, this parameter is set by
the Monitoring Device.";
}
leaf rateLimit {
type uint32;
units "bytes per second";
description "Maximum number of bytes per second the Exporting
Process may export to the given destination. The number of
bytes is calculated from the lengths of the IPFIX Messages
exported. If not configured, no rate limiting is performed.";
reference "RFC5476, Section 6.3.";
}
container transportLayerSecurity {
presence "If transportLayerSecurity is present, DTLS is
enabled if the transport protocol is SCTP or UDP, and TLS
is enabled if the transport protocol is TCP.";
description "Transport layer security configuration.";
uses transportLayerSecurityParameters;
}
container transportSession {
config false;
description "State parameters of the Transport Session
directed to the given destination.";
uses transportSessionParameters;
}
}
grouping sctpExporterParameters {
description "SCTP specific export destination parameters.";
uses commonExporterParameters;
leaf-list sourceIPAddress {
type inet:ip-address;
description "List of source IP addresses used by the
Exporting Process.
If configured, the specified addresses are eligible local
IP addresses of the multi-homed SCTP endpoint.
If not configured, all locally assigned IP addresses are
eligible local IP addresses.";
reference "RFC 4960, Section 6.4.";
}
leaf-list destinationIPAddress {
type inet:ip-address;
min-elements 1;
description "One or multiple IP addresses of the Collecting
Process to which IPFIX Messages are sent.
The user MUST ensure that all configured IP addresses
belong to the same Collecting Process.
The Exporting Process tries to establish an SCTP
association to any of the configured destination IP
addresses.";
reference "RFC 4960, Section 6.4.";
}
leaf timedReliability {
type uint32;
units milliseconds;
default 0;
description "Lifetime in milliseconds until an IPFIX
Message containing Data Sets only is 'abandoned' due to
the timed reliability mechanism of PR-SCTP.
If this parameter is set to zero, reliable SCTP
transport is used for all Data Records.
Regardless of the value of this parameter, the Exporting
Process MAY use reliable SCTP transport for Data Sets
associated with Options Templates.";
reference "RFC 3758; RFC 4960.";
}
}
grouping udpExporterParameters {
description "Parameters of a UDP export destination.";
uses commonExporterParameters;
leaf sourceIPAddress {
type inet:ip-address;
description "Source IP address used by the Exporting Process.
If not configured, the IP address assigned to the outgoing
interface is used as source IP address.";
}
leaf destinationIPAddress {
type inet:ip-address;
mandatory true;
description "IP address of the Collection Process to which
IPFIX Messages are sent.";
}
leaf maxPacketSize {
type uint16;
units octets;
description "This parameter specifies the maximum size of
IP packets sent to the Collector. If set to zero, the
Exporting Device MUST derive the maximum packet size
from path MTU discovery mechanisms.
If not configured by the user, this parameter is set by
the Monitoring Device.";
}
leaf templateRefreshTimeout {
type uint32;
units seconds;
default 600;
description "Sets time after which Templates are resent in the
UDP Transport Session.
Note that the configured lifetime MUST be adapted to the
templateLifeTime parameter value at the receiving Collecting
Process.
Note that this parameter corresponds to
ipfixTransportSessionTemplateRefreshTimeout in the IPFIX
MIB module.";
reference "RFC5101, Section 10.3.6; RFC6615, Section 8
(ipfixTransportSessionTemplateRefreshTimeout).";
}
leaf optionsTemplateRefreshTimeout {
type uint32;
units seconds;
default 600;
description "Sets time after which Options Templates are
resent in the UDP Transport Session.
Note that the configured lifetime MUST be adapted to the
optionsTemplateLifeTime parameter value at the receiving
Collecting Process.
Note that this parameter corresponds to
ipfixTransportSessionOptionsTemplateRefreshTimeout in the
IPFIX MIB module.";
reference "RFC5101, Section 10.3.6; RFC6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshTimeout).";
}
leaf templateRefreshPacket {
type uint32;
units "IPFIX Messages";
description "Sets number of IPFIX Messages after which
Templates are resent in the UDP Transport Session.
Note that this parameter corresponds to
ipfixTransportSessionTemplateRefreshPacket in the IPFIX
MIB module.
If omitted, Templates are only resent after timeout.";
reference "RFC5101, Section 10.3.6; RFC6615, Section 8
(ipfixTransportSessionTemplateRefreshPacket).";
}
leaf optionsTemplateRefreshPacket {
type uint32;
units "IPFIX Messages";
description "Sets number of IPFIX Messages after which
Options Templates are resent in the UDP Transport Session
protocol.
Note that this parameter corresponds to
ipfixTransportSessionOptionsTemplateRefreshPacket in the
IPFIX MIB module.
If omitted, Templates are only resent after timeout.";
reference "RFC5101, Section 10.3.6; RFC6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshPacket).";
}
}
grouping tcpExporterParameters {
description "Parameters of a TCP export destination.";
uses commonExporterParameters;
leaf sourceIPAddress {
type inet:ip-address;
description "Source IP address used by the Exporting Process.
If not configured by the user, this parameter is set by
the Monitoring Device to an IP address assigned to the
outgoing interface.";
}
leaf destinationIPAddress {
type inet:ip-address;
mandatory true;
description "IP address of the Collection Process to which
IPFIX Messages are sent.";
}
}
grouping fileWriterParameters {
description "File Writer parameters.";
leaf ipfixVersion {
type uint16;
default 10;
description "IPFIX version number.";
reference "RFC 5101.";
}
leaf file {
type inet:uri;
mandatory true;
description "URI specifying the location of the file.";
}
leaf bytes {
type yang:counter64;
units octets;
config false;
description "The number of bytes written by the File Writer.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileWriterDiscontinuityTime.";
}
leaf messages {
type yang:counter64;
units "IPFIX Messages";
config false;
description "The number of IPFIX Messages written by the File
Writer.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileWriterDiscontinuityTime.";
}
leaf discardedMessages {
type yang:counter64;
units "IPFIX Messages";
config false;
description "The number of IPFIX Messages that could not be
written by the File Writer due to internal buffer
overflows, limited storage capacity etc.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileWriterDiscontinuityTime.";
}
leaf records {
type yang:counter64;
units "Data Records";
config false;
description "The number of Data Records written by the File
Writer.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileWriterDiscontinuityTime.";
}
leaf templates {
type yang:counter32;
units "Templates";
config false;
description "The number of Template Records (excluding
Options Template Records) written by the File Writer.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileWriterDiscontinuityTime.";
}
leaf optionsTemplates {
type yang:counter32;
units "Options Templates";
config false;
description "The number of Options Template Records written
by the File Writer.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileWriterDiscontinuityTime.";
}
leaf fileWriterDiscontinuityTime {
type yang:date-and-time;
config false;
description "Timestamp of the most recent occasion at which
one or more File Writer counters suffered a discontinuity.
In contrast to discontinuity times in the IPFIX MIB module,
the time is absolute and not relative to sysUpTime.";
}
list template {
config false;
description "This list contains the Templates and Options
Templates that have been written by the File Reader.
Withdrawn or invalidated (Options) Template MUST be removed
from this list.";
uses templateParameters;
}
}
grouping optionsParameters {
description "Parameters specifying the data export using an
Options Template.";
leaf optionsType {
type identityref {
base "optionsType";
}
mandatory true;
description "Type of the exported options data.";
}
leaf optionsTimeout {
type uint32;
units milliseconds;
description "Time interval for periodic export of the options
data. If set to zero, the export is triggered when the
options data has changed.
If not configured by the user, this parameter is set by the
Monitoring Device.";
}
}
grouping collectingProcessParameters {
description "Parameters of a Collecting Process.";
list sctpCollector {
key name;
description "List of SCTP receivers (sockets) on which the
Collecting Process receives IPFIX Messages.";
leaf name {
type nameType;
description "Key of this list.";
}
uses sctpCollectorParameters;
}
list udpCollector {
if-feature udpTransport;
key name;
description "List of UDP receivers (sockets) on which the
Collecting Process receives IPFIX Messages.";
leaf name {
type nameType;
description "Key of this list.";
}
uses udpCollectorParameters;
}
list tcpCollector {
if-feature tcpTransport;
key name;
description "List of TCP receivers (sockets) on which the
Collecting Process receives IPFIX Messages.";
leaf name {
type nameType;
description "Key of this list.";
}
uses tcpCollectorParameters;
}
list fileReader {
if-feature fileReader;
key name;
description "List of File Readers from which the Collecting
Process reads IPFIX Messages.";
leaf name {
type nameType;
description "Key of this list.";
}
uses fileReaderParameters;
}
}
grouping commonCollectorParameters {
description "Parameters of a Collecting Process which are
common to all transport protocols.";
leaf localPort {
type inet:port-number;
description "If not configured, the Monitoring Device uses the
default port number for IPFIX, which is 4739 without
transport layer security and 4740 if transport layer
security is activated.";
}
container transportLayerSecurity {
presence "If transportLayerSecurity is present, DTLS is enabled
if the transport protocol is SCTP or UDP, and TLS is enabled
if the transport protocol is TCP.";
description "Transport layer security configuration.";
uses transportLayerSecurityParameters;
}
list transportSession {
config false;
description "This list contains the currently established
Transport Sessions terminating at the given socket.";
uses transportSessionParameters;
}
}
grouping sctpCollectorParameters {
description "Parameters of a listening SCTP socket at a
Collecting Process.";
uses commonCollectorParameters;
leaf-list localIPAddress {
type inet:ip-address;
description "List of local IP addresses on which the
Collecting Process listens for IPFIX Messages. The IP
addresses are used as eligible local IP addresses of the
multi-homed SCTP endpoint.";
reference "RFC 4960, Section 6.4.";
}
}
grouping udpCollectorParameters {
description "Parameters of a listening UDP socket at a
Collecting Process.";
uses commonCollectorParameters;
leaf-list localIPAddress {
type inet:ip-address;
description "List of local IP addresses on which the Collecting
Process listens for IPFIX Messages.";
}
leaf templateLifeTime {
type uint32;
units seconds;
default 1800;
description "Sets the lifetime of Templates for all UDP
Transport Sessions terminating at this UDP socket.
Templates which are not received again within the configured
lifetime become invalid at the Collecting Process.
As specified in RFC5101, the Template lifetime MUST be at
least three times higher than the templateRefreshTimeout
parameter value configured on the corresponding Exporting
Processes.
Note that this parameter corresponds to
ipfixTransportSessionTemplateRefreshTimeout in the IPFIX
MIB module.";
reference "RFC5101, Section 10.3.7; RFC6615, Section 8
(ipfixTransportSessionTemplateRefreshTimeout).";
}
leaf optionsTemplateLifeTime {
type uint32;
units seconds;
default 1800;
description "Sets the lifetime of Options Templates for all
UDP Transport Sessions terminating at this UDP socket.
Options Templates which are not received again within the
configured lifetime become invalid at the Collecting
Process.
As specified in RFC5101, the Options Template lifetime MUST
be at least three times higher than the
optionsTemplateRefreshTimeout parameter value configured on
the corresponding Exporting Processes.
Note that this parameter corresponds to
ipfixTransportSessionOptionsTemplateRefreshTimeout in the
IPFIX MIB module.";
reference "RFC5101, Section 10.3.7; RFC6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshTimeout).";
}
leaf templateLifePacket {
type uint32;
units "IPFIX Messages";
description "If this parameter is configured, Templates
defined in a UDP Transport Session become invalid if they
are neither included in a sequence of more than this number
of IPFIX Messages nor received again within the period of
time specified by templateLifeTime.
Note that this parameter corresponds to
ipfixTransportSessionTemplateRefreshPacket in the IPFIX
MIB module.";
reference "RFC5101, Section 10.3.7; RFC6615, Section 8
(ipfixTransportSessionTemplateRefreshPacket).";
}
leaf optionsTemplateLifePacket {
type uint32;
units "IPFIX Messages";
description "If this parameter is configured, Options
Templates defined in a UDP Transport Session become
invalid if they are neither included in a sequence of more
than this number of IPFIX Messages nor received again
within the period of time specified by
optionsTemplateLifeTime.
Note that this parameter corresponds to
ipfixTransportSessionOptionsTemplateRefreshPacket in the
IPFIX MIB module.";
reference "RFC5101, Section 10.3.7; RFC6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshPacket).";
}
}
grouping tcpCollectorParameters {
description "Parameters of a listening TCP socket at a
Collecting Process.";
uses commonCollectorParameters;
leaf-list localIPAddress {
type inet:ip-address;
description "List of local IP addresses on which the Collecting
Process listens for IPFIX Messages.";
}
}
grouping fileReaderParameters {
description "File Reader parameters.";
leaf file {
type inet:uri;
mandatory true;
description "URI specifying the location of the file.";
}
leaf bytes {
type yang:counter64;
units octets;
config false;
description "The number of bytes read by the File Reader.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileReaderDiscontinuityTime.";
}
leaf messages {
type yang:counter64;
units "IPFIX Messages";
config false;
description "The number of IPFIX Messages read by the File
Reader.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileReaderDiscontinuityTime.";
}
leaf records {
type yang:counter64;
units "Data Records";
config false;
description "The number of Data Records read by the File
Reader.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileReaderDiscontinuityTime.";
}
leaf templates {
type yang:counter32;
units "Templates";
config false;
description "The number of Template Records (excluding
Options Template Records) read by the File Reader.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileReaderDiscontinuityTime.";
}
leaf optionsTemplates {
type yang:counter32;
units "Options Templates";
config false;
description "The number of Options Template Records read by
the File Reader.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
fileReaderDiscontinuityTime.";
}
leaf fileReaderDiscontinuityTime {
type yang:date-and-time;
config false;
description "Timestamp of the most recent occasion at which
one or more File Reader counters suffered a discontinuity.
In contrast to discontinuity times in the IPFIX MIB module,
the time is absolute and not relative to sysUpTime.";
}
list template {
config false;
description "This list contains the Templates and Options
Templates that have been read by the File Reader.
Withdrawn or invalidated (Options) Template MUST be removed
from this list.";
uses templateParameters;
}
}
grouping transportLayerSecurityParameters {
description "Transport layer security parameters.";
leaf-list localCertificationAuthorityDN {
type string;
description "Distinguished names of certification authorities
whose certificates may be used to identify the local
endpoint.";
reference "RFC5280.";
}
leaf-list localSubjectDN {
type string;
description "Distinguished names which may be used in the
certificates to identify the local endpoint.";
reference "RFC5280.";
}
leaf-list localSubjectFQDN {
type inet:domain-name;
description "Fully qualified domain names which may be used to
in the certificates to identify the local endpoint.";
reference "RFC5280.";
}
leaf-list remoteCertificationAuthorityDN {
type string;
description "Distinguished names of certification authorities
whose certificates are accepted to authorize remote
endpoints.";
reference "RFC5280.";
}
leaf-list remoteSubjectDN {
type string;
description "Distinguished names which are accepted in
certificates to authorize remote endpoints.";
reference "RFC5280.";
}
leaf-list remoteSubjectFQDN {
type inet:domain-name;
description "Fully qualified domain name which are accepted in
certificates to authorize remote endpoints.";
reference "RFC5280.";
}
}
grouping templateParameters {
description "State parameters of a Template used by an Exporting
Process or received by a Collecting Process in a specific
Transport Session. Parameter names and semantics correspond to
the managed objects in IPFIX-MIB";
reference "RFC5101; RFC6615, Section 8 (ipfixTemplateEntry,
ipfixTemplateDefinitionEntry, ipfixTemplateStatsEntry)";
leaf observationDomainId {
type uint32;
description "The ID of the Observation Domain for which this
Template is defined.
Note that this parameter corresponds to
ipfixTemplateObservationDomainId in the IPFIX MIB module.";
reference "RFC6615, Section 8
(ipfixTemplateObservationDomainId).";
}
leaf templateId {
type uint16 {
range "256..65535" {
description "Valid range of Template IDs.";
reference "RFC5101";
}
}
description "This number indicates the Template Id in the IPFIX
message.
Note that this parameter corresponds to ipfixTemplateId in
the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTemplateId).";
}
leaf setId {
type uint16;
description "This number indicates the Set ID of the Template.
Currently, there are two values defined. The value 2 is used
for Sets containing Template definitions. The value 3 is
used for Sets containing Options Template definitions.
Note that this parameter corresponds to ipfixTemplateSetId
in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTemplateSetId).";
}
leaf accessTime {
type yang:date-and-time;
description "Used for Exporting Processes, this parameter
contains the time when this (Options) Template was last
sent to the Collector(s) or written to the file.
Used for Collecting Processes, this parameter contains the
time when this (Options) Template was last received from the
Exporter or read from the file.
Note that this parameter corresponds to
ipfixTemplateAccessTime in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTemplateAccessTime).";
}
leaf templateDataRecords {
type yang:counter64;
description "The number of transmitted or received Data
Records defined by this (Options) Template.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
templateDiscontinuityTime.
Note that this parameter corresponds to
ipfixTemplateDataRecords in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTemplateDataRecords).";
}
leaf templateDiscontinuityTime {
type yang:date-and-time;
description "Timestamp of the most recent occasion at which
the counter templateDataRecords suffered a discontinuity.
Note that this parameter functionally corresponds to
ipfixTemplateDiscontinuityTime in the IPFIX MIB module.
In contrast to ipfixTemplateDiscontinuityTime, the time
is absolute and not relative to sysUpTime.";
reference "RFC6615, Section 8
(ipfixTemplateDiscontinuityTime).";
}
list field {
description "This list contains the (Options) Template
fields of which the (Options) Template is defined.
The order of the list corresponds to the order of the fields
in the (Option) Template Record.";
leaf ieId {
type ieIdType;
description "This parameter indicates the Information
Element Id of the field.
Note that this parameter corresponds to
ipfixTemplateDefinitionIeId in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTemplateDefinitionIeId);
RFC5102.";
}
leaf ieLength {
type uint16;
units octets;
description "This parameter indicates the length of the
Information Element of the field.
Note that this parameter corresponds to
ipfixTemplateDefinitionIeLength in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTemplateDefinitionIeLength); RFC5102.";
}
leaf ieEnterpriseNumber {
type uint32;
description "This parameter indicates the IANA enterprise
number of the authority defining the Information Element
Id.
If the Information Element is not enterprise-specific,
this state parameter is zero.
Note that this parameter corresponds to
ipfixTemplateDefinitionIeEnterpriseNumber in the IPFIX
MIB module.";
reference "RFC6615, Section 8
(ipfixTemplateDefinitionIeEnterpriseNumber).";
}
leaf isFlowKey {
when "../../setId = 2" {
description "This parameter is available for non-Options
Templates (Set ID is 2).";
}
type empty;
description "If present, this is a Flow Key field.
Note that this corresponds to flowKey(1) being set in
ipfixTemplateDefinitionFlags.";
reference "RFC6615, Section 8
(ipfixTemplateDefinitionFlags).";
}
leaf isScope {
when "../../setId = 3" {
description "This parameter is available for Options
Templates (Set ID is 3).";
}
type empty;
description "If present, this is a scope field.
Note that this corresponds to scope(0) being set in
ipfixTemplateDefinitionFlags.";
reference "RFC6615, Section 8
(ipfixTemplateDefinitionFlags).";
}
}
}
grouping transportSessionParameters {
description "State parameters of a Transport Session originating
from an Exporting or terminating at a Collecting Process.
Parameter names and semantics correspond to the managed
objects in IPFIX-MIB.";
reference "RFC5101; RFC6615, Section 8
(ipfixTransportSessionEntry,
ipfixTransportSessionStatsEntry).";
leaf ipfixVersion {
type uint16;
description "Used for Exporting Processes, this parameter
contains the version number of the IPFIX protocol that the
Exporter uses to export its data in this Transport Session.
Hence, it is identical to the value of the configuration
parameter ipfixVersion of the outer SctpExporter,
UdpExporter, or TcpExporter node.
Used for Collecting Processes, this parameter contains the
version number of the IPFIX protocol it receives for
this Transport Session. If IPFIX Messages of different
IPFIX protocol versions are received, this parameter
contains the maximum version number.
Note that this parameter corresponds to
ipfixTransportSessionIpfixVersion in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionIpfixVersion).";
}
leaf sourceAddress {
type inet:ip-address;
description "The source address of the Exporter of the
IPFIX Transport Session.
If the transport protocol is SCTP, this is one of the
potentially many IP addresses of the Exporter.
Preferably, the source IP address of the path which is
usually selected by the Exporter to send IPFIX Messages to
the Collector SHOULD be used.
Note that this parameter functionally corresponds to
ipfixTransportSessionSourceAddressType and
ipfixTransportSessionSourceAddress in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionSourceAddressType,
ipfixTransportSessionSourceAddress);
RFC4960, Section 6.4.";
}
leaf destinationAddress {
type inet:ip-address;
description "The destination address of the Collector of
the IPFIX Transport Session.
If the transport protocol is SCTP, this is one of the
potentially many IP addresses of the Collector.
Preferably, the destination IP address of the path which is
usually selected by the Exporter to send IPFIX Messages to
the Collector SHOULD be used.
Note that this parameter functionally corresponds to
ipfixTransportSessionDestinationAddressType and
ipfixTransportSessionDestinationAddress in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionDestinationAddressType,
ipfixTransportSessionDestinationAddress);
RFC4960, Section 6.4.";
}
leaf sourcePort {
type inet:port-number;
description "The transport protocol port number of the
Exporter of the IPFIX Transport Session.
Note that this parameter corresponds to
ipfixTransportSessionSourcePort in the IPFIX MIB module.";
reference "RFC6615, Section 8
(ipfixTransportSessionSourcePort).";
}
leaf destinationPort {
type inet:port-number;
description "The transport protocol port number of the
Collector of the IPFIX Transport Session.
Note that this parameter corresponds to
ipfixTransportSessionDestinationPort in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionDestinationPort).";
}
leaf sctpAssocId {
type uint32;
description "The association id used for the SCTP session
between the Exporter and the Collector of the IPFIX
Transport Session. It is equal to the sctpAssocId entry
in the sctpAssocTable defined in the SCTP-MIB.
This parameter is only available if the transport protocol
is SCTP and if an SNMP agent on the same Monitoring Device
enables access to the corresponding MIB objects in the
sctpAssocTable.
Note that this parameter corresponds to
ipfixTransportSessionSctpAssocId in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionSctpAssocId);
RFC3871";
}
leaf status {
type transportSessionStatus;
description "Status of the Transport Session.
Note that this parameter corresponds to
ipfixTransportSessionStatus in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTransportSessionStatus).";
}
leaf rate {
type yang:gauge32;
units "bytes per second";
description "The number of bytes per second transmitted by the
Exporting Process or received by the Collecting Process.
This parameter is updated every second.
Note that this parameter corresponds to
ipfixTransportSessionRate in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTransportSessionRate).";
}
leaf bytes {
type yang:counter64;
units bytes;
description "The number of bytes transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionBytes in the IPFIX MIB module.";
reference "RFC6615, Section 8 (ipfixTransportSessionBytes).";
}
leaf messages {
type yang:counter64;
units "IPFIX Messages";
description "The number of messages transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionMessages in the IPFIX MIB module.";
reference "RFC6615, Section 8
(ipfixTransportSessionMessages).";
}
leaf discardedMessages {
type yang:counter64;
units "IPFIX Messages";
description "Used for Exporting Processes, this parameter
indicates the number of messages that could not be sent due
to internal buffer overflows, network congestion, routing
issues, etc. Used for Collecting Process, this parameter
indicates the number of received IPFIX Message that are
malformed, cannot be decoded, are received in the wrong
order or are missing according to the sequence number.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionDiscardedMessages in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionDiscardedMessages).";
}
leaf records {
type yang:counter64;
units "Data Records";
description "The number of Data Records transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionRecords in the IPFIX MIB module.";
reference "RFC6615, Section 8
(ipfixTransportSessionRecords).";
}
leaf templates {
type yang:counter32;
units "Templates";
description "The number of Templates transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionTemplates in the IPFIX MIB module.";
reference "RFC6615, Section 8
(ipfixTransportSessionTemplates).";
}
leaf optionsTemplates {
type yang:counter32;
units "Options Templates";
description "The number of Option Templates transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionOptionsTemplates in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixTransportSessionOptionsTemplates).";
}
leaf transportSessionStartTime {
type yang:date-and-time;
description "Timestamp of the start of the given Transport
Session.
This state parameter does not correspond to any object in
the IPFIX MIB module.";
}
leaf transportSessionDiscontinuityTime {
type yang:date-and-time;
description "Timestamp of the most recent occasion at which
one or more of the Transport Session counters suffered a
discontinuity.
Note that this parameter functionally corresponds to
ipfixTransportSessionDiscontinuityTime in the IPFIX MIB
module. In contrast to
ipfixTransportSessionDiscontinuityTime, the time is
absolute and not relative to sysUpTime.";
reference "RFC6615, Section 8
(ipfixTransportSessionDiscontinuityTime).";
}
list template {
description "This list contains the Templates and Options
Templates that are transmitted by the Exporting Process
or received by the Collecting Process.
Withdrawn or invalidated (Options) Template MUST be removed
from this list.";
uses templateParameters;
}
}
/*****************************************************************
* Main container
*****************************************************************/
container ipfix {
description "Top-level node of the IPFIX/PSAMP configuration
data model.";
list collectingProcess {
if-feature collector;
key name;
description "Collecting Process of the Monitoring Device.";
leaf name {
type nameType;
description "Key of this list.";
}
uses collectingProcessParameters;
leaf-list exportingProcess {
if-feature exporter;
type leafref { path "/ipfix/exportingProcess/name"; }
description "Export of received records without any
modifications. Records are processed by all Exporting
Processes in the list.";
}
}
list observationPoint {
if-feature meter;
key name;
description "Observation Point of the Monitoring Device.";
leaf name {
type nameType;
description "Key of this list.";
}
uses observationPointParameters;
leaf-list selectionProcess {
type leafref { path "/ipfix/selectionProcess/name"; }
description "Selection Processes in this list process
packets in parallel.";
}
}
list selectionProcess {
if-feature meter;
key name;
description "Selection Process of the Monitoring Device.";
leaf name {
type nameType;
description "Key of this list.";
}
list selector {
key name;
min-elements 1;
ordered-by user;
description "List of Selectors that define the action of the
Selection Process on a single packet. The Selectors are
serially invoked in the same order as they appear in this
list.";
leaf name {
type nameType;
description "Key of this list.";
}
uses selectorParameters;
}
list selectionSequence {
config false;
description "This list contains the Selection Sequence IDs
which are assigned by the Monitoring Device to distinguish
different Selection Sequences passing through the
Selection Process.
As Selection Sequence IDs are unique per Observation
Domain, the corresponding Observation Domain IDs are
included as well.
With this information, it is possible to associate
Selection Sequence (Statistics) Report Interpretations
exported according to the PSAMP protocol with a Selection
Process in the configuration data.";
reference "RFC5476.";
leaf observationDomainId {
type uint32;
description "Observation Domain ID for which the
Selection Sequence ID is assigned.";
}
leaf selectionSequenceId {
type uint64;
description "Selection Sequence ID used in the Selection
Sequence (Statistics) Report Interpretation.";
}
}
leaf cache {
type leafref { path "/ipfix/cache/name"; }
description "Cache which receives the output of the
Selection Process.";
}
}
list cache {
if-feature meter;
key name;
description "Cache of the Monitoring Device.";
leaf name {
type nameType;
description "Key of this list.";
}
leaf meteringProcessId {
type uint32;
config false;
description "The identifier of the Metering Process this
Cache belongs to.
This parameter corresponds to the Information Element
meteringProcessId. Its occurrence helps to associate
Cache parameters with Metering Process statistics
exported by the Monitoring Device using the Metering
Process (Reliability) Statistics Template as
defined by the IPFIX Protocol specification.";
reference "RFC5101, Sections 4.1 and 4.2;
RFC5102, Section 5.1.5.";
}
leaf dataRecords {
type yang:counter64;
units "Data Records";
config false;
description "The number of Data Records generated by this
Cache.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
cacheDiscontinuityTime.
Note that this parameter corresponds to
ipfixMeteringProcessDataRecords in the IPFIX MIB
module.";
reference "RFC6615, Section 8
(ipfixMeteringProcessDataRecords).";
}
leaf cacheDiscontinuityTime {
type yang:date-and-time;
config false;
description "Timestamp of the most recent occasion at which
the counter dataRecords suffered a discontinuity.
Note that this parameter functionally corresponds to
ipfixMeteringProcessDiscontinuityTime in the IPFIX MIB
module. In contrast to
ipfixMeteringProcessDiscontinuityTime, the time is
absolute and not relative to sysUpTime.";
reference "RFC6615, Section 8
(ipfixMeteringProcessDiscontinuityTime).";
}
choice CacheType {
mandatory true;
description "Type of Cache and specific parameters.";
container immediateCache {
if-feature immediateCache;
description "Flow expiration after the first packet;
generation of Packet Records.";
uses cacheLayoutParameters;
}
container timeoutCache {
if-feature timeoutCache;
description "Flow expiration after active and idle
timeout; generation of Flow Records.";
uses flowCacheParameters;
uses cacheLayoutParameters;
}
container naturalCache {
if-feature naturalCache;
description "Flow expiration after active and idle
timeout, or on natural termination (e.g. TCP FIN, or
TCP RST) of the Flow; generation of Flow Records.";
uses flowCacheParameters;
uses cacheLayoutParameters;
}
container permanentCache {
if-feature permanentCache;
description "No flow expiration, periodical export with
time interval exportInterval; generation of Flow
Records.";
uses flowCacheParameters;
uses cacheLayoutParameters;
}
}
leaf-list exportingProcess {
if-feature exporter;
type leafref { path "/ipfix/exportingProcess/name"; }
description "Records are exported by all Exporting Processes
in the list.";
}
}
list exportingProcess {
if-feature exporter;
key name;
description "Exporting Process of the Monitoring Device.";
leaf name {
type nameType;
description "Key of this list.";
}
uses exportingProcessParameters;
}
}
}
<CODE ENDS>]]>
</artwork>
</section>
<section anchor="sec:examples" title="Examples">
<t>
This section shows example configurations conforming to the YANG module specified in <xref target="sec:yang" />.
</t>
<section anchor="sec:psamp-example" title="PSAMP Device">
<t>
This configuration example configures two Observation Points capturing ingress traffic at eth0 and all traffic at eth1.
Both Observed Packet Streams enter two different Selection Processes.
The first Selection Process implements a Composite Selectors of a filter for UDP packets and a random sampler.
The second Selection Process implements a Primitive Selector of an ICMP filter.
The Selected Packet Streams of both Selection Processes enter the same Cache.
The Cache generates a PSAMP Packet Report for every selected packet.
</t>
<t>
The associated Exporting Process exports to a Collector using PR-SCTP and DTLS.
The transport layer security parameters specify that the collector must supply a certificate for the fully qualified domain name collector.example.net.
Valid certificates from any certification authority will be accepted.
As the destination transport port is omitted, the standard IPFIX-over-DTLS port 4740 is used.
</t>
<t>
The parameters of the Selection Processes are reported as Selection Sequence Report Interpretations and Selector Report Interpretations <xref target="RFC5476"/>.
There will be two Selection Sequence Report Interpretations per Selection Process, one for each Observation Point.
Selection Sequence Statistics Report Interpretations are exported every 30 seconds (30000 milliseconds).
</t>
<artwork>
<![CDATA[<ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp">
<observationPoint>
<name>OP at eth0 (ingress)</name>
<observationDomainId>123</observationDomainId>
<ifName>eth0</ifName>
<direction>ingress</direction>
<selectionProcess>Sampled UDP packets</selectionProcess>
<selectionProcess>ICMP packets</selectionProcess>
</observationPoint>
<observationPoint>
<name>OP at eth1</name>
<observationDomainId>123</observationDomainId>
<ifName>eth1</ifName>
<selectionProcess>Sampled UDP packets</selectionProcess>
<selectionProcess>ICMP packets</selectionProcess>
</observationPoint>
<selectionProcess>
<name>Sampled UDP packets</name>
<selector>
<name>UDP filter</name>
<filterMatch>
<ieId>4</ieId>
<value>17</value>
</filterMatch>
</selector>
<selector>
<name>10-out-of-100 sampler</name>
<sampRandOutOfN>
<size>10</size>
<population>100</population>
</sampRandOutOfN>
</selector>
<cache>PSAMP cache</cache>
</selectionProcess>
<selectionProcess>
<name>ICMP packets</name>
<selector>
<name>ICMP filter</name>
<filterMatch>
<ieId>4</ieId>
<value>1</value>
</filterMatch>
</selector>
<cache>PSAMP cache</cache>
</selectionProcess>
<cache>
<name>PSAMP cache</name>
<immediateCache>
<cacheLayout>
<cacheField>
<name>Field 1: ipHeaderPacketSection</name>
<ieId>313</ieId>
<ieLength>64</ieLength>
</cacheField>
<cacheField>
<name>Field 2: observationTimeMilliseconds</name>
<ieId>322</ieId>
</cacheField>
</cacheLayout>
</immediateCache>
<exportingProcess>The only exporter</exportingProcess>
</cache>
<exportingProcess>
<name>The only exporter</name>
<destination>
<name>PR-SCTP collector</name>
<sctpExporter>
<destinationIPAddress>192.0.2.1</destinationIPAddress>
<rateLimit>1000000</rateLimit>
<timedReliability>500</timedReliability>
<transportLayerSecurity>
<remoteSubjectFQDN>coll-1.example.net</remoteSubjectFQDN>
</transportLayerSecurity>
</sctpExporter>
</destination>
<options>
<name>Options 1</name>
<optionsType>selectionSequence</optionsType>
<optionsTimeout>0</optionsTimeout>
</options>
<options>
<name>Options 2</name>
<optionsType>selectionStatistics</optionsType>
<optionsTimeout>30000</optionsTimeout>
</options>
</exportingProcess>
</ipfix>]]>
</artwork>
<t>
The above configuration results in one Template and six Options Templates.
For the remainder of the example, we assume Template ID 256 for the Template and Template IDs 257 to 262 for the Options Templates.
The Template is used to export the Packet Reports and has the following fields:
</t>
<t>
<list style="empty">
<t>Template ID: 256</t>
<t>ipHeaderPacketSection (ID = 313, length = 64)</t>
<t>observationTimeMilliseconds (ID = 322, length = 8)</t>
</list>
</t>
<t>
Two Options Template are used for the Selection Sequence Report Interpretations.
The first one has one selectorId field and is used for the Selection Process "ICMP packets".
The second one has two selectorId fields to describe the two selectors of the Selection Process "Sampled UDP packets".
</t>
<t>
<list style="empty">
<t>Template ID: 257</t>
<t>Scope: selectionSequenceId (ID = 301, length = 8)</t>
<t>observationPointId (ID = 138, length = 4)</t>
<t>selectorId (ID = 302, length = 4)</t>
</list>
</t>
<t>
<list style="empty">
<t>Template ID: 258</t>
<t>Scope: selectionSequenceId (ID = 301, length = 8)</t>
<t>observationPointId (ID = 138, length = 4)</t>
<t>selectorId (ID = 302, length = 4)</t>
<t>selectorId (ID = 302, length = 4)</t>
</list>
</t>
<t>
Another Options Template is used to carry the Property Match Filtering Selector Report Interpretation for the Selectors "UDP filter" and "ICMP filter":
</t>
<t>
<list style="empty">
<t>Template ID: 259</t>
<t>Scope: selectorId (ID = 302, length = 4)</t>
<t>selectorAlgorithm (ID = 304, length = 2)</t>
<t>protocolIdentifier (ID = 4, length = 1)</t>
</list>
</t>
<t>
Yet another Options Template is used to carry the Random n-out-of-N Sampling Selector Report Interpretation for the Selector "10-out-of-100 sampler":
</t>
<t>
<list style="empty">
<t>Template ID: 260</t>
<t>Scope: selectorId (ID = 302, length = 4)</t>
<t>selectorAlgorithm (ID = 304, length = 2)</t>
<t>samplingSize (ID = 319, length = 4)</t>
<t>samplingPopulation (ID = 310, length = 4)</t>
</list>
</t>
<t>
The last two Options Template are used to carry the Selection Sequence Statistics Report Interpretation for the Selection Processes, containing the statistics for one and two Selectors, respectively:
</t>
<t>
<list style="empty">
<t>Template ID: 261</t>
<t>Scope: selectionSequenceId (ID = 301, length = 8)</t>
<t>selectorIdTotalPktsObserved (ID = 318, length = 8)</t>
<t>selectorIdTotalPktsSelected (ID = 319, length = 8)</t>
</list>
</t>
<t>
<list style="empty">
<t>Template ID: 262</t>
<t>Scope: selectionSequenceId (ID = 301, length = 8)</t>
<t>selectorIdTotalPktsObserved (ID = 318, length = 8)</t>
<t>selectorIdTotalPktsSelected (ID = 319, length = 8)</t>
<t>selectorIdTotalPktsObserved (ID = 318, length = 8)</t>
<t>selectorIdTotalPktsSelected (ID = 319, length = 8)</t>
</list>
</t>
<t>
After a short runtime, 100 packets have been observed at the two Observation Points, including 20 UDP and 5 ICMP packets.
3 of the UDP packets are selected by the random sampler, which results in a total of 8 Packet Reports generated by the Cache.
Under these circumstances, the complete configuration and state data of the PSAMP Device may look as follows:
</t>
<artwork>
<![CDATA[<ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp">
<observationPoint>
<name>OP at eth0 (ingress)</name>
<observationPointId>1</observationPointId>
<observationDomainId>123</observationDomainId>
<ifName>eth0</ifName>
<direction>ingress</direction>
<selectionProcess>Sampled UDP packets</selectionProcess>
<selectionProcess>ICMP packets</selectionProcess>
</observationPoint>
<observationPoint>
<name>OP at eth1</name>
<observationPointId>2</observationPointId>
<observationDomainId>123</observationDomainId>
<ifName>eth1</ifName>
<direction>both</direction>
<selectionProcess>Sampled UDP packets</selectionProcess>
<selectionProcess>ICMP packets</selectionProcess>
</observationPoint>
<selectionProcess>
<name>Sampled UDP packets</name>
<selector>
<name>UDP filter</name>
<filterMatch>
<ieId>4</ieId>
<value>17</value>
</filterMatch>
<packetsObserved>100</packetsObserved>
<packetsDropped>80</packetsDropped>
<selectorDiscontinuityTime>2010-03-15T00:00:00.00Z
</selectorDiscontinuityTime>
</selector>
<selector>
<name>10-out-of-100 sampler</name>
<sampRandOutOfN>
<size>10</size>
<population>100</population>
</sampRandOutOfN>
<packetsObserved>20</packetsObserved>
<packetsDropped>17</packetsDropped>
<selectorDiscontinuityTime>2010-03-15T00:00:00.00Z
</selectorDiscontinuityTime>
</selector>
<selectionSequence>
<observationDomainId>123</observationDomainId>
<selectionSequenceId>1</selectionSequenceId>
</selectionSequence>
<selectionSequence>
<observationDomainId>123</observationDomainId>
<selectionSequenceId>2</selectionSequenceId>
</selectionSequence>
<cache>PSAMP cache</cache>
</selectionProcess>
<selectionProcess>
<name>ICMP packets</name>
<selector>
<name>ICMP filter</name>
<filterMatch>
<ieId>4</ieId>
<value>1</value>
</filterMatch>
<packetsObserved>100</packetsObserved>
<packetsDropped>95</packetsDropped>
<selectorDiscontinuityTime>2010-03-15T00:00:00.00Z
</selectorDiscontinuityTime>
</selector>
<selectionSequence>
<observationDomainId>123</observationDomainId>
<selectionSequenceId>3</selectionSequenceId>
</selectionSequence>
<selectionSequence>
<observationDomainId>123</observationDomainId>
<selectionSequenceId>4</selectionSequenceId>
</selectionSequence>
<cache>PSAMP cache</cache>
</selectionProcess>
<cache>
<name>PSAMP cache</name>
<immediateCache>
<cacheLayout>
<cacheField>
<name>Field 1: ipHeaderPacketSection</name>
<ieId>313</ieId>
<ieLength>64</ieLength>
</cacheField>
<cacheField>
<name>Field 2: observationTimeMilliseconds</name>
<ieId>322</ieId>
</cacheField>
</cacheLayout>
</immediateCache>
<dataRecords>8</dataRecords>
<cacheDiscontinuityTime>2010-03-15T00:00:00.00Z
</cacheDiscontinuityTime>
<exportingProcess>The only exporter</exportingProcess>
</cache>
<exportingProcess>
<name>The only exporter</name>
<exportMode>parallel</exportMode>
<destination>
<name>PR-SCTP collector</name>
<sctpExporter>
<ipfixVersion>10</ipfixVersion>
<destinationIPAddress>192.0.2.1</destinationIPAddress>
<destinationPort>4740</destinationPort>
<sendBufferSize>32768</sendBufferSize>
<rateLimit>1000000</rateLimit>
<timedReliability>500</timedReliability>
<transportLayerSecurity>
<remoteSubjectFQDN>coll-1.example.net</remoteSubjectFQDN>
</transportLayerSecurity>
<transportSession>
<ipfixVersion>10</ipfixVersion>
<sourceAddress>192.0.2.100</sourceAddress>
<destinationAddress>192.0.2.1</destinationAddress>
<sourcePort>45687</sourcePort>
<destinationPort>4740</destinationPort>
<sctpAssocId>1</sctpAssocId>
<status>active</status>
<rate>230</rate>
<bytes>978</bytes>
<messages>3</messages>
<records>19</records>
<templates>1</templates>
<optionsTemplates>6</optionsTemplates>
<transportSessionStartTime>2010-03-15T00:00:00.50Z
</transportSessionStartTime>
<template>
<observationDomainId>123</observationDomainId>
<templateId>256</templateId>
<setId>2</setId>
<accessTime>2010-03-15T00:00:02.15Z</accessTime>
<templateDataRecords>8</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>313</ieId>
<ieLength>64</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>154</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
<template>
<observationDomainId>123</observationDomainId>
<templateId>257</templateId>
<setId>3</setId>
<accessTime>2010-03-15T00:00:02.15Z</accessTime>
<templateDataRecords>2</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>301</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
<isScope/>
</field>
<field>
<ieId>138</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>302</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
<template>
<observationDomainId>123</observationDomainId>
<templateId>258</templateId>
<setId>3</setId>
<accessTime>2010-03-15T00:00:02.15Z</accessTime>
<templateDataRecords>2</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>301</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
<isScope/>
</field>
<field>
<ieId>138</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>302</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>302</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
<template>
<observationDomainId>123</observationDomainId>
<templateId>259</templateId>
<setId>3</setId>
<accessTime>2010-03-15T00:00:02.15Z</accessTime>
<templateDataRecords>2</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>302</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
<isScope/>
</field>
<field>
<ieId>304</ieId>
<ieLength>2</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>4</ieId>
<ieLength>1</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
<template>
<observationDomainId>123</observationDomainId>
<templateId>260</templateId>
<setId>3</setId>
<accessTime>2010-03-15T00:00:02.15Z</accessTime>
<templateDataRecords>1</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>302</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
<isScope/>
</field>
<field>
<ieId>304</ieId>
<ieLength>2</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>309</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>310</ieId>
<ieLength>4</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
<template>
<observationDomainId>123</observationDomainId>
<templateId>261</templateId>
<setId>3</setId>
<accessTime>2010-03-15T00:00:03.10Z</accessTime>
<templateDataRecords>2</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>301</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
<isScope/>
</field>
<field>
<ieId>318</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>319</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
<template>
<observationDomainId>123</observationDomainId>
<templateId>262</templateId>
<setId>3</setId>
<accessTime>2010-03-15T00:00:03.10Z</accessTime>
<templateDataRecords>2</templateDataRecords>
<templateDiscontinuityTime>2010-03-15T00:00:01.10Z
</templateDiscontinuityTime>
<field>
<ieId>301</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
<isScope/>
</field>
<field>
<ieId>318</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>319</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>318</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
<field>
<ieId>319</ieId>
<ieLength>8</ieLength>
<ieEnterpriseNumber>0</ieEnterpriseNumber>
</field>
</template>
</transportSession>
</sctpExporter>
</destination>
<options>
<name>Options 1</name>
<optionsType>selectionSequence</optionsType>
<optionsTimeout>0</optionsTimeout>
</options>
<options>
<name>Options 2</name>
<optionsType>selectionStatistics</optionsType>
<optionsTimeout>30000</optionsTimeout>
</options>
</exportingProcess>
</ipfix>]]>
</artwork>
</section>
<section anchor="sec:ipfix-example" title="IPFIX Device">
<t>
This configuration example demonstrates the shared usage of a Cache for maintaining Flow Records from two Observation Points belonging to different Observation Domains.
Packets are selected using different Sampling techniques: count-based Sampling for the first Observation Point (eth0) and selection of all packets for the second Observation Point (eth1).
The Exporting Process sends the Flow Records to a primary destination using SCTP.
A UDP Collector is specified as secondary destination.
</t>
<t>
Exporting Process reliability statistics <xref target="RFC5101"/> are exported periodically every minute (60000 milliseconds).
Selection Sequence Report Interpretations and Selector Report Interpretations <xref target="RFC5476"/> are exported once after configuring the Selection Processes.
In total, two Selection Sequence Report Interpretations will be exported, one for each Selection Process.
</t>
<artwork>
<![CDATA[<ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp">
<observationPoint>
<name>OP at eth0 (ingress)</name>
<observationDomainId>123</observationDomainId>
<ifName>eth0</ifName>
<direction>ingress</direction>
<selectionProcess>Count-based packet selection</selectionProcess>
</observationPoint>
<observationPoint>
<name>OP at eth1</name>
<observationDomainId>456</observationDomainId>
<ifName>eth1</ifName>
<selectionProcess>All packet selection</selectionProcess>
</observationPoint>
<selectionProcess>
<name>Count-based packet selection</name>
<selector>
<name>Count-based sampler</name>
<sampCountBased>
<packetInterval>1</packetInterval>
<packetSpace>99</packetSpace>
</sampCountBased>
</selector>
<cache>Flow cache</cache>
</selectionProcess>
<selectionProcess>
<name>All packet selection</name>
<selector>
<name>Select all</name>
<selectAll/>
</selector>
<cache>Flow cache</cache>
</selectionProcess>
<cache>
<name>Flow cache</name>
<timeoutCache>
<maxFlows>4096</maxFlows>
<activeTimeout>5000</activeTimeout>
<idleTimeout>10000</idleTimeout>
<cacheLayout>
<cacheField>
<name>Field 1</name>
<ieName>sourceIPv4Address</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 2</name>
<ieName>destinationIPv4Address</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 3</name>
<ieName>transportProtocol</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 4</name>
<ieName>sourceTransportPort</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 5</name>
<ieName>destinationTransportPort</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 6</name>
<ieName>flowStartMilliSeconds</ieName>
</cacheField>
<cacheField>
<name>Field 7</name>
<ieName>flowEndSeconds</ieName>
</cacheField>
<cacheField>
<name>Field 8</name>
<ieName>octetDeltaCount</ieName>
</cacheField>
<cacheField>
<name>Field 9</name>
<ieName>packetDeltaCount</ieName>
</cacheField>
</cacheLayout>
</timeoutCache>
<exportingProcess>SCTP export with UDP backup</exportingProcess>
</cache>
<exportingProcess>
<name>SCTP export with UDP backup</name>
<exportMode>fallback</exportMode>
<destination>
<name>SCTP destination (primary)</name>
<sctpExporter>
<destinationPort>4739</destinationPort>
<destinationIPAddress>192.0.2.1</destinationIPAddress>
</sctpExporter>
</destination>
<destination>
<name>UDP destination (secondary)</name>
<udpExporter>
<destinationPort>4739</destinationPort>
<destinationIPAddress>192.0.2.2</destinationIPAddress>
<templateRefreshTimeout>300</templateRefreshTimeout>
<optionsTemplateRefreshTimeout>300
</optionsTemplateRefreshTimeout>
</udpExporter>
</destination>
<options>
<name>Options 1</name>
<optionsType>selectionSequence</optionsType>
<optionsTimeout>0</optionsTimeout>
</options>
<options>
<name>Options 2</name>
<optionsType>exportingReliability</optionsType>
<optionsTimeout>60000</optionsTimeout>
</options>
</exportingProcess>
</ipfix>]]>
</artwork>
</section>
<section anchor="sec:mixed-example" title="Export of Flow Records and Packet Reports">
<t>
This configuration example demonstrates the combined export of Flow Records and Packet Reports for a single Observation Point.
One Selection Process applies random Sampling to the Observed Packet Stream.
Its output is passed to a Cache generating Flow Records.
In parallel, the Observed Packet Stream enters a second Selection Process which discards all non-ICMP packets and passes the selected packets to a second Cache for generating Packet Reports.
The output of both Caches is exported to a single Collector using SCTP.
</t>
<artwork>
<![CDATA[<ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp">
<observationPoint>
<name>OP at linecard 3</name>
<observationDomainId>9876</observationDomainId>
<ifIndex>4</ifIndex>
<direction>ingress</direction>
<selectionProcess>Sampling</selectionProcess>
<selectionProcess>ICMP</selectionProcess>
</observationPoint>
<selectionProcess>
<name>Sampling</name>
<selector>
<name>Random sampler</name>
<sampUniProb>
<probability>0.01</probability>
</sampUniProb>
</selector>
<cache>Flow cache</cache>
</selectionProcess>
<selectionProcess>
<name>ICMP</name>
<selector>
<name>ICMP filter</name>
<filterMatch>
<ieId>4</ieId>
<value>1</value>
</filterMatch>
</selector>
<cache>Packet reporting</cache>
</selectionProcess>
<cache>
<name>Flow cache</name>
<timeoutCache>
<maxFlows>4096</maxFlows>
<activeTimeout>5</activeTimeout>
<idleTimeout>10</idleTimeout>
<cacheLayout>
<cacheField>
<name>Field 1</name>
<ieName>sourceIPv4Address</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 2</name>
<ieName>destinationIPv4Address</ieName>
<isFlowKey/>
</cacheField>
<cacheField>
<name>Field 6</name>
<ieName>flowStartMilliSeconds</ieName>
</cacheField>
<cacheField>
<name>Field 7</name>
<ieName>flowEndSeconds</ieName>
</cacheField>
<cacheField>
<name>Field 8</name>
<ieName>octetDeltaCount</ieName>
</cacheField>
<cacheField>
<name>Field 9</name>
<ieName>packetDeltaCount</ieName>
</cacheField>
</cacheLayout>
</timeoutCache>
<exportingProcess>Export</exportingProcess>
</cache>
<cache>
<name>Packet reporting</name>
<immediateCache>
<cacheLayout>
<cacheField>
<name>Field 1</name>
<ieId>313</ieId>
<ieLength>64</ieLength>
</cacheField>
<cacheField>
<name>Field 2</name>
<ieId>154</ieId>
</cacheField>
</cacheLayout>
</immediateCache>
<exportingProcess>Export</exportingProcess>
</cache>
<exportingProcess>
<name>Export</name>
<destination>
<name>SCTP collector</name>
<sctpExporter>
<destinationIPAddress>192.0.2.1</destinationIPAddress>
<timedReliability>0</timedReliability>
</sctpExporter>
</destination>
<options>
<name>Options 1</name>
<optionsType>selectionSequence</optionsType>
<optionsTimeout>0</optionsTimeout>
</options>
</exportingProcess>
</ipfix>]]>
</artwork>
</section>
<section title="Collector and File Writer">
<t>
This configuration example configures a Collector which writes the received data to a file.
</t>
<artwork>
<![CDATA[<ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp">
<collectingProcess>
<name>SCTP collector</name>
<sctpCollector>
<name>Listening port 4739</name>
<localPort>4739</localPort>
<localIPAddress>192.0.2.1</localIPAddress>
</sctpCollector>
<exportingProcess>File writer</exportingProcess>
</collectingProcess>
<exportingProcess>
<name>File writer</name>
<destination>
<name>Write to /tmp folder</name>
<fileWriter>
<file>file://tmp/collected-records.ipfix</file>
</fileWriter>
</destination>
</exportingProcess>
</ipfix>]]>
</artwork>
</section>
<section anchor="sec:deviation" title="Deviations">
<t>
Assume that a Monitoring Device has only two interfaces ifIndex=1 and ifIndex=2 which can be configured as Observation Points.
The Observation Point ID is always identical to the ifIndex.
</t>
<t>
The following YANG module specifies these deviations.
</t>
<artwork>
<![CDATA[module my-ipfix-psamp-deviation {
namespace "urn:my-company:xml:ns:ietf-ipfix-psamp";
prefix my;
import ietf-ipfix-psamp { prefix ipfix; }
deviation /ipfix:ipfix/ipfix:observationPoint/ipfix:entPhysicalIndex {
deviate not-supported;
}
deviation /ipfix:ipfix/ipfix:observationPoint/ipfix:entPhysicalName {
deviate not-supported;
}
deviation /ipfix:ipfix/ipfix:observationPoint/ipfix:ifName {
deviate not-supported;
}
deviation /ipfix:ipfix/ipfix:observationPoint {
deviate add {
must "ipfix:ifIndex=1 or ipfix:ifIndex=2";
}
}
deviation
/ipfix:ipfix/ipfix:observationPoint/ipfix:observationPointId {
deviate add {
must "current()=../ipfix:ifIndex";
}
}
}]]>
</artwork>
</section>
</section>
<!-- FIXME: mapping of MIB and YANG -->
<section anchor="sec:security" title="Security Considerations">
<t>
The YANG module defined in this memo is designed to be accessed via the NETCONF protocol <xref target="RFC6241"/>.
The lowest NETCONF layer is the secure transport layer and the mandatory to implement secure transport is SSH <xref target="RFC6242"/>.
</t>
<t>
There are a number of data nodes defined in this YANG module which are writable/creatable/deletable (i.e. config true, which is the default).
These data nodes may be considered sensitive or vulnerable in some network environments.
Write operations (e.g. edit-config) to these data nodes without proper protection can have a negative effect on network operations.
These are the subtrees and data nodes and their sensitivity/vulnerability:
</t>
<t>
<list style="hanging">
<t hangText="/ipfix/observationPoint">
<vspace blankLines="0" />
The configuration parameters in this subtree specify where packets are observed and by which Selection Processes they will be processed.
Write access to this subtree allows observing packets at arbitrary interfaces or linecards of the Monitoring Device and may thus lead to the export of sensitive traffic information.
</t>
<t hangText="/ipfix/selectionProcess">
<vspace blankLines="0" />
The configuration parameters in this subtree specify for which packets information will be reported in Packet Reports or Flow Records.
Write access to this subtree allows changing the subset of packets for which information will be reported and may thus lead to the export of sensitive traffic information.
</t>
<t hangText="/ipfix/cache">
<vspace blankLines="0" />
The configuration parameters in this subtree specify the fields included in Packet Reports or Flow Records.
Write access to this subtree allows adding fields which may contain sensitive traffic information, such as IP addresses or parts of the packet payload.
</t>
<t hangText="/ipfix/exportingProcess">
<vspace blankLines="0" />
The configuration parameters in this subtree specify to which Collectors Packet Reports or Flow Records are exported.
Write access to this subtree allows exporting potentially sensitive traffic information to illegitimate Collectors.
Furthermore, transport layer security parameters can be changed, which may affect the mutual authentication between Exporters and Collectors as well as the encrypted transport of the data.
</t>
<t hangText="/ipfix/collectingProcess">
<vspace blankLines="0" />
The configuration parameters in this subtree may specify that collected Packet Reports and Flow Records are reexported to another Collector or written to a file.
Write access to this subtree potentially allows reexporting or storing the sensitive traffic information.
</t>
</list>
</t>
<t>
Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments.
It is thus important to control read access (e.g. via get, get-config or notification) to these data nodes.
These are the subtrees and data nodes and their sensitivity/vulnerability:
</t>
<t>
<list style="hanging">
<t hangText="/ipfix/observationPoint">
<vspace blankLines="0" />
Parameters in this subtree may be sensitive because they reveal information about the Monitoring Device itself and the network infrastructure.
</t>
<t hangText="/ipfix/selectionProcess">
<vspace blankLines="0" />
Parameters in this subtree may be sensitive because they reveal information about the Monitoring Device itself and the observed traffic.
For example, the counters packetsObserved and packetsDropped inferring the number of observed packets.
</t>
<t hangText="/ipfix/cache">
<vspace blankLines="0" />
Parameters in this subtree may be sensitive because they reveal information about the Monitoring Device itself and the observed traffic.
For example, the counters activeFlows and dataRecords allow inferring the number of measured Flows or packets.
</t>
<t hangText="/ipfix/exportingProcess">
<vspace blankLines="0" />
Parameters in this subtree may be sensitive because they reveal information about the network infrastructure and the outgoing IPFIX Transport Sessions.
For example, it discloses the IP addresses of Collectors as well as the deployed transport layer security configuration, which may facilitate the interception of outgoing IPFIX Messages.
</t>
<t hangText="/ipfix/collectingProcess">
<vspace blankLines="0" />
Parameters in this subtree may be sensitive because they reveal information about the network infrastructure and the incoming IPFIX Transport Sessions.
For example, it discloses the IP addresses of Exporters as well as the deployed transport layer security configuration, which may facilitate the interception of incoming IPFIX Messages.
</t>
</list>
</t>
</section>
<section anchor="sec:iana" title="IANA Considerations">
<t>
This document registers a URI in the IETF XML registry <xref target="RFC3688"/>.
Following the format in RFC 3688, the following registration is requested.
</t>
<t>
<list style="empty">
<t>URI: urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp</t>
<t>Registrant Contact: The IPFIX WG of the IETF.</t>
<t>XML: N/A, the requested URI is an XML namespace.</t>
</list>
</t>
<t>
This document registers a YANG module in the YANG Module Names registry <xref target="RFC6020"/>.
</t>
<t>
<list style="empty">
<t>name: ietf-ipfix-psamp</t>
<t>namespace: urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp</t>
<t>prefix: ipfix</t>
<t>reference: RFCxxxx</t>
</list>
</t>
</section>
<appendix title="Acknowledgements">
<t>
The authors thank Martin Bjorklund, Andy Bierman, and Ladislav Lhotka for helping specifying the configuration data model in YANG, as well as Atsushi Kobayashi, Andrew Johnson, Lothar Braun, and Brian Trammell for their valuable reviews of this document.
</t>
</appendix>
</middle>
<back>
<references title="Normative References">
&rfc2119;
&rfc5101;
&rfc5102;
&rfc5103;
&rfc5475;
&rfc5476;
&rfc5477;
&rfc6020;
&rfc6021;
<reference anchor="UML">
<front>
<title>OMG Unified Modeling Language (OMG UML), Superstructure, V2.2</title>
<author>
<organisation abbrev="OMG">Object Management Group</organisation>
</author>
<date month="February" year="2009" />
</front>
<seriesInfo name="OMG" value="formal/2009-02-02" />
<format type="PDF" target="http://www.omg.org/spec/UML/2.2/Superstructure/PDF/"/>
</reference>
</references>
<references title="Informative References">
&rfc1141;
&rfc2863;
&rfc5280;
&rfc3688;
&rfc3758;
&rfc3871;
&rfc3917;
&rfc4133;
&rfc6347;
&rfc6241;
&rfc6242;
&rfc4960;
&rfc5246;
&rfc5470;
&rfc5472;
&rfc5473;
&rfc5474;
&rfc5610;
&rfc5655;
&rfc6110;
&rfc6526;
&rfc6615;
&psampmib;
&xml;
&xmlschema;
<reference anchor="YANG-WEB">
<front>
<title>YANG WebHome</title>
<author initials="M." surname="Bjoerklund" fullname="Martin Bjoerklund" />
<date month="March" year="2011" />
</front>
<seriesInfo name="Homepage" value="http://www.yang-central.org" />
<format type="HTML" target="http://www.yang-central.org/twiki/bin/view/Main/WebHome"/>
</reference>
<reference anchor="IANA-IPFIX">
<front>
<title>IANA Registry of IPFIX Information Elements</title>
</front>
<seriesInfo name="Homepage" value="http://www.iana.org/assignments/ipfix/ipfix.xhtml" />
<format type="HTML" target="http://www.iana.org/assignments/ipfix/ipfix.xhtml"/>
</reference>
<!--<reference anchor="CISCO-NETFLOW-MIB">
<front>
<title>CISCO-NETFLOW-MIB: Cisco NetFlow Cache MIB Module</title>
<author initials="N." surname="Kundu" fullname="Nitish Kundu" />
<author initials="P." surname="Aitken" fullname="Paul Aitken" />
<date month="January" year="2004" />
</front>
<seriesInfo name="Cisco SNMP Object Navigator" value="http://tools.cisco.com/Support/SNMP/do/BrowseMIB.do?local=en&step=2&mibName=CISCO-NETFLOW-MIB" />
<format type="HTML" target="http://tools.cisco.com/Support/SNMP/do/BrowseMIB.do?local=en&step=2&mibName=CISCO-NETFLOW-MIB"/>
</reference>-->
<!--&xpath;-->
</references>
</back>
</rfc>
| PAFTECH AB 2003-2026 | 2026-04-23 14:24:47 |