[Docs] [txt|pdf] [Tracker] [WG] [Email] [Diff1] [Diff2] [Nits]

Versions: (draft-schoenw-lmap-yang) 00 01 02 03 04 05 06 07 08 09 10 11 12 RFC 8194

Network Working Group                                   J. Schoenwaelder
Internet-Draft                                                 V. Bajpai
Intended status: Standards Track                Jacobs University Bremen
Expires: September 16, 2016                               March 15, 2016


             A YANG Data Model for LMAP Measurement Agents
                      draft-ietf-lmap-yang-03.txt

Abstract

   This document defines a data model for Large-Scale Measurement
   Platforms (LMAP).  The data model is defined using the YANG data
   modeling language.

Status of This Memo

   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 16, 2016.

Copyright Notice

   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.





Schoenwaelder & Bajpai Expires September 16, 2016               [Page 1]


Internet-Draft               LMAP Data Model                  March 2016


Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   2
     1.2.  Tree Diagrams . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Data Model Overview . . . . . . . . . . . . . . . . . . . . .   3
   3.  Relationship to the Information Model . . . . . . . . . . . .   7
   4.  YANG Modules  . . . . . . . . . . . . . . . . . . . . . . . .   8
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .  41
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  43
   7.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  44
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  44
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .  44
     8.2.  Informative References  . . . . . . . . . . . . . . . . .  45
   Appendix A.  Open Issues  . . . . . . . . . . . . . . . . . . . .  46
     A.1.  Purpose of /lmap-state/tasks  . . . . . . . . . . . . . .  46
     A.2.  Streamline the reporting model  . . . . . . . . . . . . .  46
   Appendix B.  Non-editorial Changes since -02  . . . . . . . . . .  46
   Appendix C.  Non-editorial Changes since -01  . . . . . . . . . .  47
   Appendix D.  Non-editorial Changes since -00  . . . . . . . . . .  47
   Appendix E.  Example IPPM Module for UDP Latency Metrics  . . . .  48
   Appendix F.  Example Configuration (XML)  . . . . . . . . . . . .  49
   Appendix G.  Example Configuration (JSON) . . . . . . . . . . . .  56
   Appendix H.  Example State (XML)  . . . . . . . . . . . . . . . .  65
   Appendix I.  Example State (JSON) . . . . . . . . . . . . . . . .  66
   Appendix J.  Example Report (XML) . . . . . . . . . . . . . . . .  68
   Appendix K.  Example Report (JSON)  . . . . . . . . . . . . . . .  71
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  75

1.  Introduction

   This document defines a data model for Large-Scale Measurement
   Platforms (LMAP) [RFC7594].  The data model is defined using the YANG
   [RFC6020] data modeling language.  It aims to be consistent with the
   LMAP Information Model [I-D.ietf-lmap-information-model].

1.1.  Terminology

   This document uses the LMAP terminology defined in [RFC7594].

   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].








Schoenwaelder & Bajpai Expires September 16, 2016               [Page 2]


Internet-Draft               LMAP Data Model                  March 2016


1.2.  Tree Diagrams

   A simplified graphical representation of the data model is used in
   this document.  The meaning of the symbols in these diagrams is as
   follows:

   o  Brackets "[" and "]" enclose list keys.

   o  Abbreviations before data node names: "rw" means configuration
      (read-write), "ro" means state data (read-only), and "w" means RPC
      input date (write-only).

   o  Symbols after data node names: "?" means an optional node, "!"
      means a presence container, and "*" denotes a list and leaf-list.

   o  Parentheses enclose choice and case nodes, and case nodes are also
      marked with a colon (":").

   o  Ellipsis ("...") stands for contents of subtrees that are not
      shown.

2.  Data Model Overview

   The tree diagram below shows the structure of the configuration data
   model.


 module: ietf-lmap-control
    +--rw lmap
       +--rw agent
       |  +--rw agent-id?                   yang:uuid
       |  +--rw device-id?                  inet:uri
       |  +--rw group-id?                   string
       |  +--rw measurement-point?          string
       |  +--rw report-agent-id?            boolean
       |  +--rw report-measurement-point?   boolean
       |  +--rw controller-timeout?         uint32
       +--rw tasks
       |  +--rw task* [name]
       |     +--rw name                   lmap:identifier
       |     +--rw metric* [uri]
       |     |  +--rw uri     inet:uri
       |     |  +--rw role*   string
       |     +--rw program?               string
       |     +--rw option* [id]
       |     |  +--rw id       lmap:identifier
       |     |  +--rw name?    string
       |     |  +--rw value?   string



Schoenwaelder & Bajpai Expires September 16, 2016               [Page 3]


Internet-Draft               LMAP Data Model                  March 2016


       |     +--rw suppress-by-default?   boolean
       |     +--rw tag*                   lmap:identifier
       +--rw schedules
       |  +--rw schedule* [name]
       |     +--rw name               lmap:identifier
       |     +--rw start              event-ref
       |     +--rw (stop)?
       |     |  +--:(end)
       |     |  |  +--rw end?               event-ref
       |     |  +--:(duration)
       |     |     +--rw duration?          uint32
       |     +--rw execution-mode?    enumeration
       |     +--rw tag*               lmap:tag
       |     +--rw suppression-tag*   lmap:tag
       |     +--rw action* [name]
       |        +--rw name               lmap:identifier
       |        +--rw task               task-ref
       |        +--rw parameters
       |        |  +--rw (extension)?
       |        +--rw option* [id]
       |        |  +--rw id       lmap:identifier
       |        |  +--rw name?    string
       |        |  +--rw value?   string
       |        +--rw destination*       schedule-ref
       |        +--rw tag*               lmap:tag
       |        +--rw suppression-tag*   lmap:tag
       +--rw suppressions
       |  +--rw suppression* [name]
       |     +--rw name            lmap:identifier
       |     +--rw start?          event-ref
       |     +--rw end?            event-ref
       |     +--rw match*          lmap:glob-pattern
       |     +--rw stop-running?   boolean
       +--rw events
          +--rw event* [name]
             +--rw name                    lmap:identifier
             +--rw (event-type)?
             |  +--:(periodic)
             |  |  +--rw periodic
             |  |     +--rw interval    uint32
             |  |     +--rw start?      yang:date-and-time
             |  |     +--rw end?        yang:date-and-time
             |  +--:(calendar)
             |  |  +--rw calendar
             |  |     +--rw month*             lmap:month-or-all
             |  |     +--rw day-of-month*      lmap:day-of-months-or-all
             |  |     +--rw day-of-week*       lmap:weekday-or-all
             |  |     +--rw hour*              lmap:hour-or-all



Schoenwaelder & Bajpai Expires September 16, 2016               [Page 4]


Internet-Draft               LMAP Data Model                  March 2016


             |  |     +--rw minute*            lmap:minute-or-all
             |  |     +--rw second*            lmap:second-or-all
             |  |     +--rw timezone-offset?   lmap:timezone-offset
             |  |     +--rw start?             yang:date-and-time
             |  |     +--rw end?               yang:date-and-time
             |  +--:(one-off)
             |  |  +--rw one-off
             |  |     +--rw time    yang:date-and-time
             |  +--:(immediate)
             |  |  +--rw immediate               empty
             |  +--:(startup)
             |  |  +--rw startup                 empty
             |  +--:(controller-lost)
             |  |  +--rw controller-lost         empty
             |  +--:(controller-connected)
             |     +--rw controller-connected    empty
             +--rw random-spread?          uint32


   The tree diagram below shows the structure of the state data model.































Schoenwaelder & Bajpai Expires September 16, 2016               [Page 5]


Internet-Draft               LMAP Data Model                  March 2016


   module: ietf-lmap-control
      +--ro lmap-state
         +--ro agent
         |  +--ro agent-id        yang:uuid
         |  +--ro device-id       inet:uri
         |  +--ro hardware        string
         |  +--ro firmware        string
         |  +--ro version         string
         |  +--ro last-started    yang:date-and-time
         +--ro tasks
         |  +--ro task* [name]
         |     +--ro name       lmap:identifier
         |     +--ro metric* [uri]
         |     |  +--ro uri     inet:uri
         |     |  +--ro role*   string
         |     +--ro version?   string
         |     +--ro program?   string
         +--ro schedules
         |  +--ro schedule* [name]
         |     +--ro name               lmap:identifier
         |     +--ro state?             enumeration
         |     +--ro invocations?       yang:counter32
         |     +--ro suppressions?      yang:counter32
         |     +--ro overlaps?          yang:counter32
         |     +--ro failures?          yang:counter32
         |     +--ro last-invocation?   yang:date-and-time
         |     +--ro action* [name]
         |        +--ro name                      lmap:identifier
         |        +--ro state?                    enumeration
         |        +--ro invocations?              yang:counter32
         |        +--ro suppressions?             yang:counter32
         |        +--ro overlaps?                 yang:counter32
         |        +--ro failures?                 yang:counter32
         |        +--ro last-invocation?          yang:date-and-time
         |        +--ro last-completion?          yang:date-and-time
         |        +--ro last-status?              lmap:status-code
         |        +--ro last-message?             string
         |        +--ro last-failed-completion?   yang:date-and-time
         |        +--ro last-failed-status?       lmap:status-code
         |        +--ro last-failed-message?      string
         +--ro suppressions
            +--ro suppression* [name]
               +--ro name     lmap:identifier
               +--ro state?   enumeration


   The tree diagram below shows the structure of the reporting data
   model.



Schoenwaelder & Bajpai Expires September 16, 2016               [Page 6]


Internet-Draft               LMAP Data Model                  March 2016


   module: ietf-lmap-report
   rpcs:
      +---x report
         +---w input
            +---w date                 yang:date-and-time
            +---w agent-id?            yang:uuid
            +---w group-id?            string
            +---w measurement-point?   string
            +---w task* [name]
               +---w name      lmap:identifier
               +---w metric* [uri]
               |  +---w uri     inet:uri
               |  +---w role*   string
               +---w option* [id]
               |  +---w id       lmap:identifier
               |  +---w name?    string
               |  +---w value?   string
               +---w tag*      lmap:tag
               +---w header
               |  +---w column*   string
               +---w row*
                  +---w start       yang:date-and-time
                  +---w end?        yang:date-and-time
                  +---w conflict*   string
                  +---w value*      string


3.  Relationship to the Information Model

   The LMAP information model [I-D.ietf-lmap-information-model] is
   devided into six sections.  They are mapped into the YANG data model
   as explained below:

   o  Pre-Configuration Information: This is not modeled explicitly
      since it is a subset of the configuration information.

   o  Configuration Information: This is modeled in the /lmap/agent
      subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree
      described below.  Some items have been left out because they are
      expected to be dealt with by the underlying protocol.

   o  Instruction Information: This is modeled in the /lmap/suppressions
      subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree
      described below.

   o  Logging Information: Some of the logging information, in
      particular 'success/failure/warning messages in response to
      information updates from the Controller', will be handled by the



Schoenwaelder & Bajpai Expires September 16, 2016               [Page 7]


Internet-Draft               LMAP Data Model                  March 2016


      protocol used to manipulate the lmap specific configuration.  For
      the first version of the LMAP data models, it is assumed that
      runtime logging information will be dealt with using protocols
      that do not require a formal data model, e.g., the Syslog protocol
      defined in [RFC5424].

   o  Capability and Status Information: Some of the status information
      is modeled in the /lmap-state/agent subtree and teh /lmap-state/
      schedules subtree.  Information about network interfaces can be
      obtained from the interfaces YANG data model [RFC7223].  The list
      of supported tasks is modeled in the /lmap-state/tasks subtree.

   o  Reporting Information: This is modeled by the report data model to
      be implemented by the Collector.  Measurement Agents send results
      to the Collector via an RPC operation.

   These six sections are build on the following common information
   objects:

   o  Schedules: This is modeled in the /lmap/schedules subtree.

   o  Channels: Channels are not modeled since the NETCONF and RESTCONF
      server configuration data model [I-D.ietf-netconf-server-model]
      already provides a mechanism to configure NETCONF and RESTCONF
      server channels.

   o  Task Configurations: This is modeled in the /lmap/tasks subtree.

   o  Event Information: This is modeled in the /lmap/events subtree.

4.  YANG Modules

   The modules import definitions from [RFC6991] and [RFC7223] and they
   reference [RFC7398].


   <CODE BEGINS> file "ietf-lmap-common@2016-03-15.yang"
   module ietf-lmap-common {

     namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-common";
     prefix "lmap";

     import ietf-inet-types {
       prefix inet;
     }

     organization
       "IETF Large-Scale Measurement Platforms Working Group";



Schoenwaelder & Bajpai Expires September 16, 2016               [Page 8]


Internet-Draft               LMAP Data Model                  March 2016


     contact
       "WG Web:   <http://tools.ietf.org/wg/lmap/>
        WG List:  <mailto:lmap@ietf.org>

        Editor:   Juergen Schoenwaelder
                  <j.schoenwaelder@jacobs-university.de>

        Editor:   Vaibhav Bajpai
                  <v.bajpai@jacobs-university.de>";

     description
       "This module provides common definitions used by the data
        models written for Large-Scale Measurement Platforms (LMAP).
        This module defines typedefs and groupings but no schema
        tree elements.";

     revision "2016-03-15" {
       description
        "Initial version";
       reference
        "RFC XXX: A YANG Data Model for LMAP Measurement Agents";
     }

     /*
      * Typedefs
      */

     typedef identifier {
       type string {
         length "1..max";
       }
       description
         "An string value used to name something.";
     }

     typedef tag {
       type string {
         length "1..max";
       }
       description
         "A tag consists of at least one character.";
     }

     typedef glob-pattern {
       type string {
         length "1..max";
       }
       description



Schoenwaelder & Bajpai Expires September 16, 2016               [Page 9]


Internet-Draft               LMAP Data Model                  March 2016


         "A glob style pattern (following POSIX.2 fnmatch() without
          special treatment of file paths):

            *         matches a sequence of characters
            ?         matches a single character
            [seq]     matches any character in seq
            [!seq]    matches any character not in seq

          A backslash followed by a character matches the following
          character. In particular:

            \*        matches *
            \?        matches ?
            \\        matches \

          A sequence seq may be a sequence of characters (e.g., [abc]
          or a range of characters (e.g., [a-c]).";
     }

     typedef wildcard {
       type string {
         pattern '\*';
       }
       description
         "A wildcard for calendar scheduling entries.";
     }

     typedef month {
       type enumeration {
         enum january {
           value 1;
           description
             "January of the Gregorian calendar.";
         }
         enum february {
           value 2;
           description
             "February of the Gregorian calendar.";
         }
         enum march {
           value 3;
           description
             "March of the Gregorian calendar.";
         }
         enum april {
           value 4;
           description
             "April of the Gregorian calendar.";



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 10]


Internet-Draft               LMAP Data Model                  March 2016


         }
         enum may {
           value 5;
           description
             "May of the Gregorian calendar.";
         }
         enum june {
           value 6;
           description
             "June of the Gregorian calendar.";
         }
         enum july {
           value 7;
           description
             "July of the Gregorian calendar.";
         }
         enum august {
           value 8;
           description
             "August of the Gregorian calendar.";
         }
         enum september {
           value 9;
           description
             "September of the Gregorian calendar.";
         }
         enum october {
           value 10;
           description
             "October of the Gregorian calendar.";
         }
         enum november {
           value 11;
           description
             "November of the Gregorian calendar.";
         }
         enum december {
           value 12;
           description
             "December of the Gregorian calendar.";
         }
       }
       description
         "A type modeling the month in the Gregorian calendar.";
     }

     typedef month-or-all {
       type union {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 11]


Internet-Draft               LMAP Data Model                  March 2016


         type month;
         type wildcard;
       }
       description
         "A month or a wildcard indicating all twelve months.";
     }

     typedef day-of-month {
       type uint8 { range "1..31"; }
       description
         "A day of a month of the Gregorian calendar.";
     }

     typedef day-of-months-or-all {
       type union {
         type day-of-month;
         type wildcard;
       }
       description
         "A day of a months or a wildcard indicating all days
          of a month.";
     }

     typedef weekday {
       type enumeration {
         enum monday {
           value 1;
           description
             "Monday of the Gregorian calendar.";
         }
         enum tuesday {
           value 2;
           description
             "Tuesday of the Gregorian calendar.";
         }
         enum wednesday {
           value 3;
           description
             "Wednesday of the Gregorian calendar.";
         }
         enum thursday {
           value 4;
           description
             "Thursday of the Gregorian calendar.";
         }
         enum friday {
           value 5;
           description



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 12]


Internet-Draft               LMAP Data Model                  March 2016


             "Friday of the Gregorian calendar.";
         }
         enum saturday {
           value 6;
           description
             "Saturday of the Gregorian calendar.";
         }
         enum sunday {
           value 7;
           description
             "Sunday of the Gregorian calendar.";
         }
       }
       description
        "A type modeling the weekdays in the Gregorian calendar.
         The numbering follows the ISO 8601 scheme.";
     }

     typedef weekday-or-all {
       type union {
         type weekday;
         type wildcard;
       }
       description
         "A weekday or a wildcard indicating all seven weekdays.";
     }

     typedef hour {
       type uint8 { range "0..23"; }
       description
         "An hour of a day.";
     }

     typedef hour-or-all {
       type union {
         type hour;
         type wildcard;
       }
       description
         "An hour of a day or a wildcard indicating all hours
          of a day.";
     }

     typedef minute {
       type uint8 { range "0..59"; }
       description
         "A minute of an hour.";
     }



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 13]


Internet-Draft               LMAP Data Model                  March 2016


     typedef minute-or-all {
       type union {
         type minute;
         type wildcard;
       }
       description
         "A minute of an hour or a wildcard indicating all
          minutes of an hour.";
     }

     typedef second {
       type uint8 { range "0..59"; }
       description
         "A second of a minute.";
     }

     typedef second-or-all {
       type union {
         type second;
         type wildcard;
       }
       description
         "A second of a minute or a wildcard indicating all
          seconds of a minute.";
     }

     typedef status-code {
       type int32;
       description
         "A status code returned by the execution of a task. Note
          that the actual range is implementation dependent but it
          should be portable to use values in the range 0..127 for
          regular exit codes. By convention, 0 indicates successful
          termination. Negative values may be used to indicate
          abnormal termination due to a signal; the absolute value
          may identify the signal number in this case.";
     }

     typedef timezone-offset {
       type string {
         pattern 'Z|[\+\-]\d{2}:\d{2}';
       }
       description
         "A timezone-offset as it is used by the date-and-time type
          defined in the ietf-yang-types module. The value Z is
          equivalent to +00:00. The value -00:00 indicates and
          unknown time-offset.";
       reference



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 14]


Internet-Draft               LMAP Data Model                  March 2016


         "RFC 6991: Common YANG Data Types";
     }

     /*
      * Groupings
      */

     grouping metrics-grouping {
       description
         "This grouping models a list of entries in a metrics
          registry.";

       list metric {
         key uri;
         description
           "A list of entries in a metrics registry.";

         leaf uri {
           type inet:uri;
           description
             "A URI identifying an entry in a metrics registry.";
         }

         leaf-list role {
           type string;
           description
             "A set of roles for this metrics.";
         }
       }
     }

     grouping task-options-grouping {
       description
         "A list of options of a task. Each option is a name/value
          pair (where the value may be absent).";

       list option {
         key "id";
         ordered-by user;
         description
           "A list of options passed to the task. It is a list of
            key / value pairs and may be used to model options.
            Options may be used to identify the role of a task
            or to pass a channel name to a task.";

         leaf id {
           type lmap:identifier;
           description



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 15]


Internet-Draft               LMAP Data Model                  March 2016


             "An identifier uniquely identifying an option. This
              identifier is required by YANG to uniquely identify
              a name value pair but it otherwise has no semantic
              value";
         }

         leaf name {
           type string;
           description
             "The name of the option.";
         }

         leaf value {
           type string;
           description
             "The value of the option.";
         }
       }
     }
   }
   <CODE ENDS>



   <CODE BEGINS> file "ietf-lmap-control@2016-03-15.yang"
   module ietf-lmap-control {

     namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-control";
     prefix "lmapc";

     import ietf-yang-types {
       prefix yang;
     }
     import ietf-inet-types {
       prefix inet;
     }
     import ietf-lmap-common {
       prefix lmap;
     }

     organization
       "IETF Large-Scale Measurement Platforms Working Group";

     contact
       "WG Web:   <http://tools.ietf.org/wg/lmap/>
        WG List:  <mailto:lmap@ietf.org>

        Editor:   Juergen Schoenwaelder



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 16]


Internet-Draft               LMAP Data Model                  March 2016


                  <j.schoenwaelder@jacobs-university.de>

        Editor:   Vaibhav Bajpai
                  <v.bajpai@jacobs-university.de>";

     description
       "This module defines a data model for controlling measurement
        agents that are part of a Large-Scale Measurement Platform
        (LMAP). This data model is expected to be implemented by a
        measurement agent.";

     revision "2016-03-15" {
       description
        "Initial version";
       reference
        "RFC XXX: A YANG Data Model for LMAP Measurement Agents";
     }

     /*
      * Typedefs
      */

     typedef event-ref {
       type leafref {
         path "/lmap/events/event/name";
       }
       description
         "This type is used by data models that need to reference
          a configured event source.";
     }

     typedef task-ref {
       type leafref {
         path "/lmap/tasks/task/name";
       }
       description
         "This type is used by data models that need to reference
          a configured task.";
     }

     typedef schedule-ref {
       type leafref {
         path "/lmap/schedules/schedule/name";
       }
       description
         "This type is used by data models that need to reference
          a configured schedule.";
     }



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 17]


Internet-Draft               LMAP Data Model                  March 2016


     /*
      * Groupings
      */

     grouping timing-start-end-grouping {
       description
         "A grouping that provides start and end times for
          timing objects.";
       leaf start {
         type yang:date-and-time;
         description
           "The date and time when the timing object
            starts to create triggers.";
       }
       leaf end {
         type yang:date-and-time;
         description
           "The date and time when the timing object
            stops to create triggers.

            It is generally a good idea to always configure
            an end time and to refresh the configuration
            of timing object as needed to ensure that agents
            that loose connectivity to their controller
            do not continue their tasks forever.";
       }
     }

     /*
      * Configuration data nodes
      */

     container lmap {
       description
         "Configuration of the LMAP agent.";

       /*
        * Agent Configuration
        */

       container agent {
         description
           "Configuration of parameters affecting the whole
            measurement agent.";

         leaf agent-id {
           type yang:uuid;
           description



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 18]


Internet-Draft               LMAP Data Model                  March 2016


             "The agent-id identifies a measurement agent with
              a very low probability of collision. In certain
              deployments, the agent-id may be considered
              sensitive and hence this object is optional.";
         }

         leaf device-id {
           type inet:uri;
           description
             "The device-id identifies a property of the
              device running the measurement agent. In certain
              deployments, the device-id may be considered
              sensitive and hence this object is optional.";
         }

         leaf group-id {
           type string;
           description
             "The group-id identifies a group of measurement
              agents. In certain deployments, the group-id
              may be considered less sensitive than the
              agent-id.";
         }

         leaf measurement-point {
           type string;
           description
             "The measurement point indicating where the
               measurement agent is located on a path.";
           reference
             "RFC 7398: A Reference Path and Measurement Points
                        for Large-Scale Measurement of Broadband
                        Performance";
         }

         leaf report-agent-id {
           type boolean;
           must '. != "true" or ../agent-id' {
             description
               "An agent-id must exist for this to be set
                to true.";
           }
           default false;
           description
             "The 'report-agent-id' controls whether the
              'agent-id' is reported to collectors if the
              'group-id' is configured. If the 'group-id'
              is not configured, the agent-id is always



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 19]


Internet-Draft               LMAP Data Model                  March 2016


              reported.";
         }

         leaf report-measurement-point {
           type boolean;
           must '. != "true" or ../measurement-point' {
             description
               "A measurement-point must exist for this to be
                set to true.";
           }
           default false;
           description
             "The 'report-measurement-point' controls whether
              the 'measurement-point' is reported to collectors
              if the 'measurement-point' is configured.";
         }

         leaf controller-timeout {
           type uint32;
           units "seconds";
           description
             "A timer is started after each successful contact
              with a controller. When the timer reaches the
              controller-timeout, an event is raised indicating
              that connectivity to the controller has been lost.";
         }
       }

       /*
        * Task Configuration
        */

       container tasks {
         description
           "Configuration of LMAP tasks.";

         list task {
           key name;
           description
             "The list of tasks configured on the LMAP agent.";

           leaf name {
             type lmap:identifier;
             description
               "The unique name of a task.";
           }

           uses lmap:metrics-grouping;



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 20]


Internet-Draft               LMAP Data Model                  March 2016


           leaf program {
             type string;
             description
               "The (local) program to invoke in order to execute
                the task.";
           }

           uses lmap:task-options-grouping {
             description
               "The list of task specific options.";
           }

           leaf suppress-by-default {
             type boolean;
             default true;
             description
               "Indicates whether the task will be suppressed by
                a default supression.";
           }

           leaf-list tag {
             type lmap:identifier;
             description
               "A tag contains additional information that is
                passed with the result record to the collector.
                A tag can be used, for example, to carry the
                Measurement Cycle ID.";
           }
         }
       }

       /*
        * Schedule Instructions
        */

       container schedules {
         description
           "Configuration of LMAP schedules. Schedules control
            which tasks are executed by the LMAP implementation.";

         list schedule {
           key name;
           description
             "Configuration of a particular schedule.";

           leaf name {
             type lmap:identifier;
             description



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 21]


Internet-Draft               LMAP Data Model                  March 2016


               "The locally-unique, administratively assigned name
                for this schedule.";
           }

           leaf start {
             type event-ref;
             mandatory true;
             description
               "The event source controlling the start of the
                scheduled actions.";
           }

           choice stop {
             description
               "This choice contains optional leafs that control the
                graceful forced termination of scheduled actions.
                When the end has been reached, the scheduled actions
                should be forced to terminate the measurements.
                This may involve being active some additional time in
                order to properly finish the action's activity (e.g.,
                waiting for any still outstanding messages).";

             leaf end {
               type event-ref;
               description
                 "The event source controlling the graceful
                  forced termination of the scheduled actions.";
             }

             leaf duration {
               type uint32;
               units "seconds";
               description
                 "The duration controlling the graceful forced
                  termination of the scheduled actions.";
             }
           }

           leaf execution-mode {
             type enumeration {
               enum sequential {
                 value 1;
                 description
                   "The actions of the schedule are executed
                    sequentially.";
               }
               enum parallel {
                 value 2;



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 22]


Internet-Draft               LMAP Data Model                  March 2016


                 description
                   "The actions of the schedule are executed
                    concurrently";
               }
               enum pipelined {
                 value 3;
                 description
                   "The actions of the schedule are executed in a
                    pipelined mode. Output created by an action is
                    passed as input to the subsequent action.";
               }
             }
             default pipelined;
             description
               "The execution mode of this schedule determins in
                which order the actions of the schedule are executed.";
           }

           leaf-list tag {
             type lmap:tag;
             description
               "A list of schedule specific tags that are
                reported together with the measurement results
                to a collector.";
           }

           leaf-list suppression-tag {
             type lmap:tag;
             description
               "A list of suppression tags that are used to select
                schedules to be suppressed.";
           }

           list action {
             key name;
             description
               "An action describes a task that is invoked by the
                schedule. Multiple actions are invoked sequentially.";

             leaf name {
               type lmap:identifier;
               description
                 "The unique identifier for this action.";
             }

             leaf task {
               type task-ref;
               mandatory true;



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 23]


Internet-Draft               LMAP Data Model                  March 2016


               description
                 "The task invoked by this action.";
             }

             container parameters {
               description
                 "This container is a place-holder for run-time
                  parameters defined in task-specific or
                  metric-specific data models augmenting the
                  base lmap control data model.";

               choice extension {
                 description
                   "This choice is provided to augment in different
                    sets of parameters.";
               }
             }

             uses lmap:task-options-grouping {
               description
                 "The list of action specific options that are
                  appended to the list of task specific options.";
             }

             leaf-list destination {
               type schedule-ref;
               description
                 "A schedule of receiving the output produced by
                  this action. A queue is internally used to pass
                  results to another schedule. The behaviour of
                  an action passing data to its own schedule is
                  implementation specific.

                  Data passed to a sequential or pipelined schedule
                  is consumed by the schedule's first action. Data
                  passed to a parallel schedule is consumed by all
                  actions of the schedule.";
             }

             leaf-list tag {
               type lmap:tag;
               description
                 "A list of action specific tags that are
                  reported together with the measurement results
                  to a collector.";
             }

             leaf-list suppression-tag {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 24]


Internet-Draft               LMAP Data Model                  March 2016


               type lmap:tag;
               description
                 "A list of suppression tags that are used to select
                  actions to be suppressed.";
             }
           }
         }
       }

       /*
        * Suppression Instructions
        */

       container suppressions {
         description
           "Suppression information to prevent schedules or
            certain actions from starting.";

         list suppression {
           key name;
           description
             "Configuration of a particular suppression.";

           leaf name {
             type lmap:identifier;
             description
               "The locally-unique, administratively assigned name
                for this suppression.";
           }

           leaf start {
             type event-ref;
             description
               "The event source controlling the start of the
                suppression period.";
           }

           leaf end {
             type event-ref;
             description
               "The event source controlling the end of the
                suppression period. If not present, supression
                continues indefinitely.";
           }

           leaf-list match {
             type lmap:glob-pattern;
             description



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 25]


Internet-Draft               LMAP Data Model                  March 2016


               "A list of suppression tags. The suppression will
                apply to all schedules (and their actions) that
                have a matching value in their suppression-tags
                and to all actions that have a matching value in
                their suppression-tags.";
           }

           leaf stop-running {
             type boolean;
             default false;
             description
               "Setting 'stop-running' to true will cause running
                tasks to be terminated if suppression is activated.
                Otherwise, running tasks will not be affected if
                suppression is activated.";
           }
         }
       }

       /*
        * Event Instructions
        */

       container events {
         description
           "Configuration of LMAP events.

            Implementations may be forced to delay acting
            upon the occurance of events in the face of local
            constraints. An action triggered by an event
            therefore should not rely on the accuracy
            provided by the scheduler implementation.";

         list event {
           key name;
           description
             "The list of event sources configured on the
              LMAP agent.";

           leaf name {
             type lmap:identifier;
             description
               "The unique name of an event source.";
           }

           choice event-type {
             description
               "Different types of events are handled by



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 26]


Internet-Draft               LMAP Data Model                  March 2016


                different branches of this choice. Note that
                this choice can be extended via augmentations.";

             case periodic {
               container periodic {
                 description
                   "A periodic timing object triggers periodically
                    according to a regular interval.";

                 leaf interval {
                   type uint32 {
                     range "1..max";
                   }
                   units "seconds";
                   mandatory true;
                   description
                     "The number of seconds between two triggers
                      generated by this periodic timing object.";
                 }
                 uses timing-start-end-grouping;
               }
             }

             case calendar {
               container calendar {
                 description
                   "A calendar timing object triggers based on the
                    current calendar date and time.";

                 leaf-list month {
                   type lmap:month-or-all;
                   min-elements 1;
                   description
                     "A month at which this calendar timing will
                      trigger. The wildcard means all months.";
                 }

                 leaf-list day-of-month {
                   type lmap:day-of-months-or-all;
                   min-elements 1;
                   description
                     "A day of the month at which this calendar
                      timing will trigger. The wildcard means all
                      days of a month.";
                 }

                 leaf-list day-of-week {
                   type lmap:weekday-or-all;



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 27]


Internet-Draft               LMAP Data Model                  March 2016


                   min-elements 1;
                   description
                     "A weekday at which this calendar timing will
                      trigger. The wildcard means all weekdays.";
                 }

                 leaf-list hour {
                   type lmap:hour-or-all;
                   min-elements 1;
                   description
                     "An hour at which this calendar timing will
                      trigger. The wildcard means all hours of a
                      day.";
                 }

                 leaf-list minute {
                   type lmap:minute-or-all;
                   min-elements 1;
                   description
                     "A minute at which this calendar timing will
                      trigger. The wildcard means all minutes of
                      an hour.";
                 }

                 leaf-list second {
                   type lmap:second-or-all;
                   min-elements 1;
                   description
                     "A second at which this calendar timing will
                      trigger. The wildcard means all seconds of
                      a minute.";
                 }

                 leaf timezone-offset {
                   type lmap:timezone-offset;
                   description
                     "The timezone in which this calendar timing
                      object will be evaluated. If not present,
                      the systems' local timezone will be used.";
                 }
                 uses timing-start-end-grouping;
               }
             }

             case one-off {
               container one-off {
                 description
                   "A one-off timing object triggers exactly once.";



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 28]


Internet-Draft               LMAP Data Model                  March 2016


                 leaf time {
                   type yang:date-and-time;
                   mandatory true;
                   description
                     "This one-off timing object triggers once at
                      the configured date and time.";
                 }
               }
             }

             case immediate {
               leaf immediate {
                 type empty;
                 mandatory true;
                 description
                   "This immediate event object triggers immediately
                    when it is configured.";
               }
             }

             case startup {
               leaf startup {
                 type empty;
                 mandatory true;
                 description
                   "This startup event object triggers whenever the
                    LMAP agent (re)starts.";
               }
             }

             case controller-lost {
               leaf controller-lost {
                 type empty;
                 mandatory true;
                 description
                   "The controller-lost event object triggers when
                    the connectivity to the controller has been lost
                    for at least 'controller-timeout' seconds.";
               }
             }

             case controller-connected {
               leaf controller-connected {
                 type empty;
                 mandatory true;
                 description
                   "The controller-connected event object triggers
                    when the connectivity to the controller has been



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 29]


Internet-Draft               LMAP Data Model                  March 2016


                    restored after it was lost for at least
                    'controller-timeout' seconds.";
               }
             }
           }

           leaf random-spread {
             type uint32;
             units seconds;
             description
               "This optional leaf adds a random spread to the
                computation of the event's trigger time. The
                random spread is a uniformly distributed random
                number taken from the interval [0:random-spread].";
           }
         }
       }
     }

     /*
      * The state subtree provides information about the capabilities
      * and the current status of the MA.
      */

     container lmap-state {
       config false;
       description
         "A tree exporting state information about the LMAP agent.";

       container agent {
         description
           "Operations state of the measurement agent.";

         leaf agent-id {
           type yang:uuid;
           mandatory true;
           description
             "The agent-id identifies a measurement agent with
              a very low probability of collision. In certain
              deployments, the agent-id may be considered
              sensitive and hence this object is optional.";
         }

         leaf device-id {
           type inet:uri;
           mandatory true;
           description
             "The device-id identifies a property of the



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 30]


Internet-Draft               LMAP Data Model                  March 2016


              device running the measurement agent. In certain
              deployments, the device-id may be considered
              sensitive and hence this object is optional.";
         }
         leaf hardware {
           type string;
           mandatory true;
           description
             "A short description of the hardware the measurement
              agent is running on. This should include the version
              number of the hardware";
         }
         leaf firmware {
           type string;
           mandatory true;
           description
             "A short description of the firmware the measurement
              agent is running on. This should include the version
              number of the firmware.";
         }
         leaf version {
           type string;
           mandatory true;
           description
             "A short description of the software implementing the
              measurement agent. This should include the version
              number of the measurement agent software.";
         }
         leaf last-started {
           type yang:date-and-time;
           mandatory true;
           description
             "The date and time the measurement agent last started.";
         }
       }

       container tasks {
         description
           "Available LMAP tasks, including information about their
            last execution and their last failed execution.";

         list task {
           key name;
           description
             "The list of tasks available on the LMAP agent.";

           leaf name {
             type lmap:identifier;



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 31]


Internet-Draft               LMAP Data Model                  March 2016


             description
               "The unique name of a task.";
           }

           uses lmap:metrics-grouping;

           leaf version {
             type string;
             description
               "A short description of the software implementing
                the task. This should include the version
                number of the measurement task software.";
           }

           leaf program {
             type string;
             description
               "The (local) program to invoke in order to execute
                the task.";
           }
         }
       }

       container schedules {
         description
           "State of LMAP schedules.";

         list schedule {
           key name;
           description
             "State of a particular schedule.";

           leaf name {
             type lmap:identifier;
             description
               "The locally-unique, administratively assigned name
                for this schedule.";
           }

           leaf state {
             type enumeration {
               enum enabled {
                 value 1;
                 description
                   "The value 'enabled' indicates that the
                    schedule is currently enabled.";
               }
               enum disabled {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 32]


Internet-Draft               LMAP Data Model                  March 2016


                 value 2;
                 description
                   "The value 'disabled' indicates that the
                    schedule is currently disabled.";
               }
               enum running {
                 value 3;
                 description
                   "The value 'running' indicates that the
                    schedule is currently running.";
               }
               enum suppressed {
                 value 4;
                 description
                   "The value 'suppressed' indicates that the
                    schedule is currently suppressed.";
               }
             }
             description
               "The current state of the schedule.";
           }

           leaf invocations {
             type yang:counter32;
             description
               "Number of invocations of this schedule. This counter
                does not include suppressed invocations or invocations
                that were prevented due to an overlap with a previous
                invocation of this schedule.";
           }

           leaf suppressions {
             type yang:counter32;
             description
               "Number of suppressed executions of this schedule.";
           }

           leaf overlaps {
             type yang:counter32;
             description
               "Number of executions prevented due to overlaps with
                a previous invocation of this schedule.";
           }

           leaf failures {
             type yang:counter32;
             description
               "Number of failed executions of this schedule. A



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 33]


Internet-Draft               LMAP Data Model                  March 2016


                failed execution is an execution where at least
                one action failed.";
           }

           leaf last-invocation {
             type yang:date-and-time;
             description
               "The date and time of the last invocation of
                this schedule.";
           }

           list action {
             key name;
             description
               "The state of the actions associated with this
                schedule entry.";

             leaf name {
               type lmap:identifier;
               description
                 "The unique identifier for this action.";
             }

             leaf state {
               type enumeration {
                 enum enabled {
                   value 1;
                   description
                     "The value 'enabled' indicates that the
                      action is currently enabled.";
                 }
                 enum disabled {
                   value 2;
                   description
                     "The value 'disabled' indicates that the
                      action is currently disabled.";
                 }
                 enum running {
                   value 3;
                   description
                     "The value 'running' indicates that the
                      action is currently runnning.";
                 }
                 enum suppressed {
                   value 4;
                   description
                     "The value 'suppressed' indicates that the
                      action is currently suppressed.";



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 34]


Internet-Draft               LMAP Data Model                  March 2016


                 }
               }
               description
                 "The current state of the action.";
             }

             leaf invocations {
               type yang:counter32;
               description
                 "Number of invocations of this action. This counter
                  does not include suppressed invocations or invocations
                  that were prevented due to an overlap with a previous
                  invocation of this action.";
             }

             leaf suppressions {
               type yang:counter32;
               description
                 "Number of suppressed executions of this action.";
             }

             leaf overlaps {
               type yang:counter32;
               description
                 "Number of executions prevented due to overlaps with
                  a previous invocation of this action.";
             }

             leaf failures {
               type yang:counter32;
               description
                 "Number of failed executions of this action.";
             }

             leaf last-invocation {
               type yang:date-and-time;
               description
                 "The date and time of the last invocation of
                  this action.";
             }

             leaf last-completion {
               type yang:date-and-time;
               description
                 "The date and time of the last completion of
                  this action.";
             }




Schoenwaelder & Bajpai Expires September 16, 2016              [Page 35]


Internet-Draft               LMAP Data Model                  March 2016


             leaf last-status {
               type lmap:status-code;
               description
                 "The status code returned by the last execution of
                  this action.";
             }

             leaf last-message {
               type string;
               description
                 "The status message produced by the last execution
                  of this action.";
             }

             leaf last-failed-completion {
               type yang:date-and-time;
               description
                 "The date and time of the last failed completion
                  of this action.";
             }

             leaf last-failed-status {
               type lmap:status-code;
               description
                 "The status code returned by the last failed
                  execution of this action.";
             }

             leaf last-failed-message {
               type string;
               description
                 "The status message produced by the last failed
                  execution of this action.";
             }
           }
         }
       }

       container suppressions {
         description
           "State of LMAP suppressions.";

         list suppression {
           key name;
           description
             "State of a particular suppression.";

           leaf name {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 36]


Internet-Draft               LMAP Data Model                  March 2016


             type lmap:identifier;
             description
               "The locally-unique, administratively assigned name
                for this suppression.";
           }

           leaf state {
             type enumeration {
               enum enabled {
                 value 1;
                 description
                   "The value 'enabled' indicates that the
                    suppression is currently enabled.";
               }
               enum disabled {
                 value 2;
                 description
                   "The value 'disabled' indicates that the
                    suppression is currently disabled.";
               }
               enum active {
                 value 3;
                 description
                   "The value 'active' indicates that the
                    suppression is currently active.";
               }
             }
             description
               "The current state of the suppression.";
           }
         }
       }
     }
   }
   <CODE ENDS>



   <CODE BEGINS> file "ietf-lmap-report@2016-03-15.yang"
   module ietf-lmap-report {

     namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-report";
     prefix "lmapr";

     import ietf-yang-types {
       prefix yang;
     }
     import ietf-lmap-common {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 37]


Internet-Draft               LMAP Data Model                  March 2016


       prefix lmap;
     }

     organization
       "IETF Large-Scale Measurement Platforms Working Group";

     contact
       "WG Web:   <http://tools.ietf.org/wg/lmap/>
        WG List:  <mailto:lmap@ietf.org>

        Editor:   Juergen Schoenwaelder
                  <j.schoenwaelder@jacobs-university.de>

        Editor:   Vaibhav Bajpai
                  <v.bajpai@jacobs-university.de>";

     description
       "This module defines a data model for reporting results from
        measurement agents, which are part of a Large-Scale Measurement
        Platform (LMAP), to result data collectors. This data model is
        expected to be implemented by a collector.";

     revision "2016-03-15" {
       description
        "Initial version";
       reference
        "RFC XXX: A YANG Data Model for LMAP Measurement Agents";
     }

     rpc report {
       description
         "The report operation is used by an LMAP measurement agent to
          submit measurement results produced by measurement tasks to
          a collector.";

       input {

         leaf date {
           type yang:date-and-time;
           mandatory true;
           description
             "The date and time when this result report was sent to
              a collector.";
         }

         leaf agent-id {
           type yang:uuid;
           description



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 38]


Internet-Draft               LMAP Data Model                  March 2016


             "The agent-id of the agent from which this
              report originates.";
         }

         leaf group-id {
           type string;
           description
             "The group-id of the agent from which this
              report originates.";
         }

         leaf measurement-point {
           type string;
           description
             "The measurement-point of the agent from which this
              report originates.";
         }

         list task {
           key name;
           description
             "The list of tasks for which results are reported.";

           leaf name {
             type lmap:identifier;
             description
               "The unique name of the task.";
           }

           uses lmap:metrics-grouping;

           uses lmap:task-options-grouping {
             description
               "The list of task options there were in use then the
                measurement was performed. This list must include
                both the task specific options as well as the action
                specific options.";
           }

           leaf-list tag {
             type lmap:tag;
             description
               "A tag contains additional information that is passed
                with the result record to the collector. A tag can be
                used to carry the Measurement Cycle ID.";
           }

           container header {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 39]


Internet-Draft               LMAP Data Model                  March 2016


             description
               "This container lists the column labels. It does not
                really serve a purpose other than making the result
                data look nicely structured.";

             leaf-list column {
               type string;
               description
                 "An ordered list of column labels. The order is
                  determined by the system and must match the order
                  of the columns in the result rows.";
             }
           }

           list row {
             description
               "The rows of the result record.";

             leaf start {
               type yang:date-and-time;
               mandatory true;
               description
                 "The date and time when the measurement producing
                 this result row started.";
             }

             leaf end {
               type yang:date-and-time;
               description
                 "The date and time when the measurement producing
                  this result row stopped.";
             }

             leaf-list conflict {
               type string;
               description
                 "The name of a task overlapping with the execution
                  of the task that has produced this result record.";
             }

             leaf-list value {
               type string;
               description
                 "The value of a cell in the result row.";
             }
           }
         }
       }



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 40]


Internet-Draft               LMAP Data Model                  March 2016


     }
   }
   <CODE ENDS>


5.  Security Considerations

   The YANG module defined in this memo is designed to be accessed via
   the NETCONF protocol [RFC6241].  The lowest NETCONF layer is the
   secure transport layer and the mandatory to implement secure
   transport is SSH [RFC6242].  The NETCONF access control model
   [RFC6536] provides the means to restrict access for particular
   NETCONF users to a pre-configured subset of all available NETCONF
   protocol operations and content.

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

   /lmap/agent           This subtree configures general properties of
                         the measurement agent such as its identity, its
                         measurement point or controller timeout.  This
                         subtree should only have write access for the
                         system responsible to configure the measurement
                         agent.

   /lmap/tasks           This subtree configures the tasks that can be
                         invoked by a controller.  This subtree should
                         only have write access for the system
                         responsible to configure the measurement agent.
                         Care must be taken to not expose tasks to a
                         controller that can cause damage to the system
                         or the network.

   /lmap/schedules       This subtree is used by a controller to define
                         the schedules and actions that are executed
                         when certain events occur.  Unauthorized access
                         can cause unwanted load on the device or
                         network or it might direct measurement traffic
                         to targets that become victims of an attack.

   /lmap/suppressions    This subtree is used by a controller to define
                         suppressions that can temporarily disable the
                         execution of schedules or actions.



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 41]


Internet-Draft               LMAP Data Model                  March 2016


                         Unauthorized access can either disable
                         measurements that should normally take place or
                         it can cause measurements to take place during
                         times when normally no measurements should take
                         place.

   /lmap/events          This subtree is used by a controller to define
                         events that trigger the execution of schedules
                         and actions.  Unauthorized access can either
                         disable measurements that should normally take
                         place or it can cause measurements to take
                         place during times when normally no
                         measurements should take place or at frequency
                         that is higher than normally expected.

   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:

   /lmap-state/agent         This subtree provides information about the
                             implementation (including version numbers).
                             This information may be used to mount
                             targeted attacks against the
                             implementation.

   /lmap-state/tasks         This subtree provides information about the
                             tasks (including version numbers).  This
                             information may be used to mount targeted
                             attacks against the implementation.

   /lmap-state/schedules     This subtree provides information about the
                             schedules executed on the system.  This
                             information may be used to check whether
                             attacks against the implementation are
                             effective.

   /lmap-state/suppressions  This subtree provides information about the
                             suppressions executed on the system.  This
                             information may be used to predict time
                             periods where measurements take place (or
                             do not take place).

   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:



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 42]


Internet-Draft               LMAP Data Model                  March 2016


   /report   The report operation is used to send locally collected
             measurement results to a remote collector.  Unauthorized
             access may leak measurement results.

   The data model uses a number of identifiers that are set by the
   controller.  Implementors may find these identifiers useful for the
   identification of resources, e.g., to identify objects in a
   filesystem providing temporary storage.  Since the identifiers used
   by the YANG data model may allow characters that may be given special
   interpretation in a specific context, implementations MUST ensure
   that identifiers are properly mapped into safe identifiers.

   The data model allows to specify options in the form of name value
   pairs that are passed to programs.  Implementers MUST taken care that
   option names and values are passed literally to programs.  In
   particular, it MUST be avoided that any shell expansions are
   performed that may alter the option names and values.

6.  IANA Considerations

   This document registers a URI in the "IETF XML Registry" [RFC3688].
   Following the format in RFC 3688, the following registrations have
   been made.


         URI: urn:ietf:params:xml:ns:yang:ietf-lmap-common
         Registrant Contact: The IESG.
         XML: N/A; the requested URI is an XML namespace.

         URI: urn:ietf:params:xml:ns:yang:ietf-lmap-control
         Registrant Contact: The IESG.
         XML: N/A; the requested URI is an XML namespace.

         URI: urn:ietf:params:xml:ns:yang:ietf-lmap-report
         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].











Schoenwaelder & Bajpai Expires September 16, 2016              [Page 43]


Internet-Draft               LMAP Data Model                  March 2016


         name: ietf-lmap-common
         namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-common
         prefix: lmap
         reference: RFC XXXX

         name: ietf-lmap-control
         namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-control
         prefix: lmapc
         reference: RFC XXXX

         name: ietf-lmap-report
         namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-report
         prefix: lmapr
         reference: RFC XXXX


7.  Acknowledgements

   Juergen Schoenwaelder and Vaibhav Bajpai worked in part on the Leone
   research project, which received funding from the European Union
   Seventh Framework Programme [FP7/2007-2013] under grant agreement
   number 317647.

   Juergen Schoenwaelder and Vaibhav Bajpai were partly funded by
   Flamingo, a Network of Excellence project (ICT-318488) supported by
   the European Commission under its Seventh Framework Programme.

8.  References

8.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
              RFC2119, March 1997,
              <http://www.rfc-editor.org/info/rfc2119>.

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

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







Schoenwaelder & Bajpai Expires September 16, 2016              [Page 44]


Internet-Draft               LMAP Data Model                  March 2016


8.2.  Informative References

   [I-D.ietf-lmap-information-model]
              Burbridge, T., Eardley, P., Bagnulo, M., and J.
              Schoenwaelder, "Information Model for Large-Scale
              Measurement Platforms (LMAP)", draft-ietf-lmap-
              information-model-06 (work in progress), July 2015.

   [I-D.ietf-netconf-server-model]
              Watsen, K. and J. Schoenwaelder, "NETCONF Server and
              RESTCONF Server Configuration Models", draft-ietf-netconf-
              server-model-08 (work in progress), October 2015.

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

   [RFC5424]  Gerhards, R., "The Syslog Protocol", RFC 5424, DOI 10
              .17487/RFC5424, March 2009,
              <http://www.rfc-editor.org/info/rfc5424>.

   [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,
              <http://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,
              <http://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,
              <http://www.rfc-editor.org/info/rfc6536>.

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

   [RFC7398]  Bagnulo, M., Burbridge, T., Crawford, S., Eardley, P., and
              A. Morton, "A Reference Path and Measurement Points for
              Large-Scale Measurement of Broadband Performance", RFC
              7398, DOI 10.17487/RFC7398, February 2015,
              <http://www.rfc-editor.org/info/rfc7398>.







Schoenwaelder & Bajpai Expires September 16, 2016              [Page 45]


Internet-Draft               LMAP Data Model                  March 2016


   [RFC7594]  Eardley, P., Morton, A., Bagnulo, M., Burbridge, T.,
              Aitken, P., and A. Akhter, "A Framework for Large-Scale
              Measurement of Broadband Performance (LMAP)", RFC 7594,
              DOI 10.17487/RFC7594, September 2015,
              <http://www.rfc-editor.org/info/rfc7594>.

Appendix A.  Open Issues

A.1.  Purpose of /lmap-state/tasks

   Proposal: Tasks are configured in /lmap/tasks and even marked as nacm
   :default-deny-write (see RFC 6536) since configuring programs that
   can be invoked by a controller is an operation that may impact the
   security of the device.  See also the related open issue on the
   information model.  If we do this, then /lmap-state/tasks should
   probably only report the version number.

A.2.  Streamline the reporting model

   The reporting model may need more attention; perhaps things can be
   streamlined and also be made more efficient.  Implementation
   experience will help to work this out.

Appendix B.  Non-editorial Changes since -02

   o  Added a mechanism to enforce a runtime limit for schedules.

   o  Added security considerations text warning about possible shell
      expansions of options.

   o  Restricted all user-defined names and tags to lmap:identifier.
      Added security considerations text to make implementors aware of
      possible security issues if identifiers are naively mapped to say
      filesystem paths.

   o  Schedules and actions now have tags (echoed to the collector) and
      suppression tags (used for suppression selection).

   o  Introduced glob-style pattern to match tags.

   o  Added an example module for IPPM udp latency metrics to
      demonstrate the usage of the extension mechanism.

   o  Introduced parameters, an extension point for task/metric specific
      parameters defined in augmenting YANG modules.

   o  Introduced the typedefs event-ref, task-ref, and schedule-ref.




Schoenwaelder & Bajpai Expires September 16, 2016              [Page 46]


Internet-Draft               LMAP Data Model                  March 2016


   o  Changed schedule/event to schedule/start and added the optional
      schedule/stop and schedule/duration leafs.

Appendix C.  Non-editorial Changes since -01

   o  Updated and split examples (config vs state vs report).

   o  Refactored the definitions so that common definitions used by both
      the control and report data models are in the new module ietf-
      lmap-common.

   o  A report is submitted via an RPC operation instead of using a
      notification.

   o  The default execution mode is pipelined.

   o  Clarified which action consumes data in sequential, pipelines, and
      parallel execution mode.

   o  Added /lmap/agent/measurement-point, /lmap/agent/report-
      measurement-point, and /report/measurement-point to configure and
      report the measurement point.

   o  Turned /lmap/suppression into a list /lmap/suppressions/
      suppression that uses a start and stop event to define the
      beginning and end of a suppression period.

   o  Added controller-lost an controller-ok event choices to /lmap/
      events/event.

   o  Added a metrics-grouping to identify entries in a metric registry
      and associated roles.

   o  Added /lmap-state/schedules to report the status of schedules and
      their actions.  Refactored /lmap-state/tasks to only report the
      task capabilities.

Appendix D.  Non-editorial Changes since -00

   o  A task can now reference multiply registry entries.

   o  Schedules are triggered by Events instead of Timings; Timings are
      just one of many possible event sources.

   o  Actions feed into other Schedules (instead of Actions within other
      Schedules).

   o  Removed the notion of multiple task outputs.



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 47]


Internet-Draft               LMAP Data Model                  March 2016


   o  Support for sequential, parallel, and pipelined execution of
      Actions.

Appendix E.  Example IPPM Module for UDP Latency Metrics


module example-ietf-ippm-udp-latency {

  namespace "urn:example:ietf-ippm-udp-latency";
  prefix "ippm-udp-latency";

  import ietf-inet-types {
    prefix inet;
  }

  import ietf-lmap-control {
    prefix "lmap";
  }

  augment "/lmap:lmap/lmap:schedules/lmap:schedule/lmap:action"
        + "/lmap:parameters/lmap:extension" {
    description
      "This augmentation adds parameters specific to IPPM UDP
       latency metrics.";

    case "ietf-ippm-udp-latency" {
      leaf src-ip {
        type inet:ip-address;
        description
          "The source IP address of the UDP measurement traffic.";
      }

      leaf src-port {
        type inet:port-number;
        description
          "The source port number of the UDP measurement traffic.";
      }

      leaf dst-ip {
        type inet:ip-address;
        description
          "The destination IP address of the UDP measurement traffic.";
      }

      leaf dst-port {
        type inet:port-number;
        description
          "The destination port number of the UDP measurement traffic.";



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 48]


Internet-Draft               LMAP Data Model                  March 2016


      }

      leaf poisson-lambda {
        type decimal64 {
          fraction-digits 4;
        }
        units "seconds";
        default 1.0000;
        description
          "The average interval for the poisson stream with a resolution
           of 0.0001 seconds (0.1 ms).";
      }

      leaf poisson-limit {
        type decimal64 {
          fraction-digits 4;
        }
        units "seconds";
        default 30.0000;
        description
          "The upper limit on the poisson distribution with a resolution
           of 0.0001 seconds (0.1 ms).";
      }
    }
  }
}


Appendix F.  Example Configuration (XML)


<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <lmap xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-control">

    <agent>
      <agent-id>550e8400-e29b-41d4-a716-446655440000</agent-id>
      <device-id>urn:dev:mac:0024befffe804ff1</device-id>
      <group-id>network measurement at the north-pole</group-id>
      <report-agent-id>true</report-agent-id>
    </agent>

    <tasks>
      <!-- configuration of an iperf server task -->
      <task>
        <name>iperf-server</name>
        <program>/usr/bin/iperf</program>
        <option>
          <id>server</id>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 49]


Internet-Draft               LMAP Data Model                  March 2016


          <name>-s</name>
        </option>
        <tag>passive</tag>
        <tag>iperf</tag>
      </task>

      <!-- configuration of an iperf client task -->
      <task>
        <name>iperf-client</name>
        <program>/usr/bin/iperf</program>
        <option>
          <id>client</id>
          <name>-c</name>
        </option>
        <tag>active</tag>
        <tag>iperf</tag>
      </task>

      <!-- configuration of a reporter task -->
      <task>
        <name>lmap-reporting-task</name>
        <program>/usr/bin/lmap-reporter</program>
        <option>
          <id>collector-uri</id>
          <value>https://example.com/restconf/operations/ietf-lmap-report:report</value>
        </option>
      </task>

      <task>
        <name>fcc-measurement-suite</name>
        <program>/usr/bin/fcc-suite</program>
      </task>

      <task>
        <name>ippm-udp-latency-client</name>
        <program>/usr/bin/ippm-udp-latency</program>
        <metric>
          <uri>urn:example:what?</uri>
          <role>client</role>
        </metric>
        <tag>active</tag>
      </task>
    </tasks>

    <schedules>
      <!-- execute the fcc measurement suite during (Sep 2016) -->
      <schedule>
        <name>fcc-campain-2016</name>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 50]


Internet-Draft               LMAP Data Model                  March 2016


        <start>fcc-hourly-sep-2016</start>
        <duration>600</duration>
        <execution-mode>pipelined</execution-mode>
        <action>
          <name>fcc-measurement</name>
          <task>fcc-measurement-suite</task>
        </action>
        <action>
          <name>fcc-report</name>
          <task>lmap-reporting-task</task>
          <option>
            <id>collector-uri</id>
            <value>https://fcc.example.com/restconf/operations/ietf-lmap-report:report</value>
          </option>
        </action>
      </schedule>

      <!-- run two iperf measurements sequentially against mlab1 and
           mlab2 and feed the results into our result reporting tasks -->
      <schedule>
        <name>iperf-hourly</name>
        <start>hourly</start>
        <execution-mode>sequential</execution-mode>
        <action>
          <name>iperf-hourly-mlab1</name>
          <task>iperf-client</task>
          <option>
            <id>mlab1</id>
            <value>mlab1.example.com</value>
          </option>
        </action>
        <action>
          <name>iperf-hourly-mlab2</name>
          <task>iperf-client</task>
          <option>
            <id>mlab2</id>
            <value>mlab2.example.com</value>
          </option>
          <destination>report-collector</destination>
          <destination>report-shadow-collector</destination>
        </action>
      </schedule>

      <!-- start an iperf server on startup -->
      <schedule>
        <name>startup</name>
        <start>startup</start>
        <action>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 51]


Internet-Draft               LMAP Data Model                  March 2016


          <name>iperf-server</name>
          <task>iperf-server</task>
        </action>
      </schedule>

      <!-- report results every six hours to our main collector -->
      <schedule>
        <name>report-collector</name>
        <start>once-every-six-hours</start>
        <action>
          <name>report-action</name>
          <task>lmap-reporting-task</task>
          <option>
            <id>collector-uri</id>
            <value>https://collector.example.com/restconf/operations/ietf-lmap-report:report</value>
          </option>
        </action>
      </schedule>

      <!-- report results once per day to our shadow collector -->
      <schedule>
        <name>report-shadow-collector</name>
        <start>daily</start>
        <action>
          <name>report-action</name>
          <task>lmap-reporting-task</task>
          <option>
            <id>collector-uri</id>
            <value>https://shadow.example.com/restconf/operations/ietf-lmap-report:report</value>
          </option>
        </action>
      </schedule>

      <!-- IPPM udp latency measurement -->
      <schedule>
        <name>ippm-udp-latency</name>
        <start>hourly</start>
        <execution-mode>sequential</execution-mode>
        <action>
          <name>ippm-udp-latency</name>
          <task>ippm-udp-latency-client</task>
          <parameters xmlns:udp="urn:example:ietf-ippm-udp-latency">
            <udp:src-ip>192.0.2.1</udp:src-ip>
            <udp:src-port>54321</udp:src-port>
            <udp:dst-ip>192.0.2.2</udp:dst-ip>
            <udp:dst-port>12345</udp:dst-port>
            <udp:poisson-lambda>42</udp:poisson-lambda>
          </parameters>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 52]


Internet-Draft               LMAP Data Model                  March 2016


        </action>
        <action>
          <name>ippm-udp-latency-report</name>
          <task>lmap-reporting-task</task>
          <option>
            <id>collector-uri</id>
            <value>https://ippm.example.com/restconf/operations/ietf-lmap-report:report</value>
          </option>
        </action>
      </schedule>
    </schedules>

    <suppressions>
      <!-- stop all measurements if we got orphaned -->
      <suppression>
        <name>orphaned</name>
        <start>controller-lost</start>
        <end>controller-connected</end>
        <match>*</match>
      </suppression>

      <!-- stop all active measurements during new year's evening -->
      <suppression>
        <name>new-year-evening</name>
        <start>dec-31-11:00</start>
        <end>jan-01-15:00</end>
        <match>active</match>
      </suppression>
    </suppressions>

    <events>
      <event>
        <name>fcc-hourly-sep-2016</name>
        <periodic>
          <interval>3600000</interval>
          <start>2016-09-01T00:00:00+00:00</start>
          <end>2016-10-01T00:00:00+00:00</end>
        </periodic>
        <random-spread>300000</random-spread>   <!-- ms -->
      </event>

      <event>
        <name>monthly</name>
        <calendar>
          <month>*</month>
          <day-of-week>*</day-of-week>
          <day-of-month>1</day-of-month>
          <hour>0</hour>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 53]


Internet-Draft               LMAP Data Model                  March 2016


          <minute>0</minute>
          <second>0</second>
          <timezone-offset>+00:00</timezone-offset>
        </calendar>
      </event>

      <event>
        <name>weekly</name>
        <calendar>
          <month>*</month>
          <day-of-week>monday</day-of-week>
          <day-of-month>*</day-of-month>
          <hour>0</hour>
          <minute>0</minute>
          <second>0</second>
          <timezone-offset>+00:00</timezone-offset>
        </calendar>
      </event>

      <event>
        <name>daily</name>
        <calendar>
          <month>*</month>
          <day-of-week>*</day-of-week>
          <day-of-month>*</day-of-month>
          <hour>0</hour>
          <minute>0</minute>
          <second>0</second>
          <timezone-offset>+00:00</timezone-offset>
        </calendar>
      </event>

      <event>
        <name>hourly</name>
        <calendar>
          <month>*</month>
          <day-of-month>*</day-of-month>
          <day-of-week>*</day-of-week>
          <hour>*</hour>
          <minute>0</minute>
          <second>0</second>
          <timezone-offset>+00:00</timezone-offset>
        </calendar>
      </event>

      <event>
        <name>once-every-six-hours</name>
        <calendar>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 54]


Internet-Draft               LMAP Data Model                  March 2016


          <month>*</month>
          <day-of-month>*</day-of-month>
          <day-of-week>*</day-of-week>
          <hour>0</hour>
          <hour>6</hour>
          <hour>12</hour>
          <hour>18</hour>
          <minute>0</minute>
          <second>0</second>
        </calendar>
        <random-spread>3600000</random-spread>
      </event>

      <event>
        <name>dec-31-11:00</name>
        <calendar>
          <month>december</month>
          <day-of-month>31</day-of-month>
          <day-of-week>*</day-of-week>
          <hour>11</hour>
          <minute>00</minute>
          <second>00</second>
        </calendar>
      </event>

      <event>
        <name>jan-01-15:00</name>
        <calendar>
          <month>january</month>
          <day-of-month>1</day-of-month>
          <day-of-week>*</day-of-week>
          <hour>15</hour>
          <minute>00</minute>
          <second>00</second>
        </calendar>
      </event>

      <event>
        <name>startup</name>
        <startup/>
        <!-- avoid synchronization issues -->
        <random-spread>12345</random-spread>
      </event>

      <event>
        <name>controller-lost</name>
        <controller-lost/>
      </event>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 55]


Internet-Draft               LMAP Data Model                  March 2016


      <event>
        <name>controller-connected</name>
        <controller-connected/>
        <!-- avoid synchronization issues -->
        <random-spread>12345</random-spread>
      </event>
    </events>
  </lmap>
</config>


Appendix G.  Example Configuration (JSON)


{
  "ietf-lmap-control:lmap": {
    "agent": {
      "agent-id": "550e8400-e29b-41d4-a716-446655440000",
      "device-id": "urn:dev:mac:0024befffe804ff1",
      "group-id": "network measurement at the north-pole",
      "report-agent-id": true
    },
    "tasks": {
      "task": [
        {
          "name": "iperf-server",
          "program": "/usr/bin/iperf",
          "option": [
            {
              "id": "server",
              "name": "-s"
            }
          ],
          "tag": [
            "passive",
            "iperf"
          ]
        },
        {
          "name": "iperf-client",
          "program": "/usr/bin/iperf",
          "option": [
            {
              "id": "client",
              "name": "-c"
            }
          ],
          "tag": [



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 56]


Internet-Draft               LMAP Data Model                  March 2016


            "active",
            "iperf"
          ]
        },
        {
          "name": "lmap-reporting-task",
          "program": "/usr/bin/lmap-reporter",
          "option": [
            {
              "id": "collector-uri",
              "value": "https://example.com/restconf/operations/ietf-lmap-report:report"
            }
          ]
        },
        {
          "name": "fcc-measurement-suite",
          "program": "/usr/bin/fcc-suite"
        },
        {
          "name": "ippm-udp-latency-client",
          "program": "/usr/bin/ippm-udp-latency",
          "metric": [
            {
              "uri": "urn:example:what?",
              "role": [
                "client"
              ]
            }
          ],
          "tag": [
            "active"
          ]
        }
      ]
    },
    "schedules": {
      "schedule": [
        {
          "name": "fcc-campain-2016",
          "start": "fcc-hourly-sep-2016",
          "duration": 600,
          "execution-mode": "pipelined",
          "action": [
            {
              "name": "fcc-measurement",
              "task": "fcc-measurement-suite"
            },
            {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 57]


Internet-Draft               LMAP Data Model                  March 2016


              "name": "fcc-report",
              "task": "lmap-reporting-task",
              "option": [
                {
                  "id": "collector-uri",
                  "value": "https://fcc.example.com/restconf/operations/ietf-lmap-report:report"
                }
              ]
            }
          ]
        },
        {
          "name": "iperf-hourly",
          "start": "hourly",
          "execution-mode": "sequential",
          "action": [
            {
              "name": "iperf-hourly-mlab1",
              "task": "iperf-client",
              "option": [
                {
                  "id": "mlab1",
                  "value": "mlab1.example.com"
                }
              ]
            },
            {
              "name": "iperf-hourly-mlab2",
              "task": "iperf-client",
              "option": [
                {
                  "id": "mlab2",
                  "value": "mlab2.example.com"
                }
              ],
              "destination": [
                "report-collector",
                "report-shadow-collector"
              ]
            }
          ]
        },
        {
          "name": "startup",
          "start": "startup",
          "action": [
            {
              "name": "iperf-server",



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 58]


Internet-Draft               LMAP Data Model                  March 2016


              "task": "iperf-server"
            }
          ]
        },
        {
          "name": "report-collector",
          "start": "once-every-six-hours",
          "action": [
            {
              "name": "report-action",
              "task": "lmap-reporting-task",
              "option": [
                {
                  "id": "collector-uri",
                  "value": "https://collector.example.com/restconf/operations/ietf-lmap-report:report"
                }
              ]
            }
          ]
        },
        {
          "name": "report-shadow-collector",
          "start": "daily",
          "action": [
            {
              "name": "report-action",
              "task": "lmap-reporting-task",
              "option": [
                {
                  "id": "collector-uri",
                  "value": "https://shadow.example.com/restconf/operations/ietf-lmap-report:report"
                }
              ]
            }
          ]
        },
        {
          "name": "ippm-udp-latency",
          "start": "hourly",
          "execution-mode": "sequential",
          "action": [
            {
              "name": "ippm-udp-latency",
              "task": "ippm-udp-latency-client",
              "parameters": {
                "src-ip": "192.0.2.1",
                "src-port": 54321,
                "dst-ip": "192.0.2.2",



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 59]


Internet-Draft               LMAP Data Model                  March 2016


                "dst-port": 12345,
                "poisson-lambda": "42"
              }
            },
            {
              "name": "ippm-udp-latency-report",
              "task": "lmap-reporting-task",
              "option": [
                {
                  "id": "collector-uri",
                  "value": "https://ippm.example.com/restconf/operations/ietf-lmap-report:report"
                }
              ]
            }
          ]
        }
      ]
    },
    "suppressions": {
      "suppression": [
        {
          "name": "orphaned",
          "start": "controller-lost",
          "end": "controller-connected",
          "match": [
            "*"
          ]
        },
        {
          "name": "new-year-evening",
          "start": "dec-31-11:00",
          "end": "jan-01-15:00",
          "match": [
            "active"
          ]
        }
      ]
    },
    "events": {
      "event": [
        {
          "name": "fcc-hourly-sep-2016",
          "periodic": {
            "interval": 3600000,
            "start": "2016-09-01T00:00:00+00:00",
            "end": "2016-10-01T00:00:00+00:00"
          },
          "random-spread": 300000



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 60]


Internet-Draft               LMAP Data Model                  March 2016


        },
        {
          "name": "monthly",
          "calendar": {
            "month": [
              "*"
            ],
            "day-of-week": [
              "*"
            ],
            "day-of-month": [
              1
            ],
            "hour": [
              0
            ],
            "minute": [
              0
            ],
            "second": [
              0
            ],
            "timezone-offset": "+00:00"
          }
        },
        {
          "name": "weekly",
          "calendar": {
            "month": [
              "*"
            ],
            "day-of-week": [
              "monday"
            ],
            "day-of-month": [
              "*"
            ],
            "hour": [
              0
            ],
            "minute": [
              0
            ],
            "second": [
              0
            ],
            "timezone-offset": "+00:00"
          }



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 61]


Internet-Draft               LMAP Data Model                  March 2016


        },
        {
          "name": "daily",
          "calendar": {
            "month": [
              "*"
            ],
            "day-of-week": [
              "*"
            ],
            "day-of-month": [
              "*"
            ],
            "hour": [
              0
            ],
            "minute": [
              0
            ],
            "second": [
              0
            ],
            "timezone-offset": "+00:00"
          }
        },
        {
          "name": "hourly",
          "calendar": {
            "month": [
              "*"
            ],
            "day-of-month": [
              "*"
            ],
            "day-of-week": [
              "*"
            ],
            "hour": [
              "*"
            ],
            "minute": [
              0
            ],
            "second": [
              0
            ],
            "timezone-offset": "+00:00"
          }



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 62]


Internet-Draft               LMAP Data Model                  March 2016


        },
        {
          "name": "once-every-six-hours",
          "calendar": {
            "month": [
              "*"
            ],
            "day-of-month": [
              "*"
            ],
            "day-of-week": [
              "*"
            ],
            "hour": [
              0,
              6,
              12,
              18
            ],
            "minute": [
              0
            ],
            "second": [
              0
            ]
          },
          "random-spread": 3600000
        },
        {
          "name": "dec-31-11:00",
          "calendar": {
            "month": [
              "december"
            ],
            "day-of-month": [
              31
            ],
            "day-of-week": [
              "*"
            ],
            "hour": [
              11
            ],
            "minute": [
              00
            ],
            "second": [
              00



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 63]


Internet-Draft               LMAP Data Model                  March 2016


            ]
          }
        },
        {
          "name": "jan-01-15:00",
          "calendar": {
            "month": [
              "january"
            ],
            "day-of-month": [
              1
            ],
            "day-of-week": [
              "*"
            ],
            "hour": [
              15
            ],
            "minute": [
              00
            ],
            "second": [
              00
            ]
          }
        },
        {
          "name": "startup",
          "startup": [null],
          "random-spread": 12345
        },
        {
          "name": "controller-lost",
          "controller-lost": [null]
        },
        {
          "name": "controller-connected",
          "controller-connected": [null],
          "random-spread": 12345
        }
      ]
    }
  }
}







Schoenwaelder & Bajpai Expires September 16, 2016              [Page 64]


Internet-Draft               LMAP Data Model                  March 2016


Appendix H.  Example State (XML)


<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <lmap-state xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-control">

    <agent>
      <agent-id>550e8400-e29b-41d4-a716-446655440000</agent-id>
      <device-id>urn:dev:mac:0024befffe804ff1</device-id>
      <hardware>ACME home router</hardware>
      <firmware>OpenWrt version 10.03.1</firmware>
      <version>Measurement Agent Daemon (MAD) 4.2</version>
      <last-started>2015-04-10T17:24:42+02:00</last-started>
    </agent>

    <tasks>
      <task>
        <name>udp-latency-measurement</name>
        <metric>
          <uri>urn:....</uri>
          <role>source</role>
          <role>target</role>
        </metric>
      </task>

      <task>
        <name>icmp-latency-measurement</name>
        <metric>
          <uri>urn:....</uri>
        </metric>
      </task>

      <task>
        <name>iperf</name>
        <program>iperf</program>
      </task>

      <task>
        <name>lmap-reporting-task</name>
        <program>lmap-reportd</program>
      </task>
    </tasks>

    <schedules>
      <schedule>
        <name>hourly-schedule</name>
        <state>enabled</state>
        <last-invocation>2015-01-23T12:00:00+01:00</last-invocation>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 65]


Internet-Draft               LMAP Data Model                  March 2016


        <action>
          <name>icmp-latency-hourly</name>
          <state>enabled</state>
          <last-invocation>2015-01-23T12:00:00+01:00</last-invocation>
          <last-completion>2015-01-23T12:00:01+01:00</last-completion>
          <last-status>0</last-status>
          <last-message>OK</last-message>
          <last-failed-completion>2015-01-23T03:00:00+01:00</last-failed-completion>
          <last-failed-status>42</last-failed-status>
          <last-failed-message>connection timed out</last-failed-message>
        </action>
        <action>
          <name>udp-latency-weekdays-hourly</name>
          <last-invocation>2015-01-23T12:00:01+01:00</last-invocation>
          <last-completion>2015-01-23T12:00:02+01:00</last-completion>
          <last-status>0</last-status>
          <last-message>OK</last-message>
          <last-failed-completion>2015-01-23T03:00:00+01:00</last-failed-completion>
          <last-failed-status>42</last-failed-status>
          <last-failed-message>connection timed out</last-failed-message>
        </action>
      </schedule>
    </schedules>
  </lmap-state>
</data>


Appendix I.  Example State (JSON)


   {
     "ietf-lmap-control:lmap-state": {
       "agent": {
         "agent-id": "550e8400-e29b-41d4-a716-446655440000",
         "device-id": "urn:dev:mac:0024befffe804ff1",
         "hardware": "ACME home router",
         "firmware": "OpenWrt version 10.03.1",
         "version": "Measurement Agent Daemon (MAD) 4.2",
         "last-started": "2015-04-10T17:24:42+02:00"
       },
       "tasks": {
         "task": [
           {
             "name": "udp-latency-measurement",
             "metric": [
               {
                 "uri": "urn:....",
                 "role": [



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 66]


Internet-Draft               LMAP Data Model                  March 2016


                   "source",
                   "target"
                 ]
               }
             ]
           },
           {
             "name": "icmp-latency-measurement",
             "metric": [
               {
                 "uri": "urn:...."
               }
             ]
           },
           {
             "name": "iperf",
             "program": "iperf"
           },
           {
             "name": "lmap-reporting-task",
             "program": "lmap-reportd"
           }
         ]
       },
       "schedules": {
         "schedule": [
           {
             "name": "hourly-schedule",
             "state": "enabled",
             "last-invocation": "2015-01-23T12:00:00+01:00",
             "action": [
               {
                 "name": "icmp-latency-hourly",
                 "state": "enabled",
                 "last-invocation": "2015-01-23T12:00:00+01:00",
                 "last-completion": "2015-01-23T12:00:01+01:00",
                 "last-status": 0,
                 "last-message": "OK",
                 "last-failed-completion": "2015-01-23T03:00:00+01:00",
                 "last-failed-status": 42,
                 "last-failed-message": "connection timed out"
               },
               {
                 "name": "udp-latency-weekdays-hourly",
                 "last-invocation": "2015-01-23T12:00:01+01:00",
                 "last-completion": "2015-01-23T12:00:02+01:00",
                 "last-status": 0,
                 "last-message": "OK",



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 67]


Internet-Draft               LMAP Data Model                  March 2016


                 "last-failed-completion": "2015-01-23T03:00:00+01:00",
                 "last-failed-status": 42,
                 "last-failed-message": "connection timed out"
               }
             ]
           }
         ]
       }
     }
   }


Appendix J.  Example Report (XML)


   <?xml version="1.0" encoding="utf-8"?>
   <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
        message-id="1">
     <report xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-report">
       <date>2015-10-28T13:27:42+02:00</date>
       <agent-id>550e8400-e29b-41d4-a716-446655440000</agent-id>
       <group-id>wireless measurement at the north-pole</group-id>
       <task>
         <name>icmp-latency-measurement</name>
         <!-- fping -A -d -C 5 -q www.ietf.org www.google.com -->
         <header>
           <column>target</column>
       <column>ip</column>
           <column>rtt-1</column>
           <column>rtt-2</column>
           <column>rtt-3</column>
           <column>rtt-4</column>
           <column>rtt-5</column>
         </header>
         <row>
           <start>2015-03-25T00:00:55+00:00</start>
       <value>www.ietf.org</value>
           <value>104.20.0.85</value>
           <value>14.15</value>
           <value>14.14</value>
           <value>14.09</value>
           <value>14.17</value>
           <value>14.51</value>
         </row>
         <row>
           <start>2015-03-25T00:00:56+00:00</start>
       <value>www.google.com</value>
           <value>216.58.213.36</value>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 68]


Internet-Draft               LMAP Data Model                  March 2016


           <value>12.24</value>
       <value>11.99</value>
       <value>12.49</value>
       <value>11.87</value>
       <value>12.45</value>
         </row>
       </task>
       <task>
         <name>happy-dns-measurement</name>
         <!-- happy -m -a www.ietf.org www.google.com -->
         <header>
       <column>target</column>
       <column>ip</column>
       <column>name</column>
         </header>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>2400:cb00:2048:1::6814:55</value>
       <value>www.ietf.org.cdn.cloudflare-dnssec.net</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>2400:cb00:2048:1::6814:155</value>
       <value>www.ietf.org.cdn.cloudflare-dnssec.net</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>104.20.1.85</value>
       <value>www.ietf.org.cdn.cloudflare-dnssec.net</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>104.20.0.85</value>
       <value>www.ietf.org.cdn.cloudflare-dnssec.net</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.google.com</value>
       <value>2a00:1450:4008:800::1012</value>
       <!-- <value>www.google.com</value> xxx leaflist sucks -->
       <value>ber01s08-in-x12.1e100.net</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 69]


Internet-Draft               LMAP Data Model                  March 2016


       <value>www.google.com</value>
       <value>216.58.213.36</value>
       <!-- <value>www.google.com</value> xxx leaflist sucks -->
       <value>ber01s15-in-f36.1e100.net</value>
         </row>
       </task>
       <task>
         <name>happy-connect-measurement</name>
         <!-- happy -m -a www.ietf.org www.google.com -->
         <header>
       <column>target</column>
       <column>port</column>
       <column>ip</column>
       <column>time-1</column>
       <column>time-2</column>
       <column>time-3</column>
         </header>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>80</value>
       <value>2400:cb00:2048:1::6814:55</value>
       <value>8164</value>
       <value>8019</value>
       <value>14066</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>80</value>
       <value>2400:cb00:2048:1::6814:155</value>
       <value>14131</value>
       <value>14029</value>
       <value>7984</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>80</value>
       <value>104.20.1.85</value>
       <value>13821</value>
       <value>13736</value>
       <value>7995</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.ietf.org</value>
       <value>80</value>



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 70]


Internet-Draft               LMAP Data Model                  March 2016


       <value>104.20.0.85</value>
       <value>14024</value>
       <value>13756</value>
       <value>8589</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.google.com</value>
       <value>80</value>
       <value>2a00:1450:4008:800::1012</value>
       <value>19246</value>
       <value>19416</value>
       <value>19443</value>
         </row>
         <row>
       <start>2015-03-25T00:00:56+00:00</start>
       <value>www.google.com</value>
       <value>80</value>
       <value>216.58.213.36</value>
       <value>11692</value>
       <value>11668</value>
       <value>11933</value>
         </row>
       </task>
     </report>
   </rpc>


Appendix K.  Example Report (JSON)


   {
     "report": {
       "date": "2015-10-28T13:27:42+02:00",
       "agent-id": "550e8400-e29b-41d4-a716-446655440000",
       "group-id": "wireless measurement at the north-pole",
       "task": [
         {
           "name": "icmp-latency-measurement",
           "header": {
             "column": [
               "target",
               "ip",
               "rtt-1",
               "rtt-2",
               "rtt-3",
               "rtt-4",
               "rtt-5"



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 71]


Internet-Draft               LMAP Data Model                  March 2016


             ]
           },
           "row": [
             {
               "start": "2015-03-25T00:00:55+00:00",
               "value": [
                 "www.ietf.org",
                 "104.20.0.85",
                 "14.15",
                 "14.14",
                 "14.09",
                 "14.17",
                 "14.51"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.google.com",
                 "216.58.213.36",
                 "12.24",
                 "11.99",
                 "12.49",
                 "11.87",
                 "12.45"
               ]
             }
           ]
         },
         {
           "name": "happy-dns-measurement",
           "header": {
             "column": [
               "target",
               "ip",
               "name"
             ]
           },
           "row": [
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "2400:cb00:2048:1::6814:55",
                 "www.ietf.org.cdn.cloudflare-dnssec.net"
               ]
             },
             {



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 72]


Internet-Draft               LMAP Data Model                  March 2016


               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "2400:cb00:2048:1::6814:155",
                 "www.ietf.org.cdn.cloudflare-dnssec.net"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "104.20.1.85",
                 "www.ietf.org.cdn.cloudflare-dnssec.net"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "104.20.0.85",
                 "www.ietf.org.cdn.cloudflare-dnssec.net"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.google.com",
                 "2a00:1450:4008:800::1012",
                 "ber01s08-in-x12.1e100.net"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.google.com",
                 "216.58.213.36",
                 "ber01s15-in-f36.1e100.net"
               ]
             }
           ]
         },
         {
           "name": "happy-connect-measurement",
           "header": {
             "column": [
               "target",
               "port",
               "ip",



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 73]


Internet-Draft               LMAP Data Model                  March 2016


               "time-1",
               "time-2",
               "time-3"
             ]
           },
           "row": [
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "80",
                 "2400:cb00:2048:1::6814:55",
                 "8164",
                 "8019",
                 "14066"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "80",
                 "2400:cb00:2048:1::6814:155",
                 "14131",
                 "14029",
                 "7984"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "80",
                 "104.20.1.85",
                 "13821",
                 "13736",
                 "7995"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.ietf.org",
                 "80",
                 "104.20.0.85",
                 "14024",
                 "13756",
                 "8589"



Schoenwaelder & Bajpai Expires September 16, 2016              [Page 74]


Internet-Draft               LMAP Data Model                  March 2016


               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.google.com",
                 "80",
                 "2a00:1450:4008:800::1012",
                 "19246",
                 "19416",
                 "19443"
               ]
             },
             {
               "start": "2015-03-25T00:00:56+00:00",
               "value": [
                 "www.google.com",
                 "80",
                 "216.58.213.36",
                 "11692",
                 "11668",
                 "11933"
               ]
             }
           ]
         }
       ]
     }
   }


Authors' Addresses

   Juergen Schoenwaelder
   Jacobs University Bremen

   Email: j.schoenwaelder@jacobs-university.de


   Vaibhav Bajpai
   Jacobs University Bremen

   Email: v.bajpai@jacobs-university.de








Schoenwaelder & Bajpai Expires September 16, 2016              [Page 75]


Html markup produced by rfcmarkup 1.129c, available from https://tools.ietf.org/tools/rfcmarkup/