Skip to main content

Generic YANG Data Model for Connectionless Operations, Administration, and Maintenance(OAM) protocols
draft-ietf-lime-yang-connectionless-oam-09

The information below is for an old version of the document.
Document Type
This is an older version of an Internet-Draft that was ultimately published as RFC 8532.
Authors Deepak Kumar , Zitao Wang , Qin Wu , Reshad Rahman , Srihari Raghavan
Last updated 2017-08-31
Replaces draft-kumar-lime-yang-connectionless-oam
RFC stream Internet Engineering Task Force (IETF)
Formats
Reviews
Additional resources Mailing list discussion
Stream WG state Submitted to IESG for Publication
Document shepherd Carlos Pignataro
Shepherd write-up Show Last changed 2017-06-28
IESG IESG state Became RFC 8532 (Proposed Standard)
Consensus boilerplate Yes
Telechat date (None)
Responsible AD Benoît Claise
Send notices to Ron Bonica <rbonica@juniper.net>, Carlos Pignataro <cpignata@cisco.com>
draft-ietf-lime-yang-connectionless-oam-09
quot;IPv6 address type";
    }

    identity tp-attribute-type {
      base tp-address-technology-type;
      description
        "Test point attribute type";
    }

    identity system-id-address-type {
      base tp-address-technology-type;
      description
        "System id address type";
    }

    identity as-number-address-type {
      base tp-address-technology-type;
      description
        "AS number address type";
    }

    identity route-distinguisher-address-type {
      base tp-address-technology-type;
      description
        "Route Distinguisher address type";
    }

    grouping tp-address {
      leaf tp-location-type {
        type identityref {
          base tp-address-technology-type;
        }

        description
          "Test point address type.";
      }
      container tp-address {
        container mac-address {
          when "derived-from-or-self('../tp-location-type', 'mac-address-type')" {
            description
              "MAC address type";
          }
          leaf mac-address {

Kumar, et al.             Expires March 4, 2018                [Page 20]
Internet-Draft       Connection-Less OAM YANG model          August 2017

            type yang:mac-address;
            description
              "MAC Address";
          }
          description
            "MAC Address based MP Addressing.";
        }
        container ipv4-address {
          when "derived-from-or-self('../tp-location-type', 'ipv4-address-type')" {
            description
              "IPv4 address type";
          }
          leaf ipv4-address {
            type inet:ipv4-address;
            description
              "IPv4 Address";
          }
          description
            "IP Address based MP Addressing.";
        }
        container ipv6-address {
          when "derived-from-or-self('../tp-location-type', 'ipv6-address-type')" {
            description
              "IPv6 address type";
          }
          leaf ipv6-address {
            type inet:ipv6-address;
            description
              "IPv6 Address";
          }
          description
            "ipv6 Address based MP Addressing.";
        }
        container tp-attribute {
          when "derived-from-or-self('../tp-location-type', 'tp-attribute-type')" {
            description
              "Test point attribute type";
          }
          leaf tp-attribute-type {
            type address-attribute-type;
            description
              "Test point type.";
          }
          choice tp-attribute-value {
            description
              "Test point value.";
            case ip-prefix {
              leaf ip-prefix {

Kumar, et al.             Expires March 4, 2018                [Page 21]
Internet-Draft       Connection-Less OAM YANG model          August 2017

                type inet:ip-prefix;
                description
                  "IP prefix.";
              }
            }
            case bgp {
              leaf bgp {
                type inet:ip-prefix;
                description
                  "BGP Labeled Prefix ";
              }
            }
            case tunnel {
              leaf tunnel-interface {
                type uint32;
                description
                  "VPN Prefix ";
              }
            }
            case pw {
              leaf remote-pe-address {
                type inet:ip-address;
                description
                  "Remote pe address.";
              }
              leaf pw-id {
                type uint32;
                description
                  "Pseudowire ID is a non-zero 32-bit ID.";
                reference
                  "RFC 4379 :Detecting Multi-Protocol Label
                  Switched (MPLS) Data Plane Failures";
              }
            }
            case vpls {
              leaf route-distinguisher {
                type uint64;
                description
                  "Route Distinguisher is an 8 octets identifier
                  used to distinguish information about various
                  L2VPN advertised by a node.";
                reference
                  "RFC 4379 :Detecting Multi-Protocol Label
                  Switched (MPLS) Data Plane Failures";
              }
              leaf sender-ve-id {
                type uint16;
                description

Kumar, et al.             Expires March 4, 2018                [Page 22]
Internet-Draft       Connection-Less OAM YANG model          August 2017

                  "Sender's VE ID. The VE ID (VPLS Edge Identifier)
                   is a 2-octet identifier.";
                reference
                  "RFC 4379 :Detecting Multi-Protocol Label
                  Switched (MPLS) Data Plane Failures";
              }
              leaf receiver-ve-id {
                type uint16;
                description
                  "Receiver's VE ID.The VE ID (VPLS Edge Identifier)
                   is a 2-octet identifier.";
                reference
                  "RFC 4379 :Detecting Multi-Protocol Label
                  Switched (MPLS) Data Plane Failures";
              }
            }
            case mpls-mldp {
              choice root-address {
                description
                  "Root address choice.";
                case ip-address {
                  leaf source-address {
                    type inet:ip-address;
                    description
                      "IP address.";
                  }
                  leaf group-ip-address {
                    type inet:ip-address;
                    description
                      "Group ip address.";
                  }
                }
                case vpn {
                  leaf as-number {
                    type inet:as-number;
                    description
                    "The AS number represents autonomous system
                    numbers which identify an Autonomous System.";
                  }
                }
                case global-id {
                  leaf lsp-id {
                    type string;
                    description
                      "LSP ID is an identifier of a LSP
                       within a MPLS network.";
                    reference
                    "RFC 4379 :Detecting Multi-Protocol Label

Kumar, et al.             Expires March 4, 2018                [Page 23]
Internet-Draft       Connection-Less OAM YANG model          August 2017

                     Switched (MPLS) Data Plane Failures";
                  }
                }
              }
            }
          }
          description
             "Test Point Attribute Container";
        }
        container system-info {
          when "derived-from-or-self('../tp-location-type', 'system-id-address-type')" {
            description
              "System id address type";
          }
          leaf system-id {
            type router-id;
            description
              "System ID assigned to this node.";
          }
          description
             "system ID container.";
        }
        description
          "TP Addressing.";
      }
      description
        "TP Address";
    }

    grouping tp-address-ni {
      description
        "Test point address with VRF.";
      leaf ni {
        type routing-instance-ref;
        description
          "The ni is used to describe virtual resource partitioning
          that may be present on a network device.Example of common
          industry terms for virtual resource partitioning is VRF
          instance.";
      }
      uses tp-address;
    }

    grouping connectionless-oam-layers {
      list oam-neighboring-layers {
        key "index";
        leaf index {
          type uint8{

Kumar, et al.             Expires March 4, 2018                [Page 24]
Internet-Draft       Connection-Less OAM YANG model          August 2017

          range "0..128";}
          description
            "Index of a list of neighboring test points
             in the upstream layer and/or downstream layer
             and/or same layer";
        }
        leaf technology-level {
          type int8 {
            range "-1..1";
          }
          default "0";
          description
            "The relative technology level
             of neighboring test point
             corresponding to the current
             test point.Level 0 indicates default level,
             -1 means downstream layer related to current layer and +1
             means upstream layer related to current layer.
             In relationship 0 means same layer.";
        }
        choice tp-location {
          case mac-address {
            leaf mac-address-location {
              type yang:mac-address;
              description
                "MAC Address";
            }
            description
              "MAC Address based MP Addressing.";
          }
          case ipv4-address {
            leaf ipv4-address-location {
              type inet:ipv4-address;
              description
                "Ipv4 Address";
            }
            description
              "IP Address based MP Addressing.";
          }
          case ipv6-address {
            leaf ipv6-address-location {
              type inet:ipv6-address;
              description
                "IPv6 Address";
            }
            description
              "IPv6 Address based MP Addressing.";
          }

Kumar, et al.             Expires March 4, 2018                [Page 25]
Internet-Draft       Connection-Less OAM YANG model          August 2017

          case as-number {
            leaf as-number-location {
              type inet:as-number;
              description
                "AS number location";
            }
            description
              "AS number for point to multipoint OAM";
          }
          case system-id {
            leaf system-id-location {
              type router-id;
              description
                "System id location";
            }
            description
              "System ID";
          }
          description
            "TP location.";
        }

        description
          "List of neighboring test points in the upstream layer and/or
           downstream layer or same layer that are related to current test
           point. If neighboring test-point in the upstream layer exist, the
           technology-level is specified as +1. If neighboring test-point
           in the downstream layer exist, the technology-level is specified
           as -1, if neighboring test-points are located at the same layer
           as the current test-point, the technology-level is specified as
           0.";
      }
      description
        "Connectionless related OAM neighboring layer";
    }

    grouping tp-technology {
      choice technology {
        default "technology-null";
        case technology-null {
          description
            "This is a placeholder when no technology is needed.";
          leaf tech-null {
            type empty;
            description
              "There is no technology define";
          }
        }

Kumar, et al.             Expires March 4, 2018                [Page 26]
Internet-Draft       Connection-Less OAM YANG model          August 2017

        description
          "Technology choice.";
      }
      description
        "OAM Technology";
    }

    grouping tp-tools {
      description
        "Test Point OAM Toolset.";
      container tp-tools {
        leaf continuity-check {
          type boolean;
          mandatory true;
          description
            "A flag indicating whether or not the
             continuity check function is supported.";
          reference
            "RFC 792: INTERNET CONTROL MESSAGE PROTOCOL.
             RFC 4443: Internet Control Message Protocol (ICMPv6)
             for the Internet Protocol Version 6 (IPv6) Specification.
             RFC 5880: Bidirectional Forwarding Detection.
             RFC 5881: BFD for IPv4 and IPv6.
             RFC 5883: BFD for Multihop Paths.
             RFC 5884: BFD for MPLS Label Switched Paths.
             RFC 5885: BFD for PW VCCV.
             RFC 6450: Multicast Ping Protocol.";
        }
        leaf path-discovery {
          type boolean;
          mandatory true;
          description
            "A flag indicating whether or not the
             path discovery function is supported.";
          reference
            "RFC 792: INTERNET CONTROL MESSAGE PROTOCOL.
             RFC 4443: Internet Control Message Protocol (ICMPv6)
             for the Internet Protocol Version 6 (IPv6) Specification.
             RFC 4884: Extended ICMP to Support Multi-part Message.
             RFC 5837:Extending ICMP for Interface
             and Next-Hop Identification.
             RFC 4379: LSP-PING.";
        }
        description
          "Container for test point OAM tools set.";
      }
    }

Kumar, et al.             Expires March 4, 2018                [Page 27]
Internet-Draft       Connection-Less OAM YANG model          August 2017

    grouping test-point-location-info {
      uses tp-technology;
      uses tp-tools;
      anydata root {
        yangmnt:mount-point "root";
        description
          "Root for models supported per
           test point";
      }
      uses connectionless-oam-layers;
      description
        "Test point Location";
    }

    grouping test-point-locations {
      description
        "Group of test point locations.";
          leaf tp-location-type {
        type identityref {
          base tp-address-technology-type;
        }
        description
          "Test point location type.";
      }
      container location-type {
        container ipv4-location-type {
          when "derived-from-or-self('../tp-location-type', 'ipv4-address-type')" {
            description
              "When test point location type is equal to ipv4 address.";
          }
          container test-point-ipv4-location-list {
            list test-point-locations {
              key "ipv4-location ni";
              leaf ipv4-location {
                type inet:ipv4-address;
                description
                  "IPv4 Address.";
              }
              leaf ni {
                type routing-instance-ref;
                description
                  "The ni is used to describe the
                   corresponding network instance";
              }
              uses test-point-location-info;
              description
                "List of test point locations.";
            }

Kumar, et al.             Expires March 4, 2018                [Page 28]
Internet-Draft       Connection-Less OAM YANG model          August 2017

            description
              "Serves as top-level container
               for test point location list.";
          }
          description
             "ipv4 location type container.";
        }
        container ipv6-location-type {
          when "derived-from-or-self('../tp-location-type', 'ipv6-address-type')" {
            description
              "when test point location is equal to ipv6 address";
          }
          container test-point-ipv6-location-list {
            list test-point-locations {
              key "ipv6-location ni";
              leaf ipv6-location {
                type inet:ipv6-address;
                description
                  "IPv6 Address.";
              }
              leaf ni {
                type routing-instance-ref;
                description
                  "The ni is used to describe the
                   corresponding network instance";
              }
              uses test-point-location-info;

              description
                "List of test point locations.";
            }
            description
              "Serves as top-level container
               for test point location list.";
          }
          description
             "ipv6 location type container.";
        }
        container mac-location-type {
          when "derived-from-or-self('../tp-location-type', 'mac-address-type')" {
            description
              "when test point location type is equal to mac address.";
          }
          container test-point-mac-address-location-list {
            list test-point-locations {
              key "mac-address-location";
              leaf mac-address-location {
                type yang:mac-address;

Kumar, et al.             Expires March 4, 2018                [Page 29]
Internet-Draft       Connection-Less OAM YANG model          August 2017

                description
                  "MAC Address";
              }
              uses test-point-location-info;

              description
                "List of test point locations.";
            }
            description
              "Serves as top-level container
               for test point location list.";
          }
          description
             "mac address location type container.";
        }
        container group-as-number-location-type {
          when "'tp-location-type' = 'as-number-address-type'" {
            description
              "When test point location type is equal to
               as-number.";
          }
          container test-point-as-number-location-list {
            list test-point-locations {
              key "as-number-location";
              leaf as-number-location {
                type inet:as-number;
                description
                  "AS number for point to multi point OAM.";
              }
              leaf ni {
                type routing-instance-ref;
                description
                  "The ni is used to describe the
                   corresponding network instance";
              }
              uses test-point-location-info;

              description
                "List of test point locations.";
            }
            description
              "Serves as top-level container
               for test point location list.";
          }
          description
             "as number location type container.";
        }
        container group-system-id-location-type {

Kumar, et al.             Expires March 4, 2018                [Page 30]
Internet-Draft       Connection-Less OAM YANG model          August 2017

          when "'tp-location-type' = 'system-id-address-type'" {
            description
              "When test point location is equal to
               system info.";
          }
          container test-point-system-info-location-list {
            list test-point-locations {
              key "system-id-location";
              leaf system-id-location {
                type inet:uri;
                description
                  "System Id.";
              }
              leaf ni {
                type routing-instance-ref;
                description
                  "The ni is used to describe the
                   corresponding network instance";
              }
              uses test-point-location-info;

              description
                "List of test point locations.";
            }
            description
              "Serves as top-level container for
               test point location list.";
          }
          description
             "system ID location type container.";
        }
        description
          "Choice of address types.";
      }
    }

    augment "/nd:networks/nd:network/nd:node" {
      description
        "Augment test points of connectionless oam.";
          uses test-point-locations;
    }

    grouping uint64-timestamp {
      description
        "Grouping for timestamp.";
      leaf timestamp-sec {
        type uint32;
        description

Kumar, et al.             Expires March 4, 2018                [Page 31]
Internet-Draft       Connection-Less OAM YANG model          August 2017

          "Absolute timestamp in seconds as per IEEE1588v2
           or seconds part in 64-bit NTP timestamp.";
      }
      leaf timestamp-nanosec {
        type uint32;
        description
          "Fractional part in nanoseconds as per IEEE1588v2
           or Fractional part in 64-bit NTP timestamp.";
      }
    }

    grouping timestamp {
      description
        "Grouping for timestamp.";
      leaf timestamp-type {
        type uint32;
        description
          "Truncated PTP = 0, NTP = 1";
      }
      uses uint64-timestamp;
    }

    grouping path-discovery-data {
      description
        "Path discovery related data output from nodes.";
      container src-test-point {
        description
          "Source test point.";
        uses tp-address-ni;
      }
      container dest-test-point {
        description
          "Destination test point.";
        uses tp-address-ni;
      }
      leaf sequence-number {
        type uint64;
        description
          "Sequence number in data packets.";
      }
      leaf hop-cnt {
        type uint8;
        description
          "Hop count.";
      }
      uses session-packet-statistics;
      uses session-error-statistics;
      uses session-delay-statistics;

Kumar, et al.             Expires March 4, 2018                [Page 32]
Internet-Draft       Connection-Less OAM YANG model          August 2017

      uses session-jitter-statistics;
      container path-verification {
        description
          "Optional path verification related information.";
        leaf flow-info {
          type string;
          description
            "Informations that refers to the flow.";
        }
        uses session-path-verification-statistics;
      }
      container path-trace-info {
        description
          "Optional path trace per-hop test point information.
           The list has typically a single element for per-hop
           cases like path-discovery RPC operation but allows
           a list of hop related information for other types of
           data retrieval methods.";
        list path-trace-info-list {
          key "index";
          description
            "Path trace information list.";
          leaf index {
            type uint32;
            description
              "Trace information index.";
          }
          uses tp-address-ni;
          uses timestamp;
          leaf ingress-intf-name {
            type if:interface-ref;
            description
              "Ingress interface name";
          }
          leaf egress-intf-name {
            type if:interface-ref;
            description
              "Egress interface name";
          }
          leaf queue-depth {
            type uint32;
            description
              "Length of the queue of the interface from where
               the packet is forwarded out.  The queue depth could
               be the current number of memory buffers used by the
               queue and a packet can consume one or more memory buffers
               thus constituting device-level information.";
          }

Kumar, et al.             Expires March 4, 2018                [Page 33]
Internet-Draft       Connection-Less OAM YANG model          August 2017

          leaf transit-delay {
            type uint32;
            description
              "Time in nano seconds
               packet spent transiting a node.";
          }
          leaf app-meta-data {
            type uint64;
            description
              "Application specific
               data added by node.";
          }
        }
      }
    }

    grouping continuity-check-data {
      description
        "Continuity check data output from nodes.";
      container src-test-point {
        description
          "Source test point.";
        uses tp-address-ni;
        leaf egress-intf-name {
          type if:interface-ref;
          description
            "Egress interface name";
        }
      }
      container dest-test-point {
        description
          "Destination test point.";
        uses tp-address-ni;
        leaf ingress-intf-name {
          type if:interface-ref;
          description
            "Ingress interface name";
        }
      }
      leaf sequence-number {
        type uint64;
        description
          "Sequence number.";
      }
      leaf hop-cnt {
        type uint8;
        description
          "Hop count.";

Kumar, et al.             Expires March 4, 2018                [Page 34]
Internet-Draft       Connection-Less OAM YANG model          August 2017

      }
      uses session-packet-statistics;
      uses session-error-statistics;
      uses session-delay-statistics;
      uses session-jitter-statistics;
    }

    container cc-session-statistics-data {
      if-feature "continuity-check";
      config false;
      description
        "CC operational information.";
      container cc-ipv4-sessions-statistics {
        description
          "CC ipv4 sessions";
        uses cc-session-statistics;
      }
      container cc-ipv6-sessions-statistics {
        description
          "CC ipv6 sessions";
        uses cc-session-statistics;
      }
    }
  }

   <CODE ENDS>

5.  Connectionless model applicability

   "ietf-connectionless-oam" model defined in this document provides
   technology-independent abstraction of key OAM constructs for
   connectionless protocols.  This model can be further extended to
   include technology specific details, e.g., adding new data nodes with
   technology specific functions and parameters into proper anchor
   points of the base model, so as to develop a technology-specific
   connectionless OAM model.

   This section demonstrates the usability of the connectionless YANG
   OAM data model to various connectionless OAM technologies, e.g., BFD,
   LSP ping.  Note that, in this section, we only present several
   snippets of technology-specific model extensions for illustrative
   purposes.  The complete model extensions should be worked on in
   respective protocol working groups.

Kumar, et al.             Expires March 4, 2018                [Page 35]
Internet-Draft       Connection-Less OAM YANG model          August 2017

5.1.  BFD Extension

5.1.1.  Augment Method

   The following sections shows how the "ietf-connectionless-oam" model
   can be extended to cover BFD technology.  For this purpose, a set of
   extension are introduced such as technology-type extension and test-
   point attributes extension.

   Note that in BFD WG, there is a BFD YANG data model
   [I-D.ietf-bfd-yang] to be produced.  Users can choose to use "ietf-
   connectioless-oam" as basis and augment the "ietf-connectionless-oam"
   model with bfd specific details.  The bfd specific details can be the
   grouping defined in the BFD model.

5.1.1.1.  Technology type extension

   No BFD technology type has been defined in the "ietf-connectionless-
   oam" model.  Therefore a technology type extension is required in the
   model Extension.

   The snippet below depicts an example of augmenting "bfd" type into
   the ietf-connectionless-oam":

   augment "/nd:networks/nd:network/nd:node/"
   +"coam:location-type/coam:ipv4-location-type"
   +"/coam:test-point-ipv4-location-list/"
   +"coam:test-point-locations/coam:technology"
   {
       leaf bfd{
      type string;
     }
   }

5.1.1.2.  Test point attributes extension

   To support bfd technology, the "ietf-connectionless-oam" model can be
   extended and add bfd specific parameters under "test-point-location"
   list and/or add new location type such as "bfd over MPLS-TE" under
   "location-type".

5.1.1.2.1.  Define and insert new nodes into corresponding test-point-
            location

   In the "ietf-connectionless-oam" model, multiple "test-point-
   location" lists are defined under the "location-type" choice node.
   Therefore, to derive a model for some bfd technologies ( such as ip
   single-hop, ip multi-hops, etc), data nodes for bfd specific details

Kumar, et al.             Expires March 4, 2018                [Page 36]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   need to be added into corresponding "test-point-locations" list.  In
   this section, we reuse some groupings which are defined in
   [I-D.ietf-bfd-yang] as following:

   The snippet below shows how the "ietf-connectionless-oam" model can
   be extended to support "BFD IP single-hop":

   augment "/nd:networks/nd:network/nd:node/"
   +"coam:location-type/coam:ipv4-location-type"
   +"/coam:test-point-ipv4-location-list/"
           +"coam:test-point-locations"
   {
           container session-cfg {
             description "BFD IP single-hop session configuration";
             list sessions {
               key "interface dest-addr";
               description "List of IP single-hop sessions";
               leaf interface {
                 type if:interface-ref;
                 description
                   "Interface on which the BFD session is running.";
               }
               leaf dest-addr {
                 type inet:ip-address;
                 description "IP address of the peer";
               }
               uses bfd:bfd-grouping-common-cfg-parms;
               uses bfd:bfd-grouping-echo-cfg-parms;
             }
           }
   }

   Similar augmentations can be defined to support other BFD
   technologies such as BFD IP multi-hop, BFD over MPLS, etc.

5.1.1.2.2.  Add new location-type cases

   In the "ietf-connectionless-oam" model, If there is no appropriate
   "location type" case that can be extended, a new "location-type" case
   can be defined and inserted into the "location-type" choice node.

   Therefore, the model user can flexibly add "location-type" to support
   other type of test point which are not defined in the "ietf-
   connectionless-oam" model.  In this section, we add a new "location-
   type" case and reuse some groupings which are defined in
   [I-D.ietf-bfd-yang] as follows:

Kumar, et al.             Expires March 4, 2018                [Page 37]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   The snippet below shows how the "ietf-connectionless-oam" model can
   be extended to support "BFD over MPLS-TE":

   augment "/nd:networks/nd:network/nd:node/coam:location-type"{
    case te-location{
     list test-point-location-list{
      key "tunnel-name";
      leaf tunnel-name{
       type leafref{
    path "/te:te/te:tunnels/te:tunnel/te:name";
   }
   description
   "point to a te instance.";
      }
       uses bfd:bfd-grouping-common-cfg-parms;
           uses bfd-mpls:bfd-encap-cfg;
     }
    }
   }

   Similar augmentations can be defined to support other BFD
   technologies such as BFD over LAG, etc.

5.1.2.  Schema Mount

   And another alternative method is using schema mount mechanism
   [I-D.ietf-netmod-schema-mount] in the "ietf-connectionless-oam".
   Within the "test-point-location" list, a "root" attribute is defined
   to provide a mounted point for models mounted per "test-point-
   location".  Therefore, the "ietf-connectionless-oam" model can
   provide a place in the node hierarchy where other OAM YANG data
   models can be attached, without any special extension in the "ietf-
   connectionless-oam" YANG data models [I-D.ietf-netmod-schema-mount].
   Note that the limitation of the Schema Mount method is it is not
   allowed to specify certain modules that are required to be mounted
   under a mount point.

   The snippet below depicts the definition of "root" attribute.

         anydata root {
          yangmnt:mount-point root;
          description
         "Root for models supported per
           test point";
         }

   The following section shows how the "ietf-connectionless-oam" model
   can use schema mount to support BFD technology.

Kumar, et al.             Expires March 4, 2018                [Page 38]
Internet-Draft       Connection-Less OAM YANG model          August 2017

5.1.2.1.  BFD Modules be populated in schema-mount

   To support BFD technology, "ietf-bfd-ip-sh" and "ietf-bfd-ip-mh" YANG
   modules might be populated in the "schema-mounts" container:

      <schema-mounts
          xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount">
        <mount-point>
          <module> ietf-connectionless-oam </module>
          <name>root</name>
          <use-schema>
            <name>root</name>
          </use-schema>
        </mount-point>
        <schema>
          <name>root</name>
          <module>
            <name>ietf-bfd-ip-sh </name>
            <revision>2016-07-04</revision>
            <namespace>
              urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh
            </namespace>
            <conformance-type>implement</conformance-type>
          </module>
          <module>
            <name>ietf-bfd-ip-mh </name>
            <revision> 2016-07-04</revision>
            <namespace>
              urn:ietf:params:xml:ns:yang:ietf-bfd-ip-mh
            </namespace>
            <conformance-type>implement</conformance-type>
          </module>
        </schema>
      </schema-mounts>

   and the " ietf-connectionless-oam " module might have:

Kumar, et al.             Expires March 4, 2018                [Page 39]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   <ietf-connectionless-oam
   uri="urn:ietf:params:xml:ns:yang:ietf-connectionless-oam">
      ......
    <test-point-locations>
     <ipv4-location>192.0.2.1</ipv4-location>
      ......
     <root>
      <ietf-bfd-ip-sh uri="urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh">
       <ip-sh>
        foo
        ......
       </ip-sh>
      </ietf-bfd-ip-sh>
      <ietf-bfd-ip-mh uri="urn:ietf:params:xml:ns:yang:ietf-bfd-ip-mh">
       <ip-mh>
        foo
        ......
       </ip-mh>
      </ietf-bfd-ip-mh>
     </root>
    </test-point-locations>
   </ietf-connectionless-oam>

5.2.  LSP ping extension

5.2.1.  Augment Method

   The following sections shows how the "ietf-connectionless-oam" model
   can be extended to support LSP ping technology.  For this purpose, a
   set of extension are introduced such as technology-type extension and
   test-point attributes extension.

   Note that in MPLS WG, there is a LSP Ping YANG data model
   [I-D.zheng-mpls-lsp-ping-yang-cfg] to be produced.  Users can choose
   to use "ietf-connectioless-oam" as basis and augment the "ietf-
   connectionless-oam" model with LSP Ping specific details in the model
   extension.  The LSP Ping specific details can be the grouping defined
   in the LSP ping model.

5.2.1.1.  Technology type extension

   No lsp-ping technology type has been defined in the "ietf-
   connectionless-oam" model.  Therefore a technology type extension is
   required in the model extension.

   The snippet below depicts an example of augmenting the "ietf-
   connectionless-oam" with "lsp-ping" type:

Kumar, et al.             Expires March 4, 2018                [Page 40]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   augment "/nd:networks/nd:network/nd:node/"
   +"coam:location-type/coam:ipv4-location-type"
   +"/coam:test-point-ipv4-location-list/"
           +"coam:test-point-locations/coam:technology"
   {
      leaf lsp-ping{
      type string;
     }
   }

5.2.1.2.  Test point attributes extension

   To support lsp-ping, the "ietf-connectionless-oam" model can be
   extended and add lsp-ping specific parameters can be defined and
   under "test-point-location" list.

   User can reuse the attributes or groupings which are defined in
   [I-D.zheng-mpls-lsp-ping-yang-cfg] as follows:

   The snippet below depicts an example of augmenting the "test-point-
   locations" list with lsp ping attributes:

   augment "/nd:networks/nd:network/nd:node/"
   +"coam:location-type/coam:ipv4-location-type"
   +"/coam:test-point-ipv4-location-list/"
           +"coam:test-point-locations"
   {
   list lsp-ping {
            key "lsp-ping-name";
            leaf lsp-ping-name {
             type string {
               length "1..31";
            }
           mandatory "true";
           description "LSP Ping test name.";
           ......
         }

5.2.2.  Schema Mount

   And another alternative method is using schema mount mechanism
   [I-D.ietf-netmod-schema-mount] in the "ietf-connectionless-oam".
   Within the "test-point-location" list, a "root" attribute is defined
   to provide a mounted point for models mounted per "test-point-
   location".  Therefore, the "ietf-connectionless-oam" model can
   provide a place in the node hierarchy where other OAM YANG data
   models can be attached, without any special extension in the "ietf-
   connectionless-oam" YANG data models [I-D.ietf-netmod-schema-mount].

Kumar, et al.             Expires March 4, 2018                [Page 41]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   Note that the limitation of the Schema Mount method is it is not
   allowed to specify certain modules that are required to be mounted
   under a mount point.

   The snippet below depicts the definition of "root" attribute.

         anydata root {
          yangmnt:mount-point root;
          description
         "Root for models supported per
           test point";
         }

   The following section shows how the "ietf-connectionless-oam" model
   can use schema mount to support LSP-PING technology.

5.2.2.1.  LSP-PING Modules be populated in schema-mount

   To support LSP-PING technology, "ietf-lspping" YANG module
   [I-D.zheng-mpls-lsp-ping-yang-cfg] might be populated in the "schema-
   mounts" container:

      <schema-mounts
          xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount">
        <mount-point>
          <module> ietf-connectionless-oam </module>
          <name>root</name>
          <use-schema>
            <name>root</name>
          </use-schema>
        </mount-point>
        <schema>
          <name>root</name>
          <module>
            <name>ietf-lspping </name>
            <revision>2016-03-18</revision>
            <namespace>
              urn:ietf:params:xml:ns:yang: ietf-lspping
            </namespace>
            <conformance-type>implement</conformance-type>
          </module>
        </schema>
      </schema-mounts>

   and the " ietf-connectionless-oam " module might have:

Kumar, et al.             Expires March 4, 2018                [Page 42]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   <ietf-connectionless-oam
   uri="urn:ietf:params:xml:ns:yang:ietf-connectionless-oam">
      ......
    <test-point-locations>
     <ipv4-location> 192.0.2.1</ipv4-location>
      ......
     <root>
      <ietf-lspping uri="urn:ietf:params:xml:ns:yang:ietf-lspping">
       <lsp-pings>
        foo
        ......
       </lsp-pings>
      </ietf-lspping>
     </root>
    </test-point-locations>
   </ietf-connectionless-oam>

6.  Security Considerations

   The YANG module defined in this document is designed to be accessed
   via network management protocols such as NETCONF [RFC6241] or
   RESTCONF [RFC8040].  The lowest NETCONF layer is the secure transport
   layer, and the mandatory-to-implement secure transport is Secure
   Shell (SSH) [RFC6242].  The lowest RESTCONF layer is HTTPS, and the
   mandatory-to-implement secure transport is TLS [RFC5246].

   The NETCONF access control model [RFC6536] provides the means to
   restrict access for particular NETCONF or RESTCONF users to a
   preconfigured subset of all available NETCONF or RESTCONF protocol
   operations and content.

   There are a number of data nodes defined in this YANG module that are
   writable/creatable/deletable (i.e., config true, which is the
   default).  These data nodes may be considered sensitive or vulnerable
   in some network environments.  Write operations (e.g., edit-config)
   to these data nodes without proper protection can have a negative
   effect on network operations.

   The vulnerable "config true" subtrees and data nodes are the
   following:

      /nd:networks/nd:network/nd:node/coam:location-type/coam:ipv4-
      location-type/coam:test-point-ipv4-location-list/coam:test-point-
      locations/

      /nd:networks/nd:network/nd:node/coam:location-type/coam:ipv6-
      location-type/coam:test-point-ipv6-location-list/coam:test-point-
      locations/

Kumar, et al.             Expires March 4, 2018                [Page 43]
Internet-Draft       Connection-Less OAM YANG model          August 2017

      /nd:networks/nd:network/nd:node/coam:location-type/coam:mac-
      location-type/coam:test-point-mac-address-location-list/coam:test-
      point-locations/

      /nd:networks/nd:network/nd:node/coam:location-type/coam:group-as-
      number-location-type/coam:test-point-as-number-location-list/
      coam:test-point-locations/

      /nd:networks/nd:network/nd:node/coam:location-type/coam:group-
      system-id-location-type/coam:test-point-system-info-location-list/
      coam:test-point-locations/

   Unauthorized access to any of these lists can adversely affect OAM
   management system handling of end-to-end OAM and coordination of OAM
   within underlying network layers.  This may lead to inconsistent
   configuration, reporting, and presentation for the OAM mechanisms
   used to manage the network.

   Some of the readable data nodes in this YANG module may be considered
   sensitive or vulnerable in some network environments.  It is thus
   important to control read access (e.g., via get, get-config, or
   notification) to these data nodes.  These are the subtrees and data
   nodes and their sensitivity/vulnerability:

      /coam:cc-session-statistics-data/coam:cc-ipv4-sessions-statistics/
      coam:cc-session-statistics/coam:session-count/

      /coam:cc-session-statistics-data/coam:cc-ipv4-sessions-statistics/
      coam:cc-session-statistics/coam:session-up-count/

      /coam:cc-session-statistics-data/coam:cc-ipv4-sessions-statistics/
      coam:cc-session-statistics/coam: session-down-count/

      /coam:cc-session-statistics-data/coam:cc-ipv4-sessions-statistics/
      coam:cc-session-statistics/coam:session-admin-down-count/

      /coam:cc-session-statistics-data/coam:cc-ipv6-sessions-statistics/
      coam:cc-session-statistics/coam:session-count/

      /coam:cc-session-statistics-data/coam:cc-ipv6-sessions-statistics/
      coam:cc-session-statistics/coam:session-up-count//

      /coam:cc-session-statistics-data/coam:cc-ipv6-sessions-statistics/
      coam:cc-session-statistics/coam:session-down-count/

      /coam:cc-session-statistics-data/coam:cc-ipv6-sessions-statistics/
      coam:cc-session-statistics/coam:session-admin-down-count/

Kumar, et al.             Expires March 4, 2018                [Page 44]
Internet-Draft       Connection-Less OAM YANG model          August 2017

7.  IANA Considerations

   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-connectionless-oam

   Registrant Contact: The IESG.

   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-connectionless-oam

   namespace: urn:ietf:params:xml:ns:yang:ietf-connectionless-oam

   prefix: coam

   reference: RFC XXXX

8.  Acknowlegements

   The authors of this document would like to thank Greg Mirsky and
   others for their sustainable review and comments, proposals to
   improve and stabilize document.

9.  References

9.1.  Normative References

   [RFC3688]  Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
              DOI 10.17487/RFC3688, January 2004, <https://www.rfc-
              editor.org/info/rfc3688>.

   [RFC4443]  Conta, A., Deering, S., and M. Gupta, Ed., "Internet
              Control Message Protocol (ICMPv6) for the Internet
              Protocol Version 6 (IPv6) Specification", STD 89,
              RFC 4443, DOI 10.17487/RFC4443, March 2006,
              <https://www.rfc-editor.org/info/rfc4443>.

   [RFC5246]  Dierks, T. and E. Rescorla, "The Transport Layer Security
              (TLS) Protocol Version 1.2", RFC 5246,
              DOI 10.17487/RFC5246, August 2008, <https://www.rfc-
              editor.org/info/rfc5246>.

Kumar, et al.             Expires March 4, 2018                [Page 45]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   [RFC6020]  Bjorklund, M., Ed., "YANG - A Data Modeling Language for
              the Network Configuration Protocol (NETCONF)", RFC 6020,
              DOI 10.17487/RFC6020, October 2010, <https://www.rfc-
              editor.org/info/rfc6020>.

   [RFC6241]  Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
              and A. Bierman, Ed., "Network Configuration Protocol
              (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
              <https://www.rfc-editor.org/info/rfc6241>.

   [RFC6242]  Wasserman, M., "Using the NETCONF Protocol over Secure
              Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
              <https://www.rfc-editor.org/info/rfc6242>.

   [RFC6536]  Bierman, A. and M. Bjorklund, "Network Configuration
              Protocol (NETCONF) Access Control Model", RFC 6536,
              DOI 10.17487/RFC6536, March 2012, <https://www.rfc-
              editor.org/info/rfc6536>.

   [RFC6991]  Schoenwaelder, J., Ed., "Common YANG Data Types",
              RFC 6991, DOI 10.17487/RFC6991, July 2013,
              <https://www.rfc-editor.org/info/rfc6991>.

   [RFC7223]  Bjorklund, M., "A YANG Data Model for Interface
              Management", RFC 7223, DOI 10.17487/RFC7223, May 2014,
              <https://www.rfc-editor.org/info/rfc7223>.

   [RFC792]   Postel, J., "Internet Control Message Protocol", RFC 792,
              September 1981.

   [RFC8040]  Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
              Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
              <https://www.rfc-editor.org/info/rfc8040>.

9.2.  Informative References

   [G.8013]   "OAM functions and mechanisms for Ethernet based
              networks", ITU-T Recommendation G.8013/Y.1731, 2013.

   [I-D.ietf-bfd-yang]
              Rahman, R., Zheng, L., Jethanandani, M., Networks, J., and
              G. Mirsky, "YANG Data Model for Bidirectional Forwarding
              Detection (BFD)", draft-ietf-bfd-yang-06 (work in
              progress), June 2017.

Kumar, et al.             Expires March 4, 2018                [Page 46]
Internet-Draft       Connection-Less OAM YANG model          August 2017

   [I-D.ietf-i2rs-yang-network-topo]
              Clemm, A., Medved, J., Varga, R., Bahadur, N.,
              Ananthakrishnan, H., and X. Liu, "A Data Model for Network
              Topologies", draft-ietf-i2rs-yang-network-topo-14 (work in
              progress), June 2017.

   [I-D.ietf-lime-yang-connection-oriented-oam-model]
              Kumar, D., Wu, Q., and Z. Wang, "Generic YANG Data Model
              for Connection Oriented Operations, Administration, and
              Maintenance(OAM) protocols", draft-ietf-lime-yang-
              connection-oriented-oam-model-00 (work in progress), June
              2017.

   [I-D.ietf-lime-yang-connectionless-oam-methods]
              Kumar, D., Wang, Z., Wu, Q., Rahman, R., and S. Raghavan,
              "Retrieval Methods YANG Data Model for Connectionless
              Operations, Administration, and Maintenance(OAM)
              protocols", draft-ietf-lime-yang-connectionless-oam-
              methods-05 (work in progress), June 2017.

   [I-D.ietf-netmod-schema-mount]
              Bjorklund, M. and L. Lhotka, "YANG Schema Mount", draft-
              ietf-netmod-schema-mount-06 (work in progress), July 2017.

   [I-D.ietf-spring-sr-yang]
              Litkowski, S., Qu, Y., Sarkar, P., and J. Tantsura, "YANG
              Data Model for Segment Routing", draft-ietf-spring-sr-
              yang-07 (work in progress), July 2017.

   [I-D.zheng-mpls-lsp-ping-yang-cfg]
              Zheng, L., Aldrin, S., Zheng, G., Mirsky, G., and R.
              Rahman, "Yang Data Model for LSP-PING", draft-zheng-mpls-
              lsp-ping-yang-cfg-05 (work in progress), June 2017.

   [RFC6136]  Sajassi, A., Ed. and D. Mohan, Ed., "Layer 2 Virtual
              Private Network (L2VPN) Operations, Administration, and
              Maintenance (OAM) Requirements and Framework", RFC 6136,
              DOI 10.17487/RFC6136, March 2011, <https://www.rfc-
              editor.org/info/rfc6136>.

   [RFC7276]  Mizrahi, T., Sprecher, N., Bellagamba, E., and Y.
              Weingarten, "An Overview of Operations, Administration,
              and Maintenance (OAM) Tools", RFC 7276,
              DOI 10.17487/RFC7276, June 2014, <https://www.rfc-
              editor.org/info/rfc7276>.

Kumar, et al.             Expires March 4, 2018                [Page 47]
Internet-Draft       Connection-Less OAM YANG model          August 2017

Authors' Addresses

   Deepak Kumar
   CISCO Systems
   510 McCarthy Blvd
   Milpitas, CA  95035
   USA

   Email: dekumar@cisco.com

   Michael Wang
   Huawei Technologies,Co.,Ltd
   101 Software Avenue, Yuhua District
   Nanjing  210012
   China

   Email: wangzitao@huawei.com

   Qin Wu
   Huawei
   101 Software Avenue, Yuhua District
   Nanjing, Jiangsu  210012
   China

   Email: bill.wu@huawei.com

   Reshad Rahman
   Cisco Systems
   2000 Innovation Drive
   Kanata, Ontario  K2K 3E8
   Canada

   Email: rrahman@cisco.com

   Srihari Raghavan
   Cisco Systems
   Tril Infopark Sez, Ramanujan IT City
   Neville Block, 2nd floor, Old Mahabalipuram Road
   Chennai, Tamil Nadu  600113
   India

   Email: srihari@cisco.com

Kumar, et al.             Expires March 4, 2018                [Page 48]