YANG Data Model for LSP-PingHuawei TechnologiesChinavero.zheng@huawei.comGoogleUSAaldrin.ietf@gmail.comHuawei TechnologiesChinazhengguangying@huawei.comZTE Corp.USAgregimirsky@gmail.comCisco SystemsCanadarrahman@cisco.comCisco Systemsfaiqbal@cisco.comWhen an LSP fails to deliver user traffic, the failure cannot always
be detected by the MPLS control plane. RFC 8029 defines a mechanism that
would enable users to detect such failure and to isolate faults. YANG,
defined in RFC 6020, is a data model definition language that was introduced to define
the contents of a conceptual data stores that allow networked devices to
be managed using NETCONF, as specified in RFC 6241. This document defines a YANG data
model that can be used to configure and manage LSP-Ping.When an LSP fails to deliver user traffic, the failure cannot always
be detected by the MPLS control plane. defines
a mechanism that would enable users to detect such failure and to
isolate faults. YANG is a data definition
language that was introduced to define the contents of a conceptual data
store that allows networked devices to be managed using NETCONF . This document defines a YANG data model that can be
used to configure and manage LSP-Ping .The rest of this document is organized as follows. Section 2 presents
the scope of this document. Section 3 provides the design of the
LSP-Ping configuration data model in details by containers. Section 4
presents the complete data hierarchy of LSP-Ping YANG model. Section 5
discusses the interaction between LSP-Ping data model and other MPLS
tools data models. Section 6 specifies the YANG module and section 7
lists examples which conform to the YANG module specified in this
document. Finally, security considerations are discussed in Section
8.
This version of the interfaces data model confirms to the Network
Management Datastore Architecture (NMDA) .
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY", and "OPTIONAL" in this document are to be interpreted as
described in BCP 14
when, and only when, they appear in all capitals, as shown here.
LSP Ping is one of examples of what can described as "long-running
operation". Unlike most of configuration operations that result in
single response execution of an LSP Ping triggers multiple responses
from a node under control. The question of implementing long-running
operation in NETCONF is still open and possible solutions being
discussed:1. Consecutive Remote Processing Calls (RPC) to poll for
results;2. Model presented in ;3. The one outlined in .The problem of long-running operation as well can be considered as
a case of controlling and obtaining results from a Measurement Agent
(MA) as defined in .Yanfeng Zhang (Huawei Technologies) contributed to the definition
of the YANG module in Section 6.The fundamental mechanism of LSP-Ping is defined in . Extensions of LSP-Ping has been
developed over the years. There are extensions for
performing LSP ping, for example, over P2MP MPLS LSPs
or for Segment Routing IGP Prefix and
Adjacency SIDs with an MPLS data plane . These
extensions will be considered in update of this document.This YANG data model is defined to be used to configure and manage
LSP-Ping and it provides the following features:1. Configuration of control information of a LSP-Ping test;2. Configuration of schedule parameters of a LSP-Ping test;3. Display of result information of a LSP-Ping test.The top level container lsp-pings holds the configuration of control
information, schedule parameters and result information for multiple
instances of LSP-Ping test.Container lsp-pings:lsp-ping:control-info defines the configuration
parameters which control a LSP-Ping test. Examples are the
target-fec-type/target-fec of the echo request packet and the reply
mode of the echo reply packet. Values of some parameters may be
auto-assigned by the system, but in several cases there is a
requirement for configuration of these parameters. Examples of such
parameters are source address and outgoing interface.The data hierarchy for control information configuration is
presented below:Container lsp-pings:lsp-ping:schedule-parameters defines the
schedule parameters of a LSP-Ping test, which basically describes when
to start and when to end the test. Four start modes and three end
modes are defined respectively. To be noted that, the configuration of
"interval" and "probe-count" parameter defined in container
lsp-pings:lsp-ping:control-info could also determine when the test
ends implicitly. All these three parameters are optional. If
"interval" and "probe-count" are not configured by the user, the
default values will be used by the system. If "end-test" is configured
by the user, the actual end time of the LSP-Ping test is the smaller
one between the configuration value of "end-test" and the time
implicitly determined by the configuration value of
"interval"/"probe-count".The data hierarchy for schedule information configuration is
presented below:Container lsp-pings:lsp-ping:result-info shows the result of the
current LSP-Ping test. Both the statistical result e.g. min-rtt, max
rtt, and per test probe result e.g. return code, return subcode, are
shown.The data hierarchy for display of result information is presented
below:The complete data hierarchy of LSP-Ping YANG model is presented
below.TBA file "ietf-lspping@2018-03-01.yang"
module ietf-lspping {
namespace "urn:ietf:params:xml:ns:yang:ietf-lspping";
//namespace need to be assigned by IANA
prefix "lspping";
import ietf-inet-types {
prefix inet;
}
import ietf-yang-types{
prefix yang;
}
organization "IETF Multiprotocol Label Switching Working Group";
contact "draft-zheng-mpls-lsp-ping-yang-cfg";
description "MPLS LSP-Ping YANG Module";
revision "2018-03-01" {
description "07 version, refine the target fec type,
as per RFC8029 and update Security Considerations section";
reference "draft-zheng-mpls-lsp-ping-yang-cfg";
}
typedef target-fec-type {
type enumeration {
enum ip-prefix {
value "0";
description "IPv4/IPv6 prefix";
}
enum bgp {
value "1";
description "BGP IPv4/IPv6 prefix";
}
enum rsvp {
value "2";
description "Tunnel interface";
}
enum vpn {
value "3";
description "VPN IPv4/IPv6 prefix";
}
enum pw {
value "4";
description "FEC 128 pseudowire IPv4/IPv6";
}
enum vpls {
value "5";
description "FEC 129 pseudowire IPv4/IPv6";
}
}
description "Target FEC type.";
}
typedef reply-mode {
type enumeration {
enum do-not-reply {
value "1";
description "Do not reply";
}
enum reply-via-udp {
value "2";
description "Reply via an IPv4/IPv6 UDP packet";
}
enum reply-via-udp-router-alert {
value "3";
description "Reply via an IPv4/IPv6 UDP packet with
Router Alert";
}
enum reply-via-control-channel {
value "4";
description "Reply via application level control
channel";
}
}
description "Reply mode.";
}
typedef units {
type enumeration {
enum seconds {
description "Seconds";
}
enum milliseconds {
description "Milliseconds";
}
enum microseconds {
description "Microseconds";
}
enum nanoseconds {
description "Nanoseconds";
}
}
description "Time units";
}
typedef operational-status {
type enumeration {
enum enabled {
value "1";
description "The Test is active.";
}
enum disabled {
value "2";
description "The test has stopped.";
}
enum completed {
value "3";
description "The test is completed.";
}
}
description "Operational state of a LSP Ping test.";
}
typedef result-type {
type enumeration {
enum success {
value "1";
description "The test probe is successful.";
}
enum fail {
value "2";
description "The test probe has failed.";
}
enum timeout {
value "3";
description "The test probe is timeout.";
}
}
description "Result of each LSP Ping test probe.";
}
container lsp-pings {
description "Multi instance of LSP Ping test.";
list lsp-ping {
key "lsp-ping-name";
description "LSP Ping test";
leaf lsp-ping-name {
type string {
length "1..31";
}
mandatory "true";
description "LSP Ping test name.";
}
container control-info {
description "Control information of the LSP Ping test.";
leaf target-fec-type {
type target-fec-type;
description "Specifies the address type of Target FEC.";
}
choice target-fec {
case ip-prefix {
leaf ip-address {
type inet:ip-address;
description "IPv4/IPv6 Prefix.";
}
}
case bgp {
leaf bgp {
type inet:ip-address;
description "BGP IPv4/IPv6 Prefix.";
}
}
case rsvp {
leaf tunnel-interface {
type union {
type uint32;
type string;
}
description "Tunnel interface";
}
}
case vpn {
leaf vrf-name {
type uint32;
description "Layer3 VPN Name.";
}
leaf vpn-ip-address {
type inet:ip-address;
description "Layer3 VPN IPv4 Prefix.";
}
}
case pw {
leaf vcid {
type uint32;
description "VC ID";
}
}
case vpls {
leaf vsi-name {
type string;
description "VPLS VSI";
}
}
description "Specifies the address of Target FEC";
}
leaf traffic-class {
type uint8;
description "Specifies the Traffic Class.";
}
leaf reply-mode {
type reply-mode;
description "Specifies the reply mode.";
}
leaf timeout {
type uint32;
description "Specifies the time-out value for a
LSP Ping operation.";
}
leaf timeout-units {
type units;
description "Time-out units.";
}
leaf interval {
type uint32;
default 1;
description "Specifies the interval to send a LSP Ping
echo request packet(probe) as part of one LSP Ping test.";
}
leaf interval-units {
type units;
default seconds;
description "Interval units.";
}
leaf probe-count {
type uint32;
default 5;
description "Specifies the number of probe sent of one
LSP Ping test.";
}
leaf data-size {
type uint32;
description "Specifies the size of the data portion to
be transmitted in a LSP Ping operation, in octets.";
}
leaf data-fill {
type string{
length "0..1564";
}
description "Used together with the corresponding
data-size value to determine how to fill the data
portion of a probe packet.";
}
leaf description {
type string{
length "1..31";
}
description "A descriptive name of the LSP Ping test.";
}
leaf source-address-type {
type inet:ip-version;
description "Specifies the type of the source address.";
}
leaf source-address {
type inet:ip-address;
description "Specifies the source address.";
}
leaf ttl {
type uint32;
default 255;
description "Time to live.";
}
choice outbound {
case interface {
leaf interface-name{
type string{
length "1..255";
}
description "Specifies the outgoing interface.";
}
}
case nexthop{
leaf nexthop {
type inet:ip-address;
description "Specifies the nexthop.";
}
}
description "Specifies the out interface or nexthop";
}
}
container schedule-parameters {
description "LSP Ping test schedule parameter";
choice start-test{
case now {
leaf start-test-now {
type empty;
description "Start test now.";
}
}
case at {
leaf start-test-at {
type yang:date-and-time;
description "Start test at a specific time.";
}
}
case delay {
leaf start-test-delay {
type uint32;
description "Start after a specific delay.";
}
leaf start-test-delay-units {
type units;
default seconds;
description "Delay units.";
}
}
case daily {
leaf start-test-daily {
type yang:date-and-time;
description "Start test daily.";
}
}
description "Specifies when the test begins to start,
include 4 schedule method: start now(1), start at(2),
start delay(3), start daily(4).";
}
choice end-test{
case at {
leaf end-test-at{
type yang:date-and-time;
description "End test at a specific time.";
}
}
case delay {
leaf end-test-delay {
type uint32;
description "End after a specific delay.";
}
leaf end-test-delay-units {
type units;
default seconds;
description "Delay units.";
}
}
case lifetime {
leaf end-test-lifetime {
type uint32;
description "Set the test lifetime.";
}
leaf lifetime-units {
type units;
default seconds;
description "Lifetime units.";
}
}
description "Specifies when the test ends, include 3
schedule method: end at(1), end delay(2),
end lifetime(3).";
}
}
container result-info {
config "false";
description "LSP Ping test result information.";
leaf operational-status {
type operational-status;
description "Operational state of a LSP Ping test";
}
leaf source-address-type {
type inet:ip-version;
description "The source address type.";
}
leaf source-address {
type inet:ip-address;
description "The source address of the test.";
}
leaf target-fec-type {
type target-fec-type;
description "The Target FEC address type.";
}
choice target-fec {
case ip-prefix {
leaf ip-address {
type inet:ip-address;
description "IPv4/IPv6 Prefix.";
}
}
case bgp {
leaf bgp {
type inet:ip-address;
description "BGP IPv4/IPv6 Prefix.";
}
}
case rsvp {
leaf tunnel-interface {
type uint32;
description "Tunnel interface";
}
}
case vpn {
leaf vrf-name {
type uint32;
description "Layer3 VPN Name.";
}
leaf vpn-ip-address {
type inet:ip-address;
description "Layer3 VPN IPv4 Prefix.";
}
}
case pw {
leaf vcid {
type uint32;
description "VC ID";
}
}
case vpls {
leaf vsi-name {
type string;
description "VPLS VSI";
}
}
description "The Target FEC address";
}
leaf min-rtt {
type uint32;
description "The minimum LSP Ping round-trip-time (RTT)
received.";
}
leaf max-rtt {
type uint32;
description "The maximum LSP Ping round-trip-time (RTT)
received.";
}
leaf average-rtt {
type uint32;
description "The current average LSP Ping round-trip-time
(RTT).";
}
leaf probe-responses {
type uint32;
description "Number of responses received for the
corresponding LSP Ping test.";
}
leaf sent-probes {
type uint32;
description "Number of probes sent for the
corresponding LSP Ping test.";
}
leaf sum-of-squares {
type uint32;
description "The sum of the squares for all
replies received.";
}
leaf last-good-probe {
type yang:date-and-time;
description "Date and time when the last response
was received for a probe.";
}
container probe-results {
description "Result info of test probes.";
list probe-result {
key "probe-index";
description "Result info of each test probe.";
leaf probe-index {
type uint32;
config false;
description "Probe index";
}
leaf return-code {
type uint8;
config false;
description "The Return Code set in the echo reply.";
}
leaf return-sub-code {
type uint8;
config false;
description "The Return Sub-code set in the
echo reply.";
}
leaf rtt {
type uint32;
config false;
description "The round-trip-time (RTT) received.";
}
leaf result-type {
type result-type;
config false;
description "The probe result type.";
}
}
}
}
}
}
}
]]>The following examples shows the netconf RPC communication between
client and server for one LSP-Ping test case.Configure the control-info for sample-test-case.sample-test-caseip-prefix2001:db8::1:100/64reply-via-udp1seconds1seconds6enabled64this is a lsp ping testipv42001:db8::456
Reply from netconf server:
]]>Set the schedule-parameters for sample-test-case to start the
test.sample-test-case
Reply from netconf server:
]]>Get the result-info of sample-test-case.sample-test-case
Reply from netconf server:
sample-test-casecompletedipv42001:db8::4ip-prefix2001:db8::1:100/641056366688822015-07-01T10:36:5600310success10356success20335success30338success40336success50341success
]]>
The YANG module specified in this document defines a schema for data that is
designed to be accessed via network management protocols such as NETCONF
or RESTCONF . The lowest NETCONF layer is the secure transport layer,
and the mandatory-to-implement secure transport is Secure Shell (SSH) .
The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS .
The NETCONF access control model provides the means to restrict access for
particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF
protocol operations and content.
Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus important
to control access to these operations. These are the operations and their sensitivity/vulnerability:
TBD
The LSP ping YANG module inherits all security consideration of .
The IANA is requested to as assign a new namespace URI from the IETF
XML registry.URI:TBAWe would also like to thank XXX.