A YANG model for Multicast Protocol for Low power and lossy Networks (MPL)

This section describes the four yang modules. The modules are based on the MPL specification published in and the specification of . The identification of the interfaces follows the specification of ietf-interfaces of . The data model allows to set values to the parameters of the MPL algorithm. This approach requires an active manager process to set the values without use of DHCP as described in: . The names of the four modules are: yang-mpl-domain, yang-mpl-ops, yang-mpl-seeds, and yang-mpl-statistics, described in subsections with the same name.

This module describes (1) the MPL domains and the associated multicast addresses, and (2) the interfaces and the multicast addresses for which they are enabled. The model features a choice such that: the model specifies for constrained devices with only one "single" interface and only one "single" domain, a list of MC addresses for which the single interface is enabled. the model specifies for larger devices "multiple" interface and "multiple" domains, a list of MC addresses for which one or more interfaces are enabled.

file "ietf-yang-mpl-domain@2018-07-06.yang" module ietf-yang-mpl-domain { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-yang-mpl-domain"; prefix mpl; import ietf-inet-types{ prefix inet; } organization "IETF ROLL (Routing Over Low power and lossy networks) Working Group"; contact "WG Web: http://tools.ietf.org/wg/roll/ WG List: mailto:roll@ietf.org WG Chair: Peter van der Stok mailto:consultancy@vanderstok.org WG Chair: Ines Robles mailto:maria.ines.robles@ericsson.com Editor: Peter van der Stok mailto:consultancy@vanderstok.org"; description "This module contains information about the state of the MPL domain. Copyright (c) 2018 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; revision "2018-07-06" { description "revision 3"; reference "I-D:draft-ietf-roll-mpl-yang: A YANG model for Multicast Protocol for Low power and lossy Networks (MPL)"; } container domain { description "High level container containing the choice statement between single domain/interface and multiple domains and interfaces."; choice multiple { description "A choice for large devices with multiple domains and interfaces."; container mpl-domain { description "The entries describe the MPL domains, the associated Multicast addresses and interfaces."; list domains { key domainID; description "The entries describe a given domain identified with domainID and the associated Multicast addresses."; leaf domainID { type uint16; description "Entry uniquely identifies the domain in the forwarder."; } leaf-list MClist{ type inet:ipv6-address; description "List of associated IPv6 Addresses."; } } // domains list list addresses { key MCaddress; description "The entries describe the interfaces enabled with the specified MC address."; leaf MCaddress { type inet:ipv6-address; description "MC address belonging to a MPL domain."; } leaf-list interfaces { type string; description "List of names of interfaces enabled for this Multicast address. Interface name is defined in Appendix A of [RFC8343]."; } } // addresses list } // container mpl-domain container mpl-single { description "A choice for constrained devices with a list of MC addresses for single interface and domain."; leaf-list MCaddresses{ type inet:ipv6-address; description "list of MC addresses belonging to one single domain and interface."; } } // container mpl-simple } // choice simple } // container module } //module ietf-yang-mpl-domain

]]>

 





This module models the operational aspects of MPL. Per domain MPL specifies four parameters I_MAX, I_MIN, K, and TIMER_EXPIRATIONs for data and control messages. The value of the MPL intervals are expressed in TUNIT. The entry SE_LIFETIME taken over from  fixes TUNIT to milliseconds. For very constrained devices with only one domain there can be only one instance of mpl-parameter list. The module augments the ietf-yang-mpl-domain module.

file "ietf-yang-mpl-ops@2018-07-06.yang"

module ietf-yang-mpl-ops {

  yang-version 1.1;

  namespace 
      "urn:ietf:params:xml:ns:yang:ietf-yang-mpl-ops";
  prefix "mplo";

  import ietf-yang-mpl-domain{
     prefix "mpl";
  }

  organization
    "IETF ROLL (Routing over Low power and lossy networks)
 Working Group";

  contact
     "WG Web:   http://tools.ietf.org/wg/roll/
     WG List:  mailto:roll@ietf.org

     WG Chair: Peter van der Stok
               mailto:consultancy@vanderstok.org

     WG Chair: Ines Robles
               mailto:maria.ines.robles@ericsson.com

     Editor:   Peter van der Stok
               mailto:consultancy@vanderstok.org";

  description
     "This module contains information about the operation of 
      the MPL protocol.

     Copyright (c) 2018 IETF Trust and the persons identified as
     authors of the code.  All rights reserved.

     Redistribution and use in source and binary forms, with or

     without modification, is permitted pursuant to, and subject
     to the license terms contained in, the Simplified BSD License
     set forth in Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (http://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX; see
     the RFC itself for full legal notices.";

revision "2018-07-06" {
      description "revision 3";
      reference
        "I-D:draft-ietf-roll-mpl-yang: A YANG model for Multicast
         Protocol for Low power and lossy Networks (MPL)";
    }

    augment "/mpl:domain" {
       description 
          "additional MPL server settings to MPL domains";

    container mpl-ops {
      description
         "Parameter settings for each MPL server and for each 
          individual domain of the server.";

      leaf PROACTIVE_FORWARDING {
        type boolean;
        description
           "The boolean value indicates whether the MPL forwarder
            schedules MPL data message transmission after
            receiving them for the first time.
            Specified in section 5.4 of [RFC7731]";
      }

      leaf SEED_SET_ENTRY_LIFETIME {
         type uint64;
         units "seconds";
         default 1800;
         description
            "The value indicates the minimum lifetime for 
             an entry in the Seed set expressed in seconds.
             Default value is 30 minutes.
             Specified in section 5.4 of [RFC7731]";
       }

       list mpl-parameter{
          key  domainID;
          description
             "Each domain has a set of MPL forwarding parameters
              which regulate the forwarding operation.";

          leaf  domainID{
             type uint16;
             description
                "Each domainID must be present in  
                 mpl-parameter list.";
          }

          leaf DATA_MESSAGE_IMIN{
             type uint16;
             description
                "The minimum Trickle timer interval
                 for MPL Data Message transmissions.
                 mpl-ops/mpl-parameter/DATA_MESSAGE_IMIN <=
                 mpl-seeds/buffered-messages/I <=
                 mpl-ops/mpl-parameter/DATA_MESSAGE_IMAX 
                 Specified in section 5.4 of [RFC7731]";
           }

           leaf DATA_MESSAGE_IMAX{
              type uint16;
              description
                 "The maximum Trickle timer interval 
                  for MPL Data Message transmissions.
                  mpl-ops/mpl-parameter/DATA_MESSAGE_IMIN <=
                  mpl-seeds/buffered-messages/I <=
                  mpl-ops/mpl-parameter/DATA_MESSAGE_IMAX 
                  Specified in section 5.4 of [RFC7731]";
           }

           leaf DATA_MESSAGE_K{
              type uint16;
              default 1;
              description
                 "The redundancy constant
                  for MPL Data Message transmissions.
                  Specified in section 5.4 of [RFC7731]";
           }

           leaf DATA_MESSAGE_TIMER_EXPIRATIONS{
              type uint16;
              default 3;
              description
                  "The number of Trickle timer expirations, as
                   that occur before terminating the Trickle 
                   algorithm's retransmission of a given 
                   MPL Data Message.
                   Specified in section 5.4 of [RFC7731]";
            }

            leaf CONTROL_MESSAGE_IMIN{
               type uint16;
               description
                  "The minimum Trickle timer interval
                   for MPL Control Message transmissions.
                   Specified in section 5.4 of [RFC7731]";
            }

            leaf CONTROL_MESSAGE_IMAX{
               type uint16;
               description
                  "The maximum Trickle timer interval
                   for MPL Control Message transmissions.
                   Specified in section 5.4 of [RFC7731]";
            }

            leaf CONTROL_MESSAGE_K{
               type uint16;
               default 1;
               description
                  "The redundancy constant
                   for MPL Control Message transmissions.
                   Specified in section 5.4 of [RFC7731]";
            }

            leaf CONTROL_MESSAGE_TIMER_EXPIRATIONS{
               type uint16;
               default 10;
               description
                  "The number of Trickle time expirations,
                   that occur before terminating the Trickle
                   algorithm for MPL Control Message
                   transmissions.
                   Specified in section 5.4 of [RFC7731]";
            }

       }  // list MPL-parameter
     }  // container MPL-ops
   }  // augment ietf-yang-mpl-domain
} // module ietf-yang-mpl-ops



]]>
    


 



This module specifies the current values of the operation of the MPL forwarder. The values are acquired by the client and set by the server. The module specifies a set of message buffers, with a buffer per seed and domain. In constrained devices there will be only one domain, but probably multiple seeds.

The message buffer contains a set of messages where each message is uniquely identified by its sequence number and seed. The associated I, c, e, and t values indicate the progress of MPL with respect to this message, as specified in . A forwarder sends and receives multiple copies of a message. When a forwarder has sent (received) a copy of a message, the forwarder has sent (received) that message.

For forwarders which are seeds, local has value true and seqno is the sequence number of the next message to send.

The module augments the ietf-yang-mpl-domain module.

file "ietf-yang-mpl-seeds@2018-07-06.yang"

module ietf-yang-mpl-seeds {

  yang-version 1.1;

  namespace 
      "urn:ietf:params:xml:ns:yang:ietf-yang-mpl-seeds";

  prefix "mplse";

  import ietf-yang-mpl-domain{
     prefix "mpl";
  }

  organization
    "IETF ROLL (Routing over Low power and lossy networks)
 Working Group";

  contact
    "WG Web:   http://tools.ietf.org/wg/roll/
     WG List:  mailto:roll@ietf.org

     WG Chair: Peter van der Stok
               mailto:consultancy@vanderstok.org

     WG Chair: Ines Robles
               mailto:maria.ines.robles@ericsson.com

     Editor:   Peter van der Stok
               mailto:consultancy@vanderstok.org";

  description
     "This module contains information about the operation 
      of the MPL protocol.

     Copyright (c) 2018 IETF Trust and the persons identified as
     authors of the code.  All rights reserved.

     Redistribution and use in source and binary forms, with or

     without modification, is permitted pursuant to, and subject
     to the license terms contained in, the Simplified BSD License
     set forth in Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (http://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX; see
     the RFC itself for full legal notices.";

revision "2018-07-06" {
      description "revision 3";
      reference
        "I-D:draft-ietf-roll-mpl-yang: A YANG model for Multicast
 Protocol for Low power and lossy Networks (MPL)";
    }
 
augment "/mpl:domain" {
       description "additional message buffer status to MPL 
       domains";

     leaf SE_LIFETIME {
        type uint16;
        units "milliseconds/timer units";
        description
           "Conversion from clock ticks to milliseconds,
            equivalent to SEED_SET_ENTRY_LIFETIME/TUNIT as
            specified in [RFC7774].";
     }

     list mpl-seeds{
        key "seedID domainID";
        config false;
        description
           "List describes all seeds that are active in the 
            server. Seed information contains the message buffer
            contents and the operational values of I, c, sequence
            number and the life-times per message.";

      leaf seedID{
         type uint64;
         description
            "value uniquely identifies the MPL Seed within a MPL
             domain.";
      }

      leaf domainID{
         type uint16;
         description
            "together with seedID uniquely identifies buffer 
             set.";
      }

      leaf local {
         type boolean;
         description
            "When local == true, seed originated in this
             forwarder.
             When local == false, seed originated in different
             forwarder.";
     }

     leaf generate-seqno {
        type uint8;
        description
           "Sequence number of next message to be generated by 
            this local seed.";
     }

     leaf life-time {
        type uint64;
        units   "milliseconds";
        description
           "Minimum remaining lifetime of the seed entry in
            milliseconds.";
     }

     leaf min-seqno{
        type uint8;
        description
           "Lower bound sequence number in the buffer of the 
            seed.";
     }

     leaf data-number{
        type uint8;
        description
           "Number of currently buffered data messages.";
     }

     leaf control-number{
        type uint8;
        description
           "Number of currently buffered control messages.";
     }

      list buffered-messages{
         key seqno;
         description
            "status of trickle intervals of the buffered message 
             identified by seqno. and seed/domain";

         leaf seqno{
            type uint8;
            description
               "Sequence number of message.";
         }

         leaf I{
            type uint8;
            units  "milliseconds";
            description
               "Current Trickle timer interval size in 
                milliseconds.
                mpl-ops/mpl-parameter/DATA_MESSAGE_IMIN <=
                mpl-seeds/buffered-messages/I <=
                mpl-ops/mpl-parameter/DATA_MESSAGE_IMAX"; 
         }

         leaf c{
            type uint8;
            description
               "number of times that a copy of this message has 
                been received in this interval.";
         }

         leaf e{
            type uint8;
            description
               "number of Trickle time expirations since last
                Trickle timer reset.";
         }

         leaf t{
            type uint8;
            units  "milliseconds";
            description
               "Time expressed in milliseconds
                that message will be (is) forwarded.
                mpl-seeds/buffered-messages/t < 
                mpl-seeds/buffered-messages/I";
         }

     } // list seed-timers
   } // list MPL-seeds
  } // augment
} // module ietf-yang-mpl-seeds




]]>
    


 



This module specifies the operation of the MPL forwarder expressed in number of messages and copies. The values are acquired by the client and set by the server. Statistics are specified per seed and domain. In constrained devices there will be only one domain, but probably multiple seeds.

The parameter k determines how many copies of a message can be forwarded. The counters c-too-high, nr-forwarded, and nr-not-forwarded give insight in the consequences of the current value of k.

The other counters give insight in the loss of messages caused by the medium or forwarding delays. The inconsistent/consistent counters indicate when consistent or inconsistent messages were received according to the definition of consistent in .

The module augments the ietf-yang-mpl-domain module.


file "ietf-yang-mpl-statistics@2018-07-06.yang"


module ietf-yang-mpl-statistics {

  yang-version 1.1;

  namespace 
      "urn:ietf:params:xml:ns:yang:ietf-yang-mpl-statistics";

  prefix "mplst";

  import ietf-yang-mpl-domain{
     prefix "mpl";
  }

  organization
    "IETF ROLL (Routing over Low power and lossy networks)
     Working Group";

  contact
    "WG Web:   http://tools.ietf.org/wg/roll/
     WG List:  mailto:roll@ietf.org

     WG Chair: Peter van der Stok
               mailto:consultancy@vanderstok.org

     WG Chair: Ines Robles
               mailto:maria.ines.robles@ericsson.com

     Editor:   Peter van der Stok
               mailto:consultancy@vanderstok.org";

  description
    "This module contains information about the operation 
     of the MPL protocol.

     Copyright (c) 2018 IETF Trust and the persons identified as
     authors of the code.  All rights reserved.

     Redistribution and use in source and binary forms, with or

     without modification, is permitted pursuant to, and subject
     to the license terms contained in, the Simplified BSD License
     set forth in Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (http://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX; see
     the RFC itself for full legal notices.";

revision "2018-07-06" {
      description "revision 3";
      reference
        "I-D:draft-ietf-roll-mpl-yang: A YANG model for Multicast
 Protocol for Low power and lossy Networks (MPL)";
    }

 augment "/mpl:domain" {
       description "additional MPL message statistics to MPL 
       domains";

     list mpl-statistics{
     key "seedID domainID";

     config false;
    
     description
        "List describes performance statistics integrated over
         the messages identified by seed and domain identifiers.
         A forwarder can receive and forward multiple copies of 
         a message uniquely identified by seqno, domain, and 
         seed.";
      
      leaf seedID{
         type uint64;
         description
            "value uniquely identifies the MPL Seed within a MPL
             domain.";
      }

      leaf domainID{
         type uint16;
         description
            "together with seed-ID uniquely identifies buffer 
             set.";
      }

      leaf c-too-high {
         type uint64;
         description
            "Number of times that a copy was not forwarded
             because c > k.";
      }

      leaf nr-forwarded {
         type uint64;
         description
            "number of times copies are forwarded, 
             while c <= k.";
      }

      leaf nr-of-messages-received{
         type uint64;
         description
            "number of messages received, 
             must be smaller than or equal to seqno.";
      }

         leaf nr-of-messages-forwarded{
         type uint64;
         description
            "number of forwarded messages, must be smaller 
             than or equal to nr-of-messages-received.";
      }


      leaf nr-of-copies-received{
         type uint64;
         description
            "total number of message copies received.";
      }

      leaf nr-of-copies-forwarded{
         type uint64;
         description
            "number of forwarded copies, can be larger than 
             number-of-copies-received.";
      }

      leaf nr-of-refused-copies{
         type uint64;
         description
            "number of refused copies because seqno too small.";
      }

      leaf nr-of-missed-messages{
         type uint64;
         description
            "number of messages that were not received 
             because seqno < min-seqno.";
      }

      leaf nr-of-notreceived-messages{
         type uint64;
         description
            "number of messages that were not received
             according to control message.";
      }

      leaf nr-of-inconsistent-data{
         type uint64;
         description
            "number of inconsistent data messages.";
      }

      leaf nr-of-consistent-data{
         type uint64;
         description
            "number of consistent data messages.";
      }

      leaf nr-of-consistent-control{
         type uint64;
         description
            "number of consistent control messages.";
      }

      leaf nr-of-inconsistent-control{
         type uint64; 
         description
            "number of inconsistent control messages.";
      }

      leaf statistics-interval{
         type uint64;
         description
            "Interval, expressed in seconds, during which
             the statistics are collected.";
      }

      action reset-buffer-statistics{
         description
            "set all statistics counters and 
             statistics-interval of buffer[seedID domainID}
             to zero.";
      }
 
   }  // list mpl statistics
   
   action reset-all-statistics{
      description
         "set all statistics counters and 
          statistics-interval of all buffers to zero.";
   }

  }  //  augment
} // module  ietf-yang-mpl-statistics




]]>