YANG Data Models for the IP Flow Information Export (IPFIX) Protocol, Packet Sampling (PSAMP) Protocol, and Bulk Data Export
draft-boydseda-ipfix-psamp-bulk-data-yang-model-01

Document Type Active Internet-Draft (individual)
Last updated 2019-04-16 (latest revision 2019-03-11)
Stream IETF
Intended RFC status Proposed Standard
Formats plain text xml pdf html bibtex
Yang Validation 0 errors, 0 warnings.
Additional URLs
- Yang catalog entry for ietf-bulk-data-export@2019-03-11.yang
- Yang catalog entry for ietf-ipfix@2019-03-11.yang
- Yang catalog entry for ietf-psamp@2019-03-11.yang
- Yang impact analysis for draft-boydseda-ipfix-psamp-bulk-data-yang-model
Stream WG state (None)
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Yes
Telechat date
Responsible AD Ignas Bagdonas
Send notices to (None)
Network Working Group                                            J. Boyd
Internet-Draft                                                    ADTRAN
Obsoletes: 6728 (if approved)                                    M. Seda
Intended status: Standards Track                                   Calix
Expires: September 12, 2019                               March 11, 2019

 YANG Data Models for the IP Flow Information Export (IPFIX) Protocol,
         Packet Sampling (PSAMP) Protocol, and Bulk Data Export
           draft-boydseda-ipfix-psamp-bulk-data-yang-model-01

Abstract

   This document defines a flexible modular YANG model for packet
   sampling (PSAMP) and bulk data collection and export via the IPFIX
   protocol.  This new model is an alternative to the model defined in
   RFC 6728, "Configuration Data Model for the IP Flow Information
   Export (IPFIX) and Packet Sampling (PSAMP) Protocols".  All
   functionality modeled in RFC 6728 has been carried over to this new
   model.

   The YANG data model in this document conforms to the Network
   Management Datastore Architecture (NMDA) defined in RFC 8342.

   This document obsoletes RFC 6728 (if approved).

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on September 12, 2019.

Copyright Notice

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

Boyd & Seda            Expires September 12, 2019               [Page 1]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

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

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Historical Perspective  . . . . . . . . . . . . . . . . .   4
     1.2.  Relationship with RFC 6728  . . . . . . . . . . . . . . .   6
     1.3.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   7
     1.4.  Tree Diagrams . . . . . . . . . . . . . . . . . . . . . .  13
   2.  Objectives  . . . . . . . . . . . . . . . . . . . . . . . . .  14
   3.  Structure of the Configuration Data Model . . . . . . . . . .  14
     3.1.  PSAMP-IPFIX Metered Decomposition . . . . . . . . . . . .  17
       3.1.1.  Metering Process Decomposition in Selection Process
               and Cache . . . . . . . . . . . . . . . . . . . . . .  17
       3.1.2.  Exporter Configuration  . . . . . . . . . . . . . . .  18
     3.2.  Collector/Exporter Model  . . . . . . . . . . . . . . . .  20
       3.2.1.  Collector/Exporter Decomposition  . . . . . . . . . .  20
     3.3.  Bulk Data Model . . . . . . . . . . . . . . . . . . . . .  20
       3.3.1.  Bulk Data Exporter Decomposition  . . . . . . . . . .  21
   4.  Configuration Parameters  . . . . . . . . . . . . . . . . . .  21
     4.1.  Observation Point Class . . . . . . . . . . . . . . . . .  21
     4.2.  Selection Process Class . . . . . . . . . . . . . . . . .  23
       4.2.1.  Selection Process Class Method  . . . . . . . . . . .  25
       4.2.2.  Selection Process Filter Classes  . . . . . . . . . .  27
     4.3.  Cache Class . . . . . . . . . . . . . . . . . . . . . . .  29
       4.3.1.  Immediate Cache Type Class  . . . . . . . . . . . . .  31
       4.3.2.  Timeout Cache, Natural Cache, and Permanent Cache
               Type Class  . . . . . . . . . . . . . . . . . . . . .  32
       4.3.3.  Cache Layout Class  . . . . . . . . . . . . . . . . .  33
     4.4.  Exporting Process Class . . . . . . . . . . . . . . . . .  36
       4.4.1.  SCTP Exporter Class . . . . . . . . . . . . . . . . .  38
       4.4.2.  UDP Exporter Class  . . . . . . . . . . . . . . . . .  40
       4.4.3.  TCP Exporter Class  . . . . . . . . . . . . . . . . .  42
       4.4.4.  File Writer Class . . . . . . . . . . . . . . . . . .  43
       4.4.5.  Options Class . . . . . . . . . . . . . . . . . . . .  45
     4.5.  Collecting Process Class  . . . . . . . . . . . . . . . .  47
       4.5.1.  SCTP Collector Class  . . . . . . . . . . . . . . . .  47
       4.5.2.  UDP Collector Class . . . . . . . . . . . . . . . . .  48
       4.5.3.  TCP Collector Class . . . . . . . . . . . . . . . . .  49
       4.5.4.  File Reader Class . . . . . . . . . . . . . . . . . .  50

Boyd & Seda            Expires September 12, 2019               [Page 2]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     4.6.  Transport Layer Security Class  . . . . . . . . . . . . .  51
     4.7.  Transport Session Class . . . . . . . . . . . . . . . . .  54
     4.8.  Template Class  . . . . . . . . . . . . . . . . . . . . .  57
     4.9.  Bulk Data Class . . . . . . . . . . . . . . . . . . . . .  59
   5.  Adaptation to Device Capabilities . . . . . . . . . . . . . .  60
   6.  YANG Modules  . . . . . . . . . . . . . . . . . . . . . . . .  62
     6.1.  ietf-ipfix  . . . . . . . . . . . . . . . . . . . . . . .  63
       6.1.1.  ietf-ipfix Module Structure . . . . . . . . . . . . .  63
       6.1.2.  ietf-ipfix YANG Module  . . . . . . . . . . . . . . .  63
     6.2.  ietf-psamp  . . . . . . . . . . . . . . . . . . . . . . . 101
       6.2.1.  ietf-psamp Module Structure . . . . . . . . . . . . . 101
       6.2.2.  ietf-psamp YANG module  . . . . . . . . . . . . . . . 102
     6.3.  ietf-bulk-data-export . . . . . . . . . . . . . . . . . . 130
       6.3.1.  ietf-bulk-data-export Module Structure  . . . . . . . 130
       6.3.2.  ietf-bulk-data-export YANG module . . . . . . . . . . 131
   7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . . 136
   8.  Security Considerations . . . . . . . . . . . . . . . . . . . 137
   9.  Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 139
   10. References  . . . . . . . . . . . . . . . . . . . . . . . . . 139
     10.1.  Normative References . . . . . . . . . . . . . . . . . . 139
     10.2.  Informative References . . . . . . . . . . . . . . . . . 142
   Appendix A.  Example: ietf-ipfix Usage  . . . . . . . . . . . . . 143
   Appendix B.  Example: ietf-psamp Usage  . . . . . . . . . . . . . 145
   Appendix C.  Example: ietf-bulk-data-export Usage . . . . . . . . 148
   Appendix D.  Tree diagrams  . . . . . . . . . . . . . . . . . . . 150
     D.1.  ietf-ipfix  . . . . . . . . . . . . . . . . . . . . . . . 150
     D.2.  ietf-psamp  . . . . . . . . . . . . . . . . . . . . . . . 160
     D.3.  ietf-bulk-data-export . . . . . . . . . . . . . . . . . . 164
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . . 164

1.  Introduction

   Bulk data collection is an automated collection of device data that
   is packaged together and delivered to an IPFIX collector.  The IPFIX
   protocol may be used to transport bulk data such as:

   o  Sampled (metered) Packet SAMPling (PSAMP) data: [RFC5476] defines
      PSAMP operations that a device may implement to sample packets
      passing a network element for reporting purposes.

   o  Statistics from interfaces, sub-interfaces and sessions: YANG
      models define statistics that can be retrieved via protocols such
      as NETCONF [RFC6241] or RESTCONF [RFC8040].  These statistics can
      be streamed using an IPFIX transport to an IPFIX collector that
      supports analytics tools.  An operator may wish to take the bulk
      data and analyze it for trend analysis purposes or other usages
      (e.g., collect octet counts every 5 minutes for service level

Boyd & Seda            Expires September 12, 2019               [Page 3]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      agreement purposes or collect reported device temperature for
      network health purposes).

   IPFIX can also be used to meet the bulk transport requirements of
   other protocols.  For example:

   o  [BBF.TR-352] ICTP (Inter-Channel Transport Protocol): ICTP uses
      IPFIX to transport dynamic data (e.g., lease information) across
      participating NG-PON2 (Next-Generation Passive Optical Network 2)
      systems.

   The YANG data model in this document conforms to the Network
   Management Datastore Architecture (NMDA) defined in [RFC8342].

1.1.  Historical Perspective

   Below is a historical timeline of IETF IPFIX and YANG RFCs:

   o  RFC 5101 (2008), obsoleted by [RFC7011] (2013), defined the IPFIX
      protocol.

   o  [RFC5476] (2009) defines the PSAMP operations of selection (random
      selection, deterministic selection or hash-based selection) for
      capturing or metering packets arriving on a device.

   o  RFC 6020 (2010) and [RFC7950] (2016) define v1.0 and v1.1 of the
      YANG data modeling language (respectively), and [RFC8342] (2018)
      updates RFC 7950 to define NMDA (Network Management Datastore
      Architecture).

   o  [RFC6728] (2012) defined a Packet SAMPling (PSAMP) YANG model for
      devices that use PSAMP for capturing (for metering purposes) a
      subset of all packets traversing a device.

   o  RFC 7223 (2014), obsoleted by [RFC8343] (2018), defined a YANG
      data model for interfaces.

   o  IETF, IEEE, BBF etc. (2015 to 2018) have incorporated reporting of
      statistics into corresponding YANG models (G.fast, PON, etc.).

   [RFC6728] defines a single YANG module that performs PSAMP sampling.
   The collection process (PSAMP) and the IPFIX exporting process are
   part of the same YANG module.  The PSAMP YANG model defines a variety
   of features.  However, it only supports a PSAMP meter and it assumes
   a device supports SCTP (minimally).  Both constructs prove
   challenging to other applications that use IPFIX for transport of
   bulk data:

Boyd & Seda            Expires September 12, 2019               [Page 4]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   o  [BBF.TR-352] supports only TCP and TLS as IPFIX transport
      protocols.  The [RFC6728] YANG model does not allow for explicit
      non-support for SCTP, therefore requiring the need for YANG
      deviations to announce non-support.

      *  A preferable solution is one that is more flexible (e.g.,
         allows different underlying transport options and avoids the
         need for deviations to announce non-support for features which
         an access node is not required to support).

   o  The PSAMP meter does not need to be configured if the observation
      point is already defined by other YANG models.  One could attempt
      to augment PSAMP YANG to reference where the observation point is
      being configured (but then would have to express feature "non-
      support" on features unlikely to be needed or required by access
      devices).

   Rather than these approaches, new YANG model have been developed
   where functionality is separated into different modules such that the
   functions can be independently leveraged.

   These are some of the other issues with the current model and how
   these new models address them:

   o  The PSAMP YANG model defines the frequency of export in the PSAMP
      cache.  Bulk data needs the export frequency to be controlled by
      the exporting process.

      *  The new models bring the cache closer to the function
         performing the export.

      *  The bulk data and PSAMP collection processes are modeled
         independently.

   o  The PSAMP YANG model supports IPFIX mediators.  Access nodes may
      need to support large IPFIX mediation functions.

      *  The transport sessions are modeled such that they can be
         retrieved individually in addition to retrieving the entire
         list (which may be quite large for access devices such as an
         NG-PON2 OLT).

   o  The PSAMP YANG model contains references which correlate to MIB
      definitions.  For example, interfaces are referenced via ifIndex.
      For most NETCONF managed devices, interfaces are referenced by
      name as defined in [RFC8343].

Boyd & Seda            Expires September 12, 2019               [Page 5]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      *  The ability to reference via the interface list in ietf-
         interfaces [RFC8343] is added alongside the ifName and ifIndex.

      *  The ability to reference via the hardware component list in
         ietf-hardware [RFC8348] is added alongside the entPhysicalName
         and entPhysicalIndex.

1.2.  Relationship with RFC 6728

   This RFC uses the general principles defined in [RFC6728] with the
   following exceptions:

   o  [RFC6728] was developed prior to [RFC8407] YANG guidelines
      publication.  This RFC adopts and conforms to the latest YANG
      guidelines for identifier naming conventions.

   o  The YANG model adds support for [RFC8343] interface references.

   o  The YANG model is separated into the following three modules:

      *  ietf-ipfix: Defines the IPFIX collector and exporter functions.

      *  ietf-psamp: Defines the PSAMP functions for configuring a
         device to sample/meter a subset of packets from the network.

      *  ietf-bulk-data-export: Defines the bulk data IPFIX templates
         used to export bulk data.

   o  SCTP data nodes are made optional via the 'sctp' feature for
      applications not requiring to support SCTP.

   o  IPFIX transport sessions allow transport session information to be
      retrieved individually.

   o  Source and destination address type choice statements are added to
      improve extensibility of the model.

   Applications that use this RFC are expected to only need to import
   the applicable YANG modules.  For example:

   o  PSAMP uses the ietf-ipfix and ietf-psamp modules.

   o  Bulk data export uses the ietf-ipfix and ietf-bulk-data-export
      modules.

   o  Mediators and file readers/writers use the ietf-ipfix module.

Boyd & Seda            Expires September 12, 2019               [Page 6]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

1.3.  Terminology

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in BCP
   14 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

   The following terms are used in this RFC:

   Bulk Data
      Bulk data is the collection of data from a device that is packaged
      together and delivered to an IPFIX collector.

   Cache
      The Cache is a functional block in a Metering Process that
      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.
      [RFC6728]

   Cache Layout
      The Cache Layout defines the superset of fields that are included
      in the Packet Reports or Flow Records maintained by the Cache.
      [RFC6728]

   Collector
      A device that host one or more Collecting Processes is termed a
      Collector.  [RFC7011]

   Collection Process
      A Collecting Process received IPFIX messages from one or more
      Exporting Processes.  The Collecting Process might process or
      store received Flow Records.  [RFC7011]

   Composite Selector
      A Composite Selector is an ordered composition of Selectors, in
      which the output Packet Stream issuing from one Selector forms the
      input Packet Stream to the succeeding Selector.  [RFC5476]

   Data Record

Boyd & Seda            Expires September 12, 2019               [Page 7]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      A data record is a record that contains values of the parameters
      corresponding to a template record.  [RFC7011]

   Exporter
      A device that hosts one or more Exporting Process is termed an
      Exporter.  [RFC7011]

   Exporting Process
      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.  [RFC6728]

   Filtering
      A filter is a Selector that selects a packet deterministically
      based on the Packet Content or its treatment or functions of these
      occurring in the Selection State.  Two examples are:

      *  Property Match filtering: A packet is selected if the specific
         field in the packet equals a predefined value.

      *  Hash-based Selection: A Hash Function is applied to the Packet
         Content and the packet is selected if the result falls in a
         specific range.  [RFC5476]

   Flow Key
      Each of the fields that:

      *  belong to the packet header (e.g., destination IP address), or

      *  are a property of the packet itself (e.g., packet length), or

      *  are derived from Packet Treatment (e.g., Autonomous System (AS)
         number), and

      *  that are used to define a Flow (i.e., are the properties common
         to all packets in the Flow) are termed Flow Keys.

      As an example, the traditional '5-tuple' Flow Key of source and
      destination IP address, source and destination transport port, and
      transport protocol, groups together all packets belonging to a
      single direction of communication on a single socket.  [RFC7011]

   Flow Record
      A Flow Record contains information about a specific Flow that was
      observed at an Observation Point.  A Flow Record contains measured
      properties of the Flow (e.g., the total number of bytes for all

Boyd & Seda            Expires September 12, 2019               [Page 8]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      the Flow's packets) and usually contains characteristic properties
      of the Flow (e.g., source IP address).  [RFC7011]

   Informational Element
      An Information Element is a protocol and encoding independent
      description of an attribute that may appear in an IPFIX Record.
      Information Elements are defined in the [IANA-IPFIX] Registry].
      The type associated with an Information Element indicates
      constraints on what it may contain and also determines the valid
      encoding mechanisms for use in IPFIX.  [RFC7011]

   IPFIX Device
      An IPFIX Device host at least one Exporting Process.  It may host
      further Exporting Processes as well as arbitrary number of
      Observation Points and Metering Processing.  [RFC7011]

   IPFIX FIle
      An IPFIX File is a serialized stream of IPFIX Messages; this
      stream may be stored in a filesystem or transported using some
      technique customarily used for files.  [RFC5655]

   IPFIX File Writer
      An IPFIX File Writer is a process that writes IPFIX Files to a
      filesystem.  [RFC5655]

   IPFIX Mediator
      An IPFIX Mediator is an IPFIX Device that provides IPFIX Mediation
      by receiving a record stream from some data sources, hosting one
      or more Intermediate Processes to transform that stream, and
      exporting the transformed record stream into IPFIX Messages via an
      Exporting Process.  [RFC7119]

   IPFIX Message
      An IPFIX Message is a message that originates at the Exporting
      Process and carries the IPFIX record for this Exporting Process
      and whose destination is a Collecting Process.  An IPFIX Message
      is encapsulated at the transport layer.  [RFC7011]

   Metering Process
      The Metering Process is split into two functional blocks:

      *  Selection Process: A Selection Process takes the Observed
         Packet Stream as its input and selects a subset of that stream
         as its output.

      *  Cache: The Cache is a functional block in a Metering Process
         that generates IPFIX Flow Records or PSAMP Packet Reports from
         a Selected Packet Stream, in accordance with its configuration.

Boyd & Seda            Expires September 12, 2019               [Page 9]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      The Metering Process generates IPFIX Flow Records or PSAMP Packet
      Reports, depending on its deployment as part of an IPFIX Device or
      PSAMP Device.  If IPFIX Flow Records are generated, the Metering
      Process MUST NOT aggregate packets observed at different
      Observation Domains in the same Flow.  [RFC6728]

   Monitoring Device
      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.  [RFC6728]

   Observation Domain
      An Observation Domain is the largest set of Observation Points for
      which Flow Information can be aggregated by a Metering Process.
      For example, a router line card may be an Observation Domain if it
      is composed of several interfaces, each of which is an Observation
      Point.  If the IPFIX Message it generates, the Observation Domain
      includes it Observation Domain ID, which is unique per Exporting
      Process.  That way, the Collecting Process can identify the
      specific Observation Domain from the Exporter that sends the IPFIX
      Messages.  Every Observation Point is associated with an
      Observation Domain.  It is RECOMMENDED that Observation Domain IDs
      also be unique per IPFIX Device.  [RFC7011]

   Observation Point
      An Observation Point is a location in the network where packets
      can be observed.  Examples include a line to which a probe is
      attached, a shared medium, such as an Ethernet based LAN, a single
      port of a router, or a set of interfaces (physical or logical) of
      a router.  Note that every Observation Point is associated with an
      Observation Domain and that one Observation Point can be an entire
      line card.  That would be a subset of the individual Observation
      Points at the line card's interfaces.  [RFC7011]

   Options Template Record
      An Options Template Record is a Template Record that defines the
      structure and interpretation of fields in a Data Record, including
      defining how to scope the applicability of the Data Record.
      [RFC7011]

   Options Template/Options Template Set
      An Options Template Set is a collection of one or more Options
      Template Records that have been grouped together in an IPFIX
      Message.  [RFC7011]

   Packet Report

Boyd & Seda            Expires September 12, 2019              [Page 10]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      Packet Reports comprise a configurable subset of a packet's input
      to the Selection Process include the Packet Content, information
      relating to its treatment (e.g., the output interface) and its
      associated selection state (e.g., the hash of a packet content).
      [RFC5476]

   Primitive Selector
      A Selector is primitive if it is not a Composite Selector.
      [RFC5476]

   PSAMP Device
      A PSAMP device is a device hosting at least an Observation Point,
      a Selection Process and an Exporting Process.  Typically
      corresponding Observation Point(s), Selection Process(es) and
      Exporting Process(es) are co-located at this device, for example,
      at a router.  [RFC5476]

   Reverse Information Element
      An Information Element defined as corresponding to a normal (or
      forward) Information Element, but associated with the reverse
      direction of a Biflow.  [RFC5103]

   Sampling
      A Selector that is not a filter is called a Sampling operation.
      This reflects the intuitive notion that if the selection of a
      packet cannot be determine from its content alone, there must be
      some type of Sampling taking place.  [RFC5476]

   Selected Packet Stream
      The Selected Packet Stream is the set of all packets selected by a
      Selection Process.  [RFC6728]

   Selection Process
      A Selection Process takes the Observed Packet Stream as its input
      and selects a subset of that stream as its output.  [RFC5476]

   Selection Sequence
      From all the packets observed at an Observation Point, only a few
      packets are selected by one or more Selectors.  The Selection
      Sequence is a unique value per Observation Domain describing the
      Observation Point and the Selector IDs through the packets are
      selected.  [RFC5476]

   Selection Sequence Report Interpretation
      Each Packet Report contains a selectionSequenceId Information
      Element that identifies the particular combination of Observation
      Point and Selector(s) used for its selection.  For every
      selectionSequenceId Information Element in use, the PSAMP Device

Boyd & Seda            Expires September 12, 2019              [Page 11]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      MUST export a Selection Sequence Report Interpretation using an
      Options Template.  [RFC5476]

   Selection Sequence Statistics Report Interpretation
      A Selector MAY be used in multiple Selection Sequences.  However,
      each use of a Selector must be independent, so each separate
      logical instance of a Selector MUST maintain its own individual
      Selection State and statistics.  The Selection Sequence Statistics
      Report Interpretation MUST include the number of observed packets
      (Population Size) and the number of packets selected (Sample Size)
      by each instance of its Primitive Selectors.  [RFC5476]

   Selection State
      A Selection Process may maintain state information for use by the
      Selection Process.  At a given time, the Selection State may
      depend on packets observed at and before that time, and other
      variables.  Examples include:

      *  sequence numbers of packets at the input of Selectors

      *  a timestamp of observation of the packet at the Observation
         Point

      *  iterators for pseudorandom number generators

      *  hash values calculated during selection

      *  indicators of whether the packet was selected by a given
         Selector

      Selection Processes may change portions of the Selection State as
      a result of processing a packet.  Selection state for a packet is
      to reflect the state after processing the packet.  [RFC5476]

   Selector
      A Selector defines the action of a Selection Process on a single
      packet of its input.  If selected, the packet becomes an element
      of the output Packet Stream.  The Selector can make use of the
      following information in determining whether a packet is selected:

      *  the Packet Content

      *  information derived from the packet's treatment at the
         Observation Point

      *  any selection state that may be maintained by the Selection
         Process [RFC5476]

Boyd & Seda            Expires September 12, 2019              [Page 12]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   Selector Report Interpretation
      An IPFIX Data Record, defined by an Options Template Record, MUST
      be used to send the configuration details of every Selector in
      use.  The Options Template Record MUST contain:

      *  selectorId Information Element as the Scope field

      *  SelectorAlgorithm Information Element [RFC5476]

   Template Record
      A Template Record defines the structure and interpretation of
      fields in a Data Record.  [RFC7011]

   Template/Template Set
      A Template Set is a collection of one or more Template Records
      that have been grouped together in an IPFIX Message.  [RFC7011]

   Traffic Flow or Flow
      A Flow is defined as a set of packets or frames passing an
      Observation Point in the network during a certain time interval.
      All packets belonging to a particular Flow have a set of common
      properties.  Each property is defined as the result of applying a
      function to the values of:

      *  one or more packet header fields (e.g., destination IP
         address), transport header fields (e.g., destination port
         number), or application header fields (e.g., RTP header fields)

      *  one or more characteristics of the packet itself (e.g., number
         of MPLS labels, etc.)

      *  one or more of the fields derived from Packet Treatment (e.g.,
         next-hop IP address, the output interface, etc.)

      A packet is defined as belonging to a Flow if it completely
      satisfies all the defined properties of the Flow.  Note that the
      set of packets represented by a Flow may be empty; that is, a Flow
      may represent zero or more packets.  As sampling is a Packet
      Treatment, this definition includes packets selected by a sampling
      mechanism.  [RFC7011]

1.4.  Tree Diagrams

   Tree diagrams used in this document follow the notation defined in
   [RFC8340].

Boyd & Seda            Expires September 12, 2019              [Page 13]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

2.  Objectives

   This document defines a YANG data model for the configuration and
   state retrieval of basic IPFIX functionality as well as PSAMP and
   bulk data export applications over IPFIX.  The YANG modules in this
   document conform to the Network Management Datastore Architecture
   (NMDA) [RFC8342] and [RFC8407] YANG guidelines.

3.  Structure of the Configuration Data Model

   The reference model described in this RFC describes the following
   models:

   o  A PSAMP/IPFIX metered model based on [RFC6728] where a PSAMP/IPFIX
      device configures a meter that samples packets passing through a
      device, applies an IPFIX template to those packets, and exports
      IPFIX templates/data records to an IPFIX collector.

   o  An IPFIX collector/exporter model based on [RFC6728] where an
      IPFIX device can:

      *  terminate multiple IPFIX sessions to a collection process and
         then exports those IPFIX packets to an external IPFIX collector
         or

      *  read an IPFIX formatted file into the collection process and
         export that file to a destination location.

   o  A bulk data model where an IPFIX template is applied to configured
      reference resource that can export bulk data (e.g., statistics,
      [BBF.TR-352] ICTP IPFIX data).

   Figure 1 illustrates the PSAMP metered UML model for a PSAMP/IPFIX
   monitoring device.  The metering process is contained in the ietf-
   psamp module.  The metering process is comprised of a selection-
   process and cache that refers to an exporting-process.  Further
   explanations about the relationship between selection-process and
   cache are given in Section 3.1.1.  Section 4.4 describes the
   exporting-process configuration.

Boyd & Seda            Expires September 12, 2019              [Page 14]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   +--------------------------------------------------------------+
   | +--------------------+                    Metering Process   |
   | | Module: ietf-psamp |                                       |
   | |--------------------|<------------------------+             |
   | |                    |<--------+             1 |             |
   | +--------------------+         | +-------------+-----------+ |
   |          ^                     | | list: selection-process | |
   |          |                     | |-------------------------| |
   |        1 |                     | |                         | |
   | +--------+-------------+       | +-----------------+-------+ |
   | | list: observation-pt |       |               ^   |         |
   | |----------------------| selection-process-ref |   |         |
   | |                      +-------|---------------+   |         |
   | +----------------------+       |           0..*    |         |
   |                              1 |                   |         |
   |                        +-------+-------+           |         |
   |                        |  list: cache  |           |         |
   |                        |---------------| 0..1      |         |
   |                        |               |<----------+         |
   |                        +---------------+   cache-ref         |
   +--------------------------------+-----------------------------+
    +--------------------+          |
    | Module: ietf-ipfix |          |
    |--------------------|          |
    |                    |          |
    +--------------------+          |
              ^                     | exporting-process-ref
              |                     |
            1 |                     |
    +---------+---------------+     |
    | list: exporting-process |     |
    |-------------------------|     |
    |                         |<----+
    +-------------------------+ 0..*

                    Figure 1: PSAMP-IPFIX metered model

   PSAMP/IPFIX monitoring device implementations usually maintain the
   separation of various functional blocks, although they do not
   necessarily implement all of them.  The configuration data model
   enables the setting of commonly available configuration parameters
   for selection-processes, and caches and supports optional
   configuration for features like the [RFC2863] IF-MIB and [RFC6933]
   Entity MIB.

   Figure 2 illustrates the collector/export UML model for a PSAMP/IPFIX
   monitoring device.  A device supports a collector that terminates

Boyd & Seda            Expires September 12, 2019              [Page 15]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   IPFIX message or reads an IPFIX file (e.g., from a remote device) and
   optionally exports that data to an external IPFIX collector (this
   model taken from [RFC6728] could be used for IPFIX mediators).

     +--------------------+
     | Module: ietf-ipfix |
     |--------------------|<------------------+
     |                    |                 1 |
     +--------------------+     +-------------+------------+
               ^                | list: collecting-process |
               |                |--------------------------|
               |                +-------------+------------+
               |                              |
             1 |                              |
     +---------+---------------+              |
     | list: exporting-process |              |
     |-------------------------| 0..*         |
     |                         |<-------------+
     +-------------------------+  exporting-process-ref

                    Figure 2: Collector/Exporter Model

   Figure 3 shows the bulk data model for an IPFIX monitoring device.  A
   device configures a resource (through other YANG modules for
   example).  A bulk-data template is created and applied to that
   resource.  For example, if a resource had enabled statistics
   collecting or BBF WT-352 ICTP, the application of the bulk-data-
   template would determine the IPFIX data exported to an IPFIX
   collector.

Boyd & Seda            Expires September 12, 2019              [Page 16]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

    +------------------------------+
    | module:ietf-bulk-data-export |
    |------------------------------|
    +------------------------------+
                 ^
                 |
               1 |
    +------------+------------+              +---------------+
    | list:bulk-data-template |              | list:resource |
    |-------------------------|------------->+---------------|
    +------------+------------+         0..* +---------------+
                 |
            0..* | exporting-process-ref
                 v
    +-------------------------+
    | list:exporting-process  |
    |-------------------------|
    +-------------------------+

                         Figure 3: Bulk Data Model

3.1.  PSAMP-IPFIX Metered Decomposition

3.1.1.  Metering Process Decomposition in Selection Process and Cache

   In a monitoring device implementation, the functionality of the
   metering process is split into the selection process and cache.
   Figure 4 shows a metering process example.  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 a primitive selector) or an ordered composition
   of multiple selectors (called a composite selector).  The cache
   generates flow records or packet reports from the selected packet
   stream, depending on its configuration.

              +------------------------------------+
              | Metering Process                   |
              | +------------+ Selected            |
     Observed | | selection- | Packet    +-------+ |  Stream of
     Packet  -->| process    |---------->| cache |--> Flow Records or
     Stream   | +------------+ Stream    +-------+ |  Packet Reports
              +------------------------------------+

     Figure 4: Selection Process and Cache forming a Metering Process

   A metering process must always have a selection-process.  It is
   possible to select all in the observed packet stream, and pass them

Boyd & Seda            Expires September 12, 2019              [Page 17]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   to the cache unfiltered by configuring the selector-method to
   "select-all".

   A metering process can be configured to support multiple selection
   processes that receive packets from multiple observation points
   within the same observation domain.  In this case, the observed
   packet streams of the observation points are processed in independent
   selection sequences.  As specified in [RFC5476], a distinct set of
   selector instances needs to be maintained per selection sequence in
   order to keep the selection states and statistics separate.

   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 Figure 5.

             +--------------------------------------+
             | 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                |
             +--------------------------------------+

       Figure 5: Metering Process with multiple Selection Processes

   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 [RFC7011]), 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.

3.1.2.  Exporter Configuration

   Figure 6 below shows the main classes of the configuration data model
   that are involved in the configuration of an IPFIX or PSAMP Exporter.
   The role of the classes can be briefly summarized as follows:

   o  The observation-point class specifies an observation-point (e.g.,
      an interface or line card) of the Monitoring Device that captures
      packets for traffic measurements.  An observation-point may be

Boyd & Seda            Expires September 12, 2019              [Page 18]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      associated with one or more selection-process classes when a
      device is capable of processing observed packets in parallel.

      *  When an observation-point is configured without references to
         the selection-process, the captured packets are not considered
         part of the metering process.

   o  The selection-process 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.  The selection-
      process selects packets from one or more observed packet streams,
      each originating from a different observation-point.  A selection-
      process instance may be referred to from one or more observation-
      point instances.

      *  A selection process may pass the selected packet stream to a
         cache.  Therefore, the selection-process class contains a
         reference to an instance 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.

   o  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 instance of the cache class may be
      referred to from multiple selection process instances.
      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.

      *  A cache may pass its output to one or more exporting processes.
         Therefore, the cache class enables references to one or more
         instances of the exporting process class.

      *  If a cache instance does not specify any reference to an
         exporting process instance, the cache output is dropped.

   o  The exporting-process class contains configuration and state
      parameters of an exporting-process.  It includes various
      transport-protocol-specific parameters and the export
      destinations.

      *  An instance of the exporting process class may be referred to
         from multiple instances of the cache class.

Boyd & Seda            Expires September 12, 2019              [Page 19]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

                        +-------------------+
                        | observation-point |
                        +---------+---------+
                             0..* |
                                  |
                             0..* v
                        +-------------------+
                        | selection-process |
                        +---------+---------+
                             0..* |
                                  |
                             0..1 v
                        +-------------------+
                        | cache             |
                        +---------+---------+
                             0..* |
                                  |
                             0..* v
                        +-------------------+
                        | exporting-process |
                        +-------------------+

             Figure 6: Class diagram of Exporter configuration

3.2.  Collector/Exporter Model

3.2.1.  Collector/Exporter Decomposition

   Figure 2 shows the main classes of the configuration data model that
   are involved in the configuration of a collector.  An instance of the
   collecting-process class specifies the local IP addresses, transport
   protocols, and port numbers of a collecting-process.

   A collecting-process MAY be configured as a File Reader according to
   [RFC5655].

   A collecting-process class instance may refer to one or more
   exporting-process instances configuring exporting processes that re-
   export 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.

3.3.  Bulk Data Model

Boyd & Seda            Expires September 12, 2019              [Page 20]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

3.3.1.  Bulk Data Exporter Decomposition

   Figure 3 shows the main classes of the configuration model that are
   involved in bulk data export.  A device that has a resource instance
   capable of reporting bulk data through IPFIX does not need an IPFIX
   meter to be created.  Instead a bulk-data template is created and
   applied to that resource instance.

   The exporting-process class contains configuration and state
   parameters of an exporting-process.  It includes various transport-
   protocol-specific parameters and the export destinations.  The bulk-
   data-template may refer to multiple instances of the exporting-
   process class.

4.  Configuration Parameters

   This section specifies the configuration and state parameters of the
   configuration data model separately for each class.

4.1.  Observation Point Class

   Figure 7 shows the observation-point attributes of an IPFIX
   monitoring device.  As defined in [RFC7011], an observation point can
   be any location where packets are observed.  A IPFIX monitoring
   device potentially has more than one such location.  An instance of
   observation-point defines which location is associated with a
   specific observation point.  For this purpose, interfaces and
   physical entities are identified using their names.

   o  Alternatively, index values of the corresponding entries in the
      IfTable (if-mib module [RFC2863]) or the EntPhysicalTable (entity-
      mib module [RFC6933]) 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.

   By its definition in [RFC7011], 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.  The observation-point-id
   (i.e., the value of the information element observation-point-id
   [IANA-IPFIX]) is assigned by the monitoring device.

   The configuration parameters of the observation point are:

   observation-domain-id
      This parameter defines the identifier of the observation domain
      that the observation point belongs to.  Observation points that

Boyd & Seda            Expires September 12, 2019              [Page 21]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      are configured with the same observation domain ID belong to the
      same observation domain.  Note that this parameter corresponds to
      ipfixObservationPointObservationDomainId in the IPFIX MIB module
      [RFC6615].

   if-name
      This parameter identifies the interface (via the IfName in the IF-
      MIB [RFC2863]) on the monitoring device that is associated with
      the given observation point.  if-name should only be used if an
      SNMP agent enables access to the IfTable.

   if-index
      This parameter identifies the interface (via the IfIndex value in
      the IF-MIB [RFC2863]) on the monitoring device that is associated
      with the given observation point.  if-index should only be used if
      an SNMP agent enables access to the IfTable.

   interface-ref
      This parameter identifies the interface via the interface
      reference [RFC8343] on the monitoring device that is associated
      with the given observation point.

   hardware-ref
      This parameter identifies a hardware component via the hardware
      reference [RFC8348] on the monitoring device that is associated
      with the given observation point.

   ent-physical-name
      This parameter identifies a physical entity (via the
      EntPhysicalName in the ENTITY-MIB module [RFC6933]) on the
      monitoring device that is associated with the given observation
      point.  ent-physical-name should only be used if an SNMP agent
      enables access to the EntPhysicalTable.

   ent-physical-index
      This parameter identifies a physical entity (via the
      EntPhysicalIndex in the ENTITY-MIB module [RFC6933]) on the
      monitoring device that is associated with the given observation
      point.  ent-physical-name should only be used if an SNMP agent
      enables access to the EntPhysicalTable.

   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

Boyd & Seda            Expires September 12, 2019              [Page 22]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      interface in promiscuous mode), the value of this parameter is
      ignored.

   selection-process-reference
      An observation-point instance may refer to one or more selection-
      process instances that process the observed packets in parallel.

        +--rw observation-point* [name]
           +--rw name                     ietf-ipfix:name-type
           +--rw observation-domain-id    uint32
           +--rw interface-ref*           if:interface-ref
           +--rw if-name*                 if-name-type {if-mib}?
           +--rw if-index*                uint32 {if-mib}?
           +--rw hardware-ref*            hardware-ref
           +--rw ent-physical-name*       string {entity-mib}?
           +--rw ent-physical-index*      uint32 {entity-mib}?
           +--rw direction?               direction
           +--ro observation-point-id?    uint32
           +--rw selection-process*
                   -> /ietf-ipfix:ipfix/psamp/selection-process/name

                  Figure 7: Observation Point Attributes

4.2.  Selection Process Class

   Figure 8 shows the selection-process attributes.  The selection-
   process class contains the configuration and state parameters of a
   selection process that 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 packets in the specified order.

   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 that is unique
   within the observation domain the observation point belongs to (see
   [RFC5477]).  Selection sequence ids are assigned by the monitoring
   device.

   As state parameters, the selection-process class contains a list of
   (observation-domain-id, selection-sequence-id) 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 [RFC5476] with the corresponding
   selection-process instance.

Boyd & Seda            Expires September 12, 2019              [Page 23]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   A selection-process instance may include a reference to cache class
   instance to generate packet reports or flow records from the selected
   packet stream.

        +--rw selection-process* [name]
           +--rw name                  ietf-ipfix:name-type
           +--rw selector* [name]
           |  +--rw name
           |  |       ietf-ipfix:name-type
           |  +--rw (method)
           |  |  +--:(select-all)
           |  |  |  +--rw select-all?              empty
           |  |  +--:(samp-count-based)
           |  |  |  +--rw samp-count-based {psamp-samp-count-based}?
           |  |  |     +--rw packet-interval    uint32
           |  |  |     +--rw packet-space       uint32
           |  |  +--:(samp-time-based)
           |  |  |  +--rw samp-time-based {psamp-samp-time-based}?
           |  |  |     +--rw time-interval    uint32
           |  |  |     +--rw time-space       uint32
           |  |  +--:(samp-rand-out-of-n)
           |  |  |  +--rw samp-rand-out-of-n
           |  |  |          {psamp-samp-rand-out-of-n}?
           |  |  |     +--rw size          uint32
           |  |  |     +--rw population    uint32
           |  |  +--:(samp-uni-prob)
           |  |  |  +--rw samp-uni-prob {psamp-samp-uni-prob}?
           |  |  |     +--rw probability    decimal64
           |  |  +--:(filter-match)
           |  |  |  +--rw filter-match {psamp-filter-match}?
           |  |  |     +--rw (information-element)
           |  |  |     |  +--:(ie-name)
           |  |  |     |  |  +--rw ie-name?
           |  |  |     |  |          ietf-ipfix:ie-name-type
           |  |  |     |  +--:(ie-id)
           |  |  |     |     +--rw ie-id?
           |  |  |     |             ietf-ipfix:ie-id-type
           |  |  |     +--rw ie-enterprise-number?   uint32
           |  |  |     +--rw value                   string
           |  |  +--:(filter-hash)
           |  |     +--rw filter-hash {psamp-filter-hash}?
           |  |        +--rw hash-function?       identityref
           |  |        +--rw initializer-value?   uint64
           |  |        +--rw ip-payload-offset?   uint64
           |  |        +--rw ip-payload-size?     uint64
           |  |        +--rw digest-output?       boolean
           |  |        +--rw selected-range* [name]
           |  |        |  +--rw name    ietf-ipfix:name-type

Boyd & Seda            Expires September 12, 2019              [Page 24]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |  |        |  +--rw min?    uint64
           |  |        |  +--rw max?    uint64
           |  |        +--ro output-range-min?    uint64
           |  |        +--ro output-range-max?    uint64
           |  +--ro packets-observed?              yang:counter64
           |  +--ro packets-dropped?               yang:counter64
           |  +--ro selector-discontinuity-time?   yang:date-and-time
           +--rw cache?
           |       -> /ietf-ipfix:ipfix/psamp/cache/name
           +--ro selection-sequence* []
              +--ro observation-domain-id?   uint32
              +--ro selection-sequence-id?   uint64

                  Figure 8: Selection Process Attributes

4.2.1.  Selection Process Class Method

   Standardized PSAMP sampling and filtering methods are described in
   [RFC5475]; their configuration parameters are specified in the
   classes samp-count-based, samp-time-based, samp-rand-out-of-n, samp-
   uni-prob, filter-match, and filter-hash.  In addition, the select-all
   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.

   The selector class contains the selector statistics packets-observed
   and packets-dropped as well as selector-discontinuity-time, which
   correspond to the IPFIX MIB module objects
   ipfixSelectionProcessStatsPacketsObserved,
   ipfixSelectionProcessStatsPacketsDropped, and
   ipfixSelectionProcessStatsDiscontinuityTime, respectively [RFC6615]:

   packets-observed
      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 selector-
      discontinuity-time.

   packets-dropped
      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 selector-discontinuity-time.

Boyd & Seda            Expires September 12, 2019              [Page 25]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   selector-discontinuity-time
      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
      absoluteand not relative to sys-uptime.

   Note that packets-observed and packets-dropped 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 [RFC5476], which are
   related to a single selection sequence only.

4.2.1.1.  Selection Process Class Method: Sampler Methods

   Figure 8 shows the following sampler methods:

   Samp-Count-Based (Systematic Count-based Sampling): The following
   attributes are configurable:

   packet-interval
      The number of packets that are consecutively sampled between gaps
      of length packet-space.  This parameter corresponds with the
      Information Element samplingPacketInterval and
      psampSampCountBasedInterval attribute [RFC5477].

   packet-space:
      The number of unsampled packets between two sampling intervals.
      This parameter corresponds to the Information Element
      samplingPacketSpace and psampSampCountBasedSpace attribute
      [RFC6727].

   Samp-Time-Based (Systematic Time-based Sampling): The following
   attributes are configurable:

   time-interval
      The time interval during which all arriving packets are sampled.
      The unit is microseconds.  This parameter corresponds to
      corresponds to the Information Element samplingTimeInterval and to
      psampSampTimeBasedInterval attribute [RFC6727].

   time-space
      The gap between two Sampling intervals, in microseconds.  This
      parameter corresponds to Information Element samplingTimeSpace and
      to psampSampTimeBasedSpace attribute [RFC6727].

   Samp-Rand-Out-of-N: The following attributes are configurable:

   size

Boyd & Seda            Expires September 12, 2019              [Page 26]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      The number of elements taken from the parent population.  This
      parameter corresponds to Information Element samplingSize and
      psampSampRandOutOfNSize attribute [RFC6727].

   population
      The number of elements in the parent population.  These parameters
      corresponds to Information Element samplingPopulation and
      psampSampRandOutOfNPopulation attribute [RFC6727].

   Samp-Uni_Prob: The following attributes are configurable:

   probability
      The probability for uniform probabilistic sampling.  The
      probability is expressed as a value between 0 and 1.  This
      parameter corresponds to Information Element samplingProbability
      and psampSampUniProbProbability attribute [RFC6727].

4.2.2.  Selection Process Filter Classes

   Figure 8 shows the following filter methods:

   Property-Match Filtering: The following attributes are configurable:

   Filtering based on ie-id, ie-name, ie-enterprise-number
      The property to be matched is specified by either ie-id or ie-
      name, specifying the identifier or name of the Information
      Element, respectively.  If ie-enterprise-number is zero (which is
      the default), this Information Element is registered in the IANA
      registry of IPFIX Information Elements [IANA-IPFIX].  A non-zero
      value of ie-enterprise-number specifies an enterprise-specific
      Information Element [IANA-ENTERPRISE-NUMBERS].

   value
      The matching value.

   For hash-based filtering, the configuration and state attributes are:

   hash-function
      The following values are defined:

      *  BOB: BOB Hash Function as specified in [RFC5475], Appendix A.2

      *  IPSX: IP Shift-XOR (IPSX) Hash Function as specified in
         [RFC5475], Appendix A.1

      *  CRC: CRC-32 function as specified in [RFC1141] Default value is
         "BOB".  This parameter corresponds to the PSAMP MIB object
         psampFiltHashFunction [RFC6727].

Boyd & Seda            Expires September 12, 2019              [Page 27]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   initializer-value
      This parameter corresponds to the Information Element
      hashInitialiserValue [RFC5477], as well as to the PSAMP MIB object
      psampFiltHashInitializerValue [RFC6727].  If not configured by the
      user, the Monitoring Device arbitrarily chooses an initializer
      value.

   ip-payload-offset
      Configures the offset of the payload section used as input to the
      hash function.  Default value is 0 (minimum configurable values
      according to [RFC5476], Section 6.5.2.6.).  This parameter
      corresponds to the Information Element hashIPPayloadOffset
      [RFC5477] as well as to the PSAMP MIB object
      psampFiltHashIpPayloadOffset [RFC6727].

   ip-payload-size
      Configures the size of the payload section used as input to the
      hash function.  Default value is 8 (minimum configurable values
      according to [RFC5476], Section 6.5.2.6.).  This parameter
      corresponds to the Information Element hashIPPayloadSize
      [RFC5477], as well as to the PSAMP MIB object
      psampFiltHashIpPayloadSize [RFC6727].

   digest-output
      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
      digest-hash-value field.  This parameter corresponds to the
      Information Element hashDigestOutput [RFC5477].

   output-range-min
      Defines the beginning of the hash's function potential output
      range.  This parameter correspond to the Information Element
      hashOutputRangeMin [RFC5477], as well as to the PSAMP MIB object
      psampFiltHashOutputRangeMin [RFC6727].

   output-range-max
      Defines the end of the hash function's potential output range.
      This parameter correspond to the Information Element
      hashOutputRangeMax [RFC5477], as well as to the PSAMP MIB object
      psampFiltHashOutputRangeMax [RFC6727].

   One or more ranges of matching hash values are defined by the min and
   max parameters of the selected-range subclass.  These parameters
   correspond to the Information Elements hashSelectedRangeMin and
   hashSelectedRangeMax [RFC5477], as well as to the PSAMP MIB objects
   psampFiltHashSelectedRangeMin and psampFiltHashSelectedRangeMax
   [RFC6727].

Boyd & Seda            Expires September 12, 2019              [Page 28]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

4.3.  Cache Class

   Figure 9 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
   immediate-cache, timeout-cache, natural-cache, and permanent-cache,
   which are presented below in Section 4.3.1 and Section 4.3.2.  The
   following three state parameters are common to all caches and
   therefore included in the cache class itself:

   enabled
      Enables the cache so that specified data may be exported.  The
      default is "enabled".

   metering-process-id
      The identifier of the metering process that cache belongs to.
      This parameter corresponds to the information element
      meteringprocessid [IANA-IPFIX].  Its occurrence helps to associate
      metering process (reliability) statistics exported according to
      the IPFIX protocol specification [RFC7011] with the corresponding
      metering-process class identifier.

   data-records
      The number of data records generated by this cache.

   discontinuities
      The value of this counter can occur at re-initialization of the
      management system, and at other times as indicated by the value of
      cache-discontinuity-time.  Note that this parameter corresponds to
      ipfixMeteringProcessDataRecords in the IPFIX MIB module [RFC6615].

   cache-discontinuity-time
      The timestamp of the most recent occasion at which datarecords
      suffered a discontinuity.  The time is absolute and not relative
      to sysUpTime.  Note that this parameter functionally corresponds
      to ipfixMeteringProcessDiscontinuityTime in the IPFIX MIB module
      [RFC6615].

   A cache object may refer to one or more exporting-process instances.

        +--rw cache* [name]
           +--rw name                        ietf-ipfix:name-type
           +--rw enabled                     boolean
           +--ro metering-process-id?        uint32
           +--ro data-records?               yang:counter64
           +--ro cache-discontinuity-time?   yang:date-and-time
           +--rw (cache-type)
           |  +--:(immediate-cache)

Boyd & Seda            Expires September 12, 2019              [Page 29]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |  |  +--rw immediate-cache {immediate-cache}?
           |  |     +--rw cache-layout
           |  |        +--rw cache-field* [name]
           |  |           +--rw name
           |  |           |       ietf-ipfix:name-type
           |  |           +--rw (information-element)
           |  |           |  +--:(ie-name)
           |  |           |  |  +--rw ie-name?
           |  |           |  |          ietf-ipfix:ie-name-type
           |  |           |  +--:(ie-id)
           |  |           |     +--rw ie-id?
           |  |           |             ietf-ipfix:ie-id-type
           |  |           +--rw ie-length?              uint16
           |  |           +--rw ie-enterprise-number?   uint32
           |  |           +--rw is-flow-key?            empty
           |  +--:(timeout-cache)
           |  |  +--rw timeout-cache {timeout-cache}?
           |  |     +--rw max-flows?              uint32
           |  |     +--rw active-timeout?         uint32
           |  |     +--rw idle-timeout?           uint32
           |  |     +--rw export-interval?        uint32
           |  |     +--rw cache-layout
           |  |     |  +--rw cache-field* [name]
           |  |     |     +--rw name
           |  |     |     |       ietf-ipfix:name-type
           |  |     |     +--rw (information-element)
           |  |     |     |  +--:(ie-name)
           |  |     |     |  |  +--rw ie-name?
           |  |     |     |  |          ietf-ipfix:ie-name-type
           |  |     |     |  +--:(ie-id)
           |  |     |     |     +--rw ie-id?
           |  |     |     |             ietf-ipfix:ie-id-type
           |  |     |     +--rw ie-length?              uint16
           |  |     |     +--rw ie-enterprise-number?   uint32
           |  |     |     +--rw is-flow-key?            empty
           |  |     +--ro active-flows?           yang:gauge32
           |  |     +--ro unused-cache-entries?   yang:gauge32
           |  +--:(natural-cache)
           |  |  +--rw natural-cache {natural-cache}?
           |  |     +--rw max-flows?              uint32
           |  |     +--rw active-timeout?         uint32
           |  |     +--rw idle-timeout?           uint32
           |  |     +--rw export-interval?        uint32
           |  |     +--rw cache-layout
           |  |     |  +--rw cache-field* [name]
           |  |     |     +--rw name
           |  |     |     |       ietf-ipfix:name-type
           |  |     |     +--rw (information-element)

Boyd & Seda            Expires September 12, 2019              [Page 30]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |  |     |     |  +--:(ie-name)
           |  |     |     |  |  +--rw ie-name?
           |  |     |     |  |          ietf-ipfix:ie-name-type
           |  |     |     |  +--:(ie-id)
           |  |     |     |     +--rw ie-id?
           |  |     |     |             ietf-ipfix:ie-id-type
           |  |     |     +--rw ie-length?              uint16
           |  |     |     +--rw ie-enterprise-number?   uint32
           |  |     |     +--rw is-flow-key?            empty
           |  |     +--ro active-flows?           yang:gauge32
           |  |     +--ro unused-cache-entries?   yang:gauge32
           |  +--:(permanent-cache)
           |     +--rw permanent-cache {permanent-cache}?
           |        +--rw max-flows?              uint32
           |        +--rw active-timeout?         uint32
           |        +--rw idle-timeout?           uint32
           |        +--rw export-interval?        uint32
           |        +--rw cache-layout
           |        |  +--rw cache-field* [name]
           |        |     +--rw name
           |        |     |       ietf-ipfix:name-type
           |        |     +--rw (information-element)
           |        |     |  +--:(ie-name)
           |        |     |  |  +--rw ie-name?
           |        |     |  |          ietf-ipfix:ie-name-type
           |        |     |  +--:(ie-id)
           |        |     |     +--rw ie-id?
           |        |     |             ietf-ipfix:ie-id-type
           |        |     +--rw ie-length?              uint16
           |        |     +--rw ie-enterprise-number?   uint32
           |        |     +--rw is-flow-key?            empty
           |        +--ro active-flows?           yang:gauge32
           |        +--ro unused-cache-entries?   yang:gauge32
           +--rw exporting-process*
                   -> /ietf-ipfix:ipfix/exporting-process/name
                   {ietf-ipfix:exporter}?

                        Figure 9: Cache Attributes

4.3.1.  Immediate Cache Type Class

   The immediate-cache type class depicted in Figure 9 is used to
   configure a cache that 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 cache-layout, which is
   defined below in Section 4.3.3.

Boyd & Seda            Expires September 12, 2019              [Page 31]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

4.3.2.  Timeout Cache, Natural Cache, and Permanent Cache Type Class

   Figure 9 shows the timeout-cache, natural-cache, and permanent-cache
   type classes.  These classes are used to configure a cache that
   aggregates the packets at its input and generates IPFIX flow records.
   The three classes differ in when flows expire:

   timeout-cache
      Flows expire after active or idle timeout.

   natural-cache
      Flows expire after active or idle timeout, or on natural
      termination (e.g., TCP FIN or TCP RST) of the flow.

   permanent-cache
      Flows never expire, but are periodically exported with the
      interval set by export-interval.

   The following configuration and state parameters are common to the
   three classes:

   max-flows
      This parameter configures the maximum number of entries in the
      cache, which is the maximum number of flows that can be measured
      simultaneously.  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 that pertains to existing flows can
      continue to be measured.

   active-flows
      This state parameter indicates the number of flows currently
      active in this cache (i.e., the number of cache entries currently
      in use).  Note that this parameter corresponds to
      ipfixmeteringprocesscacheactiveflows in the IPFIX MIB module
      [RFC6615].

   unused-cache-entries
      The number of unused cache entries.  Note that the sum of active-
      flows and unused-cache-entries equals max-flows if max-flows is
      configured.  Note that this parameter corresponds to
      ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX MIB
      module [RFC6615].

   The following timeout parameters are only available in the timeout-
   cache and the natural-cache cache-types:

Boyd & Seda            Expires September 12, 2019              [Page 32]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   active-timeout
      This parameter configures the time in secondsafter 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 [RFC6615].

   idle-timeout
      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 [RFC6615].

   The following interval parameter is only available in the permanent-
   cache class:

   export-interval
      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.

   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.

   An object of the cache class contains an object of the cache-layout
   class that defines which fields are included in the flow records.

4.3.3.  Cache Layout Class

   A cache generates and maintains packet reports or flow records
   containing information that has been extracted from the incoming
   stream of packets.  Using the cache-field class, the cache-layout
   class specifies the superset of fields that are included in the
   packet reports or flow records (see Figure 9).

   If packet reports are generated (i.e., if immediate-cache 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

Boyd & Seda            Expires September 12, 2019              [Page 33]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   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.

   For example, if a field is configured to contain the TCP source port
   (information element tcpsourceport [IANA-IPFIX]), the field must be
   included in all packet reports that 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 [IANA-IPFIX]).

   If flow records are generated (i.e., if timeout-cache, natural-cache,
   or permanent-cache 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 the same flow record that the
   field value was not determined from the packet.  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.

   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.

   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 [RFC7012] 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.

Boyd & Seda            Expires September 12, 2019              [Page 34]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   The cache-layout class does not have any parameters.  The
   configuration parameters of the cache-field class (under cache-
   layout) are as follows:

   ie-id
      Specifies the information element identifier to be used.  Either
      ie-id or ie-name must be specified.

   ie-name
      Specifies the information element name to be used.  Either ie-id
      or ie-name must be specified.

   ie-enterprise-number
      Specifies the enterprise id of the ie-id or ie-name.  If the ie-
      enterprise-number is zero (which is the default), this information
      element is registered in the IANA registry of IPFIX information
      elements [IANA-IPFIX].  A non-zero value of ie-enterprise-number
      specifies an enterprise-specific information element
      [IANA-ENTERPRISE-NUMBERS].  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].

   ie-length
      This parameter specifies the length of the field in octets.  A
      value of 65535 means that the field is encoded as 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 (see [RFC7011], section 6.2).
      If not configured by the user, the field length is set by the
      monitoring device.

   is-flow-key
      If present, this field is a flow key.  If the field contains a
      reverse information element, it must not be configured as flow
      key.  This parameter is not available if the cache is configured
      using the immediate-cache class since there is no distinction
      between flow key fields and non-key fields in packet reports.

   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 Section 5, the monitoring
   device must notify the user if a cache field cannot be configured
   with the given information element.

Boyd & Seda            Expires September 12, 2019              [Page 35]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

4.4.  Exporting Process Class

   The exporting-process class in Figure 10) specifies destinations to
   which the incoming packet reports and flow records are exported using
   objects of the destination class.  The destination class includes a
   choice of type of exporter (sctp-exporter, udp-exporter, tcp-
   exporter, or file-writer) which contains further configuration
   parameters.  Those exporter type classes are described in
   Section 4.4.1, Section 4.4.2, Section 4.4.3, and Section 4.4.4.

   The exporting-process class contains the identifier of the exporting
   process (exporting-process-id).  This parameter corresponds to the
   information element exportingprocessid [IANA-IPFIX].  Its occurrence
   helps to associate exporting process reliability statistics exported
   according to the IPFIX protocol specification [RFC7011] with the
   corresponding object of the exporting-process class.

   The order in which destination instances appear has a specific
   meaning only if the export-mode parameter is set to "fallback".  The
   export-mode parameter is defined as follows:

   enabled
      Enables the exporting process to begin exporting data.  The
      default is "enabled".

   export-mode
      Determines to which configured destination(s) the incoming data
      records are exported.  The following parameter values are
      specified by the configuration data model:

      *  parallel: every data record is exported to all configured
         destinations in parallel

      *  load-balancing: every data record is exported to exactly one
         configured destination according to a device-specific load-
         balancing policy

      *  fallback: every data record is exported to exactly one
         configured destination according to the fallback policy
         described below

   If export-mode is set to "fallback", the first destination instance
   defines the primary destination, the second destination instance
   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.
   "parallel" is the default value if exportmode is not configured.

Boyd & Seda            Expires September 12, 2019              [Page 36]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   Note that the export-mode parameter is related to the
   ipfixExportMemberType object in [RFC6615].  If export-mode is
   "parallel", the ipfixExportMemberType values of the corresponding
   entries in IpfixExportTable are set to parallel(3).  If export-mode
   is "load-balancing", the ipfixExportMemberType values of the
   corresponding entries in IpfixExportTable are set to
   loadBalancing(4).  If exportmode is "fallback", the
   ipfixExportMemberType value that refers to the primary destination is
   set to primary(1); the ipfixExportMemberType values that 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.

   The reporting of information with options templates is defined with
   objects of the options class.

   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 [RFC7011].  The exporting process
   may also export certain fields in a separate data record as described
   in [RFC5476].

        +--rw exporting-process* [name] {exporter}?
           +--rw name                    name-type
           +--rw enabled?                boolean
           +--rw export-mode?            identityref
           +--rw destination* [name]
           |  +--rw name                   name-type
           |  +--rw (destination-parameters)
           |     +--:(tcp-exporter)
           |         ...
           |     +--:(udp-exporter)
           |         ...
           |     +--:(sctp-exporter)
           |         ...
           |     +--:(file-writer)
           |         ...
           +--rw options* [name]
           |  +--rw name               name-type
           |  +--rw options-type       identityref
           |  +--rw options-timeout?   uint32
           +--ro exporting-process-id?   uint32

                    Figure 10: Exporting Process Class

Boyd & Seda            Expires September 12, 2019              [Page 37]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

4.4.1.  SCTP Exporter Class

   The sctp-exporter class shown in Figure 11 contains the configuration
   parameters of an SCTP export destination.  The configuration
   parameters are:

   ipfix-version
      Version number of the IPFIX protocol used.  If omitted, the
      default value is 10 (=0x000a) as specified in [RFC7011].

   source-address
      List of source IP addresses used by the exporting process.  If
      configured, the specified addresses are eligible local IP
      addresses of the multihomed SCTP endpoint.  If not configured, all
      locally assigned IP addresses are eligible local IP addresses.

   destination-address
      One or more 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.

   destination-port
      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.

   if-index
      The index 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 [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.

   if-name
      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 [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.

   send-buffersize
      Size of the socket send buffer in bytes.  If not configured by the
      user, the buffer size is set by the monitoring device.

Boyd & Seda            Expires September 12, 2019              [Page 38]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   rate-limit
      Maximum number of bytes per second the exporting process may
      export to the given destination as required by [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.

   timed-reliability
      Lifetime in milliseconds until an IPFIX message containing data
      sets only is "abandoned" due to the timed reliability mechanism of
      the partial reliability extension of SCTP (pr-SCTP) [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
      [RFC6526].

   Using the transport-layer-security class described in Section 4.6,
   Datagram Transport Layer Security (DTLS) is enabled and configured
   for this export destination.

   The Transport-Session class is discussed in Section 4.7.

Boyd & Seda            Expires September 12, 2019              [Page 39]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--:(sctp-exporter)
           +--rw sctp-exporter {sctp-transport}?
              +--rw ipfix-version?               uint16
              +--rw destination-port?
              |       inet:port-number
              +--rw send-buffer-size?            uint32
              +--rw rate-limit?                  uint32
              +--rw transport-layer-security!
              |     ...
              +--rw source
              |  +--rw (source-method)?
              |     +--:(source-address)
              |     |  +--rw source-address?   inet:host
              |     +--:(interface-ref)
              |     |  +--rw interface-ref?    if:interface-ref
              |     +--:(if-index) {if-mib}?
              |     |  +--rw if-index?         uint32
              |     +--:(if-name) {if-mib}?
              |        +--rw if-name?          string
              +--rw destination
              |  +--rw (destination-method)
              |     +--:(destination-address)
              |        +--rw destination-address?   inet:host
              +--rw timed-reliability?           uint32
              +--ro transport-session
                    ...

                      Figure 11: SCTP Exporter Class

4.4.2.  UDP Exporter Class

   The udp-exporter class shown in Figure 12 contains the configuration
   parameters of a UDP export destination.  The parameters ipfix-
   version, destination-port, if-name, if-index, send-buffer-size, and
   rate-limit have the same meaning as in the sctp-exporter class (see
   Section 4.4.1).  The remaining configuration parameters are:

   source-address
      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 the source IP
      address.

   destination-address
      Destination IP address to which IPFIX messages are sent (i.e., the
      IP address of the collecting process).

Boyd & Seda            Expires September 12, 2019              [Page 40]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   max-packet-size
      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.

   template-refresh-timeout
      This parameter specifies when templates are refreshed by the
      exporting process.  This timeout is specified in seconds between
      re-sending of templates.  If omitted, the default value of 600
      seconds (10 minutes) is used [RFC7011].  This parameter
      corresponds to ipfixTransportSessionTemplateRefreshTimeout in the
      IPFIX MIB module [RFC6615].

   options-template-refresh-timeout
      This parameter specifies when options templates are refreshed by
      the exporting process.  This timeout is specified in seconds
      between re-sending of options templates.  If omitted, the default
      value of 600 seconds (10 minutes) is used [RFC7011].  This
      parameter corresponds to
      ipfixTransportSessionOptionsTemplateRefreshTimeout in the IPFIX
      MIB module [RFC6615].

   template-refresh-packet
      This parameter specifies the number of IPFIX messages after which
      templates are re-sent.  If omitted, the templates are only resent
      after timeout.  This parameter corresponds to
      ipfixTransportSessionTemplateRefreshTimeout in the IPFIX MIB
      module [RFC6615].

   options-template-refresh-packet
      This parameter specifies the number of IPFIX messages after which
      options templates are re-sent.  If omitted, the options templates
      are only resent after timeout.  This parameter corresponds to
      ipfixTransportSessionOptionsTemplateRefreshTimeout in the IPFIX
      MIB module [RFC6615].

   Note that the values configured for template-refresh-timeout and
   options-template-refresh-timeout must be adapted to the template-
   lifetime and options-template-lifetime parameter settings at the
   receiving collecting process (see Section 4.5.2).

   Using the transport-layer-security class described in Section 4.6,
   DTLS is enabled and configured for this export destination.  The
   transport-session class is specified in Section 4.7.

Boyd & Seda            Expires September 12, 2019              [Page 41]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--:(udp-exporter)
           +--rw udp-exporter {udp-transport}?
              +--rw ipfix-version?                      uint16
              +--rw destination-port?
              |       inet:port-number
              +--rw send-buffer-size?                   uint32
              +--rw rate-limit?                         uint32
              +--rw transport-layer-security!
              |     ...
              +--rw source
              |  +--rw (source-method)?
              |     +--:(source-address)
              |     |  +--rw source-address?   inet:host
              |     +--:(interface-ref)
              |     |  +--rw interface-ref?    if:interface-ref
              |     +--:(if-index) {if-mib}?
              |     |  +--rw if-index?         uint32
              |     +--:(if-name) {if-mib}?
              |        +--rw if-name?          string
              +--rw destination
              |  +--rw (destination-method)
              |     +--:(destination-address)
              |        +--rw destination-address?   inet:host
              +--rw maximum-packet-size?                uint16
              +--rw template-refresh-timeout?           uint32
              +--rw options-template-refresh-timeout?   uint32
              +--rw template-refresh-packet?            uint32
              +--rw options-template-refresh-packet?    uint32
              +--ro transport-session
                 ....

                       Figure 12: UDP Exporter Class

4.4.3.  TCP Exporter Class

   The tcp-exporter class shown in Figure 13 contains the configuration
   parameters of a TCP export destination.  The parameters have the same
   meaning as in the udp-exporter class (see Section 4.4.2).

   Using the transport-layer-security class described in Section 4.6,
   Transport Layer Security (TLS) is enabled and configured for this
   export destination.

   The transport-session class is specified in Section 4.7.

Boyd & Seda            Expires September 12, 2019              [Page 42]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--:(tcp-exporter)
           +--rw tcp-exporter {tcp-transport}?
              +--rw ipfix-version?               uint16
              +--rw destination-port?
              |       inet:port-number
              +--rw send-buffer-size?            uint32
              +--rw rate-limit?                  uint32
              +--rw transport-layer-security!
              |     ...
              +--rw source
              |  +--rw (source-method)?
              |     +--:(source-address)
              |     |  +--rw source-address?   inet:host
              |     +--:(interface-ref)
              |     |  +--rw interface-ref?    if:interface-ref
              |     +--:(if-index) {if-mib}?
              |     |  +--rw if-index?         uint32
              |     +--:(if-name) {if-mib}?
              |        +--rw if-name?          string
              +--rw destination
              |  +--rw (destination-method)
              |     +--:(destination-address)
              |        +--rw destination-address?   inet:host
              +--ro transport-session

                       Figure 13: TCP Exporter Class

4.4.4.  File Writer Class

   If file-writer instance is included in an object of the destination
   class, IPFIX messages are written into a file as specified in
   [RFC5655].  The file-writer class contains the following
   configuration parameters:

   ipfix-version
      Version number of the IPFIX protocol used.  If omitted, the
      default value is 10 (=0x000a) as specified in [RFC7011].

   file
      File name and location specified as URI.

   The state parameters of the file-writer class are:

   bytes, messages, records, templates, options-templates
      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-

Boyd & Seda            Expires September 12, 2019              [Page 43]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      initialization of the management system, and at other times as
      indicated by the value of file-writer-discontinuity-time.

   discarded-messages
      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 file-writer-discontinuity-time.

   file-writer-discontinuity-time
      Timestamp of the most recent occasion at which one or more file
      writer counters suffered a discontinuity.  The time is absolute
      and not relative to sysUpTime.

   Each file-writer class instance includes statistics about the
   templates written to the file.  The template class is specified in
   Section 4.8.

Boyd & Seda            Expires September 12, 2019              [Page 44]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--:(file-writer)
           +--rw file-writer {file-writer}?
              +--rw ipfix-version?       uint16
              +--rw file                 inet:uri
              +--ro file-writer-state
                 +--ro bytes?
                 |       yang:counter64
                 +--ro messages?
                 |       yang:counter64
                 +--ro discarded-messages?
                 |       yang:counter64
                 +--ro records?
                 |       yang:counter64
                 +--ro templates?
                 |       yang:counter32
                 +--ro options-templates?
                 |       yang:counter32
                 +--ro file-writer-discontinuity-time?
                 |       yang:date-and-time
                 +--ro template* []
                    +--ro observation-domain-id?         uint32
                    +--ro template-id?                   uint16
                    +--ro set-id?                        uint16
                    +--ro access-time?
                    |       yang:date-and-time
                    +--ro template-data-records?
                    |       yang:counter64
                    +--ro template-discontinuity-time?
                    |       yang:date-and-time
                    +--ro field* []
                       +--ro ie-id?                  ie-id-type
                       +--ro ie-length?              uint16
                       +--ro ie-enterprise-number?   uint32
                       +--ro is-flow-key?            empty
                       +--ro is-scope?               empty

                       Figure 14: File Writer Class

4.4.5.  Options Class

   The options class in Figure 15 defines the type of specific
   information to be reported, such as statistics, flow keys, sampling
   and filtering parameters, etc.  [RFC7011] and [RFC5476] specify
   several types of reporting information that may be exported.  The
   following parameter values are specified by the configuration data
   model:

   metering-statistics

Boyd & Seda            Expires September 12, 2019              [Page 45]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      Export of metering process statistics using the metering process
      statistics options template [RFC7011].

   metering-reliability
      Export of metering process reliability statistics using the
      metering process reliability statistics options template
      [RFC7011].

   exporting-reliability
      Export of exporting process reliability statistics using the
      exporting process reliability statistics options template
      [RFC7011].

   flow-keys
      Export of the flow key specification using the flow keys options
      template [RFC7011].

   selection-sequence
      Export of selection sequence report interpretation and selector
      report interpretation [RFC5476].

   selection-statistics
      Export of selection sequence statistics report interpretation
      [RFC5476].

   accuracy
      Export of accuracy report interpretation [RFC5476].

   reducing-redundancy
      Enables the utilization of options templates to reduce redundancy
      in the exported data records according to [RFC5473].  The
      exporting process decides when to apply these options templates.

   extended-type-information
      Export of extended type information for enterprise-specific
      information elements used in the exported templates [RFC5610].

   The exporting process must choose a template definition according to
   the options type and available options data.  The options-timeout
   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 flow-keys, selection-sequence, accuracy,
   and reducing-redundancy.  If options-timeout is not configured by the
   user, it is set by the monitoring device.

Boyd & Seda            Expires September 12, 2019              [Page 46]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--rw options* [name]
           +--rw name               name-type
           +--rw options-type       identityref
           +--rw options-timeout?   uint32

                         Figure 15: Options Class

4.5.  Collecting Process Class

   Figure 16 shows the collecting-process class that contains the
   configuration and state parameters of a collecting process.  The
   sctp-collector, udp-collector, and tcp-collector classes specify how
   IPFIX messages are received from remote exporters.  The collecting
   process can also be configured as a file reader using the file-reader
   class.  These classes are described in Section 4.5.1, Section 4.5.2,
   Section 4.5.3, and Section 4.5.4.

   A collecting-process instance may refer to one or more exporting-
   process instances configuring exporting processes that export the
   received data without modifications to a file or to another remote
   collector.

        +--rw collecting-process* [name] {collector}?
           +--rw name                 name-type
           +--rw tcp-collector* [name] {tcp-transport}?
              ...
           +--rw udp-collector* [name] {udp-transport}?
              ...
           +--rw sctp-collector* [name] {sctp-transport}?
              ...
           +--rw file-reader* [name] {file-reader}?
              ...
           +--rw exporting-process*   -> /ipfix/exporting-process/name
                   {exporter}?

                    Figure 16: Collecting Process Class

4.5.1.  SCTP Collector Class

   The sctp-collector class contains the configuration parameters of a
   listening SCTP socket at a collecting process.  The parameters are:

   local-ip-address
      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 multihomed SCTP endpoint [RFC4960].  IF
      omitted, the collecting process listens on all local IP addresses.

Boyd & Seda            Expires September 12, 2019              [Page 47]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   local-port
      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.

   Using the transport-layer-security class described in Section 4.6,
   DTLS is enabled and configured for this receiving socket.

   The transport-session class is specified in Section 4.7.

        +--rw sctp-collector* [name] {sctp-transport}?
           +--rw name                        name-type
           +--rw local-port?                 inet:port-number
           |     +--rw transport-layer-security!
           |     |     ...
           +--rw (local-address-method)?
           |  +--:(local-address)
           |     +--rw local-address*        inet:host
           +--ro transport-session* [name]
               ...

                      Figure 17: SCTP Collector Class

4.5.2.  UDP Collector Class

   The udp-collector class contains the configuration parameters of a
   listening UDP socket at a collecting process.  The parameter local-
   port has the same meaning as in the sctp-collector class (see
   Section 4.5.1).  The remaining parameters are:

   local-ip-address
      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.

   template-life-time, options-template-life-time
      (options) template lifetime in seconds for all UDP transport
      sessions terminating at this UDP socket.  (options) templates that
      are not received again within the configured lifetime become
      invalid at the collecting process.  As specified in [RFC7011],
      section 10.3.7, the lifetime of templates and options templates
      must be at least three times higher than the template-refresh-
      timeout and option-templates-refresh-timeout parameter values
      configured on the corresponding exporting processes.  If not
      configured, the default value 1800 is used, which is three times
      the default (options) template refresh timeout (see Section 4.4.2)
      as specified in [RFC7011].  Note that these parameters correspond
      to ipfixTransportSessionTemplateRefreshTimeout and

Boyd & Seda            Expires September 12, 2019              [Page 48]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      ipfixTransportSessionOptionsTemplateRefreshTimeout in the IPFIX
      MIB module [RFC6615].

   template-life-packet, options-template-life-packet
      If template-life-packet 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 template-lifetime.
      Similarly, if options-template-life-packet 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 options-template-
      lifetime.  If not configured, templates and options templates only
      become invalid according to the lifetimes specified by template-
      lifetime and options-template-lifetime, respectively.  Note that
      these parameters correspond to
      ipfixTransportSessionTemplateRefreshPacket and
      ipfixTransportSessionOptionsTemplateRefreshPacket in the IPFIX MIB
      module [RFC6615].

   Using the transport-layer-security class described in Section 4.6,
   DTLS is enabled and configured for this receiving socket.

   The transport-session class is specified in Section 4.7.

        +--rw udp-collector* [name] {udp-transport}?
           +--rw name                            name-type
           +--rw local-port?                     inet:port-number
           +--rw transport-layer-security!
           |     ...
           +--rw (local-address-method)?
           |  +--:(local-address)
           |     +--rw local-address*            inet:host
           +--rw template-life-time?             uint32
           +--rw options-template-life-time?     uint32
           +--rw template-life-packet?           uint32
           +--rw options-template-life-packet?   uint32
           +--ro transport-session* [name]
              ...

                      Figure 18: UDP Collector Class

4.5.3.  TCP Collector Class

   The tcp-collector class contains the configuration parameters of a
   listening TCP socket at a collecting process.  The parameters have
   the same meaning as in the udp-collector class (Section 4.5.2).

Boyd & Seda            Expires September 12, 2019              [Page 49]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   Using the transport-layer-security class described in Section 4.6,
   TLS is enabled and configured for this receiving socket.

   The transport-session class is specified in Section 4.7.

        +--rw tcp-collector* [name] {tcp-transport}?
           +--rw name                        name-type
           +--rw local-port?                 inet:port-number
           +--rw transport-layer-security!
           |     ...
           +--rw (local-address-method)?
           |  +--:(local-address)
           |     +--rw local-address*        inet:host
           +--ro transport-session* [name]
             ...

                      Figure 19: TCP Collector Class

4.5.4.  File Reader Class

   The collecting process may import IPFIX messages from a file as
   specified in [RFC5655].  The file-reader class defines the following
   configuration parameter:

   file
      File name and location specified as URI.

   The state parameters of the file-reader class are:

   bytes, messages, records, templates, options-templates
      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 file-reader-discontinuity-time.

   file-reader-discontinuity-time
      Timestamp of the most recent occasion at which one or more file
      reader counters suffered a discontinuity.  The time is absolute
      and not relative to sysUpTime.

   The file-reader class includes information about the template class
   and statistics.  The template class is specified in Section 4.8.

Boyd & Seda            Expires September 12, 2019              [Page 50]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--rw file-reader* [name] {file-reader}?
           +--rw name                 name-type
           +--rw file                 inet:uri
           +--ro file-reader-state
              +--ro bytes?                            yang:counter64
              +--ro messages?                         yang:counter64
              +--ro records?                          yang:counter64
              +--ro templates?                        yang:counter32
              +--ro options-templates?                yang:counter32
              +--ro file-reader-discontinuity-time?
              |       yang:date-and-time
              +--ro template* []
                 ...

                       Figure 20: File Reader Class

4.6.  Transport Layer Security Class

   The transport-layer-security class is used in the exporting process's
   sctp-exporter, udp-exporter, and tcp-exporter classes, and the
   collecting process's sctp-collector, udp-collector, and tcp-collector
   classes to enable and configure TLS/DTLS for IPFIX.  If TLS/DTLS is
   enabled, the endpoint must use DTLS [RFC6347] if the transport
   protocol is SCTP or UDP and TLS [RFC8446] if the transport protocol
   is TCP.

   [RFC7011] mandates strong mutual authentication of exporting
   processes and collecting process as follows.  IPFIX exporting
   processes and IPFIX collecting processes are identified by the fully
   qualified domain name (FQDN) of the interface on which IPFIX messages
   are sent or received, for purposes of X.509 client and server
   certificates as in [RFC5280].  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.

   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.

Boyd & Seda            Expires September 12, 2019              [Page 51]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   In order to use TLS/DTLS, 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 TLS/
   DTLS is enabled on a monitoring device that does not dispose of
   appropriate certificates and keys, the configuration must be rejected
   with an error.

   The configuration data model allows restricting the authorization of
   remote endpoints to certificates issued by specific certification
   authorities or identifying specific fqdns 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.

   The configuration parameters are defined as follows:

   local-certification-authority-dn
      This parameter may appear one or more 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.  To identify
      the local endpoint, the exporting process or collecting process
      must use a certificate issued by one of the configured
      certification authorities.  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.  If local-
      certification-authority-dn is not configured, the choice of
      certificates identifying the local endpoint is not restricted with
      respect to the issuing certification authority.

   local-subject-dn, local-subject-fqdn
      Each of these parameters may appear one or more times to restrict
      the identification of the local endpoint during the TLS/DTLS
      handshake to certificates issued for specific subjects or for
      specific FQDNs.  Each occurrence of local-subject-dn contains a
      distinguished name identifying the local endpoint.  Each
      occurrence of local-subject-fqdn contains a FQDN which is assigned
      to the local endpoint.  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 FQDNs in a
      dnsname component of the subject alternative extension field or in
      the most specific commonname component of the subject field.  If

Boyd & Seda            Expires September 12, 2019              [Page 52]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      none of the certificates installed on the monitoring device
      fulfills the specified restrictions, the configuration must be
      rejected with an error.  If any of the parameters local-subject-dn
      and local-subject-fqdn is configured at the same time as the
      local-certification-authority-dn parameter, certificates must also
      fulfill the specified restrictions regarding the certification
      authority.  If local-subject-dn and local-subject-fqdn are not
      configured, the choice of certificates identifying the local
      endpoint is not restricted with respect to the subject's
      distinguished name or FQDN.

   remote-certification-authority-dn
      This parameter may appear one or more 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.  To
      authenticate the remote endpoint, the remote exporting process or
      collecting process must provide a certificate issued by one of the
      configured certification authorities.  Certificates issued by any
      other certification authority must be rejected during TLS/DTLS
      handshake.  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.  If remote-certification-authority-dn is
      not configured, the authorization of remote endpoints is not
      restricted with respect to the issuing certification authority of
      the delivered certificate.

   remote-subject-dn, remote-subject-fqdn
      Each of these parameters may appear one or more times to restrict
      the authentication of remote endpoints during the TLS/DTLS
      handshake to certificates issued for specific subjects or for
      specific FQDNs.  Each occurrence of remote-subject-dn contains a
      distinguished name identifying a remote endpoint.  Each occurrence
      of remote-subject-fqdn contains a FQDN that is assigned to a
      remote endpoint.  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 FQDNs in a
      dnsname component of the subject alternative extension field or in
      the most specific common name component of the subject field.
      Certificates not fulfilling this condition must be rejected during
      TLS/DTLS handshake.  If any of the parameters remote-subject-dn
      and remote-subject-fqdn is configured at the same time as the
      remote-certification-authority-dn parameter, certificates must
      also fulfill the specified restrictions regarding the
      certification authority in order to be accepted.  If remote-

Boyd & Seda            Expires September 12, 2019              [Page 53]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      subject-dn and remote-subject-FQDN are not configured, the
      authorization of remote endpoints is not restricted with respect
      to the subject's distinguished name or FQDN of the delivered
      certificate.

    +--rw transport-layer-security!
       +--rw local-certification-authority-dn*    string
       +--rw local-subject-dn*                    string
       +--rw local-subject-fqdn*                  inet:domain-name
       +--rw remote-certification-authority-dn*   string
       +--rw remote-subject-dn*                   string
       +--rw remote-subject-fqdn*                 inet:domain-name

                 Figure 21: Transport Layer Security Class

4.7.  Transport Session Class

   The transport-session class contains state data about transport
   sessions originating from an exporting process or terminating at a
   collecting process.  If SCTP is the transport protocol, the exporter
   or collector may be multihomed SCTP endpoints (see [RFC4960],
   Section 6.4), in which can more than one IP address will be used.

   The following attributes are supported:

   ipfix-version
      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 ipfix-version of the sctp-
      exporter, udp-exporter, or tcp-exporter object.  When 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.  This state
      parameter is identical to ipfixTransportSessionIpfixVersion in the
      IPFIX MIB module [RFC6615].

   source-address, destination-address
      If TCP or UDP is the transport protocol, source-address contains
      the IP address of the exporter, and destination-address contains
      the IP addresses of the collector.  Hence, the two parameters have
      identical values as ipfixTransportSessionSourceAddress and
      ipfixTransportSessionDestinationAddress in the IPFIX MIB module
      [RFC6615].  if SCTP is the transport protocol, source-address
      contains one of the IP addresses of the exporter and destination-
      address one of the IP addresses of the collector.  Preferably, the

Boyd & Seda            Expires September 12, 2019              [Page 54]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      IP addresses of the path that is usually selected by the exporter
      to send IPFIX messages to the collector should be contained.

   source-port, destination-port
      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
      [RFC6615].

   sctp-assoc-id
      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
      [RFC3871].  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.  This state parameter is identical to
      ipfixTransportSessionSctpAssocId in the IPFIX MIB module
      [RFC6615].

   status
      Status of the transport session, which can be one of the
      following:

      *  inactive: transport session is established, but no IPFIX
         messages are currently transferred (e.g., because this is a
         backup (secondary) session)

      *  active: transport session is established and transfers IPFIX
         messages

      *  unknown: transport session status cannot be determined; this
         state parameter is identical to ipfixTransportSessionStatus in
         the IPFIX MIB module [RFC6615]

   rate
      The number of bytes per second transmitted by the exporting
      process or received by the collecting process.  This parameter is
      updated every second.  This state parameter is identical to
      ipfixtransportsessionrate in the IPFIX MIB module [RFC6615].

   bytes, messages, records, templates, options-templates
      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

Boyd & Seda            Expires September 12, 2019              [Page 55]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      management system, and at other times as indicated by the value of
      transport-session-discontinuity-time.

   discarded-messages
      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 messages 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 transport-session-
      discontinuity-time.

   transport-session-start-time
      Timestamp of the start of the given transport session.

   transport-session-discontinuity-time
      Timestamp of the most recent occasion at which one or more of the
      transport session counters suffered a discontinuity.  The time is
      absolute and not relative to sysUpTime.  Note that, if used for
      exporting processes, the values of the state parameters
      destination-address and destination-port match the values of the
      configuration parameters destination-ip-address and destination-
      port of the sctp-exporter, tcp-exporter, and udp-exporter (in the
      case of sctp-exporter, one of the configured destination-ip-
      address values); if the transport protocol is UDP or SCTP and if
      the parameter source-ip-address is configured in the udp-exporter
      or sctp-exporter object, the value of source-address equals the
      configured value or one of the configured values.  Used for
      collecting processes, the value of destination-address equals the
      value (or one of the values) of the parameter local-ip-address if
      this parameter is configured in the udp-collector, tcp-collector,
      or sctp-collector; destination-port equals the value of the
      configuration parameter local-port.

   The transport-session class includes template class information and
   statistics about the templates transmitted or received on the given
   transport session.  The template class is specified in Section 4.8.

Boyd & Seda            Expires September 12, 2019              [Page 56]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        +--ro transport-session* [name]
           +--ro name                                    name-type
           +--ro ipfix-version?                          uint16
           +--ro source-address?                         inet:host
           +--ro destination-address?                    inet:host
           +--ro source-port?
           |       inet:port-number
           +--ro destination-port?
           |       inet:port-number
           +--ro status?
           |       transport-session-status
           +--ro rate?
           |       yang:gauge32
           +--ro bytes?
           |       yang:counter64
           +--ro messages?
           |       yang:counter64
           +--ro discarded-messages?
           |       yang:counter64
           +--ro records?
           |       yang:counter64
           +--ro templates?
           |       yang:counter32
           +--ro options-templates?
           |       yang:counter32
           +--ro transport-session-start-time?
           |       yang:date-and-time
           +--ro transport-session-discontinuity-time?
           |       yang:date-and-time
           +--ro template* []
             ...

                    Figure 22: Transport Session Class

4.8.  Template Class

   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 [RFC6615]:

   observation-domain-id
      The identifier of the observation domain for which this template
      is defined.

Boyd & Seda            Expires September 12, 2019              [Page 57]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   template-id
      This number indicates the template identifier in the IPFIX
      Message.

   set-id
      This number indicates the set identifier of this template.
      Currently, there are two values defined [RFC7011].  The value 2 is
      used for sets containing template definitions.  The value 3 is
      used for sets containing options template definitions.

   access-time
      Used for exporting processes, this parameter contains the time
      when this (Options) Template was last sent to the Collector 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.

   template-data-records
      The number of transmitted or received data records defined by this
      (options) template since the point in time indicated by template-
      definition-time.

   template-discontinuity-time
      Timestamp of the most recent occasion at which the counter
      template-data-records suffered a discontinuity.  The time is
      absolute and not relative to sysUpTime.

   ie-id, ie-length, ie-enterprise-number
      Information Element identifier, length, and enterprise number of a
      field in the template.  If this is not an enterprise-specific
      Information Element, ie-enterprise-number is zero.  These state
      parameters are identical to ipfixTemplateDefinitionIeId,
      ipfixTemplateDefinitionIeLength, and
      ipfixTemplateDefinitionIeEnterpriseNumber in the IPFIX MIB module
      [RFC6615].

   is-flow-key
      If this state parameter is present, this is a flow key field.
      This parameter is only available for non-Options Templates (i.e.,
      if setId is 2).

   is-scope
      If this state parameter is present, this is a scope field.  This
      parameter is only available for options templates (i.e., if setId
      is 3).

Boyd & Seda            Expires September 12, 2019              [Page 58]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

    +--ro template* []
       +--ro observation-domain-id?         uint32
       +--ro template-id?                   uint16
       +--ro set-id?                        uint16
       +--ro access-time?                   yang:date-and-time
       +--ro template-data-records?         yang:counter64
       +--ro template-discontinuity-time?   yang:date-and-time
       +--ro field* []
          +--ro ie-id?                  ie-id-type
          +--ro ie-length?              uint16
          +--ro ie-enterprise-number?   uint32
          +--ro is-flow-key?            empty
          +--ro is-scope?               empty

                         Figure 23: Template Class

4.9.  Bulk Data Class

   The bulk data process class in Figure 24) specifies the bulk data
   template to be applied to resource or set of resources and provides
   state information about the template records.  The following
   attributes are supported:

   enabled
      Enables the template so that specified data may be exported.  The
      default is "enabled".

   export-interval
      The interval (in seconds) for periodical export of data records.

   observation-domain-id
      The Observation Domain that is locally unique to an Exporting
      Process

   field-layout
      The IPFIX template to be applied to the resource.  The following
      attributes are configurable:

      *  ie-id: Identifies the Information Element identifier.

      *  ie-enterprise-id: Identifies the enterprise identifier of the
         Information Element.  If 0, the enterprise ID is an IANA based
         Information Element.

      *  ie-length: Identifies the length of the Information Element.

   A bulk data instance may refer to:

Boyd & Seda            Expires September 12, 2019              [Page 59]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   o  one or more exporting-process instances

   o  one or more resource instances (e.g., different interface
      instances on a line card)

   The following state information is available;

   data-records
      Reports the number of data records generated for this bulk data
      template.

   discontinuity-time
      Timestamp of the most recent occasion at which the counter data
      records suffered a discontinuity.

        +--rw bulk-data-export
           +--rw template* [name]
              +--rw name                     ietf-ipfix:name-type
              +--rw enabled?                 boolean
              +--rw export-interval?         uint32
              +--rw observation-domain-id?   uint32
              +--rw field-layout
              |  +--rw field* [name]
              |     +--rw name                    ietf-ipfix:name-type
              |     +--rw (identifier)
              |     |  +--:(ie-id)
              |     |     +--rw ie-id?            ietf-ipfix:ie-id-type
              |     +--rw ie-length?              uint16
              |     +--rw ie-enterprise-number?   uint32
              +--rw exporting-process*
              |       -> /ietf-ipfix:ipfix/exporting-process/name
              |       {ietf-ipfix:exporter}?
              +--rw resource*                resource
              +--ro data-records?            yang:counter64
              +--ro discontinuity-time?      yang:date-and-time

                        Figure 24: Bulk Data Class

5.  Adaptation to Device Capabilities

   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 that 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

Boyd & Seda            Expires September 12, 2019              [Page 60]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   available memory on the device.  It is also possible that a
   monitoring device implementation requires the configuration of
   additional parameters that are not part of the configuration data
   model in order to function properly.

   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:

   exporter
      If this feature is supported, Exporting Processes can be
      configured.

   collector
      If this feature is supported, Collecting Processes can be
      configured.

   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:

   Additional features refer to different PSAMP Sampling and Filtering
   methods as well as to the supported types of Caches:

   psamp-samp-count-based
      If this feature is supported, Sampling method samp-count-based can
      be configured.

   psamp-samp-time-based
      If this feature is supported, Sampling method samp-time-based can
      be configured.

   psamp-samp-rand-out-of-n
      If this feature is supported, Sampling method samp-rand-out-of-n
      can be configured.

   psamp-samp-uni-prob
      If this feature is supported, Sampling method samp-uni-prob can be
      configured.

   psampfilter-match
      If this feature is supported, Filtering method filter-match can be
      configured.

   psamp-filter-hash

Boyd & Seda            Expires September 12, 2019              [Page 61]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

      If this feature is supported, Filtering method filter-hash can be
      configured.

   immediate-cache
      If this feature is supported, a Cache generating PSAMP Packet
      Reports can be configured using the Immediate Cache class.

   timeout-cache
      If this feature is supported, a Cache generating IPFIX Flow
      Records can be configured using the Timeout Cache class.

   natural-cache
      If this feature is supported, a Cache generating IPFIX Flow
      Records can be configured using the Natural Cache class.

   permanent-cache
      If this feature is supported, a Cache generating IPFIX Flow
      Records can be configured using the Permanent Cache class.

   The following features concern the support of UDP and TCP as
   transport protocols and the support of File Readers and File Writers:

   sctp-transport
      If this feature is supported, SCTP can be used as transport
      protocol by Exporting Processes and Collecting Processes.

   udp-transport
      If this feature is supported, UDP can be used as transport
      protocol by Exporting Processes and Collecting Processes.

   tcp-transport
      If this feature is supported, TCP can be used as transport
      protocol by Exporting Processes and Collecting Processes.

   file-reader
      If this feature is supported, File Readers can be configured as
      part of Collecting Processes.

   file-writer
      If this feature is supported, File Writers can be configured as
      part of Exporting Processes.

6.  YANG Modules

   This document defines three YANG modules:

   o  ietf-ipfix

Boyd & Seda            Expires September 12, 2019              [Page 62]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   o  ietf-psamp

   o  ietf-bulk-data-export

6.1.  ietf-ipfix

6.1.1.  ietf-ipfix Module Structure

   This document defines the YANG module "ietf-ipfix", which has the
   following structure:

   module: ietf-ipfix
     +--rw ipfix
        +--rw collecting-process* [name] {collector}?
        |  +--rw name                 name-type
        |  +--rw tcp-collector* [name] {tcp-transport}?
        |  |     ...
        |  +--rw udp-collector* [name] {udp-transport}?
        |  |     ...
        |  +--rw sctp-collector* [name] {sctp-transport}?
        |  |     ...
        |  +--rw file-reader* [name] {file-reader}?
        |  |     ...
        |  +--rw exporting-process*   -> /ipfix/exporting-process/name
        |          {exporter}?
        +--rw exporting-process* [name] {exporter}?
           +--rw name                    name-type
           +--rw enabled?                boolean
           +--rw export-mode?            identityref
           +--rw destination* [name]
           |     ...
           +--rw options* [name]
           |     ...
           +--ro exporting-process-id?   uint32

6.1.2.  ietf-ipfix YANG Module

   This YANG Module imports typedefs from [RFC6991].

   <CODE BEGINS> file "ietf-ipfix@2018-10-22.yang"

   module ietf-ipfix {
     yang-version 1.1;

     namespace "urn:ietf:params:xml:ns:yang:ietf-ipfix";

     prefix ietf-ipfix;

Boyd & Seda            Expires September 12, 2019              [Page 63]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     import ietf-inet-types {
       prefix inet;
     }

     import ietf-yang-types {
       prefix yang;
     }

     import ietf-interfaces {
       prefix if;
     }

     organization
       "IETF";

     contact
       "Web:      TBD
        List:     TBD

        Editor:   Joey Boyd
                  <mailto:joey.boyd@adtran.com>

        Editor:   Marta Seda
                  <mailto:marta.seda@calix.com>";

     // RFC Ed.: replace XXXX with actual RFC numbers and
     // remove this note.

     description
       "This module contains a collection of YANG definitions for the
        management of IP Flow Information Export (IPFIX).

        This data model is designed for the Network Management Datastore
        Architecture defined in RFC 8342.

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

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

        This version of this YANG module is part of XXXX; see the RFC
        itself for full legal notices.";

Boyd & Seda            Expires September 12, 2019              [Page 64]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     revision 2019-03-11 {
       description
         "Initial revision.";
       reference
         "RFC XXXX: YANG Data Models for the IP Flow Information Export
                    (IPFIX) Protocol, Packet Sampling (PSAMP) Protocol,
                    and Bulk Data Export";
     }

     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 tcp-transport {
       description
         "If supported, the Monitoring Device supports TCP
          as the transport protocol.";
     }

     feature udp-transport {
       description
         "If supported, the Monitoring Device supports UDP
          as the transport protocol.";
     }

     feature sctp-transport {
       description
         "If supported, the Monitoring Device supports SCTP
          as the transport protocol.";
     }

     feature file-reader {
       description
         "If supported, the Monitoring Device supports the
          configuration of Collecting Processes as File Readers.";
     }

     feature file-writer {
       description
         "If supported, the Monitoring Device supports the

Boyd & Seda            Expires September 12, 2019              [Page 65]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

          configuration of Exporting Processes as File Writers.";
     }

     feature if-mib {
       description
         "This feature indicates that the device implements
          the IF-MIB.";
       reference
         "RFC 2863: The Interfaces Group MIB";
     }

     identity export-mode {
       description
         "Base identity for different usages of export
          destinations configured for an Exporting Process.";
     }

     identity parallel {
       base export-mode;
       description
         "Parallel export of Data Records to all
          destinations configured for the Exporting Process.";
     }

     identity load-balancing {
       base export-mode;
       description
         "Load-balancing between the different destinations
          configured for the Exporting Process.";
     }

     identity fallback {
       base export-mode;
       description
         "Export to the primary destination (i.e., the first
          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.";
     }

     identity options-type {
       description
         "Base identity for report types exported with
          options templates.";
     }

Boyd & Seda            Expires September 12, 2019              [Page 66]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     identity metering-statistics {
       base options-type;
       description
         "Metering Process Statistics.";
       reference
         "RFC 5101, Section 4.1.";
     }

     identity metering-reliability {
       base options-type;
       description
         "Metering Process Reliability Statistics.";
       reference
         "RFC 5101, Section 4.2.";
     }

     identity exporting-reliability {
       base options-type;
       description
         "Exporting Process Reliability Statistics.";
       reference
         "RFC 5101, Section 4.3.";
     }

     identity flow-keys {
       base options-type;
       description
         "Flow Keys.";
       reference
         "RFC 5101, Section 4.4.";
     }

     identity selection-sequence {
       base options-type;
       description
         "Selection Sequence and Selector Reports.";
       reference
         "RFC 5476, Sections 6.5.1 and 6.5.2.";
     }

     identity selection-statistics {
       base options-type;
       description
         "Selection Sequence Statistics Report.";
       reference
         "RFC 5476, Sections 6.5.3.";
     }

Boyd & Seda            Expires September 12, 2019              [Page 67]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     identity accuracy {
       base options-type;
       description
         "Accuracy Report.";
       reference
         "RFC 5476, Section 6.5.4.";
     }

     identity reducing-redundancy {
       base options-type;
       description
         "Enables the utilization of Options Templates to
          reduce redundancy in the exported Data Records.";
       reference
         "RFC 5473.";
     }

     identity extended-type-information {
       base options-type;
       description
         "Export of extended type information for
          enterprise-specific Information Elements used in the
          exported Templates.";
       reference
         "RFC 5610.";
     }

     typedef ie-name-type {
       type string {
         length "1..max";
         pattern '\S+';
       }
       description
         "Type for Information Element names. Whitespaces
          are not allowed.";
     }

     typedef name-type {
       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.";
     }

Boyd & Seda            Expires September 12, 2019              [Page 68]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     typedef ie-id-type {
       type uint16 {
         range "1..32767";
       }
       description
         "Type for Information Element identifiers.";
     }

     typedef transport-session-status {
       type enumeration {
         enum "inactive" {
           value 0;
           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" {
           value 1;
           description
             "This value MUST be used for Transport Sessions
              that are currently active and transmitting or receiving
              data.";
         }
         enum "unknown" {
           value 2;
           description
             "This value MUST be used if the status of the
              Transport Sessions cannot be detected by the device.
              This value should be avoided as far as possible.";
         }
       }
       description
         "Status of a Transport Session.";
       reference
         "RFC 6615, Section 8 (ipfixTransportSessionStatus).";
     }

     grouping transport-layer-security-parameters {
       description
         "TLS or DTLS parameters.";

       leaf-list local-certification-authority-dn {
         type string;
         description
           "Distinguished names of certification authorities

Boyd & Seda            Expires September 12, 2019              [Page 69]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            whose certificates may be used to identify the local
            endpoint.";
         reference
           "RFC 5280.";
       }

       leaf-list local-subject-dn {
         type string;
         description
           "Distinguished names that may be used in the
            certificates to identify the local endpoint.";
         reference
           "RFC 5280.";
       }

       leaf-list local-subject-fqdn {
         type inet:domain-name;
         description
           "Fully qualified domain names that may be used to
            in the certificates to identify the local endpoint.";
         reference
           "RFC 5280.";
       }

       leaf-list remote-certification-authority-dn {
         type string;
         description
           "Distinguished names of certification authorities
            whose certificates are accepted to authorize remote
            endpoints.";
         reference
           "RFC 5280.";
       }

       leaf-list remote-subject-dn {
         type string;
         description
           "Distinguished names which are accepted in
            certificates to authorize remote endpoints.";
         reference
           "RFC 5280.";
       }

       leaf-list remote-subject-fqdn {
         type inet:domain-name;
         description
           "Fully qualified domain names that are accepted in
            certificates to authorize remote endpoints.";

Boyd & Seda            Expires September 12, 2019              [Page 70]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         reference
           "RFC 5280.";
       }
     }

     grouping transport-session-state-parameters {
       description
         "State parameters of a Transport Session originating
          from an Exporting Process or terminating at a Collecting
          Process.  Parameter names and semantics correspond to the
          managed objects in IPFIX-MIB.";
       reference
         "RFC 5101; RFC 6615, Section 8
          (ipfixTransportSessionEntry,
          ipfixTransportSessionStatsEntry).";

       leaf ipfix-version {
         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.

            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
           "RFC 6615, Section 8
            (ipfixTransportSessionIpfixVersion).";
       }

       leaf source-address {
         type inet:host;
         description
           "The source address of the Exporter of the
            IPFIX Transport Session.  ";
         reference
           "RFC 6615, Section 8
            (ipfixTransportSessionSourceAddressType,
            ipfixTransportSessionSourceAddress);
            RFC 4960, Section 6.4.";
       }

Boyd & Seda            Expires September 12, 2019              [Page 71]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       leaf destination-address {
         type inet:host;
         description
           "The destination address of the
            path that is selected by the Exporter to
            send IPFIX messages to the Collector.

            In the case of TCP, it is possible
            that if an FQDN address is configured it
            resolves into many addresses.

            Note that this parameter functionally corresponds to
            ipfixTransportSessionDestinationAddressType and
            ipfixTransportSessionDestinationAddress in the IPFIX MIB
            module.";
         reference
           "RFC 6615, Section 8
            (ipfixTransportSessionDestinationAddressType,
            ipfixTransportSessionDestinationAddress);
            RFC 4960, Section 6.4.";
       }

       leaf source-port {
         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
           "RFC 6615, Section 8
            (ipfixTransportSessionSourcePort).";
       }

       leaf destination-port {
         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
           "RFC 6615, Section 8
            (ipfixTransportSessionDestinationPort).";
       }

Boyd & Seda            Expires September 12, 2019              [Page 72]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       leaf status {
         type transport-session-status;
         description
           "Status of the Transport Session.

            Note that this parameter corresponds to
            ipfixTransportSessionStatus in the IPFIX MIB module.";
           reference
            "RFC 6615, 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
           "RFC 6615, 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
           "RFC 6615, 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.

Boyd & Seda            Expires September 12, 2019              [Page 73]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             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
            "RFC 6615, Section 8
             (ipfixTransportSessionMessages).";
       }

       leaf discarded-messages {
         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
            transport-session-discontinuity-time.

            Note that this parameter corresponds to
            ipfixTransportSessionDiscardedMessages in the IPFIX MIB
            module.";
         reference
           "RFC 6615, 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

Boyd & Seda            Expires September 12, 2019              [Page 74]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            ipfixTransportSessionRecords in the IPFIX MIB module.";
         reference
           "RFC 6615, 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
           "RFC 6615, Section 8
           (ipfixTransportSessionTemplates).";
       }

       leaf options-templates {
         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
           "RFC 6615, Section 8
            (ipfixTransportSessionOptionsTemplates).";
       }

       leaf transport-session-start-time {
         type yang:date-and-time;
         description
           "Timestamp of the start of the given Transport
            Session.

Boyd & Seda            Expires September 12, 2019              [Page 75]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            This state parameter does not correspond to any object in
            the IPFIX MIB module.";
       }

       leaf transport-session-discontinuity-time {
         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
           "RFC 6615, 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) Templates MUST be removed
            from this list.";

         uses template-parameters-state;
       }
     }

     grouping template-parameters-state {
       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
         "RFC 5101; RFC 6615, Section 8 (ipfixTemplateEntry,
          ipfixTemplateDefinitionEntry, ipfixTemplateStatsEntry)";

       leaf observation-domain-id {
         type uint32;
         description
           "The ID of the Observation Domain for which this

Boyd & Seda            Expires September 12, 2019              [Page 76]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            Template is defined.

            Note that this parameter corresponds to
            ipfixTemplateObservationDomainId in the IPFIX MIB module.";
         reference
           "RFC 6615, Section 8
            (ipfixTemplateObservationDomainId).";
       }

       leaf template-id {
         type uint16 {
           range "256..65535";
         }
         description
           "This number indicates the Template ID in the IPFIX
            message.
            Note that this parameter corresponds to ipfixTemplateId in
            the IPFIX MIB module.";
         reference
           "RFC 6615, Section 8 (ipfixTemplateId).";
       }

       leaf set-id {
         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
           "RFC 6615, Section 8 (ipfixTemplateSetId).";
       }

       leaf access-time {
         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

Boyd & Seda            Expires September 12, 2019              [Page 77]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           "RFC 6615, Section 8 (
            ipfixTemplateAccessTime).";
       }

       leaf template-data-records {
         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
           "RFC 6615, Section 8 (ipfixTemplateDataRecords).";
       }

       leaf template-discontinuity-time {
         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
           "RFC 6615, 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 ie-id {
           type ie-id-type;
           description
             "This parameter indicates the Information
              Element identifier of the field.

              Note that this parameter corresponds to
              ipfixTemplateDefinitionIeId in the IPFIX MIB module.";

Boyd & Seda            Expires September 12, 2019              [Page 78]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           reference
             "RFC 5101; RFC 6615, Section 8
              (ipfixTemplateDefinitionIeId).";
         }

         leaf ie-length {
           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
             "RFC 5101; RFC 6615, Section 8
              (ipfixTemplateDefinitionIeLength).";
         }

         leaf ie-enterprise-number {
           type uint32;
           description
             "This parameter indicates the IANA enterprise
              number of the authority defining the Information Element
              identifier.
              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
             "RFC 6615, Section 8
              (ipfixTemplateDefinitionIeEnterpriseNumber);
              IANA registry for Private Enterprise Numbers,
              http://www.iana.org/assignments/enterprise-numbers.";
         }

         leaf is-flow-key {
           when "../../set-id = 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.

Boyd & Seda            Expires September 12, 2019              [Page 79]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

              Note that this corresponds to flowKey(1) being set in
              ipfixTemplateDefinitionFlags.";
           reference
             "RFC 6615, Section 8
              (ipfixTemplateDefinitionFlags).";
         }

         leaf is-scope {
           when "../../set-id = 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
             "RFC 6615, Section 8
              (ipfixTemplateDefinitionFlags).";
         }
       }
     }

     grouping common-collector-parameters {
       description
         "Parameters of a Collecting Process that are
          common to all transport protocols.";

       leaf local-port {
         type inet:port-number;
         description
           "If not configured, the Monitoring Device uses the
            default port number for IPFIX, which is 4739 without
            TLS or DTLS and 4740 if TLS or DTLS is activated.";
       }

       container transport-layer-security {
         presence
           "The presence of this container indicates TLS is enabled.";
         description
           "TLS or DTLS configuration.";

         uses transport-layer-security-parameters;
       }

Boyd & Seda            Expires September 12, 2019              [Page 80]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     }

     grouping file-reader-state-parameters {
       description
         "State Parameters for the File Reader.";

       container file-reader-state {
         config false;
         description
           "File Reader parameters.";

         leaf bytes {
           type yang:counter64;
           units octets;
           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";
           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";
           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";
           description

Boyd & Seda            Expires September 12, 2019              [Page 81]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             "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 options-templates {
           type yang:counter32;
           units "Options Templates";
           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 file-reader-discontinuity-time {
           type yang:date-and-time;
           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 {
           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 template-parameters-state;
         }
       }
     }

     grouping tcp-collector-parameters {
       description
         "Parameters of a listening TCP socket at a
          Collecting Process.";

       uses common-collector-parameters;

Boyd & Seda            Expires September 12, 2019              [Page 82]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       choice local-address-method {
         description
           "Method to configure the local address
            of the collecting process.  Note that it is
            expected that other methods be available.  Those
            method can augment this choice.";

         case local-address {
           leaf-list local-address {
             type inet:host;
             description
               "List of local addresses on which the Collecting
                Process listens for IPFIX Messages.";
           }
         }
       }
     }

     grouping udp-collector-parameters {
       description
         "Parameters of a listening UDP socket at a
          Collecting Process.";

       uses common-collector-parameters;

       choice local-address-method {
         description
           "Method to configure the local address
            of the collecting process.  Note that it is
            expected that other methods be available.  Those
            method can augment this choice.";

         case local-address {
           leaf-list local-address {
             type inet:host;
             description
               "List of local addresses on which the Collecting
                Process listens for IPFIX Messages.";
           }
         }
       }

     leaf template-life-time {
         type uint32;
         units seconds;
         default 1800;
         description
           "Sets the lifetime of Templates for all UDP

Boyd & Seda            Expires September 12, 2019              [Page 83]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            Transport Sessions terminating at this UDP socket.
            Templates that are not received again within the configured
            lifetime become invalid at the Collecting Process.
            As specified in RFC 5101, 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
           "RFC 5101, Section 10.3.7; RFC 6615, Section 8
            (ipfixTransportSessionTemplateRefreshTimeout).";
       }

       leaf options-template-life-time {
         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 that are not received again within the
            configured lifetime become invalid at the Collecting
            Process.
            As specified in RFC 5101, 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
           "RFC 5101, Section 10.3.7; RFC 6615, Section 8
            (ipfixTransportSessionOptionsTemplateRefreshTimeout).";
       }

       leaf template-life-packet {
         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

Boyd & Seda            Expires September 12, 2019              [Page 84]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            MIB module.";
         reference
           "RFC 5101, Section 10.3.7; RFC 6615, Section 8
            (ipfixTransportSessionTemplateRefreshPacket).";
       }

       leaf options-template-life-packet {
         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
           "RFC 5101, Section 10.3.7; RFC 6615, Section 8
            (ipfixTransportSessionOptionsTemplateRefreshPacket).";
       }
     }

     grouping sctp-collector-parameters {
       description
         "Parameters of a listening SCTP socket at a
          Collecting Process.";

       uses common-collector-parameters;

       choice local-address-method {
         description
           "Method to configure the local address
            of the collecting process.  Note that it is
            expected that other methods be available.  Those
            method can augment this choice.";

         case local-address {
           leaf-list local-address {
             type inet:host;
             description
               "List of local addresses on which the Collecting
                Process listens for IPFIX Messages.";
           }
         }
       }

Boyd & Seda            Expires September 12, 2019              [Page 85]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     }

     grouping collecting-process-parameters {
       description
         "Parameters of a Collecting Process.";

       list tcp-collector {
         if-feature tcp-transport;
         key "name";
         description
           "List of TCP receivers (sockets) on which the
            Collecting Process receives IPFIX Messages.";

         leaf name {
           type name-type;
           description
             "Name of the TCP collector.";
         }

         uses tcp-collector-parameters;

         list transport-session {
           key name;
           config false;
           description
             "This list contains the currently established
              Transport Sessions terminating at the given socket.";

           leaf name {
             type name-type;
             description
               "The name of the transporter session.";
           }

           uses transport-session-state-parameters;
         }
       }

     list udp-collector {
         if-feature udp-transport;
         key "name";
         description
           "List of UDP receivers (sockets) on which the
            Collecting Process receives IPFIX Messages.";

         leaf name {
           type name-type;
           description

Boyd & Seda            Expires September 12, 2019              [Page 86]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             "Name of the UDP collector.";
         }

         uses udp-collector-parameters;

         list transport-session {
           key name;
           config false;
           description
             "This list contains the currently established
              Transport Sessions terminating at the given socket.";

           leaf name {
             type name-type;
             description
               "The name of the transporter session.";
           }

           uses transport-session-state-parameters;
         }
       }

       list sctp-collector {
         if-feature sctp-transport;
         key "name";
         description
           "List of SCTP receivers on which the
            Collecting Process receives IPFIX Messages.";

         leaf name {
           type name-type;
           description
             "Name of the SCTP collector.";
         }

         uses sctp-collector-parameters;

         list transport-session {
           key name;
           config false;
           description
             "This list contains the currently established
              Transport Sessions terminating at the given socket.";

           leaf name {
             type name-type;
             description
               "The name of the transporter session.";

Boyd & Seda            Expires September 12, 2019              [Page 87]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           }

           leaf sctp-association-id {
             type uint32;
             config false;
             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
               "RFC 6615, Section 8
                (ipfixTransportSessionSctpAssocId);
                RFC 3871";
           }

           uses transport-session-state-parameters;
         }
       }

       list file-reader {
         if-feature file-reader;
         key "name";
         description
           "List of File Readers from which the
            Collecting Process reads the IPFIX Messages.";

         leaf name {
           type name-type;
           description
             "Name of the File Reader.";
         }

         leaf file {
           type inet:uri;
           mandatory true;
           description
             "URI specifying the location of the file.";
         }

         uses file-reader-state-parameters;

Boyd & Seda            Expires September 12, 2019              [Page 88]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       }
     }

     grouping exporting-process-parameters {
       description
         "Parameters of an Exporting Process.";

       leaf export-mode {
         type identityref {
           base export-mode;
         }
         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 name-type;
           description
             "Export destination name.";
         }

         choice destination-parameters {
           mandatory true;
           description
             "Destination configuration.";

           container tcp-exporter {
             if-feature tcp-transport;
             description
               "TCP parameters.";

             uses tcp-exporter-parameters;

             container transport-session {
               config false;
               description
                 "Transport session state data.";

               uses transport-session-state-parameters;
             }

Boyd & Seda            Expires September 12, 2019              [Page 89]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           }

           container udp-exporter {
             if-feature udp-transport;
             description
               "UDP parameters.";

             uses udp-exporter-parameters;

             container transport-session {
               config false;
               description
                 "Transport session state data.";

               uses transport-session-state-parameters;
             }
           }

           container sctp-exporter {
             if-feature sctp-transport;
             description
               "SCTP parameters.";

             uses sctp-exporter-parameters;

             container transport-session {
               config false;
               description
                 "Transport session state data.";

               leaf sctp-association-id {
                 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
                   "RFC 6615, Section 8
                    (ipfixTransportSessionSctpAssocId);
                    RFC 3871";

Boyd & Seda            Expires September 12, 2019              [Page 90]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

               }

               uses transport-session-state-parameters;
             }
           }

           container file-writer {
             if-feature file-writer;
             description
               "File Writer parameters.";

             leaf ipfix-version {
               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.";
             }

             uses file-writer-state-parameters;
           }
         }
       }

       list options {
         key "name";
         description
           "List of options reported by the Exporting Process.";

         leaf name {
           type name-type;
           description
             "Name of the option.";
         }
         uses options-parameters;
       }
     }

     grouping common-exporter-parameters {
       description

Boyd & Seda            Expires September 12, 2019              [Page 91]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         "Parameters of en export destination that are
          common to all transport protocols.";

       leaf ipfix-version {
         type uint16;
         default '10';
         description
           "IPFIX version number.";
         reference
           "RFC 5101.";
       }

       leaf destination-port {
         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 TLS or DTLS and 4740 if TLS or DTLS is
            activated.";
       }

       leaf send-buffer-size {
         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 rate-limit {
         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
           "RFC 5476, Section 6.3.";
       }

       container transport-layer-security {
         presence
           "The presence of this container indicates TLS is enabled.";
         description

Boyd & Seda            Expires September 12, 2019              [Page 92]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           "TLS or DTLS configuration.";

         uses transport-layer-security-parameters;
       }

       container source {
         description
           "Configuration corresponding to how exporter's source IP
            address is specified.";

         choice source-method {
           description
             "Method to configure the source address of the exporter
              or the interface to be used by the exporter.

              Note that it is expected that other methods be available.
              Those methods can augment this choice.";

           case source-address {
             leaf source-address {
               type inet:host;
               description
                 "Select the source address used by the Exporting
                  Process.";
             }
           }

           case interface-ref {
             leaf interface-ref {
               type if:interface-ref;
               description
                 "The interface to be used by the Exporting Process.";
             }
           }

           case if-index {
             if-feature if-mib;
             leaf if-index {
               type uint32;
               description
                 "Index of an interface as stored in the ifTable
                  of IF-MIB.";
               reference
                 "RFC 2863.";
             }
           }

           case if-name {

Boyd & Seda            Expires September 12, 2019              [Page 93]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             if-feature if-mib;
             leaf if-name {
               type string;
               description
                 "Name of an interface as stored in the ifTable
                  of IF-MIB.";
               reference
                 "RFC 2863.";
             }
           }
         }
       }

       container destination {
         description
           "Configuration corresponding to how exporter's destination IP
            address is specified.";

         choice destination-method {
           mandatory true;
           description
             "Method to configuring the destination address of the
              Collection Process to which IPFIX Messages are sent.

              Note it is expected that if other methods are available
              that they would augment from this statement.";

           case destination-address {
             leaf destination-address {
               type inet:host;
               description
                 "Destination IP address or hostname. A hostname may
                  resolve to one or more IP addresses.";
             }
           }
         }
       }
     }

     grouping tcp-exporter-parameters {
       description
         "Parameters of a TCP export destination.";

       uses common-exporter-parameters;
     }

     grouping udp-exporter-parameters {
       description

Boyd & Seda            Expires September 12, 2019              [Page 94]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         "Parameters of a UDP export destination.";

       uses common-exporter-parameters;

       leaf maximum-packet-size {
         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 template-refresh-timeout {
         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
           "RFC 5101, Section 10.3.6; RFC 6615, Section 8
            (ipfixTransportSessionTemplateRefreshTimeout).";
       }

       leaf options-template-refresh-timeout {
         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

Boyd & Seda            Expires September 12, 2019              [Page 95]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           "RFC 5101, Section 10.3.6; RFC 6615, Section 8
            (ipfixTransportSessionOptionsTemplateRefreshTimeout).";
       }

       leaf template-refresh-packet {
         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
           "RFC 5101, Section 10.3.6; RFC 6615, Section 8
            (ipfixTransportSessionTemplateRefreshPacket).";
       }

       leaf options-template-refresh-packet {
         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
           "RFC 5101, Section 10.3.6; RFC 6615, Section 8
            (ipfixTransportSessionOptionsTemplateRefreshPacket).";
       }
     }

     grouping sctp-exporter-parameters {
       description
         "Parameters of a SCTP export destination.";

       uses common-exporter-parameters;

       leaf timed-reliability {
         type uint32;
         units milliseconds;
         default 0;
         description
           "Lifetime in milliseconds until an IPFIX

Boyd & Seda            Expires September 12, 2019              [Page 96]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            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 file-writer-state-parameters {
       description
         "State Parameters for the File Writer.";

       container file-writer-state {
         config false;
         description
           "File Writer parameters.";

         leaf bytes {
           type yang:counter64;
           units octets;
           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";
           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 discarded-messages {
           type yang:counter64;
           units "IPFIX Messages";
           description

Boyd & Seda            Expires September 12, 2019              [Page 97]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             "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";
           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";
           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 options-templates {
           type yang:counter32;
           units "Options Templates";
           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 file-writer-discontinuity-time {
           type yang:date-and-time;
           description
             "Timestamp of the most recent occasion at which

Boyd & Seda            Expires September 12, 2019              [Page 98]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

              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 {
           description
             "This list contains the Templates and Options
              Templates that have been written by the File Reader.
              Withdrawn or invalidated (Options) Templates MUST be
              removed from this list.";
           uses template-parameters-state;
         }
       }
     }

     grouping options-parameters {
       description
         "Parameters specifying the data export using an
          Options Template.";

       leaf options-type {
         type identityref {
           base options-type;
         }
         mandatory true;
         description
           "Type of the exported options data.";
       }

       leaf options-timeout {
         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.";
       }
     }

     container ipfix {
       description
        "IPFIX Exporter and/or Collector data nodes.";

Boyd & Seda            Expires September 12, 2019              [Page 99]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       list collecting-process {
         if-feature collector;
         key "name";
         description
           "Collecting Process of the Monitoring Device.";

         leaf name {
           type name-type;
           description
             "Name of the collecting process.";
         }

         uses collecting-process-parameters;

         leaf-list exporting-process {
           if-feature exporter;
           type leafref {
             path "/ietf-ipfix:ipfix"
                + "/ietf-ipfix:exporting-process"
                + "/ietf-ipfix:name";
           }
           description
             "Export of received records without any
              modifications.  Records are processed by all Exporting
              Processes in the list.";
         }
       }

       list exporting-process {
         if-feature exporter;
         key "name";
         description
           "List of Exporting Processes of the IPFIX Monitoring Device
            for which configuration will be applied.";

         leaf name {
           type name-type;
           description
             "Name of the exporting process.";
         }

         leaf enabled {
           type boolean;
           default "true";
           description
             "If true, this exporting process is enabled for
              exporting.";
         }

Boyd & Seda            Expires September 12, 2019             [Page 100]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         uses exporting-process-parameters;

         leaf exporting-process-id {
           type uint32;
           config false;
           description
             "The identifier of the Exporting Process.
              This parameter corresponds to the Information Element
              exportingProcessId. Its occurrence helps to associate
              Exporting Process parameters with Exporing Process
              statistics exported by the Monitoring Device using the
              Exporting Process Reliability Statistics Template as
              defined by the IPFIX protocol specification.";
           reference
             "RFC 5101, Section 4.3; IANA registry for IPFIX
              Entities, http://www.iana.org/assignments/ipfix.";
         }
       }
     }
   }

   <CODE ENDS>

6.2.  ietf-psamp

6.2.1.  ietf-psamp Module Structure

   This document defines the YANG module "ietf-psamp", which has the
   following structure:

Boyd & Seda            Expires September 12, 2019             [Page 101]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   module: ietf-psamp
     augment /ietf-ipfix:ipfix:
       +--rw psamp
          +--rw observation-point* [name]
          |  +--rw name                     ietf-ipfix:name-type
          |  +--rw observation-domain-id    uint32
          |  +--rw interface-ref*           if:interface-ref
          |  +--rw if-name*                 if-name-type {if-mib}?
          |  +--rw if-index*                uint32 {if-mib}?
          |  +--rw hardware-ref*            hardware-ref
          |  +--rw ent-physical-name*       string {entity-mib}?
          |  +--rw ent-physical-index*      uint32 {entity-mib}?
          |  +--rw direction?               direction
          |  +--rw selection-process*
          |  |       -> /ietf-ipfix:ipfix/psamp/selection-process/name
          |  +--ro observation-point-id?    uint32
          +--rw selection-process* [name]
          |  +--rw name                  ietf-ipfix:name-type
          |  +--rw selector* [name]
          |  |     ...
          |  +--rw cache?
          |  |       -> /ietf-ipfix:ipfix/psamp/cache/name
          |  +--ro selection-sequence* []
          |        ...
          +--rw cache* [name]
             +--rw name                        ietf-ipfix:name-type
             +--rw enabled?                    boolean
             +--rw (cache-type)
             |     ...
             +--rw exporting-process*
             |       -> /ietf-ipfix:ipfix/exporting-process/name
             |       {ietf-ipfix:exporter}?
             +--ro metering-process-id?        uint32
             +--ro data-records?               yang:counter64
             +--ro cache-discontinuity-time?   yang:date-and-time

6.2.2.  ietf-psamp YANG module

   This YANG Module imports typedefs from [RFC6991].

   <CODE BEGINS> file "ietf-psamp@2018-10-22.yang"

   module ietf-psamp {
     yang-version 1.1;

     namespace "urn:ietf:params:xml:ns:yang:ietf-psamp";

     prefix ietf-psamp;

Boyd & Seda            Expires September 12, 2019             [Page 102]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     import ietf-yang-types {
       prefix yang;
     }

     import ietf-ipfix {
       prefix ietf-ipfix;
     }

     import ietf-interfaces {
       prefix if;
     }

     import ietf-hardware {
       prefix hw;
     }

     organization
       "IETF";

     contact
       "Web:      TBD
        List:     TBD

        Editor:   Joey Boyd
                  <mailto:joey.boyd@adtran.com>

        Editor:   Marta Seda
                  <mailto:marta.seda@calix.com>";

     // RFC Ed.: replace XXXX with actual RFC numbers and
     // remove this note.

     description
       "This module contains a collection of YANG definitions for the
        management Packet Sampling (PSAMP) over IPFIX.

        This data model is designed for the Network Management Datastore
        Architecture defined in RFC 8342.

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

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

Boyd & Seda            Expires September 12, 2019             [Page 103]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        This version of this YANG module is part of XXXX; see the RFC
        itself for full legal notices.";

     revision 2019-03-11 {
       description
         "Initial revision.";
       reference
         "RFC XXXX: YANG Data Models for the IP Flow Information Export
                    (IPFIX) Protocol, Packet Sampling (PSAMP) Protocol,
                    and Bulk Data Export";
     }

     feature if-mib {
       description
         "This feature indicates that the device implements
          the IF-MIB.";
       reference
         "RFC 2863: The Interfaces Group MIB";
     }

     feature entity-mib {
       description
         "This feature indicates that the device implements
          the ENTITY-MIB.";
       reference
         "RFC 6933: Entity MIB (Version 4)";
     }

     feature psamp-samp-count-based {
       description
         "If supported, the Monitoring Device supports
          count-based Sampling. The Selector method sampCountBased can
          be configured.";
     }

     feature psamp-samp-time-based {
       description
         "If supported, the Monitoring Device supports
          time-based Sampling. The Selector method sampTimeBased can
          be configured.";
     }

     feature psamp-samp-rand-out-of-n {
       description
         "If supported, the Monitoring Device supports
          random n-out-of-N Sampling. The Selector method
          sampRandOutOfN can be configured.";
     }

Boyd & Seda            Expires September 12, 2019             [Page 104]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     feature psamp-samp-uni-prob {
       description
         "If supported, the Monitoring Device supports
          uniform probabilistic Sampling. The Selector method
          sampUniProb can be configured.";
     }

     feature psamp-filter-match {
       description
         "If supported, the Monitoring Device supports
          property match Filtering. The Selector method filterMatch
          can be configured.";
     }

     feature psamp-filter-hash {
       description
         "If supported, the Monitoring Device supports
          hash-based Filtering. The Selector method filterHash can be
          configured.";
     }

     feature immediate-cache {
       description
         "If supported, the Monitoring Device supports
          Caches generating PSAMP Packet Reports by configuration with
          immediateCache.";
     }

     feature timeout-cache {
       description
         "If supported, the Monitoring Device supports
          Caches generating IPFIX Flow Records by configuration with
          timeoutCache.";
     }

     feature natural-cache {
       description
         "If supported, the Monitoring Device supports
          Caches generating IPFIX Flow Records by configuration with
          naturalCache.";
     }

     feature permanent-cache {
       description
         "If supported, the Monitoring Device supports
          Caches generating IPFIX Flow Records by configuration with
          permanentCache.";
     }

Boyd & Seda            Expires September 12, 2019             [Page 105]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     identity bob {
       base hash-function;
       description
         "BOB hash function.";
       reference
         "RFC 5475, Section 6.2.4.1.";
     }

     identity ipsx {
       base hash-function;
       description
         "IPSX hash function.";
       reference
         "RFC 5475, Section 6.2.4.1.";
     }

     identity crc {
       base hash-function;
       description
         "CRC hash function.";
       reference
         "RFC 5475, Section 6.2.4.1.";
     }

     identity hash-function {
       description
         "Base identity for all hash functions used for
          hash-based packet Filtering.";
     }

     typedef hardware-ref {
       type leafref {
         path "/hw:hardware/hw:component/hw:name";
       }
       description
         "This type is used to reference hardware components.";
       reference
         "RFC 8348.";
     }

     typedef if-name-type {
       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.";

Boyd & Seda            Expires September 12, 2019             [Page 106]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       reference
         "RFC 2863 (ifName).";
     }

     typedef direction {
       type enumeration {
         enum "ingress" {
           value 0;
           description
             "This value is used for monitoring incoming packets.";
         }
         enum "egress" {
           value 1;
           description
             "This value is used for monitoring outgoing packets.";
         }
         enum "both" {
           value 2;
           description
             "This value is used for monitoring incoming and
              outgoing packets.";
         }
       }
       description
         "Direction of packets going through an interface.";
     }

     grouping observation-point-parameters {
       description
         "Interface as input to Observation Point.";

       leaf observation-domain-id {
         type uint32;
         mandatory true;
         description
           "The Observation Domain ID associates the
            Observation Point to an Observation Domain. Observation
            Points with identical Observation Domain IDs belong to the
            same Observation Domain.

            Note that this parameter corresponds to
            ipfixObservationPointObservationDomainId in the IPFIX MIB
            module.";
         reference
           "RFC 5101; RFC 6615, Section 8
            (ipfixObservationPointObservationDomainId).";
       }

Boyd & Seda            Expires September 12, 2019             [Page 107]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       leaf-list interface-ref {
         type if:interface-ref;
         description
           "List of interfaces of the Monitoring Device. The
            Observation Point observes packets at the specified
            interfaces.";
       }

       leaf-list if-name {
         if-feature if-mib;
         type if-name-type;
         description
           "List of names identifying interfaces of the
            Monitoring Device.  The Observation Point observes packets
            at the specified interfaces.";
       }

       leaf-list if-index {
         if-feature if-mib;
         type uint32;
         description
           "List of if-index values pointing to entries in the
            ifTable of the IF-MIB module maintained by the Monitoring
            Device.  The Observation Point observes packets at the
            specified interfaces.
            This parameter SHOULD only be used if an SNMP agent enables
            access to the ifTable.
            Note that this parameter corresponds to
            ipfixObservationPointPhysicalInterface in the IPFIX MIB
            module.";
         reference
           "RFC 2863; RFC 6615, Section 8
            (ipfixObservationPointPhysicalInterface).";
       }

       leaf-list hardware-ref {
         type hardware-ref;
         description
           "List of hardware components of the Monitoring Device.
            The Observation Points observes packets at the specified
            hardware components.";
         reference
           "RFC 8348.";
     }

       leaf-list ent-physical-name {
         if-feature entity-mib;
         type string;

Boyd & Seda            Expires September 12, 2019             [Page 108]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         description
           "List of names identifying physical entities of the
            Monitoring Device. The Observation Point observes packets
            at the specified entities.";
       }

       leaf-list ent-physical-index {
         if-feature entity-mib;
         type uint32;
         description
           "List of ent-physical-index values pointing to
            entries in the entPhysicalTable of the ENTITY-MIB module
            maintained by the Monitoring Device.  The Observation Point
            observes packets at the specified entities.
            This parameter SHOULD only be used if an SNMP agent enables
            access to the entPhysicalTable.
            Note that this parameter corresponds to
            ipfixObservationPointPhysicalEntity in the IPFIX MIB
            module.";
         reference
           "RFC 4133; RFC 6615, Section 8
            (ipfixObservationPointPhysicalInterface).";
       }

       leaf direction {
         type direction;
         default "both";
         description
           "Direction of packets. If not applicable (e.g., in
            the case of a sniffing interface in promiscuous mode), this
            parameter is ignored.";
       }
     }

     grouping samp-count-based-parameters {
       description
         "Configuration parameters of a Selector applying
          systematic count-based packet Sampling to the packet
          stream.";
       reference
         "RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.1.";

       leaf packet-interval {
         type uint32;
         units "packets";
         mandatory true;
         description
           "The number of packets that are consecutively

Boyd & Seda            Expires September 12, 2019             [Page 109]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            sampled between gaps of length packetSpace.

            This parameter corresponds to the Information Element
            samplingPacketInterval and to psampSampCountBasedInterval
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.2.2; RFC 6727, Section 6
            (psampSampCountBasedInterval).";
       }

       leaf packet-space {
         type uint32;
         units "packets";
         mandatory true;
         description
           "The number of unsampled packets between two
            Sampling intervals.

            This parameter corresponds to the Information Element
            samplingPacketSpace and to psampSampCountBasedSpace
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.2.3; RFC 6727, Section 6
            (psampSampCountBasedSpace).";
       }
     }

     grouping samp-time-based-parameters {
       description
         "Configuration parameters of a Selector applying
          systematic time-based packet Sampling to the packet
          stream.";
       reference
         "RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.2.";

       leaf time-interval {
         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

Boyd & Seda            Expires September 12, 2019             [Page 110]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           "RFC 5477, Section 8.2.4; RFC 6727, Section 6
            (psampSampTimeBasedInterval).";
       }

       leaf time-space {
         type uint32;
         units "microseconds";
         mandatory true;
         description
           "The time interval in microseconds during
            which no packets are sampled between two Sampling
            intervals specified by timeInterval.

            This parameter corresponds to the Information Element
            samplingTimeInterval and to psampSampTimeBasedSpace
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.2.5; RFC 6727, Section 6
            (psampSampTimeBasedSpace).";
       }
     }

     grouping samp-rand-out-of-n-parameters {
       description
         "Configuration parameters of a Selector applying
          n-out-of-N packet Sampling to the packet stream.";
       reference
         "RFC 5475, Section 5.2.1; RFC 5476, Section 6.5.2.3.";

       leaf size {
         type uint32;
         units "packets";
         mandatory true;
         description
           "The number of elements taken from the parent
            population.

            This parameter corresponds to the Information Element
            samplingSize and to psampSampRandOutOfNSize in the PSAMP
            MIB module.";
         reference
           "RFC 5477, Section 8.2.6; RFC 6727, Section 6
            (psampSampRandOutOfNSize).";
       }

       leaf population {
         type uint32;
         units "packets";

Boyd & Seda            Expires September 12, 2019             [Page 111]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         mandatory true;
         description
           "The number of elements in the parent
            population.

            This parameter corresponds to the Information Element
            samplingPopulation and to psampSampRandOutOfNPopulation
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.2.7; RFC 6727, Section 6
            (psampSampRandOutOfNPopulation).";
       }
     }

     grouping samp-uni-prob-parameters {
       description
         "Configuration parameters of a Selector applying
          uniform probabilistic packet Sampling (with equal
          probability per packet) to the packet stream.";
       reference
         "RFC 5475, Section 5.2.2.1;
          RFC 5476, Section 6.5.2.4.";

       leaf probability {
         type decimal64 {
           fraction-digits 18;
           range "0..1";
         }
         mandatory true;
         description
           "Probability that a packet is sampled,
            expressed as a value between 0 and 1.  The probability
            is equal for every packet.

            This parameter corresponds to the Information Element
            samplingProbability and to psampSampUniProbProbability
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.2.8; RFC 6727, Section 6
            (psampSampUniProbProbability).";
       }
     }

     grouping filter-match-parameters {
       description
         "Configuration parameters of a Selector applying
          property match Filtering to the packet stream.

Boyd & Seda            Expires September 12, 2019             [Page 112]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

          The field to be matched is specified as an Information
          Element.";
       reference
         "RFC 5475, Section 6.1; RFC 5476, Section 6.5.2.5.";

       choice information-element {
         mandatory true;
         description
           "The field to be matched is the Information
            Element.";

         leaf ie-name {
           type ietf-ipfix:ie-name-type;
           description
             "Name of the Information Element.";
         }

         leaf ie-id {
           type ietf-ipfix:ie-id-type;
           description
             "Identifier of the Information Element.";
         }
       }

       leaf ie-enterprise-number {
         type uint32;
         default '0';
         description
           "If this parameter is zero, the Information
            Element is registered in the IANA registry of IPFIX
            Information Elements.

            If this parameter is configured with a non-zero private
            enterprise number, the Information Element is
            enterprise-specific.";
         reference
           "IANA registry for Private Enterprise Numbers,
            http://www.iana.org/assignments/enterprise-numbers;
            IANA registry for IPFIX Entities,
            http://www.iana.org/assignments/ipfix.";
       }

       leaf value {
         type string;
         mandatory true;
         description
           "Matching value of the Information Element.";
       }

Boyd & Seda            Expires September 12, 2019             [Page 113]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     }

     grouping filter-hash-parameters {
       description
         "Configuration parameters of a Selector applying
          hash-based Filtering to the packet stream.";
       reference
         "RFC 5475, Section 6.2; RFC 5476, Section 6.5.2.6.";

       leaf hash-function {
         type identityref {
           base hash-function;
         }
         default 'bob';
         description
           "Hash function to be applied.  According to
            RFC 5475, Section 6.2.4.1, 'BOB' must be used in order to
            be compliant with PSAMP.

            This parameter functionally corresponds to
            psampFiltHashFunction in the PSAMP MIB module.";
         reference
           "RFC 6727, Section 6 (psampFiltHashFunction)";
       }

       leaf initializer-value {
         type uint64;
         description
           "Initializer value to the hash function.
            If not configured by the user, the Monitoring Device
            arbitrarily chooses an initializer value.

            This parameter corresponds to the Information Element
            hashInitialiserValue and to psampFiltHashInitializerValue
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.3.9; RFC 6727, Section 6
            (psampFiltHashInitializerValue).";
       }

       leaf ip-payload-offset {
         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.

Boyd & Seda            Expires September 12, 2019             [Page 114]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            Default value 0 corresponds to the minimum offset that
            must be configurable according to RFC 5476, Section
            6.5.2.6.

            This parameter corresponds to the Information Element
            hashIPPayloadOffset and to psampFiltHashIpPayloadOffset
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.3.2; RFC 6727, Section 6
            (psampFiltHashIpPayloadOffset).";
       }

       leaf ip-payload-size {
         type uint64;
         units "octets";
         default '8';
         description
           "Number of IP payload bytes used as input to
            the hash function, counted from the payload offset.
            If the IP payload is shorter than the payload range,
            all available payload octets are used as input.
            Default value 8 corresponds to the minimum IP payload
            size that must be configurable according to RFC 5476,
            Section 6.5.2.6.

            This parameter corresponds to the Information Element
            hashIPPayloadSize and to psampFiltHashIpPayloadSize
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.3.3; RFC 6727, Section 6
            (psampFiltHashIpPayloadSize).";
       }

       leaf digest-output {
         type boolean;
         default 'false';
         description
           "If true, the output from this Selector is
            included in the Packet Report as a packet digest.
            Therefore, the configured Cache Layout needs to contain
            a digestHashValue field.

            This parameter corresponds to the Information Element
            hashDigestOutput.";
         reference
           "RFC 5477, Section 8.3.8.";
       }

Boyd & Seda            Expires September 12, 2019             [Page 115]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       list selected-range {
         key "name";
         min-elements 1;
         description
           "List of hash function return ranges for
            which packets are selected.";

         leaf name {
           type ietf-ipfix:name-type;
           description
             "Name of the selected range.";
         }

         leaf min {
           type uint64;
           description
             "Beginning of the hash function's selected
              range.

              This parameter corresponds to the Information Element
              hashSelectedRangeMin and to psampFiltHashSelectedRangeMin
              in the PSAMP MIB module.";
           reference
             "RFC 5477, Section 8.3.6; RFC 6727, Section 6
              (psampFiltHashSelectedRangeMin).";
         }

         leaf max {
           type uint64;
           description
             "End of the hash function's selected range.

              This parameter corresponds to the Information Element
              hashSelectedRangeMax and to psampFiltHashSelectedRangeMax
              in the PSAMP MIB module.";
           reference
             "RFC 5477, Section 8.3.7; RFC 6727, Section 6
              (psampFiltHashSelectedRangeMax).";
         }
       }
     }

     grouping filter-hash-parameters-state {
       description
         "Configuration parameters of a Selector applying
          hash-based Filtering to the packet stream.";
       reference
         "RFC 5475, Section 6.2; RFC 5476, Section 6.5.2.6.";

Boyd & Seda            Expires September 12, 2019             [Page 116]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       leaf output-range-min {
         type uint64;
         config false;
         description
           "Beginning of the hash function's potential
            range.

            This parameter corresponds to the Information Element
            hashOutputRangeMin and to psampFiltHashOutputRangeMin
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.3.4; RFC 6727, Section 6
            (psampFiltHashOutputRangeMin).";
       }

       leaf output-range-max {
         type uint64;
         config false;
         description
           "End of the hash function's potential range.

            This parameter corresponds to the Information Element
            hashOutputRangeMax and to psampFiltHashOutputRangeMax
            in the PSAMP MIB module.";
         reference
           "RFC 5477, Section 8.3.5; RFC 6727, Section 6
            (psampFiltHashOutputRangeMax).";
       }
     }

     grouping selector-parameters {
       description
         "Configuration and state parameters of a Selector.";

       choice method {
         mandatory true;
         description
           "Packet selection method applied by the Selector.";

         leaf select-all {
           type empty;
           description
             "Method that selects all packets.";
         }

         container samp-count-based {
           if-feature psamp-samp-count-based;
           description

Boyd & Seda            Expires September 12, 2019             [Page 117]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             "Systematic count-based packet Sampling.";

           uses samp-count-based-parameters;
         }

         container samp-time-based {
           if-feature psamp-samp-time-based;
           description
             "Systematic time-based packet Sampling.";

           uses samp-time-based-parameters;
         }

         container samp-rand-out-of-n {
            if-feature psamp-samp-rand-out-of-n;
            description
              "n-out-of-N packet Sampling.";

            uses samp-rand-out-of-n-parameters;
         }

         container samp-uni-prob {
           if-feature psamp-samp-uni-prob;
           description
             "Uniform probabilistic packet Sampling.";

           uses samp-uni-prob-parameters;
         }

         container filter-match {
           if-feature psamp-filter-match;
           description
             "Property match Filtering.";

           uses filter-match-parameters;
         }

         container filter-hash {
           if-feature psamp-filter-hash;
           description
             "Hash-based Filtering.";

           uses filter-hash-parameters;
           uses filter-hash-parameters-state;
         }
       }
     }

Boyd & Seda            Expires September 12, 2019             [Page 118]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     grouping selector-parameters-state {
       description
         "Configuration and state parameters of a Selector.";

       leaf packets-observed {
         type yang:counter64;
         config false;
         description
           "The number of packets observed at the input of
            the Selector.

            If this is the first Selector in the Selection Process,
            this counter corresponds to the total number of packets in
            all Observed Packet Streams at the input of the Selection
            Process.  Otherwise, the counter corresponds to the total
            number of packets at the output of the preceding Selector.
            Discontinuities in the value of this counter can occur at
            re-initialization of the management system, and at other
            times as indicated by the value of
            selectorDiscontinuityTime.

            Note that this parameter corresponds to
            ipfixSelectorStatsPacketsObserved in the IPFIX MIB
            module.";
         reference
           "RFC 6615, Section 8
            (ipfixSelectorStatsPacketsObserved).";
       }

       leaf packets-dropped {
         type yang:counter64;
         config false;
         description
           "The total number of packets discarded by the
            Selector.

            Discontinuities in the value of this counter can occur at
            re-initialization of the management system, and at other
            times as indicated by the value of
            selectorDiscontinuityTime.

            Note that this parameter corresponds to
            ipfixSelectorStatsPacketsDropped in the IPFIX MIB
            module.";
         reference
           "RFC 6615, Section 8
            (ipfixSelectorStatsPacketsDropped).";
       }

Boyd & Seda            Expires September 12, 2019             [Page 119]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       leaf selector-discontinuity-time {
         type yang:date-and-time;
         config false;
         description
           "Timestamp of the most recent occasion at which
            one or more of the Selector counters suffered a
            discontinuity.

            Note that this parameter functionally corresponds to
            ipfixSelectionProcessStatsDiscontinuityTime in the IPFIX
            MIB module. In contrast to
            ipfixSelectionProcessStatsDiscontinuityTime, the time is
            absolute and not relative to sysUpTime.";
         reference
           "RFC 6615, Section 8
            (ipfixSelectionProcessStatsDiscontinuityTime).";
       }
     }

     grouping cache-layout-parameters {
       description
         "Cache Layout parameters used by immediateCache,
          timeoutCache, naturalCache, and permanentCache.";

       container cache-layout {
         description
           "Cache Layout parameters.";

         list cache-field {
           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 ietf-ipfix:name-type;
             description
               "Name of the cache field.";
           }

           choice information-element {
             mandatory true;
             description
               "Information Element.";
             reference
               "RFC 5102, Section 2; IANA registry for IPFIX
                Entities, http://www.iana.org/assignments/ipfix.";

Boyd & Seda            Expires September 12, 2019             [Page 120]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             leaf ie-name {
               type ietf-ipfix:ie-name-type;
               description
                 "Name of the Information Element.";
             }

             leaf ie-id {
               type ietf-ipfix:ie-id-type;
               description
                 "Identifier of the Information Element.";
             }
           }

           leaf ie-length {
             type uint16;
             units "octets";
             description
               "Length of the field in which the Information
                Element is encoded.  A value of 65535 specifies a
                variable-length Information Element. For Information
                Elements of integer and float type, the field length
                MAY be set to a smaller value than the standard length
                of the abstract data type if the rules of reduced size
                encoding are fulfilled.

                If not configured by the user, this parameter is set by
                the Monitoring Device.";
             reference
               "RFC 5101, Section 6.2.";
           }

           leaf ie-enterprise-number {
             type uint32;
             default '0';
             description
               "If this parameter is zero, the Information
                Element is registered in the IANA registry of IPFIX
                Information Elements.

                If this parameter is configured with a non-zero private
                enterprise number, the Information Element is
                enterprise-specific.

                If the enterprise number is set to 29305, this field
                contains a Reverse Information Element.  In this case,
                the Cache MUST generate Data Records in accordance to
                RFC 5103.";
             reference

Boyd & Seda            Expires September 12, 2019             [Page 121]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

               "RFC 5101; RFC 5103;
                IANA registry for Private Enterprise Numbers,
                http://www.iana.org/assignments/enterprise-numbers;
                IANA registry for IPFIX Entities,
                http://www.iana.org/assignments/ipfix.";
           }

           leaf is-flow-key {
             when
               "(name(../../..) != 'immediate-cache')
                and
                ((count(../ie-enterprise-number) = 0)
                or
                (../ie-enterprise-number != 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 flow-cache-parameters {
       description
         "Configuration parameters of a Cache generating Flow
          Records.";

       leaf max-flows {
         type uint32;
         units "flows";
         description
           "This parameter configures the maximum number of
            Flows in the Cache, which is the maximum number of Flows
            that can be measured simultaneously.

            The Monitoring Device MUST ensure that sufficient resources
            are available to store the configured maximum number of
            Flows.

            If the maximum number of Flows is measured, an additional
            Flow can be measured only if an existing entry is removed.
            However, traffic that pertains to existing Flows can

Boyd & Seda            Expires September 12, 2019             [Page 122]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            continue to be measured.";
       }

       leaf active-timeout {
         when "(name(..) = 'timeout-cache') or
               (name(..) = 'natural-cache')" {
           description
             "This parameter is only available for
              timeoutCache and naturalCache.";
         }
         type uint32;
         units "seconds";
         description
           "This parameter configures the time in
            seconds after which a Flow is expired even though packets
            matching this Flow are still received by the Cache.
            The parameter value zero indicates infinity, meaning that
            there is no active timeout.

            If not configured by the user, the Monitoring Device sets
            this parameter.

            Note that this parameter corresponds to
            ipfixMeteringProcessCacheActiveTimeout in the IPFIX
            MIB module.";
         reference
           "RFC 6615, Section 8
            (ipfixMeteringProcessCacheActiveTimeout).";
       }

       leaf idle-timeout {
         when
           "(name(..) = 'timeout-cache') or
            (name(..) = 'natural-cache')" {
           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.

Boyd & Seda            Expires September 12, 2019             [Page 123]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

            If not configured by the user, the Monitoring Device sets
            this parameter.

            Note that this parameter corresponds to
            ipfixMeteringProcessCacheIdleTimeout in the IPFIX
            MIB module.";
         reference
           "RFC 6615, Section 8
            (ipfixMeteringProcessCacheIdleTimeout).";
       }

       leaf export-interval {
         when "name(..) = 'permanent-cache'" {
         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.";
       }
     }

     grouping flow-cache-parameters-state {
       description
         "State parameters of a Cache generating Flow Records.";

       leaf active-flows {
         type yang:gauge32;
         units "flows";
         config false;
         description
           "The number of Flows currently active in this Cache.

            Note that this parameter corresponds to
            ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB
            module.";
         reference
           "RFC 6615, Section 8
            (ipfixMeteringProcessCacheActiveFlows).";
       }

       leaf unused-cache-entries {
         type yang:gauge32;
         units "flows";

Boyd & Seda            Expires September 12, 2019             [Page 124]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         config false;
         description
           "The number of unused Cache entries in this
            Cache.

            Note that this parameter corresponds to
            ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX
            MIB module.";
         reference
           "RFC 6615, Section 8
            (ipfixMeteringProcessCacheUnusedCacheEntries).";
       }
     }

     augment '/ietf-ipfix:ipfix' {
       description
         "Augment IPFIX to add PSAMP.";

       container psamp {
         description
           "Container for PSAMP nodes.";

         list observation-point {
           key "name";
           description
             "Observation Point of the Monitoring Device.";

           leaf name {
             type ietf-ipfix:name-type;
             description "Name of the observation point.";
           }

           uses observation-point-parameters;

           leaf-list selection-process {
             type leafref {
               path "/ietf-ipfix:ipfix/psamp/selection-process/name";
             }
             description
               "Selection Processes in this list process
                packets in parallel.";
           }

           leaf observation-point-id {
             type uint32;
             config false;
             description
               "Observation Point ID (i.e., the value of the

Boyd & Seda            Expires September 12, 2019             [Page 125]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

                Information Element observationPointId) assigned by the
                Monitoring Device.";
             reference
               "IANA registry for IPFIX Entities,
                http://www.iana.org/assignments/ipfix.";
           }
         }

         list selection-process {
           key "name";
           description
             "Selection Process of the Monitoring Device.";

           leaf name {
             type ietf-ipfix:name-type;
             description
               "Name of the selection process.";
           }

           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 ietf-ipfix:name-type;
               description
                 "Name of the selector.";
             }

             uses selector-parameters;

             uses selector-parameters-state;
           }

           leaf cache {
             type leafref {
               path "/ietf-ipfix:ipfix/psamp/cache/name";
             }
             description
               "Cache that receives the output of the
                Selection Process.";
           }

Boyd & Seda            Expires September 12, 2019             [Page 126]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           list selection-sequence {
             config false;
             description
               "This list contains the Selection Sequence IDs
                that 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
               "RFC 5476.";

             leaf observation-domain-id {
               type uint32;
               description
                 "Observation Domain ID for which the
                  Selection Sequence ID is assigned.";
             }

             leaf selection-sequence-id {
               type uint64;
               description
                 "Selection Sequence ID used in the Selection
                  Sequence (Statistics) Report Interpretation.";
             }
           }
         }

         list cache {
           key "name";
           description
             "Cache of the Monitoring Device.";

           leaf name {
             type ietf-ipfix:name-type;
             description
               "Name of the cache.";
           }

           leaf enabled {
             type boolean;

Boyd & Seda            Expires September 12, 2019             [Page 127]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             default "true";
             description
               "If true, this cache is enabled and the specified
                data is able to be exported.";
           }

           choice cache-type {
             mandatory true;
             description
               "Type of Cache and specific parameters.";

             container immediate-cache {
               if-feature immediate-cache;
               description
                 "Flow expiration after the first packet;
                  generation of Packet Records.";

               uses cache-layout-parameters;
             }

             container timeout-cache {
               if-feature timeout-cache;
               description
                 "Flow expiration after active and idle
                  timeout; generation of Flow Records.";

               uses flow-cache-parameters;
               uses cache-layout-parameters;
               uses flow-cache-parameters-state;

             }

             container natural-cache {
               if-feature natural-cache;
               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 flow-cache-parameters;
               uses cache-layout-parameters;
               uses flow-cache-parameters-state;
             }

             container permanent-cache {
               if-feature permanent-cache;
               description
                 "No flow expiration, periodical export with
                  time interval exportInterval; generation of Flow

Boyd & Seda            Expires September 12, 2019             [Page 128]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

                  Records.";
               uses flow-cache-parameters;
               uses cache-layout-parameters;
               uses flow-cache-parameters-state;
             }
           }

           leaf-list exporting-process {
             if-feature ietf-ipfix:exporter;
             type leafref {
               path "/ietf-ipfix:ipfix"
                  + "/ietf-ipfix:exporting-process"
                  + "/ietf-ipfix:name";
             }
             description
               "Records are exported by all Exporting Processes
                in the list.";
           }

           leaf metering-process-id {
             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
               "RFC 5101, Sections 4.1 and 4.2;
                IANA registry for IPFIX Entities,
                http://www.iana.org/assignments/ipfix.";
           }

           leaf data-records {
             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

Boyd & Seda            Expires September 12, 2019             [Page 129]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

                other times as indicated by the value of
                cacheDiscontinuityTime.

                Note that this parameter corresponds to
                ipfixMeteringProcessDataRecords in the IPFIX MIB
                module.";
             reference
               "RFC 6615, Section 8
                (ipfixMeteringProcessDataRecords).";
           }

           leaf cache-discontinuity-time {
             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
               "RFC 6615, Section 8
                (ipfixMeteringProcessDiscontinuityTime).";
           }
         }
       }
     }
   }

   <CODE ENDS>

6.3.  ietf-bulk-data-export

6.3.1.  ietf-bulk-data-export Module Structure

   This document defines the YANG module "ietf-bulk-data-export", which
   has the following tentative structure:

Boyd & Seda            Expires September 12, 2019             [Page 130]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   module: ietf-bulk-data-export
     augment /ietf-ipfix:ipfix:
       +--rw bulk-data-export
          +--rw template* [name]
             +--rw name                     ietf-ipfix:name-type
             +--rw enabled?                 boolean
             +--rw export-interval?         uint32
             +--rw observation-domain-id?   uint32
             +--rw field-layout
             |     ...
             +--rw exporting-process*
             |       -> /ietf-ipfix:ipfix/exporting-process/name
             |       {ietf-ipfix:exporter}?
             +--rw resource*                resource
             +--ro data-records?            yang:counter64
             +--ro discontinuity-time?      yang:date-and-time

6.3.2.  ietf-bulk-data-export YANG module

   This YANG Module imports typedefs from [RFC6991].

   <CODE BEGINS> file "ietf-bulk-data-export@2018-11-15.yang"

   module ietf-bulk-data-export {
     yang-version 1.1;

     namespace "urn:ietf:params:xml:ns:yang:ietf-bulk-data-export";

     prefix ietf-bde;

     import ietf-ipfix {
       prefix ietf-ipfix;
     }

     import ietf-yang-types {
       prefix yang;
     }

     organization
       "IETF";

     contact
       "Web:      TBD
        List:     TBD

        Editor:   Joey Boyd
                  <mailto:joey.boyd@adtran.com>

Boyd & Seda            Expires September 12, 2019             [Page 131]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        Editor:   Marta Seda
                  <mailto:marta.seda@calix.com>";

     // RFC Ed.: replace XXXX with actual RFC numbers and
     // remove this note.

     description
       "This module contains a collection of YANG definitions for the
        management exporting bulk data over IPFIX.

        This data model is designed for the Network Management Datastore
        Architecture defined in RFC 8342.

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

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

        This version of this YANG module is part of XXXX; see the RFC
        itself for full legal notices.";

     revision 2019-03-11 {
       description
         "Initial revision.";
       reference
         "RFC XXXX: YANG Data Models for the IP Flow Information Export
                    (IPFIX) Protocol, Packet Sampling (PSAMP) Protocol,
                    and Bulk Data Export";
     }

     feature bulk-data {
       description
         "If supported, bulk data templates can be configured.";
     }

     typedef resource {
       type instance-identifier {
         require-instance false;
       }
       description
         "A resource from which bulk data will be exported.";
     }

Boyd & Seda            Expires September 12, 2019             [Page 132]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

     grouping bulk-data-template-parameters {
       description
         "Field Layout parameters.";

       leaf observation-domain-id {
         type uint32;
         default 0;
         description
           "An identifier of an Observation Domain that is locally
            unique to an Exporting Process (see RFC 7011 Section 3.1).

            Typically, this Information Element is for limiting the
            scope of other Information Elements.

            A value of 0 indicates that no specific Observation Domain
            is identified by this Information Element.";
       }

       container field-layout {
         description
           "Field Layout parameters.";

         list field {
           key name;
           min-elements 1;
           description
             "Superset of statistics field names or special
              field-names (e.g., timestamps, etc) for interpreting
              statistics that are included in the
              Packet Reports or Flow Records generated by the device.";

           leaf name {
             type ietf-ipfix:name-type;
             description
               "Name of the field.";
           }

           choice identifier {
             mandatory true;
             description
               "ID of the Information Element to use in Packet Reports
                or Flow Records.";

             leaf ie-id {
               type ietf-ipfix:ie-id-type;
               description
                 "ID of the Information Element.";
             }

Boyd & Seda            Expires September 12, 2019             [Page 133]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           }

           leaf ie-length {
             type uint16;
             units octets;
             description
               "Length of the field in which the Information
                Element is encoded.  A value of 65535 specifies a
                variable-length Information Element.  For Information
                Elements of integer and float type, the field length MAY
                be set to a smaller value than the standard length of
                the abstract data type if the rules of reduced size
                encoding are fulfilled.

                If not configured by the user, this parameter is set by
                the Monitoring Device.";
             reference
               "RFC 5101, Section 6.2.";
           }

           leaf ie-enterprise-number {
             type uint32;
             default 0;
             description
               "If this parameter is zero, the Information
                Element is registered in the IANA registry of IPFIX
                Information Elements or unspecified (if the
                Informational Element is not IANA registered).

                If this parameter is configured with a non-zero private
                enterprise number, the Information Element is
                enterprise-specific.";
             reference
               "RFC 5101; RFC 5103;
                IANA registry for Private Enterprise Numbers,
                http://www.iana.org/assignments/enterprise-numbers;
                IANA registry for IPFIX Entities,
                http://www.iana.org/assignments/ipfix.";
           }
         }
       }
     }

     augment "/ietf-ipfix:ipfix" {
       description
         "Augment IPFIX to add bulk data.";

       container bulk-data-export {

Boyd & Seda            Expires September 12, 2019             [Page 134]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         description
           "Container for bulk data export nodes.";

         list template {
           key name;
           description
             "List of bulk data templates of the Monitoring Device.";

           leaf name {
             type ietf-ipfix:name-type;
             description
               "Name of the bulk data template.";
           }

           leaf enabled {
             type boolean;
             default "true";
             description
               "If true, this template is enabled and the specified
                data is able to be exported.";
           }

           leaf export-interval {
             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.";
           }

           uses bulk-data-template-parameters;

           leaf-list exporting-process {
             if-feature ietf-ipfix:exporter;
             type leafref {
               path "/ietf-ipfix:ipfix"
                  + "/ietf-ipfix:exporting-process"
                  + "/ietf-ipfix:name";
             }
             description
               "Records are exported by all Exporting Processes in the
                list.";
           }

           leaf-list resource {

Boyd & Seda            Expires September 12, 2019             [Page 135]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             type resource;
             description
               "Records are sourced from all resources in this list.";
           }

           leaf data-records {
             type yang:counter64;
             units "Data Records";
             config false;
             description
               "The number of Data Records generated for this
                sampling 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 Discontinuity Time.";
           }

           leaf discontinuity-time {
             type yang:date-and-time;
             config false;
             description
               "Timestamp of the most recent occasion at which
                the counter data records suffered a discontinuity.";
           }
         }
       }
     }
   }

   <CODE ENDS>

7.  IANA Considerations

   This document registers 3 URIs in the "IETF XML Registry".
   [RFC3688].  Following the format in RFC 3688, the following
   registrations have been made.

   URI: urn:ietf:params:xml:ns:yang:ietf-ipfix
   Registrant Contact: The IESG.
   XML: N/A, the requested URI is an XML namespace.

   URI: urn:ietf:params:xml:ns:yang:ietf-psamp
   Registrant Contact: The IESG.
   XML: N/A, the requested URI is an XML namespace.

   URI: urn:ietf:params:xml:ns:yang:ietf-bulk-data-export
   Registrant Contact: The IESG.
   XML: N/A, the requested URI is an XML namespace.

Boyd & Seda            Expires September 12, 2019             [Page 136]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   This document registers 3 YANG modules in the "YANG Module Names"
   registry.  Following the format in [RFC7950], the following have been
   registered.

   Name: ietf-ipfix
   Namespace: urn:ietf:params:xml:ns:yang:ietf-ipfix
   Prefix: ietf-ipfix
   Reference: TBD

   Name: ietf-psamp
   Namespace: urn:ietf:params:xml:ns:yang:ietf-psamp
   Prefix: ietf-psamp
   Reference: TBD

   Name: ietf-bulk-data-export
   Namespace: urn:ietf:params:xml:ns:yang:ietf-bulk-data-export
   Prefix: ietf-bde
   Reference: TBD

8.  Security Considerations

   The YANG module specified in this document defines a schema for data
   that is designed to be accessed via network management protocols such
   as NETCONF [RFC6241] or RESTCONF [RFC8040].  The lowest NETCONF layer
   is the secure transport layer, and the mandatory-to-implement secure
   transport is Secure Shell (SSH) [RFC6242].  The lowest RESTCONF layer
   is HTTPS, and the mandatory-to-implement secure transport is TLS
   [RFC8446].

   The NETCONF access control model [RFC8341] provides the means to
   restrict access for particular NETCONF or RESTCONF users to a
   preconfigured subset of all available NETCONF or RESTCONF protocol
   operations and content.

   There are a number of data nodes defined in this YANG module that 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:

   o  /ipfix/psamp/observation-point: 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.

Boyd & Seda            Expires September 12, 2019             [Page 137]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   o  /ipfix/psamp/selection-process: 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.

   o  /ipfix/psamp/cache: 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.

   o  /ipfix/exporting-process: 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, TLS/DTLS parameters can be changed,
      which may affect the mutual authentication between Exporters and
      Collectors as well as the encrypted transport of the data.

   o  /ipfix/collecting-process: 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.

   o  /ipfix/bulk-data-export/template: The configuration parameters in
      this subtree specify the fields included in the bulk data export.
      Write access to this subtree allows adding fields which may cause
      export of sensitive configuration and/or statistics.

   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:

   o  /ipfix/psamp/observation-point: Parameters in this subtree may be
      sensitive because they reveal information about the Monitoring
      Device itself and the network infrastructure.

   o  /ipfix/psamp/selection-process: 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.

Boyd & Seda            Expires September 12, 2019             [Page 138]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   o  /ipfix/psamp/cache: 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.

   o  /ipfix/exporting-process: 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 TLS/DTLS configuration, which may facilitate the
      interception of outgoing IPFIX Messages.

   o  /ipfix/collecting-process: 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 TLS/DTLS configuration, which may facilitate the
      interception of incoming IPFIX Messages.

9.  Acknowledgments

   The authors would like to thank Anand Arokiaraj and William Lupton
   for their contributions towards creation of this document and
   associated YANG data models.

10.  References

10.1.  Normative References

   [BBF.TR-352]
              Broadband Forum, "Multi-wavelength PON Inter-Channel-
              Termination Protocol (ICTP) Specification", May 2017,
              <https://www.broadband-forum.org/technical/download/
              TR-352.pdf>.

   [IANA-IPFIX]
              IANA, "IP Flow Information Export (IPFIX) Entities",
              <http://www.iana.org/assignments/ipfix>.

   [RFC2863]  McCloghrie, K. and F. Kastenholz, "The Interfaces Group
              MIB", RFC 2863, DOI 10.17487/RFC2863, June 2000,
              <https://www.rfc-editor.org/info/rfc2863>.

   [RFC3688]  Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
              DOI 10.17487/RFC3688, January 2004,
              <https://www.rfc-editor.org/info/rfc3688>.

Boyd & Seda            Expires September 12, 2019             [Page 139]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   [RFC3758]  Stewart, R., Ramalho, M., Xie, Q., Tuexen, M., and P.
              Conrad, "Stream Control Transmission Protocol (SCTP)
              Partial Reliability Extension", RFC 3758,
              DOI 10.17487/RFC3758, May 2004,
              <https://www.rfc-editor.org/info/rfc3758>.

   [RFC4960]  Stewart, R., Ed., "Stream Control Transmission Protocol",
              RFC 4960, DOI 10.17487/RFC4960, September 2007,
              <https://www.rfc-editor.org/info/rfc4960>.

   [RFC5103]  Trammell, B. and E. Boschi, "Bidirectional Flow Export
              Using IP Flow Information Export (IPFIX)", RFC 5103,
              DOI 10.17487/RFC5103, January 2008,
              <https://www.rfc-editor.org/info/rfc5103>.

   [RFC5475]  Zseby, T., Molina, M., Duffield, N., Niccolini, S., and F.
              Raspall, "Sampling and Filtering Techniques for IP Packet
              Selection", RFC 5475, DOI 10.17487/RFC5475, March 2009,
              <https://www.rfc-editor.org/info/rfc5475>.

   [RFC5476]  Claise, B., Ed., Johnson, A., and J. Quittek, "Packet
              Sampling (PSAMP) Protocol Specifications", RFC 5476,
              DOI 10.17487/RFC5476, March 2009,
              <https://www.rfc-editor.org/info/rfc5476>.

   [RFC5477]  Dietz, T., Claise, B., Aitken, P., Dressler, F., and G.
              Carle, "Information Model for Packet Sampling Exports",
              RFC 5477, DOI 10.17487/RFC5477, March 2009,
              <https://www.rfc-editor.org/info/rfc5477>.

   [RFC5610]  Boschi, E., Trammell, B., Mark, L., and T. Zseby,
              "Exporting Type Information for IP Flow Information Export
              (IPFIX) Information Elements", RFC 5610,
              DOI 10.17487/RFC5610, July 2009,
              <https://www.rfc-editor.org/info/rfc5610>.

   [RFC5655]  Trammell, B., Boschi, E., Mark, L., Zseby, T., and A.
              Wagner, "Specification of the IP Flow Information Export
              (IPFIX) File Format", RFC 5655, DOI 10.17487/RFC5655,
              October 2009, <https://www.rfc-editor.org/info/rfc5655>.

   [RFC6347]  Rescorla, E. and N. Modadugu, "Datagram Transport Layer
              Security Version 1.2", RFC 6347, DOI 10.17487/RFC6347,
              January 2012, <https://www.rfc-editor.org/info/rfc6347>.

Boyd & Seda            Expires September 12, 2019             [Page 140]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   [RFC6526]  Claise, B., Aitken, P., Johnson, A., and G. Muenz, "IP
              Flow Information Export (IPFIX) Per Stream Control
              Transmission Protocol (SCTP) Stream", RFC 6526,
              DOI 10.17487/RFC6526, March 2012,
              <https://www.rfc-editor.org/info/rfc6526>.

   [RFC6615]  Dietz, T., Ed., Kobayashi, A., Claise, B., and G. Muenz,
              "Definitions of Managed Objects for IP Flow Information
              Export", RFC 6615, DOI 10.17487/RFC6615, June 2012,
              <https://www.rfc-editor.org/info/rfc6615>.

   [RFC6727]  Dietz, T., Ed., Claise, B., and J. Quittek, "Definitions
              of Managed Objects for Packet Sampling", RFC 6727,
              DOI 10.17487/RFC6727, October 2012,
              <https://www.rfc-editor.org/info/rfc6727>.

   [RFC6728]  Muenz, G., Claise, B., and P. Aitken, "Configuration Data
              Model for the IP Flow Information Export (IPFIX) and
              Packet Sampling (PSAMP) Protocols", RFC 6728,
              DOI 10.17487/RFC6728, October 2012,
              <https://www.rfc-editor.org/info/rfc6728>.

   [RFC6933]  Bierman, A., Romascanu, D., Quittek, J., and M.
              Chandramouli, "Entity MIB (Version 4)", RFC 6933,
              DOI 10.17487/RFC6933, May 2013,
              <https://www.rfc-editor.org/info/rfc6933>.

   [RFC6991]  Schoenwaelder, J., Ed., "Common YANG Data Types",
              RFC 6991, DOI 10.17487/RFC6991, July 2013,
              <https://www.rfc-editor.org/info/rfc6991>.

   [RFC7011]  Claise, B., Ed., Trammell, B., Ed., and P. Aitken,
              "Specification of the IP Flow Information Export (IPFIX)
              Protocol for the Exchange of Flow Information", STD 77,
              RFC 7011, DOI 10.17487/RFC7011, September 2013,
              <https://www.rfc-editor.org/info/rfc7011>.

   [RFC7012]  Claise, B., Ed. and B. Trammell, Ed., "Information Model
              for IP Flow Information Export (IPFIX)", RFC 7012,
              DOI 10.17487/RFC7012, September 2013,
              <https://www.rfc-editor.org/info/rfc7012>.

   [RFC7119]  Claise, B., Kobayashi, A., and B. Trammell, "Operation of
              the IP Flow Information Export (IPFIX) Protocol on IPFIX
              Mediators", RFC 7119, DOI 10.17487/RFC7119, February 2014,
              <https://www.rfc-editor.org/info/rfc7119>.

Boyd & Seda            Expires September 12, 2019             [Page 141]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   [RFC7950]  Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
              RFC 7950, DOI 10.17487/RFC7950, August 2016,
              <https://www.rfc-editor.org/info/rfc7950>.

   [RFC8342]  Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
              and R. Wilton, "Network Management Datastore Architecture
              (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
              <https://www.rfc-editor.org/info/rfc8342>.

   [RFC8343]  Bjorklund, M., "A YANG Data Model for Interface
              Management", RFC 8343, DOI 10.17487/RFC8343, March 2018,
              <https://www.rfc-editor.org/info/rfc8343>.

   [RFC8348]  Bierman, A., Bjorklund, M., Dong, J., and D. Romascanu, "A
              YANG Data Model for Hardware Management", RFC 8348,
              DOI 10.17487/RFC8348, March 2018,
              <https://www.rfc-editor.org/info/rfc8348>.

10.2.  Informative References

   [IANA-ENTERPRISE-NUMBERS]
              IANA, "Private Enterprise Numbers",
              <http://www.iana.org/assignments/enterprise-numbers>.

   [RFC1141]  Mallory, T. and A. Kullberg, "Incremental updating of the
              Internet checksum", RFC 1141, DOI 10.17487/RFC1141,
              January 1990, <https://www.rfc-editor.org/info/rfc1141>.

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119,
              DOI 10.17487/RFC2119, March 1997,
              <https://www.rfc-editor.org/info/rfc2119>.

   [RFC3871]  Jones, G., Ed., "Operational Security Requirements for
              Large Internet Service Provider (ISP) IP Network
              Infrastructure", RFC 3871, DOI 10.17487/RFC3871, September
              2004, <https://www.rfc-editor.org/info/rfc3871>.

   [RFC5280]  Cooper, D., Santesson, S., Farrell, S., Boeyen, S.,
              Housley, R., and W. Polk, "Internet X.509 Public Key
              Infrastructure Certificate and Certificate Revocation List
              (CRL) Profile", RFC 5280, DOI 10.17487/RFC5280, May 2008,
              <https://www.rfc-editor.org/info/rfc5280>.

   [RFC5473]  Boschi, E., Mark, L., and B. Claise, "Reducing Redundancy
              in IP Flow Information Export (IPFIX) and Packet Sampling
              (PSAMP) Reports", RFC 5473, DOI 10.17487/RFC5473, March
              2009, <https://www.rfc-editor.org/info/rfc5473>.

Boyd & Seda            Expires September 12, 2019             [Page 142]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   [RFC6241]  Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
              and A. Bierman, Ed., "Network Configuration Protocol
              (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
              <https://www.rfc-editor.org/info/rfc6241>.

   [RFC6242]  Wasserman, M., "Using the NETCONF Protocol over Secure
              Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
              <https://www.rfc-editor.org/info/rfc6242>.

   [RFC8040]  Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
              Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
              <https://www.rfc-editor.org/info/rfc8040>.

   [RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
              2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
              May 2017, <https://www.rfc-editor.org/info/rfc8174>.

   [RFC8340]  Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
              BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
              <https://www.rfc-editor.org/info/rfc8340>.

   [RFC8341]  Bierman, A. and M. Bjorklund, "Network Configuration
              Access Control Model", STD 91, RFC 8341,
              DOI 10.17487/RFC8341, March 2018,
              <https://www.rfc-editor.org/info/rfc8341>.

   [RFC8407]  Bierman, A., "Guidelines for Authors and Reviewers of
              Documents Containing YANG Data Models", BCP 216, RFC 8407,
              DOI 10.17487/RFC8407, October 2018,
              <https://www.rfc-editor.org/info/rfc8407>.

   [RFC8446]  Rescorla, E., "The Transport Layer Security (TLS) Protocol
              Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
              <https://www.rfc-editor.org/info/rfc8446>.

Appendix A.  Example: ietf-ipfix Usage

   This configuration example configures an IPFIX exporter for a BBF
   TR-352 ICTP Proxy.

Boyd & Seda            Expires September 12, 2019             [Page 143]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   <ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix">
     <exporting-process>
       <name>TR352-exporter</name>
       <enabled>true</enabled>
       <destination>
         <name>ICTP-Proxy1-collector</name>
         <tcp-exporter>
           <source>
             <source-address>192.100.2.1</source-address>
           </source>
           <destination>
             <destination-address>proxy1.sys.com</destination-address>
           </destination>
         </tcp-exporter>
       </destination>
       <options>
         <name>Options 1</name>
         <options-type>extended-type-information</options-type>
         <options-timeout>0</options-timeout>
       </options>
     </exporting-process>
   </ipfix>

   This configuration example configures an IPFIX mediator.

Boyd & Seda            Expires September 12, 2019             [Page 144]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   <ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix">
     <collecting-process>
       <name>OLT-collector</name>
       <tcp-collector>
         <name>myolt-tcp-collector</name>
         <local-address-method>local-ip-address
           <local-ip-address>192.100.2.1</local-ip-address>
         </local-address-method>
       </tcp-collector>
       <exporting-process>OLT-exporter</exporting-process>
     </collecting-process>
     <exporting-process>
       <name>OLT-exporter</name>
       <enabled>true</enabled>
       <destination>
         <name>big-collector</name>
         <tcp-exporter>
           <source>
             <source-address>192.100.2.1</source-address>
           </source>
           <destination>
             <destination-address>collect1.sys.com</destination-address>
           </destination>
         </tcp-exporter>
       </destination>
       <options>
         <name>Options 1</name>
         <options-type>extended-type-information</options-type>
         <options-timeout>0</options-timeout>
       </options>
     </exporting-process>
   </ipfix>

Appendix B.  Example: ietf-psamp Usage

   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 Selector 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.

   The associated Exporting Process exports to a Collector using PR-SCTP
   and DTLS.  The TLS/DTLS parameters specify that the collector must
   supply a certificate for the FQDN collector.example.net.  Valid
   certificates from any certification authority will be accepted.  As

Boyd & Seda            Expires September 12, 2019             [Page 145]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   the destination transport port is omitted, the standard IPFIX-over-
   DTLS port 4740 is used.

   The parameters of the Selection Processes are reported as Selection
   Sequence Report Interpretations and Selector Report Interpretations
   [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).

   <ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix">
     <psamp xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix">
       <observation-point>
         <name>OP at eth0 (ingress)</name>
         <observation-domain-id>123</observation-domain-id>
         <interface-ref>eth0</interface-ref>
         <direction>ingress</direction>
         <selection-process>Sampled UDP packets</selection-process>
         <selection-process>ICMP packets</selection-process>
       </observation-point>

       <observation-point>
         <name>OP at eth1</name>
         <observation-domain-id>123</observation-domain-id>
         <interface-ref>eth1</interface-ref>
         <selection-process>Sampled UDP packets</selection-process>
         <selection-process>ICMP packets</selection-process>
       </observation-point>

       <selection-process>
         <name>Sampled UDP packets</name>
         <selector>
           <name>UDP filter</name>
           <filter-match>
             <ie-id>4</ie-id>
             <value>17</value>
           </filter-match>
         </selector>
         <selector>
           <name>10-out-of-100 sampler</name>
           <samp-rand-out-of-n>
             <size>10</size>
             <population>100</population>
           </samp-rand-out-of-n>
         </selector>
         <cache>PSAMP cache</cache>
       </selection-process>

Boyd & Seda            Expires September 12, 2019             [Page 146]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

       <selection-process>
         <name>ICMP packets</name>
         <selector>
           <name>ICMP filter</name>
           <filter-match>
             <ie-id>4</ie-id>
             <value>1</value>
           </filter-match>
         </selector>
         <cache>PSAMP cache</cache>
       </selection-process>

       <cache>
         <name>PSAMP cache</name>
         <immediate-cache>
           <cache-layout>
             <cache-field>
               <name>Field 1: ipHeaderPacketSection</name>
               <ie-id>313</ie-id>
               <ie-length>64</ie-length>
             </cache-field>
             <cache-field>
               <name>Field 2: observationTimeMilliseconds</name>
               <ie-id>322</ieId>
             </cache-field>
           </cache-layout>
         </immediate-cache>
         <exporting-process>The only exporter</exporting-process>
       </cache>
     </psamp>

     <exporting-process>
       <name>The only exporter</name>
       <enabled>true</enabled>
       <destination>
         <name>PR-SCTP collector</name>
         <sctp-exporter>
           <destination-address>192.0.2.1</destination-address>
           <rate-limit>1000000</rate-limit>
           <timed-reliability>500</timed-reliability>
           <transport-layer-security>
             <remote-subject-fqdn>coll-1.ex.net</remote-subject-fqdn>
           </transport-layer-security>
         </sctp-exporter>
       </destination>
       <options>
         <name>Options 1</name>
         <options-type>selection-sequence</options-type>

Boyd & Seda            Expires September 12, 2019             [Page 147]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

         <options-timeout>0</options-timeout>
       </options>
       <options>
         <name>Options 2</name>
         <options-type>selection-statistics</options-type>
         <options-timeout>30000</options-timeout>
       </options>
     </exporting-process>

   </ipfix>

Appendix C.  Example: ietf-bulk-data-export Usage

   The configuration example configures a field-layout template to
   export Ethernet statistics from eth0 and eth1.:

Boyd & Seda            Expires September 12, 2019             [Page 148]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   <ipfix xmlns="urn:ietf:params:xml:ns:yang:ietf-ipfix">
     <bulk-data-export xmlns=
      "urn:ietf:params:xml:ns:yang:ietf-bulk-data-export">

       <template>
         <name>Ethernet Statistics</name>
         <enabled>true</enabled>
         <export-interval>300</export-interval>
         <observation-domain-id>123</observation-domain-id>
         <field-layout>
           <field>
             <name>in-octets</name>
             <ie-id>1001</ie-id>
             <ie-length>4</ie-length>
             <ie-enterprise-number>664</ie-enterprise-number>
           </field>
           <field>
             <name>out-octets</name>
             <ie-id>1002</ie-id>
             <ie-length>4</ie-length>
             <ie-enterprise-number>664</ie-enterprise-number>
           </field>
         </field-layout>
         <exporting-process>The only one</exporting-process>
         <resource>/if:interfaces/if:interface[if:name=eth0]</resource>
         <resource>/if:interfaces/if:interface[if:name=eth1]</resource>
       </template>
     </bulk-data-export>
     <exporting-process>
       <name>The only one</name>
       <enabled>true</enabled>
       <destination>
         <name>Bulk data collector</name>
         <tcp-exporter>
           <destination-address>192.0.2.2</destination-address>
           <rate-limit>1000000</rate-limit>
           <transport-layer-security>
             <remote-subject-fqdn>coll-2.ex.net</remote-subject-fqdn>
           </transport-layer-security>
         </tcp-exporter>
       </destination>
     </exporting-process>
   </ipfix>

Boyd & Seda            Expires September 12, 2019             [Page 149]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

Appendix D.  Tree diagrams

D.1.  ietf-ipfix

   The complete tree diagram for ietf-ipfix:

   module: ietf-ipfix
     +--rw ipfix
        +--rw collecting-process* [name] {collector}?
        |  +--rw name                 name-type
        |  +--rw tcp-collector* [name] {tcp-transport}?
        |  |  +--rw name                        name-type
        |  |  +--rw local-port?                 inet:port-number
        |  |  +--rw transport-layer-security!
        |  |  |  +--rw local-certification-authority-dn*    string
        |  |  |  +--rw local-subject-dn*                    string
        |  |  |  +--rw local-subject-fqdn*
        |  |  |  |       inet:domain-name
        |  |  |  +--rw remote-certification-authority-dn*   string
        |  |  |  +--rw remote-subject-dn*                   string
        |  |  |  +--rw remote-subject-fqdn*
        |  |  |          inet:domain-name
        |  |  +--rw (local-address-method)?
        |  |  |  +--:(local-address)
        |  |  |     +--rw local-address*        inet:host
        |  |  +--ro transport-session* [name]
        |  |     +--ro name                                    name-type
        |  |     +--ro ipfix-version?                          uint16
        |  |     +--ro source-address?                         inet:host
        |  |     +--ro destination-address?                    inet:host
        |  |     +--ro source-port?
        |  |     |       inet:port-number
        |  |     +--ro destination-port?
        |  |     |       inet:port-number
        |  |     +--ro status?
        |  |     |       transport-session-status
        |  |     +--ro rate?
        |  |     |       yang:gauge32
        |  |     +--ro bytes?
        |  |     |       yang:counter64
        |  |     +--ro messages?
        |  |     |       yang:counter64
        |  |     +--ro discarded-messages?
        |  |     |       yang:counter64
        |  |     +--ro records?
        |  |     |       yang:counter64
        |  |     +--ro templates?
        |  |     |       yang:counter32

Boyd & Seda            Expires September 12, 2019             [Page 150]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        |  |     +--ro options-templates?
        |  |     |       yang:counter32
        |  |     +--ro transport-session-start-time?
        |  |     |       yang:date-and-time
        |  |     +--ro transport-session-discontinuity-time?
        |  |     |       yang:date-and-time
        |  |     +--ro template* []
        |  |        +--ro observation-domain-id?         uint32
        |  |        +--ro template-id?                   uint16
        |  |        +--ro set-id?                        uint16
        |  |        +--ro access-time?
        |  |        |       yang:date-and-time
        |  |        +--ro template-data-records?         yang:counter64
        |  |        +--ro template-discontinuity-time?
        |  |        |       yang:date-and-time
        |  |        +--ro field* []
        |  |           +--ro ie-id?                  ie-id-type
        |  |           +--ro ie-length?              uint16
        |  |           +--ro ie-enterprise-number?   uint32
        |  |           +--ro is-flow-key?            empty
        |  |           +--ro is-scope?               empty
        |  +--rw udp-collector* [name] {udp-transport}?
        |  |  +--rw name                            name-type
        |  |  +--rw local-port?                     inet:port-number
        |  |  +--rw transport-layer-security!
        |  |  |  +--rw local-certification-authority-dn*    string
        |  |  |  +--rw local-subject-dn*                    string
        |  |  |  +--rw local-subject-fqdn*
        |  |  |  |       inet:domain-name
        |  |  |  +--rw remote-certification-authority-dn*   string
        |  |  |  +--rw remote-subject-dn*                   string
        |  |  |  +--rw remote-subject-fqdn*
        |  |  |          inet:domain-name
        |  |  +--rw (local-address-method)?
        |  |  |  +--:(local-address)
        |  |  |     +--rw local-address*            inet:host
        |  |  +--rw template-life-time?             uint32
        |  |  +--rw options-template-life-time?     uint32
        |  |  +--rw template-life-packet?           uint32
        |  |  +--rw options-template-life-packet?   uint32
        |  |  +--ro transport-session* [name]
        |  |     +--ro name                                    name-type
        |  |     +--ro ipfix-version?                          uint16
        |  |     +--ro source-address?                         inet:host
        |  |     +--ro destination-address?                    inet:host
        |  |     +--ro source-port?
        |  |     |       inet:port-number
        |  |     +--ro destination-port?

Boyd & Seda            Expires September 12, 2019             [Page 151]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        |  |     |       inet:port-number
        |  |     +--ro status?
        |  |     |       transport-session-status
        |  |     +--ro rate?
        |  |     |       yang:gauge32
        |  |     +--ro bytes?
        |  |     |       yang:counter64
        |  |     +--ro messages?
        |  |     |       yang:counter64
        |  |     +--ro discarded-messages?
        |  |     |       yang:counter64
        |  |     +--ro records?
        |  |     |       yang:counter64
        |  |     +--ro templates?
        |  |     |       yang:counter32
        |  |     +--ro options-templates?
        |  |     |       yang:counter32
        |  |     +--ro transport-session-start-time?
        |  |     |       yang:date-and-time
        |  |     +--ro transport-session-discontinuity-time?
        |  |     |       yang:date-and-time
        |  |     +--ro template* []
        |  |        +--ro observation-domain-id?         uint32
        |  |        +--ro template-id?                   uint16
        |  |        +--ro set-id?                        uint16
        |  |        +--ro access-time?
        |  |        |       yang:date-and-time
        |  |        +--ro template-data-records?         yang:counter64
        |  |        +--ro template-discontinuity-time?
        |  |        |       yang:date-and-time
        |  |        +--ro field* []
        |  |           +--ro ie-id?                  ie-id-type
        |  |           +--ro ie-length?              uint16
        |  |           +--ro ie-enterprise-number?   uint32
        |  |           +--ro is-flow-key?            empty
        |  |           +--ro is-scope?               empty
        |  +--rw sctp-collector* [name] {sctp-transport}?
        |  |  +--rw name                        name-type
        |  |  +--rw local-port?                 inet:port-number
        |  |  +--rw transport-layer-security!
        |  |  |  +--rw local-certification-authority-dn*    string
        |  |  |  +--rw local-subject-dn*                    string
        |  |  |  +--rw local-subject-fqdn*
        |  |  |  |       inet:domain-name
        |  |  |  +--rw remote-certification-authority-dn*   string
        |  |  |  +--rw remote-subject-dn*                   string
        |  |  |  +--rw remote-subject-fqdn*
        |  |  |          inet:domain-name

Boyd & Seda            Expires September 12, 2019             [Page 152]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        |  |  +--rw (local-address-method)?
        |  |  |  +--:(local-address)
        |  |  |     +--rw local-address*        inet:host
        |  |  +--ro transport-session* [name]
        |  |     +--ro name                                    name-type
        |  |     +--ro sctp-association-id?                    uint32
        |  |     +--ro ipfix-version?                          uint16
        |  |     +--ro source-address?                         inet:host
        |  |     +--ro destination-address?                    inet:host
        |  |     +--ro source-port?
        |  |     |       inet:port-number
        |  |     +--ro destination-port?
        |  |     |       inet:port-number
        |  |     +--ro status?
        |  |     |       transport-session-status
        |  |     +--ro rate?
        |  |     |       yang:gauge32
        |  |     +--ro bytes?
        |  |     |       yang:counter64
        |  |     +--ro messages?
        |  |     |       yang:counter64
        |  |     +--ro discarded-messages?
        |  |     |       yang:counter64
        |  |     +--ro records?
        |  |     |       yang:counter64
        |  |     +--ro templates?
        |  |     |       yang:counter32
        |  |     +--ro options-templates?
        |  |     |       yang:counter32
        |  |     +--ro transport-session-start-time?
        |  |     |       yang:date-and-time
        |  |     +--ro transport-session-discontinuity-time?
        |  |     |       yang:date-and-time
        |  |     +--ro template* []
        |  |        +--ro observation-domain-id?         uint32
        |  |        +--ro template-id?                   uint16
        |  |        +--ro set-id?                        uint16
        |  |        +--ro access-time?
        |  |        |       yang:date-and-time
        |  |        +--ro template-data-records?         yang:counter64
        |  |        +--ro template-discontinuity-time?
        |  |        |       yang:date-and-time
        |  |        +--ro field* []
        |  |           +--ro ie-id?                  ie-id-type
        |  |           +--ro ie-length?              uint16
        |  |           +--ro ie-enterprise-number?   uint32
        |  |           +--ro is-flow-key?            empty
        |  |           +--ro is-scope?               empty

Boyd & Seda            Expires September 12, 2019             [Page 153]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

        |  +--rw file-reader* [name] {file-reader}?
        |  |  +--rw name                 name-type
        |  |  +--rw file                 inet:uri
        |  |  +--ro file-reader-state
        |  |     +--ro bytes?                            yang:counter64
        |  |     +--ro messages?                         yang:counter64
        |  |     +--ro records?                          yang:counter64
        |  |     +--ro templates?                        yang:counter32
        |  |     +--ro options-templates?                yang:counter32
        |  |     +--ro file-reader-discontinuity-time?
        |  |     |       yang:date-and-time
        |  |     +--ro template* []
        |  |        +--ro observation-domain-id?         uint32
        |  |        +--ro template-id?                   uint16
        |  |        +--ro set-id?                        uint16
        |  |        +--ro access-time?
        |  |        |       yang:date-and-time
        |  |        +--ro template-data-records?         yang:counter64
        |  |        +--ro template-discontinuity-time?
        |  |        |       yang:date-and-time
        |  |        +--ro field* []
        |  |           +--ro ie-id?                  ie-id-type
        |  |           +--ro ie-length?              uint16
        |  |           +--ro ie-enterprise-number?   uint32
        |  |           +--ro is-flow-key?            empty
        |  |           +--ro is-scope?               empty
        |  +--rw exporting-process*   -> /ipfix/exporting-process/name
        |          {exporter}?
        +--rw exporting-process* [name] {exporter}?
           +--rw name                    name-type
           +--rw enabled?                boolean
           +--rw export-mode?            identityref
           +--rw destination* [name]
           |  +--rw name                   name-type
           |  +--rw (destination-parameters)
           |     +--:(tcp-exporter)
           |     |  +--rw tcp-exporter {tcp-transport}?
           |     |     +--rw ipfix-version?              uint16
           |     |     +--rw destination-port?
           |     |     |       inet:port-number
           |     |     +--rw send-buffer-size?           uint32
           |     |     +--rw rate-limit?                 uint32
           |     |     +--rw transport-layer-security!
           |     |     |  +--rw local-certification-authority-dn*
           |     |     |  |       string
           |     |     |  +--rw local-subject-dn*
           |     |     |  |       string
           |     |     |  +--rw local-subject-fqdn*

Boyd & Seda            Expires September 12, 2019             [Page 154]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |     |     |  |       inet:domain-name
           |     |     |  +--rw remote-certification-authority-dn*
           |     |     |  |       string
           |     |     |  +--rw remote-subject-dn*
           |     |     |  |       string
           |     |     |  +--rw remote-subject-fqdn*
           |     |     |          inet:domain-name
           |     |     +--rw source
           |     |     |  +--rw (source-method)?
           |     |     |     +--:(source-address)
           |     |     |     |  +--rw source-address?   inet:host
           |     |     |     +--:(interface-ref)
           |     |     |     |  +--rw interface-ref?    if:interface-ref
           |     |     |     +--:(if-index) {if-mib}?
           |     |     |     |  +--rw if-index?         uint32
           |     |     |     +--:(if-name) {if-mib}?
           |     |     |        +--rw if-name?          string
           |     |     +--rw destination
           |     |     |  +--rw (destination-method)
           |     |     |     +--:(destination-address)
           |     |     |        +--rw destination-address?   inet:host
           |     |     +--ro transport-session
           |     |        +--ro ipfix-version?
           |     |        |       uint16
           |     |        +--ro source-address?
           |     |        |       inet:host
           |     |        +--ro destination-address?
           |     |        |       inet:host
           |     |        +--ro source-port?
           |     |        |       inet:port-number
           |     |        +--ro destination-port?
           |     |        |       inet:port-number
           |     |        +--ro status?
           |     |        |       transport-session-status
           |     |        +--ro rate?
           |     |        |       yang:gauge32
           |     |        +--ro bytes?
           |     |        |       yang:counter64
           |     |        +--ro messages?
           |     |        |       yang:counter64
           |     |        +--ro discarded-messages?
           |     |        |       yang:counter64
           |     |        +--ro records?
           |     |        |       yang:counter64
           |     |        +--ro templates?
           |     |        |       yang:counter32
           |     |        +--ro options-templates?
           |     |        |       yang:counter32

Boyd & Seda            Expires September 12, 2019             [Page 155]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |     |        +--ro transport-session-start-time?
           |     |        |       yang:date-and-time
           |     |        +--ro transport-session-discontinuity-time?
           |     |        |       yang:date-and-time
           |     |        +--ro template* []
           |     |           +--ro observation-domain-id?         uint32
           |     |           +--ro template-id?                   uint16
           |     |           +--ro set-id?                        uint16
           |     |           +--ro access-time?
           |     |           |       yang:date-and-time
           |     |           +--ro template-data-records?
           |     |           |       yang:counter64
           |     |           +--ro template-discontinuity-time?
           |     |           |       yang:date-and-time
           |     |           +--ro field* []
           |     |              +--ro ie-id?                  ie-id-type
           |     |              +--ro ie-length?              uint16
           |     |              +--ro ie-enterprise-number?   uint32
           |     |              +--ro is-flow-key?            empty
           |     |              +--ro is-scope?               empty
           |     +--:(udp-exporter)
           |     |  +--rw udp-exporter {udp-transport}?
           |     |     +--rw ipfix-version?                      uint16
           |     |     +--rw destination-port?
           |     |     |       inet:port-number
           |     |     +--rw send-buffer-size?                   uint32
           |     |     +--rw rate-limit?                         uint32
           |     |     +--rw transport-layer-security!
           |     |     |  +--rw local-certification-authority-dn*
           |     |     |  |       string
           |     |     |  +--rw local-subject-dn*
           |     |     |  |       string
           |     |     |  +--rw local-subject-fqdn*
           |     |     |  |       inet:domain-name
           |     |     |  +--rw remote-certification-authority-dn*
           |     |     |  |       string
           |     |     |  +--rw remote-subject-dn*
           |     |     |  |       string
           |     |     |  +--rw remote-subject-fqdn*
           |     |     |          inet:domain-name
           |     |     +--rw source
           |     |     |  +--rw (source-method)?
           |     |     |     +--:(source-address)
           |     |     |     |  +--rw source-address?   inet:host
           |     |     |     +--:(interface-ref)
           |     |     |     |  +--rw interface-ref?    if:interface-ref
           |     |     |     +--:(if-index) {if-mib}?
           |     |     |     |  +--rw if-index?         uint32

Boyd & Seda            Expires September 12, 2019             [Page 156]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |     |     |     +--:(if-name) {if-mib}?
           |     |     |        +--rw if-name?          string
           |     |     +--rw destination
           |     |     |  +--rw (destination-method)
           |     |     |     +--:(destination-address)
           |     |     |        +--rw destination-address?   inet:host
           |     |     +--rw maximum-packet-size?                uint16
           |     |     +--rw template-refresh-timeout?           uint32
           |     |     +--rw options-template-refresh-timeout?   uint32
           |     |     +--rw template-refresh-packet?            uint32
           |     |     +--rw options-template-refresh-packet?    uint32
           |     |     +--ro transport-session
           |     |        +--ro ipfix-version?
           |     |        |       uint16
           |     |        +--ro source-address?
           |     |        |       inet:host
           |     |        +--ro destination-address?
           |     |        |       inet:host
           |     |        +--ro source-port?
           |     |        |       inet:port-number
           |     |        +--ro destination-port?
           |     |        |       inet:port-number
           |     |        +--ro status?
           |     |        |       transport-session-status
           |     |        +--ro rate?
           |     |        |       yang:gauge32
           |     |        +--ro bytes?
           |     |        |       yang:counter64
           |     |        +--ro messages?
           |     |        |       yang:counter64
           |     |        +--ro discarded-messages?
           |     |        |       yang:counter64
           |     |        +--ro records?
           |     |        |       yang:counter64
           |     |        +--ro templates?
           |     |        |       yang:counter32
           |     |        +--ro options-templates?
           |     |        |       yang:counter32
           |     |        +--ro transport-session-start-time?
           |     |        |       yang:date-and-time
           |     |        +--ro transport-session-discontinuity-time?
           |     |        |       yang:date-and-time
           |     |        +--ro template* []
           |     |           +--ro observation-domain-id?         uint32
           |     |           +--ro template-id?                   uint16
           |     |           +--ro set-id?                        uint16
           |     |           +--ro access-time?
           |     |           |       yang:date-and-time

Boyd & Seda            Expires September 12, 2019             [Page 157]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |     |           +--ro template-data-records?
           |     |           |       yang:counter64
           |     |           +--ro template-discontinuity-time?
           |     |           |       yang:date-and-time
           |     |           +--ro field* []
           |     |              +--ro ie-id?                  ie-id-type
           |     |              +--ro ie-length?              uint16
           |     |              +--ro ie-enterprise-number?   uint32
           |     |              +--ro is-flow-key?            empty
           |     |              +--ro is-scope?               empty
           |     +--:(sctp-exporter)
           |     |  +--rw sctp-exporter {sctp-transport}?
           |     |     +--rw ipfix-version?              uint16
           |     |     +--rw destination-port?
           |     |     |       inet:port-number
           |     |     +--rw send-buffer-size?           uint32
           |     |     +--rw rate-limit?                 uint32
           |     |     +--rw transport-layer-security!
           |     |     |  +--rw local-certification-authority-dn*
           |     |     |  |       string
           |     |     |  +--rw local-subject-dn*
           |     |     |  |       string
           |     |     |  +--rw local-subject-fqdn*
           |     |     |  |       inet:domain-name
           |     |     |  +--rw remote-certification-authority-dn*
           |     |     |  |       string
           |     |     |  +--rw remote-subject-dn*
           |     |     |  |       string
           |     |     |  +--rw remote-subject-fqdn*
           |     |     |          inet:domain-name
           |     |     +--rw source
           |     |     |  +--rw (source-method)?
           |     |     |     +--:(source-address)
           |     |     |     |  +--rw source-address?   inet:host
           |     |     |     +--:(interface-ref)
           |     |     |     |  +--rw interface-ref?    if:interface-ref
           |     |     |     +--:(if-index) {if-mib}?
           |     |     |     |  +--rw if-index?         uint32
           |     |     |     +--:(if-name) {if-mib}?
           |     |     |        +--rw if-name?          string
           |     |     +--rw destination
           |     |     |  +--rw (destination-method)
           |     |     |     +--:(destination-address)
           |     |     |        +--rw destination-address?   inet:host
           |     |     +--rw timed-reliability?          uint32
           |     |     +--ro transport-session
           |     |        +--ro sctp-association-id?
           |     |        |       uint32

Boyd & Seda            Expires September 12, 2019             [Page 158]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |     |        +--ro ipfix-version?
           |     |        |       uint16
           |     |        +--ro source-address?
           |     |        |       inet:host
           |     |        +--ro destination-address?
           |     |        |       inet:host
           |     |        +--ro source-port?
           |     |        |       inet:port-number
           |     |        +--ro destination-port?
           |     |        |       inet:port-number
           |     |        +--ro status?
           |     |        |       transport-session-status
           |     |        +--ro rate?
           |     |        |       yang:gauge32
           |     |        +--ro bytes?
           |     |        |       yang:counter64
           |     |        +--ro messages?
           |     |        |       yang:counter64
           |     |        +--ro discarded-messages?
           |     |        |       yang:counter64
           |     |        +--ro records?
           |     |        |       yang:counter64
           |     |        +--ro templates?
           |     |        |       yang:counter32
           |     |        +--ro options-templates?
           |     |        |       yang:counter32
           |     |        +--ro transport-session-start-time?
           |     |        |       yang:date-and-time
           |     |        +--ro transport-session-discontinuity-time?
           |     |        |       yang:date-and-time
           |     |        +--ro template* []
           |     |           +--ro observation-domain-id?         uint32
           |     |           +--ro template-id?                   uint16
           |     |           +--ro set-id?                        uint16
           |     |           +--ro access-time?
           |     |           |       yang:date-and-time
           |     |           +--ro template-data-records?
           |     |           |       yang:counter64
           |     |           +--ro template-discontinuity-time?
           |     |           |       yang:date-and-time
           |     |           +--ro field* []
           |     |              +--ro ie-id?                  ie-id-type
           |     |              +--ro ie-length?              uint16
           |     |              +--ro ie-enterprise-number?   uint32
           |     |              +--ro is-flow-key?            empty
           |     |              +--ro is-scope?               empty
           |     +--:(file-writer)
           |        +--rw file-writer {file-writer}?

Boyd & Seda            Expires September 12, 2019             [Page 159]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

           |           +--rw ipfix-version?       uint16
           |           +--rw file                 inet:uri
           |           +--ro file-writer-state
           |              +--ro bytes?
           |              |       yang:counter64
           |              +--ro messages?
           |              |       yang:counter64
           |              +--ro discarded-messages?
           |              |       yang:counter64
           |              +--ro records?
           |              |       yang:counter64
           |              +--ro templates?
           |              |       yang:counter32
           |              +--ro options-templates?
           |              |       yang:counter32
           |              +--ro file-writer-discontinuity-time?
           |              |       yang:date-and-time
           |              +--ro template* []
           |                 +--ro observation-domain-id?         uint32
           |                 +--ro template-id?                   uint16
           |                 +--ro set-id?                        uint16
           |                 +--ro access-time?
           |                 |       yang:date-and-time
           |                 +--ro template-data-records?
           |                 |       yang:counter64
           |                 +--ro template-discontinuity-time?
           |                 |       yang:date-and-time
           |                 +--ro field* []
           |                    +--ro ie-id?                  ie-id-type
           |                    +--ro ie-length?              uint16
           |                    +--ro ie-enterprise-number?   uint32
           |                    +--ro is-flow-key?            empty
           |                    +--ro is-scope?               empty
           +--rw options* [name]
           |  +--rw name               name-type
           |  +--rw options-type       identityref
           |  +--rw options-timeout?   uint32
           +--ro exporting-process-id?   uint32

D.2.  ietf-psamp

   The complete tree diagram for ietf-psamp:

   module: ietf-psamp
     augment /ietf-ipfix:ipfix:
       +--rw psamp
          +--rw observation-point* [name]
          |  +--rw name                     ietf-ipfix:name-type

Boyd & Seda            Expires September 12, 2019             [Page 160]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

          |  +--rw observation-domain-id    uint32
          |  +--rw interface-ref*           if:interface-ref
          |  +--rw if-name*                 if-name-type {if-mib}?
          |  +--rw if-index*                uint32 {if-mib}?
          |  +--rw hardware-ref*            hardware-ref
          |  +--rw ent-physical-name*       string {entity-mib}?
          |  +--rw ent-physical-index*      uint32 {entity-mib}?
          |  +--rw direction?               direction
          |  +--rw selection-process*
          |  |       -> /ietf-ipfix:ipfix/psamp/selection-process/name
          |  +--ro observation-point-id?    uint32
          +--rw selection-process* [name]
          |  +--rw name                  ietf-ipfix:name-type
          |  +--rw selector* [name]
          |  |  +--rw name
          |  |  |       ietf-ipfix:name-type
          |  |  +--rw (method)
          |  |  |  +--:(select-all)
          |  |  |  |  +--rw select-all?              empty
          |  |  |  +--:(samp-count-based)
          |  |  |  |  +--rw samp-count-based {psamp-samp-count-based}?
          |  |  |  |     +--rw packet-interval    uint32
          |  |  |  |     +--rw packet-space       uint32
          |  |  |  +--:(samp-time-based)
          |  |  |  |  +--rw samp-time-based {psamp-samp-time-based}?
          |  |  |  |     +--rw time-interval    uint32
          |  |  |  |     +--rw time-space       uint32
          |  |  |  +--:(samp-rand-out-of-n)
          |  |  |  |  +--rw samp-rand-out-of-n
          |  |  |  |          {psamp-samp-rand-out-of-n}?
          |  |  |  |     +--rw size          uint32
          |  |  |  |     +--rw population    uint32
          |  |  |  +--:(samp-uni-prob)
          |  |  |  |  +--rw samp-uni-prob {psamp-samp-uni-prob}?
          |  |  |  |     +--rw probability    decimal64
          |  |  |  +--:(filter-match)
          |  |  |  |  +--rw filter-match {psamp-filter-match}?
          |  |  |  |     +--rw (information-element)
          |  |  |  |     |  +--:(ie-name)
          |  |  |  |     |  |  +--rw ie-name?
          |  |  |  |     |  |          ietf-ipfix:ie-name-type
          |  |  |  |     |  +--:(ie-id)
          |  |  |  |     |     +--rw ie-id?
          |  |  |  |     |             ietf-ipfix:ie-id-type
          |  |  |  |     +--rw ie-enterprise-number?   uint32
          |  |  |  |     +--rw value                   string
          |  |  |  +--:(filter-hash)
          |  |  |     +--rw filter-hash {psamp-filter-hash}?

Boyd & Seda            Expires September 12, 2019             [Page 161]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

          |  |  |        +--rw hash-function?       identityref
          |  |  |        +--rw initializer-value?   uint64
          |  |  |        +--rw ip-payload-offset?   uint64
          |  |  |        +--rw ip-payload-size?     uint64
          |  |  |        +--rw digest-output?       boolean
          |  |  |        +--rw selected-range* [name]
          |  |  |        |  +--rw name    ietf-ipfix:name-type
          |  |  |        |  +--rw min?    uint64
          |  |  |        |  +--rw max?    uint64
          |  |  |        +--ro output-range-min?    uint64
          |  |  |        +--ro output-range-max?    uint64
          |  |  +--ro packets-observed?              yang:counter64
          |  |  +--ro packets-dropped?               yang:counter64
          |  |  +--ro selector-discontinuity-time?   yang:date-and-time
          |  +--rw cache?
          |  |       -> /ietf-ipfix:ipfix/psamp/cache/name
          |  +--ro selection-sequence* []
          |     +--ro observation-domain-id?   uint32
          |     +--ro selection-sequence-id?   uint64
          +--rw cache* [name]
             +--rw name                        ietf-ipfix:name-type
             +--rw enabled?                    boolean
             +--rw (cache-type)
             |  +--:(immediate-cache)
             |  |  +--rw immediate-cache {immediate-cache}?
             |  |     +--rw cache-layout
             |  |        +--rw cache-field* [name]
             |  |           +--rw name
             |  |           |       ietf-ipfix:name-type
             |  |           +--rw (information-element)
             |  |           |  +--:(ie-name)
             |  |           |  |  +--rw ie-name?
             |  |           |  |          ietf-ipfix:ie-name-type
             |  |           |  +--:(ie-id)
             |  |           |     +--rw ie-id?
             |  |           |             ietf-ipfix:ie-id-type
             |  |           +--rw ie-length?              uint16
             |  |           +--rw ie-enterprise-number?   uint32
             |  |           +--rw is-flow-key?            empty
             |  +--:(timeout-cache)
             |  |  +--rw timeout-cache {timeout-cache}?
             |  |     +--rw max-flows?              uint32
             |  |     +--rw active-timeout?         uint32
             |  |     +--rw idle-timeout?           uint32
             |  |     +--rw export-interval?        uint32
             |  |     +--rw cache-layout
             |  |     |  +--rw cache-field* [name]
             |  |     |     +--rw name

Boyd & Seda            Expires September 12, 2019             [Page 162]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             |  |     |     |       ietf-ipfix:name-type
             |  |     |     +--rw (information-element)
             |  |     |     |  +--:(ie-name)
             |  |     |     |  |  +--rw ie-name?
             |  |     |     |  |          ietf-ipfix:ie-name-type
             |  |     |     |  +--:(ie-id)
             |  |     |     |     +--rw ie-id?
             |  |     |     |             ietf-ipfix:ie-id-type
             |  |     |     +--rw ie-length?              uint16
             |  |     |     +--rw ie-enterprise-number?   uint32
             |  |     |     +--rw is-flow-key?            empty
             |  |     +--ro active-flows?           yang:gauge32
             |  |     +--ro unused-cache-entries?   yang:gauge32
             |  +--:(natural-cache)
             |  |  +--rw natural-cache {natural-cache}?
             |  |     +--rw max-flows?              uint32
             |  |     +--rw active-timeout?         uint32
             |  |     +--rw idle-timeout?           uint32
             |  |     +--rw export-interval?        uint32
             |  |     +--rw cache-layout
             |  |     |  +--rw cache-field* [name]
             |  |     |     +--rw name
             |  |     |     |       ietf-ipfix:name-type
             |  |     |     +--rw (information-element)
             |  |     |     |  +--:(ie-name)
             |  |     |     |  |  +--rw ie-name?
             |  |     |     |  |          ietf-ipfix:ie-name-type
             |  |     |     |  +--:(ie-id)
             |  |     |     |     +--rw ie-id?
             |  |     |     |             ietf-ipfix:ie-id-type
             |  |     |     +--rw ie-length?              uint16
             |  |     |     +--rw ie-enterprise-number?   uint32
             |  |     |     +--rw is-flow-key?            empty
             |  |     +--ro active-flows?           yang:gauge32
             |  |     +--ro unused-cache-entries?   yang:gauge32
             |  +--:(permanent-cache)
             |     +--rw permanent-cache {permanent-cache}?
             |        +--rw max-flows?              uint32
             |        +--rw active-timeout?         uint32
             |        +--rw idle-timeout?           uint32
             |        +--rw export-interval?        uint32
             |        +--rw cache-layout
             |        |  +--rw cache-field* [name]
             |        |     +--rw name
             |        |     |       ietf-ipfix:name-type
             |        |     +--rw (information-element)
             |        |     |  +--:(ie-name)
             |        |     |  |  +--rw ie-name?

Boyd & Seda            Expires September 12, 2019             [Page 163]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

             |        |     |  |          ietf-ipfix:ie-name-type
             |        |     |  +--:(ie-id)
             |        |     |     +--rw ie-id?
             |        |     |             ietf-ipfix:ie-id-type
             |        |     +--rw ie-length?              uint16
             |        |     +--rw ie-enterprise-number?   uint32
             |        |     +--rw is-flow-key?            empty
             |        +--ro active-flows?           yang:gauge32
             |        +--ro unused-cache-entries?   yang:gauge32
             +--rw exporting-process*
             |       -> /ietf-ipfix:ipfix/exporting-process/name
             |       {ietf-ipfix:exporter}?
             +--ro metering-process-id?        uint32
             +--ro data-records?               yang:counter64
             +--ro cache-discontinuity-time?   yang:date-and-time

D.3.  ietf-bulk-data-export

   The complete tree diagram for ietf-bulk-data-export:

   module: ietf-bulk-data-export
     augment /ietf-ipfix:ipfix:
       +--rw bulk-data-export
          +--rw template* [name]
             +--rw name                     ietf-ipfix:name-type
             +--rw enabled?                 boolean
             +--rw export-interval?         uint32
             +--rw observation-domain-id?   uint32
             +--rw field-layout
             |  +--rw field* [name]
             |     +--rw name                    ietf-ipfix:name-type
             |     +--rw (identifier)
             |     |  +--:(ie-id)
             |     |     +--rw ie-id?            ietf-ipfix:ie-id-type
             |     +--rw ie-length?              uint16
             |     +--rw ie-enterprise-number?   uint32
             +--rw exporting-process*
             |       -> /ietf-ipfix:ipfix/exporting-process/name
             |       {ietf-ipfix:exporter}?
             +--rw resource*                resource
             +--ro data-records?            yang:counter64
             +--ro discontinuity-time?      yang:date-and-time

Authors' Addresses

Boyd & Seda            Expires September 12, 2019             [Page 164]
Internet-Draft  IPFIX/PSAMP/Bulk Data Export Data Models      March 2019

   Joey Boyd
   ADTRAN

   Email: joey.boyd@adtran.com

   Marta Seda
   Calix

   Email: marta.seda@calix.com

Boyd & Seda            Expires September 12, 2019             [Page 165]