<?xml version="1.0" encoding="UTF-8"?>
<module name="ietf-ipfix-psamp"
xmlns="urn:ietf:params:xml:ns:yang:yin:1"
xmlns:ipfix="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp"
xmlns:yang="urn:ietf:params:xml:ns:yang:ietf-yang-types"
xmlns:inet="urn:ietf:params:xml:ns:yang:ietf-inet-types">
<namespace uri="urn:ietf:params:xml:ns:yang:ietf-ipfix-psamp"/>
<prefix value="ipfix"/>
<import module="ietf-yang-types">
<prefix value="yang"/>
</import>
<import module="ietf-inet-types">
<prefix value="inet"/>
</import>
<organization>
<text>IETF IPFIX Working Group</text>
</organization>
<contact>
<text>WG Web: <http://tools.ietf.org/wg/ipfix/>
WG List: <ipfix@ietf.org>
WG Chair: Nevil Brownlee
<n.brownlee@auckland.ac.nz>
WG Chair: Juergen Quittek
<quittek@neclab.eu>
Editor: Gerhard Muenz
<muenz@net.in.tum.de></text>
</contact>
<description>
<text>IPFIX/PSAMP Configuration Data Model
Copyright (c) 2012 IETF Trust and the persons identified as
the document authors. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).</text>
</description>
<revision date="2012-09-05">
<description>
<text>Initial version</text>
</description>
<reference>
<text>RFC 6728: Configuration Data Model for the IP Flow
Information Export (IPFIX) and Packet Sampling (PSAMP)
Protocols</text>
</reference>
</revision>
<feature name="exporter">
<description>
<text>If supported, the Monitoring Device can be used as
an Exporter. Exporting Processes can be configured.</text>
</description>
</feature>
<feature name="collector">
<description>
<text>If supported, the Monitoring Device can be used as
a Collector. Collecting Processes can be configured.</text>
</description>
</feature>
<feature name="meter">
<description>
<text>If supported, Observation Points, Selection
Processes, and Caches can be configured.</text>
</description>
</feature>
<feature name="psampSampCountBased">
<description>
<text>If supported, the Monitoring Device supports
count-based Sampling. The Selector method sampCountBased can
be configured.</text>
</description>
</feature>
<feature name="psampSampTimeBased">
<description>
<text>If supported, the Monitoring Device supports
time-based Sampling. The Selector method sampTimeBased can
be configured.</text>
</description>
</feature>
<feature name="psampSampRandOutOfN">
<description>
<text>If supported, the Monitoring Device supports
random n-out-of-N Sampling. The Selector method
sampRandOutOfN can be configured.</text>
</description>
</feature>
<feature name="psampSampUniProb">
<description>
<text>If supported, the Monitoring Device supports
uniform probabilistic Sampling. The Selector method
sampUniProb can be configured.</text>
</description>
</feature>
<feature name="psampFilterMatch">
<description>
<text>If supported, the Monitoring Device supports
property match Filtering. The Selector method filterMatch
can be configured.</text>
</description>
</feature>
<feature name="psampFilterHash">
<description>
<text>If supported, the Monitoring Device supports
hash-based Filtering. The Selector method filterHash can be
configured.</text>
</description>
</feature>
<feature name="immediateCache">
<description>
<text>If supported, the Monitoring Device supports
Caches generating PSAMP Packet Reports by configuration with
immediateCache.</text>
</description>
</feature>
<feature name="timeoutCache">
<description>
<text>If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
timeoutCache.</text>
</description>
</feature>
<feature name="naturalCache">
<description>
<text>If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
naturalCache.</text>
</description>
</feature>
<feature name="permanentCache">
<description>
<text>If supported, the Monitoring Device supports
Caches generating IPFIX Flow Records by configuration with
permanentCache.</text>
</description>
</feature>
<feature name="udpTransport">
<description>
<text>If supported, the Monitoring Device supports UDP
as the transport protocol.</text>
</description>
</feature>
<feature name="tcpTransport">
<description>
<text>If supported, the Monitoring Device supports TCP
as the transport protocol.</text>
</description>
</feature>
<feature name="fileReader">
<description>
<text>If supported, the Monitoring Device supports the
configuration of Collecting Processes as File Readers.</text>
</description>
</feature>
<feature name="fileWriter">
<description>
<text>If supported, the Monitoring Device supports the
configuration of Exporting Processes as File Writers.</text>
</description>
</feature>
<identity name="hashFunction">
<description>
<text>Base identity for all hash functions used for
hash-based packet Filtering. Identities derived from
this base are used by the leaf
/ipfix/selectionProcess/selector/filterHash/hashFunction.</text>
</description>
</identity>
<identity name="BOB">
<base name="hashFunction"/>
<description>
<text>BOB hash function</text>
</description>
<reference>
<text>RFC 5475, Section 6.2.4.1.</text>
</reference>
</identity>
<identity name="IPSX">
<base name="hashFunction"/>
<description>
<text>IPSX hash function</text>
</description>
<reference>
<text>RFC 5475, Section 6.2.4.1.</text>
</reference>
</identity>
<identity name="CRC">
<base name="hashFunction"/>
<description>
<text>CRC hash function</text>
</description>
<reference>
<text>RFC 5475, Section 6.2.4.1.</text>
</reference>
</identity>
<identity name="exportMode">
<description>
<text>Base identity for different usages of export
destinations configured for an Exporting Process.
Identities derived from this base are used by the leaf
/ipfix/exportingProcess/exportMode.</text>
</description>
</identity>
<identity name="parallel">
<base name="exportMode"/>
<description>
<text>Parallel export of Data Records to all
destinations configured for the Exporting Process.</text>
</description>
</identity>
<identity name="loadBalancing">
<base name="exportMode"/>
<description>
<text>Load-balancing between the different destinations
configured for the Exporting Process.</text>
</description>
</identity>
<identity name="fallback">
<base name="exportMode"/>
<description>
<text>Export to the primary destination (i.e., the first
SCTP, UDP, TCP, or file destination configured for the
Exporting Process). If the export to the primary destination
fails, the Exporting Process tries to export to the secondary
destination. If the secondary destination fails as well, it
continues with the tertiary, etc.</text>
</description>
</identity>
<identity name="optionsType">
<description>
<text>Base identity for report types exported with
options. Identities derived from this base are used by the leaf
/ipfix/exportingProcess/options/optionsType.</text>
</description>
</identity>
<identity name="meteringStatistics">
<base name="optionsType"/>
<description>
<text>Metering Process Statistics.</text>
</description>
<reference>
<text>RFC 5101, Section 4.1.</text>
</reference>
</identity>
<identity name="meteringReliability">
<base name="optionsType"/>
<description>
<text>Metering Process Reliability Statistics.</text>
</description>
<reference>
<text>RFC 5101, Section 4.2.</text>
</reference>
</identity>
<identity name="exportingReliability">
<base name="optionsType"/>
<description>
<text>Exporting Process Reliability
Statistics.</text>
</description>
<reference>
<text>RFC 5101, Section 4.3.</text>
</reference>
</identity>
<identity name="flowKeys">
<base name="optionsType"/>
<description>
<text>Flow Keys.</text>
</description>
<reference>
<text>RFC 5101, Section 4.4.</text>
</reference>
</identity>
<identity name="selectionSequence">
<base name="optionsType"/>
<description>
<text>Selection Sequence and Selector Reports.</text>
</description>
<reference>
<text>RFC 5476, Sections 6.5.1 and 6.5.2.</text>
</reference>
</identity>
<identity name="selectionStatistics">
<base name="optionsType"/>
<description>
<text>Selection Sequence Statistics Report.</text>
</description>
<reference>
<text>RFC 5476, Sections 6.5.3.</text>
</reference>
</identity>
<identity name="accuracy">
<base name="optionsType"/>
<description>
<text>Accuracy Report.</text>
</description>
<reference>
<text>RFC 5476, Section 6.5.4.</text>
</reference>
</identity>
<identity name="reducingRedundancy">
<base name="optionsType"/>
<description>
<text>Enables the utilization of Options Templates to
reduce redundancy in the exported Data Records.</text>
</description>
<reference>
<text>RFC 5473.</text>
</reference>
</identity>
<identity name="extendedTypeInformation">
<base name="optionsType"/>
<description>
<text>Export of extended type information for
enterprise-specific Information Elements used in the
exported Templates.</text>
</description>
<reference>
<text>RFC 5610.</text>
</reference>
</identity>
<typedef name="ieNameType">
<type name="string">
<length value="1..max"/>
<pattern value="\S+"/>
</type>
<description>
<text>Type for Information Element names. Whitespaces
are not allowed.</text>
</description>
</typedef>
<typedef name="ieIdType">
<type name="uint16">
<range value="1..32767">
<description>
<text>Valid range of Information Element
identifiers.</text>
</description>
<reference>
<text>RFC 5102, Section 4.</text>
</reference>
</range>
</type>
<description>
<text>Type for Information Element identifiers.</text>
</description>
</typedef>
<typedef name="nameType">
<type name="string">
<length value="1..max"/>
<pattern value="\S(.*\S)?"/>
</type>
<description>
<text>Type for 'name' leafs, which are used to identify
specific instances within lists, etc.
Leading and trailing whitespaces are not allowed.</text>
</description>
</typedef>
<typedef name="ifNameType">
<type name="string">
<length value="1..255"/>
</type>
<description>
<text>This corresponds to the DisplayString textual
convention of SNMPv2-TC, which is used for ifName in the IF
MIB module.</text>
</description>
<reference>
<text>RFC 2863 (ifName).</text>
</reference>
</typedef>
<typedef name="direction">
<type name="enumeration">
<enum name="ingress">
<description>
<text>This value is used for monitoring incoming
packets.</text>
</description>
</enum>
<enum name="egress">
<description>
<text>This value is used for monitoring outgoing
packets.</text>
</description>
</enum>
<enum name="both">
<description>
<text>This value is used for monitoring incoming and
outgoing packets.</text>
</description>
</enum>
</type>
<description>
<text>Direction of packets going through an interface or
linecard.</text>
</description>
</typedef>
<typedef name="transportSessionStatus">
<type name="enumeration">
<enum name="inactive">
<description>
<text>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.</text>
</description>
</enum>
<enum name="active">
<description>
<text>This value MUST be used for Transport Sessions
that are currently active and transmitting or receiving
data.</text>
</description>
</enum>
<enum name="unknown">
<description>
<text>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.</text>
</description>
</enum>
</type>
<description>
<text>Status of a Transport Session.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTransportSessionStatus).</text>
</reference>
</typedef>
<grouping name="observationPointParameters">
<description>
<text>Interface as input to Observation Point.</text>
</description>
<leaf name="observationPointId">
<type name="uint32"/>
<config value="false"/>
<description>
<text>Observation Point ID (i.e., the value of the
Information Element observationPointId) assigned by the
Monitoring Device.</text>
</description>
<reference>
<text>IANA registry for IPFIX Entities,
http://www.iana.org/assignments/ipfix.</text>
</reference>
</leaf>
<leaf name="observationDomainId">
<type name="uint32"/>
<mandatory value="true"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101; RFC 6615, Section 8
(ipfixObservationPointObservationDomainId).</text>
</reference>
</leaf>
<leaf-list name="ifName">
<type name="ifNameType"/>
<description>
<text>List of names identifying interfaces of the
Monitoring Device. The Observation Point observes packets at
the specified interfaces.</text>
</description>
</leaf-list>
<leaf-list name="ifIndex">
<type name="uint32"/>
<description>
<text>List of ifIndex values pointing to entries in the
ifTable of the IF-MIB module maintained by the Monitoring
Device. The Observation Point observes packets at the
specified interfaces.
This parameter SHOULD only be used if an SNMP agent enables
access to the ifTable.
Note that this parameter corresponds to
ipfixObservationPointPhysicalInterface in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 2863; RFC 6615, Section 8
(ipfixObservationPointPhysicalInterface).</text>
</reference>
</leaf-list>
<leaf-list name="entPhysicalName">
<type name="string"/>
<description>
<text>List of names identifying physical entities of the
Monitoring Device. The Observation Point observes packets at
the specified entities.</text>
</description>
</leaf-list>
<leaf-list name="entPhysicalIndex">
<type name="uint32"/>
<description>
<text>List of entPhysicalIndex values pointing to
entries in the entPhysicalTable of the ENTITY-MIB module
maintained by the Monitoring Device. The Observation Point
observes packets at the specified entities.
This parameter SHOULD only be used if an SNMP agent enables
access to the entPhysicalTable.
Note that this parameter corresponds to
ipfixObservationPointPhysicalEntity in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 4133; RFC 6615, Section 8
(ipfixObservationPointPhysicalInterface).</text>
</reference>
</leaf-list>
<leaf name="direction">
<type name="direction"/>
<default value="both"/>
<description>
<text>Direction of packets. If not applicable (e.g., in
the case of a sniffing interface in promiscuous mode), this
parameter is ignored.</text>
</description>
</leaf>
</grouping>
<grouping name="sampCountBasedParameters">
<description>
<text>Configuration parameters of a Selector applying
systematic count-based packet Sampling to the packet
stream.</text>
</description>
<reference>
<text>RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.1.</text>
</reference>
<leaf name="packetInterval">
<type name="uint32"/>
<units name="packets"/>
<mandatory value="true"/>
<description>
<text>The number of packets that are consecutively
sampled between gaps of length packetSpace.
This parameter corresponds to the Information Element
samplingPacketInterval and to psampSampCountBasedInterval
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.2; RFC 6727, Section 6
(psampSampCountBasedInterval).</text>
</reference>
</leaf>
<leaf name="packetSpace">
<type name="uint32"/>
<units name="packets"/>
<mandatory value="true"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.3; RFC 6727, Section 6
(psampSampCountBasedSpace).</text>
</reference>
</leaf>
</grouping>
<grouping name="sampTimeBasedParameters">
<description>
<text>Configuration parameters of a Selector applying
systematic time-based packet Sampling to the packet
stream.</text>
</description>
<reference>
<text>RFC 5475, Section 5.1; RFC 5476, Section 6.5.2.2.</text>
</reference>
<leaf name="timeInterval">
<type name="uint32"/>
<units name="microseconds"/>
<mandatory value="true"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.4; RFC 6727, Section 6
(psampSampTimeBasedInterval).</text>
</reference>
</leaf>
<leaf name="timeSpace">
<type name="uint32"/>
<units name="microseconds"/>
<mandatory value="true"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.5; RFC 6727, Section 6
(psampSampTimeBasedSpace).</text>
</reference>
</leaf>
</grouping>
<grouping name="sampRandOutOfNParameters">
<description>
<text>Configuration parameters of a Selector applying
n-out-of-N packet Sampling to the packet stream.</text>
</description>
<reference>
<text>RFC 5475, Section 5.2.1; RFC 5476, Section 6.5.2.3.</text>
</reference>
<leaf name="size">
<type name="uint32"/>
<units name="packets"/>
<mandatory value="true"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.6; RFC 6727, Section 6
(psampSampRandOutOfNSize).</text>
</reference>
</leaf>
<leaf name="population">
<type name="uint32"/>
<units name="packets"/>
<mandatory value="true"/>
<description>
<text>The number of elements in the parent
population.
This parameter corresponds to the Information Element
samplingPopulation and to psampSampRandOutOfNPopulation
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.7; RFC 6727, Section 6
(psampSampRandOutOfNPopulation).</text>
</reference>
</leaf>
</grouping>
<grouping name="sampUniProbParameters">
<description>
<text>Configuration parameters of a Selector applying
uniform probabilistic packet Sampling (with equal
probability per packet) to the packet stream.</text>
</description>
<reference>
<text>RFC 5475, Section 5.2.2.1;
RFC 5476, Section 6.5.2.4.</text>
</reference>
<leaf name="probability">
<type name="decimal64">
<fraction-digits value="18"/>
<range value="0..1"/>
</type>
<mandatory value="true"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.2.8; RFC 6727, Section 6
(psampSampUniProbProbability).</text>
</reference>
</leaf>
</grouping>
<grouping name="filterMatchParameters">
<description>
<text>Configuration parameters of a Selector applying
property match Filtering to the packet stream.
The field to be matched is specified as an Information
Element.</text>
</description>
<reference>
<text>RFC 5475, Section 6.1; RFC 5476, Section 6.5.2.5.</text>
</reference>
<choice name="nameOrId">
<mandatory value="true"/>
<description>
<text>The field to be matched is specified by
either the name or the identifier of the Information
Element.</text>
</description>
<leaf name="ieName">
<type name="ieNameType"/>
<description>
<text>Name of the Information Element.</text>
</description>
</leaf>
<leaf name="ieId">
<type name="ieIdType"/>
<description>
<text>Identifier of the Information Element.</text>
</description>
</leaf>
</choice>
<leaf name="ieEnterpriseNumber">
<type name="uint32"/>
<default value="0"/>
<description>
<text>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.</text>
</description>
<reference>
<text>IANA registry for Private Enterprise Numbers,
http://www.iana.org/assignments/enterprise-numbers;
IANA registry for IPFIX Entities,
http://www.iana.org/assignments/ipfix.</text>
</reference>
</leaf>
<leaf name="value">
<type name="string"/>
<mandatory value="true"/>
<description>
<text>Matching value of the Information Element.</text>
</description>
</leaf>
</grouping>
<grouping name="filterHashParameters">
<description>
<text>Configuration parameters of a Selector applying
hash-based Filtering to the packet stream.</text>
</description>
<reference>
<text>RFC 5475, Section 6.2; RFC 5476, Section 6.5.2.6.</text>
</reference>
<leaf name="hashFunction">
<type name="identityref">
<base name="hashFunction"/>
</type>
<default value="BOB"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6727, Section 6 (psampFiltHashFunction)</text>
</reference>
</leaf>
<leaf name="initializerValue">
<type name="uint64"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.9; RFC 6727, Section 6
(psampFiltHashInitializerValue).</text>
</reference>
</leaf>
<leaf name="ipPayloadOffset">
<type name="uint64"/>
<units name="octets"/>
<default value="0"/>
<description>
<text>IP payload offset indicating the position of
the first payload byte considered as input to the hash
function.
Default value 0 corresponds to the minimum offset that
must be configurable according to RFC 5476, Section
6.5.2.6.
This parameter corresponds to the Information Element
hashIPPayloadOffset and to psampFiltHashIpPayloadOffset
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.2; RFC 6727, Section 6
(psampFiltHashIpPayloadOffset).</text>
</reference>
</leaf>
<leaf name="ipPayloadSize">
<type name="uint64"/>
<units name="octets"/>
<default value="8"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.3; RFC 6727, Section 6
(psampFiltHashIpPayloadSize).</text>
</reference>
</leaf>
<leaf name="digestOutput">
<type name="boolean"/>
<default value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.8.</text>
</reference>
</leaf>
<leaf name="outputRangeMin">
<type name="uint64"/>
<config value="false"/>
<description>
<text>Beginning of the hash function's potential
range.
This parameter corresponds to the Information Element
hashOutputRangeMin and to psampFiltHashOutputRangeMin
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.4; RFC 6727, Section 6
(psampFiltHashOutputRangeMin).</text>
</reference>
</leaf>
<leaf name="outputRangeMax">
<type name="uint64"/>
<config value="false"/>
<description>
<text>End of the hash function's potential range.
This parameter corresponds to the Information Element
hashOutputRangeMax and to psampFiltHashOutputRangeMax
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.5; RFC 6727, Section 6
(psampFiltHashOutputRangeMax).</text>
</reference>
</leaf>
<list name="selectedRange">
<key value="name"/>
<min-elements value="1"/>
<description>
<text>List of hash function return ranges for
which packets are selected.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<leaf name="min">
<type name="uint64"/>
<description>
<text>Beginning of the hash function's selected
range.
This parameter corresponds to the Information Element
hashSelectedRangeMin and to psampFiltHashSelectedRangeMin
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.6; RFC 6727, Section 6
(psampFiltHashSelectedRangeMin).</text>
</reference>
</leaf>
<leaf name="max">
<type name="uint64"/>
<description>
<text>End of the hash function's selected range.
This parameter corresponds to the Information Element
hashSelectedRangeMax and to psampFiltHashSelectedRangeMax
in the PSAMP MIB module.</text>
</description>
<reference>
<text>RFC 5477, Section 8.3.7; RFC 6727, Section 6
(psampFiltHashSelectedRangeMax).</text>
</reference>
</leaf>
</list>
</grouping>
<grouping name="selectorParameters">
<description>
<text>Configuration and state parameters of a Selector.</text>
</description>
<choice name="Method">
<mandatory value="true"/>
<description>
<text>Packet selection method applied by the Selector.</text>
</description>
<leaf name="selectAll">
<type name="empty"/>
<description>
<text>Method that selects all packets.</text>
</description>
</leaf>
<container name="sampCountBased">
<if-feature name="psampSampCountBased"/>
<description>
<text>Systematic count-based packet Sampling.</text>
</description>
<uses name="sampCountBasedParameters"/>
</container>
<container name="sampTimeBased">
<if-feature name="psampSampTimeBased"/>
<description>
<text>Systematic time-based packet Sampling.</text>
</description>
<uses name="sampTimeBasedParameters"/>
</container>
<container name="sampRandOutOfN">
<if-feature name="psampSampRandOutOfN"/>
<description>
<text>n-out-of-N packet Sampling.</text>
</description>
<uses name="sampRandOutOfNParameters"/>
</container>
<container name="sampUniProb">
<if-feature name="psampSampUniProb"/>
<description>
<text>Uniform probabilistic packet Sampling.</text>
</description>
<uses name="sampUniProbParameters"/>
</container>
<container name="filterMatch">
<if-feature name="psampFilterMatch"/>
<description>
<text>Property match Filtering.</text>
</description>
<uses name="filterMatchParameters"/>
</container>
<container name="filterHash">
<if-feature name="psampFilterHash"/>
<description>
<text>Hash-based Filtering.</text>
</description>
<uses name="filterHashParameters"/>
</container>
</choice>
<leaf name="packetsObserved">
<type name="yang:counter64"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixSelectorStatsPacketsObserved).</text>
</reference>
</leaf>
<leaf name="packetsDropped">
<type name="yang:counter64"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixSelectorStatsPacketsDropped).</text>
</reference>
</leaf>
<leaf name="selectorDiscontinuityTime">
<type name="yang:date-and-time"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixSelectionProcessStatsDiscontinuityTime).</text>
</reference>
</leaf>
</grouping>
<grouping name="cacheLayoutParameters">
<description>
<text>Cache Layout parameters used by immediateCache,
timeoutCache, naturalCache, and permanentCache.</text>
</description>
<container name="cacheLayout">
<description>
<text>Cache Layout parameters.</text>
</description>
<list name="cacheField">
<key value="name"/>
<min-elements value="1"/>
<description>
<text>Superset of fields that are included in the
Packet Reports or Flow Records generated by the Cache.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<choice name="nameOrId">
<mandatory value="true"/>
<description>
<text>Name or identifier of the Information
Element.</text>
</description>
<reference>
<text>RFC 5102, Section 2; IANA registry for IPFIX
Entities, http://www.iana.org/assignments/ipfix.</text>
</reference>
<leaf name="ieName">
<type name="ieNameType"/>
<description>
<text>Name of the Information Element.</text>
</description>
</leaf>
<leaf name="ieId">
<type name="ieIdType"/>
<description>
<text>Identifier of the Information Element.</text>
</description>
</leaf>
</choice>
<leaf name="ieLength">
<type name="uint16"/>
<units name="octets"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 6.2.</text>
</reference>
</leaf>
<leaf name="ieEnterpriseNumber">
<type name="uint32"/>
<default value="0"/>
<description>
<text>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.</text>
</description>
<reference>
<text>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.</text>
</reference>
</leaf>
<leaf name="isFlowKey">
<when condition="(name(../../..) != 'immediateCache') and ((count(../ieEnterpriseNumber) = 0) or (../ieEnterpriseNumber != 29305))">
<description>
<text>This parameter is not available for
Reverse Information Elements (which have enterprise
number 29305). It is also not available for
immediateCache.</text>
</description>
</when>
<type name="empty"/>
<description>
<text>If present, this is a flow key.</text>
</description>
</leaf>
</list>
</container>
</grouping>
<grouping name="flowCacheParameters">
<description>
<text>Configuration and state parameters of a Cache
generating Flow Records.</text>
</description>
<leaf name="maxFlows">
<type name="uint32"/>
<units name="flows"/>
<description>
<text>This parameter configures the maximum number of
Flows in the Cache, which is the maximum number of Flows
that can be measured simultaneously.
The Monitoring Device MUST ensure that sufficient resources
are available to store the configured maximum number of
Flows.
If the maximum number of Flows is measured, an additional
Flow can be measured only if an existing entry is removed.
However, traffic that pertains to existing Flows can
continue to be measured.</text>
</description>
</leaf>
<leaf name="activeTimeout">
<when condition="(name(..) = 'timeoutCache') or (name(..) = 'naturalCache')">
<description>
<text>This parameter is only available for
timeoutCache and naturalCache.</text>
</description>
</when>
<type name="uint32"/>
<units name="seconds"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixMeteringProcessCacheActiveTimeout).</text>
</reference>
</leaf>
<leaf name="idleTimeout">
<when condition="(name(..) = 'timeoutCache') or (name(..) = 'naturalCache')">
<description>
<text>This parameter is only available for
timeoutCache and naturalCache.</text>
</description>
</when>
<type name="uint32"/>
<units name="seconds"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixMeteringProcessCacheIdleTimeout).</text>
</reference>
</leaf>
<leaf name="exportInterval">
<when condition="name(..) = 'permanentCache'">
<description>
<text>This parameter is only available for
permanentCache.</text>
</description>
</when>
<type name="uint32"/>
<units name="seconds"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="activeFlows">
<type name="yang:gauge32"/>
<units name="flows"/>
<config value="false"/>
<description>
<text>The number of Flows currently active in this
Cache.
Note that this parameter corresponds to
ipfixMeteringProcessCacheActiveFlows in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixMeteringProcessCacheActiveFlows).</text>
</reference>
</leaf>
<leaf name="unusedCacheEntries">
<type name="yang:gauge32"/>
<units name="flows"/>
<config value="false"/>
<description>
<text>The number of unused Cache entries in this
Cache.
Note that this parameter corresponds to
ipfixMeteringProcessCacheUnusedCacheEntries in the IPFIX
MIB module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixMeteringProcessCacheUnusedCacheEntries).</text>
</reference>
</leaf>
</grouping>
<grouping name="exportingProcessParameters">
<description>
<text>Parameters of an Exporting Process.</text>
</description>
<leaf name="exportingProcessId">
<type name="uint32"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 4.3; IANA registry for IPFIX
Entities, http://www.iana.org/assignments/ipfix.</text>
</reference>
</leaf>
<leaf name="exportMode">
<type name="identityref">
<base name="exportMode"/>
</type>
<default value="parallel"/>
<description>
<text>This parameter determines to which configured
destination(s) the incoming Data Records are exported.</text>
</description>
</leaf>
<list name="destination">
<key value="name"/>
<min-elements value="1"/>
<description>
<text>List of export destinations.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<choice name="DestinationParameters">
<mandatory value="true"/>
<description>
<text>Configuration parameters depend on whether
SCTP, UDP, or TCP is used as transport protocol, and
whether the destination is a file.</text>
</description>
<container name="sctpExporter">
<description>
<text>SCTP parameters.</text>
</description>
<uses name="sctpExporterParameters"/>
</container>
<container name="udpExporter">
<if-feature name="udpTransport"/>
<description>
<text>UDP parameters.</text>
</description>
<uses name="udpExporterParameters"/>
</container>
<container name="tcpExporter">
<if-feature name="tcpTransport"/>
<description>
<text>TCP parameters.</text>
</description>
<uses name="tcpExporterParameters"/>
</container>
<container name="fileWriter">
<if-feature name="fileWriter"/>
<description>
<text>File Writer parameters.</text>
</description>
<uses name="fileWriterParameters"/>
</container>
</choice>
</list>
<list name="options">
<key value="name"/>
<description>
<text>List of options reported by the Exporting
Process.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="optionsParameters"/>
</list>
</grouping>
<grouping name="commonExporterParameters">
<description>
<text>Parameters of en export destination that are
common to all transport protocols.</text>
</description>
<leaf name="ipfixVersion">
<type name="uint16"/>
<default value="10"/>
<description>
<text>IPFIX version number.</text>
</description>
<reference>
<text>RFC 5101.</text>
</reference>
</leaf>
<leaf name="destinationPort">
<type name="inet:port-number"/>
<description>
<text>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.</text>
</description>
</leaf>
<choice name="indexOrName">
<description>
<text>Index or name of the interface as stored in the
ifTable of IF-MIB.
If configured, the Exporting Process MUST use the given
interface to export IPFIX Messages to the export
destination.
If omitted, the Exporting Process selects the outgoing
interface based on local routing decision and accepts
return traffic, such as transport-layer acknowledgments,
on all available interfaces.</text>
</description>
<reference>
<text>RFC 2863.</text>
</reference>
<leaf name="ifIndex">
<type name="uint32"/>
<description>
<text>Index of an interface as stored in the ifTable
of IF-MIB.</text>
</description>
<reference>
<text>RFC 2863.</text>
</reference>
</leaf>
<leaf name="ifName">
<type name="string"/>
<description>
<text>Name of an interface as stored in the ifTable
of IF-MIB.</text>
</description>
<reference>
<text>RFC 2863.</text>
</reference>
</leaf>
</choice>
<leaf name="sendBufferSize">
<type name="uint32"/>
<units name="bytes"/>
<description>
<text>Size of the socket send buffer.
If not configured by the user, this parameter is set by
the Monitoring Device.</text>
</description>
</leaf>
<leaf name="rateLimit">
<type name="uint32"/>
<units name="bytes per second"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5476, Section 6.3.</text>
</reference>
</leaf>
<container name="transportLayerSecurity">
<presence value="If transportLayerSecurity is present, DTLS is enabled if the transport protocol is SCTP or UDP, and TLS is enabled if the transport protocol is TCP."/>
<description>
<text>TLS or DTLS configuration.</text>
</description>
<uses name="transportLayerSecurityParameters"/>
</container>
<container name="transportSession">
<config value="false"/>
<description>
<text>State parameters of the Transport Session
directed to the given destination.</text>
</description>
<uses name="transportSessionParameters"/>
</container>
</grouping>
<grouping name="sctpExporterParameters">
<description>
<text>SCTP-specific export destination parameters.</text>
</description>
<uses name="commonExporterParameters"/>
<leaf-list name="sourceIPAddress">
<type name="inet:ip-address"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 4960, Section 6.4.</text>
</reference>
</leaf-list>
<leaf-list name="destinationIPAddress">
<type name="inet:ip-address"/>
<min-elements value="1"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 4960, Section 6.4.</text>
</reference>
</leaf-list>
<leaf name="timedReliability">
<type name="uint32"/>
<units name="milliseconds"/>
<default value="0"/>
<description>
<text>Lifetime in milliseconds until an IPFIX
Message containing Data Sets only is 'abandoned' due to
the timed reliability mechanism of PR-SCTP.
If this parameter is set to zero, reliable SCTP
transport is used for all Data Records.
Regardless of the value of this parameter, the Exporting
Process MAY use reliable SCTP transport for Data Sets
associated with Options Templates.</text>
</description>
<reference>
<text>RFC 3758; RFC 4960.</text>
</reference>
</leaf>
</grouping>
<grouping name="udpExporterParameters">
<description>
<text>Parameters of a UDP export destination.</text>
</description>
<uses name="commonExporterParameters"/>
<leaf name="sourceIPAddress">
<type name="inet:ip-address"/>
<description>
<text>Source IP address used by the Exporting Process.
If not configured, the IP address assigned to the outgoing
interface is used as source IP address.</text>
</description>
</leaf>
<leaf name="destinationIPAddress">
<type name="inet:ip-address"/>
<mandatory value="true"/>
<description>
<text>IP address of the Collection Process to which
IPFIX Messages are sent.</text>
</description>
</leaf>
<leaf name="maxPacketSize">
<type name="uint16"/>
<units name="octets"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="templateRefreshTimeout">
<type name="uint32"/>
<units name="seconds"/>
<default value="600"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.6; RFC 6615, Section 8
(ipfixTransportSessionTemplateRefreshTimeout).</text>
</reference>
</leaf>
<leaf name="optionsTemplateRefreshTimeout">
<type name="uint32"/>
<units name="seconds"/>
<default value="600"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.6; RFC 6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshTimeout).</text>
</reference>
</leaf>
<leaf name="templateRefreshPacket">
<type name="uint32"/>
<units name="IPFIX Messages"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.6; RFC 6615, Section 8
(ipfixTransportSessionTemplateRefreshPacket).</text>
</reference>
</leaf>
<leaf name="optionsTemplateRefreshPacket">
<type name="uint32"/>
<units name="IPFIX Messages"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.6; RFC 6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshPacket).</text>
</reference>
</leaf>
</grouping>
<grouping name="tcpExporterParameters">
<description>
<text>Parameters of a TCP export destination.</text>
</description>
<uses name="commonExporterParameters"/>
<leaf name="sourceIPAddress">
<type name="inet:ip-address"/>
<description>
<text>Source IP address used by the Exporting Process.
If not configured by the user, this parameter is set by
the Monitoring Device to an IP address assigned to the
outgoing interface.</text>
</description>
</leaf>
<leaf name="destinationIPAddress">
<type name="inet:ip-address"/>
<mandatory value="true"/>
<description>
<text>IP address of the Collection Process to which
IPFIX Messages are sent.</text>
</description>
</leaf>
</grouping>
<grouping name="fileWriterParameters">
<description>
<text>File Writer parameters.</text>
</description>
<leaf name="ipfixVersion">
<type name="uint16"/>
<default value="10"/>
<description>
<text>IPFIX version number.</text>
</description>
<reference>
<text>RFC 5101.</text>
</reference>
</leaf>
<leaf name="file">
<type name="inet:uri"/>
<mandatory value="true"/>
<description>
<text>URI specifying the location of the file.</text>
</description>
</leaf>
<leaf name="bytes">
<type name="yang:counter64"/>
<units name="octets"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="messages">
<type name="yang:counter64"/>
<units name="IPFIX Messages"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="discardedMessages">
<type name="yang:counter64"/>
<units name="IPFIX Messages"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="records">
<type name="yang:counter64"/>
<units name="Data Records"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="templates">
<type name="yang:counter32"/>
<units name="Templates"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="optionsTemplates">
<type name="yang:counter32"/>
<units name="Options Templates"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="fileWriterDiscontinuityTime">
<type name="yang:date-and-time"/>
<config value="false"/>
<description>
<text>Timestamp of the most recent occasion at which
one or more File Writer counters suffered a discontinuity.
In contrast to discontinuity times in the IPFIX MIB module,
the time is absolute and not relative to sysUpTime.</text>
</description>
</leaf>
<list name="template">
<config value="false"/>
<description>
<text>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.</text>
</description>
<uses name="templateParameters"/>
</list>
</grouping>
<grouping name="optionsParameters">
<description>
<text>Parameters specifying the data export using an
Options Template.</text>
</description>
<leaf name="optionsType">
<type name="identityref">
<base name="optionsType"/>
</type>
<mandatory value="true"/>
<description>
<text>Type of the exported options data.</text>
</description>
</leaf>
<leaf name="optionsTimeout">
<type name="uint32"/>
<units name="milliseconds"/>
<description>
<text>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.</text>
</description>
</leaf>
</grouping>
<grouping name="collectingProcessParameters">
<description>
<text>Parameters of a Collecting Process.</text>
</description>
<list name="sctpCollector">
<key value="name"/>
<description>
<text>List of SCTP receivers (sockets) on which the
Collecting Process receives IPFIX Messages.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="sctpCollectorParameters"/>
</list>
<list name="udpCollector">
<if-feature name="udpTransport"/>
<key value="name"/>
<description>
<text>List of UDP receivers (sockets) on which the
Collecting Process receives IPFIX Messages.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="udpCollectorParameters"/>
</list>
<list name="tcpCollector">
<if-feature name="tcpTransport"/>
<key value="name"/>
<description>
<text>List of TCP receivers (sockets) on which the
Collecting Process receives IPFIX Messages.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="tcpCollectorParameters"/>
</list>
<list name="fileReader">
<if-feature name="fileReader"/>
<key value="name"/>
<description>
<text>List of File Readers from which the Collecting
Process reads IPFIX Messages.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="fileReaderParameters"/>
</list>
</grouping>
<grouping name="commonCollectorParameters">
<description>
<text>Parameters of a Collecting Process that are
common to all transport protocols.</text>
</description>
<leaf name="localPort">
<type name="inet:port-number"/>
<description>
<text>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.</text>
</description>
</leaf>
<container name="transportLayerSecurity">
<presence value="If transportLayerSecurity is present, DTLS is enabled if the transport protocol is SCTP or UDP, and TLS is enabled if the transport protocol is TCP."/>
<description>
<text>TLS or DTLS configuration.</text>
</description>
<uses name="transportLayerSecurityParameters"/>
</container>
<list name="transportSession">
<config value="false"/>
<description>
<text>This list contains the currently established
Transport Sessions terminating at the given socket.</text>
</description>
<uses name="transportSessionParameters"/>
</list>
</grouping>
<grouping name="sctpCollectorParameters">
<description>
<text>Parameters of a listening SCTP socket at a
Collecting Process.</text>
</description>
<uses name="commonCollectorParameters"/>
<leaf-list name="localIPAddress">
<type name="inet:ip-address"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 4960, Section 6.4.</text>
</reference>
</leaf-list>
</grouping>
<grouping name="udpCollectorParameters">
<description>
<text>Parameters of a listening UDP socket at a
Collecting Process.</text>
</description>
<uses name="commonCollectorParameters"/>
<leaf-list name="localIPAddress">
<type name="inet:ip-address"/>
<description>
<text>List of local IP addresses on which the Collecting
Process listens for IPFIX Messages.</text>
</description>
</leaf-list>
<leaf name="templateLifeTime">
<type name="uint32"/>
<units name="seconds"/>
<default value="1800"/>
<description>
<text>Sets the lifetime of Templates for all UDP
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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.7; RFC 6615, Section 8
(ipfixTransportSessionTemplateRefreshTimeout).</text>
</reference>
</leaf>
<leaf name="optionsTemplateLifeTime">
<type name="uint32"/>
<units name="seconds"/>
<default value="1800"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.7; RFC 6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshTimeout).</text>
</reference>
</leaf>
<leaf name="templateLifePacket">
<type name="uint32"/>
<units name="IPFIX Messages"/>
<description>
<text>If this parameter is configured, Templates
defined in a UDP Transport Session become invalid if they
are neither included in a sequence of more than this number
of IPFIX Messages nor received again within the period of
time specified by templateLifeTime.
Note that this parameter corresponds to
ipfixTransportSessionTemplateRefreshPacket in the IPFIX
MIB module.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.7; RFC 6615, Section 8
(ipfixTransportSessionTemplateRefreshPacket).</text>
</reference>
</leaf>
<leaf name="optionsTemplateLifePacket">
<type name="uint32"/>
<units name="IPFIX Messages"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Section 10.3.7; RFC 6615, Section 8
(ipfixTransportSessionOptionsTemplateRefreshPacket).</text>
</reference>
</leaf>
</grouping>
<grouping name="tcpCollectorParameters">
<description>
<text>Parameters of a listening TCP socket at a
Collecting Process.</text>
</description>
<uses name="commonCollectorParameters"/>
<leaf-list name="localIPAddress">
<type name="inet:ip-address"/>
<description>
<text>List of local IP addresses on which the Collecting
Process listens for IPFIX Messages.</text>
</description>
</leaf-list>
</grouping>
<grouping name="fileReaderParameters">
<description>
<text>File Reader parameters.</text>
</description>
<leaf name="file">
<type name="inet:uri"/>
<mandatory value="true"/>
<description>
<text>URI specifying the location of the file.</text>
</description>
</leaf>
<leaf name="bytes">
<type name="yang:counter64"/>
<units name="octets"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="messages">
<type name="yang:counter64"/>
<units name="IPFIX Messages"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="records">
<type name="yang:counter64"/>
<units name="Data Records"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="templates">
<type name="yang:counter32"/>
<units name="Templates"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="optionsTemplates">
<type name="yang:counter32"/>
<units name="Options Templates"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<leaf name="fileReaderDiscontinuityTime">
<type name="yang:date-and-time"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
</leaf>
<list name="template">
<config value="false"/>
<description>
<text>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.</text>
</description>
<uses name="templateParameters"/>
</list>
</grouping>
<grouping name="transportLayerSecurityParameters">
<description>
<text>TLS or DTLS parameters.</text>
</description>
<leaf-list name="localCertificationAuthorityDN">
<type name="string"/>
<description>
<text>Distinguished names of certification authorities
whose certificates may be used to identify the local
endpoint.</text>
</description>
<reference>
<text>RFC 5280.</text>
</reference>
</leaf-list>
<leaf-list name="localSubjectDN">
<type name="string"/>
<description>
<text>Distinguished names that may be used in the
certificates to identify the local endpoint.</text>
</description>
<reference>
<text>RFC 5280.</text>
</reference>
</leaf-list>
<leaf-list name="localSubjectFQDN">
<type name="inet:domain-name"/>
<description>
<text>Fully qualified domain names that may be used to
in the certificates to identify the local endpoint.</text>
</description>
<reference>
<text>RFC 5280.</text>
</reference>
</leaf-list>
<leaf-list name="remoteCertificationAuthorityDN">
<type name="string"/>
<description>
<text>Distinguished names of certification authorities
whose certificates are accepted to authorize remote
endpoints.</text>
</description>
<reference>
<text>RFC 5280.</text>
</reference>
</leaf-list>
<leaf-list name="remoteSubjectDN">
<type name="string"/>
<description>
<text>Distinguished names which are accepted in
certificates to authorize remote endpoints.</text>
</description>
<reference>
<text>RFC 5280.</text>
</reference>
</leaf-list>
<leaf-list name="remoteSubjectFQDN">
<type name="inet:domain-name"/>
<description>
<text>Fully qualified domain names that are accepted in
certificates to authorize remote endpoints.</text>
</description>
<reference>
<text>RFC 5280.</text>
</reference>
</leaf-list>
</grouping>
<grouping name="templateParameters">
<description>
<text>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</text>
</description>
<reference>
<text>RFC 5101; RFC 6615, Section 8 (ipfixTemplateEntry,
ipfixTemplateDefinitionEntry, ipfixTemplateStatsEntry)</text>
</reference>
<leaf name="observationDomainId">
<type name="uint32"/>
<description>
<text>The ID of the Observation Domain for which this
Template is defined.
Note that this parameter corresponds to
ipfixTemplateObservationDomainId in the IPFIX MIB module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTemplateObservationDomainId).</text>
</reference>
</leaf>
<leaf name="templateId">
<type name="uint16">
<range value="256..65535">
<description>
<text>Valid range of Template IDs.</text>
</description>
<reference>
<text>RFC 5101</text>
</reference>
</range>
</type>
<description>
<text>This number indicates the Template ID in the IPFIX
message.
Note that this parameter corresponds to ipfixTemplateId in
the IPFIX MIB module.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTemplateId).</text>
</reference>
</leaf>
<leaf name="setId">
<type name="uint16"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTemplateSetId).</text>
</reference>
</leaf>
<leaf name="accessTime">
<type name="yang:date-and-time"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTemplateAccessTime).</text>
</reference>
</leaf>
<leaf name="templateDataRecords">
<type name="yang:counter64"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTemplateDataRecords).</text>
</reference>
</leaf>
<leaf name="templateDiscontinuityTime">
<type name="yang:date-and-time"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTemplateDiscontinuityTime).</text>
</reference>
</leaf>
<list name="field">
<description>
<text>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.</text>
</description>
<leaf name="ieId">
<type name="ieIdType"/>
<description>
<text>This parameter indicates the Information
Element identifier of the field.
Note that this parameter corresponds to
ipfixTemplateDefinitionIeId in the IPFIX MIB module.</text>
</description>
<reference>
<text>RFC 5101; RFC 6615, Section 8
(ipfixTemplateDefinitionIeId).</text>
</reference>
</leaf>
<leaf name="ieLength">
<type name="uint16"/>
<units name="octets"/>
<description>
<text>This parameter indicates the length of the
Information Element of the field.
Note that this parameter corresponds to
ipfixTemplateDefinitionIeLength in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 5101; RFC 6615, Section 8
(ipfixTemplateDefinitionIeLength).</text>
</reference>
</leaf>
<leaf name="ieEnterpriseNumber">
<type name="uint32"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTemplateDefinitionIeEnterpriseNumber);
IANA registry for Private Enterprise Numbers,
http://www.iana.org/assignments/enterprise-numbers.</text>
</reference>
</leaf>
<leaf name="isFlowKey">
<when condition="../../setId = 2">
<description>
<text>This parameter is available for non-Options
Templates (Set ID is 2).</text>
</description>
</when>
<type name="empty"/>
<description>
<text>If present, this is a Flow Key field.
Note that this corresponds to flowKey(1) being set in
ipfixTemplateDefinitionFlags.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTemplateDefinitionFlags).</text>
</reference>
</leaf>
<leaf name="isScope">
<when condition="../../setId = 3">
<description>
<text>This parameter is available for Options
Templates (Set ID is 3).</text>
</description>
</when>
<type name="empty"/>
<description>
<text>If present, this is a scope field.
Note that this corresponds to scope(0) being set in
ipfixTemplateDefinitionFlags.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTemplateDefinitionFlags).</text>
</reference>
</leaf>
</list>
</grouping>
<grouping name="transportSessionParameters">
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101; RFC 6615, Section 8
(ipfixTransportSessionEntry,
ipfixTransportSessionStatsEntry).</text>
</reference>
<leaf name="ipfixVersion">
<type name="uint16"/>
<description>
<text>Used for Exporting Processes, this parameter
contains the version number of the IPFIX protocol that the
Exporter uses to export its data in this Transport Session.
Hence, it is identical to the value of the configuration
parameter ipfixVersion of the outer SctpExporter,
UdpExporter, or TcpExporter node.
Used for Collecting Processes, this parameter contains the
version number of the IPFIX protocol it receives for
this Transport Session. If IPFIX Messages of different
IPFIX protocol versions are received, this parameter
contains the maximum version number.
Note that this parameter corresponds to
ipfixTransportSessionIpfixVersion in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionIpfixVersion).</text>
</reference>
</leaf>
<leaf name="sourceAddress">
<type name="inet:ip-address"/>
<description>
<text>The source address of the Exporter of the
IPFIX Transport Session.
If the transport protocol is SCTP, this is one of the
potentially many IP addresses of the Exporter.
Preferably, the source IP address of the path that is
usually selected by the Exporter to send IPFIX Messages to
the Collector SHOULD be used.
Note that this parameter functionally corresponds to
ipfixTransportSessionSourceAddressType and
ipfixTransportSessionSourceAddress in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionSourceAddressType,
ipfixTransportSessionSourceAddress);
RFC 4960, Section 6.4.</text>
</reference>
</leaf>
<leaf name="destinationAddress">
<type name="inet:ip-address"/>
<description>
<text>The destination address of the Collector of
the IPFIX Transport Session.
If the transport protocol is SCTP, this is one of the
potentially many IP addresses of the Collector.
Preferably, the destination IP address of the path that is
usually selected by the Exporter to send IPFIX Messages to
the Collector SHOULD be used.
Note that this parameter functionally corresponds to
ipfixTransportSessionDestinationAddressType and
ipfixTransportSessionDestinationAddress in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionDestinationAddressType,
ipfixTransportSessionDestinationAddress);
RFC 4960, Section 6.4.</text>
</reference>
</leaf>
<leaf name="sourcePort">
<type name="inet:port-number"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionSourcePort).</text>
</reference>
</leaf>
<leaf name="destinationPort">
<type name="inet:port-number"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionDestinationPort).</text>
</reference>
</leaf>
<leaf name="sctpAssocId">
<type name="uint32"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionSctpAssocId);
RFC 3871</text>
</reference>
</leaf>
<leaf name="status">
<type name="transportSessionStatus"/>
<description>
<text>Status of the Transport Session.
Note that this parameter corresponds to
ipfixTransportSessionStatus in the IPFIX MIB module.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTransportSessionStatus).</text>
</reference>
</leaf>
<leaf name="rate">
<type name="yang:gauge32"/>
<units name="bytes per second"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTransportSessionRate).</text>
</reference>
</leaf>
<leaf name="bytes">
<type name="yang:counter64"/>
<units name="bytes"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8 (ipfixTransportSessionBytes).</text>
</reference>
</leaf>
<leaf name="messages">
<type name="yang:counter64"/>
<units name="IPFIX Messages"/>
<description>
<text>The number of messages transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionMessages in the IPFIX MIB module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionMessages).</text>
</reference>
</leaf>
<leaf name="discardedMessages">
<type name="yang:counter64"/>
<units name="IPFIX Messages"/>
<description>
<text>Used for Exporting Processes, this parameter
indicates the number of messages that could not be sent due
to internal buffer overflows, network congestion, routing
issues, etc. Used for Collecting Process, this parameter
indicates the number of received IPFIX Message that are
malformed, cannot be decoded, are received in the wrong
order or are missing according to the sequence number.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionDiscardedMessages in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionDiscardedMessages).</text>
</reference>
</leaf>
<leaf name="records">
<type name="yang:counter64"/>
<units name="Data Records"/>
<description>
<text>The number of Data Records transmitted by the
Exporting Process or received by the Collecting Process.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
transportSessionDiscontinuityTime.
Note that this parameter corresponds to
ipfixTransportSessionRecords in the IPFIX MIB module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionRecords).</text>
</reference>
</leaf>
<leaf name="templates">
<type name="yang:counter32"/>
<units name="Templates"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionTemplates).</text>
</reference>
</leaf>
<leaf name="optionsTemplates">
<type name="yang:counter32"/>
<units name="Options Templates"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionOptionsTemplates).</text>
</reference>
</leaf>
<leaf name="transportSessionStartTime">
<type name="yang:date-and-time"/>
<description>
<text>Timestamp of the start of the given Transport
Session.
This state parameter does not correspond to any object in
the IPFIX MIB module.</text>
</description>
</leaf>
<leaf name="transportSessionDiscontinuityTime">
<type name="yang:date-and-time"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixTransportSessionDiscontinuityTime).</text>
</reference>
</leaf>
<list name="template">
<description>
<text>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.</text>
</description>
<uses name="templateParameters"/>
</list>
</grouping>
<container name="ipfix">
<description>
<text>Top-level node of the IPFIX/PSAMP configuration
data model.</text>
</description>
<list name="collectingProcess">
<if-feature name="collector"/>
<key value="name"/>
<description>
<text>Collecting Process of the Monitoring Device.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="collectingProcessParameters"/>
<leaf-list name="exportingProcess">
<if-feature name="exporter"/>
<type name="leafref">
<path value="/ipfix/exportingProcess/name"/>
</type>
<description>
<text>Export of received records without any
modifications. Records are processed by all Exporting
Processes in the list.</text>
</description>
</leaf-list>
</list>
<list name="observationPoint">
<if-feature name="meter"/>
<key value="name"/>
<description>
<text>Observation Point of the Monitoring Device.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="observationPointParameters"/>
<leaf-list name="selectionProcess">
<type name="leafref">
<path value="/ipfix/selectionProcess/name"/>
</type>
<description>
<text>Selection Processes in this list process
packets in parallel.</text>
</description>
</leaf-list>
</list>
<list name="selectionProcess">
<if-feature name="meter"/>
<key value="name"/>
<description>
<text>Selection Process of the Monitoring Device.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<list name="selector">
<key value="name"/>
<min-elements value="1"/>
<ordered-by value="user"/>
<description>
<text>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.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="selectorParameters"/>
</list>
<list name="selectionSequence">
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5476.</text>
</reference>
<leaf name="observationDomainId">
<type name="uint32"/>
<description>
<text>Observation Domain ID for which the
Selection Sequence ID is assigned.</text>
</description>
</leaf>
<leaf name="selectionSequenceId">
<type name="uint64"/>
<description>
<text>Selection Sequence ID used in the Selection
Sequence (Statistics) Report Interpretation.</text>
</description>
</leaf>
</list>
<leaf name="cache">
<type name="leafref">
<path value="/ipfix/cache/name"/>
</type>
<description>
<text>Cache that receives the output of the
Selection Process.</text>
</description>
</leaf>
</list>
<list name="cache">
<if-feature name="meter"/>
<key value="name"/>
<description>
<text>Cache of the Monitoring Device.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<leaf name="meteringProcessId">
<type name="uint32"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 5101, Sections 4.1 and 4.2;
IANA registry for IPFIX Entities,
http://www.iana.org/assignments/ipfix.</text>
</reference>
</leaf>
<leaf name="dataRecords">
<type name="yang:counter64"/>
<units name="Data Records"/>
<config value="false"/>
<description>
<text>The number of Data Records generated by this
Cache.
Discontinuities in the value of this counter can occur at
re-initialization of the management system, and at other
times as indicated by the value of
cacheDiscontinuityTime.
Note that this parameter corresponds to
ipfixMeteringProcessDataRecords in the IPFIX MIB
module.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixMeteringProcessDataRecords).</text>
</reference>
</leaf>
<leaf name="cacheDiscontinuityTime">
<type name="yang:date-and-time"/>
<config value="false"/>
<description>
<text>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.</text>
</description>
<reference>
<text>RFC 6615, Section 8
(ipfixMeteringProcessDiscontinuityTime).</text>
</reference>
</leaf>
<choice name="CacheType">
<mandatory value="true"/>
<description>
<text>Type of Cache and specific parameters.</text>
</description>
<container name="immediateCache">
<if-feature name="immediateCache"/>
<description>
<text>Flow expiration after the first packet;
generation of Packet Records.</text>
</description>
<uses name="cacheLayoutParameters"/>
</container>
<container name="timeoutCache">
<if-feature name="timeoutCache"/>
<description>
<text>Flow expiration after active and idle
timeout; generation of Flow Records.</text>
</description>
<uses name="flowCacheParameters"/>
<uses name="cacheLayoutParameters"/>
</container>
<container name="naturalCache">
<if-feature name="naturalCache"/>
<description>
<text>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.</text>
</description>
<uses name="flowCacheParameters"/>
<uses name="cacheLayoutParameters"/>
</container>
<container name="permanentCache">
<if-feature name="permanentCache"/>
<description>
<text>No flow expiration, periodical export with
time interval exportInterval; generation of Flow
Records.</text>
</description>
<uses name="flowCacheParameters"/>
<uses name="cacheLayoutParameters"/>
</container>
</choice>
<leaf-list name="exportingProcess">
<if-feature name="exporter"/>
<type name="leafref">
<path value="/ipfix/exportingProcess/name"/>
</type>
<description>
<text>Records are exported by all Exporting Processes
in the list.</text>
</description>
</leaf-list>
</list>
<list name="exportingProcess">
<if-feature name="exporter"/>
<key value="name"/>
<description>
<text>Exporting Process of the Monitoring Device.</text>
</description>
<leaf name="name">
<type name="nameType"/>
<description>
<text>Key of this list.</text>
</description>
</leaf>
<uses name="exportingProcessParameters"/>
</list>
</container>
</module>