A YANG Data Model for Network Interconnect Tester ManagementLightside Instruments ASvladimir@lightside-instruments.com
This document introduces new YANG model for use in network interconnect testing containing modules of traffic generator and traffic analyzer.
There is a need for standard mechanism to allow the specification
and implementation of the transactions part of network tests.
The mechanism should allow the control and monitoring of the data plane traffic in a transactional way.
This document defines two YANG modules for test traffic generator and analyzer.
The YANG modules in this document conform to the Network Management Datastore Architecture (NMDA) defined in RFC 8342.
DUT: Device Under TestTA: Traffic AnalyzerTG: Traffic GeneratorFor a reference to the annotations used in tree diagrams included
in this document, please see YANG Tree
Diagrams.
Network interconnect tests require active network
elements part of the tested network that generate
test traffic and network elements that analyze
the test traffic at one or more points of its path.
A network interconnect tester is a device that can either
generate test traffic, analyze test traffic or both.
Here is a figure borrowed from
representing the horseshoe test setup topology consisting
of a single tester and a single DUT connected in a
network interconnect loop.
| DUT |--------------+
| |
+------------+
]]>
This document attempts to address the problem of defining YANG
model of a network interconnect tester that can be used for
development of vendor independent network interconnect tests
and utilize the advantages of transactional management using
standard protocols like NETCONF.
This section describes some of the design objectives for the model. It should:
provide means to specify the generated traffic as streams of cyclic sequence of bursts with configurable frame size, frame data, interframe gap and interburst gap.have a mandatory single stream mode and optional multi stream mode.provide means for configuration of traffic streams with static frame data where frames with identical frame data are sent during the lifetime of the stream.provide means for configuration of traffic streams with dynamic frame data where frames contain fields with dynamic data like generation time and sequence number.allow third parties to augment the base module with alternative dynamic fields of frame data extensions.provide means for realtime synchronization and orchestration of the generated streams.provide counters for received test traffic frames and octets.provide latency statistic in the case of test traffic with dynamic frame data that includes timestamp.provide sequence number errors in the case of test traffic with dynamic frame data that includes sequence number.
The proposed model splits the design into 2 modules - 1) Traffic
Generator module (TG), 2) Traffic Analyzer module (TA). The modules are
implemented as augmentations of the ietf-interfaces
module adding configuration and state data that models the
functionality of a network interconnect tester. The TA and TG modules concept is
illustrated with the following diagram of a tester with two interfaces (named e0 and e1) connected in a loop with single DUT:
| DUT |----------------+
| |
+------------+
]]>
Basic example of how the model can be used in transactional network test program to control the testers part of a network and report counter statistics and timing measurement data is presented in .
All example cases present the configuration and state data from a single test trial. The search algorithm logic that operates to control the trial configuration is outside the scope of this document.
One of the examples demonstrates the use of the defined testframe packet.
<CODE BEGINS> file "ietf-traffic-generator@2021-10-25.yang"
WG List:
Editor: Vladimir Vassilev
";
description
"This module contains a collection of YANG definitions for
description and management of network interconnect testers.
Copyright (c) 2021 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 RFC XXXX; see
the RFC itself for full legal notices.";
revision 2021-10-25 {
description
"Initial revision.";
reference
"RFC XXXX: A YANG Data Model for
Network Interconnect Tester Management";
}
feature egress-direction {
description
"The device can generate traffic in the egress direction.";
}
feature ingress-direction {
description
"The device can generate traffic in the ingress direction.";
}
feature multi-stream {
description
"The device can generate multi-stream traffic.";
}
feature ethernet {
description
"The device can generate ethernet traffic.";
}
feature realtime-epoch {
description
"The device can generate traffic precisely
at configured realtime epoch.";
}
identity testframe-type {
description
"Base identity for all testframe types.";
}
identity static {
base testframe-type;
description
"Identity for static testframe.
The frame data and size are constant.";
}
identity dynamic {
base testframe-type;
description
"Identity to be used as base for dynamic
testframe type identities defined
in external modules.
When used itself it identifies dynamic testframe
where the last 18 octets of the payload contain
incrementing sequence number field (8 octets)
followed by timestamp field in the
IEEE 1588-2008 format (10 octets). If frame data is defined
for the last 18 octets of the payload it will be ignored
and overwritten with dynamic data according to this
specification.";
}
grouping common-data {
description
"Common configuration data.";
leaf realtime-epoch {
if-feature "realtime-epoch";
type yang:date-and-time;
description
"If this leaf is present the stream generation will start
at the specified realtime epoch.";
}
leaf total-frames {
type uint64;
description
"If this leaf is present the traffic generation will stop
after the specified number of frames are generated.";
}
}
grouping burst-data {
description
"Generated traffic burst parameters.";
leaf testframe-type {
type identityref {
base nttg:testframe-type;
}
default "nttg:static";
description
"In case of dynamic testframes this leaf specifies
the dynamic testframe identity.";
}
leaf frame-size {
type uint32;
mandatory true;
description
"Size of the frames generated. For example for
ethernet interfaces the following definition
applies:
Ethernet frame-size in octets includes:
* Destination Address (6 octets),
* Source Address (6 octets),
* Frame Type (2 octets),
* Data (min 46 octets or 42 octets + 4 octets 802.1Q tag),
* CRC Checksum (4 octets).
Ethernet frame-size does not include:
* Preamble (dependent on MAC configuration
by default 7 octets),
* Start of frame delimiter (1 octet)
Minimum standard ethernet frame-size is 64 bytes but
generators might support smaller sizes for validation.";
}
leaf frame-data {
type string {
pattern '([0-9A-F]{2})*';
}
must 'string-length(.)<=(../frame-size*2)';
description
"The raw frame data specified as hexadecimal string.
The specified data can be shorter then the ../frame-size
value specifying only the header or the header and the
payload with or without the 4 byte CRC Checksum
in the case of a Ethernet frame.";
}
leaf interframe-gap {
type uint32;
mandatory true;
description
"Length of the idle period between generated frames.
For example for ethernet interfaces the following
definition applies:
Ethernet interframe-gap between transmission of frames
known as the interframe gap (IFG). A brief recovery time
between frames allows devices to prepare for
reception of the next frame. The minimum
interframe gap is 96 bit times (12 octet times) (the time it
takes to transmit 96 bits (12 octets) of raw data on the
medium). However the preamble (7 octets) and start of
frame delimiter (1 octet) are considered a constant gap that
should be included in the interframe-gap. Thus the minimum
value for standard ethernet transmission should be considered
20 octets.";
}
leaf interburst-gap {
type uint32;
description
"Similar to the interframe-gap but takes place between
any two bursts of the stream.";
}
leaf frames-per-burst {
type uint32;
description
"Number of frames contained in a burst";
}
}
grouping multi-stream-data {
description
"Multi stream traffic generation parameters.";
container streams {
description
"Non-presence container holding the configured stream list.";
list stream {
key "id";
description
"Each stream repeats a burst until frames-per-stream
count is reached followed by interstream-gap delay.";
leaf id {
type uint32;
description
"Number specifying the order of the stream.";
}
uses burst-data;
leaf frames-per-stream {
type uint32;
mandatory true;
description
"The count of frames to be generated before
generation of the next stream is started.";
}
leaf interstream-gap {
type uint32;
mandatory true;
description
"Idle period after the last frame of the last burst.";
}
}
}
}
grouping ethernet-data {
description
"Ethernet frame data specific parameters.";
reference
"IEEE 802-2014 Clause 9.2";
leaf src-mac-address {
type yang:mac-address;
description
"Source Address field of the generated Ethernet packet.";
}
leaf dst-mac-address {
type yang:mac-address;
description
"Destination Address field of the generated Ethernet packet.";
}
leaf ether-type {
type uint16;
description
"Length/Type field of the generated Ethernet packet.";
}
}
augment "/if:interfaces/if:interface" {
description
"Traffic generator augmentations of ietf-interfaces.";
container traffic-generator {
if-feature "egress-direction";
description
"Traffic generator for egress direction.";
choice type {
description
"Choice of the type of the data model of the generator.
Single or multi stream.";
case single-stream {
uses burst-data;
}
case multi-stream {
uses multi-stream-data;
}
}
uses common-data;
}
container traffic-generator-ingress {
if-feature "ingress-direction";
description
"Traffic generator for ingress direction.";
choice type {
description
"Choice of the type of the data model of the generator.
Single or multi stream.";
case single-stream {
uses burst-data;
}
case multi-stream {
uses multi-stream-data;
}
}
uses common-data;
}
}
augment "/if:interfaces/if:interface/nttg:traffic-generator/"
+ "nttg:type/nttg:single-stream" {
when "derived-from-or-self(../if:type, 'ianaift:ethernetCsmacd')" {
description
"Ethernet interface type.";
}
if-feature "ethernet";
description
"Ethernet specific augmentation for egress
single stream generator type.";
uses ethernet-data;
}
augment "/if:interfaces/if:interface/nttg:traffic-generator/"
+ "nttg:type/nttg:multi-stream/nttg:streams/nttg:stream" {
when "derived-from-or-self(../../../if:type,"
+ "'ianaift:ethernetCsmacd')" {
description
"Ethernet interface type.";
}
if-feature "ethernet";
description
"Ethernet specific augmentation for egress
multi stream generator type.";
uses ethernet-data;
}
augment "/if:interfaces/if:interface/nttg:traffic-generator-ingress/"
+ "nttg:type/nttg:single-stream" {
when "derived-from-or-self(../if:type, 'ianaift:ethernetCsmacd')" {
description
"Ethernet interface type.";
}
if-feature "ethernet";
description
"Ethernet specific augmentation for ingress
single stream generator type.";
uses ethernet-data;
}
augment "/if:interfaces/if:interface/nttg:traffic-generator-ingress/"
+ "nttg:type/nttg:multi-stream/nttg:streams/nttg:stream" {
when "derived-from-or-self(../../../if:type,"
+ "'ianaift:ethernetCsmacd')" {
description
"Ethernet interface type.";
}
if-feature "ethernet";
description
"Ethernet specific augmentation for ingress
multi stream generator type.";
uses ethernet-data;
}
}
]]><CODE ENDS><CODE BEGINS> file "ietf-traffic-analyzer@2021-10-25.yang"
WG List:
Editor: Vladimir Vassilev
";
description
"This module contains a collection of YANG definitions for
description and management of network interconnect testers.
Copyright (c) 2021 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 RFC XXXX; see
the RFC itself for full legal notices.";
revision 2021-10-25 {
description
"Initial revision.";
reference
"RFC XXXX: A YANG Data Model for
Network Interconnect Tester Management";
}
feature egress-direction {
description
"The device can analyze traffic from the egress direction.";
}
feature ingress-direction {
description
"The device can generate traffic from the ingress direction.";
}
feature filter {
description
"This feature indicates that the device implements
filter that can specify a subset of packets to be
analyzed when filtering is enabled.";
}
feature idle-octets-counter {
description
"This feature indicates that the device implements
idle-octets counter that accumulates the time
the link is not utilized. The minimum required
idle gaps are not counted as idle octets.";
}
feature capture {
description
"This feature indicates that the device implements
packet capture functionality.";
}
identity filter {
description
"Base filter identity.";
}
identity ethernet {
base ntta:filter;
description
"Ethernet packet fields filter.";
}
grouping statistics-data {
description
"Analyzer statistics.";
leaf pkts {
type yang:counter64;
description
"Total number of packets analyzed.";
}
leaf octets {
type yang:counter64;
description
"This counter is identical with the in-octets/out-octets
counters defined in RFC8343 except that it counts the
octets since the analyzer was created.";
}
leaf idle-octets {
if-feature "idle-octets-counter";
type yang:counter64;
description
"Total accumulated period with no frame transmission
taking place measured in octets at the current link
speed. Octets not counted in ../octets but not idle are
for example layer 1 framing octets - for Ethernet links
7+1 preamble octets per packet.";
}
leaf errors {
type yang:counter64;
description
"Count of packets with errors.
Not counted in the pkts or captured.
For example packets with CRC error.";
}
container testframe-stats {
description
"Statistics for testframe packets containing
either sequence number, payload checksum,
timestamp or any combination of these features.";
leaf testframe-pkts {
type yang:counter64;
description
"Total count of detected testframe packets.";
}
leaf sequence-errors {
type yang:counter64;
description
"Total count of testframe packets with
unexpected sequence number. After each sequence
error the expected next sequence number is
updated.";
}
leaf payload-errors {
type yang:counter64;
description
"Total count of testframe packets with
payload errors.";
}
container latency {
description
"Latency statistics.";
leaf samples {
type uint64;
description
"Total count of packets used for estimating
the latency statistics. Ideally
samples=../testframe-stats.";
}
leaf min {
type uint64;
units "nanoseconds";
description
"Minimum measured latency.";
}
leaf max {
type uint64;
units "nanoseconds";
description
"Maximum measured latency.";
}
leaf average {
type uint64;
units "nanoseconds";
description
"The sum of all sampled latencies divided
by the number of samples.";
}
leaf latest {
type uint64;
units "nanoseconds";
description
"Latency of the latest sample.";
}
}
}
}
grouping capture-config-data {
description
"Grouping with a capture configuration container.";
container capture {
if-feature "capture";
description
"Contains capture parameters.";
container start-trigger {
description
"Configures when the capture start is triggered.";
choice start-trigger {
description
"If none of the cases in this choice are configured the
capture process starts from the first frame received.";
case frame-index {
description
"Start capturing frames at the specified frame index.";
leaf frame-index {
type uint64;
description
"First captured frame index.";
}
}
case testframe-index {
description
"Start capturing frames at the specified
testframe index.";
leaf testframe-index {
type uint64;
description
"Starts capture as specified testframe index.";
}
}
}
}
container stop-trigger {
description
"Configures when the capture is stopped.";
choice stop-trigger {
description
"If none of the cases in this choice are configured the
captured frames are always the last frames received for
as many frames the implementation can buffer.";
case when-full {
description
"Stops capturing when the implementation can not store
more frames.";
leaf when-full {
type empty;
description
"When present in configuration capture stops when
the capture buffer is full.";
}
}
}
}
}
}
grouping capture-data {
description
"Grouping with statistics and data
of one or more captured frame.";
container capture {
if-feature "capture";
description
"Statistics and data of
one or more captured frames.";
list frame {
key "sequence-number";
description
"Statistics and data of a captured frame.";
leaf sequence-number {
type uint64;
description
"Incremental counter of frames captured.";
}
leaf timestamp {
type yang:date-and-time;
description
"Timestamp of the moment the frame was captured.";
}
leaf length {
type uint32;
description
"Frame length. Ideally the data captured will be
of the same length but can be shorter
depending on implementation limitations.";
}
leaf preceding-interframe-gap {
type uint32;
units "nanoseconds";
description
"Measured delay between the reception of the previous
frame was completed and the reception of the current
frame was started.";
}
leaf data {
type string {
pattern '([0-9A-F]{2})*';
}
description
"Raw data of the captured frame.";
}
}
}
}
grouping filter-data {
description
"Grouping with a filter container specifying the filtering
rules for processing only a specific subset of the
frames.";
container filter {
if-feature "filter";
presence "When present packets are
filtered before analyzed according
to the filter type";
description
"Contains the filtering rules for processing only
a specific subset of the frames.";
leaf type {
type identityref {
base ntta:filter;
}
mandatory true;
description
"Type of the applied filter. External modules can
define alternative filter type identities.";
}
}
}
augment "/if:interfaces/if:interface" {
description
"Traffic analyzer augmentations of ietf-interfaces.";
container traffic-analyzer {
if-feature "ingress-direction";
presence "Enables the traffic analyzer for ingress traffic.";
description
"Traffic analyzer for ingress direction.";
uses filter-data;
uses capture-config-data;
container state {
config false;
description
"State data.";
uses statistics-data;
uses capture-data;
}
}
container traffic-analyzer-egress {
if-feature "egress-direction";
presence "Enables the traffic analyzer for egress traffic.";
description
"Traffic analyzer for egress direction.";
uses filter-data;
uses capture-config-data;
container state {
config false;
description
"State data.";
uses statistics-data;
uses capture-data;
}
}
}
augment "/if:interfaces/if:interface/ntta:traffic-analyzer/"
+ "ntta:filter" {
when "derived-from-or-self(ntta:type, 'ntta:ethernet')";
description
"Ethernet frame specific filter type.";
leaf ether-type {
type uint16;
description
"The Ethernet Type (or Length) value
defined by IEEE 802.";
reference
"IEEE 802-2014 Clause 9.2";
}
}
}
]]><CODE ENDS>This document registers two URIs and two YANG modules.This document registers two URIs in the IETF XML registry . Following the format in
RFC 3688, the following registration is requested to be made:Registrant Contact: The IESG.XML: N/A, the requested URI is an XML namespace.This document registers two YANG module in the YANG Module Names
registry YANG.The YANG modules defined in this document are designed to be accessed via
the NETCONF protocol RFC 6241. The
lowest NETCONF layer is the secure transport layer and the mandatory
to implement secure transport is SSH RFC
6242. The NETCONF access control model RFC 6536 provides the means to restrict access
for particular NETCONF users to a pre-configured subset of all
available NETCONF protocol operations and content.There are a number of data nodes defined in this YANG module which
are writable/creatable/deletable (i.e. config true, which is the
default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g. edit-config) to
these data nodes without proper protection can have a negative effect
on network operations. These are the subtrees and data nodes and
their sensitivity/vulnerability:
The ietf-traffic-generator YANG module controls a stateless traffic generator which is intended to be used for testing and verification purposes but can be used for malicious purposes like generating network traffic part of a Denial-of-Service (DoS) attack.
This should be taken into consideration when granting write access to the following container and descendant data nodes:
/if:interfaces/if:interface/nttg:traffic-generator
The ietf-traffic-analyzer YANG module controls a traffic analyzer which is designed for use in testing and verification but can be used for reading information contained in packets sent and received on any of the interfaces on systems that implement the capture feature.
This should be taken into consideration when granting read access to the following container and descendant data nodes:
/if:interfaces/if:interface/ntta:traffic-analyzer/ntta:captureIEEE 802.3-2014IEEE WG802.3 - Ethernet Working GroupIEEE 1588-2008IEEE
The following topology will be used for the examples in this section:
-------->| dut0 |>------->|TA tester1 |
| | | | | |
+-------------+ +------------+ +------------+
]]>
This pseudo code program orchestrates a network test and shows how the model can be used:
In sec. C.2.6.4 Test Frames a detailed format is specified. The frame-data leaf allows full control over the generated frames payload.