idnits 2.17.1 draft-ietf-lmap-information-model-10.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 695 has weird spacing: '...ion-obj ma-in...' == Line 882 has weird spacing: '...ask-obj ma-ca...' == Line 903 has weird spacing: '...try-obj ma-ca...' == Line 924 has weird spacing: '...ace-obj ma-...' == Line 926 has weird spacing: '...ion-obj ma-st...' == (7 more instances...) -- The document date (July 8, 2016) is 2842 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) ** Downref: Normative reference to an Informational RFC: RFC 7594 == Outdated reference: A later version (-24) exists of draft-ietf-ippm-metric-registry-06 == Outdated reference: A later version (-12) exists of draft-ietf-lmap-yang-04 Summary: 1 error (**), 0 flaws (~~), 10 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group T. Burbridge 3 Internet-Draft P. Eardley 4 Intended status: Standards Track BT 5 Expires: January 9, 2017 M. Bagnulo 6 Universidad Carlos III de Madrid 7 J. Schoenwaelder 8 Jacobs University Bremen 9 July 8, 2016 11 Information Model for Large-Scale Measurement Platforms (LMAP) 12 draft-ietf-lmap-information-model-10 14 Abstract 16 This Information Model applies to the Measurement Agent within a 17 Large-Scale Measurement Platform. As such it outlines the 18 information that is (pre-)configured on the Measurement Agent or 19 exists in communications with a Controller or Collector within an 20 LMAP framework. The purpose of such an Information Model is to 21 provide a protocol and device independent view of the Measurement 22 Agent that can be implemented via one or more Control and Report 23 protocols. 25 Requirements Language 27 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 28 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 29 document are to be interpreted as described in RFC 2119 [RFC2119]. 31 Status of This Memo 33 This Internet-Draft is submitted in full conformance with the 34 provisions of BCP 78 and BCP 79. 36 Internet-Drafts are working documents of the Internet Engineering 37 Task Force (IETF). Note that other groups may also distribute 38 working documents as Internet-Drafts. The list of current Internet- 39 Drafts is at http://datatracker.ietf.org/drafts/current/. 41 Internet-Drafts are draft documents valid for a maximum of six months 42 and may be updated, replaced, or obsoleted by other documents at any 43 time. It is inappropriate to use Internet-Drafts as reference 44 material or to cite them other than as "work in progress." 46 This Internet-Draft will expire on January 9, 2017. 48 Copyright Notice 50 Copyright (c) 2016 IETF Trust and the persons identified as the 51 document authors. All rights reserved. 53 This document is subject to BCP 78 and the IETF Trust's Legal 54 Provisions Relating to IETF Documents 55 (http://trustee.ietf.org/license-info) in effect on the date of 56 publication of this document. Please review these documents 57 carefully, as they describe your rights and restrictions with respect 58 to this document. Code Components extracted from this document must 59 include Simplified BSD License text as described in Section 4.e of 60 the Trust Legal Provisions and are provided without warranty as 61 described in the Simplified BSD License. 63 Table of Contents 65 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 66 2. Notation . . . . . . . . . . . . . . . . . . . . . . . . . . 4 67 3. LMAP Information Model . . . . . . . . . . . . . . . . . . . 5 68 3.1. Pre-Configuration Information . . . . . . . . . . . . . . 8 69 3.1.1. Definition of ma-preconfig-obj . . . . . . . . . . . 9 70 3.2. Configuration Information . . . . . . . . . . . . . . . . 10 71 3.2.1. Definition of ma-config-obj . . . . . . . . . . . . . 11 72 3.3. Instruction Information . . . . . . . . . . . . . . . . . 13 73 3.3.1. Definition of ma-instruction-obj . . . . . . . . . . 15 74 3.3.2. Definition of ma-suppression-obj . . . . . . . . . . 16 75 3.4. Logging Information . . . . . . . . . . . . . . . . . . . 17 76 3.4.1. Definition of ma-log-obj . . . . . . . . . . . . . . 18 77 3.5. Capability and Status Information . . . . . . . . . . . . 19 78 3.5.1. Definition of ma-capability-obj . . . . . . . . . . . 19 79 3.5.2. Definition of ma-capability-task-obj . . . . . . . . 20 80 3.5.3. Definition of ma-status-obj . . . . . . . . . . . . . 20 81 3.5.4. Definition of ma-status-schedule-obj . . . . . . . . 21 82 3.5.5. Definition of ma-status-action-obj . . . . . . . . . 22 83 3.5.6. Definition of ma-status-suppression-obj . . . . . . . 24 84 3.5.7. Definition of ma-status-interface-obj . . . . . . . . 24 85 3.6. Reporting Information . . . . . . . . . . . . . . . . . . 25 86 3.6.1. Definition of ma-report-obj . . . . . . . . . . . . . 27 87 3.6.2. Definition of ma-report-result-obj . . . . . . . . . 28 88 3.6.3. Definition of ma-report-conflict-obj . . . . . . . . 29 89 3.6.4. Definition of ma-report-table-obj . . . . . . . . . . 29 90 3.6.5. Definition of ma-report-row-obj . . . . . . . . . . . 30 91 3.7. Common Objects: Schedules . . . . . . . . . . . . . . . . 30 92 3.7.1. Definition of ma-schedule-obj . . . . . . . . . . . . 32 93 3.7.2. Definition of ma-action-obj . . . . . . . . . . . . . 33 94 3.8. Common Objects: Channels . . . . . . . . . . . . . . . . 34 95 3.8.1. Definition of ma-channel-obj . . . . . . . . . . . . 35 97 3.9. Common Objects: Task Configurations . . . . . . . . . . . 35 98 3.9.1. Definition of ma-task-obj . . . . . . . . . . . . . . 37 99 3.9.2. Definition of ma-option-obj . . . . . . . . . . . . . 37 100 3.10. Common Objects: Registry Information . . . . . . . . . . 38 101 3.10.1. Definition of ma-metric-registry-obj . . . . . . . . 38 102 3.11. Common Objects: Event Information . . . . . . . . . . . . 38 103 3.11.1. Definition of ma-event-obj . . . . . . . . . . . . . 39 104 3.11.2. Definition of ma-periodic-obj . . . . . . . . . . . 40 105 3.11.3. Definition of ma-calendar-obj . . . . . . . . . . . 41 106 3.11.4. Definition of ma-one-off-obj . . . . . . . . . . . . 43 107 3.11.5. Definition of ma-immediate-obj . . . . . . . . . . . 43 108 3.11.6. Definition of ma-startup-obj . . . . . . . . . . . . 43 109 3.11.7. Definition of ma-controller-lost-obj . . . . . . . . 44 110 3.11.8. Definition of ma-controller-connected-obj . . . . . 44 111 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 44 112 5. Security Considerations . . . . . . . . . . . . . . . . . . . 44 113 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 45 114 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 45 115 7.1. Normative References . . . . . . . . . . . . . . . . . . 45 116 7.2. Informative References . . . . . . . . . . . . . . . . . 46 117 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 46 118 Appendix B. Non-editorial Changes since -09 . . . . . . . . . . 46 119 Appendix C. Non-editorial Changes since -08 . . . . . . . . . . 47 120 Appendix D. Non-editorial Changes since -07 . . . . . . . . . . 47 121 Appendix E. Non-editorial Changes since -06 . . . . . . . . . . 47 122 Appendix F. Non-editorial Changes since -05 . . . . . . . . . . 48 123 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 49 125 1. Introduction 127 A large-scale measurement platform is a collection of components that 128 work in a coordinated fashion to perform measurements from a large 129 number of vantage points. The main components of a large-scale 130 measurement platform are the Measurement Agents (hereafter MAs), the 131 Controller(s) and the Collector(s). 133 The MAs are the elements actually performing the measurements. The 134 MAs are controlled by exactly one Controller at a time and the 135 Collectors gather the results generated by the MAs. In a nutshell, 136 the normal operation of a large-scale measurement platform starts 137 with the Controller instructing a set of one or more MAs to perform a 138 set of one or more Measurement Tasks at a certain point in time. The 139 MAs execute the instructions from a Controller, and once they have 140 done so, they report the results of the measurements to one or more 141 Collectors. The overall framework for a Large Measurement platform 142 as used in this document is described in detail in [RFC7594]. 144 A large-scale measurement platform involves basically three types of 145 protocols, namely, a Control protocol (or protocols) between a 146 Controller and the MAs, a Report protocol (or protocols) between the 147 MAs and the Collector(s) and several measurement protocols between 148 the MAs and Measurement Peers (MPs), used to actually perform the 149 measurements. In addition some information is required to be 150 configured on the MA prior to any communication with a Controller. 152 This document defines the information model for both Control and the 153 Report protocols along with pre-configuration information that is 154 required on the MA before communicating with the Controller, broadly 155 named as the LMAP Information Model. The measurement protocols are 156 out of the scope of this document. 158 As defined in [RFC3444], the LMAP Information Model defines the 159 concepts involved in a large-scale measurement platform at a high 160 level of abstraction, independent of any specific implementation or 161 actual protocol used to exchange the information. It is expected 162 that the proposed information model can be used with different 163 protocols in different measurement platform architectures and across 164 different types of MA devices (e.g., home gateway, smartphone, PC, 165 router). A YANG data model implementing the information model can be 166 found in [I-D.ietf-lmap-yang]. 168 The definition of an Information Model serves a number of purposes: 170 1. To guide the standardisation of one or more Control and Report 171 protocols and data models 173 2. To enable high-level inter-operability between different Control 174 and Report protocols by facilitating translation between their 175 respective data models such that a Controller could instruct sub- 176 populations of MAs using different protocols 178 3. To form agreement of what information needs to be held by an MA 179 and passed over the Control and Report interfaces and support the 180 functionality described in the LMAP framework 182 4. To enable existing protocols and data models to be assessed for 183 their suitability as part of a large-scale measurement system 185 2. Notation 187 This document uses a programming language-like notation to define the 188 properties of the objects of the information model. An optional 189 property is enclosed by square brackets, [ ], and a list property is 190 indicated by two numbers in angle brackets, , where m indicates 191 the minimal number of values, and n is the maximum. The symbol * for 192 n means no upper bound. 194 3. LMAP Information Model 196 The information described herein relates to the information stored, 197 received or transmitted by a Measurement Agent as described within 198 the LMAP framework [RFC7594]. As such, some subsets of this 199 information model are applicable to the measurement Controller, 200 Collector and any device management system that pre-configures the 201 Measurement Agent. The information described in these models will be 202 transmitted by protocols using interfaces between the Measurement 203 Agent and such systems according to a Data Model. 205 For clarity the information model is divided into six sections: 207 1. Pre-Configuration Information. Information pre-configured on the 208 Measurement Agent prior to any communication with other 209 components of the LMAP architecture (i.e., the Controller, 210 Collector and Measurement Peers), specifically detailing how to 211 communicate with a Controller and whether the device is enabled 212 to participate as an MA. 214 2. Configuration Information. Update of the pre-configuration 215 information during the registration of the MA or subsequent 216 communication with the Controller, along with the configuration 217 of further parameters about the MA (rather than the Measurement 218 Tasks it should perform) that were not mandatory for the initial 219 communication between the MA and a Controller. 221 3. Instruction Information. Information that is received by the MA 222 from the Controller pertaining to the Measurement Tasks that 223 should be executed. This includes the task execution Schedules 224 (other than the Controller communication Schedule supplied as 225 (pre)configuration information) and related information such as 226 the Task Configuration, communication Channels to Collectors and 227 schedule Event and Timing information. It also includes Task 228 Suppression information that is used to over-ride normal Task 229 execution. 231 4. Logging Information. Information transmitted from the MA to the 232 Controller detailing the results of any configuration operations 233 along with error and status information from the operation of the 234 MA. 236 5. Capability and Status Information. Information on the general 237 status and capabilities of the MA. For example, the set of 238 measurements that are supported on the device. 240 6. Reporting Information. Information transmitted from the MA to 241 one or more Collectors including measurement results and the 242 context in which they were conducted. 244 In addition the MA may hold further information not described herein, 245 and which may be optionally transferred to or from other systems 246 including the Controller and Collector. One example of information 247 in this category is subscriber or line information that may be 248 extracted by a task and reported by the MA in the reporting 249 communication to a Collector. 251 It should also be noted that the MA may be in communication with 252 other management systems which may be responsible for configuring and 253 retrieving information from the MA device. Such systems, where 254 available, can perform an important role in transferring the pre- 255 configuration information to the MA or enabling/disabling the 256 measurement functionality of the MA. 258 The Information Model is divided into sub-sections for a number of 259 reasons. Firstly the grouping of information facilitates reader 260 understanding. Secondly, the particular groupings chosen are 261 expected to map to different protocols or different transmissions 262 within those protocols. 264 The granularity of data transmitted in each operation of the Control 265 and Report Protocols is not dictated by the Information Model. For 266 example, the Instruction object may be delivered in a single 267 operation. Alternatively, Schedules and Task Configurations may be 268 separated or even each Schedule/Task Configuration may be delivered 269 individually. Similarly the Information Model does not dictate 270 whether data is read, write, or read/write. For example, some 271 Control Protocols may have the ability to read back Configuration and 272 Instruction information which have been previously set on the MA. 273 Lastly, while some protocols may simply overwrite information (for 274 example refreshing the entire Instruction Information), other 275 protocols may have the ability to update or delete selected items of 276 information. 278 The information in these six sections is captured by a number of 279 common information objects. These objects are also described later 280 in this document and comprise of: 282 1. Schedules. A set of Schedules tells the MA to do something. 283 Without a Schedule no Task (from a measurement to reporting or 284 communicating with the Controller) is ever executed. Schedules 285 are used within the Instruction to specify what tasks should be 286 performed, when, and how to direct their results. A Schedule is 287 also used within the pre-Configuration and Configuration 288 information in order to execute the Task or Tasks required to 289 communicate with the Controller. A specific Schedule can only be 290 active once. Attempts to start a Schedule while the same 291 Schedule is still active will fail. 293 2. Channels. A set of Channel objects are used to communicate with 294 a number of endpoints (i.e., the Controller and Collectors). 295 Each Channel object contains the information required for the 296 communication with a single endpoint such as the target location 297 and security details. 299 3. Task Configurations. A set of Task Configurations is used to 300 configure the Tasks that are run by the MA. This includes the 301 registry entries for the Task and any configuration parameters. 302 Task Configurations are referenced from a Schedule in order to 303 specify what Tasks the MA should execute. 305 4. Events. A set of Event objects that can be referenced from the 306 Schedules. Each Schedule always references exactly one Event 307 object that determines when the schedule is executed. An Event 308 object specifies either a singleton or series of events that 309 indicate when Tasks should be executed. A commonly used kind of 310 Event objects are Timing objects. 312 Figure 1 illustrates the structure in which these common information 313 objects are referenced. The references are achieved by each object 314 (Task Configuration, Event) being given a short textual name that is 315 used by other objects. The objects shown in parenthesis are part of 316 the internal object structure of a Schedule. Channels are not shown 317 in the diagram since they are only used as an option by selected Task 318 Configurations but are similarly referenced using a short text name. 320 Schedule 321 |-- triggered by --> Event 322 | 323 |-- executes --> Action 1 324 | |-- using --> Task Configuration 325 | | 326 | `-- feeding to --> Destination Schedule 327 : 328 : 329 `-- executes --> Action N 330 |-- using --> Task Configuration 331 | 332 `-- feeding to --> Destination Schedule 334 Figure 1: Relationship between Schedules, Events, Actions, Task 335 Configurations, and Destination Schedules 337 It should be clear that the top-level behavior of an MA is simply to 338 execute Schedules. Every Action contained in a Schedule is defined 339 as a Task. As such, these Actions are configured through Task 340 Configurations and executed according to the Event object referenced 341 by the Schedule in which they appear. Note, however, that Actions 342 can have Action specific parameters. 344 Tasks can implement a variety of different types of Actions. While 345 in terms of the Information Model, all Tasks have the same structure, 346 it can help conceptually to think of different Task categories: 348 1. Measurement Tasks measure some aspect of network performance or 349 traffic. They may also capture contextual information from the 350 MA device or network interfaces such as the device type or 351 interface speed. 353 2. Data Transfer Tasks support the communication with a Controller 354 and Collectors: 356 A. Reporting Tasks report the results of Measurement Tasks to 357 Collectors 359 B. Control Task(s) implement the Control Protocol and 360 communicate with the Controller. 362 3. Data Analysis Tasks can exist to analyse data from other 363 Measurement Tasks locally on the MA 365 4. Data Management Tasks may exist to clean-up, filter or compress 366 data on the MA such as Measurement Task results 368 Figure 1 indicates that Actions can produce data that is fed into 369 Destination Schedules. This can by used by Actions implementing 370 Measurement Tasks to feed measurement results to a Schedule that 371 triggers Actions implementing Reporting Tasks. Data fed to a 372 Destination Schedule is consumed by the first Action of the 373 Destination Schedule if the Destination Schedule is using sequential 374 or pipelined execution mode and it is consumed by all Actions of the 375 Destination Schedule if the Destination Schedule is using parallel 376 execution mode. 378 3.1. Pre-Configuration Information 380 This information is the minimal information that needs to be pre- 381 configured to the MA in order for it to successfully communicate with 382 a Controller during the registration process. Some of the Pre- 383 Configuration Information elements are repeated in the Configuration 384 Information in order to allow an LMAP Controller to update these 385 items. The pre-configuration information also contains some elements 386 that are not under the control of the LMAP framework (such as the 387 device identifier and device security credentials). 389 This Pre-Configuration Information needs to include a URL of the 390 initial Controller from where configuration information can be 391 communicated along with the security information required for the 392 communication including the certificate of the Controller (or the 393 certificate of the Certification Authority which was used to issue 394 the certificate for the Controller). All this is expressed as a 395 Channel. While multiple Channels may be provided in the Pre- 396 Configuration Information they must all be associated with a single 397 Controller (e.g., over different interfaces or network protocols). 399 Where the MA pulls information from the Controller, the Pre- 400 Configuration Information also needs to contain the timing of the 401 communication with the Controller as well as the nature of the 402 communication itself (such as the protocol and data to be 403 transferred). The timing is given as a Schedule that executes the 404 Task(s) responsible for communication with the Controller. It is 405 this Task (or Tasks) that implement the Control protocol between the 406 MA and the Controller and utilises the Channel information. The 407 Task(s) may take additional parameters in which case a Task 408 Configuration can also be included. 410 Even where information is pushed to the MA from the Controller 411 (rather than pulled by the MA), a Schedule still needs to be 412 supplied. In this case the Schedule will simply execute a Controller 413 listener task when the MA is started. A Channel is still required 414 for the MA to establish secure communication with the Controller. 416 It can be seen that these Channels, Schedules and Task Configurations 417 for the initial MA-Controller communication are no different in terms 418 of the Information Model to any other Channel, Schedule or Task 419 Configuration that might execute a Measurement Task or report the 420 measurement results (as described later). 422 The MA may be pre-configured with an MA ID, or may use a Device ID in 423 the first Controller contact before it is assigned an MA ID. The 424 Device ID may be a MAC address or some other device identifier 425 expressed as a URI. If the MA ID is not provided at this stage then 426 it must be provided by the Controller during Configuration. 428 3.1.1. Definition of ma-preconfig-obj 429 object { 430 [uuid ma-preconfig-agent-id;] 431 ma-task-obj ma-preconfig-control-tasks<1..*>; 432 ma-channel-obj ma-preconfig-control-channels<1..*>; 433 ma-schedule-obj ma-preconfig-control-schedules<1..*>; 434 [uri ma-preconfig-device-id;] 435 credentials ma-preconfig-credentials; 436 } ma-preconfig-obj; 438 The ma-preconfig-obj is essentially a subset of the ma-config-obj 439 described below. The ma-preconfig-obj consists of the following 440 elements: 442 ma-preconfig-agent-id: An optional uuid uniquely identifying 443 the measurement agent. 445 ma-preconfig-control-tasks: An unordered set of tasks objects. 447 ma-preconfig-control-channels: An unordered set of channel objects. 449 ma-preconfig-control-schedules: An unordered set of scheduling 450 objects. 452 ma-preconfig-device-id: An optional identifier for the 453 device. 455 ma-preconfig-credentials: The security credentials used by the 456 measurement agent. 458 3.2. Configuration Information 460 During registration or at any later point at which the MA contacts 461 the Controller (or vice-versa), the choice of Controller, details for 462 the timing of communication with the Controller or parameters for the 463 communication Task(s) can be changed (as captured by the Channels, 464 Schedules and Task Configurations objects). For example the pre- 465 configured Controller (specified as a Channel or Channels) may be 466 over-ridden with a specific Controller that is more appropriate to 467 the MA device type, location or characteristics of the network (e.g., 468 access technology type or broadband product). The initial 469 communication Schedule may be over-ridden with one more relevant to 470 routine communications between the MA and the Controller. 472 While some Control protocols may only use a single Schedule, other 473 protocols may use several Schedules (and related data transfer Tasks) 474 to update the Configuration Information, transfer the Instruction 475 Information, transfer Capability and Status Information and send 476 other information to the Controller such as log or error 477 notifications. Multiple Channels may be used to communicate with the 478 same Controller over multiple interfaces (e.g., to send logging 479 information over a different network). 481 In addition the MA will be given further items of information that 482 relate specifically to the MA rather than the measurements it is to 483 conduct or how to report results. The assignment of an ID to the MA 484 is mandatory. If the MA Agent ID was not optionally provided during 485 the pre-configuration then one must be provided by the Controller 486 during Configuration. Optionally a Group ID may also be given which 487 identifies a group of interest to which that MA belongs. For example 488 the group could represent an ISP, broadband product, technology, 489 market classification, geographic region, or a combination of 490 multiple such characteristics. Where the Measurement Group ID is set 491 an additional flag (the Report MA ID flag) is required to control 492 whether the Measurement Agent ID is also to be reported. The 493 reporting of a Group ID without the MA ID allows the MA to remain 494 anonymous, which may be particularly useful to prevent tracking of 495 mobile MA devices. 497 Optionally an MA can also be configured to stop executing any 498 Instruction Schedule if the Controller is unreachable. This can be 499 used as a fail-safe to stop Measurement and other Tasks being 500 conducted when there is doubt that the Instruction Information is 501 still valid. This is simply represented as a time window in seconds 502 since the last communication with the Controller after which an Event 503 is generated that can trigger the suspension of Instruction 504 Schedules. The appropriate value of the time window will depend on 505 the specified communication Schedule with the Controller and the 506 duration for which the system is willing to tolerate continued 507 operation with potentially stale Instruction Information. 509 While Pre-Configuration Information is persistent upon device reset 510 or power cycle, the persistency of the Configuration Information may 511 be device dependent. Some devices may revert back to their pre- 512 configuration state upon reboot or factory reset, while other devices 513 may store all Configuration and Instruction information in persistent 514 storage. A Controller can check whether an MA has the latest 515 Configuration and Instruction information by examining the Capability 516 and Status information for the MA. 518 3.2.1. Definition of ma-config-obj 519 object { 520 uuid ma-config-agent-id; 521 ma-task-obj ma-config-control-tasks<1..*>; 522 ma-channel-obj ma-config-control-channels<1..*>; 523 ma-schedule-obj ma-config-control-schedules<1..*>; 524 [uri ma-config-device-id;] 525 credentials ma-config-credentials; 526 [string ma-config-group-id;] 527 [string ma-config-measurement-point;] 528 [boolean ma-config-report-agent-id;] 529 [boolean ma-config-report-measurement-point;] 530 [int ma-config-controller-timeout;] 531 } ma-config-obj; 533 The ma-config-obj consists of the following elements: 535 ma-config-agent-id: A uuid uniquely identifying the 536 measurement agent. 538 ma-config-control-tasks: An unordered set of task objects. 540 ma-config-control-channels: An unordered set of channel 541 objects. 543 ma-config-control-schedules: An unordered set of scheduling 544 objects. 546 ma-config-device-id: An optional identifier for the 547 device. 549 ma-config-credentials: The security credentials used by 550 the measurement agent. 552 ma-config-group-id: An optional identifier of the 553 group of measurement agents this 554 measurement agent belongs to. 556 ma-config-measurement-point: An optional identifier for the 557 measurement point indicating 558 where the measurement agent is 559 located on a path (see [RFC7398] 560 for further details). 562 ma-config-report-agent-id: An optional flag indicating 563 whether the identifier (ma- 564 config-agent-id) should be 565 included in reports. The default 566 value is false. 568 ma-config-report-measurement-point: An optional flag indicating 569 whether the measurement point 570 (ma-config-measurement-point) 571 should be included in reports. 572 The default value is false. 574 ma-config-controller-timeout: A timer is started after each 575 successful contact with a 576 controller. When the timer 577 reaches the controller-timeout 578 (measured in seconds), an event 579 is raised indicating that 580 connectivity to the controller 581 has been lost (see ma-controller- 582 lost-obj). 584 3.3. Instruction Information 586 The Instruction information model has four sub-elements: 588 1. Instruction Task Configurations 590 2. Report Channels 592 3. Instruction Schedules 594 4. Suppression 596 The Instruction supports the execution of all Tasks on the MA except 597 those that deal with communication with the Controller (specified in 598 (pre-)configuration information). The Tasks are configured in 599 Instruction Task Configurations and included by reference in 600 Instruction Schedules that specify when to execute them. The results 601 can be communicated to other Schedules or a Task may implement a 602 Reporting Protocol and communicate results over Report Channels. 603 Suppression is used to temporarily stop the execution of new Tasks as 604 specified by the Instruction Schedules (and optionally to stop 605 ongoing Tasks). 607 A Task Configuration is used to configure the mandatory and optional 608 parameters of a Task. It also serves to instruct the MA about the 609 Task including the ability to resolve the Task to an executable and 610 specifying the schema for the Task parameters. 612 A Report Channel defines how to communicate with a single remote 613 system specified by a URL. A Report Channel is used to send results 614 to a single Collector but is no different in terms of the Information 615 Model to the Control Channel used to transfer information between the 616 MA and the Controller. Several Report Channels can be defined to 617 enable results to be split or duplicated across different 618 destinations. A single Channel can be used by multiple (reporting) 619 Task Configurations to transfer data to the same Collector. A single 620 Reporting Task Configuration can also be included in multiple 621 Schedules. E.g., a single Collector may receive data at three 622 different cycle rates, one Schedule reporting hourly, another 623 reporting daily and a third specifying that results should be sent 624 immediately for on-demand measurement tasks. Alternatively multiple 625 Report Channels can be used to send Measurement Task results to 626 different Collectors. The details of the Channel element is 627 described later as it is common to several objects. 629 Instruction Schedules specify which Actions to execute according to a 630 given triggering Event. An Action is a Task with additional specific 631 parameters. An Event can trigger the execution of a single Action or 632 it can trigger a repeated series of Actions. The Schedule also 633 specifies how to link Tasks output data to other Schedules. 635 Measurement Suppression information is used to over-ride the 636 Instruction Schedule and temporarily stop measurements or other Tasks 637 from running on the MA for a defined or indefinite period. While 638 conceptually measurements can be stopped by simply removing them from 639 the Measurement Schedule, splitting out separate information on 640 Measurement Suppression allows this information to be updated on the 641 MA on a different timing cycle or protocol implementation to the 642 Measurement Schedule. It is also considered that it will be easier 643 for a human operator to implement a temporary explicit suppression 644 rather than having to move to a reduced Schedule and then roll-back 645 at a later time. 647 It should be noted that control schedules and tasks cannot be 648 suppressed as evidenced by the lack of suppression information in the 649 Configuration. The control schedule must only reference tasks listed 650 as control tasks (i.e., within the Configuration information). 652 A single Suppression object is able to enable/disable a set of 653 Instruction Tasks that are tagged for suppression. This enabled fine 654 grained control on which Tasks are suppressed. Suppression of both 655 matching Actions and Measurement Schedules is supported. Support for 656 disabling specific Actions allows malfunctioning or mis-configured 657 Tasks or Actions that have an impact on a particular part of the 658 network infrastructure (e.g., a particular Measurement Peer) to be 659 targeted. Support for disabling specific Schedules allows for 660 particularly heavy cycles or sets of less essential Measurement Tasks 661 to be suppressed quickly and effectively. Note that Suppression has 662 no effect on either Controller Tasks or Controller Schedules. 664 Suppression stops new Tasks from executing. In addition, the 665 Suppression information also supports an additional Boolean that is 666 used to select whether on-going tasks are also to be terminated. 668 Unsuppression is achieved through either overwriting the Measurement 669 Suppression information (e.g., changing 'enabled' to False) or 670 through the use of an End time such that the Measurement Suppression 671 will no longer be in effect beyond this time. The datetime format 672 used for all elements in the information model (e.g., the suppression 673 start and end dates) MUST conform to RFC 3339 [RFC3339]. 675 The goal when defining these four different elements is to allow each 676 part of the information model to change without affecting the other 677 three elements. For example it is envisaged that the Report Channels 678 and the set of Task Configurations will be relatively static. The 679 Instruction Schedule, on the other hand, is likely to be more 680 dynamic, as the measurement panel and test frequency are changed for 681 various business goals. Another example is that measurements can be 682 suppressed with a Suppression command without removing the existing 683 Instruction Schedules that would continue to apply after the 684 Suppression expires or is removed. In terms of the Controller-MA 685 communication this can reduce the data overhead. It also encourages 686 the re-use of the same standard Task Configurations and Reporting 687 Channels to help ensure consistency and reduce errors. 689 3.3.1. Definition of ma-instruction-obj 691 object { 692 ma-task-obj ma-instruction-tasks<0..*>; 693 ma-channel-obj ma-instruction-channels<0..*>; 694 ma-schedule-obj ma-instruction-schedules<0..*>; 695 [ma-suppression-obj ma-instruction-suppressions<0..*>;] 696 } ma-instruction-obj; 698 An ma-instruction-obj consists of the following elements: 700 ma-instruction-tasks: A possibly empty unordered set of task 701 objects. 703 ma-instruction-channels: A possibly empty unordered set of 704 channel objects. 706 ma-instruction-schedules: A possibly empty unordered set of 707 schedule objects. 709 ma-instruction-suppressions: An optional possibly empty unordered 710 set of suppression objects. 712 3.3.2. Definition of ma-suppression-obj 714 object { 715 string ma-suppression-name; 716 [ma-event-obj ma-suppression-start;] 717 [ma-event-obj ma-suppression-end;] 718 [string ma-suppression-match<0..*>;] 719 [boolean ma-suppression-stop-running;] 720 } ma-suppression-obj; 722 The ma-suppression-obj controls the suppression of schedules or 723 actions and consists of the following elements: 725 ma-suppression-name: A name uniquely identifying a 726 suppression. 728 ma-suppression-start: The optional event indicating when 729 suppression starts. If not present, 730 the suppression starts immediately, 731 i.e., as if the value would be 732 'immediate'. 734 ma-suppression-end: The optional event indicating when 735 suppression ends. If not present, the 736 suppression does not have a defined 737 end, i.e., the suppression remains for 738 an indefinite period of time. 740 ma-suppression-match: An optional and possibly empty 741 unordered set of match pattern. The 742 suppression will apply to all schedules 743 (and their actions) that have a 744 matching value in their ma-schedule- 745 suppression-tags and all actions that 746 have a matching value in their ma- 747 action-suppression-tags. Pattern 748 matching is done using glob style 749 pattern (see below). 751 ma-suppression-stop-running: An optional boolean indicating whether 752 suppression will stop any running 753 matching schedules or actions. The 754 default value for this boolean is 755 false. 757 Glob style pattern matching is following POSIX.2 fnmatch() without 758 special treatment of file paths: 760 * matches a sequence of characters 761 ? matches a single character 762 [seq] matches any character in seq 763 [!seq] matches any character not in seq 765 A backslash followed by a character matches the following character. 766 In particular: 768 \* matches * 769 \? matches ? 770 \\ matches \ 772 A sequence seq may be a sequence of characters (e.g., [abc] or a 773 range of characters (e.g., [a-c]). 775 3.4. Logging Information 777 The MA may report on the success or failure of Configuration or 778 Instruction communications from the Controller. In addition further 779 operational logs may be produced during the operation of the MA and 780 updates to capabilities may also be reported. Reporting this 781 information is achieved in exactly the same manner as scheduling any 782 other Task. We make no distinction between a Measurement Task 783 conducting an active or passive network measurement and one which 784 solely retrieves static or dynamic information from the MA such as 785 capabilities or logging information. One or more logging tasks can 786 be programmed or configured to capture subsets of the Logging 787 Information. These logging tasks are then executed by Schedules 788 which also specify that the resultant data is to be transferred over 789 the Controller Channels. 791 The type of Logging Information will fall into three different 792 categories: 794 1. Success/failure/warning messages in response to information 795 updates from the Controller. Failure messages could be produced 796 due to some inability to receive or parse the Controller 797 communication, or if the MA is not able to act as instructed. 798 For example: 800 * "Measurement Schedules updated OK" 802 * "Unable to parse JSON" 804 * "Missing mandatory element: Measurement Timing" 806 * "'Start' does not conform to schema - expected datetime" 807 * "Date specified is in the past" 809 * "'Hour' must be in the range 1..24" 811 * "Schedule A refers to non-existent Measurement Task 812 Configuration" 814 * "Measurement Task Configuration X registry entry Y not found" 816 * "Updated Measurement Task Configurations do not include M used 817 by Measurement Schedule N" 819 2. Operational updates from the MA. For example: 821 * "Out of memory: cannot record result" 823 * "Collector 'collector.example.com' not responding" 825 * "Unexpected restart" 827 * "Suppression timeout" 829 * "Failed to execute Measurement Task Configuration H" 831 3. Status updates from the MA. For example: 833 * "Device interface added: eth3" 835 * "Supported measurements updated" 837 * "New IP address on eth0: xxx.xxx.xxx.xxx" 839 This Information Model document does not detail the precise format of 840 logging information since it is to a large extent protocol and MA 841 specific. However, some common information can be identified. 843 3.4.1. Definition of ma-log-obj 845 object { 846 uuid ma-log-agent-id; 847 datetime ma-log-event-time; 848 code ma-log-code; 849 string ma-log-description; 850 } ma-log-obj; 852 The ma-log-obj models the generic aspects of a logging object and 853 consists of the following elements: 855 ma-log-agent-id: A uuid uniquely identifying the measurement 856 agent. 858 ma-log-event-time: The date and time of the event reported in 859 the logging object. 861 ma-log-code: A machine readable code describing the 862 event. 864 ma-log-description: A human readable description of the event. 866 3.5. Capability and Status Information 868 The MA will hold Capability Information that can be retrieved by a 869 Controller. Capabilities include the device interface details 870 available to Measurement Tasks as well as the set of Measurement 871 Tasks/Roles (specified by registry entries) that are actually 872 installed or available on the MA. Status information includes the 873 times that operations were last performed such as contacting the 874 Controller or producing Reports. 876 3.5.1. Definition of ma-capability-obj 878 object { 879 string ma-capability-hardware; 880 string ma-capability-firmware; 881 string ma-capability-version; 882 [ma-capability-task-obj ma-capability-tasks<0..*>;] 883 } ma-capability-obj; 885 The ma-capability-obj provides information about the capabilities of 886 the measurement agent and consists of the following elements: 888 ma-capability-hardware: A description of the hardware of the device 889 the measurement agent is running on. 891 ma-capability-firmware: A description of the firmware of the device 892 the measurement agent is running on. 894 ma-capability-version: The version of the measurement agent. 896 ma-capability-tasks: An optional unordered set of capability 897 objects for each supported task. 899 3.5.2. Definition of ma-capability-task-obj 901 object { 902 string ma-capability-task-name; 903 ma-metric-registry-obj ma-capability-task-metrics<0..*>; 904 string ma-capability-task-version; 905 } ma-capability-task-obj; 907 The ma-capability-task-obj provides information about the capability 908 of a task and consists of the following elements: 910 ma-capability-task-name: A name uniquely identifying a task. 912 ma-capability-task-metrics: A possibly empty unordered set of 913 registered metrics and associated roles 914 this task implements. 916 ma-capability-task-version: The version of the measurement task. 918 3.5.3. Definition of ma-status-obj 920 object { 921 uuid ma-status-agent-id; 922 uri ma-status-device-id; 923 datetime ma-status-last-started; 924 ma-status-interface-obj ma-status-interfaces<0..*>; 925 [ma-status-schedule-obj ma-status-schedules<0..*>;] 926 [ma-status-suppression-obj ma-status-suppressions<0..*>;] 927 } ma-status-obj; 929 The ma-status-obj provides status information about the measurement 930 agent and consists of the following elements: 932 ma-status-agent-id: A uuid uniquely identifying the measurement 933 agent. 935 ma-status-device-id: A URI identifying the device. 937 ma-status-last-started: The date and time the measurement agent 938 last started. 940 ma-status-interfaces: An unordered set of network interfaces 941 available on the device. 943 ma-status-schedules: An optional unordered set of status objects 944 for each schedule. 946 ma-status-suppressions: An optional unordered set of status objects 947 for each suppression. 949 3.5.4. Definition of ma-status-schedule-obj 951 object { 952 string ma-status-schedule-name; 953 string ma-status-schedule-state; 954 int ma-status-schedule-storage; 955 counter ma-status-schedule-invocations; 956 counter ma-status-schedule-suppressions; 957 counter ma-status-schedule-overlaps; 958 counter ma-status-schedule-failures; 959 datetime ma-status-schedule-last-invocation; 960 [ma-status-action-obj ma-status-schedule-actions<0..*>;] 961 } ma-status-schedule-obj; 963 The ma-status-schedule-obj provides status information about the 964 status of a schedule and consists of the following elements: 966 ma-status-schedule-name: The name of the schedule this 967 status object refers to. 969 ma-status-schedule-state: The state of the schedule. The 970 value 'enabled' indicates that 971 the schedule is currently 972 enabled. The value 'suppressed' 973 indicates that the schedule is 974 currently suppressed. The value 975 'disabled' indicates that the 976 schedule is currently disabled. 977 The value 'running' indicates 978 that the schedule is currently 979 running. 981 ma-status-schedule-storage: The amount of storage allocated 982 to the schedule in bytes. This 983 object reports the amount of 984 allocated physical storage and 985 not the storage used by logical 986 data records. Data models should 987 use a 64-bit integer type. 989 ma-status-schedule-invocations Number of invocations of this 990 schedule. This counter does not 991 include suppressed invocations or 992 invocations that were prevented 993 due to an overlap with a previous 994 invocation of this schedule. 996 ma-status-schedule-suppressions Number of suppressed executions 997 of this schedule. 999 ma-status-schedule-overlaps Number of executions prevented 1000 due to overlaps with a previous 1001 invocation of this schedule. 1003 ma-status-schedule-failures Number of failed executions of 1004 this schedule. A failed 1005 execution is an execution where 1006 at least one action failed. 1008 ma-status-schedule-last-invocation: The date and time of the last 1009 invocation of this schedule. 1011 ma-status-schedule-actions: An optional ordered list of 1012 status objects for each action of 1013 the schedule. 1015 3.5.5. Definition of ma-status-action-obj 1017 object { 1018 string ma-status-action-name; 1019 string ma-status-action-state; 1020 int ma-status-action-storage; 1021 counter ma-status-action-invocations; 1022 counter ma-status-action-suppressions; 1023 counter ma-status-action-overlaps; 1024 counter ma-status-action-failures; 1025 datetime ma-status-action-last-invocation; 1026 datetime ma-status-action-last-completion; 1027 int ma-status-action-last-status; 1028 string ma-status-action-last-message; 1029 datetime ma-status-action-last-failed-completion; 1030 int ma-status-action-last-failed-status; 1031 string ma-status-action-last-failed-message; 1032 } ma-status-action-obj; 1034 The ma-status-action-obj provides status information about an action 1035 of a schedule and consists of the following elements: 1037 ma-status-action-name: The name of the action of a 1038 schedule this status object 1039 refers to. 1041 ma-status-action-state: The state of the action. 1042 The value 'enabled' 1043 indicates that the action is 1044 currently enabled. The 1045 value 'suppressed' indicates 1046 that the action is currently 1047 suppressed. The value 1048 'disabled' indicates that 1049 the action is currently 1050 disabled. The value 1051 'running' indicates that the 1052 action is currently running. 1054 ma-status-action-storage: The amount of storage 1055 allocated to the action in 1056 bytes. This object reports 1057 the amount of allocated 1058 physical storage and not the 1059 storage used by logical data 1060 records. Data models should 1061 use a 64-bit integer type. 1063 ma-status-action-invocations Number of invocations of 1064 this action. This counter 1065 does not include suppressed 1066 invocations or invocations 1067 that were prevented due to 1068 an overlap with a previous 1069 invocation of this action. 1071 ma-status-action-suppressions Number of suppressed 1072 executions of this action. 1074 ma-status-action-overlaps Number of executions 1075 prevented due to overlaps 1076 with a previous invocation 1077 of this action. 1079 ma-status-action-failures Number of failed executions 1080 of this action. 1082 ma-status-action-last-invocation: The date and time of the 1083 last invocation of this 1084 action. 1086 ma-status-action-last-completion: The date and time of the 1087 last completion of this 1088 action. 1090 ma-status-action-last-status: The status code returned by 1091 the last execution of this 1092 action. 1094 ma-status-action-last-message: The status message produced 1095 by the last execution of 1096 this action. 1098 ma-status-action-last-failed-completion: The date and time of the 1099 last failed completion of 1100 this action. 1102 ma-status-action-last-failed-status: The status code returned by 1103 the last failed execution of 1104 this action. 1106 ma-status-action-last-failed-message: The status message produced 1107 by the last failed execution 1108 of this action. 1110 3.5.6. Definition of ma-status-suppression-obj 1112 object { 1113 string ma-status-suppression-name; 1114 string ma-status-suppression-state; 1115 } ma-status-suppression-obj; 1117 The ma-status-suppression-obj provides status information about that 1118 status of a suppression and consists of the following elements: 1120 ma-status-schedule-name: The name of the suppression this status 1121 object refers to. 1123 ma-status-schedule-state: The state of the suppression. The value 1124 'enabled' indicates that the suppression 1125 is currently enabled. The value 'active 1126 indicates that the suppression is 1127 currently active. The value 'disabled' 1128 indicates that the suppression is 1129 currently disabled. 1131 3.5.7. Definition of ma-status-interface-obj 1132 object { 1133 string ma-status-interface-name; 1134 string ma-status-interface-type; 1135 [int ma-status-interface-speed;] 1136 [string ma-status-interface-link-layer-address;] 1137 [ip-address ma-status-interface-ip-addresses<0..*>;] 1138 [ip-address ma-status-interface-gateways<0..*>;] 1139 [ip-address ma-status-interface-dns-servers<0..*>;] 1140 } ma-status-interface-obj; 1142 The ma-status-interface-obj provides status information about network 1143 interfaces and consists of the following elements: 1145 ma-status-interface-name: A name uniquely identifying a 1146 network interface. 1148 ma-status-interface-type: The type of the network 1149 interface. 1151 ma-status-interface-speed: An optional indication of the 1152 speed of the interface 1153 (measured in bits-per- 1154 second). 1156 ma-status-interface-link-layer-address: An optional link-layer 1157 address of the interface. 1159 ma-status-interface-ip-addresses: An optional ordered list of 1160 IP addresses assigned to the 1161 interface. 1163 ma-status-interface-gateways: An optional ordered list of 1164 gateways assigned to the 1165 interface. 1167 ma-status-interface-dns-servers: An optional ordered list of 1168 DNS servers assigned to the 1169 interface. 1171 3.6. Reporting Information 1173 At a point in time specified by a Schedule, the MA will execute tasks 1174 that communicate a set of measurement results to the Collector. 1175 These Reporting Tasks will be configured to transmit task results 1176 over a specified Report Channel to a Collector. 1178 It should be noted that the output from Tasks does not need to be 1179 sent to communication Channels. It can alternatively, or 1180 additionally, be sent to other Tasks on the MA. This facilitates 1181 using a first Measurement Task to control the operation of a later 1182 Measurement Task (such as first probing available line speed and then 1183 adjusting the operation of a video testing measurement) and also to 1184 allow local processing of data to output alarms (e.g., when 1185 performance drops from earlier levels). Of course, subsequent Tasks 1186 also include Tasks that implement the reporting protocol(s) and 1187 transfer data to one or more Collector(s). 1189 The Report generated by a Reporting Task is structured hierarchically 1190 to avoid repetition of report header and Measurement Task 1191 Configuration information. The report starts with the timestamp of 1192 the report generation on the MA and details about the MA including 1193 the optional Measurement Agent ID and Group ID (controlled by the 1194 Configuration Information). 1196 Much of the report Information is optional and will depend on the 1197 implementation of the Reporting Task and any parameters defined in 1198 the Task Configuration for the Reporting Task. For example some 1199 Reporting Tasks may choose not to include the Measurement Task 1200 Configuration or Action parameters, while others may do so dependent 1201 on the Controller setting a configurable parameter in the Task 1202 Configuration. 1204 It is possible for a Reporting Task to send just the Report header 1205 (datetime and optional agent ID and/or Group ID) if no measurement 1206 data is available. Whether to send such empty reports again is 1207 dependent on the implementation of the Reporting Task and potential 1208 Task Configuration parameter. 1210 The handling of measurement data on the MA before generating a Report 1211 and transfer from the MA to the Collector is dependent on the 1212 implementation of the device, MA and/or scheduled Tasks and not 1213 defined by the LMAP standards. Such decisions may include limits to 1214 the measurement data storage and what to do when such available 1215 storage becomes depleted. It is generally suggested that 1216 implementations running out of storage stop executing new measurement 1217 tasks and retain old measurement data. 1219 No context information, such as line speed or broadband product are 1220 included within the report header information as this data is 1221 reported by individual tasks at the time they execute. Either a 1222 Measurement Task can report contextual parameters that are relevant 1223 to that particular measurement, or specific tasks can be used to 1224 gather a set of contextual and environmental data at certain times 1225 independent of the reporting schedule. 1227 After the report header information the results are reported grouped 1228 according to different Measurement Task Configurations. Each Task 1229 section optionally starts with replicating the Measurement Task 1230 Configuration information before the result headers (titles for data 1231 columns) and the result data rows. The Options reported are those 1232 used for the scheduled execution of the Measurement Task and 1233 therefore include the Options specified in the Task Configuration as 1234 well as additional Options specified in the Action. The Action 1235 Options are appended to the Task Configuration Options in exactly the 1236 same order as they were provided to the Task during execution. 1238 The result row data includes a time for the start of the measurement 1239 and optionally an end time where the duration also needs to be 1240 considered in the data analysis. 1242 Some Measurement Tasks may optionally include an indication of the 1243 cross-traffic although the definition of cross-traffic is left up to 1244 each individual Measurement Task. Some Measurement Tasks may also 1245 output other environmental measures in addition to cross-traffic such 1246 as CPU utlilisation or interface speed. 1248 Where the Configuration and Instruction information represent 1249 information transmitted via the Control Protocol, the Report 1250 represents the information that is transmitted via the Report 1251 Protocol. It is constructed at the time of sending a report and 1252 represents the inherent structure of the information that is sent to 1253 the Collector. 1255 3.6.1. Definition of ma-report-obj 1257 object { 1258 datetime ma-report-date; 1259 [uuid ma-report-agent-id;] 1260 [string ma-report-group-id;] 1261 [string ma-report-measurement-point;] 1262 [ma-report-result-obj ma-report-results<0..*>;] 1263 } ma-report-obj; 1265 The ma-report-obj provides the meta-data of a single report and 1266 consists of the following elements: 1268 ma-report-date: The date and time when the report was 1269 sent to a collector. 1271 ma-report-agent-id: An optional uuid uniquely identifying 1272 the measurement agent. 1274 ma-report-group-id: An optional identifier of the group of 1275 measurement agents this measurement 1276 agent belongs to. 1278 ma-report-measurement-point: An optional identifier for the 1279 measurement point indicating where the 1280 measurement agent is located on a path 1281 (see [RFC7398] for further details). 1283 ma-report-results: An optional and possibly empty 1284 unordered set of result objects. 1286 3.6.2. Definition of ma-report-result-obj 1288 object { 1289 string ma-report-result-schedule-name; 1290 string ma-report-result-action-name; 1291 string ma-report-result-task-name; 1292 [ma-option-obj ma-report-result-options<0..*>;] 1293 [string ma-report-result-tags<0..*>;] 1294 datetime ma-report-result-start-time; 1295 [datetime ma-report-result-end-time;] 1296 int ma-report-result-status; 1297 [ma-report-conflict-obj ma-report-result-conflicts<0..*>;] 1298 [ma-report-table-obj ma-report-result-tables<0..*>;] 1299 } ma-report-result-obj; 1301 The ma-report-result-obj provides the meta-data of a result report of 1302 a single executed action. It consists of the following elements: 1304 ma-report-result-schedule-name: The name of the schedule that 1305 produced the result. 1307 ma-report-result-action-name: The name of the action in the 1308 schedule that produced the result. 1310 ma-report-result-task-name: The name of the task that produced 1311 the result. 1313 ma-report-result-options: An optional ordered joined list of 1314 options provided by the task object 1315 and the action object when the action 1316 was started. 1318 ma-report-result-tags: An optional unordered set of tags. 1319 This is the joined set of tags 1320 provided by the task object and the 1321 action object and schedule object 1322 when the action was started. 1324 ma-report-result-start-time: The date and time of the start of the 1325 task that produced the reported 1326 result values. 1328 ma-report-result-end-time: An optional date and time indicating 1329 when the task finished. 1331 ma-report-result-status: The status code returned by the 1332 execution of the task. 1334 ma-report-result-conflicts: A possibly empty set of conflict 1335 actions that might have impacted the 1336 measurement results being reported. 1338 ma-report-result-tables: An optional and possibly empty 1339 unordered set of result tables. 1341 3.6.3. Definition of ma-report-conflict-obj 1343 object { 1344 string ma-report-conflict-schedule-name; 1345 string ma-report-conflict-action-name; 1346 string ma-report-conflict-task-name; 1347 } ma-report-conflict-obj; 1349 The ma-report-conflict-obj provides the information about conflicting 1350 action that might have impacted the measurement results. It consists 1351 of the following elements: 1353 ma-report-result-schedule-name: The name of the schedule that may 1354 have impacted the result. 1356 ma-report-result-action-name: The name of the action in the 1357 schedule that may have impacted the 1358 result. 1360 ma-report-result-task-name: The name of the task that may have 1361 impacted the result. 1363 3.6.4. Definition of ma-report-table-obj 1364 object { 1365 [ma-metric-registry-obj ma-report-table-metrics<0..*>;] 1366 [string] ma-report-table-column-labels<0..*>;] 1367 [ma-report-row-obj ma-report-table-rows<0..*>;] 1368 } ma-report-table-obj; 1370 The ma-report-table-obj represents a result table and consists of the 1371 following elements: 1373 ma-report-table-metrics: An optional and possibly empty 1374 unordered set of registered metrics 1375 and associated roles that are 1376 reported. 1378 ma-report-table-column-labels: An optional and possibly empty 1379 ordered list of column labels. 1381 ma-report-table-rows: A possibly empty ordered list of 1382 result rows. 1384 3.6.5. Definition of ma-report-row-obj 1386 object { 1387 data ma-report-row-values<0..*>; 1388 } ma-report-row-obj; 1390 The ma-report-row-obj represents a result row and consists of the 1391 following elements: 1393 ma-report-row-values: A possibly empty ordered list of result 1394 values. When present, it contains an 1395 ordered list of values that align to the 1396 set of column labels for the report. 1398 3.7. Common Objects: Schedules 1400 A Schedule specifies the execution of a single or repeated series of 1401 Actions. An Action is a Task with additional specific parameters. 1402 Each Schedule contains basically two elements: an ordered list of 1403 Actions to be executed and an Event object triggering the execution 1404 of the Schedule. The Schedule states what Actions to run (with what 1405 configuration) and when to run the Actions. A Schedule may 1406 optionally have an Event that stops the execution of the Schedule or 1407 a maximum duration after which a schedule is stopped. 1409 Multiple Actions contained as an ordered list of a single Measurement 1410 Schedule will be executed according to the execution mode of the 1411 Schedule. In sequential mode, Actions will be executed sequentially 1412 and in parallel mode, all Actions will be executed concurrently. In 1413 pipelined mode, data produced by one Action is passed to the 1414 subsequent Action. Actions contained in different Schedules execute 1415 in parallel with such conflicts being reported in the Reporting 1416 Information where necessary. If two or more Schedules have the same 1417 start time, then the two will execute in parallel. There is no 1418 mechanism to prioritise one schedule over another or to mutex 1419 scheduled tasks. 1421 As well as specifying which Actions to execute, the Schedule also 1422 specifies how to link the data outputs from each Action to other 1423 Schedules. Specifying this within the Schedule allows the highest 1424 level of flexibility since it is even possible to send the output 1425 from different executions of the same Task Configuration to different 1426 destinations. A single Task producing multiple different outputs is 1427 expected to properly tag the different result. An Action receiving 1428 the output can then filter the results based on the tag if necessary. 1429 For example, a Measurement Task might report routine results to a 1430 data Reporting Task in a Schedule that communicates hourly via the 1431 Broadband PPP interface, but also outputs emergency conditions via an 1432 alarm Reporting Task in a different Schedule communicating 1433 immediately over a GPRS channel. Note that task-to-task data 1434 transfer is always specified in association with the scheduled 1435 execution of the sending task - there is no need for a corresponding 1436 input specification for the receiving task. While it is likely that 1437 an MA implementation will use a queue mechanism between the Schedules 1438 or Actions, this Information Model does not mandate or define a 1439 queue. The Information Model, however, reports the storage allocated 1440 to Schedules and Actions so that storage usage can be monitored. 1441 Furthermore, it is recommended that MA implementations by default 1442 retain old data and stop the execution of new measurement tasks if 1443 the MA runs out of storage capacity. 1445 When specifying the task to execute within the Schedule, i.e., 1446 creating an Action, it is possible to add to the Action option 1447 parameters. This allows the Task Configuration to determine the 1448 common characteristics of a Task, while selected parameters (e.g., 1449 the test target URL) are defined within as option parameters of the 1450 Action in the schedule. A single Tasks Configuration can even be 1451 used multiple times in the same schedule with different additional 1452 parameters. This allows for efficiency in creating and transferring 1453 the Instruction. Note that the semantics of what happens if an 1454 option is defined multiple times (either in the Task Configuration, 1455 Action or in both) is not standardised and will depend upon the Task. 1456 For example, some tasks may legitimately take multiple values for a 1457 single parameter. 1459 Where Options are specified in both the Schedule and the Task 1460 Configuration, the Schedule Options are appended to those specified 1461 in the Task Configuration. 1463 Example: An Action of a Schedule references a single Measurement 1464 Task Configuration for measuring UDP latency. It specifies that 1465 results are to be sent to a Schedule with a Reporting Action. 1466 This Reporting Task of the Reporting Action is executed by a 1467 separate Schedule that specifies that it should run hourly at 5 1468 minutes past the hour. When run this Reporting Action takes the 1469 data generated by the UDP latency Measurement Task as well as any 1470 other data to be included in the hourly report and transfers it to 1471 the Collector over the Report Channel specified within its own 1472 Schedule. 1474 Schedules and Actions may optionally also be given tags that are 1475 included in result reports sent to a Collector. In addition, 1476 schedules can be given suppression tags that may be used to select 1477 Schedules and Actions for suppression. 1479 3.7.1. Definition of ma-schedule-obj 1481 object { 1482 string ma-schedule-name; 1483 ma-event-obj ma-schedule-start; 1484 [ma-event-obj ma-schedule-end;] 1485 [int ma-schedule-duration;] 1486 ma-action-obj ma-schedule-actions<0..*>; 1487 string ma-schedule-execution-mode; 1488 [string ma-schedule-tags<0..*>;] 1489 [string ma-schedule-suppression-tags<0..*>;] 1490 } ma-schedule-obj; 1492 The ma-schedule-obj is the main scheduling object. It consists of 1493 the following elements: 1495 ma-schedule-name: A name uniquely identifying a 1496 scheduling object. 1498 ma-schedule-start: An event object indicating when the 1499 schedule starts. 1501 ma-schedule-end: An optional event object controlling 1502 the forceful termination of scheduled 1503 actions. When the event occurs, all 1504 actions of the schedule will be forced 1505 to terminate gracefully. 1507 ma-schedule-duration: An optional duration in seconds for the 1508 schedule. All actions of the schedule 1509 will be forced to terminate gracefully 1510 after the duration number of seconds 1511 past the start of the schedule. 1513 ma-schedule-actions: A possibly empty ordered list of 1514 actions to invoke when the schedule 1515 starts. 1517 ma-schedule-execution-mode: Indicates whether the actions should be 1518 executed sequentially, in parallel, or 1519 in a pipelined mode (where data 1520 produced by one action is passed to the 1521 subsequent action). The default 1522 execution mode is pipelined. 1524 ma-schedule-tags: An optional unordered set of tags that 1525 are reported together with the 1526 measurement results to a collector. 1528 ma-schedule-suppression-tags: An optional unordered set of 1529 suppression tags that are used to 1530 select schedules to be suppressed. 1532 3.7.2. Definition of ma-action-obj 1534 object { 1535 string ma-action-name; 1536 string ma-action-config-task-name; 1537 [ma-option-obj ma-action-task-options<0..*>;] 1538 [string ma-action-destinations<0..*>;] 1539 [string ma-action-tags<0..*>;] 1540 [string ma-action-suppression-tags<0..*>;] 1541 } ma-action-obj; 1543 The ma-action-obj models a task together with its schedule specific 1544 task options and destination schedules. It consists of the following 1545 elements: 1547 ma-action-name: A name uniquely identifying an action 1548 of a scheduling object. 1550 ma-action-config-task-name: A name identifying the configured task 1551 to be invoked by the action. 1553 ma-action-task-options: An optional and possibly empty ordered 1554 list of options (name-value pairs) that 1555 are passed to the task by appending 1556 them to the options configured for the 1557 task object. 1559 ma-action-destinations: An optional and possibly empty 1560 unordered set of names of destination 1561 schedules that consume output produced 1562 by this action. 1564 ma-action-tags: An optional unordered set of tags that 1565 are reported together with the 1566 measurement results to a collector. 1568 ma-action-suppression-tags: An optional unordered set of 1569 suppression tags that are used to 1570 select actions to be suppressed. 1572 3.8. Common Objects: Channels 1574 A Channel defines a bi-directional communication channel between the 1575 MA and a Controller or Collector. Multiple Channels can be defined 1576 to enable results to be split or duplicated across different 1577 Collectors. 1579 Each Channel contains the details of the remote endpoint (including 1580 location and security credential information such as the 1581 certificate). The timing of when to communicate over a Channel is 1582 specified by the Schedule which executes the corresponding Control or 1583 Reporting Task. The certificate can be the digital certificate 1584 associated to the FQDN in the URL or it can be the certificate of the 1585 Certification Authority that was used to issue the certificate for 1586 the FQDN (Fully Qualified Domain Name) of the target URL (which will 1587 be retrieved later on using a communication protocol such as TLS). 1588 In order to establish a secure channel, the MA will use it's own 1589 security credentials (in the Configuration Information) and the given 1590 credentials for the individual Channel end-point. 1592 As with the Task Configurations, each Channel is also given a text 1593 name by which it can be referenced as a Task Option. 1595 Although the same in terms of information, Channels used for 1596 communication with the Controller are referred to as Control Channels 1597 whereas Channels to Collectors are referred to as Report Channels. 1598 Hence Control Channels will be referenced from Control Tasks executed 1599 by a Control Schedule, whereas Report Channels will be referenced 1600 from within Reporting Tasks executed by an Instruction Schedule. 1602 Multiple interfaces are also supported. For example the Reporting 1603 Task could be configured to send some results over GPRS. This is 1604 especially useful when such results indicate the loss of connectivity 1605 on a different network interface. 1607 Example: A Channel used for reporting results may specify that 1608 results are to be sent to the URL (https://collector.example.org/ 1609 report/), using the appropriate digital certificate to establish a 1610 secure channel. 1612 3.8.1. Definition of ma-channel-obj 1614 object { 1615 string ma-channel-name; 1616 url ma-channel-target; 1617 credentials ma-channel-credentials; 1618 [string ma-channel-interface-name;] 1619 } ma-channel-obj; 1621 The ma-channel-obj consists of the following elements: 1623 ma-channel-name: A unique name identifying the channel 1624 object. 1626 ma-channel-target: A URL identifying the target channel 1627 endpoint. 1629 ma-channel-credentials: The security credentials needed to 1630 establish a secure channel. 1632 ma-channel-interface-name: An optional name of the network interface 1633 to be used. If not present, the system 1634 will select a suitable interface. 1636 3.9. Common Objects: Task Configurations 1638 Conceptually each Task Configuration defines the parameters of a Task 1639 that the Measurement Agent (MA) may perform at some point in time. 1640 It does not by itself actually instruct the MA to perform them at any 1641 particular time (this is done by a Schedule). Tasks can be 1642 Measurement Tasks (i.e., those Tasks actually performing some type of 1643 passive or active measurement) or any other scheduled activity 1644 performed by the MA such as transferring information to or from the 1645 Controller and Collectors. Other examples of Tasks may include data 1646 manipulation or processing Tasks conducted on the MA. 1648 A Measurement Task Configuration is the same in information terms to 1649 any other Task Configuration. Both measurement and non-measurement 1650 Tasks have registry entries to enable the MA to uniquely identify the 1651 Task it should execute and retrieve the schema for any parameters 1652 that may be passed to the Task. Registry entries are specified as a 1653 URI and can therefore be used to identify the Task within a namespace 1654 or point to a web or local file location for the Task information. 1655 As mentioned previously, these URIs may be used to identify the 1656 Measurement Task in a public namespace 1657 [I-D.ietf-ippm-metric-registry]. 1659 Example: A Measurement Task Configuration may configure a single 1660 Measurement Task for measuring UDP latency. The Measurement Task 1661 Configuration could define the destination port and address for 1662 the measurement as well as the duration, internal packet timing 1663 strategy and other parameters (for example a stream for one hour 1664 and sending one packet every 500 ms). It may also define the 1665 output type and possible parameters (for example the output type 1666 can be the 95th percentile mean) where the measurement task 1667 accepts such parameters. It does not define when the task starts 1668 (this is defined by the Schedule element), so it does not by 1669 itself instruct the MA to actually perform this Measurement Task. 1671 The Task Configuration will include a local short name for reference 1672 by a Schedule. Task Configurations may also refer to registry 1673 entries as described above. In addition the Task can be configured 1674 through a set of configuration Options. The nature and number of 1675 these Options will depend upon the Task. These options are expressed 1676 as name-value pairs although the 'value' may be a structured object 1677 instead of a simple string or numeric value. The implementation of 1678 these name-value pairs will vary between data models. 1680 An Option that must be present for Reporting Tasks is the Channel 1681 reference specifying how to communicate with a Collector. This is 1682 included in the task options and will have a value that matches a 1683 channel name that has been defined in the Instruction. Similarly 1684 Control Tasks will have a similar option with the value set to a 1685 specified Control Channel. 1687 A reporting task might also have a flag parameter to indicate whether 1688 to report if there is no measurement result data pending to be 1689 transferred to the Collector. In addition many tasks will also take 1690 as a parameter which interface to operate over. 1692 In addition the Task Configuration may optionally also be given tags 1693 that can carry a Measurement Cycle ID. The purpose of this ID is to 1694 easily identify a set of measurement results that have been produced 1695 by Measurement Tasks with comparable Options. This ID could be 1696 manually incremented or otherwise changed when an Option change is 1697 implemented which could mean that two sets of results should not be 1698 directly compared. 1700 3.9.1. Definition of ma-task-obj 1702 object { 1703 string ma-task-name; 1704 ma-metric-registry-obj ma-task-metrics<0..*>; 1705 [ma-option-obj ma-task-options<0..*>;] 1706 [string ma-task-tags<0..*>;] 1707 } ma-task-obj; 1709 The ma-task-obj defines a configured task that can be invoked as part 1710 of an action. A configured task can be referenced by its name and it 1711 contains a set of URIs to link to a metrics registry or a local 1712 specification of the task. Options allow the configuration of task 1713 parameters (in the form of name-value pairs). The ma-task-obj 1714 consists of the following elements: 1716 ma-task-name: A name uniquely identifying a 1717 configured task object. 1719 ma-task-metrics: A possibly empty unordered set of 1720 registered metrics and associated roles 1721 the configured measurement task will 1722 use. 1724 ma-task-options: An optional and possibly empty ordered 1725 list of options (name-value pairs) that 1726 are passed to the configured task. 1728 ma-task-tags: An optional unordered set of tags that 1729 are reported together with the 1730 measurement results to a collector. 1732 3.9.2. Definition of ma-option-obj 1734 object { 1735 string ma-option-name; 1736 [object ma-option-value;] 1737 } ma-option-obj; 1739 The ma-option-obj models a name-value pair and consists of the 1740 following elements: 1742 ma-option-name: The name of the option. 1744 ma-option-value: The optional value of the option. 1746 While many of the Task Configuration Options are left to individual 1747 tasks to define, some common Options are used by multiple tasks and 1748 benefit from standardisation: 1750 o Channel is used to specify the details of an endpoint for Control 1751 or Reporting Task communications and is detailed elsewhere in this 1752 document. The common option name for specifying the channel is 1753 "channel". 1755 3.10. Common Objects: Registry Information 1757 Tasks and actions can be associated with entries in a metrics 1758 registry. A metric is identified by a URI and a metric may have 1759 associated roles. 1761 3.10.1. Definition of ma-metric-registry-obj 1763 object { 1764 uri ma-metric-registry-entry; 1765 [string ma-metric-registry-role<0..*>;] 1766 } ma-metric-registry-obj; 1768 The ma-metric-registry-obj defines a registered metric and the 1769 associated role(s). The ma-metric-registry-obj consists of the 1770 following elements: 1772 ma-metric-registry-entry: A URI identifying a metric in a metric 1773 registry. 1775 ma-metric-registry-role: An optional and possibly empty unordered 1776 set of roles for the metric. 1778 3.11. Common Objects: Event Information 1780 The Event information object used throughout the information models 1781 can initially take one of several different forms. Additional forms 1782 may be defined later in order to bind the execution of schedules to 1783 additional events. The initially defined Event forms are: 1785 1. Periodic Timing: Emits multiple events periodically according to 1786 an interval time defined in seconds 1788 2. Calendar Timing: Emits multiple events according to a calendar 1789 based pattern, e.g., 22 minutes past each hour of the day on 1790 weekdays 1792 3. One Off Timing: Emits one event at a specific date and time 1793 4. Immediate: Emits one event as soon as possible 1795 5. Startup: Emits an event whenever the MA is started (e.g., at 1796 device startup) 1798 6. Controller Lost: Emits an event when connectivity to the 1799 controller has been lost 1801 7. Controller Connected: Emits an event when connectivity to the 1802 controller has been (re-)established 1804 Optionally each of the Event options may also specify a randomness 1805 that should be evaluated and applied separately to each indicated 1806 event. This randomness parameter defines a uniform interval in 1807 seconds over which the start of the task is delayed from the starting 1808 times specified by the event object. 1810 Both the Periodic and Calendar timing objects allow for a series of 1811 Actions to be executed. While both have an optional end time, it is 1812 best practice to always configure an end time and refresh the 1813 information periodically to ensure that lost MAs do not continue 1814 their tasks forever. 1816 Startup events are only created on device startup, not when a new 1817 Instruction is transferred to the MA. If scheduled task execution is 1818 desired both on the transfer of the Instruction and on device restart 1819 then both the Immediate and Startup timing needs to be used in 1820 conjunction. 1822 The datetime format used for all elements in the information model 1823 MUST conform to RFC 3339 [RFC3339]. 1825 3.11.1. Definition of ma-event-obj 1827 object { 1828 string ma-event-name; 1829 union { 1830 ma-periodic-obj ma-event-periodic; 1831 ma-calendar-obj ma-event-calendar; 1832 ma-one-off-obj ma-event-one-off; 1833 ma-immediate-obj ma-event-immediate; 1834 ma-startup-obj ma-event-startup; 1835 ma-controller-lost-obj ma-event-controller-lost; 1836 ma-controller-connected-obj ma-event-controller-connected; 1837 } 1838 [int ma-event-random-spread;] 1839 } ma-event-obj; 1841 The ma-event-obj is the main event object. Event objects are 1842 identified by a name. A generic event object itself contains a more 1843 specific event object. The set of specific event objects should be 1844 extensible. The initial set of specific event objects is further 1845 described below. The ma-event-obj also includes an optional uniform 1846 random spread that can be used to randomize the start times of 1847 schedules triggered by an event. The ma-event-obj consists of the 1848 following elements: 1850 ma-event-name: The name uniquely identifies an event 1851 object. Schedules refer to event 1852 objects by this name. 1854 ma-event-periodic: The ma-event-periodic is present for 1855 periodic timing objects. 1857 ma-event-calendar: The ma-event-calendar is present for 1858 calendar timing objects. 1860 ma-event-one-off: The ma-event-one-off is present for 1861 one-off timing objects. 1863 ma-event-immediate: The ma-event-immediate is present for 1864 immediate event objects. 1866 ma-event-startup: The ma-event-startup is present for 1867 startup event objects. 1869 ma-event-controller-lost: The ma-event-controller-lost is 1870 present for connectivity to 1871 controller lost event objects. 1873 ma-event-controller-connected: The ma-event-controller-connected is 1874 present for connectivity to a 1875 controller established event objects. 1877 ma-event-random-spread: The optional ma-event-random-spread 1878 adds a random delay defined in 1879 seconds to the event object. 1881 3.11.2. Definition of ma-periodic-obj 1883 object { 1884 [datetime ma-periodic-start;] 1885 [datetime ma-periodic-end;] 1886 int ma-periodic-interval; 1887 } ma-periodic-obj; 1889 The ma-periodic-obj timing object has an optional start and an 1890 optional end time plus a periodic interval. Schedules using an ma- 1891 periodic-obj are started periodically between the start and end time. 1892 The ma-periodic-obj consists of the following elements: 1894 ma-periodic-start: The optional date and time at which 1895 Schedules using this object are first 1896 started. If not present it defaults to 1897 immediate. 1899 ma-periodic-end: The optional date and time at which 1900 Schedules using this object are last 1901 started. If not present it defaults to 1902 indefinite. 1904 ma-periodic-interval: The interval defines the time in seconds 1905 between two consecutive starts of tasks. 1907 3.11.3. Definition of ma-calendar-obj 1909 Calendar Timing supports the routine execution of Schedules at 1910 specific times and/or on specific dates. It can support more 1911 flexible timing than Periodic Timing since the execution of Schedules 1912 does not have to be uniformly spaced. For example a Calendar Timing 1913 could support the execution of a Measurement Task every hour between 1914 6pm and midnight on weekdays only. 1916 Calendar Timing is also required to perform measurements at 1917 meaningful times in relation to network usage (e.g., at peak times). 1918 If the optional timezone offset is not supplied then local system 1919 time is assumed. This is essential in some use cases to ensure 1920 consistent peak-time measurements as well as supporting MA devices 1921 that may be in an unknown timezone or roam between different 1922 timezones (but know their own timezone information such as through 1923 the mobile network). 1925 The calendar elements within the Calendar Timing do not have defaults 1926 in order to avoid accidental high-frequency execution of Tasks. If 1927 all possible values for an element are desired then the wildcard * is 1928 used. 1930 object { 1931 [datetime ma-calendar-start;] 1932 [datetime ma-calendar-end;] 1933 [string ma-calendar-months<0..*>;] 1934 [string ma-calendar-days-of-week<0..*>;] 1935 [string ma-calendar-days-of-month<0..*>;] 1936 [string ma-calendar-hours<0..*>;] 1937 [string ma-calendar-minutes<0..*>;] 1938 [string ma-calendar-seconds<0..*>;] 1939 [int ma-calendar-timezone-offset;] 1940 } ma-calendar-obj; 1942 ma-calendar-start: The optional date and time at which 1943 Schedules using this object are first 1944 started. If not present it defaults to 1945 immediate. 1947 ma-calendar-end: The optional date and time at which 1948 Schedules using this object are last 1949 started. If not present it defaults to 1950 indefinite. 1952 ma-calendar-months: The optional set of months (1-12) on 1953 which tasks scheduled using this object 1954 are started. The wildcard * means all 1955 months. If not present, it defaults to 1956 no months. 1958 ma-calendar-days-of-week: The optional set of days of a week 1959 ("Mon", "Tue", "Wed", "Thu", "Fri", 1960 "Sat", "Sun") on which tasks scheduled 1961 using this object are started. The 1962 wildcard * means all days of the week. 1963 If not present, it defaults to no days. 1965 ma-calendar-days-of-month: The optional set of days of a months 1966 (1-31) on which tasks scheduled using 1967 this object are started. The wildcard 1968 * means all days of a months. If not 1969 present, it defaults to no days. 1971 ma-calendar-hours: The optional set of hours (0-23) on 1972 which tasks scheduled using this object 1973 are started. The wildcard * means all 1974 hours of a day. If not present, it 1975 defaults to no hours. 1977 ma-calendar-minutes: The optional set of minutes (0-59) on 1978 which tasks scheduled using this object 1979 are started. The wildcard * means all 1980 minutes of an hour. If not present, it 1981 defaults to no hours. 1983 ma-calendar-seconds: The optional set of seconds (0-59) on 1984 which tasks scheduled using this object 1985 are started. The wildcard * means all 1986 seconds of an hour. If not present, it 1987 defaults to no seconds. 1989 ma-calendar-timezone-offset: The optional timezone offest in hours. 1990 If not present, it defaults to the 1991 system's local timezone. 1993 If a day of the month is specified that does not exist in the month 1994 (e.g., 29th of Feburary) then those values are ignored. 1996 3.11.4. Definition of ma-one-off-obj 1998 object { 1999 datetime ma-one-off-time; 2000 } ma-one-off-obj; 2002 The ma-one-off-obj timing object specifies a fixed point in time. 2003 Schedules using an ma-one-off-obj are started once at the specified 2004 date and time. The ma-one-off-obj consists of the following 2005 elements: 2007 ma-one-off-time: The date and time at which Schedules using 2008 this object are started. 2010 3.11.5. Definition of ma-immediate-obj 2012 object { 2013 // empty 2014 } ma-immediate-obj; 2016 The ma-immediate-obj event object has no further information 2017 elements. Schedules using an ma-immediate-obj are started as soon as 2018 possible. 2020 3.11.6. Definition of ma-startup-obj 2022 object { 2023 // empty 2024 } ma-startup-obj; 2026 The ma-startup-obj event object has no further information elements. 2027 Schedules or suppressions using an ma-startup-obj are started at MA 2028 initialization time. 2030 3.11.7. Definition of ma-controller-lost-obj 2032 object { 2033 // empty 2034 } ma-controller-lost-obj; 2036 The ma-controller-lost-obj event object has no further information 2037 elements. The ma-controller-lost-obj indicates that connectivity to 2038 the controller has been lost. This is determined by a timer started 2039 after each successful contact with a controller. When the timer 2040 reaches the controller-timeout (measured in seconds), an ma- 2041 controller-lost-obj event is generated. This event may be used to 2042 start a suppression. 2044 3.11.8. Definition of ma-controller-connected-obj 2046 object { 2047 // empty 2048 } ma-controller-connected-obj; 2050 The ma-controller-connected-obj event object has no further 2051 information elements. The ma-controller-connected-obj indicates that 2052 connectivity to the controller has been established again after it 2053 was lost. This event may be used to end a suppression. 2055 4. IANA Considerations 2057 This document makes no request of IANA. 2059 Note to RFC Editor: this section may be removed on publication as an 2060 RFC. 2062 5. Security Considerations 2064 This Information Model deals with information about the control and 2065 reporting of the Measurement Agent. There are broadly two security 2066 considerations for such an Information Model. Firstly the 2067 Information Model has to be sufficient to establish secure 2068 communication channels to the Controller and Collector such that 2069 other information can be sent and received securely. Additionally, 2070 any mechanisms that the Network Operator or other device 2071 administrator employs to pre-configure the MA must also be secure to 2072 protect unauthorized parties from modifying pre-configuration 2073 information. These mechanisms are important to ensure that the MA 2074 cannot be hijacked, for example to participate in a distributed 2075 denial of service attack. 2077 The second consideration is that no mandated information items should 2078 pose a risk to confidentiality or privacy given such secure 2079 communication channels. For this latter reason items such as the MA 2080 context and MA ID are left optional and can be excluded from some 2081 deployments. This would, for example, allow the MA to remain 2082 anonymous and for information about location or other context that 2083 might be used to identify or track the MA to be omitted or blurred. 2085 The Information Model should support wherever relevant, all the 2086 security and privacy requirements associated with the LMAP Framework. 2088 6. Acknowledgements 2090 The notation was inspired by the notation used in the ALTO protocol 2091 specification. 2093 Philip Eardley, Trevor Burbridge, Marcelo Bagnulo and Juergen 2094 Schoenwaelder worked in part on the Leone research project, which 2095 received funding from the European Union Seventh Framework Programme 2096 [FP7/2007-2013] under grant agreement number 317647. 2098 Juergen Schoenwaelder was partly funded by Flamingo, a Network of 2099 Excellence project (ICT-318488) supported by the European Commission 2100 under its Seventh Framework Programme. 2102 7. References 2104 7.1. Normative References 2106 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2107 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 2108 RFC2119, March 1997, 2109 . 2111 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2112 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2113 . 2115 [RFC7594] Eardley, P., Morton, A., Bagnulo, M., Burbridge, T., 2116 Aitken, P., and A. Akhter, "A Framework for Large-Scale 2117 Measurement of Broadband Performance (LMAP)", RFC 7594, 2118 DOI 10.17487/RFC7594, September 2015, 2119 . 2121 7.2. Informative References 2123 [I-D.ietf-ippm-metric-registry] 2124 Bagnulo, M., Claise, B., Eardley, P., Morton, A., and A. 2125 Akhter, "Registry for Performance Metrics", draft-ietf- 2126 ippm-metric-registry-06 (work in progress), March 2016. 2128 [I-D.ietf-lmap-yang] 2129 Schoenwaelder, J. and V. Bajpai, "A YANG Data Model for 2130 LMAP Measurement Agents", draft-ietf-lmap-yang-04 (work in 2131 progress), March 2016. 2133 [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between 2134 Information Models and Data Models", RFC 3444, DOI 10 2135 .17487/RFC3444, January 2003, 2136 . 2138 [RFC7398] Bagnulo, M., Burbridge, T., Crawford, S., Eardley, P., and 2139 A. Morton, "A Reference Path and Measurement Points for 2140 Large-Scale Measurement of Broadband Performance", RFC 2141 7398, DOI 10.17487/RFC7398, February 2015, 2142 . 2144 Appendix A. Open Issues 2146 o There is a proposal to add a cycle number to the result reports 2147 but it is still unclear how exactly the cycle number is calculated 2148 and how parameters needed to calculate the cycle interval are 2149 conveyed to the MA. 2151 o There is a proposal to remove the well-known Channel option name 2152 from the information model. 2154 o There is a potentially unresolved discussion around the ma- 2155 schedule-end and ma-schedule-duration. 2157 o It may be useful to add ma-capability-tags so that MAs could be 2158 tagged with additional information (e.g., dsl, cable, home, 2159 office, nat, ipv4, ipv6, ...). 2161 Appendix B. Non-editorial Changes since -09 2163 o Added ma-status-schedule-storage and ma-status-action-storage. 2165 o Removed suppress-by-default. 2167 o Moved ma-report-result-metrics of the ma-report-result-obj to ma- 2168 report-table-metrics of the ma-report-table-obj so that the 2169 relationship between metrics and result tables is clear. 2171 o Added ma-report-conflict-obj. 2173 o Added ma-report-result-status to ma-report-result-obj. 2175 o Several clarifications and bug fixes. 2177 Appendix C. Non-editorial Changes since -08 2179 o Refactored the ma-report-task-obj into the ma-report-result-obj. 2181 o Introduced the ma-report-table-obj so that a result can contain 2182 multiple tables. 2184 o Report schedule, action, and task name as part of the ma-report- 2185 result-obj. 2187 o Report conflicts per ma-report-result-obj and not per ma-report- 2188 row-obj. 2190 o Report the start/end time as part of the ma-report-result-obj. 2192 Appendix D. Non-editorial Changes since -07 2194 o Added ma-schedule-end and ma-schedule-duration. 2196 o Changed the granularity of scheduler timings to seconds. 2198 o Added ma-status-suppression-obj to report the status of 2199 suppressions as done in the YANG data model. 2201 o Added counters to schedule and action status objects to match the 2202 counters in the YANG data model. 2204 o Using tags to pass information such as a measurement cycle 2205 identifier to the collector. 2207 o Using suppression tags and glob-style matching to select schedules 2208 and actions to be suppressed. 2210 Appendix E. Non-editorial Changes since -06 2212 o The default execution mode is pipelined (LI12) 2213 o Added text to define which action consumes data in sequential, 2214 pipelines, and parallel execution mode (LI11) 2216 o Added ma-config-measurement-point, ma-report-measurement-point, 2217 and ma-config-report-measurement-point to configure and report the 2218 measurement point (LI10) 2220 o Turned ma-suppression-obj into a list that uses a start event and 2221 a stop event to define the start and end of suppression; this 2222 unifies the handling of suppression and loss of controller 2223 connectivity (LI09) 2225 o Added ma-controller-lost-obj and ma-controller-ok-obj event 2226 objects (LI09) 2228 o Added ma-status-schedule-obj to report the status of a schedule 2229 and refactored ma-task-status-obj into ma-status-action-obj to 2230 report the status of an action (LI07, LI08) 2232 o Introduced a common ma-metric-registry-obj that identifies a 2233 metric and a set of associated roles and added this object to 2234 expose metric capabilities and to support the configuration of 2235 metrics and to report the metrics used (LI06) 2237 o Introduced ma-capability-obj and ma-capability-task-obj to expose 2238 the capabilities of a measurement agent (LI05) 2240 o Use 'ordered list' or 'unordered set' instead of list, collection, 2241 etc. (LI02) 2243 o Clarification that Actions are part of a Schedule (LI03) 2245 o Deleted terms that are not strictly needed (LI04) 2247 Appendix F. Non-editorial Changes since -05 2249 o A task can now reference multiply registry entries. 2251 o Consistent usage of the term Action and Task. 2253 o Schedules are triggered by Events instead of Timings; Timings are 2254 just one of many possible event sources. 2256 o Actions feed into other Schedules (instead of Actions within other 2257 Schedules). 2259 o Removed the notion of multiple task outputs. 2261 o Support for sequential, parallel, and pipelined execution of 2262 Actions. 2264 Authors' Addresses 2266 Trevor Burbridge 2267 BT 2268 Adastral Park, Martlesham Heath 2269 Ipswich IP5 3RE 2270 United Kingdom 2272 Email: trevor.burbridge@bt.com 2274 Philip Eardley 2275 BT 2276 Adastral Park, Martlesham Heath 2277 Ipswich IP5 3RE 2278 United Kingdom 2280 Email: philip.eardley@bt.com 2282 Marcelo Bagnulo 2283 Universidad Carlos III de Madrid 2284 Av. Universidad 30 2285 Leganes, Madrid 28911 2286 Spain 2288 Email: marcelo@it.uc3m.es 2290 Juergen Schoenwaelder 2291 Jacobs University Bremen 2292 Campus Ring 1 2293 Bremen 28759 2294 Germany 2296 Email: j.schoenwaelder@jacobs-university.de