Debian Codegraph @

rfc8194.html

raw
1 <pre>Internet Engineering Task Force (IETF) J. Schoenwaelder
2 Request for Comments: 8194 Jacobs University Bremen
3 Category: Standards Track V. Bajpai
4 ISSN: 2070-1721 Technical University of Munich
5 August 2017
6
7
8 <span class="h1">A YANG Data Model for LMAP Measurement Agents</span>
9
10 Abstract
11
12 This document defines a data model for Large-Scale Measurement
13 Platforms (LMAPs). The data model is defined using the YANG data
14 modeling language.
15
16 Status of This Memo
17
18 This is an Internet Standards Track document.
19
20 This document is a product of the Internet Engineering Task Force
21 (IETF). It represents the consensus of the IETF community. It has
22 received public review and has been approved for publication by the
23 Internet Engineering Steering Group (IESG). Further information on
24 Internet Standards is available in <a href="./rfc7841#section-2">Section&nbsp;2 of RFC 7841</a>.
25
26 Information about the current status of this document, any errata,
27 and how to provide feedback on it may be obtained at
28 <a href="http://www.rfc-editor.org/info/rfc8194">http://www.rfc-editor.org/info/rfc8194</a>.
29
30 Copyright Notice
31
32 Copyright (c) 2017 IETF Trust and the persons identified as the
33 document authors. All rights reserved.
34
35 This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
36 Provisions Relating to IETF Documents
37 (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
38 publication of this document. Please review these documents
39 carefully, as they describe your rights and restrictions with respect
40 to this document. Code Components extracted from this document must
41 include Simplified BSD License text as described in Section 4.e of
42 the Trust Legal Provisions and are provided without warranty as
43 described in the Simplified BSD License.
44
45
46
47
48
49
50
51
52 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
55
56
57 Table of Contents
58
59 <a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
60 <a href="#section-1.1">1.1</a>. Terminology . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
61 <a href="#section-1.2">1.2</a>. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
62 <a href="#section-2">2</a>. Data Model Overview . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
63 <a href="#section-3">3</a>. Relationship to the Information Model . . . . . . . . . . . . <a href="#page-9">9</a>
64 <a href="#section-4">4</a>. YANG Modules . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
65 <a href="#section-4.1">4.1</a>. LMAP Common YANG Module . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
66 <a href="#section-4.2">4.2</a>. LMAP Control YANG Module . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
67 <a href="#section-4.3">4.3</a>. LMAP Report YANG Module . . . . . . . . . . . . . . . . . <a href="#page-40">40</a>
68 <a href="#section-5">5</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a>
69 <a href="#section-6">6</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
70 <a href="#section-7">7</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
71 <a href="#section-7.1">7.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>
72 <a href="#section-7.2">7.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-49">49</a>
73 <a href="#appendix-A">Appendix A</a>. Example Parameter Extension Module . . . . . . . . . <a href="#page-51">51</a>
74 <a href="#appendix-B">Appendix B</a>. Example Configuration . . . . . . . . . . . . . . . <a href="#page-53">53</a>
75 <a href="#appendix-C">Appendix C</a>. Example Report . . . . . . . . . . . . . . . . . . . <a href="#page-56">56</a>
76 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
77 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-59">59</a>
78
79 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
80
81 This document defines a data model for Large-Scale Measurement
82 Platforms (LMAPs) [<a href="./rfc7594" title="&quot;A Framework for Large-Scale Measurement of Broadband Performance (LMAP)&quot;">RFC7594</a>]. The data model is defined using the
83 YANG [<a href="./rfc7950" title="&quot;The YANG 1.1 Data Modeling Language&quot;">RFC7950</a>] data modeling language. It is based on the LMAP
84 Information Model [<a href="./rfc8193" title="&quot;Information Model for Large-Scale Measurement Platforms (LMAPs)&quot;">RFC8193</a>].
85
86 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Terminology</span>
87
88 This document uses the LMAP terminology defined in [<a href="./rfc7594" title="&quot;A Framework for Large-Scale Measurement of Broadband Performance (LMAP)&quot;">RFC7594</a>].
89
90 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
91 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
92 "OPTIONAL" in this document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP</a>
93 <a href="https://www.rfc-editor.org/bcp/bcp14">14</a> [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>] [<a href="./rfc8174" title="&quot;Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words&quot;">RFC8174</a>] when, and only when, they appear in all
94 capitals, as shown here.
95
96 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Tree Diagrams</span>
97
98 A simplified graphical representation of the data model is used in
99 this document. The meaning of the symbols in these diagrams is as
100 follows:
101
102 o Brackets "[" and "]" enclose list keys.
103
104
105
106
107
108 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
111
112
113 o Abbreviations before data node names: "rw" means configuration
114 (read-write), "ro" means state data (read-only), and "w" means RPC
115 input data (write-only).
116
117 o Symbols after data node names: "?" means an optional node, "!"
118 means a presence container, and "*" denotes a list and leaf-list.
119
120 o Parentheses enclose choice and case nodes, and case nodes are also
121 marked with a colon (":").
122
123 o Ellipsis ("...") stands for contents of subtrees that are not
124 shown.
125
126 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Data Model Overview</span>
127
128 The LMAP framework has three basic elements: Measurement Agents
129 (MAs), Controllers, and Collectors. Measurement Agents initiate the
130 actual measurements, which are called Measurement Tasks in the LMAP
131 terminology. The Controller instructs one or more MAs and
132 communicates the set of Measurement Tasks an MA should perform and
133 when. The Collector accepts Reports from the MAs with the Results
134 from their Measurement Tasks.
135
136 The YANG data model for LMAP has been split into three modules:
137
138 1. The module ietf-lmap-common.yang provides common definitions such
139 as LMAP-specific data types.
140
141 2. The module ietf-lmap-control.yang defines the data structures
142 exchanged between a Controller and Measurement Agents.
143
144 3. The module ietf-lmap-report.yang defines the data structures
145 exchanged between Measurement Agents and Collectors.
146
147 As shown in Figure 1, a Controller, implementing
148 ietf-lmap-common.yang and ietf-lmap-control.yang as a client, will
149 instruct Measurement Agents, which implement ietf-lmap-common.yang
150 and ietf-lmap-control.yang as servers. A Measurement Agent,
151 implementing ietf-lmap-common.yang and ietf-lmap-report.yang, will
152 send results to a Collector, which implements ietf-lmap-common.yang
153 and ietf-lmap-report.yang as a server.
154
155
156
157
158
159
160
161
162
163
164 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
167
168
169 +------------------------+
170 | LMAP Controller |
171 | |
172 | Client: |
173 | ietf-lmap-common.yang |
174 | ietf-lmap-control.yang |
175 +------------------------+
176 +------------------------+ |
177 | LMAP Measurement Agent | |
178 | | &lt;- request |
179 | Server: |&lt;---------------------'
180 | ietf-lmap-common.yang | response -&gt;
181 | ietf-lmap-control.yang |
182 | |
183 | | request -&gt;
184 | Client: |----------------------.
185 | ietf-lmap-common.yang | &lt;- response |
186 | ietf-lmap-report.yang | |
187 +------------------------+ v
188 +------------------------+
189 | LMAP Collector |
190 | |
191 | Server: |
192 | ietf-lmap-common.yang |
193 | ietf-lmap-report.yang |
194 +------------------------+
195
196 Figure 1: The LMAP Controller, Measurement Agent, and Collector and
197 the YANG Modules They Implement as Client or Server
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
223
224
225 The tree diagram below shows the structure of the control data model.
226
227 module: ietf-lmap-control
228 +--rw lmap
229 +--ro capabilities
230 | +--ro version string
231 | +--ro tag* lmap:tag
232 | +--ro tasks
233 | +--ro task* [name]
234 | +--ro name lmap:identifier
235 | +--ro function* [uri]
236 | | +--ro uri inet:uri
237 | | +--ro role* string
238 | +--ro version? string
239 | +--ro program? string
240 +--rw agent
241 | +--rw agent-id? yang:uuid
242 | +--rw group-id? string
243 | +--rw measurement-point? string
244 | +--rw report-agent-id? boolean
245 | +--rw report-group-id? boolean
246 | +--rw report-measurement-point? boolean
247 | +--rw controller-timeout? uint32
248 | +--ro last-started yang:date-and-time
249 +--rw tasks
250 | +--rw task* [name]
251 | +--rw name lmap:identifier
252 | +--rw function* [uri]
253 | | +--rw uri inet:uri
254 | | +--rw role* string
255 | +--rw program? string
256 | +--rw option* [id]
257 | | +--rw id lmap:identifier
258 | | +--rw name? string
259 | | +--rw value? string
260 | +--rw tag* lmap:identifier
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
279
280
281 +--rw schedules
282 | +--rw schedule* [name]
283 | +--rw name lmap:identifier
284 | +--rw start event-ref
285 | +--rw (stop)?
286 | | +--:(end)
287 | | | +--rw end? event-ref
288 | | +--:(duration)
289 | | +--rw duration? uint32
290 | +--rw execution-mode? enumeration
291 | +--rw tag* lmap:tag
292 | +--rw suppression-tag* lmap:tag
293 | +--ro state enumeration
294 | +--ro storage yang:gauge64
295 | +--ro invocations yang:counter32
296 | +--ro suppressions yang:counter32
297 | +--ro overlaps yang:counter32
298 | +--ro failures yang:counter32
299 | +--ro last-invocation? yang:date-and-time
300 | +--rw action* [name]
301 | +--rw name lmap:identifier
302 | +--rw task task-ref
303 | +--rw parameters
304 | | +--rw (extension)?
305 | +--rw option* [id]
306 | | +--rw id lmap:identifier
307 | | +--rw name? string
308 | | +--rw value? string
309 | +--rw destination* schedule-ref
310 | +--rw tag* lmap:tag
311 | +--rw suppression-tag* lmap:tag
312 | +--ro state enumeration
313 | +--ro storage yang:gauge64
314 | +--ro invocations yang:counter32
315 | +--ro suppressions yang:counter32
316 | +--ro overlaps yang:counter32
317 | +--ro failures yang:counter32
318 | +--ro last-invocation yang:date-and-time
319 | +--ro last-completion yang:date-and-time
320 | +--ro last-status lmap:status-code
321 | +--ro last-message string
322 | +--ro last-failed-completion yang:date-and-time
323 | +--ro last-failed-status lmap:status-code
324 | +--ro last-failed-message string
325
326
327
328
329
330
331
332 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
335
336
337 +--rw suppressions
338 | +--rw suppression* [name]
339 | +--rw name lmap:identifier
340 | +--rw start? event-ref
341 | +--rw end? event-ref
342 | +--rw match* lmap:glob-pattern
343 | +--rw stop-running? boolean
344 | +--ro state enumeration
345 +--rw events
346 +--rw event* [name]
347 +--rw name lmap:identifier
348 +--rw random-spread? uint32
349 +--rw cycle-interval? uint32
350 +--rw (event-type)?
351 +--:(periodic)
352 | +--rw periodic
353 | +--rw interval uint32
354 | +--rw start? yang:date-and-time
355 | +--rw end? yang:date-and-time
356 +--:(calendar)
357 | +--rw calendar
358 | +--rw month* lmap:month-or-all
359 | +--rw day-of-month* lmap:day-of-months-or-all
360 | +--rw day-of-week* lmap:weekday-or-all
361 | +--rw hour* lmap:hour-or-all
362 | +--rw minute* lmap:minute-or-all
363 | +--rw second* lmap:second-or-all
364 | +--rw timezone-offset? lmap:timezone-offset
365 | +--rw start? yang:date-and-time
366 | +--rw end? yang:date-and-time
367 +--:(one-off)
368 | +--rw one-off
369 | +--rw time yang:date-and-time
370 +--:(immediate)
371 | +--rw immediate empty
372 +--:(startup)
373 | +--rw startup empty
374 +--:(controller-lost)
375 | +--rw controller-lost empty
376 +--:(controller-connected)
377 +--rw controller-connected empty
378
379
380
381
382
383
384
385
386
387
388 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
391
392
393 The tree diagram below shows the structure of the reporting data
394 model.
395
396 module: ietf-lmap-report
397
398 rpcs:
399 +---x report
400 +---w input
401 +---w date yang:date-and-time
402 +---w agent-id? yang:uuid
403 +---w group-id? string
404 +---w measurement-point? string
405 +---w result*
406 +---w schedule? lmap:identifier
407 +---w action? lmap:identifier
408 +---w task? lmap:identifier
409 +---w parameters
410 | +---w (extension)?
411 +---w option* [id]
412 | +---w id lmap:identifier
413 | +---w name? string
414 | +---w value? string
415 +---w tag* lmap:tag
416 +---w event? yang:date-and-time
417 +---w start yang:date-and-time
418 +---w end? yang:date-and-time
419 +---w cycle-number? lmap:cycle-number
420 +---w status lmap:status-code
421 +---w conflict*
422 | +---w schedule-name? lmap:identifier
423 | +---w action-name? lmap:identifier
424 | +---w task-name? lmap:identifier
425 +---w table*
426 +---w function* [uri]
427 | +---w uri inet:uri
428 | +---w role* string
429 +---w column* string
430 +---w row*
431 +---w value* string
432
433
434
435
436
437
438
439
440
441
442
443
444 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
447
448
449 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Relationship to the Information Model</span>
450
451 The LMAP Information Model [<a href="./rfc8193" title="&quot;Information Model for Large-Scale Measurement Platforms (LMAPs)&quot;">RFC8193</a>] is divided into six aspects.
452 They are mapped into the YANG data model as explained below:
453
454 o Preconfiguration Information: This is not modeled explicitly since
455 bootstrapping information is outside the scope of this data model.
456 Implementations may use some of the Configuration Information also
457 for bootstrapping purposes.
458
459 o Configuration Information: This is modeled in the /lmap/agent
460 subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree
461 described below. Some items have been left out because they are
462 expected to be dealt with by the underlying protocol.
463
464 o Instruction Information: This is modeled in the /lmap/suppressions
465 subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree
466 described below.
467
468 o Logging Information: Some of the Logging Information, in
469 particular 'success/failure/warning messages in response to
470 information updates from the Controller', will be handled by the
471 protocol used to manipulate the LMAP-specific configuration. The
472 LMAP data model defined in this document assumes that runtime
473 Logging Information will be communicated using protocols that do
474 not require a formal data model, e.g., the syslog protocol defined
475 in [<a href="./rfc5424" title="&quot;The Syslog Protocol&quot;">RFC5424</a>].
476
477 o Capability and Status Information: Some of the Capability and
478 Status Information is modeled in the /lmap/capability subtree.
479 The list of supported Tasks is modeled in the /lmap/capabilities/
480 task list. Status Information about Schedules and Actions is
481 included in the /lmap/schedules subtree. Information about
482 network interfaces can be obtained from the ietf-interfaces YANG
483 data model [<a href="./rfc7223" title="&quot;A YANG Data Model for Interface Management&quot;">RFC7223</a>]. Information about the hardware and the
484 firmware can be obtained from the ietf-system YANG data model
485 [<a href="./rfc7317" title="&quot;A YANG Data Model for System Management&quot;">RFC7317</a>]. A device identifier can be obtained from the ietf-
486 hardware YANG data model [<a href="#ref-YANG-HARDWARE">YANG-HARDWARE</a>].
487
488 o Reporting Information: This is modeled by the report data model to
489 be implemented by the Collector. Measurement Agents send results
490 to the Collector by invoking an RPC on the Collector.
491
492 These six Information Model aspects use a collection of common
493 information objects. These common information objects are
494 represented in the YANG data model as follows:
495
496 o Schedules: Schedules are modeled in the /lmap/schedules subtree.
497
498
499
500 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
503
504
505 o Channels: Channels are not modeled since the NETCONF server
506 configuration data model [<a href="#ref-NETCONF-CLIENT-SERVER">NETCONF-CLIENT-SERVER</a>] already provides
507 a mechanism to configure NETCONF server Channels.
508
509 o Task Configurations: Configured Tasks are modeled in the /lmap/
510 tasks subtree.
511
512 o Event Information: Event definitions are modeled in the /lmap/
513 events subtree.
514
515 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. YANG Modules</span>
516
517 <span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. LMAP Common YANG Module</span>
518
519 This module imports definitions from [<a href="./rfc6536" title="&quot;Network Configuration Protocol (NETCONF) Access Control Model&quot;">RFC6536</a>], and it references
520 [<a href="#ref-ISO-8601">ISO-8601</a>].
521
522 &lt;CODE BEGINS&gt; file "[email protected]"
523 module ietf-lmap-common {
524
525 yang-version 1.1;
526 namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-common";
527 prefix "lmap";
528
529 import ietf-inet-types {
530 prefix inet;
531 }
532
533 organization
534 "IETF Large-Scale Measurement of Broadband Performance
535 Working Group";
536
537 contact
538 "WG Web: &lt;<a href="https://datatracker.ietf.org/wg/lmap">https://datatracker.ietf.org/wg/lmap</a>&gt;
539 WG List: &lt;mailto:[email protected]&gt;
540
541 Editor: Juergen Schoenwaelder
542 &lt;[email protected]&gt;
543
544 Editor: Vaibhav Bajpai
545 &lt;[email protected]&gt;";
546
547 description
548 "This module provides common definitions used by the data
549 models written for Large-Scale Measurement Platforms (LMAPs).
550 This module defines typedefs and groupings but no schema
551 tree elements.";
552
553
554
555
556 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
559
560
561 revision "2017-08-08" {
562 description
563 "Initial version";
564 reference
565 "<a href="./rfc8194">RFC 8194</a>: A YANG Data Model for LMAP Measurement Agents";
566 }
567
568 /*
569 * Typedefs
570 */
571
572 typedef identifier {
573 type string {
574 length "1..max";
575 }
576 description
577 "A string value used to name something.";
578 }
579
580 typedef tag {
581 type string {
582 length "1..max";
583 }
584 description
585 "A tag consists of at least one character.";
586 }
587
588 typedef glob-pattern {
589 type string {
590 length "1..max";
591 }
592 description
593 'A glob style pattern (following POSIX.2 fnmatch() without
594 special treatment of file paths):
595
596 * matches a sequence of characters
597 ? matches a single character
598 [seq] matches any character in seq
599 [!seq] matches any character not in seq
600
601 A backslash followed by a character matches the following
602 character. In particular:
603
604 \* matches *
605 \? matches ?
606 \\ matches \
607
608
609
610
611
612 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
615
616
617 A sequence seq may be a sequence of characters (e.g., [abc]
618 or a range of characters (e.g., [a-c]).';
619 }
620
621 typedef wildcard {
622 type string {
623 pattern '\*';
624 }
625 description
626 "A wildcard for calendar scheduling entries.";
627 }
628
629 typedef cycle-number {
630 type string {
631 pattern '[0-9]{8}\.[0-9]{6}';
632 }
633 description
634 "A cycle number represented in the format YYYYMMDD.HHMMSS
635 where YYYY represents the year, MM the month (1..12), DD
636 the day of the months (01..31), HH the hour (00..23), MM
637 the minute (00..59), and SS the second (00..59). The cycle
638 number is using Coordinated Universal Time (UTC).";
639 }
640
641 typedef month {
642 type enumeration {
643 enum january {
644 value 1;
645 description
646 "January of the Gregorian calendar.";
647 }
648 enum february {
649 value 2;
650 description
651 "February of the Gregorian calendar.";
652 }
653 enum march {
654 value 3;
655 description
656 "March of the Gregorian calendar.";
657 }
658 enum april {
659 value 4;
660 description
661 "April of the Gregorian calendar.";
662 }
663
664
665
666
667
668 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
671
672
673 enum may {
674 value 5;
675 description
676 "May of the Gregorian calendar.";
677 }
678 enum june {
679 value 6;
680 description
681 "June of the Gregorian calendar.";
682 }
683 enum july {
684 value 7;
685 description
686 "July of the Gregorian calendar.";
687 }
688 enum august {
689 value 8;
690 description
691 "August of the Gregorian calendar.";
692 }
693 enum september {
694 value 9;
695 description
696 "September of the Gregorian calendar.";
697 }
698 enum october {
699 value 10;
700 description
701 "October of the Gregorian calendar.";
702 }
703 enum november {
704 value 11;
705 description
706 "November of the Gregorian calendar.";
707 }
708 enum december {
709 value 12;
710 description
711 "December of the Gregorian calendar.";
712 }
713 }
714 description
715 "A type modeling the month in the Gregorian calendar.";
716 }
717
718
719
720
721
722
723
724 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
727
728
729 typedef month-or-all {
730 type union {
731 type month;
732 type wildcard;
733 }
734 description
735 "A month or a wildcard indicating all twelve months.";
736 }
737
738 typedef day-of-month {
739 type uint8 { range "1..31"; }
740 description
741 "A day of a month of the Gregorian calendar.";
742 }
743
744 typedef day-of-months-or-all {
745 type union {
746 type day-of-month;
747 type wildcard;
748 }
749 description
750 "A day of a month or a wildcard indicating all days
751 of a month.";
752 }
753
754 typedef weekday {
755 type enumeration {
756 enum monday {
757 value 1;
758 description
759 "Monday of the Gregorian calendar.";
760 }
761 enum tuesday {
762 value 2;
763 description
764 "Tuesday of the Gregorian calendar.";
765 }
766 enum wednesday {
767 value 3;
768 description
769 "Wednesday of the Gregorian calendar.";
770 }
771 enum thursday {
772 value 4;
773 description
774 "Thursday of the Gregorian calendar.";
775 }
776
777
778
779
780 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
783
784
785 enum friday {
786 value 5;
787 description
788 "Friday of the Gregorian calendar.";
789 }
790 enum saturday {
791 value 6;
792 description
793 "Saturday of the Gregorian calendar.";
794 }
795 enum sunday {
796 value 7;
797 description
798 "Sunday of the Gregorian calendar.";
799 }
800 }
801 description
802 "A type modeling the weekdays in the Gregorian calendar.
803 The numbering follows the ISO 8601 scheme.";
804 reference
805 "ISO 8601:2004: Data elements and interchange formats --
806 Information interchange -- Representation
807 of dates and times";
808 }
809
810 typedef weekday-or-all {
811 type union {
812 type weekday;
813 type wildcard;
814 }
815 description
816 "A weekday or a wildcard indicating all seven weekdays.";
817 }
818
819 typedef hour {
820 type uint8 { range "0..23"; }
821 description
822 "An hour of a day.";
823 }
824
825 typedef hour-or-all {
826 type union {
827 type hour;
828 type wildcard;
829 }
830 description
831 "An hour of a day or a wildcard indicating all hours
832 of a day.";
833
834
835
836 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
839
840
841 }
842
843 typedef minute {
844 type uint8 { range "0..59"; }
845 description
846 "A minute of an hour.";
847 }
848
849 typedef minute-or-all {
850 type union {
851 type minute;
852 type wildcard;
853 }
854 description
855 "A minute of an hour or a wildcard indicating all
856 minutes of an hour.";
857 }
858
859 typedef second {
860 type uint8 { range "0..59"; }
861 description
862 "A second of a minute.";
863 }
864
865 typedef second-or-all {
866 type union {
867 type second;
868 type wildcard;
869 }
870 description
871 "A second of a minute or a wildcard indicating all
872 seconds of a minute.";
873 }
874
875 typedef status-code {
876 type int32;
877 description
878 "A status code returned by the execution of a Task. Note
879 that the actual range is implementation dependent, but it
880 should be portable to use values in the range 0..127 for
881 regular exit codes. By convention, 0 indicates successful
882 termination. Negative values may be used to indicate
883 abnormal termination due to a signal; the absolute value
884 may identify the signal number in this case.";
885 }
886
887
888
889
890
891
892 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
895
896
897 typedef timezone-offset {
898 type string {
899 pattern 'Z|[\+\-]\d{2}:\d{2}';
900 }
901 description
902 "A time zone offset as it is used by the date-and-time type
903 defined in the ietf-yang-types module. The value Z is
904 equivalent to +00:00. The value -00:00 indicates an
905 unknown time-offset.";
906 reference
907 "<a href="./rfc6991">RFC 6991</a>: Common YANG Data Types";
908 }
909
910 /*
911 * Groupings
912 */
913
914 grouping registry-grouping {
915 description
916 "This grouping models a list of entries in a registry
917 that identify functions of a Task.";
918
919 list function {
920 key uri;
921 description
922 "A list of entries in a registry identifying functions.";
923
924 leaf uri {
925 type inet:uri;
926 description
927 "A URI identifying an entry in a registry.";
928 }
929
930 leaf-list role {
931 type string;
932 description
933 "A set of roles for the identified registry entry.";
934 }
935 }
936 }
937
938 grouping options-grouping {
939 description
940 "A list of options of a Task. Each option is a name/value
941 pair (where the value may be absent).";
942
943 list option {
944 key "id";
945
946
947
948 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
951
952
953 ordered-by user;
954 description
955 "A list of options passed to the Task. It is a list of
956 key/value pairs and may be used to model options.
957 Options may be used to identify the role of a Task
958 or to pass a Channel name to a Task.";
959
960 leaf id {
961 type lmap:identifier;
962 description
963 "An identifier uniquely identifying an option. This
964 identifier is required by YANG to uniquely identify
965 a name/value pair, but it otherwise has no semantic
966 value";
967 }
968
969 leaf name {
970 type string;
971 description
972 "The name of the option.";
973 }
974
975 leaf value {
976 type string;
977 description
978 "The value of the option.";
979 }
980 }
981 }
982 }
983 &lt;CODE ENDS&gt;
984
985 <span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. LMAP Control YANG Module</span>
986
987 This module imports definitions from [<a href="./rfc6536" title="&quot;Network Configuration Protocol (NETCONF) Access Control Model&quot;">RFC6536</a>], [<a href="./rfc6991" title="&quot;Common YANG Data Types&quot;">RFC6991</a>], and the
988 common LMAP module, and it references [<a href="./rfc7398" title="&quot;A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance&quot;">RFC7398</a>].
989
990 &lt;CODE BEGINS&gt; file "[email protected]"
991 module ietf-lmap-control {
992
993 yang-version 1.1;
994 namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-control";
995 prefix "lmapc";
996
997 import ietf-yang-types {
998 prefix yang;
999 }
1000 import ietf-netconf-acm {
1001
1002
1003
1004 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1007
1008
1009 prefix nacm;
1010 }
1011 import ietf-lmap-common {
1012 prefix lmap;
1013 }
1014
1015 organization
1016 "IETF Large-Scale Measurement of Broadband Performance
1017 Working Group";
1018
1019 contact
1020 "WG Web: &lt;<a href="https://datatracker.ietf.org/wg/lmap">https://datatracker.ietf.org/wg/lmap</a>&gt;
1021 WG List: &lt;mailto:[email protected]&gt;
1022
1023 Editor: Juergen Schoenwaelder
1024 &lt;[email protected]&gt;
1025
1026 Editor: Vaibhav Bajpai
1027 &lt;[email protected]&gt;";
1028
1029 description
1030 "This module defines a data model for controlling Measurement
1031 Agents that are part of a Large-Scale Measurement Platform
1032 (LMAP). This data model is expected to be implemented by
1033 Measurement Agents.";
1034
1035 revision "2017-08-08" {
1036 description
1037 "Initial version";
1038 reference
1039 "<a href="./rfc8194">RFC 8194</a>: A YANG Data Model for LMAP Measurement Agents";
1040 }
1041
1042 /*
1043 * Typedefs
1044 */
1045
1046 typedef event-ref {
1047 type leafref {
1048 path "/lmap/events/event/name";
1049 }
1050 description
1051 "This type is used by data models that need to reference
1052 a configured event source.";
1053 }
1054
1055 typedef task-ref {
1056 type leafref {
1057
1058
1059
1060 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1063
1064
1065 path "/lmap/tasks/task/name";
1066 }
1067 description
1068 "This type is used by data models that need to reference
1069 a configured Task.";
1070 }
1071
1072 typedef schedule-ref {
1073 type leafref {
1074 path "/lmap/schedules/schedule/name";
1075 }
1076 description
1077 "This type is used by data models that need to reference
1078 a configured Schedule.";
1079 }
1080
1081 /*
1082 * Groupings
1083 */
1084
1085 grouping start-end-grouping {
1086 description
1087 "A grouping that provides start and end times for
1088 Event objects.";
1089 leaf start {
1090 type yang:date-and-time;
1091 description
1092 "The date and time when the Event object
1093 starts to create triggers.";
1094 }
1095 leaf end {
1096 type yang:date-and-time;
1097 description
1098 "The date and time when the Event object
1099 stops to create triggers.
1100
1101 It is generally a good idea to always configure
1102 an end time and to refresh the end time as needed
1103 to ensure that agents that lose connectivity to
1104 their Controller do not continue executing Schedules
1105 forever.";
1106 }
1107 }
1108
1109 /*
1110 * Capability, configuration, and state data nodes
1111 */
1112
1113
1114
1115
1116 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1119
1120
1121 container lmap {
1122 description
1123 "Configuration and control of a Measurement Agent.";
1124
1125 container capabilities {
1126 config false;
1127 description
1128 "Agent capabilities including a list of supported Tasks.";
1129
1130 leaf version {
1131 type string;
1132 config false;
1133 mandatory true;
1134 description
1135 "A short description of the software implementing the
1136 Measurement Agent. This should include the version
1137 number of the Measurement Agent software.";
1138 }
1139
1140 leaf-list tag {
1141 type lmap:tag;
1142 config false;
1143 description
1144 "An optional unordered set of tags that provide
1145 additional information about the capabilities of
1146 the Measurement Agent.";
1147 }
1148
1149 container tasks {
1150 description
1151 "A list of Tasks that the Measurement Agent supports.";
1152
1153 list task {
1154 key name;
1155 description
1156 "The list of Tasks supported by the Measurement Agent.";
1157
1158 leaf name {
1159 type lmap:identifier;
1160 description
1161 "The unique name of a Task capability.";
1162 }
1163
1164 uses lmap:registry-grouping;
1165
1166 leaf version {
1167 type string;
1168
1169
1170
1171
1172 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1175
1176
1177 description
1178 "A short description of the software implementing
1179 the Task. This should include the version
1180 number of the Measurement Task software.";
1181 }
1182
1183 leaf program {
1184 type string;
1185 description
1186 "The (local) program to invoke in order to execute
1187 the Task.";
1188 }
1189 }
1190 }
1191 }
1192
1193 /*
1194 * Agent Configuration
1195 */
1196
1197 container agent {
1198 description
1199 "Configuration of parameters affecting the whole
1200 Measurement Agent.";
1201
1202 leaf agent-id {
1203 type yang:uuid;
1204 description
1205 "The agent-id identifies a Measurement Agent with
1206 a very low probability of collision. In certain
1207 deployments, the agent-id may be considered
1208 sensitive, and hence this object is optional.";
1209 }
1210
1211 leaf group-id {
1212 type string;
1213 description
1214 "The group-id identifies a group of Measurement
1215 Agents. In certain deployments, the group-id
1216 may be considered less sensitive than the
1217 agent-id.";
1218 }
1219
1220 leaf measurement-point {
1221 type string;
1222 description
1223 "The measurement point indicating where the
1224 Measurement Agent is located on a path.";
1225
1226
1227
1228 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1231
1232
1233 reference
1234 "<a href="./rfc7398">RFC 7398</a>: A Reference Path and Measurement Points
1235 for Large-Scale Measurement of Broadband
1236 Performance";
1237 }
1238
1239 leaf report-agent-id {
1240 type boolean;
1241 must '. != "true" or ../agent-id' {
1242 description
1243 "An agent-id must exist for this to be set
1244 to true.";
1245 }
1246 default false;
1247 description
1248 "The 'report-agent-id' controls whether the
1249 'agent-id' is reported to Collectors.";
1250 }
1251
1252 leaf report-group-id {
1253 type boolean;
1254 must '. != "true" or ../group-id' {
1255 description
1256 "A group-id must exist for this to be set
1257 to true.";
1258 }
1259 default false;
1260 description
1261 "The 'report-group-id' controls whether the
1262 'group-id' is reported to Collectors.";
1263 }
1264
1265 leaf report-measurement-point {
1266 type boolean;
1267 must '. != "true" or ../measurement-point' {
1268 description
1269 "A measurement-point must exist for this to be
1270 set to true.";
1271 }
1272 default false;
1273 description
1274 "The 'report-measurement-point' controls whether
1275 the 'measurement-point' is reported to Collectors.";
1276 }
1277
1278 leaf controller-timeout {
1279 type uint32;
1280 units "seconds";
1281
1282
1283
1284 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1287
1288
1289 description
1290 "A timer is started after each successful contact
1291 with a Controller. When the timer reaches the
1292 controller-timeout, an event (controller-lost) is
1293 raised indicating that connectivity to the Controller
1294 has been lost.";
1295 }
1296
1297 leaf last-started {
1298 type yang:date-and-time;
1299 config false;
1300 mandatory true;
1301 description
1302 "The date and time the Measurement Agent last started.";
1303 }
1304 }
1305
1306 /*
1307 * Task Configuration
1308 */
1309
1310 container tasks {
1311 description
1312 "Configuration of LMAP Tasks.";
1313
1314 list task {
1315 key name;
1316 description
1317 "The list of Tasks configured on the Measurement
1318 Agent. Note that a configured Task MUST resolve to a
1319 Task listed in the capabilities. Attempts to execute
1320 a configured Task that is not listed in the capabilities
1321 result in a runtime execution error.";
1322
1323 leaf name {
1324 type lmap:identifier;
1325 description
1326 "The unique name of a Task.";
1327 }
1328
1329 uses lmap:registry-grouping;
1330
1331 leaf program {
1332 type string;
1333 nacm:default-deny-write;
1334
1335
1336
1337
1338
1339
1340 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1343
1344
1345 description
1346 "The (local) program to invoke in order to execute
1347 the Task. If this leaf is not set, then the system
1348 will try to identify a suitable program based on
1349 the registry information present.";
1350 }
1351
1352 uses lmap:options-grouping {
1353 description
1354 "The list of Task-specific options.";
1355 }
1356
1357 leaf-list tag {
1358 type lmap:identifier;
1359 description
1360 "A set of Task-specific tags that are reported
1361 together with the measurement results to a Collector.
1362 A tag can be used, for example, to carry the
1363 Measurement Cycle ID.";
1364 }
1365 }
1366 }
1367
1368 /*
1369 * Schedule Instructions
1370 */
1371
1372 container schedules {
1373 description
1374 "Configuration of LMAP Schedules. Schedules control
1375 which Tasks are executed by the LMAP implementation.";
1376
1377 list schedule {
1378 key name;
1379 description
1380 "Configuration of a particular Schedule.";
1381
1382 leaf name {
1383 type lmap:identifier;
1384 description
1385 "The locally unique, administratively assigned name
1386 for this Schedule.";
1387 }
1388
1389 leaf start {
1390 type event-ref;
1391 mandatory true;
1392
1393
1394
1395
1396 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1399
1400
1401 description
1402 "The event source controlling the start of the
1403 scheduled Actions.";
1404 }
1405
1406 choice stop {
1407 description
1408 "This choice contains optional leafs that control the
1409 graceful forced termination of scheduled Actions.
1410 When the end has been reached, the scheduled Actions
1411 should be forced to terminate the measurements.
1412 This may involve being active some additional time in
1413 order to properly finish the Action's activity (e.g.,
1414 waiting for any messages that are still outstanding).";
1415
1416 leaf end {
1417 type event-ref;
1418 description
1419 "The event source controlling the graceful
1420 forced termination of the scheduled Actions.";
1421 }
1422
1423 leaf duration {
1424 type uint32;
1425 units "seconds";
1426 description
1427 "The duration controlling the graceful forced
1428 termination of the scheduled Actions.";
1429 }
1430 }
1431
1432 leaf execution-mode {
1433 type enumeration {
1434 enum sequential {
1435 value 1;
1436 description
1437 "The Actions of the Schedule are executed
1438 sequentially.";
1439 }
1440 enum parallel {
1441 value 2;
1442 description
1443 "The Actions of the Schedule are executed
1444 concurrently.";
1445 }
1446 enum pipelined {
1447 value 3;
1448
1449
1450
1451
1452 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1455
1456
1457 description
1458 "The Actions of the Schedule are executed in a
1459 pipelined mode. Output created by an Action is
1460 passed as input to the subsequent Action.";
1461 }
1462 }
1463 default pipelined;
1464 description
1465 "The execution mode of this Schedule determines in
1466 which order the Actions of the Schedule are executed.";
1467 }
1468
1469 leaf-list tag {
1470 type lmap:tag;
1471 description
1472 "A set of Schedule-specific tags that are reported
1473 together with the measurement results to a Collector.";
1474 }
1475
1476 leaf-list suppression-tag {
1477 type lmap:tag;
1478 description
1479 "A set of Suppression tags that are used to select
1480 Schedules to be suppressed.";
1481 }
1482
1483 leaf state {
1484 type enumeration {
1485 enum enabled {
1486 value 1;
1487 description
1488 "The value 'enabled' indicates that the
1489 Schedule is currently enabled.";
1490 }
1491 enum disabled {
1492 value 2;
1493 description
1494 "The value 'disabled' indicates that the
1495 Schedule is currently disabled.";
1496 }
1497 enum running {
1498 value 3;
1499 description
1500 "The value 'running' indicates that the
1501 Schedule is currently running.";
1502 }
1503 enum suppressed {
1504 value 4;
1505
1506
1507
1508 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1511
1512
1513 description
1514 "The value 'suppressed' indicates that the
1515 Schedule is currently suppressed.";
1516 }
1517 }
1518 config false;
1519 mandatory true;
1520 description
1521 "The current state of the Schedule.";
1522 }
1523
1524 leaf storage {
1525 type yang:gauge64;
1526 units "bytes";
1527 config false;
1528 mandatory true;
1529 description
1530 "The amount of secondary storage (e.g., allocated in a
1531 file system) holding temporary data allocated to the
1532 Schedule in bytes. This object reports the amount of
1533 allocated physical storage and not the storage used
1534 by logical data records.";
1535 }
1536
1537 leaf invocations {
1538 type yang:counter32;
1539 config false;
1540 mandatory true;
1541 description
1542 "Number of invocations of this Schedule. This counter
1543 does not include suppressed invocations or invocations
1544 that were prevented due to an overlap with a previous
1545 invocation of this Schedule.";
1546 }
1547
1548 leaf suppressions {
1549 type yang:counter32;
1550 config false;
1551 mandatory true;
1552 description
1553 "Number of suppressed executions of this Schedule.";
1554 }
1555
1556 leaf overlaps {
1557 type yang:counter32;
1558 config false;
1559 mandatory true;
1560
1561
1562
1563
1564 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1567
1568
1569 description
1570 "Number of executions prevented due to overlaps with
1571 a previous invocation of this Schedule.";
1572 }
1573
1574 leaf failures {
1575 type yang:counter32;
1576 config false;
1577 mandatory true;
1578 description
1579 "Number of failed executions of this Schedule. A
1580 failed execution is an execution where at least
1581 one Action failed.";
1582 }
1583
1584 leaf last-invocation {
1585 type yang:date-and-time;
1586 config false;
1587 description
1588 "The date and time of the last invocation of
1589 this Schedule.";
1590 }
1591
1592 list action {
1593 key name;
1594 description
1595 "An Action describes a Task that is invoked by the
1596 Schedule. Multiple Actions are invoked according to
1597 the execution-mode of the Schedule.";
1598
1599 leaf name {
1600 type lmap:identifier;
1601 description
1602 "The unique identifier for this Action.";
1603 }
1604
1605 leaf task {
1606 type task-ref;
1607 mandatory true;
1608 description
1609 "The Task invoked by this Action.";
1610 }
1611
1612 container parameters {
1613 description
1614 "This container is a placeholder for runtime
1615 parameters defined in Task-specific data models
1616 augmenting the base LMAP control data model.";
1617
1618
1619
1620 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1623
1624
1625 choice extension {
1626 description
1627 "This choice is provided to augment in different
1628 sets of parameters.";
1629 }
1630 }
1631
1632 uses lmap:options-grouping {
1633 description
1634 "The list of Action-specific options that are
1635 appended to the list of Task-specific options.";
1636 }
1637
1638 leaf-list destination {
1639 type schedule-ref;
1640 description
1641 "A set of Schedules receiving the output produced
1642 by this Action. The output is stored temporarily
1643 since the Destination Schedules will in general
1644 not be running when output is passed to them. The
1645 behavior of an Action passing data to its own
1646 Schedule is implementation specific.
1647
1648 Data passed to a sequential or pipelined Schedule
1649 is received by the Schedule's first Action. Data
1650 passed to a parallel Schedule is received by all
1651 Actions of the Schedule.";
1652 }
1653
1654 leaf-list tag {
1655 type lmap:tag;
1656 description
1657 "A set of Action-specific tags that are reported
1658 together with the measurement results to a
1659 Collector.";
1660 }
1661
1662 leaf-list suppression-tag {
1663 type lmap:tag;
1664 description
1665 "A set of Suppression tags that are used to select
1666 Actions to be suppressed.";
1667 }
1668
1669 leaf state {
1670 type enumeration {
1671 enum enabled {
1672 value 1;
1673
1674
1675
1676 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1679
1680
1681 description
1682 "The value 'enabled' indicates that the
1683 Action is currently enabled.";
1684 }
1685 enum disabled {
1686 value 2;
1687 description
1688 "The value 'disabled' indicates that the
1689 Action is currently disabled.";
1690 }
1691 enum running {
1692 value 3;
1693 description
1694 "The value 'running' indicates that the
1695 Action is currently running.";
1696 }
1697 enum suppressed {
1698 value 4;
1699 description
1700 "The value 'suppressed' indicates that the
1701 Action is currently suppressed.";
1702 }
1703 }
1704 config false;
1705 mandatory true;
1706 description
1707 "The current state of the Action.";
1708 }
1709
1710 leaf storage {
1711 type yang:gauge64;
1712 units "bytes";
1713 config false;
1714 mandatory true;
1715 description
1716 "The amount of secondary storage (e.g., allocated in a
1717 file system) holding temporary data allocated to the
1718 Schedule in bytes. This object reports the amount of
1719 allocated physical storage and not the storage used
1720 by logical data records.";
1721 }
1722
1723 leaf invocations {
1724 type yang:counter32;
1725 config false;
1726 mandatory true;
1727
1728
1729
1730
1731
1732 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1735
1736
1737 description
1738 "Number of invocations of this Action. This counter
1739 does not include suppressed invocations or invocations
1740 that were prevented due to an overlap with a previous
1741 invocation of this Action.";
1742 }
1743
1744 leaf suppressions {
1745 type yang:counter32;
1746 config false;
1747 mandatory true;
1748 description
1749 "Number of suppressed executions of this Action.";
1750 }
1751
1752 leaf overlaps {
1753 type yang:counter32;
1754 config false;
1755 mandatory true;
1756 description
1757 "Number of executions prevented due to overlaps with
1758 a previous invocation of this Action.";
1759 }
1760
1761 leaf failures {
1762 type yang:counter32;
1763 config false;
1764 mandatory true;
1765 description
1766 "Number of failed executions of this Action.";
1767 }
1768
1769 leaf last-invocation {
1770 type yang:date-and-time;
1771 config false;
1772 mandatory true;
1773 description
1774 "The date and time of the last invocation of
1775 this Action.";
1776 }
1777
1778 leaf last-completion {
1779 type yang:date-and-time;
1780 config false;
1781 mandatory true;
1782 description
1783 "The date and time of the last completion of
1784 this Action.";
1785
1786
1787
1788 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1791
1792
1793 }
1794
1795 leaf last-status {
1796 type lmap:status-code;
1797 config false;
1798 mandatory true;
1799 description
1800 "The status code returned by the last execution of
1801 this Action.";
1802 }
1803
1804 leaf last-message {
1805 type string;
1806 config false;
1807 mandatory true;
1808 description
1809 "The status message produced by the last execution
1810 of this Action.";
1811 }
1812
1813 leaf last-failed-completion {
1814 type yang:date-and-time;
1815 config false;
1816 mandatory true;
1817 description
1818 "The date and time of the last failed completion
1819 of this Action.";
1820 }
1821
1822 leaf last-failed-status {
1823 type lmap:status-code;
1824 config false;
1825 mandatory true;
1826 description
1827 "The status code returned by the last failed
1828 execution of this Action.";
1829 }
1830
1831 leaf last-failed-message {
1832 type string;
1833 config false;
1834 mandatory true;
1835 description
1836 "The status message produced by the last failed
1837 execution of this Action.";
1838 }
1839 }
1840 }
1841
1842
1843
1844 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1847
1848
1849 }
1850
1851 /*
1852 * Suppression Instructions
1853 */
1854
1855 container suppressions {
1856 description
1857 "Suppression information to prevent Schedules or
1858 certain Actions from starting.";
1859
1860 list suppression {
1861 key name;
1862 description
1863 "Configuration of a particular Suppression.";
1864
1865 leaf name {
1866 type lmap:identifier;
1867 description
1868 "The locally unique, administratively assigned name
1869 for this Suppression.";
1870 }
1871
1872 leaf start {
1873 type event-ref;
1874 description
1875 "The event source controlling the start of the
1876 Suppression period.";
1877 }
1878
1879 leaf end {
1880 type event-ref;
1881 description
1882 "The event source controlling the end of the
1883 Suppression period. If not present, Suppression
1884 continues indefinitely.";
1885 }
1886
1887 leaf-list match {
1888 type lmap:glob-pattern;
1889 description
1890 "A set of Suppression match patterns. The Suppression
1891 will apply to all Schedules (and their Actions) that
1892 have a matching value in their suppression-tags
1893 and to all Actions that have a matching value in
1894 their suppression-tags.";
1895 }
1896
1897
1898
1899
1900 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1903
1904
1905 leaf stop-running {
1906 type boolean;
1907 default false;
1908 description
1909 "If 'stop-running' is true, running Schedules and
1910 Actions matching the Suppression will be terminated
1911 when Suppression is activated. If 'stop-running' is
1912 false, running Schedules and Actions will not be
1913 affected if Suppression is activated.";
1914 }
1915
1916 leaf state {
1917 type enumeration {
1918 enum enabled {
1919 value 1;
1920 description
1921 "The value 'enabled' indicates that the
1922 Suppression is currently enabled.";
1923 }
1924 enum disabled {
1925 value 2;
1926 description
1927 "The value 'disabled' indicates that the
1928 Suppression is currently disabled.";
1929 }
1930 enum active {
1931 value 3;
1932 description
1933 "The value 'active' indicates that the
1934 Suppression is currently active.";
1935 }
1936 }
1937 config false;
1938 mandatory true;
1939 description
1940 "The current state of the Suppression.";
1941 }
1942 }
1943 }
1944
1945 /*
1946 * Event Instructions
1947 */
1948
1949 container events {
1950 description
1951 "Configuration of LMAP events.
1952
1953
1954
1955
1956 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
1959
1960
1961 Implementations may be forced to delay acting
1962 upon the occurrence of events in the face of local
1963 constraints. An Action triggered by an event
1964 therefore should not rely on the accuracy
1965 provided by the scheduler implementation.";
1966
1967 list event {
1968 key name;
1969 description
1970 "The list of event sources configured on the
1971 Measurement Agent.";
1972
1973 leaf name {
1974 type lmap:identifier;
1975 description
1976 "The unique name of an event source.";
1977 }
1978
1979 leaf random-spread {
1980 type uint32;
1981 units seconds;
1982 description
1983 "This optional leaf adds a random spread to the
1984 computation of the event's trigger time. The
1985 random spread is a uniformly distributed random
1986 number taken from the interval [0:random-spread].";
1987 }
1988
1989 leaf cycle-interval {
1990 type uint32;
1991 units seconds;
1992 description
1993 "The optional cycle-interval defines the duration
1994 of the time interval in seconds that is used to
1995 calculate cycle numbers. No cycle number is
1996 calculated if the optional cycle-interval does
1997 not exist.";
1998 }
1999
2000 choice event-type {
2001 description
2002 "Different types of events are handled by
2003 different branches of this choice. Note that
2004 this choice can be extended via augmentations.";
2005
2006 case periodic {
2007 container periodic {
2008
2009
2010
2011
2012 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2015
2016
2017 description
2018 "A periodic timing object triggers periodically
2019 according to a regular interval.";
2020
2021 leaf interval {
2022 type uint32 {
2023 range "1..max";
2024 }
2025 units "seconds";
2026 mandatory true;
2027 description
2028 "The number of seconds between two triggers
2029 generated by this periodic timing object.";
2030 }
2031 uses start-end-grouping;
2032 }
2033 }
2034
2035 case calendar {
2036 container calendar {
2037 description
2038 "A calendar timing object triggers based on the
2039 current calendar date and time.";
2040
2041 leaf-list month {
2042 type lmap:month-or-all;
2043 min-elements 1;
2044 description
2045 "A set of months at which this calendar timing
2046 will trigger. The wildcard means all months.";
2047 }
2048
2049 leaf-list day-of-month {
2050 type lmap:day-of-months-or-all;
2051 min-elements 1;
2052 description
2053 "A set of days of the month at which this
2054 calendar timing will trigger. The wildcard means
2055 all days of a month.";
2056 }
2057
2058 leaf-list day-of-week {
2059 type lmap:weekday-or-all;
2060 min-elements 1;
2061 description
2062 "A set of weekdays at which this calendar timing
2063 will trigger. The wildcard means all weekdays.";
2064 }
2065
2066
2067
2068 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2071
2072
2073 leaf-list hour {
2074 type lmap:hour-or-all;
2075 min-elements 1;
2076 description
2077 "A set of hours at which this calendar timing will
2078 trigger. The wildcard means all hours of a day.";
2079 }
2080
2081 leaf-list minute {
2082 type lmap:minute-or-all;
2083 min-elements 1;
2084 description
2085 "A set of minutes at which this calendar timing
2086 will trigger. The wildcard means all minutes of
2087 an hour.";
2088 }
2089
2090 leaf-list second {
2091 type lmap:second-or-all;
2092 min-elements 1;
2093 description
2094 "A set of seconds at which this calendar timing
2095 will trigger. The wildcard means all seconds of
2096 a minute.";
2097 }
2098
2099 leaf timezone-offset {
2100 type lmap:timezone-offset;
2101 description
2102 "The time zone in which this calendar timing
2103 object will be evaluated. If not present,
2104 the system's local time zone will be used.";
2105 }
2106 uses start-end-grouping;
2107 }
2108 }
2109
2110 case one-off {
2111 container one-off {
2112 description
2113 "A one-off timing object triggers exactly once.";
2114
2115 leaf time {
2116 type yang:date-and-time;
2117 mandatory true;
2118 description
2119 "This one-off timing object triggers once at
2120 the configured date and time.";
2121
2122
2123
2124 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2127
2128
2129 }
2130 }
2131 }
2132
2133 case immediate {
2134 leaf immediate {
2135 type empty;
2136 mandatory true;
2137 description
2138 "This immediate Event object triggers immediately
2139 when it is configured.";
2140 }
2141 }
2142
2143 case startup {
2144 leaf startup {
2145 type empty;
2146 mandatory true;
2147 description
2148 "This startup Event object triggers whenever the
2149 Measurement Agent (re)starts.";
2150 }
2151 }
2152
2153 case controller-lost {
2154 leaf controller-lost {
2155 type empty;
2156 mandatory true;
2157 description
2158 "The controller-lost Event object triggers when
2159 the connectivity to the Controller has been lost
2160 for at least 'controller-timeout' seconds.";
2161 }
2162 }
2163
2164 case controller-connected {
2165 leaf controller-connected {
2166 type empty;
2167 mandatory true;
2168 description
2169 "The controller-connected Event object triggers
2170 when the connectivity to the Controller has been
2171 restored after it was lost for at least
2172 'controller-timeout' seconds.";
2173 }
2174 }
2175 }
2176
2177
2178
2179
2180 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2183
2184
2185 }
2186 }
2187 }
2188 }
2189 &lt;CODE ENDS&gt;
2190
2191 <span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. LMAP Report YANG Module</span>
2192
2193 This module imports definitions from [<a href="./rfc6536" title="&quot;Network Configuration Protocol (NETCONF) Access Control Model&quot;">RFC6536</a>] and the common LMAP
2194 module.
2195
2196 &lt;CODE BEGINS&gt; file "[email protected]"
2197 module ietf-lmap-report {
2198
2199 yang-version 1.1;
2200 namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-report";
2201 prefix "lmapr";
2202
2203 import ietf-yang-types {
2204 prefix yang;
2205 }
2206 import ietf-lmap-common {
2207 prefix lmap;
2208 }
2209
2210 organization
2211 "IETF Large-Scale Measurement of Broadband Performance
2212 Working Group";
2213
2214 contact
2215 "WG Web: &lt;<a href="https://datatracker.ietf.org/wg/lmap">https://datatracker.ietf.org/wg/lmap</a>&gt;
2216 WG List: &lt;mailto:[email protected]&gt;
2217
2218 Editor: Juergen Schoenwaelder
2219 &lt;[email protected]&gt;
2220
2221 Editor: Vaibhav Bajpai
2222 &lt;[email protected]&gt;";
2223
2224 description
2225 "This module defines a data model for reporting results from
2226 Measurement Agents, which are part of a Large-Scale Measurement
2227 Platform (LMAP), to result data Collectors. This data model is
2228 expected to be implemented by a Collector.";
2229
2230 revision "2017-08-08" {
2231 description
2232 "Initial version";
2233
2234
2235
2236 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2239
2240
2241 reference
2242 "<a href="./rfc8194">RFC 8194</a>: A YANG Data Model for LMAP Measurement Agents";
2243 }
2244
2245 rpc report {
2246 description
2247 "The report operation is used by a Measurement Agent to
2248 submit measurement results produced by Measurement Tasks to
2249 a Collector.";
2250
2251 input {
2252
2253 leaf date {
2254 type yang:date-and-time;
2255 mandatory true;
2256 description
2257 "The date and time when this result report was sent to
2258 a Collector.";
2259 }
2260
2261 leaf agent-id {
2262 type yang:uuid;
2263 description
2264 "The agent-id of the agent from which this
2265 report originates.";
2266 }
2267
2268 leaf group-id {
2269 type string;
2270 description
2271 "The group-id of the agent from which this
2272 report originates.";
2273 }
2274
2275 leaf measurement-point {
2276 type string;
2277 description
2278 "The measurement-point of the agent from which this
2279 report originates.";
2280 }
2281
2282 list result {
2283 description
2284 "The list of Tasks for which results are reported.";
2285
2286 leaf schedule {
2287 type lmap:identifier;
2288
2289
2290
2291
2292 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 41]</span></pre>
2293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
2294 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2295
2296
2297 description
2298 "The name of the Schedule that produced the result.";
2299 }
2300
2301 leaf action {
2302 type lmap:identifier;
2303 description
2304 "The name of the Action in the Schedule that produced
2305 the result.";
2306 }
2307
2308 leaf task {
2309 type lmap:identifier;
2310 description
2311 "The name of the Task that produced the result.";
2312 }
2313
2314 container parameters {
2315 description
2316 "This container is a placeholder for runtime
2317 parameters defined in Task-specific data models
2318 augmenting the base LMAP report data model.";
2319
2320 choice extension {
2321 description
2322 "This choice is provided to augment in different
2323 sets of parameters.";
2324 }
2325 }
2326
2327 uses lmap:options-grouping {
2328 description
2329 "The list of options there were in use when the
2330 measurement was performed. This list must include
2331 both the Task-specific options as well as the
2332 Action-specific options.";
2333 }
2334
2335 leaf-list tag {
2336 type lmap:tag;
2337 description
2338 "A tag contains additional information that is passed
2339 with the result record to the Collector. This is the
2340 joined set of tags defined for the Task object, the
2341 Schedule object, and the Action object. A tag can be
2342 used to carry the Measurement Cycle ID.";
2343 }
2344
2345
2346
2347
2348 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 42]</span></pre>
2349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
2350 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2351
2352
2353 leaf event {
2354 type yang:date-and-time;
2355 description
2356 "The date and time of the event that triggered the
2357 Schedule of the Action that produced the reported
2358 result values. The date and time does not include
2359 any added randomization.";
2360 }
2361
2362 leaf start {
2363 type yang:date-and-time;
2364 mandatory true;
2365 description
2366 "The date and time when the Task producing
2367 this result started.";
2368 }
2369
2370 leaf end {
2371 type yang:date-and-time;
2372 description
2373 "The date and time when the Task producing
2374 this result finished.";
2375 }
2376
2377 leaf cycle-number {
2378 type lmap:cycle-number;
2379 description
2380 "The optional cycle number is the time closest to
2381 the time reported in the event leaf that is a multiple
2382 of the cycle-interval of the event that triggered the
2383 execution of the Schedule. The value is only present
2384 if the event that triggered the execution of the
2385 Schedule has a defined cycle-interval.";
2386 }
2387
2388 leaf status {
2389 type lmap:status-code;
2390 mandatory true;
2391 description
2392 "The status code returned by the execution of this
2393 Action.";
2394 }
2395
2396 list conflict {
2397 description
2398 "The names of Tasks overlapping with the execution
2399 of the Task that has produced this result.";
2400
2401
2402
2403
2404 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 43]</span></pre>
2405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
2406 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2407
2408
2409 leaf schedule-name {
2410 type lmap:identifier;
2411 description
2412 "The name of a Schedule that might have impacted
2413 the execution of the Task that has produced this
2414 result.";
2415 }
2416
2417 leaf action-name {
2418 type lmap:identifier;
2419 description
2420 "The name of an Action within the Schedule that
2421 might have impacted the execution of the Task that
2422 has produced this result.";
2423 }
2424
2425 leaf task-name {
2426 type lmap:identifier;
2427 description
2428 "The name of the Task executed by an Action within
2429 the Schedule that might have impacted the execution
2430 of the Task that has produced this result.";
2431 }
2432 }
2433
2434 list table {
2435 description
2436 "A list of result tables.";
2437
2438 uses lmap:registry-grouping;
2439
2440 leaf-list column {
2441 type string;
2442 description
2443 "An ordered list of column labels. The order is
2444 determined by the system and must match the order
2445 of the columns in the result rows.";
2446 }
2447
2448 list row {
2449 description
2450 "The rows of a result table.";
2451
2452 leaf-list value {
2453 type string;
2454 description
2455 "The value of a cell in the result row.";
2456 }
2457
2458
2459
2460 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 44]</span></pre>
2461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
2462 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2463
2464
2465 }
2466 }
2467 }
2468 }
2469 }
2470 }
2471 &lt;CODE ENDS&gt;
2472
2473 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span>
2474
2475 The YANG module defined in this document is designed to be accessed
2476 via network management protocols such as NETCONF [<a href="./rfc6241" title="&quot;Network Configuration Protocol (NETCONF)&quot;">RFC6241</a>] or
2477 RESTCONF [<a href="./rfc8040" title="&quot;RESTCONF Protocol&quot;">RFC8040</a>]. The lowest NETCONF layer is the secure transport
2478 layer, and the mandatory-to-implement secure transport is Secure
2479 Shell (SSH) [<a href="./rfc6242" title="&quot;Using the NETCONF Protocol over Secure Shell (SSH)&quot;">RFC6242</a>]. The lowest RESTCONF layer is HTTPS, and the
2480 mandatory-to-implement secure transport is Transport Layer Security
2481 (TLS) [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>].
2482
2483 The NETCONF access control model [<a href="./rfc6536" title="&quot;Network Configuration Protocol (NETCONF) Access Control Model&quot;">RFC6536</a>] provides the means to
2484 restrict access for particular NETCONF or RESTCONF users to a
2485 preconfigured subset of all available NETCONF or RESTCONF protocol
2486 operations and content.
2487
2488 There are a number of data nodes defined in this YANG module that are
2489 writable/creatable/deletable (i.e., config true, which is the
2490 default). These data nodes may be considered sensitive or vulnerable
2491 in some network environments. Write operations (e.g., edit-config)
2492 to these data nodes without proper protection can have a negative
2493 effect on network operations. These are the subtrees and data nodes
2494 and their sensitivity/vulnerability:
2495
2496 /lmap/agent This subtree configures general properties of
2497 the Measurement Agent such as its identity,
2498 measurement point, or Controller timeout. This
2499 subtree should only have write access for the
2500 system responsible for configuring the
2501 Measurement Agent.
2502
2503 /lmap/tasks This subtree configures the Tasks that can be
2504 invoked by a Controller. This subtree should
2505 only have write access for the system
2506 responsible for configuring the Measurement
2507 Agent. Care must be taken to not expose Tasks
2508 to a Controller that can cause damage to the
2509 system or the network.
2510
2511
2512
2513
2514
2515
2516 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 45]</span></pre>
2517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
2518 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2519
2520
2521 /lmap/schedules This subtree is used by a Controller to define
2522 the Schedules and Actions that are executed
2523 when certain events occur. Unauthorized access
2524 can cause unwanted load on the device or
2525 network, or it might direct measurement traffic
2526 to targets that become victims of an attack.
2527
2528 /lmap/suppressions This subtree is used by a Controller to define
2529 Suppressions that can temporarily disable the
2530 execution of Schedules or Actions.
2531 Unauthorized access can either disable
2532 measurements that should normally take place or
2533 cause measurements to take place during times
2534 when normally no measurements should take
2535 place.
2536
2537 /lmap/events This subtree is used by a Controller to define
2538 events that trigger the execution of Schedules
2539 and Actions. Unauthorized access can either
2540 disable measurements that should normally take
2541 place or cause measurements to take place
2542 during times when normally no measurements
2543 should take place or at a frequency that is
2544 higher than normally expected.
2545
2546 Some of the readable data nodes in this YANG module may be considered
2547 sensitive or vulnerable in some network environments. It is thus
2548 important to control read access (e.g., via get, get-config, or
2549 notification) to these data nodes. These are the subtrees and data
2550 nodes and their sensitivity/vulnerability:
2551
2552 /lmap/agent This subtree provides information about the
2553 Measurement Agent. This information may be
2554 used to select specific targets for attacks.
2555
2556 /lmap/capabilities This subtree provides information about the
2557 capabilities of the Measurement Agent,
2558 including its software version number and the
2559 Tasks that it supports. This information may
2560 be used to execute targeted attacks against
2561 specific implementations.
2562
2563 /lmap/schedules This subtree provides information about the
2564 Schedules and their associated Actions executed
2565 on the Measurement Agent. This information may
2566 be used to check whether attacks against the
2567 implementation are effective.
2568
2569
2570
2571
2572 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 46]</span></pre>
2573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
2574 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2575
2576
2577 /lmap/suppressions This subtree provides information about the
2578 Suppressions that can be active on the
2579 Measurement Agent. This information may be
2580 used to predict time periods where measurements
2581 take place (or do not take place).
2582
2583 Some of the RPC operations in this YANG module may be considered
2584 sensitive or vulnerable in some network environments. It is thus
2585 important to control access to these operations. These are the
2586 operations and their sensitivity/vulnerability:
2587
2588 /report The report operation is used to send locally collected
2589 measurement results to a remote Collector. Unauthorized
2590 access may leak measurement results, including those from
2591 passive measurements.
2592
2593 The data model uses a number of identifiers that are set by the
2594 Controller. Implementors may find these identifiers useful for the
2595 identification of resources, e.g., to identify objects in a file
2596 system providing temporary storage. Since the identifiers used by
2597 the YANG data model may allow characters that may be given special
2598 interpretation in a specific context, implementations must ensure
2599 that identifiers are properly mapped into safe identifiers.
2600
2601 The data model allows specifying options in the form of name/value
2602 pairs that are passed to programs. Implementors ought to take care
2603 that option names and values are passed literally to programs. In
2604 particular, shell expansions that may alter option names and values
2605 must not be performed.
2606
2607 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span>
2608
2609 This document registers three URIs in the "IETF XML Registry"
2610 [<a href="./rfc3688" title="&quot;The IETF XML Registry&quot;">RFC3688</a>]. Following the format in <a href="./rfc3688">RFC 3688</a>, the following
2611 registrations have been made.
2612
2613 URI: urn:ietf:params:xml:ns:yang:ietf-lmap-common
2614 Registrant Contact: The IESG.
2615 XML: N/A; the requested URI is an XML namespace.
2616
2617 URI: urn:ietf:params:xml:ns:yang:ietf-lmap-control
2618 Registrant Contact: The IESG.
2619 XML: N/A; the requested URI is an XML namespace.
2620
2621 URI: urn:ietf:params:xml:ns:yang:ietf-lmap-report
2622 Registrant Contact: The IESG.
2623 XML: N/A; the requested URI is an XML namespace.
2624
2625
2626
2627
2628 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 47]</span></pre>
2629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
2630 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2631
2632
2633 This document registers three YANG modules in the "YANG Module Names"
2634 registry [<a href="./rfc6020" title="&quot;YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)&quot;">RFC6020</a>].
2635
2636 Name: ietf-lmap-common
2637 Namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-common
2638 Prefix: lmap
2639 Reference: <a href="./rfc8194">RFC 8194</a>
2640
2641 Name: ietf-lmap-control
2642 Namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-control
2643 Prefix: lmapc
2644 Reference: <a href="./rfc8194">RFC 8194</a>
2645
2646 Name: ietf-lmap-report
2647 Namespace: urn:ietf:params:xml:ns:yang:ietf-lmap-report
2648 Prefix: lmapr
2649 Reference: <a href="./rfc8194">RFC 8194</a>
2650
2651 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
2652
2653 <span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span>
2654
2655 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
2656 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
2657 DOI 10.17487/RFC2119, March 1997,
2658 &lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;.
2659
2660 [<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer Security
2661 (TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>,
2662 DOI 10.17487/RFC5246, August 2008,
2663 &lt;<a href="https://www.rfc-editor.org/info/rfc5246">https://www.rfc-editor.org/info/rfc5246</a>&gt;.
2664
2665 [<a id="ref-RFC6020">RFC6020</a>] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
2666 the Network Configuration Protocol (NETCONF)", <a href="./rfc6020">RFC 6020</a>,
2667 DOI 10.17487/RFC6020, October 2010,
2668 &lt;<a href="https://www.rfc-editor.org/info/rfc6020">https://www.rfc-editor.org/info/rfc6020</a>&gt;.
2669
2670 [<a id="ref-RFC6241">RFC6241</a>] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
2671 and A. Bierman, Ed., "Network Configuration Protocol
2672 (NETCONF)", <a href="./rfc6241">RFC 6241</a>, DOI 10.17487/RFC6241, June 2011,
2673 &lt;<a href="https://www.rfc-editor.org/info/rfc6241">https://www.rfc-editor.org/info/rfc6241</a>&gt;.
2674
2675 [<a id="ref-RFC6242">RFC6242</a>] Wasserman, M., "Using the NETCONF Protocol over Secure
2676 Shell (SSH)", <a href="./rfc6242">RFC 6242</a>, DOI 10.17487/RFC6242, June 2011,
2677 &lt;<a href="https://www.rfc-editor.org/info/rfc6242">https://www.rfc-editor.org/info/rfc6242</a>&gt;.
2678
2679
2680
2681
2682
2683
2684 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 48]</span></pre>
2685 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
2686 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2687
2688
2689 [<a id="ref-RFC6536">RFC6536</a>] Bierman, A. and M. Bjorklund, "Network Configuration
2690 Protocol (NETCONF) Access Control Model", <a href="./rfc6536">RFC 6536</a>,
2691 DOI 10.17487/RFC6536, March 2012,
2692 &lt;<a href="https://www.rfc-editor.org/info/rfc6536">https://www.rfc-editor.org/info/rfc6536</a>&gt;.
2693
2694 [<a id="ref-RFC6991">RFC6991</a>] Schoenwaelder, J., Ed., "Common YANG Data Types",
2695 <a href="./rfc6991">RFC 6991</a>, DOI 10.17487/RFC6991, July 2013,
2696 &lt;<a href="https://www.rfc-editor.org/info/rfc6991">https://www.rfc-editor.org/info/rfc6991</a>&gt;.
2697
2698 [<a id="ref-RFC7950">RFC7950</a>] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
2699 <a href="./rfc7950">RFC 7950</a>, DOI 10.17487/RFC7950, August 2016,
2700 &lt;<a href="https://www.rfc-editor.org/info/rfc7950">https://www.rfc-editor.org/info/rfc7950</a>&gt;.
2701
2702 [<a id="ref-RFC8040">RFC8040</a>] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
2703 Protocol", <a href="./rfc8040">RFC 8040</a>, DOI 10.17487/RFC8040, January 2017,
2704 &lt;<a href="https://www.rfc-editor.org/info/rfc8040">https://www.rfc-editor.org/info/rfc8040</a>&gt;.
2705
2706 [<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in <a href="./rfc2119">RFC</a>
2707 <a href="./rfc2119">2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>, DOI 10.17487/RFC8174,
2708 May 2017, &lt;<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>&gt;.
2709
2710 [<a id="ref-RFC8193">RFC8193</a>] Burbridge, T., Eardley, P., Bagnulo, M., and J.
2711 Schoenwaelder, "Information Model for Large-Scale
2712 Measurement Platforms (LMAPs)", DOI 10.17487/RFC8193,
2713 <a href="./rfc8193">RFC 8193</a>, August 2017,
2714 &lt;<a href="http://www.rfc-editor.org/info/rfc8193">http://www.rfc-editor.org/info/rfc8193</a>&gt;.
2715
2716 <span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span>
2717
2718 [<a id="ref-ISO-8601">ISO-8601</a>]
2719 International Organization for Standardization, "Data
2720 elements and interchange formats -- Information
2721 interchange -- Representation of dates and times", ISO
2722 Standard 8601:2004, December 2004.
2723
2724 [<a id="ref-NETCONF-CLIENT-SERVER">NETCONF-CLIENT-SERVER</a>]
2725 Watsen, K., Wu, G., and J. Schoenwaelder, "NETCONF Client
2726 and Server Models", Work in Progress, <a href="./draft-ietf-netconf-netconf-client-server-04">draft-ietf-netconf-</a>
2727 <a href="./draft-ietf-netconf-netconf-client-server-04">netconf-client-server-04</a>, July 2017.
2728
2729 [<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
2730 DOI 10.17487/RFC3688, January 2004,
2731 &lt;<a href="https://www.rfc-editor.org/info/rfc3688">https://www.rfc-editor.org/info/rfc3688</a>&gt;.
2732
2733 [<a id="ref-RFC5424">RFC5424</a>] Gerhards, R., "The Syslog Protocol", <a href="./rfc5424">RFC 5424</a>,
2734 DOI 10.17487/RFC5424, March 2009,
2735 &lt;<a href="https://www.rfc-editor.org/info/rfc5424">https://www.rfc-editor.org/info/rfc5424</a>&gt;.
2736
2737
2738
2739
2740 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 49]</span></pre>
2741 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
2742 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2743
2744
2745 [<a id="ref-RFC7223">RFC7223</a>] Bjorklund, M., "A YANG Data Model for Interface
2746 Management", <a href="./rfc7223">RFC 7223</a>, DOI 10.17487/RFC7223, May 2014,
2747 &lt;<a href="https://www.rfc-editor.org/info/rfc7223">https://www.rfc-editor.org/info/rfc7223</a>&gt;.
2748
2749 [<a id="ref-RFC7317">RFC7317</a>] Bierman, A. and M. Bjorklund, "A YANG Data Model for
2750 System Management", <a href="./rfc7317">RFC 7317</a>, DOI 10.17487/RFC7317, August
2751 2014, &lt;<a href="https://www.rfc-editor.org/info/rfc7317">https://www.rfc-editor.org/info/rfc7317</a>&gt;.
2752
2753 [<a id="ref-RFC7398">RFC7398</a>] Bagnulo, M., Burbridge, T., Crawford, S., Eardley, P., and
2754 A. Morton, "A Reference Path and Measurement Points for
2755 Large-Scale Measurement of Broadband Performance",
2756 <a href="./rfc7398">RFC 7398</a>, DOI 10.17487/RFC7398, February 2015,
2757 &lt;<a href="https://www.rfc-editor.org/info/rfc7398">https://www.rfc-editor.org/info/rfc7398</a>&gt;.
2758
2759 [<a id="ref-RFC7594">RFC7594</a>] Eardley, P., Morton, A., Bagnulo, M., Burbridge, T.,
2760 Aitken, P., and A. Akhter, "A Framework for Large-Scale
2761 Measurement of Broadband Performance (LMAP)", <a href="./rfc7594">RFC 7594</a>,
2762 DOI 10.17487/RFC7594, September 2015,
2763 &lt;<a href="https://www.rfc-editor.org/info/rfc7594">https://www.rfc-editor.org/info/rfc7594</a>&gt;.
2764
2765 [<a id="ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>]
2766 Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and
2767 F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
2768 Edition)", World Wide Web Consortium Recommendation REC-
2769 xml-20081126, November 2008,
2770 &lt;<a href="http://www.w3.org/TR/2008/REC-xml-20081126">http://www.w3.org/TR/2008/REC-xml-20081126</a>&gt;.
2771
2772 [<a id="ref-YANG-HARDWARE">YANG-HARDWARE</a>]
2773 Bierman, A., Bjorklund, M., Dong, J., and D. Romascanu, "A
2774 YANG Data Model for Hardware Management", Work in
2775 Progress, <a href="./draft-ietf-netmod-entity-03">draft-ietf-netmod-entity-03</a>, March 2017.
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 50]</span></pre>
2797 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
2798 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2799
2800
2801 <span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Example Parameter Extension Module</span>
2802
2803 Sometimes Tasks may require complicated parameters that cannot easily
2804 be fit into options, i.e., a list of name/value pairs. In such a
2805 situation, it is possible to augment the ietf-lmap-control.yang and
2806 ietf-lmap-report.yang data models with definitions for more complex
2807 parameters. The following example module demonstrates this idea
2808 using the parameters of UDP latency metrics as an example (although
2809 UDP latency metric parameters do not really need such an extension
2810 module).
2811
2812 module example-ietf-ippm-udp-latency {
2813
2814 namespace "urn:example:ietf-ippm-udp-latency";
2815 prefix "ippm-udp-latency";
2816
2817 import ietf-inet-types {
2818 prefix inet;
2819 }
2820 import ietf-lmap-control {
2821 prefix "lmapc";
2822 }
2823 import ietf-lmap-report {
2824 prefix "lmapr";
2825 }
2826
2827 grouping ippm-udp-latency-parameter-grouping {
2828 leaf src-ip {
2829 type inet:ip-address;
2830 description
2831 "The source IP address of the UDP measurement traffic.";
2832 }
2833
2834 leaf src-port {
2835 type inet:port-number;
2836 description
2837 "The source port number of the UDP measurement traffic.";
2838 }
2839
2840 leaf dst-ip {
2841 type inet:ip-address;
2842 description
2843 "The destination IP address of the UDP measurement traffic.";
2844 }
2845
2846
2847
2848
2849
2850
2851
2852 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 51]</span></pre>
2853 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
2854 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2855
2856
2857 leaf dst-port {
2858 type inet:port-number;
2859 description
2860 "The destination port number of the UDP measurement traffic.";
2861 }
2862
2863 leaf poisson-lambda {
2864 type decimal64 {
2865 fraction-digits 4;
2866 }
2867 units "seconds";
2868 default 1.0000;
2869 description
2870 "The average interval for the poisson stream with a resolution
2871 of 0.0001 seconds (0.1 ms).";
2872 }
2873
2874 leaf poisson-limit {
2875 type decimal64 {
2876 fraction-digits 4;
2877 }
2878 units "seconds";
2879 default 30.0000;
2880 description
2881 "The upper limit on the poisson distribution with a resolution
2882 of 0.0001 seconds (0.1 ms).";
2883 }
2884 }
2885
2886 augment "/lmapc:lmap/lmapc:schedules/lmapc:schedule/lmapc:action"
2887 + "/lmapc:parameters/lmapc:extension" {
2888 description
2889 "This augmentation adds parameters specific to IP Performance
2890 Metrics (IPPM) and UDP latency metrics to Actions.";
2891
2892 case "ietf-ippm-udp-latency" {
2893 uses ippm-udp-latency-parameter-grouping;
2894 }
2895 }
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 52]</span></pre>
2909 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
2910 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2911
2912
2913 augment "/lmapr:report/lmapr:input/lmapr:result"
2914 + "/lmapr:parameters/lmapr:extension" {
2915 description
2916 "This augmentation adds parameters specific to IPPM and
2917 UDP latency metrics to reports.";
2918
2919 case "ietf-ippm-udp-latency" {
2920 uses ippm-udp-latency-parameter-grouping;
2921 }
2922 }
2923
2924 }
2925
2926 <span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Example Configuration</span>
2927
2928 The configuration below is in XML [<a href="#ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>].
2929
2930 &lt;config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"&gt;
2931 &lt;lmap xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-control"&gt;
2932
2933 &lt;agent&gt;
2934 &lt;agent-id&gt;550e8400-e29b-41d4-a716-446655440000&lt;/agent-id&gt;
2935 &lt;report-agent-id&gt;true&lt;/report-agent-id&gt;
2936 &lt;/agent&gt;
2937
2938 &lt;schedules&gt;
2939 &lt;!-- The Schedule S1 first updates a list of ping targets
2940 and subsequently sends a ping to all targets. --&gt;
2941 &lt;schedule&gt;
2942 &lt;name&gt;S1&lt;/name&gt;
2943 &lt;start&gt;E1&lt;/start&gt;
2944 &lt;execution-mode&gt;sequential&lt;/execution-mode&gt;
2945 &lt;action&gt;
2946 &lt;name&gt;A1&lt;/name&gt;
2947 &lt;task&gt;update-ping-targets&lt;/task&gt;
2948 &lt;/action&gt;
2949 &lt;action&gt;
2950 &lt;name&gt;A2&lt;/name&gt;
2951 &lt;task&gt;ping-all-targets&lt;/task&gt;
2952 &lt;destination&gt;S3&lt;/destination&gt;
2953 &lt;/action&gt;
2954 &lt;suppression-tag&gt;measurement:ping&lt;/suppression-tag&gt;
2955 &lt;/schedule&gt;
2956 &lt;!-- The Schedule S2 executes two traceroutes concurrently. --&gt;
2957 &lt;schedule&gt;
2958 &lt;name&gt;S2&lt;/name&gt;
2959 &lt;start&gt;E1&lt;/start&gt;
2960 &lt;execution-mode&gt;parallel&lt;/execution-mode&gt;
2961
2962
2963
2964 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 53]</span></pre>
2965 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
2966 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
2967
2968
2969 &lt;action&gt;
2970 &lt;name&gt;A1&lt;/name&gt;
2971 &lt;task&gt;traceroute&lt;/task&gt;
2972 &lt;option&gt;
2973 &lt;id&gt;target&lt;/id&gt;
2974 &lt;name&gt;target&lt;/name&gt;
2975 &lt;value&gt;2001:db8::1&lt;/value&gt;
2976 &lt;/option&gt;
2977 &lt;destination&gt;S3&lt;/destination&gt;
2978 &lt;/action&gt;
2979 &lt;action&gt;
2980 &lt;name&gt;A2&lt;/name&gt;
2981 &lt;task&gt;traceroute&lt;/task&gt;
2982 &lt;option&gt;
2983 &lt;id&gt;target&lt;/id&gt;
2984 &lt;name&gt;target&lt;/name&gt;
2985 &lt;value&gt;2001:db8::2&lt;/value&gt;
2986 &lt;/option&gt;
2987 &lt;destination&gt;S3&lt;/destination&gt;
2988 &lt;/action&gt;
2989 &lt;suppression-tag&gt;measurement:traceroute&lt;/suppression-tag&gt;
2990 &lt;/schedule&gt;
2991 &lt;!-- The Schedule S3 sends measurement data to a Collector. --&gt;
2992 &lt;schedule&gt;
2993 &lt;name&gt;S3&lt;/name&gt;
2994 &lt;start&gt;E2&lt;/start&gt;
2995 &lt;action&gt;
2996 &lt;name&gt;A1&lt;/name&gt;
2997 &lt;task&gt;report&lt;/task&gt;
2998 &lt;option&gt;
2999 &lt;id&gt;collector&lt;/id&gt;
3000 &lt;name&gt;collector&lt;/name&gt;
3001 &lt;value&gt;https://collector.example.com/&lt;/value&gt;
3002 &lt;/option&gt;
3003 &lt;/action&gt;
3004 &lt;/schedule&gt;
3005 &lt;/schedules&gt;
3006
3007 &lt;suppressions&gt;
3008 &lt;!-- Stop all measurements if we got orphaned. --&gt;
3009 &lt;suppression&gt;
3010 &lt;name&gt;orphaned&lt;/name&gt;
3011 &lt;start&gt;controller-lost&lt;/start&gt;
3012 &lt;end&gt;controller-connected&lt;/end&gt;
3013 &lt;match&gt;measurement:*&lt;/match&gt;
3014 &lt;/suppression&gt;
3015 &lt;/suppressions&gt;
3016
3017
3018
3019
3020 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 54]</span></pre>
3021 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
3022 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
3023
3024
3025 &lt;tasks&gt;
3026 &lt;!-- configuration of an update-ping-targets task --&gt;
3027 &lt;task&gt;
3028 &lt;name&gt;update-ping-targets&lt;/name&gt;
3029 &lt;program&gt;fping-update-targets&lt;/program&gt;
3030 &lt;/task&gt;
3031 &lt;!-- configuration of a ping-all-targets task --&gt;
3032 &lt;task&gt;
3033 &lt;name&gt;ping-all-targets&lt;/name&gt;
3034 &lt;program&gt;fping&lt;/program&gt;
3035 &lt;/task&gt;
3036 &lt;!-- configuration of a traceroute task --&gt;
3037 &lt;task&gt;
3038 &lt;name&gt;traceroute&lt;/name&gt;
3039 &lt;program&gt;mtr&lt;/program&gt;
3040 &lt;option&gt;
3041 &lt;id&gt;csv&lt;/id&gt;
3042 &lt;name&gt;--csv&lt;/name&gt;
3043 &lt;/option&gt;
3044 &lt;/task&gt;
3045 &lt;!-- configuration of a reporter task --&gt;
3046 &lt;task&gt;
3047 &lt;name&gt;report&lt;/name&gt;
3048 &lt;program&gt;lmap-report&lt;/program&gt;
3049 &lt;/task&gt;
3050
3051 &lt;task&gt;
3052 &lt;name&gt;ippm-udp-latency-client&lt;/name&gt;
3053 &lt;program&gt;ippm-udp-latency&lt;/program&gt;
3054 &lt;function&gt;
3055 &lt;uri&gt;urn:example:tbd&lt;/uri&gt;
3056 &lt;role&gt;client&lt;/role&gt;
3057 &lt;/function&gt;
3058 &lt;tag&gt;active&lt;/tag&gt;
3059 &lt;/task&gt;
3060 &lt;/tasks&gt;
3061
3062 &lt;events&gt;
3063 &lt;!-- The event E1 triggers every hour during September 2016
3064 with a random spread of one minute. --&gt;
3065 &lt;event&gt;
3066 &lt;name&gt;E1&lt;/name&gt;
3067 &lt;random-spread&gt;60&lt;/random-spread&gt; &lt;!-- seconds --&gt;
3068 &lt;periodic&gt;
3069 &lt;interval&gt;3600000&lt;/interval&gt;
3070 &lt;start&gt;2016-09-01T00:00:00+00:00&lt;/start&gt;
3071 &lt;end&gt;2016-11-01T00:00:00+00:00&lt;/end&gt;
3072 &lt;/periodic&gt;
3073
3074
3075
3076 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 55]</span></pre>
3077 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
3078 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
3079
3080
3081 &lt;/event&gt;
3082 &lt;!-- The event E2 triggers on Mondays at 4am UTC --&gt;
3083 &lt;event&gt;
3084 &lt;name&gt;E2&lt;/name&gt;
3085 &lt;calendar&gt;
3086 &lt;month&gt;*&lt;/month&gt;
3087 &lt;day-of-week&gt;monday&lt;/day-of-week&gt;
3088 &lt;day-of-month&gt;*&lt;/day-of-month&gt;
3089 &lt;hour&gt;4&lt;/hour&gt;
3090 &lt;minute&gt;0&lt;/minute&gt;
3091 &lt;second&gt;0&lt;/second&gt;
3092 &lt;timezone-offset&gt;+00:00&lt;/timezone-offset&gt;
3093 &lt;/calendar&gt;
3094 &lt;/event&gt;
3095 &lt;!-- The event controller-lost triggers when we lost
3096 connectivity with the Controller. --&gt;
3097 &lt;event&gt;
3098 &lt;name&gt;controller-lost&lt;/name&gt;
3099 &lt;controller-lost/&gt;
3100 &lt;/event&gt;
3101 &lt;!-- The event contoller-connected triggers when we
3102 established or re-established connectivity with
3103 the Controller. --&gt;
3104 &lt;event&gt;
3105 &lt;name&gt;controller-connected&lt;/name&gt;
3106 &lt;controller-connected/&gt;
3107 &lt;/event&gt;
3108 &lt;/events&gt;
3109 &lt;/lmap&gt;
3110 &lt;/config&gt;
3111
3112 <span class="h2"><a class="selflink" id="appendix-C" href="#appendix-C">Appendix C</a>. Example Report</span>
3113
3114 The report below is in XML [<a href="#ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>].
3115
3116 &lt;rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
3117 message-id="1"&gt;
3118 &lt;report xmlns="urn:ietf:params:xml:ns:yang:ietf-lmap-report"&gt;
3119 &lt;date&gt;2015-10-28T13:27:42+02:00&lt;/date&gt;
3120 &lt;agent-id&gt;550e8400-e29b-41d4-a716-446655440000&lt;/agent-id&gt;
3121 &lt;result&gt;
3122 &lt;schedule&gt;S1&lt;/schedule&gt;
3123 &lt;action&gt;A1&lt;/action&gt;
3124 &lt;task&gt;update-ping-targets&lt;/task&gt;
3125 &lt;start&gt;2016-03-21T10:48:55+01:00&lt;/start&gt;
3126 &lt;end&gt;2016-03-21T10:48:57+01:00&lt;/end&gt;
3127 &lt;status&gt;0&lt;/status&gt;
3128 &lt;/result&gt;
3129
3130
3131
3132 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 56]</span></pre>
3133 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
3134 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
3135
3136
3137 &lt;result&gt;
3138 &lt;schedule&gt;S1&lt;/schedule&gt;
3139 &lt;action&gt;A2&lt;/action&gt;
3140 &lt;task&gt;ping-all-targets&lt;/task&gt;
3141 &lt;start&gt;2016-03-21T10:48:55+01:00&lt;/start&gt;
3142 &lt;end&gt;2016-03-21T10:48:57+01:00&lt;/end&gt;
3143 &lt;status&gt;0&lt;/status&gt;
3144 &lt;table&gt;
3145 &lt;column&gt;target&lt;/column&gt;
3146 &lt;column&gt;rtt&lt;/column&gt;
3147 &lt;row&gt;
3148 &lt;value&gt;2001:db8::1&lt;/value&gt;
3149 &lt;value&gt;42&lt;/value&gt;
3150 &lt;/row&gt;
3151 &lt;row&gt;
3152 &lt;value&gt;2001:db8::2&lt;/value&gt;
3153 &lt;value&gt;24&lt;/value&gt;
3154 &lt;/row&gt;
3155 &lt;/table&gt;
3156 &lt;/result&gt;
3157 &lt;result&gt;
3158 &lt;schedule&gt;S2&lt;/schedule&gt;
3159 &lt;action&gt;A1&lt;/action&gt;
3160 &lt;task&gt;traceroute&lt;/task&gt;
3161 &lt;option&gt;
3162 &lt;id&gt;target&lt;/id&gt;
3163 &lt;name&gt;target&lt;/name&gt;
3164 &lt;value&gt;2001:db8::1&lt;/value&gt;
3165 &lt;/option&gt;
3166 &lt;option&gt;
3167 &lt;id&gt;csv&lt;/id&gt;
3168 &lt;name&gt;--csv&lt;/name&gt;
3169 &lt;/option&gt;
3170 &lt;start&gt;2016-03-21T10:48:55+01:00&lt;/start&gt;
3171 &lt;end&gt;2016-03-21T10:48:57+01:00&lt;/end&gt;
3172 &lt;status&gt;1&lt;/status&gt;
3173 &lt;table&gt;
3174 &lt;column&gt;hop&lt;/column&gt;
3175 &lt;column&gt;ip&lt;/column&gt;
3176 &lt;column&gt;rtt&lt;/column&gt;
3177 &lt;row&gt;
3178 &lt;value&gt;1&lt;/value&gt;
3179 &lt;value&gt;2001:638:709:5::1&lt;/value&gt;
3180 &lt;value&gt;10.5&lt;/value&gt;
3181 &lt;/row&gt;
3182 &lt;row&gt;
3183 &lt;value&gt;2&lt;/value&gt;
3184 &lt;value&gt;?&lt;/value&gt;
3185
3186
3187
3188 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 57]</span></pre>
3189 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
3190 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
3191
3192
3193 &lt;value&gt;&lt;/value&gt;
3194 &lt;/row&gt;
3195 &lt;/table&gt;
3196 &lt;/result&gt;
3197 &lt;result&gt;
3198 &lt;schedule&gt;S2&lt;/schedule&gt;
3199 &lt;action&gt;A2&lt;/action&gt;
3200 &lt;task&gt;traceroute&lt;/task&gt;
3201 &lt;option&gt;
3202 &lt;id&gt;target&lt;/id&gt;
3203 &lt;name&gt;target&lt;/name&gt;
3204 &lt;value&gt;2001:db8::2&lt;/value&gt;
3205 &lt;/option&gt;
3206 &lt;option&gt;
3207 &lt;id&gt;csv&lt;/id&gt;
3208 &lt;name&gt;--csv&lt;/name&gt;
3209 &lt;/option&gt;
3210 &lt;start&gt;2016-03-21T10:48:55+01:00&lt;/start&gt;
3211 &lt;end&gt;2016-03-21T10:48:57+01:00&lt;/end&gt;
3212 &lt;status&gt;1&lt;/status&gt;
3213 &lt;table&gt;
3214 &lt;column&gt;hop&lt;/column&gt;
3215 &lt;column&gt;ip&lt;/column&gt;
3216 &lt;column&gt;rtt&lt;/column&gt;
3217 &lt;row&gt;
3218 &lt;value&gt;1&lt;/value&gt;
3219 &lt;value&gt;2001:638:709:5::1&lt;/value&gt;
3220 &lt;value&gt;11.8&lt;/value&gt;
3221 &lt;/row&gt;
3222 &lt;row&gt;
3223 &lt;value&gt;2&lt;/value&gt;
3224 &lt;value&gt;?&lt;/value&gt;
3225 &lt;value&gt;&lt;/value&gt;
3226 &lt;/row&gt;
3227 &lt;/table&gt;
3228 &lt;/result&gt;
3229 &lt;/report&gt;
3230 &lt;/rpc&gt;
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244 <span class="grey">Schoenwaelder &amp; Bajpai Standards Track [Page 58]</span></pre>
3245 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
3246 <span class="grey"><a href="./rfc8194">RFC 8194</a> YANG Data Model for LMAP August 2017</span>
3247
3248
3249 Acknowledgements
3250
3251 Several people contributed to this specification by reviewing early
3252 draft versions and actively participating in the LMAP Working Group
3253 (apologies to those unintentionally omitted): Marcelo Bagnulo, Martin
3254 Bjorklund, Trevor Burbridge, Timothy Carey, Alissa Cooper, Philip
3255 Eardley, Al Morton, Dan Romascanu, Andrea Soppera, Barbara Stark, and
3256 Qin Wu.
3257
3258 Juergen Schoenwaelder and Vaibhav Bajpai worked in part on the Leone
3259 research project, which received funding from the European Union
3260 Seventh Framework Programme [FP7/2007-2013] under grant agreement
3261 number 317647.
3262
3263 Juergen Schoenwaelder and Vaibhav Bajpai were partly funded by
3264 Flamingo, a Network of Excellence project (ICT-318488) supported by
3265 the European Commission under its Seventh Framework Programme.
3266
3267 Authors' Addresses
3268
3269 Juergen Schoenwaelder
3270 Jacobs University Bremen
3271
3272 Email: [email protected]
3273
3274
3275 Vaibhav Bajpai
3276 Technical University of Munich
3277
3278 Email: [email protected]
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300 Schoenwaelder &amp; Bajpai Standards Track [Page 59]
3301 </pre>