| IPPM WG | R. Civil |
| Internet-Draft | Ciena Corporation |
| Intended status: Standards Track | A. Morton |
| Expires: September 22, 2016 | AT&T Labs |
| L. Zheng | |
| Huawei Technologies | |
| R. Rahman | |
| M. Jethanandani | |
| Cisco Systems | |
| K. Pentikousis, Ed. | |
| EICT | |
| March 21, 2016 |
Two-Way Active Measurement Protocol (TWAMP) Data Model
draft-ietf-ippm-twamp-yang-00
This document specifies a data model for client and server implementations of the Two-Way Active Measurement Protocol (TWAMP). We define the TWAMP data model through Unified Modeling Language (UML) class diagrams and formally specify it using YANG.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 22, 2016.
Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
The Two-Way Active Measurement Protocol (TWAMP) [RFC5357] is used to measure network performance parameters such as latency, bandwidth, and packet loss by sending probe packets and measuring their experience in the network. To date, TWAMP implementations do not come with a standard management framework and, as such, configuration depends on the various proprietary mechanisms developed by the corresponding TWAMP vendor. This document addresses this gap by formally specifying the TWAMP data model using YANG.
In current TWAMP deployments, the lack of a standardized data model limits the flexibility to dynamically instantiate TWAMP-based measurements across equipment from different vendors. In large, virtualized, and dynamically instantiated infrastructures where network functions are placed according to orchestration algorithms as discussed in [I-D.unify-nfvrg-challenges][I-D.unify-nfvrg-devops], proprietary mechanisms for managing TWAMP measurements pose severe limitations with respect to programmability.
Two major trends call for revisiting the standardization on TWAMP management aspects. First, we expect that in the coming years large-scale and multi-vendor TWAMP deployments will become the norm. From an operations perspective, dealing with several vendor-specific TWAMP configuration mechanisms is simply unsustainable in this context. Second, the increasingly software-defined and virtualized nature of network infrastructures, based on dynamic service chains [NSC] and programmable control and management planes [RFC7426] requires a well-defined data model for TWAMP implementations. This document defines such a TWAMP data model and specifies it formally using the YANG data modeling language [RFC6020].
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
The rest of this document is organized as follows. Section 2 presents the scope and applicability of this document. Section 3 provides a high-level overview of the TWAMP data model. Section 4 details the configuration parameters of the data model and Section 5 specifies in YANG the TWAMP data model. Section 6 lists illustrative examples which conform to the YANG data model specified in this document. Appendix A elaborates these examples further.
The purpose of this document is the specification of a vendor-independent data model for TWAMP implementations.
Figure 1 illustrates a redrawn version of the TWAMP logical model found in Section 1.2 of [RFC5357]. The figure is annotated with pointers to the UML diagrams provided in this document and associated with the data model of the four logical entities in a TWAMP deployment, namely the TWAMP Control-Client, Server, Session-Sender and Session-Reflector. As per [RFC5357], unlabeled links in Figure 1 are unspecified and may be proprietary protocols.
[Fig. 3] [Fig. 4]
+----------------+ +--------+
| Control-Client | <-- TWAMP-Control --> | Server |
+----------------+ +--------+
^ ^
| |
V V
+----------------+ +-------------------+
| Session-Sender | <-- TWAMP-Test --> | Session-Reflector |
+----------------+ +-------------------+
[Fig. 5] [Fig. 6]
Figure 1: Annotated TWAMP logical model
As per [RFC5357], a TWAMP implementation may follow a simplified logical model, in which the same node acts both as the Control-Client and Session-Sender, while another node acts at the same time as the TWAMP Server and Session-Reflector. Figure 2 illustrates this simplified logical model and indicates the interaction between the TWAMP configuration client and server using, for instance, NETCONF [RFC6241] or RESTCONF [I-D.ietf-netconf-restconf]. Note, however, that the specific protocol used to communicate the TWAMP configuration parameters specified herein is outside the scope of this document. Appendix B considers TWAMP operational commands, which are also outside the scope of this document.
o-------------------o o-------------------o
| Config client | | Config client |
o-------------------o o-------------------o
|| ||
NETCONF || RESTCONF NETCONF || RESTCONF
|| ||
o-------------------o o-------------------o
| Config server | | Config server |
| [Fig. 3, 5] | | [Fig. 4, 6] |
+-------------------+ +-------------------+
| Control-Client | <-- TWAMP-Control --> | Server |
| | | |
| Session-Sender | <-- TWAMP-Test --> | Session-Reflector |
+-------------------+ +-------------------+
Figure 2: Simplified TWAMP model and protocols
A TWAMP data model includes four categories of configuration items. Global configuration items relate to parameters that are set on a per device level. For example, the administrative status of the device with respect to whether it allows TWAMP sessions and, if so, in what capacity (e.g. Control-Client, Server or both), are typical instances of global configuration items. A second category includes attributes that can be configured on a per control connection basis, such as the Server IP address. A third category includes attributes related to per test session attributes, for instance setting different values in the Differentiated Services Code Point (DSCP) field. Finally, the data model could include attributes that relate to the operational state of the TWAMP implementation.
As we describe the TWAMP data model in the remaining sections of this document, readers should keep in mind the functional entity grouping illustrated in Figure 1.
A TWAMP Control-Client has an administrative status field set at the device level that indicates whether the node is enabled to function as such.
Each TWAMP Control-Client is associated with zero or more TWAMP control connections. The main configuration parameters of each control connection are:
Each TWAMP control connection, in turn, is associated with zero or more test sessions. For each test session we note the following configuration items:
Each TWAMP Server has an administrative status field set at the device level to indicate whether the node is enabled to function as a TWAMP Server.
Each TWAMP Server is associated with zero or more control connections. Each control connection is uniquely identified by the 4-tuple {Control-Client IP address, Control-Client TCP port number, Server IP address, Server TCP port}. Control connection configuration items on a TWAMP Server are read-only.
There is one TWAMP Session-Sender instance for each test session that is initiated from the sending device. Primary configuration fields include:
Each TWAMP Session-Reflector is associated with zero or more test sessions. For each test session, the REFWAIT parameter (Section 4.2 of [RFC5357] can be configured. Read-only access to other data model parameters, such as the Sender IP address is foreseen. Each test session can be uniquely identified by the 4-tuple mentioned in Section 3.2.
This section defines the TWAMP data model using UML and describes all associated parameters.
The twamp-client container (see Figure 3) holds items that are related to the configuration of the TWAMP Control-Client logical entity. These are divided up into items that are associated with the configuration of the Control-Client as a whole (e.g. client-admin-state) and items that are associated with individual control connections initiated by the Control-Client entity (twamp-client-ctrl-connection).
+--------------------+
| twamp-client |
+--------------------+ 1..* +-----------------------+
| client-admin-state |<>----------------------| mode-preference-chain |
| | +-----------------------+
| | 1..* +------------+ | priority |
| |<>-----| key-chain | | mode |
+--------------------+ +------------+ +-----------------------+
^ | key-id |
V | secret-key |
| +------------+
| 0..*
+------------------------------+
| twamp-client-ctrl-connection |
+------------------------------+
| ctrl-connection-name |
| client-ip |
| server-ip |
| server-tcp-port | 0..* +-------------------------+
| dscp |<>-------| twamp-session-request |
| key-id | +-------------------------+
| max-count | | test-session-name |
| client-tcp-port {ro} | | sender-ip |
| server-start-time {ro} | | sender-udp-port |
| ctrl-connection-state {ro} | | reflector-ip |
| selected-mode {ro} | | reflector-udp-port |
| token {ro} | | timeout |
| client-iv {ro} | | padding-length |
+------------------------------+ | dscp |
| start-time |
+-------------+ 1 | repeat |
| pm-reg-list |------<>| repeat-interval |
+-------------+ | test-session-state {ro} |
| pm-index | | sid {ro} |
+-------------+ +-------------------------+
Figure 3: TWAMP Control-Client UML class diagram
The twamp-client container includes an administrative parameter (client-admin-state) that controls whether the device is allowed to initiate TWAMP control sessions.
The twamp-client container holds a list (mode-preference-chain) which specifies the preferred Mode values according to their preferred order of use, including the authentication and encryption Modes. Specifically, mode-preference-chain lists each priority (expressed as a 16-bit unsigned integer, where zero is the highest priority and subsequent values monotonically increasing) with their corresponding mode (expressed as a 32-bit Hexadecimal value). Depending on the Modes available in the Server Greeting, the Control-Client MUST choose the highest priority Mode from the configured mode-preference-chain list. Note that the list of preferred Modes may set bit position combinations when necessary, such as when referring to the extended TWAMP features in [RFC5618], [RFC5938], and [RFC6038]. If the Control-Client cannot determine an acceptable Mode, it MUST respond with zero Mode bits set in the Set-up Response message, indicating it will not continue with the control connection.
In addition, the twamp-client container holds a list named key-chain which relates KeyIDs with the respective secret keys. Both the Server and the Control-Client use the same mappings from KeyIDs to shared secrets (key-id and secret-key in Figure 3, respectively). The Server, being prepared to conduct sessions with more than one Control-Client, uses KeyIDs to choose the appropriate secret-key; a Control-Client would typically have different secret keys for different Servers. The secret-key is the shared secret, an octet string of arbitrary length whose interpretation as a text string is unspecified. The key-id and secret-key encoding should follow Section 9.4 of [RFC6020]. The derived key length (dkLen in [RFC2898]) MUST be 128-bits for the AES Session-key used for encryption and a 256-bit HMAC-SHA1 Session-key used for authentication (see Section 6.10 of [RFC4656]).
Each twamp-client container also holds a list of twamp-client-ctrl-connection, where each item in the list describes a TWAMP control connection that will be initiated by this Control-Client. There SHALL be one instance of twamp-client-ctrl-connection per TWAMP-Control (TCP) connection that is to be initiated from this device.
The configuration items for twamp-client-ctrl-connection are:
The following twamp-client-ctrl-connection parameters are read-only:
Each twamp-client-ctrl-connection holds a list of twamp-session-request. twamp-session-request holds information associated with the Control-Client for this test session. This includes information that is associated with the Request-TW-Session/Accept-Session message exchange (see Section 3.5 of [RFC5357]). The Control-Client is also responsible for scheduling and results collection for TWAMP-Test sessions, so twamp-session-request will also hold information related these actions (e.g. pm-index, repeat-interval).
There SHALL be one instance of twamp-session-request for each TWAMP-Test session that is to be negotiated by this TWAMP-Control connection via a Request-TW-Session/Accept-Session exchange.
The configuration items for twamp-session-request are:
The following twamp-session-request parameters are read-only:
The twamp-server container (see Figure 4) holds items that are related to the configuration of the TWAMP Server logical entity (recall Figure 1).
+------------------ -+
| twamp-server |
+--------------------+
| server-admin-state | 1..* +------------+
| server-tcp-port |<>------| key-chain |
| servwait | +------------+
| dscp | | key-id |
| count | | secret-key |
| max-count | +------------+
| modes |
| | 0..* +-----------------------------------+
| |<>------| twamp-server-ctrl-connection |
+--------------------+ +-----------------------------------+
| client-ip {ro} |
| client-tcp-port {ro} |
| server-ip {ro} |
| server-tcp-port {ro} |
| server-ctrl-connection-state {ro} |
| dscp {ro} |
| selected-mode {ro} |
| key-id {ro} |
| count {ro} |
| max-count {ro} |
| salt {ro} |
| server-iv {ro} |
| challenge {ro} |
+-----------------------------------+
Figure 4: TWAMP Server UML class diagram
A device operating in the Server role cannot configure attributes on a per TWAMP-Control connection basis, as it has no foreknowledge of what incoming TWAMP-Control connections it will receive. As such, any parameter that the Server might want to apply to an incoming control connection must be configured at the overall Server level, and will then be applied to all incoming TWAMP-Control connections.
Each twamp-server container holds a list named key-chain which relates KeyIDs with the respective secret keys. As mentioned in Section 4.1, both the Server and the Control-Client use the same mappings from KeyIDs to shared secrets. The Server, being prepared to conduct sessions with more than one Control-Client, uses KeyIDs to choose the appropriate secret-key; a Control-Client would typically have different secret keys for different Servers. key-id tells the Server which shared-secret the Control-Client wishes to use for authentication or encryption.
Each incoming control connection that is active on the Server will be represented by an instance of a twamp-server-ctrl-connection object. All items in the twamp-server-ctrl-connection object are read-only, as we explain later in this section.
The twamp-server container items are as follows:
There SHALL be one instance of twamp-server-ctrl-connection per incoming TWAMP-Control (TCP) connection that is received and active on the Server device. All items in the twamp-server-ctrl-connection are read-only. Each instance of twamp-server-ctrl-connection uses the following 4-tuple as its unique key: client-ip, client-tcp-port, server-ip, server-tcp-port.
The twamp-server-ctrl-connection container items are all read-only:
The twamp-session-sender container, illustrated in Figure 5, holds items that are related to the configuration of the TWAMP Session-Sender logical entity.
The twamp-session-sender container includes an administrative parameter (session-sender-admin-state) that controls whether the device is allowed to initiate TWAMP test sessions.
There is one instance of twamp-sender-test-session for each TWAMP-Test session for which packets are being sent.
+----------------------------+
| twamp-session-sender |
+----------------------------+ 0..* +---------------------------+
| session-sender-admin-state |<>-----| twamp-sender-test-session |
+----------------------------+ +---------------------------+
| test-session-name |
| ctrl-connection-name {ro} |
| fill-mode |
| number-of-packets |
| sender-session-state {ro} |
| sent-packets {ro} |
| rcv-packets {ro} |
| last-sent-seq {ro} |
| last-rcv-seq {ro} |
+---------------------------+
^
V
| 1
+---------------------+
| packet-distribution |
+---------------------+
| periodic / poisson |
+---------------------+
| |
+-------------------------+ |
| periodic-interval | |
| periodic-interval-units | |
+-------------------------+ |
+------------------------+
| lambda |
| lambda-units |
| max-interval |
| truncation-point-units |
+------------------------+
Figure 5: TWAMP Session-Sender UML class diagram
The twamp-sender-test-session container items are:
The following twamp-sender-test-session parameters are read-only:
The twamp-session-reflector container, illustrated in Figure 6, holds items that are related to the configuration of the TWAMP Session-Reflector logical entity.
A device operating in the Session-Reflector role cannot configure attributes on a per-session basis, as it has no foreknowledge of what incoming sessions it will receive. As such, any parameter that the Session-Reflector might want to apply to an incoming TWAMP-Test session must be configured at the overall Session-Reflector level, and will then be applied to all incoming sessions.
The twamp-session-sender container includes an administrative parameter (session-reflector-admin-state) that controls whether the device is allowed to respond to incoming TWAMP test sessions. Each incoming TWAMP-Test session that is active on the Session-Reflector will be represented by an instance of a twamp-reflector-test-session object. All items in the twamp-reflector-test-session object are read-only.
+----=--------------------------+
| twamp-session-reflector |
+-------------------------------+
| session-reflector-admin-state |
| refwait |
+-------------------------------+
^
V
|
| 0..*
+----------------------------------------+
| twamp-reflector-test-session |
+----------------------------------------+
| sid {ro} |
| sender-ip {ro} |
| sender-udp-port {ro} |
| reflector-ip {ro} |
| reflector-udp-port {ro} |
| parent-connection-client-ip {ro} |
| parent-connection-client-tcp-port {ro} |
| parent-connection-server-ip {ro} |
| parent-connection-server-tcp-port {ro} |
| dscp {ro} |
| sent-packets {ro} |
| rcv-packets {ro} |
| last-sent-seq {ro} |
| last-rcv-seq {ro} |
+----------------------------------------+
Figure 6: TWAMP Session-Reflector UML class diagram
The twamp-session-reflector configuration items are:
Instances of twamp-reflector-test-session are indexed by a session identifier (sid). This value is auto-allocated by the Server as test session requests are received, and communicated back to the Control-Client in the SID field of the Accept-Session message; see Section 4.3 of [RFC6038].
When attempting to retrieve operational data for active test sessions from a Session-Reflector device, the user will not know what sessions are currently active on that device, or what SIDs have been auto-allocated for these test sessions. If the user has network access to the Control-Client device, then it is possible to read the data for this session under twamp-client:twamp-client-ctrl-connection:twamp-session-request:sid and obtain the SID (see Figure 3). The user may then use this SID value as an index to retrieve an individual twamp-session-reflector:twamp-reflector-test-session instance on the Session-Reflector device.
If the user has no network access to the Control-Client device, then the only option is to retrieve all twamp-reflector-test-session instances from the Session-Reflector device. This could be problematic if a large number of test sessions are currently active on that device.
Each Session-Reflector TWAMP-Test session contains the following 4-tuple: {parent-connection-client-ip, parent-connection-client-tcp-port, parent-connection-server-ip, parent-connection-server-tcp-port}. This 4-tuple corresponds to the equivalent 4-tuple {client-ip, client-tcp-port, server-ip, server-tcp-port} in the twamp-server-ctrl-connection object. This 4-tuple allows the user to trace back from the TWAMP-Test session to the (parent) TWAMP-Control connection that negotiated this test session.
All data under twamp-reflector-test-session is read-only:
This section formally specifies the TWAMP data model using YANG.
This section presents a simplified graphical representation of the TWAMP data model using a YANG tree diagram. Readers should keep in mind that the limit of 72 characters per line forces us to introduce artificial line breaks in some tree diagram nodes.
module: ietf-twamp
+--rw twamp
+--rw twamp-client! {control-client}?
| +--rw client-admin-state boolean
| +--rw mode-preference-chain* [priority]
| | +--rw priority uint16
| | +--rw mode? mode
| +--rw key-chain* [key-id]
| | +--rw key-id string
| | +--rw secret-key? string
| +--rw twamp-client-ctrl-connection* [ctrl-connection-name]
| +--rw ctrl-connection-name string
| +--rw client-ip? inet:ip-address
| +--rw server-ip inet:ip-address
| +--rw server-tcp-port? inet:port-number
| +--rw dscp? inet:dscp
| +--rw key-id? string
| +--rw max-count? uint32
| +--ro client-tcp-port? inet:port-number
| +--ro server-start-time? uint64
| +--ro ctrl-connection-state? ctrl-connection-state
| +--ro selected-mode? mode
| +--ro token? binary
| +--ro client-iv? binary
| +--rw twamp-session-request* [test-session-name]
| +--rw test-session-name string
| +--rw sender-ip? inet:ip-address
| +--rw sender-udp-port? inet:port-number
| +--rw reflector-ip inet:ip-address
| +--rw reflector-udp-port? inet:port-number
| +--rw timeout? uint64
| +--rw padding-length? uint32
| +--rw dscp? inet:dscp
| +--rw start-time? uint64
| +--rw repeat? uint32
| +--rw repeat-interval? uint32
| +--rw pm-reg-list* [pm-index]
| | +--rw pm-index uint16
| +--ro test-session-state? test-session-state
| +--ro sid? string
+--rw twamp-server! {server}?
| +--rw server-admin-state boolean
| +--rw server-tcp-port? inet:port-number
| +--rw servwait? uint32
| +--rw dscp? inet:dscp
| +--rw count? uint32
| +--rw max-count? uint32
| +--rw modes? mode
| +--rw key-chain* [key-id]
| | +--rw key-id string
| | +--rw secret-key? string
| +--ro twamp-server-ctrl-connection* [client-ip client-tcp-port server-ip server-tcp-port]
| +--ro client-ip inet:ip-address
| +--ro client-tcp-port inet:port-number
| +--ro server-ip inet:ip-address
| +--ro server-tcp-port inet:port-number
| +--ro server-ctrl-connection-state? server-ctrl-connection-state
| +--ro dscp? inet:dscp
| +--ro selected-mode? mode
| +--ro key-id? string
| +--ro count? uint32
| +--ro max-count? uint32
| +--ro salt? binary
| +--ro server-iv? binary
| +--ro challenge? binary
+--rw twamp-session-sender! {session-sender}?
| +--rw session-sender-admin-state boolean
| +--rw twamp-sender-test-session* [test-session-name]
| +--rw test-session-name string
| +--ro ctrl-connection-name? string
| +--rw fill-mode? fill-mode
| +--rw number-of-packets? uint32
| +--rw (packet-distribution)?
| | +--:(periodic)
| | | +--rw periodic-interval? uint32
| | | +--rw periodic-interval-units? units
| | +--:(poisson)
| | +--rw lambda? uint32
| | +--rw lambda-units? uint32
| | +--rw max-interval? uint32
| | +--rw truncation-point-units? units
| +--ro sender-session-state? sender-session-state
| +--ro sent-packets? uint32
| +--ro rcv-packets? uint32
| +--ro last-sent-seq? uint32
| +--ro last-rcv-seq? uint32
+--rw twamp-session-reflector! {session-reflector}?
+--rw session-reflector-admin-state boolean
+--rw refwait? uint32
+--ro twamp-reflector-test-session* [sender-ip sender-udp-port reflector-ip reflector-udp-port]
+--ro sid? string
+--ro sender-ip inet:ip-address
+--ro sender-udp-port inet:port-number
+--ro reflector-ip inet:ip-address
+--ro reflector-udp-port inet:port-number
+--ro parent-connection-client-ip? inet:ip-address
+--ro parent-connection-client-tcp-port? inet:port-number
+--ro parent-connection-server-ip? inet:ip-address
+--ro parent-connection-server-tcp-port? inet:port-number
+--ro dscp? inet:dscp
+--ro sent-packets? uint32
+--ro rcv-packets? uint32
+--ro last-sent-seq? uint32
+--ro last-rcv-seq? uint32
This section presents the YANG module for the TWAMP data model defined in this document.
<CODE BEGINS> file "ietf-twamp@2016-03-21.yang"
module ietf-twamp {
namespace "urn:ietf:params:xml:ns:yang:ietf-twamp";
//namespace need to be assigned by IANA
prefix "ietf-twamp";
import ietf-inet-types {
prefix inet;
}
organization "IETF IPPM (IP Performance Metrics) Working Group";
contact "draft-ietf-ippm-twamp-yang@tools.ietf.org";
description "TWAMP Data Model";
revision "2016-03-21" {
description "01 version. RFC5357, RFC5618, RFC5938 and RFC6038
is covered. draft-ietf-ippm-metric-registry is also considered";
reference "draft-ietf-ippm-twamp-yang";
}
feature control-client {
description "This feature relates to the device functions as
the TWAMP Control-Client.";
}
feature server {
description "This feature relates to the device functions as
the TWAMP Server.";
}
feature session-sender {
description "This feature relates to the device functions as
the TWAMP Session-Sender.";
}
feature session-reflector {
description "This feature relates to the device functions as
the TWAMP Session-Reflector.";
}
typedef ctrl-connection-state {
type enumeration {
enum active {
description "Control session is active.";
}
enum idle {
description "Control session is idle.";
}
}
description "Control connection state";
}
typedef mode {
type bits {
bit unauthenticated {
position "0";
description "Unauthenticated";
}
bit authenticated {
position "1";
description "Authenticated";
}
bit encrypted {
position "2";
description "Encrypted";
}
bit unauth-test-encrpyt-control {
position "3";
description "Mixed Security Mode per RFC 5618. Test
protocol security mode in Unauthenticated mode,
Control protocol in Encrypted mode.";
}
bit individual-session-control {
position "4";
description "Individual session control per RFC5938.";
}
bit reflect-octets {
position "5";
description "Reflect octets capability per RFC6038.";
}
bit symmetrical-size {
position "6";
description "Symmetrical size per RFC6038.";
}
}
description "Authentication mode bit mask";
}
typedef test-session-state {
type enumeration {
enum ok {
value 0;
description "Test session is accepted.";
}
enum failed {
value 1;
description "Failure, reason unspecified (catch-all).";
}
enum internal-error {
value 2;
description "Internal error.";
}
enum not-supported {
value 3;
description "Some aspect of request is not supported.";
}
enum permanent-resource-limit {
value 4;
description "Cannot perform request due to
permanent resource limitations.";
}
enum temp-resource-limit {
value 5;
description "Cannot perform request due to
temporary resource limitations.";
}
}
description "Test session state";
}
typedef server-ctrl-connection-state {
type enumeration {
enum "active" {
description "Active";
}
enum "servwait" {
description "Servwait";
}
}
description "Server control connection state";
}
typedef fill-mode {
type enumeration {
enum zero {
description "Zero";
}
enum random {
description "Random";
}
}
description "Indicates whether the padding added to the
UDP test packets will contain pseudo-random numbers, or
whether it should consist of all zeroes.";
}
typedef units {
type enumeration {
enum seconds {
description "Seconds";
}
enum milliseconds {
description "Milliseconds";
}
enum microseconds {
description "Microseconds";
}
enum nanoseconds {
description "Nanoseconds";
}
}
description "Time units";
}
typedef sender-session-state {
type enumeration {
enum setup {
description "Test session is active.";
}
enum failure {
description "Test session is idle.";
}
}
description "Sender session state.";
}
typedef dynamic-port-number {
type inet:port-number {
range "49152 .. 65535";
}
description "Dynamic range for port numbers";
}
grouping maintenance-statistics {
description "Maintenance statistics grouping";
leaf sent-packets {
type uint32;
config "false";
description "Packets sent";
}
leaf rcv-packets {
type uint32;
config "false";
description "Packets received";
}
leaf last-sent-seq {
type uint32;
config "false";
description "Last sent sequence number";
}
leaf last-rcv-seq {
type uint32;
config "false";
description "Last received sequence number";
}
}
container twamp {
description "Top level container";
container twamp-client {
if-feature control-client;
presence "twamp-client";
description "Twamp client container";
leaf client-admin-state {
type boolean;
mandatory "true";
description "Indicates whether this device is allowed to run
TWAMP to initiate control sessions";
}
list mode-preference-chain {
key "priority";
unique "mode";
leaf priority {
type uint16;
description "priority";
}
leaf mode {
type mode;
description "Authentication mode bit mask";
}
description "Authentication mode preference";
}
list key-chain {
key "key-id";
leaf key-id {
type string {
length "1..80";
}
description "Key ID";
}
leaf secret-key {
type string;
description "Secret key";
}
description "Key chain";
}
list twamp-client-ctrl-connection {
key "ctrl-connection-name";
description "Twamp client control connections";
leaf ctrl-connection-name {
type string;
description "A unique name used as a key to identify this
individual TWAMP control connection on the
Control-Client device.";
}
leaf client-ip {
type inet:ip-address;
description "Client IP address";
}
leaf server-ip {
type inet:ip-address;
mandatory "true";
description "Server IP address";
}
leaf server-tcp-port {
type inet:port-number;
default "862";
description "Server tcp port";
}
leaf dscp{
type inet:dscp;
default "0";
description "The DSCP value to be placed in the IP header
of the TWAMP TCP Control packets generated
by the Control-Client";
}
leaf key-id {
type string {
length "1..80";
}
description "Key ID";
}
leaf max-count {
type uint32 {
range 1024..4294967295;
}
default 32768;
description "Max count value.";
}
leaf client-tcp-port {
type inet:port-number;
config "false";
description "Client TCP port";
}
leaf server-start-time {
type uint64;
config "false";
description "The Start-Time advertized by the Server in
the Server-Start message";
}
leaf ctrl-connection-state {
type ctrl-connection-state;
config "false";
description "Control connection state";
}
leaf selected-mode {
type mode;
config "false";
description "The TWAMP mode that the Control-Client has
chosen for this control connection as set in the Mode
field of the Set-Up-Response message";
}
leaf token {
type binary {
length "64";
}
config "false";
description "64 octets, containing the concatenation of a
16-octet challenge, a 16-octet AES Session-key used
for encryption, and a 32-octet HMAC-SHA1 Session-key
used for authentication";
}
leaf client-iv{
type binary {
length "16";
}
config "false";
description "16 octets, Client-IV is generated randomly
by the Control-Client.";
}
list twamp-session-request {
key "test-session-name";
description "Twamp session requests";
leaf test-session-name {
type string;
description "A unique name for this test session to be
used as a key for this test session on the
Control-Client.";
}
leaf sender-ip {
type inet:ip-address;
description "Sender IP address";
}
leaf sender-udp-port {
type dynamic-port-number;
description "Sender UDP port";
}
leaf reflector-ip {
type inet:ip-address;
mandatory "true";
description "Reflector IP address.";
}
leaf reflector-udp-port {
type dynamic-port-number;
description "Reflector UDP port. If this value is not
set, the device shall use the same port number as
defined in the server-tcp-port parameter of this
twamp-session-request's
parent client-control-connection.";
}
leaf timeout {
type uint64;
default "2";
description "The time (in seconds)Session-Reflector MUST
wait after receiving a Stop-Session message.";
}
leaf padding-length {
type uint32{
range "64..4096";
}
description "The number of bytes of padding that should
be added to the UDP test packets generated by the
sender. Jumbo sized packets supported.";
}
leaf dscp {
type inet:dscp;
description "The DSCP value to be placed in the UDP
header of TWAMP-Test packets generated by the
Session-Sender, and in the UDP header of the TWAMP-Test
response packets generated by the Session-Reflector
for this test session.";
}
leaf start-time {
type uint64;
default "0";
description "Time when the session is to be started
(but not before the Start-Sessions command is issued).
This value is placed in the Start Time field of the
Request-TW-Session message. The default value of 0
indicates that the session will be started as soon
as the Start-Sessions message is received.";
}
leaf repeat {
type uint32;
default "0";
description "Determines if the test session is to be
run repeatedly. The default value of repeat is 0,
indicating that once the session has completed, it
will not be renegotiated and restarted. 1 thru 4,294,967,294
indicate the number of repetitions, and the max value of
4,294,967,295 indicates repeat forever.";
}
leaf repeat-interval {
when "../repeat!='0'" {
description "When repeat is not 0, the test is to be
repeated";
}
type uint32;
description "Repeat interval (in minutes)";
}
list pm-reg-list {
key "pm-index";
leaf pm-index {
type uint16;
description "One or more Numerical index values of a
Registered Metric in the Performance Metric Registry";
}
description "A list of one or more pm-index values,
which communicate packet stream characteristics and one
or more metrics to be measured.";
}
leaf test-session-state {
type test-session-state;
config "false";
description "Test session state";
}
leaf sid{
type string;
config "false";
description "The SID allocated by the Server for
this test session";
}
}
}
}
container twamp-server{
if-feature server;
presence "twamp-server";
description "Twamp sever container";
leaf server-admin-state{
type boolean;
mandatory "true";
description "Indicates whether this device is allowed to run
TWAMP to respond to control sessions";
}
leaf server-tcp-port {
type inet:port-number;
default "862";
description "This parameter defines the well known TCP port
number that is used by TWAMP.";
}
leaf servwait {
type uint32 {
range 1..604800;
}
default 900;
description "SERVWAIT (TWAMP Control (TCP) session timeout),
default value is 900";
}
leaf dscp {
type inet:dscp;
description "The DSCP value to be placed in the IP header of
TCP TWAMP-Control packets generated by the Server";
}
leaf count {
type uint32 {
range 1024..4294967295;
}
description "Parameter used in deriving a key from a
shared secret ";
}
leaf max-count {
type uint32 {
range 1024..4294967295;
}
default 32768;
description "Max count value.";
}
leaf modes {
type mode;
description "The bit mask of TWAMP Modes this Server
instance is willing to support.";
}
list key-chain {
key "key-id";
leaf key-id {
type string {
length "1..80";
}
description "Key IDs.";
}
leaf secret-key {
type string;
description "Secret keys.";
}
description "KeyIDs with the respective secret keys.";
}
list twamp-server-ctrl-connection {
key "client-ip client-tcp-port server-ip server-tcp-port";
config "false";
description "Twamp server control connections";
leaf client-ip {
type inet:ip-address;
description "Client IP address";
}
leaf client-tcp-port {
type inet:port-number;
description "Client TCP port";
}
leaf server-ip {
type inet:ip-address;
description "Server IP address";
}
leaf server-tcp-port {
type inet:port-number;
description "Server TCP port";
}
leaf server-ctrl-connection-state {
type server-ctrl-connection-state;
description "Server control connection state";
}
leaf dscp {
type inet:dscp;
description "The DSCP value used in the IP header of the
TCP control packets sent by the Server for this control
connection. This will usually be the same value as is
configured for twamp-server:dscp under the twamp-server.
However, in the event that the user re-configures
twamp-server:dscp after this control connection is already
in progress, this read-only value will show the actual
dscp value in use by this control connection.";
}
leaf selected-mode {
type mode;
description "The mode that was chosen for this control
connection as set in the Mode field of the
Set-Up-Response message.";
}
leaf key-id {
type string {
length "1..80";
}
description "The key-id value that is in use by this
control connection.";
}
leaf count {
type uint32 {
range 1024..4294967295;
}
description "The count value that is in use by this control
connection. This will usually be the same value as is
configured under twamp-server. However, in the event that
the user re-configured twamp-server:count after this
control connection is already in progress, this read-only
value will show the different count that is in use for
this control connection.";
}
leaf max-count {
type uint32 {
range 1024..4294967295;
}
description "The max-count value that is in use by this
control connection. This will usually be the same value
as is configured under twamp-server. However, in the
event that the user re-configured twamp-server:max-count
after this control connection is already in progress,
this read-only value will show the different max-count
that is in use for this control connection.";
}
leaf salt{
type binary {
length "16";
}
description "Salt MUST be generated pseudo-randomly";
}
leaf server-iv {
type binary {
length "16";
}
description "16 octets, Server-IV is generated randomly
by the Control-Client.";
}
leaf challenge {
type binary {
length "16";
}
description "Challenge is a random sequence of octets
generated by the Server";
}
}
}
container twamp-session-sender{
if-feature session-sender;
presence "twamp-session-sender";
description "Twamp session sender container";
leaf session-sender-admin-state {
type boolean;
mandatory "true";
description "Indicates whether this device is allowed to run
TWAMP to initiate test sessions";
}
list twamp-sender-test-session{
key "test-session-name";
description "Twamp sender test sessions";
leaf test-session-name {
type string;
description "A unique name for this test session to be
used as a key for this test session by the Session-Sender
logical entity.";
}
leaf ctrl-connection-name {
type string;
config "false";
description "The name of the parent control connection
that is responsible for negotiating this test session.";
}
leaf fill-mode {
type fill-mode;
default zero;
description "Indicates whether the padding added to the
UDP test packets will contain pseudo-random numbers, or
whether it should consist of all zeroes.";
}
leaf number-of-packets {
type uint32;
description "The overall number of UDP test packets to be
transmitted by the sender for this test session.";
}
choice packet-distribution {
description "Packet distributions, poisson or periodic";
case periodic {
leaf periodic-interval {
type uint32;
description "Periodic interval";
}
leaf periodic-interval-units {
type units;
description "Periodic interval units";
}
}
case poisson {
leaf lambda{
type uint32;
description "The average rate of
packet transmission.";
}
leaf lambda-units{
type uint32;
description "Lambda units.";
}
leaf max-interval{
type uint32;
description "maximum time between packet
transmissions.";
}
leaf truncation-point-units{
type units;
description "Truncation point units";
}
}
}
leaf sender-session-state {
type sender-session-state;
config "false";
description "Sender session state.";
}
uses maintenance-statistics;
}
}
container twamp-session-reflector {
if-feature session-reflector;
presence "twamp-session-reflector";
description "Twamp session reflector container";
leaf session-reflector-admin-state {
type boolean;
mandatory "true";
description "Indicates whether this device is allowed to run
TWAMP to respond to test sessions";
}
leaf refwait {
type uint32 {
range 1..604800;
}
default 900;
description "REFWAIT (TWAMP test session timeout),
the default value is 900";
}
list twamp-reflector-test-session {
key "sender-ip sender-udp-port reflector-ip
reflector-udp-port";
config "false";
description "Twamp reflector test sessions";
leaf sid{
type string;
description "An auto-allocated identifier for this test
session, that is unique within the context of this
Server/Session-Reflector device only. ";
}
leaf sender-ip {
type inet:ip-address;
description "Sender IP address.";
}
leaf sender-udp-port {
type dynamic-port-number;
description "Sender UDP port.";
}
leaf reflector-ip {
type inet:ip-address;
description "Reflector IP address.";
}
leaf reflector-udp-port {
type dynamic-port-number;
description "Reflector UDP port.";
}
leaf parent-connection-client-ip {
type inet:ip-address;
description "Parent connction client IP address.";
}
leaf parent-connection-client-tcp-port {
type inet:port-number;
description "Parent connection client TCP port.";
}
leaf parent-connection-server-ip {
type inet:ip-address;
description "Parent connection server IP address.";
}
leaf parent-connection-server-tcp-port {
type inet:port-number;
description "Parent connection server TCP port";
}
leaf dscp {
type inet:dscp;
description "The DSCP value present in the IP header of
TWAMP UDP test packets belonging to this test session.";
}
uses maintenance-statistics;
}
}
}
}
<CODE ENDS>
This section presents a simple but complete example of configuring all four entities in Figure 1, based on the YANG module specified in Section 5. The example is illustrative in nature, but aims to be self-contained, i.e. were it to be executed in a real TWAMP implementation it would lead to a correctly configured test session. A more elaborated example, which also includes authentication parameters, is provided in Appendix A.
The following configuration example shows a Control-Client with client-admin-state enabled. In a real implementation following Figure 2 this would permit the initiation of TWAMP-Control connections and TWAMP-Test sessions.
<?xml version="1.0" encoding="utf-8"?>
<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-client>
<client-admin-state>true</client-admin-state>
</twamp-client>
</twamp>
</config>
The following configuration example shows a Control-Client with two instances of twamp-client-ctrl-connection, one called "RouterA" and another called "RouterB". Each TWAMP-Control connection is to a different Server. The control connection named "RouterA" has two test session requests. The TWAMP-Control connection named "RouterB" has no TWAMP-Test session requests.
<?xml version="1.0" encoding="utf-8"?>
<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-client>
<client-admin-state>true</client-admin-state>
<twamp-client-ctrl-connection>
<ctrl-connection-name>RouterA</ctrl-connection-name>
<client-ip>203.0.113.1</client-ip>
<server-ip>203.0.113.2</server-ip>
<twamp-session-request>
<test-session-name>Test1</test-session-name>
<sender-ip>10.1.1.1</sender-ip>
<sender-udp-port>50000</sender-udp-port>
<reflector-ip>10.1.1.2</reflector-ip>
<reflector-udp-port>500001</reflector-udp-port>
<start-time>0</start-time>
</twamp-session-request>
<twamp-session-request>
<test-session-name>Test2</test-session-name>
<sender-ip>203.0.113.1</sender-ip>
<sender-udp-port>4001</sender-udp-port>
<reflector-ip>203.0.113.2</reflector-ip>
<reflector-udp-port>50001</reflector-udp-port>
<start-time>0</start-time>
</twamp-session-request>
</twamp-client-ctrl-connection>
<twamp-client-ctrl-connection>
<ctrl-connection-name>RouterB</ctrl-connection-name>
<client-ip>203.0.113.1</client-ip>
<server-ip>203.0.113.3</server-ip>
</twamp-client-ctrl-connection>
</twamp-client>
</twamp>
</config>
This configuration example shows a Server with server-admin-state enabled, which permits a device following Figure 2 to respond to TWAMP-Control connections and TWAMP-Test sessions.
<?xml version="1.0" encoding="utf-8"?>
<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-server>
<server-admin-state>true</server-admin-state>
</twamp-server>
</twamp>
</config>
The following example presents a Server with the TWAMP-Control connection corresponding to the control connection name (ctrl-connection-name) "RouterA" presented in Section 6.1.
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-server>
<server-admin-state>true</server-admin-state>
<twamp-server-ctrl-connection>
<client-ip>203.0.113.1</client-ip>
<client-tcp-port>16341</client-tcp-port>
<server-ip>203.0.113.2</server-ip>
<server-tcp-port>862</server-tcp-port>
<server-ctrl-connection-state>
active
</server-ctrl-connection-state>
</twamp-server-ctrl-connection>
</twamp-server>
</twamp>
</data>
The following configuration example shows a Session-Sender with the two TWAMP-Test sessions presented in Section 6.1.
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-session-sender>
<session-sender-admin-state>true</session-sender-admin-state>
<twamp-sender-test-session>
<test-session-name>Test1</test-session-name>
<ctrl-connection-name>RouterA</ctrl-connection-name>
<number-of-packets>900</number-of-packets>
<periodic-interval>1</periodic-interval>
<periodic-interval-units>seconds</periodic-interval-units>
<sender-session-state>setup</sender-session-state>
</twamp-sender-test-session>
<twamp-sender-test-session>
<test-session-name>Test2</test-session-name>
<ctrl-connection-name>
RouterA
</ctrl-connection-name>
<number-of-packets>900</number-of-packets>
<lambda>1</lambda>
<lambda-units>1</lambda-units>
<max-interval>2</max-interval>
<truncation-point-units>seconds</truncation-point-units>
<sender-session-state>setup</sender-session-state>
</twamp-sender-test-session>
</twamp-session-sender>
</twamp>
</data>
The following example shows the two Session-Reflector TWAMP-Test sessions corresponding to the test sessions presented in Section 6.3.
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-session-reflector>
<session-reflector-admin-state>
true
</session-reflector-admin-state>
<twamp-reflector-test-session>
<sender-ip>10.1.1.1</sender-ip>
<sender-udp-port>4000</sender-udp-port>
<reflector-ip>10.1.1.2</reflector-ip>
<reflector-udp-port>50001</reflector-udp-port>
<sid>1232</sid>
<parent-connection-client-ip>
203.0.113.1
</parent-connection-client-ip>
<parent-connection-client-tcp-port>
16341
</parent-connection-client-tcp-port>
<parent-connection-server-ip>
203.0.113.2
</parent-connection-server-ip>
<parent-connection-server-tcp-port>
862
</parent-connection-server-tcp-port>
<sent-packets>2</sent-packets>
<rcv-packets>2</rcv-packets>
<last-sent-seq>1</last-sent-seq>
<last-rcv-seq>1</last-rcv-seq>
</twamp-reflector-test-session>
<twamp-reflector-test-session>
<sender-ip>203.0.113.1</sender-ip>
<sender-udp-port>50000</sender-udp-port>
<reflector-ip>192.68.0.2</reflector-ip>
<reflector-udp-port>50001</reflector-udp-port>
<sid>178943</sid>
<parent-connection-client-ip>
203.0.113.1
</parent-connection-client-ip>
<parent-connection-client-tcp-port>
16341
</parent-connection-client-tcp-port>
<parent-connection-server-ip>
203.0.113.2
</parent-connection-server-ip>
<parent-connection-server-tcp-port>
862
</parent-connection-server-tcp-port>
<sent-packets>21</sent-packets>
<rcv-packets>21</rcv-packets>
<last-sent-seq>20</last-sent-seq>
<last-rcv-seq>20</last-rcv-seq>
</twamp-reflector-test-session>
</twamp-session-reflector>
</twamp>
</data>
TBD
This document registers a URI in the IETF XML registry [RFC3688]. Following the format in [RFC3688], the following registration is requested to be made.
URI: urn:ietf:params:xml:ns:yang:ietf-twamp
Registrant Contact: The IPPM WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
This document registers a YANG module in the YANG Module Names registry [RFC6020].
name: ietf-twamp
namespace: urn:ietf:params:xml:ns:yang:ietf-twamp
prefix: twamp
reference: RFC XXXX
We thank Gregory Mirsky, Kevin D'Souza, and Robert Sherman for their thorough and constructive reviews, comments and text suggestions.
Haoxing Shen contributed to the definition of the YANG module in Section 5.
Ladislav Lhokta did thorough review of the YANG module and the examples.
Kostas Pentikousis is partially supported by FP7 UNIFY (http://fp7-unify.eu), a research project partially funded by the European Community under the Seventh Framework Program (grant agreement no. 619609). The views expressed here are those of the authors only. The European Commission is not liable for any use that may be made of the information in this document.
This appendix extends the example presented in Section 6 by configuring more fields such as authentication parameters, dscp values and so on.
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-client>
<client-admin-state>true</client-admin-state>
<mode-preference-chain>
<priority>0</priority>
<mode>authenticated</mode>
</mode-preference-chain>
<mode-preference-chain>
<priority>1</priority>
<mode>unauthenticated</mode>
</mode-preference-chain>
<key-chain>
<key-id>KeyClient1ToRouterA</key-id>
<secret-key>secret1</secret-key>
</key-chain>
<key-chain>
<key-id>KeyForRouterB</key-id>
<secret-key>secret2</secret-key>
</key-chain>
<twamp-client-ctrl-connection>
<ctrl-connection-name>RouterA</ctrl-connection-name>
<client-ip>203.0.113.1</client-ip>
<server-ip>203.0.113.2</server-ip>
<dscp>32</dscp>
<key-id>KeyClient1ToRouterA</key-id>
<twamp-session-request>
<test-session-name>Test1</test-session-name>
<sender-ip>10.1.1.1</sender-ip>
<sender-udp-port>4000</sender-udp-port>
<reflector-ip>10.1.1.2</reflector-ip>
<reflector-udp-port>5000</reflector-udp-port>
<padding-length>64</padding-length>
<start-time>0</start-time>
<test-session-state>ok</test-session-state>
<sid>1232</sid>
</twamp-session-request>
<twamp-session-request>
<test-session-name>Test2</test-session-name>
<sender-ip>203.0.113.1</sender-ip>
<sender-udp-port>4001</sender-udp-port>
<reflector-ip>203.0.113.2</reflector-ip>
<reflector-udp-port>5001</reflector-udp-port>
<padding-length>128</padding-length>
<start-time>0</start-time>
<test-session-state>ok</test-session-state>
<sid>178943</sid>
</twamp-session-request>
</twamp-client-ctrl-connection>
</twamp-client>
</twamp>
</data>
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-server>
<server-admin-state>true</server-admin-state>
<servwait>1800</servwait>
<dscp>32</dscp>
<modes>authenticated unauthenticated</modes>
<count>1024</count>
<key-chain>
<key-id>KeyClient1ToRouterA</key-id>
<secret-key>secret1</secret-key>
</key-chain>
<key-chain>
<key-id>KeyClient10ToRouterA</key-id>
<secret-key>secret10</secret-key>
</key-chain>
<twamp-server-ctrl-connection>
<client-ip>203.0.113.1</client-ip>
<client-tcp-port>16341</client-tcp-port>
<server-ip>203.0.113.2</server-ip>
<server-tcp-port>862</server-tcp-port>
<server-ctrl-connection-state>
active
</server-ctrl-connection-state>
<dscp>32</dscp>
<selected-mode>unauthenticated</selected-mode>
<key-id>KeyClient1ToRouterA</key-id>
<count>1024</count>
</twamp-server-ctrl-connection>
</twamp-server>
</twamp>
</data>
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-session-sender>
<session-sender-admin-state>true</session-sender-admin-state>
<twamp-sender-test-session>
<test-session-name>Test1</test-session-name>
<ctrl-connection-name>RouterA</ctrl-connection-name>
<fill-mode>zero</fill-mode>
<number-of-packets>900</number-of-packets>
<periodic-interval>1</periodic-interval>
<periodic-interval-units>seconds</periodic-interval-units>
<sender-session-state>setup</sender-session-state>
<sent-packets>2</sent-packets>
<rcv-packets>2</rcv-packets>
<last-sent-seq>1</last-sent-seq>
<last-rcv-seq>1</last-rcv-seq>
</twamp-sender-test-session>
<twamp-sender-test-session>
<test-session-name>Test2</test-session-name>
<ctrl-connection-name>
RouterA
</ctrl-connection-name>
<fill-mode>random</fill-mode>
<number-of-packets>900</number-of-packets>
<lambda>1</lambda>
<lambda-units>1</lambda-units>
<max-interval>2</max-interval>
<truncation-point-units>seconds</truncation-point-units>
<sender-session-state>setup</sender-session-state>
<sent-packets>21</sent-packets>
<rcv-packets>21</rcv-packets>
<last-sent-seq>20</last-sent-seq>
<last-rcv-seq>20</last-rcv-seq>
</twamp-sender-test-session>
</twamp-session-sender>
</twamp>
</data>
<?xml version="1.0" encoding="utf-8"?>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<twamp xmlns="urn:ietf:params:xml:ns:yang:ietf-twamp">
<twamp-session-reflector>
<session-reflector-admin-state>
true
</session-reflector-admin-state>
<twamp-reflector-test-session>
<sender-ip>10.1.1.1</sender-ip>
<sender-udp-port>4000</sender-udp-port>
<reflector-ip>10.1.1.2</reflector-ip>
<reflector-udp-port>5000</reflector-udp-port>
<sid>1232</sid>
<parent-connection-client-ip>
203.0.113.1
</parent-connection-client-ip>
<parent-connection-client-tcp-port>
16341
</parent-connection-client-tcp-port>
<parent-connection-server-ip>
203.0.113.2
</parent-connection-server-ip>
<parent-connection-server-tcp-port>
862
</parent-connection-server-tcp-port>
<dscp>32</dscp>
<sent-packets>2</sent-packets>
<rcv-packets>2</rcv-packets>
<last-sent-seq>1</last-sent-seq>
<last-rcv-seq>1</last-rcv-seq>
</twamp-reflector-test-session>
<twamp-reflector-test-session>
<sender-ip>203.0.113.1</sender-ip>
<sender-udp-port>4001</sender-udp-port>
<reflector-ip>192.68.0.2</reflector-ip>
<reflector-udp-port>5001</reflector-udp-port>
<sid>178943</sid>
<parent-connection-client-ip>
203.0.113.1
</parent-connection-client-ip>
<parent-connection-client-tcp-port>
16341
</parent-connection-client-tcp-port>
<parent-connection-server-ip>
203.0.113.2
</parent-connection-server-ip>
<parent-connection-server-tcp-port>
862
</parent-connection-server-tcp-port>
<dscp>32</dscp>
<sent-packets>21</sent-packets>
<rcv-packets>21</rcv-packets>
<last-sent-seq>20</last-sent-seq>
<last-rcv-seq>20</last-rcv-seq>
</twamp-reflector-test-session>
</twamp-session-reflector>
</twamp>
</data>
This document is targeted at configuration details for TWAMP. Operational actions such as how TWAMP sessions are started/stopped, how results are retrieved, or stored results are cleared, and so on, are not addressed by this configuration model and are out of scope of this document.
TWAMP operational commands could be performed programmatically or manually, e.g. using a command-line interface (CLI). With respect to programmability, YANG can be used to define NETCONF Remote Procedure Calls (RPC), therefore it would be possible to define RPC operations for actions such as starting or stopping control or test sessions or groups of sessions; retrieving results; clearing stored results, and so on.
However, [RFC5357] does not attempt to describe such operational actions, and it is likely that different TWAMP implementations could support different sets of operational commands, with different restrictions. Therefore, this document considers it the responsibility of the individual implementation to define its corresponding TWAMP operational commands data model.