idnits 2.17.1 draft-ietf-lmap-information-model-08.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 703 has weird spacing: '...ion-obj ma-in...' == Line 889 has weird spacing: '...ask-obj ma-ca...' == Line 910 has weird spacing: '...try-obj ma-ca...' == Line 933 has weird spacing: '...ion-obj ma-st...' == Line 966 has weird spacing: '...ion-obj ma-...' == (3 more instances...) -- The document date (March 15, 2016) is 2963 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-05 == Outdated reference: A later version (-12) exists of draft-ietf-lmap-yang-01 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: September 16, 2016 M. Bagnulo 6 Universidad Carlos III de Madrid 7 J. Schoenwaelder 8 Jacobs University Bremen 9 March 15, 2016 11 Information Model for Large-Scale Measurement Platforms (LMAP) 12 draft-ietf-lmap-information-model-08 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 September 16, 2016. 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 . . . . . . . . . . . . . 12 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 . . . . . . . . . . . . . . 19 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-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-task-obj . . . . . . . . . . 27 88 3.6.3. Definition of ma-report-row-obj . . . . . . . . . . . 28 89 3.7. Common Objects: Schedules . . . . . . . . . . . . . . . . 29 90 3.7.1. Definition of ma-schedule-obj . . . . . . . . . . . . 30 91 3.7.2. Definition of ma-action-obj . . . . . . . . . . . . . 32 92 3.8. Common Objects: Channels . . . . . . . . . . . . . . . . 33 93 3.8.1. Definition of ma-channel-obj . . . . . . . . . . . . 33 94 3.9. Common Objects: Task Configurations . . . . . . . . . . . 34 95 3.9.1. Definition of ma-task-obj . . . . . . . . . . . . . . 35 96 3.9.2. Definition of ma-option-obj . . . . . . . . . . . . . 36 97 3.10. Common Objects: Registry Information . . . . . . . . . . 37 98 3.10.1. Definition of ma-metric-registry-obj . . . . . . . . 37 99 3.11. Common Objects: Event Information . . . . . . . . . . . . 37 100 3.11.1. Definition of ma-event-obj . . . . . . . . . . . . . 38 101 3.11.2. Definition of ma-periodic-obj . . . . . . . . . . . 39 102 3.11.3. Definition of ma-calendar-obj . . . . . . . . . . . 40 103 3.11.4. Definition of ma-one-off-obj . . . . . . . . . . . . 42 104 3.11.5. Definition of ma-immediate-obj . . . . . . . . . . . 42 105 3.11.6. Definition of ma-startup-obj . . . . . . . . . . . . 42 106 3.11.7. Definition of ma-controller-lost-obj . . . . . . . . 42 107 3.11.8. Definition of ma-controller-connected-obj . . . . . 43 108 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 43 109 5. Security Considerations . . . . . . . . . . . . . . . . . . . 43 110 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 44 111 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 44 112 7.1. Normative References . . . . . . . . . . . . . . . . . . 44 113 7.2. Informative References . . . . . . . . . . . . . . . . . 44 114 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 45 115 A.1. Remove suppress-by-default . . . . . . . . . . . . . . . 45 116 A.2. Overlapping schedules/actions are skipped . . . . . . . . 45 117 A.3. Storage usage reporting and control . . . . . . . . . . . 45 118 A.4. Configuration vs. instruction: ma-task-obj . . . . . . . 45 119 A.5. Streamline the reporting model . . . . . . . . . . . . . 46 120 Appendix B. Non-editorial Changes since -07 . . . . . . . . . . 46 121 Appendix C. Non-editorial Changes since -06 . . . . . . . . . . 46 122 Appendix D. Non-editorial Changes since -05 . . . . . . . . . . 47 123 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 47 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. 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 Tasks it 218 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 Tasks that should be 223 executed. This includes the task execution Schedules (other than 224 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 Timing information. It also includes Task Suppression 228 information that is used to over-ride normal Task execution. 230 4. Logging Information. Information transmitted from the MA to the 231 Controller detailing the results of any configuration operations 232 along with error and status information from the operation of the 233 MA. 235 5. Capability and Status Information. Information on the general 236 status and capabilities of the MA. For example, the set of 237 measurements that are supported on the device. 239 6. Reporting Information. Information transmitted from the MA to 240 one or more Collectors including measurement results and the 241 context in which they were conducted. 243 In addition the MA may hold further information not described herein, 244 and which may be optionally transferred to or from other systems 245 including the Controller and Collector. One example of information 246 in this category is subscriber or line information that may be 247 extracted by a task and reported by the MA in the reporting 248 communication to a Collector. 250 It should also be noted that the MA may be in communication with 251 other management systems which may be responsible for configuring and 252 retrieving information from the MA device. Such systems, where 253 available, can perform an important role in transferring the pre- 254 configuration information to the MA or enabling/disabling the 255 measurement functionality of the MA. 257 The Information Model is divided into sub-sections for a number of 258 reasons. Firstly the grouping of information facilitates reader 259 understanding. Secondly, the particular groupings chosen are 260 expected to map to different protocols or different transmissions 261 within those protocols. 263 The granularity of data transmitted in each operation of the Control 264 and Report Protocols is not dictated by the Information Model. For 265 example, the Instruction object may be delivered in a single 266 operation. Alternatively, Schedules and Task Configurations may be 267 separated or even each Schedule/Task Configuration may be delivered 268 individually. Similarly the Information Model does not dictate 269 whether data is read, write, or read/write. For example, some 270 Control Protocols may have the ability to read back Configuration and 271 Instruction information which have been previously set on the MA. 272 Lastly, while some protocols may simply overwrite information (for 273 example refreshing the entire Instruction Information), other 274 protocols may have the ability to update or delete selected items of 275 information. 277 The information in these six sections is captured by a number of 278 common information objects. These objects are also described later 279 in this document and comprise of: 281 1. Schedules. A set of Schedules tell the MA to do something. 282 Without a Schedule no Task (from a measurement to reporting or 283 communicating with the Controller) is ever executed. Schedules 284 are used within the Instruction to specify what tasks should be 285 performed, when, and how to direct their results. A Schedule is 286 also used within the pre-Configuration and Configuration 287 information in order to execute the Task or Tasks required to 288 communicate with the Controller. 290 2. Channels. A set of Channel objects are used to communicate with 291 a number of endpoints (i.e., the Controller and Collectors). 292 Each Channel object contains the information required for the 293 communication with a single endpoint such as the target location 294 and security details. 296 3. Task Configurations. A set of Task Configurations is used to 297 configure the Tasks that are run by the MA. This includes the 298 registry entries for the Task and any configuration parameters. 299 Task Configurations are referenced from a Schedule in order to 300 specify what Tasks the MA should execute. 302 4. Events. A set of Event objects that can be referenced from the 303 Schedules. Each Schedule always references exactly one Event 304 object. An Event object specifies either a singleton or series 305 of events that indicate when Tasks should be executed. A 306 commonly used kind of Event objects are Timing objects. 308 Figure 1 illustrates the structure in which these common information 309 objects are referenced. The references are achieved by each object 310 (Task Configuration, Event) being given a short textual name that is 311 used by other objects. The objects shown in parenthesis are part of 312 the internal object structure of a Schedule. Channels are not shown 313 in the diagram since they are only used as an option by selected Task 314 Configurations but are similarly referenced using a short text name. 316 Schedule 317 |-- triggered by --> Event 318 | 319 |-- executes --> Action 1 320 | |-- using --> Task Configuration 321 | | 322 | `-- feeding to --> Destination Schedule 323 : 324 : 325 `-- exceutes --> Action N 326 |-- using --> Task Configuration 327 | 328 `-- feeding to --> Destination Schedule 330 Figure 1: Relationship between Schedules, Events, Actions, Task 331 Configurations, and Destination Schedules 333 It should be clear that the top-level behavior of an MA is simply to 334 execute Schedules. Every Action contained in a Schedule is defined 335 as a Task. As such, these Actions are configured through Task 336 Configurations and executed according to the Event object referenced 337 by the Schedule in which they appear. Note, however, that Actions 338 can have Action specific parameters. 340 Tasks can implement a variety of different types of Actions. While 341 in terms of the Information Model, all Tasks have the same structure, 342 it can help conceptually to think of different Task categories: 344 1. Measurement Tasks measure some aspect of network performance or 345 traffic. They may also capture contextual information from the 346 MA device or network interfaces such as the device type or 347 interface speed. 349 2. Data Transfer Tasks 351 A. Reporting Tasks report the results of Measurement Tasks to 352 Collectors 354 B. Control Task(s) implement the Control Protocol and 355 communicate with the Controller. 357 3. Data Analysis Tasks can exist to analyse data from other 358 Measurement Tasks locally on the MA 360 4. Data Management Tasks may exist to clean-up, filter or compress 361 data on the MA such as Measurement Task results 363 Figure 1 indicates that Actions can produce data that is fed into 364 Destination Schedules. This can by used by Actions implementing 365 Measurement Tasks to feed measurement results to a Schedule that 366 triggers Actions implementing Reporting Tasks. Data fed to a 367 Destination Schedule is consumed by the first Action of the 368 Destination Schedule if the Destination Schedule is using sequential 369 or pipelined execution mode and it is consumed by all Actions of the 370 Destination Schedule if the Destination Schedule is using parallel 371 execution mode. 373 3.1. Pre-Configuration Information 375 This information is the minimal information that needs to be pre- 376 configured to the MA in order for it to successfully communicate with 377 a Controller during the registration process. Some of the Pre- 378 Configuration Information elements are repeated in the Configuration 379 Information in order to allow an LMAP Controller to update these 380 items. The pre-configuration information also contains some elements 381 that are not under the control of the LMAP framework (such as the 382 device identifier and device security credentials). 384 This Pre-Configuration Information needs to include a URL of the 385 initial Controller from where configuration information can be 386 communicated along with the security information required for the 387 communication including the certificate of the Controller (or the 388 certificate of the Certification Authority which was used to issue 389 the certificate for the Controller). All this is expressed as a 390 Channel. While multiple Channels may be provided in the Pre- 391 Configuration Information they must all be associated with a single 392 Controller (e.g., over different interfaces or network protocols). 394 Where the MA pulls information from the Controller, the Pre- 395 Configuration Information also needs to contain the timing of the 396 communication with the Controller as well as the nature of the 397 communication itself (such as the protocol and data to be 398 transferred). The timing is given as a Schedule that executes the 399 Task(s) responsible for communication with the Controller. It is 400 this Task (or Tasks) that implement the Control protocol between the 401 MA and the Controller and utilises the Channel information. The 402 Task(s) may take additional parameters in which case a Task 403 Configuration can also be included. 405 Even where information is pushed to the MA from the Controller 406 (rather than pulled by the MA), a Schedule still needs to be 407 supplied. In this case the Schedule will simply execute a Controller 408 listener task when the MA is started. A Channel is still required 409 for the MA to establish secure communication with the Controller. 411 It can be seen that these Channels, Schedules and Task Configurations 412 for the initial MA-Controller communication are no different in terms 413 of the Information Model to any other Channel, Schedule or Task 414 Configuration that might execute a Measurement Task or report the 415 measurement results (as described later). 417 The MA may be pre-configured with an MA ID, or may use a Device ID in 418 the first Controller contact before it is assigned an MA ID. The 419 Device ID may be a MAC address or some other device identifier 420 expressed as a URI. If the MA ID is not provided at this stage then 421 it must be provided by the Controller during Configuration. 423 3.1.1. Definition of ma-preconfig-obj 424 object { 425 [uuid ma-preconfig-agent-id;] 426 ma-task-obj ma-preconfig-control-tasks<1..*>; 427 ma-channel-obj ma-preconfig-control-channels<1..*>; 428 ma-schedule-obj ma-preconfig-control-schedules<1..*>; 429 [uri ma-preconfig-device-id;] 430 credentials ma-preconfig-credentials; 431 } ma-preconfig-obj; 433 The ma-preconfig-obj is essentially a subset of the ma-config-obj 434 described below. The ma-preconfig-obj consists of the following 435 elements: 437 ma-preconfig-agent-id: An optional uuid uniquely identifying 438 the measurement agent. 440 ma-preconfig-control-tasks: An unordered set of tasks objects. 442 ma-preconfig-control-channels: An unordered set of channel objects. 444 ma-preconfig-control-schedules: An unordered set of scheduling 445 objects. 447 ma-preconfig-device-id: An optional identifier for the 448 device. 450 ma-preconfig-credentials: The security credentials used by the 451 measurement agent. 453 3.2. Configuration Information 455 During registration or at any later point at which the MA contacts 456 the Controller (or vice-versa), the choice of Controller, details for 457 the timing of communication with the Controller or parameters for the 458 communication Task(s) can be changed (as captured by the Channels, 459 Schedules and Task Configurations objects). For example the pre- 460 configured Controller (specified as a Channel or Channels) may be 461 over-ridden with a specific Controller that is more appropriate to 462 the MA device type, location or characteristics of the network (e.g., 463 access technology type or broadband product). The initial 464 communication Schedule may be over-ridden with one more relevant to 465 routine communications between the MA and the Controller. 467 While some Control protocols may only use a single Schedule, other 468 protocols may use several Schedules (and related data transfer Tasks) 469 to update the Configuration Information, transfer the Instruction 470 Information, transfer Capability and Status Information and send 471 other information to the Controller such as log or error 472 notifications. Multiple Channels may be used to communicate with the 473 same Controller over multiple interfaces (e.g., to send logging 474 information over a different network). 476 In addition the MA will be given further items of information that 477 relate specifically to the MA rather than the measurements it is to 478 conduct or how to report results. The assignment of an ID to the MA 479 is mandatory. If the MA Agent ID was not optionally provided during 480 the pre-configuration then one must be provided by the Controller 481 during Configuration. Optionally a Group ID may also be given which 482 identifies a group of interest to which that MA belongs. For example 483 the group could represent an ISP, broadband product, technology, 484 market classification, geographic region, or a combination of 485 multiple such characteristics. Where the Measurement Group ID is set 486 an additional flag (the Report MA ID flag) is required to control 487 whether the Measurement Agent ID is also to be reported. The 488 reporting of a Group ID without the MA ID allows the MA to remain 489 anonymous, which may be particularly useful to prevent tracking of 490 mobile MA devices. 492 Optionally an MA can also be configured to stop executing any 493 Instruction Schedule if the Controller is unreachable. This can be 494 used as a fail-safe to stop Measurement and other Tasks being 495 conducted when there is doubt that the Instruction Information is 496 still valid. This is simply represented as a time window in seconds 497 since the last communication with the Controller after which 498 Instruction Schedules are to be suspended. The appropriate value of 499 the time window will depend on the specified communication Schedule 500 with the Controller and the duration for which the system is willing 501 to tolerate continued operation with potentially stale Instruction 502 Information. 504 While Pre-Configuration Information is persistent upon device reset 505 or power cycle, the persistency of the Configuration Information may 506 be device dependent. Some devices may revert back to their pre- 507 configuration state upon reboot or factory reset, while other devices 508 may store all Configuration and Instruction information in persistent 509 storage. A Controller can check whether an MA has the latest 510 Configuration and Instruction information by examining the Capability 511 and Status information for the MA. 513 It should be noted that control schedules and tasks cannot be 514 suppressed as evidenced by the lack of suppression information in the 515 Configuration. The control schedule must only reference tasks listed 516 as control tasks (i.e., within the Configuration information). Any 517 suppress-by-default flag against control tasks will be ignored. 519 3.2.1. Definition of ma-config-obj 521 object { 522 uuid ma-config-agent-id; 523 ma-task-obj ma-config-control-tasks<1..*>; 524 ma-channel-obj ma-config-control-channels<1..*>; 525 ma-schedule-obj ma-config-control-schedules<1..*>; 526 [uri ma-config-device-id;] 527 credentials ma-config-credentials; 528 [string ma-config-group-id;] 529 [string ma-config-measurement-point;] 530 [boolean ma-config-report-agent-id;] 531 [boolean ma-config-report-measurement-point;] 532 [int ma-config-controller-timeout;] 533 } ma-config-obj; 535 The ma-config-obj consists of the following elements: 537 ma-config-agent-id: A uuid uniquely identifying the 538 measurement agent. 540 ma-config-control-tasks: An unordered set of task objects. 542 ma-config-control-channels: An unordered set of channel 543 objects. 545 ma-config-control-schedules: An unordered set of scheduling 546 objects. 548 ma-config-device-id: An optional identifier for the 549 device. 551 ma-config-credentials: The security credentials used by 552 the measurement agent. 554 ma-config-group-id: An optional identifier of the 555 group of measurement agents this 556 measurement agent belongs to. 558 ma-config-measurement-point: An optional identifier for the 559 measurement point indicating 560 where the measurement agent is 561 located on a path (see [RFC7398] 562 for further details). 564 ma-config-report-agent-id: An optional flag indicating 565 whether the identifier (ma- 566 config-agent-id) should be 567 included in reports. The default 568 value is false. 570 ma-config-report-measurement-point: An optional flag indicating 571 whether the measurement point 572 (ma-config-measurement-point) 573 should be included in reports. 574 The default value is false. 576 ma-config-controller-timeout: A timer is started after each 577 successful contact with a 578 controller. When the timer 579 reaches the controller-timeout 580 (measured in seconds), an event 581 is raised indicating that 582 connectivity to the controller 583 has been lost (see ma-controller- 584 lost-obj). 586 3.3. Instruction Information 588 The Instruction information model has four sub-elements: 590 1. Instruction Task Configurations 592 2. Report Channels 594 3. Instruction Schedules 596 4. Suppression 598 The Instruction supports the execution of all Tasks on the MA except 599 those that deal with communication with the Controller (specified in 600 (pre-)configuration information). The Tasks are configured in 601 Instruction Task Configurations and included by reference in 602 Instruction Schedules that specify when to execute them. The results 603 can be communicated to other Schedules or a Task may implement a 604 Reporting Protocol and communicate results over Report Channels. 605 Suppression is used to temporarily stop the execution of new Tasks as 606 specified by the Instruction Schedules (and optionally to stop 607 ongoing Tasks). 609 A Task Configuration is used to configure the mandatory and optional 610 parameters of a Task. It also serves to instruct the MA about the 611 Task including the ability to resolve the Task to an executable and 612 specifying the schema for the Task parameters. 614 A Report Channel defines how to communicate with a single remote 615 system specified by a URL. A Report Channel is used to send results 616 to single Collector but is no different in terms of the Information 617 Model to the Control Channel used to transfer information between the 618 MA and the Controller. Several Report Channels can be defined to 619 enable results to be split or duplicated across different 620 destinations. A single Channel can be used by multiple (reporting) 621 Task Configurations to transfer data to the same Collector. A single 622 Reporting Task Configuration can also be included in multiple 623 Schedules. E.g., a single Collector may receive data at three 624 different cycle rates, one Schedule reporting hourly, another 625 reporting daily and a third specifying that results should be sent 626 immediately for on-demand measurement tasks. Alternatively multiple 627 Report Channels can be used to send Measurement Task results to 628 different Collectors. The details of the Channel element is 629 described later as it is common to several objects. 631 Instruction Schedules specify which Actions to execute according to a 632 given triggering Event. An Action is a Task with additional specific 633 parameters. An Event can trigger the execution of a single Action or 634 it can trigger a repeated series of Actions. The Schedule also 635 specifies how to link Tasks output data to other Schedules. 637 Measurement Suppression information is used to over-ride the 638 Instruction Schedule and temporarily stop measurements or other Tasks 639 from running on the MA for a defined or indefinite period. While 640 conceptually measurements can be stopped by simply removing them from 641 the Measurement Schedule, splitting out separate information on 642 Measurement Suppression allows this information to be updated on the 643 MA on a different timing cycle or protocol implementation to the 644 Measurement Schedule. It is also considered that it will be easier 645 for a human operator to implement a temporary explicit suppression 646 rather than having to move to a reduced Schedule and then roll-back 647 at a later time. 649 The explicit Suppression instruction message is able to simply 650 enable/disable all Instruction Tasks (that are enabled for default 651 suppression) as well as having fine control on which Tasks are 652 suppressed. Suppression of both specified Task Configurations and 653 Measurement Schedules is supported. Support for disabling specific 654 Task Configurations allows malfunctioning or mis-configured Tasks or 655 Task Configurations that have an impact on a particular part of the 656 network infrastructure (e.g., a particular Measurement Peer) to be 657 targeted. Support for disabling specific Schedules allows for 658 particularly heavy cycles or sets of less essential Measurement Tasks 659 to be suppressed quickly and effectively. Note that Suppression has 660 no effect on either Controller Tasks or Controller Schedules. 662 When no tasks or schedules are explicitly listed, all Instruction 663 tasks will be suppressed (or not) as indicated by the suppress-by- 664 default flag in the Task Configuration. If tasks or schedules are 665 listed explicitly then only these listed tasks or schedules will be 666 suppressed regardless of the suppress-by-default flag. If both 667 individual tasks and individual schedules are listed then only the 668 listed schedules, plus the listed tasks where present in other 669 schedules, will be suppressed regardless of the suppress-by-default 670 flag. 672 Suppression stops new Tasks from executing. In addition, the 673 Suppression information also supports an additional Boolean that is 674 used to select whether on-going tasks are also to be terminated. 676 Unsuppression is achieved through either overwriting the Measurement 677 Suppression information (e.g., changing 'enabled' to False) or 678 through the use of an End time such that the Measurement Suppression 679 will no longer be in effect beyond this time. The datetime format 680 used for all elements in the information model (e.g., the suppression 681 start and end dates) MUST conform to RFC 3339 [RFC3339]. 683 The goal when defining these four different elements is to allow each 684 part of the information model to change without affecting the other 685 three elements. For example it is envisaged that the Report Channels 686 and the set of Task Configurations will be relatively static. The 687 Instruction Schedule, on the other hand, is likely to be more 688 dynamic, as the measurement panel and test frequency are changed for 689 various business goals. Another example is that measurements can be 690 suppressed with a Suppression command without removing the existing 691 Instruction Schedules that would continue to apply after the 692 Suppression expires or is removed. In terms of the Controller-MA 693 communication this can reduce the data overhead. It also encourages 694 the re-use of the same standard Task Configurations and Reporting 695 Channels to help ensure consistency and reduce errors. 697 3.3.1. Definition of ma-instruction-obj 699 object { 700 ma-task-obj ma-instruction-tasks<0..*>; 701 ma-channel-obj ma-instruction-channels<0..*>; 702 ma-schedule-obj ma-instruction-schedules<0..*>; 703 [ma-suppression-obj ma-instruction-suppressions<0..*>;] 704 } ma-instruction-obj; 706 An ma-instruction-obj consists of the following elements: 708 ma-instruction-tasks: A possibly empty unordered set of task 709 objects. 711 ma-instruction-channels: A possibly empty unordered set of 712 channel objects. 714 ma-instruction-schedules: A possibly empty unordered set of 715 schedule objects. 717 ma-instruction-suppressions: An optional possibly empty unordered 718 set of suppression objects. 720 3.3.2. Definition of ma-suppression-obj 722 object { 723 string ma-suppression-name; 724 [ma-event-obj ma-suppression-start;] 725 [ma-event-obj ma-suppression-end;] 726 [string ma-suppression-match<0..*>;] 727 [boolean ma-suppression-stop-running;] 728 } ma-suppression-obj; 730 The ma-suppression-obj controls the suppression of schedules or 731 actions and consists of the following elements: 733 ma-suppression-name: A name uniquely identifying a 734 suppression. 736 ma-suppression-start: The optional event indicating when 737 suppression starts. The default value 738 is 'immediate'. 740 ma-suppression-end: The optional event indicating when 741 suppression ends. The default value is 742 'indefinite'. 744 ma-suppression-match: An optional and possibly empty 745 unordered set of match pattern. The 746 suppression will apply to all schedules 747 (and their actions) that have a 748 matching value in their ma-schedule- 749 suppression-tags and all actions that 750 have a matching value in their ma- 751 action-suppression-tags. If not 752 present, the suppression affects 753 actions that refer to a task with 754 suppress-by-default set to true. 755 Pattern matching is done using glob 756 style pattern (see below). 758 ma-suppression-stop-running: An optional boolean indicating whether 759 suppression will stop any running 760 schedules or actions. The default 761 value for this boolean is false. 763 Glob style pattern matching is following POSIX.2 fnmatch() without 764 special treatment of file paths: 766 * matches a sequence of characters 767 ? matches a single character 768 [seq] matches any character in seq 769 [!seq] matches any character not in seq 771 A backslash followed by a character matches the following character. 772 In particular: 774 \* matches * 775 \? matches ? 776 \\ matches \ 778 A sequence seq may be a sequence of characters (e.g., [abc] or a 779 range of characters (e.g., [a-c]). 781 3.4. Logging Information 783 The MA may report on the success or failure of Configuration or 784 Instruction communications from the Controller. In addition further 785 operational logs may be produced during the operation of the MA and 786 updates to capabilities may also be reported. Reporting this 787 information is achieved in exactly the same manner as scheduling any 788 other Task. We make no distinction between a Measurement Task 789 conducting an active or passive network measurement and one which 790 solely retrieves static or dynamic information from the MA such as 791 capabilities or logging information. One or more logging tasks can 792 be programmed or configured to capture subsets of the Logging 793 Information. These logging tasks are then executed by Schedules 794 which also specify that the resultant data is to be transferred over 795 the Controller Channels. 797 The type of Logging Information will fall into three different 798 categories: 800 1. Success/failure/warning messages in response to information 801 updates from the Controller. Failure messages could be produced 802 due to some inability to receive or parse the Controller 803 communication, or if the MA is not able to act as instructed. 804 For example: 806 * "Measurement Schedules updated OK" 808 * "Unable to parse JSON" 810 * "Missing mandatory element: Measurement Timing" 812 * "'Start' does not conform to schema - expected datetime" 814 * "Date specified is in the past" 816 * "'Hour' must be in the range 1..24" 818 * "Schedule A refers to non-existent Measurement Task 819 Configuration" 821 * "Measurement Task Configuration X registry entry Y not found" 823 * "Updated Measurement Task Configurations do not include M used 824 by Measurement Schedule N" 826 2. Operational updates from the MA. For example: 828 * "Out of memory: cannot record result" 830 * "Collector 'collector.example.com' not responding" 832 * "Unexpected restart" 834 * "Suppression timeout" 836 * "Failed to execute Measurement Task Configuration H" 838 3. Status updates from the MA. For example: 840 * "Device interface added: eth3" 842 * "Supported measurements updated" 844 * "New IP address on eth0: xxx.xxx.xxx.xxx" 846 This Information Model document does not detail the precise format of 847 logging information since it is to a large extent protocol and MA 848 specific. However, some common information can be identified. 850 3.4.1. Definition of ma-log-obj 852 object { 853 uuid ma-log-agent-id; 854 datetime ma-log-event-time; 855 code ma-log-code; 856 string ma-log-description; 857 } ma-log-obj; 859 The ma-log-obj models the generic aspects of a logging object and 860 consists of the following elements: 862 ma-log-agent-id: A uuid uniquely identifying the measurement 863 agent. 865 ma-log-event-time: The date and time of the event reported in 866 the logging object. 868 ma-log-code: A machine readable code describing the 869 event. 871 ma-log-description: A human readable description of the event. 873 3.5. Capability and Status Information 875 The MA will hold Capability Information that can be retrieved by a 876 Controller. Capabilities include the device interface details 877 available to Measurement Tasks as well as the set of Measurement 878 Tasks/Roles (specified by registry entries) that are actually 879 installed or available on the MA. Status information includes the 880 times that operations were last performed such as contacting the 881 Controller or producing Reports. 883 3.5.1. Definition of ma-capability-obj 885 object { 886 string ma-capability-hardware; 887 string ma-capability-firmware; 888 string ma-capability-version; 889 [ma-capability-task-obj ma-capability-tasks<0..*>;] 890 } ma-capability-obj; 892 The ma-capability-obj provides information about the capabilities of 893 the measurement agent and consists of the following elements: 895 ma-capability-hardware: A description of the hardware of the device 896 the measurement agent is running on. 898 ma-capability-firmware: A description of the firmware of the device 899 the measurement agent is running on. 901 ma-capability-version: The version of the measurement agent. 903 ma-capability-tasks: An optional unordered set of capability 904 objects for each supported task. 906 3.5.2. Definition of ma-capability-task-obj 908 object { 909 string ma-capability-task-name; 910 ma-metric-registry-obj ma-capability-task-metrics<0..*>; 911 string ma-capability-task-version; 912 } ma-capability-task-obj; 914 The ma-capability-task-obj provides information about the capability 915 of a task and consists of the following elements: 917 ma-capability-task-name: A name uniquely identifying a task. 919 ma-capability-task-metrics: A possibly empty unordered set of 920 registered metrics and associated roles 921 this task implements. 923 ma-capability-task-version: The version of the measurement task. 925 3.5.3. Definition of ma-status-obj 927 object { 928 uuid ma-status-agent-id; 929 uri ma-status-device-id; 930 datetime ma-status-last-started; 931 ma-interface-obj ma-status-interfaces<0..*>; 932 [ma-status-schedule-obj ma-status-schedules<0..*>;] 933 [ma-status-suppression-obj ma-status-suppressions<0..*>;] 934 } ma-status-obj; 936 The ma-status-obj provides status information about the measurement 937 agent and consists of the following elements: 939 ma-status-agent-id: A uuid uniquely identifying the measurement 940 agent. 942 ma-status-device-id: A URI identifying the device. 944 ma-status-last-started: The date and time the measurement agent 945 last started. 947 ma-status-interfaces: An unordered set of network interfaces 948 available on the device. 950 ma-status-schedules: An optional unordered set of status objects 951 for each schedule. 953 ma-status-suppressions: An optional unordered set of status objects 954 for each suppression. 956 3.5.4. Definition of ma-status-schedule-obj 958 object { 959 string ma-status-schedule-name; 960 string ma-status-schedule-state; 961 counter ma-status-schedule-invocations; 962 counter ma-status-schedule-suppressions; 963 counter ma-status-schedule-overlaps; 964 counter ma-status-schedule-failures; 965 datetime ma-status-schedule-last-invocation; 966 [ma-status-action-obj ma-status-schedule-actions<0..*>;] 967 } ma-status-schedule-obj; 969 The ma-status-schedule-obj provides status information about that 970 status of a schedule and consists of the following elements: 972 ma-status-schedule-name: The name of the schedule this 973 status object refers to. 975 ma-status-schedule-state: The state of the schedule. The 976 value 'enabled' indicates that 977 the schedule is currently 978 enabled. The value 'suppressed' 979 indicates that the schedule is 980 currently suppressed. The value 981 'disabled' indicates that the 982 schedule is currently disabled. 983 The value 'running' indicates 984 that the schedule is currently 985 running. 987 ma-status-schedule-invocations Number of invocations of this 988 schedule. This counter does not 989 include suppressed invocations or 990 invocations that were prevented 991 due to an overlap with a previous 992 invocation of this schedule. 994 ma-status-schedule-suppressions Number of suppressed executions 995 of this schedule. 997 ma-status-schedule-overlaps Number of executions prevented 998 due to overlaps with a previous 999 invocation of this schedule. 1001 ma-status-schedule-failures Number of failed executions of 1002 this schedule. A failed 1003 execution is an execution where 1004 at least one action failed. 1006 ma-status-schedule-last-invocation: The date and time of the last 1007 invocation of this schedule. 1009 ma-status-schedule-last-invocation: The date and time of the last 1010 invocation of this schedule. 1012 ma-status-schedule-actions: An optional ordered list of 1013 status objects for each action of 1014 the schedule. 1016 3.5.5. Definition of ma-status-action-obj 1018 object { 1019 string ma-status-action-name; 1020 string ma-status-action-state; 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-schedule-invocations Number of invocations of 1055 this action. This counter 1056 does not include suppressed 1057 invocations or invocations 1058 that were prevented due to 1059 an overlap with a previous 1060 invocation of this action. 1062 ma-status-schedule-suppressions Number of suppressed 1063 executions of this action. 1065 ma-status-schedule-overlaps Number of executions 1066 prevented due to overlaps 1067 with a previous invocation 1068 of this action. 1070 ma-status-schedule-failures Number of failed executions 1071 of this action. 1073 ma-status-action-last-invocation: The date and time of the 1074 last invocation of this 1075 action. 1077 ma-status-action-last-completion: The date and time of the 1078 last completion of this 1079 action. 1081 ma-status-action-last-status: The status code returned by 1082 the last execution of this 1083 action. 1085 ma-status-action-last-message: The status message produced 1086 by the last execution of 1087 this action. 1089 ma-status-action-last-failed-completion: The date and time of the 1090 last failed completion of 1091 this action. 1093 ma-status-action-last-failed-status: The status code returned by 1094 the last failed execution of 1095 this action. 1097 ma-status-action-last-failed-message: The status message produced 1098 by the last failed execution 1099 of this action. 1101 3.5.6. Definition of ma-status-suppression-obj 1103 object { 1104 string ma-status-suppression-name; 1105 string ma-status-suppression-state; 1106 } ma-status-suppression-obj; 1108 The ma-status-suppression-obj provides status information about that 1109 status of a suppression and consists of the following elements: 1111 ma-status-schedule-name: The name of the suppression this status 1112 object refers to. 1114 ma-status-schedule-state: The state of the suppression. The value 1115 'enabled' indicates that the suppression 1116 is currently enabled. The value 'active 1117 indicates that the suppression is 1118 currently active. The value 'disabled' 1119 indicates that the suppression is 1120 currently disabled. 1122 3.5.7. Definition of ma-interface-obj 1124 object { 1125 string ma-interface-name; 1126 string ma-interface-type; 1127 [int ma-interface-speed;] 1128 [string ma-interface-link-layer-address;] 1129 [ip-address ma-interface-ip-addresses<0..*>;] 1130 [ip-address ma-interface-gateways<0..*>;] 1131 [ip-address ma-interface-dns-servers<0..*>;] 1132 } ma-interface-obj; 1134 The ma-interface-obj provides status information about network 1135 interfaces and consists of the following elements: 1137 ma-interface-name: A name uniquely identifying a 1138 network interface. 1140 ma-interface-type: The type of the network interface. 1142 ma-interface-speed: An optional indication of the speed 1143 of the interface (measured in bits- 1144 per-second). 1146 ma-interface-link-layer-address: An optional link-layer address of 1147 the interface. 1149 ma-interface-ip-addresses: An optional ordered list of IP 1150 addresses assigned to the 1151 interface. 1153 ma-interface-gateways: An optional ordered list of 1154 gateways assigned to the interface. 1156 ma-interface-dns-servers: An optional ordered list of DNS 1157 servers assigned to the interface. 1159 3.6. Reporting Information 1161 At a point in time specified by a Schedule, the MA will execute a 1162 task or tasks that communicate a set of measurement results to the 1163 Collector. These Reporting Tasks will be configured to transmit task 1164 results over a specified Report Channel to a Collector. 1166 It should be noted that the output from Tasks does not need to be 1167 sent to communication Channels. It can alternatively, or 1168 additionally, be sent to other Tasks on the MA. This facilitates 1169 using a first Measurement Task to control the operation of a later 1170 Measurement Task (such as first probing available line speed and then 1171 adjusting the operation of a video testing measurement) and also to 1172 allow local processing of data to output alarms (e.g., when 1173 performance drops from earlier levels). Of course, subsequent Tasks 1174 also include Tasks that implement the reporting protocol(s) and 1175 transfer data to one or more Collector(s). 1177 The Report generated by a Reporting Task is structured hierarchically 1178 to avoid repetition of report header and Measurement Task 1179 Configuration information. The report starts with the timestamp of 1180 the report generation on the MA and details about the MA including 1181 the optional Measurement Agent ID and Group ID (controlled by the 1182 Configuration Information). 1184 Much of the report Information is optional and will depend on the 1185 implementation of the Reporting Task and any parameters defined in 1186 the Task Configuration for the Reporting Task. For example some 1187 Reporting Tasks may choose not to include the Measurement Task 1188 Configuration or scheduled task parameters, while others may do so 1189 dependent on the Controller setting a configurable parameter in the 1190 Task Configuration. 1192 It is possible for a Reporting Task to send just the Report header 1193 (datetime and optional agent ID and/or Group ID) if no measurement 1194 data is available. Whether to send such empty reports again is 1195 dependent on the implementation of the Reporting Task and potential 1196 Task Configuration parameter. 1198 The handling of measurement data on the MA before generating a Report 1199 and transfer from the MA to the Collector is dependent on the 1200 implementation of the device, MA and/or scheduled Tasks and not 1201 defined by the LMAP standards. Such decisions may include limits to 1202 the measurement data storage and what to do when such available 1203 storage becomes depleted. 1205 No context information, such as line speed or broadband product are 1206 included within the report header information as this data is 1207 reported by individual tasks at the time they execute. Either a 1208 Measurement Task can report contextual parameters that are relevant 1209 to that particular measurement, or specific tasks can be used to 1210 gather a set of contextual and environmental data. at certain times 1211 independent of the reporting schedule. 1213 After the report header information the results are reported grouped 1214 according to different Measurement Task Configurations. Each Task 1215 section optionally starts with replicating the Measurement Task 1216 Configuration information before the result headers (titles for data 1217 columns) and the result data rows. The Options reported are those 1218 used for the scheduled execution of the Measurement Task and 1219 therefore include the Options specified in the Task Configuration as 1220 well as additional Options specified in the Scheduled Task. The 1221 Scheduled Task Options are appended to the Task Configuration Options 1222 in exactly the same order as they were provided to the Task during 1223 execution. 1225 The result row data includes a time for the start of the measurement 1226 and optionally an end time where the duration also needs to be 1227 considered in the data analysis. 1229 Some Measurement Tasks may optionally include an indication of the 1230 cross-traffic although the definition of cross-traffic is left up to 1231 each individual Measurement Task. Some Measurement Tasks may also 1232 output other environmental measures in addition to cross-traffic such 1233 as CPU utlilisation or interface speed. 1235 Where the Configuration and Instruction information represent 1236 information transmitted via the Control Protocol, the Report 1237 represents the information that is transmitted via the Report 1238 Protocol. It is constructed at the time of sending a report and 1239 represents the inherent structure of the information that is sent to 1240 the Collector. 1242 3.6.1. Definition of ma-report-obj 1244 object { 1245 datetime ma-report-date; 1246 [uuid ma-report-agent-id;] 1247 [string ma-report-group-id;] 1248 [string ma-report-measurement-point;] 1249 [ma-report-task-obj ma-report-tasks<0..*>;] 1250 } ma-report-obj; 1252 The ma-report-obj provides the meta-data of a single report and 1253 consists of the following elements: 1255 ma-report-date: The date and time when the report was 1256 sent to a collector. 1258 ma-report-agent-id: An optional uuid uniquely identifying 1259 the measurement agent. 1261 ma-report-group-id: An optional identifier of the group of 1262 measurement agents this measurement 1263 agent belongs to. 1265 ma-report-measurement-point: An optional identifier for the 1266 measurement point indicating where the 1267 measurement agent is located on a path 1268 (see [RFC7398] for further details). 1270 ma-report-tasks: An optional and possibly empty 1271 unordered set of tasks result objects. 1273 3.6.2. Definition of ma-report-task-obj 1274 object { 1275 string ma-report-task-name; 1276 [ma-metric-registry-obj ma-report-task-metrics<0..*>;] 1277 [ma-option-obj ma-report-task-options<0..*>;] 1278 [ma-option-obj ma-report-task-action-options<0..*>;] 1279 [string ma-report-task-tags<0..*>;] 1280 [string ma-report-task-column-labels<0..*>;] 1281 [ma-report-row-obj ma-report-task-rows<0..*>;] 1282 } ma-report-task-obj; 1284 The ma-report-task-obj provides the meta-data of a result report of a 1285 single task. It consists of the following elements: 1287 ma-report-task-name: A name uniquely identifying the task 1288 that produced the results being 1289 reported. 1291 ma-report-task-metrics: An optional and possibly empty 1292 unordered set of registered metrics 1293 and associated rulels that are 1294 reported. 1296 ma-report-task-options: An optional ordered list of task 1297 options provided by the task object. 1299 ma-report-task-action-options: An optional ordered list of action 1300 options provided by the action 1301 object. 1303 ma-report-task-tags: An optional unordered set of tags. 1305 ma-report-task-column-labels: An optional and possibly empty 1306 ordered list of column labels. 1308 ma-report-task-rows: An optional and possibly empty 1309 ordered list of result rows. 1311 3.6.3. Definition of ma-report-row-obj 1313 object { 1314 datetime ma-report-row-start-time; 1315 [datetime ma-report-row-end-time;] 1316 string ma-report-row-conflicts<0..*>; 1317 data ma-report-row-values<0..*>; 1318 } ma-report-row-obj; 1320 The ma-report-row-obj represents a result row and consists of the 1321 following elements: 1323 ma-report-row-start-time: The date and time of the start of the 1324 measurement task that produced the reported 1325 result values. 1327 ma-report-row-end-time: An optional date and time indicating when 1328 the measurement task that produced the 1329 reported result values finished. 1331 ma-report-row-conflicts: A possibly empty set of names of task that 1332 might have impacted the measurement being 1333 reported. 1335 ma-report-row-values: A possibly empty ordered list of result 1336 values. When present, it contains an 1337 ordered list of values that align to the 1338 set of column labels for the report. 1340 3.7. Common Objects: Schedules 1342 A Schedule specifies the execution of a single or repeated series of 1343 Actions. An Action is a Task with additional specific parameters. 1344 Each Schedule contains basically two elements: an ordered list of 1345 Actions to be executed and an Event object for the Schedule. The 1346 Schedule states what Actions to run (with what configuration) and 1347 when to run the Actions. 1349 Multiple Actions contained as an ordered list of a single Measurement 1350 Schedule will be executed according to the execution mode of the 1351 Schedule. In sequential mode, Actions will be executed sequentially 1352 and in parallel mode, all Actions will be executed concurrently. In 1353 pipelined mode, data produced by one Action is passed to the 1354 subsequent Action. Actions contained in different Schedules execute 1355 in parallel with such conflicts being reported in the Reporting 1356 Information where necessary. If two or more Schedules have the same 1357 start time, then the two will execute in parallel. There is no 1358 mechanism to prioritise one schedule over another or to mutex 1359 scheduled tasks. 1361 As well as specifying which Actions to execute, the Schedule also 1362 specifies how to link the data outputs from each Action to other 1363 Schedules. Specifying this within the Schedule allows the highest 1364 level of flexibility since it is even possible to send the output 1365 from different executions of the same Task Configuration to different 1366 destinations. A single Task producing multiple different outputs is 1367 expected to properly tag the different result. An Action receiving 1368 the output can then filter the results based on the tag if necessary. 1369 For example, a Measurement Task might report routine results to a 1370 data Reporting Task in a Schedule that communicates hourly via the 1371 Broadband PPP interface, but also outputs emergency conditions via an 1372 alarm Reporting Task in a different Schedule communicating 1373 immediately over a GPRS channel. Note that task-to-task data 1374 transfer is always specified in association with the scheduled 1375 execution of the sending task - there is no need for a corresponding 1376 input specification for the receiving task. While it is likely that 1377 an MA implementation will use a queue mechanism between the Schedules 1378 or Actions, this Information Model does not mandate or define a 1379 queue, or any potential associated parameters such as storage size 1380 and retention policies. 1382 When specifying the task to execute within the Schedule, i.e., 1383 creating an Action, it is possible to add to the task configuration 1384 option parameters. This allows the Task Configuration to determine 1385 the common characteristics of a Task, while selected parameters 1386 (e.g., the test target URL) are defined within the schedule. A 1387 single Tasks Configuration can even be used multiple times in the 1388 same schedule with different additional parameters. This allows for 1389 efficiency in creating and transferring the Instruction. Note that 1390 the semantics of what happens if an option is defined multiple times 1391 (either in the Task Configuration, Schedule or in both) is not 1392 standardised and will depend upon the Task. For example, some tasks 1393 may legitimately take multiple values for a single parameter. 1395 Where Options are specified in both the Schedule and the Task 1396 Configuration, the Schedule Options are appended to those specified 1397 in the Task Configuration. 1399 Example: An Action of a Schedule references a single Measurement 1400 Task Configuration for measuring UDP latency. It specifies that 1401 results are to be sent to a Schedule with a Reporting Action. 1402 This Reporting Task of the Reporting Action is executed by a 1403 separate Schedule that specifies that it should run hourly at 5 1404 minutes past the hour. When run this Reporting Action takes the 1405 data generated by the UDP latency Measurement Task as well as any 1406 other data to be included in the hourly report and transfers it to 1407 the Collector over the Report Channel specified within its own 1408 Schedule. 1410 3.7.1. Definition of ma-schedule-obj 1411 object { 1412 string ma-schedule-name; 1413 ma-event-obj ma-schedule-start; 1414 [ma-event-obj ma-schedule-end;] 1415 [int ma-schedule-duration;] 1416 ma-action-obj ma-schedule-actions<0..*>; 1417 string ma-schedule-execution-mode; 1418 [string ma-schedule-tags<0..*>;] 1419 [string ma-schedule-suppression-tags<0..*>;] 1420 } ma-schedule-obj; 1422 The ma-schedule-obj is the main scheduling object. It consists of 1423 the following elements: 1425 ma-schedule-name: A name uniquely identifying a 1426 scheduling object. 1428 ma-schedule-start: An event object indicating when the 1429 schedule starts. 1431 ma-schedule-end: An optional event object controlling 1432 the forceful termination of scheduled 1433 actions. When the event occurs, all 1434 actions of the schedule will be forced 1435 to terminate gracefully. 1437 ma-schedule-duration: An optional duration in seconds for the 1438 schedule. All actions of the schedule 1439 will be forced to terminate gracefully 1440 after the duration number of seconds 1441 past the start of the schedule. 1443 ma-schedule-actions: A possibly empty ordered list of 1444 actions to invoke when the schedule 1445 starts. 1447 ma-schedule-execution-mode: Indicates whether the actions should be 1448 executed sequentially, in parallel, or 1449 in a pipelined mode (where data 1450 produced by one action is passed to the 1451 subsequent action). The default 1452 execution mode is pipelined. 1454 ma-schedule-tags: An optional unordered set of tags that 1455 are reported together with the 1456 measurement results to a collector. 1458 ma-schedule-suppression-tags: An optional unordered set of 1459 suppression tags that are used to 1460 select schedules to be suppressed. 1462 3.7.2. Definition of ma-action-obj 1464 object { 1465 string ma-action-name; 1466 string ma-action-config-task-name; 1467 [ma-option-obj ma-action-task-options<0..*>;] 1468 [string ma-action-destinations<0..*>;] 1469 [string ma-action-tags<0..*>;] 1470 [string ma-action-suppression-tags<0..*>;] 1471 } ma-action-obj; 1473 The ma-action-obj models an a task together with its schedule 1474 specific task options and destination tasks. It consists of the 1475 following elements: 1477 ma-action-name: A name uniquely identifying an action 1478 of a scheduling object. 1480 ma-action-config-task-name: A name identifying the configured task 1481 to be invoked by the action. 1483 ma-action-task-options: An optional and possibly empty ordered 1484 list of options (name-value pairs) that 1485 are passed to the task by appending 1486 them to the options configured for the 1487 task object. 1489 ma-action-destinations: An optional and possibly empty 1490 unordered set of names of destination 1491 schedules that consume output produced 1492 by this action. 1494 ma-action-tags: An optional unordered set of tags that 1495 are reported together with the 1496 measurement results to a collector. 1498 ma-action-suppression-tags: An optional unordered set of 1499 suppression tags that are used to 1500 select actions to be suppressed. 1502 3.8. Common Objects: Channels 1504 A Channel defines a bi-directional communication channel between the 1505 MA and a Controller or Collector. Multiple Channels can be defined 1506 to enable results to be split or duplicated across different 1507 Collectors. 1509 Each Channel contains the details of the remote endpoint (including 1510 location and security credential information such as the 1511 certificate). The timing of when to communicate over a Channel is 1512 specified by the Schedule which executes the corresponding Control or 1513 Reporting Task. The certificate can be the digital certificate 1514 associated to the FQDN in the URL or it can be the certificate of the 1515 Certification Authority that was used to issue the certificate for 1516 the FQDN (Fully Qualified Domain Name) of the target URL (which will 1517 be retrieved later on using a communication protocol such as TLS). 1518 In order to establish a secure channel, the MA will use it's own 1519 security credentials (in the Configuration Information) and the given 1520 credentials for the individual Channel end-point. 1522 As with the Task Configurations, each Channel is also given a text 1523 name by which it can be referenced as a Task Option. 1525 Although the same in terms of information, Channels used for 1526 communication with the Controller are referred to as Control Channels 1527 whereas Channels to Collectors are referred to as Report Channels. 1528 Hence Control Channels will be referenced from Control Tasks executed 1529 by a Control Schedule, whereas Report Channels will be referenced 1530 from within Reporting Tasks executed by an Instruction Schedule. 1532 Multiple interfaces are also supported. For example the Reporting 1533 Task could be configured to send some results over GPRS. This is 1534 especially useful when such results indicate the loss of connectivity 1535 on a different network interface. 1537 Example: A Channel used for reporting results may specify that 1538 results are to be sent to the URL (https://collector.example.org/ 1539 report/), using the appropriate digital certificate to establish a 1540 secure channel.. 1542 3.8.1. Definition of ma-channel-obj 1544 object { 1545 string ma-channel-name; 1546 url ma-channel-target; 1547 credentials ma-channel-credentials; 1548 [string ma-channel-interface-name;] 1549 } ma-channel-obj; 1551 The ma-channel-obj consists of the following elements: 1553 ma-channel-name: A unique name identifying the channel 1554 object. 1556 ma-channel-target: A URL identifying the target channel 1557 endpoint. 1559 ma-channel-credentials: The security credentials needed to 1560 establish a secure channel. 1562 ma-channel-interface-name: An optional name of the network interface 1563 to be used. If not present, the system 1564 will select a suitable interface. 1566 3.9. Common Objects: Task Configurations 1568 Conceptually each Task Configuration defines the parameters of a Task 1569 that the Measurement Agent (MA) may perform at some point in time. 1570 It does not by itself actually instruct the MA to perform them at any 1571 particular time (this is done by a Schedule). Tasks can be 1572 Measurement Tasks (i.e., those Tasks actually performing some type of 1573 passive or active measurement) or any other scheduled activity 1574 performed by the MA such as transferring information to or from the 1575 Controller and Collectors. Other examples of Tasks may include data 1576 manipulation or processing Tasks conducted on the MA. 1578 A Measurement Task Configuration is the same in information terms to 1579 any other Task Configuration. Both measurement and non-measurement 1580 Tasks have registry entries to enable the MA to uniquely identify the 1581 Task it should execute and retrieve the schema for any parameters 1582 that may be passed to the Task. Registry entries are specified as a 1583 URI and can therefore be used to identify the Task within a namespace 1584 or point to a web or local file location for the Task information. 1585 As mentioned previously, these URIs may be used to identify the 1586 Measurement Task in a public namespace 1587 [I-D.ietf-ippm-metric-registry]. 1589 Example: A Measurement Task Configuration may configure a single 1590 Measurement Task for measuring UDP latency. The Measurement Task 1591 Configuration could define the destination port and address for 1592 the measurement as well as the duration, internal packet timing 1593 strategy and other parameters (for example a stream for one hour 1594 and sending one packet every 500 ms). It may also define the 1595 output type and possible parameters (for example the output type 1596 can be the 95th percentile mean) where the measurement task 1597 accepts such parameters. It does not define when the task starts 1598 (this is defined by the Schedule element), so it does not by 1599 itself instruct the MA to actually perform this Measurement Task. 1601 The Task Configuration will include a local short name for reference 1602 by a Schedule. Task Configurations may also refer to registry 1603 entries as described above. In addition the Task can be configured 1604 through a set of configuration Options. The nature and number of 1605 these Options will depend upon the Task. These options are expressed 1606 as name-value pairs although the 'value' may be a structured object 1607 instead of a simple string or numeric value. The implementation of 1608 these name-value pairs will vary between data models. 1610 An Option that must be present for Reporting Tasks is the Channel 1611 reference specifying how to communicate with a Collector. This is 1612 included in the task options and will have a value that matches a 1613 channel name that has been defined in the Instruction. Similarly 1614 Control Tasks will have a similar option with the value set to a 1615 specified Control Channel. 1617 A reporting task might also have a flag parameter to indicate whether 1618 to report if there is no measurement result data pending to be 1619 transferred to the Collector. In addition many tasks will also take 1620 as a parameter which interface to operate over. 1622 The Task Configuration also contains a suppress-by-default flag that 1623 specifies the behaviour of a default suppress instruction (that does 1624 not list explicit tasks or schedules). If this flag is set to FALSE 1625 then the Task will not be suppressed. It should be noted that 1626 Controller Tasks are not subject to the suppression instruction and 1627 therefore this flag will be ignored in such cases. 1629 In addition the Task Configuration may optionally also be given tags 1630 that can carry a Measurement Cycle ID. The purpose of this ID is to 1631 easily identify a set of measurement results that have been produced 1632 by Measurement Tasks with comparable Options. This ID could be 1633 manually incremented or otherwise changed when an Option change is 1634 implemented which could mean that two sets of results should not be 1635 directly compared. 1637 3.9.1. Definition of ma-task-obj 1639 object { 1640 string ma-task-name; 1641 ma-metric-registry-obj ma-task-metrics<0..*>; 1642 [ma-option-obj ma-task-options<0..*>;] 1643 [boolean ma-task-suppress-by-default;] 1644 [string ma-task-tags<0..*>;] 1645 } ma-task-obj; 1647 The ma-task-obj defines a configured task that can be invoked as part 1648 of an action. A configured task can be referenced by its name and it 1649 contains a set of URIs to link to a metrics registry or a local 1650 specification of the task. Options allow the configuration of task 1651 parameters (in the form of name-value pairs). The ma-task-obj 1652 consists of the following elements: 1654 ma-task-name: A name uniquely identifying a 1655 configured task object. 1657 ma-task-metrics: A possibly empty unordered set of 1658 registered metrics and associated roles 1659 the configured measurement task will 1660 use. 1662 ma-task-options: An optional and possibly empty ordered 1663 list of options (name-value pairs) that 1664 are passed to the configured task. 1666 ma-task-suppress-by-default: A boolean flag indicating whether this 1667 configured task will be suppressed by 1668 default. The default value of the flag 1669 is true. 1671 ma-task-tags: An optional unordered set of tags that 1672 are reported together with the 1673 measurement results to a collector. 1675 3.9.2. Definition of ma-option-obj 1677 object { 1678 string ma-option-name; 1679 [object ma-option-value;] 1680 } ma-option-obj; 1682 The ma-option-obj models a name-value pair and consists of the 1683 following elements: 1685 ma-option-name: The name of the option. 1687 ma-option-value: The optional value of the option. 1689 While many of the Task Configuration Options are left to individual 1690 tasks to define, some common Options are used by multiple tasks and 1691 benefit from standardisation. These Options are Channel and Role. 1693 o Channel is used to specify the details of an endpoint for Control 1694 or Reporting Task communications and is detailed elsewhere in this 1695 document. The common option name for specifying the channel is 1696 "channel". 1698 o Role is used to specify which Role the task should be performing 1699 (as defined in the registry) if multiple roles are available. The 1700 common option name for specifying the role is "role". 1702 3.10. Common Objects: Registry Information 1704 Tasks and actions can be associated with entries in a metrics 1705 registry. A metric is identified by a URI and a metric may have 1706 associated roles. 1708 3.10.1. Definition of ma-metric-registry-obj 1710 object { 1711 uri ma-metric-registry-entry; 1712 [string ma-metric-registry-role<0..*>;] 1713 } ma-metric-registry-obj; 1715 The ma-metric-registry-obj defines a registered metric and the 1716 associated role(s). The ma-metric-registry-obj consists of the 1717 following elements: 1719 ma-metric-registry-entry: A URI identifying a metric in a metric 1720 registry. 1722 ma-metric-registry-role: An optional and possibly empty unordered 1723 set of roles for the metric. 1725 3.11. Common Objects: Event Information 1727 The Event information object used throughout the information models 1728 can initially take one of five different forms. Additional forms may 1729 be defined later in order to bind the execution of schedules to 1730 additional events. The initially defined five Event forms are: 1732 1. Periodic Timing: Emits multiple events periodically according to 1733 an interval time defined in seconds 1735 2. Calendar Timing: Emits multiple events according to a calendar 1736 based pattern, e.g., 22 minutes past each hour of the day on 1737 weekdays 1739 3. One Off Timing: Emits one event at a specific date and time 1741 4. Immediate: Emits one event as soon as possible 1742 5. Startup: Emits an event whenever the MA is started (e.g., at 1743 device startup) 1745 Optionally each of the Event options may also specify a randomness 1746 that should be evaluated and applied separately to each indicated 1747 event. This randomness parameter defines a uniform interval in 1748 seconds over which the start of the task is delayed from the starting 1749 times specified by the timing object. 1751 Both the Periodic and Calendar timing objects allow for a series of 1752 Actions to be executed. While both have an optional end time, it is 1753 best practice to always configure an end time and refresh the 1754 information periodically to ensure that lost MAs do not continue 1755 their tasks forever. 1757 Startup events are only created on device startup, not when a new 1758 Instruction is transferred to the MA. If scheduled task execution is 1759 desired both on the transfer of the Instruction and on device restart 1760 then both the Immediate and Startup timing needs to be used in 1761 conjunction. 1763 The datetime format used for all elements in the information model 1764 MUST conform to RFC 3339 [RFC3339]. 1766 3.11.1. Definition of ma-event-obj 1768 object { 1769 string ma-event-name; 1770 union { 1771 ma-periodic-obj ma-event-periodic; 1772 ma-calendar-obj ma-event-calendar; 1773 ma-one-off-obj ma-event-one-off; 1774 ma-immediate-obj ma-event-immediate; 1775 ma-startup-obj ma-event-startup; 1776 ma-immediate-obj ma-event-immediate; 1777 ma-startup-obj ma-event-startup; 1778 ma-controller-lost-obj ma-event-controller-lost; 1779 ma-controller-connected-obj ma-event-controller-connected; 1780 } 1781 [int ma-event-random-spread;] 1782 } ma-event-obj; 1784 The ma-event-obj is the main event object. Event objects are 1785 identified by a name. A generic event object itself contains a more 1786 specific event object. The set of specific event objects should be 1787 extensible. The initial set of specific event objects is further 1788 described below. The ma-event-obj also includes an optional uniform 1789 random spread that can be used to randomize the start times of 1790 scheduled tasks. The ma-event-obj consists of the following 1791 elements: 1793 ma-event-name: The name uniquely identifies an event 1794 object. Schedules refer to event 1795 objects by this name. 1797 ma-event-periodic: The ma-event-periodic is present for 1798 periodic timing objects. 1800 ma-event-calendar: The ma-event-calendar is present for 1801 calendar timing objects. 1803 ma-event-one-off: The ma-event-one-off is present for 1804 one-off timing objects. 1806 ma-event-immediate: The ma-event-immediate is present for 1807 immediate event objects. 1809 ma-event-startup: The ma-event-startup is present for 1810 startup event objects. 1812 ma-event-controller-lost: The ma-event-controller-lost is 1813 present for connectivity to 1814 controller lost event objects. 1816 ma-event-controller-connected: The ma-event-controller-connected is 1817 present for connectivity to a 1818 controller established event objects. 1820 ma-event-random-spread: The optional ma-event-random-spread 1821 adds a random delay defined in 1822 seconds to the event object. 1824 3.11.2. Definition of ma-periodic-obj 1826 object { 1827 [datetime ma-periodic-start;] 1828 [datetime ma-periodic-end;] 1829 int ma-periodic-interval; 1830 } ma-periodic-obj; 1832 The ma-periodic-obj timing object has an optional start and an 1833 optional end time plus a periodic interval. Schedules using an ma- 1834 periodic-obj are started periodically between the start and end time. 1835 The ma-periodic-obj consists of the following elements: 1837 ma-periodic-start: The optional date and time at which 1838 Schedules using this object are first 1839 started. If not present it defaults to 1840 immediate. 1842 ma-periodic-end: The optional date and time at which 1843 Schedules using this object are last 1844 started. If not present it defaults to 1845 indefinite. 1847 ma-periodic-interval: The interval defines the time in seconds 1848 between two consecutive starts of tasks. 1850 3.11.3. Definition of ma-calendar-obj 1852 Calendar Timing supports the routine execution of Actions at specific 1853 times and/or on specific dates. It can support more flexible timing 1854 than Periodic Timing since the execution of Actions does not have to 1855 be uniformly spaced. For example a Calendar Timing could support the 1856 execution of a Measurement Task every hour between 6pm and midnight 1857 on weekdays only. 1859 Calendar Timing is also required to perform measurements at 1860 meaningful times in relation to network usage (e.g., at peak times). 1861 If the optional timezone offset is not supplied then local system 1862 time is assumed. This is essential in some use cases to ensure 1863 consistent peak-time measurements as well as supporting MA devices 1864 that may be in an unknown timezone or roam between different 1865 timezones (but know their own timezone information such as through 1866 the mobile network). 1868 The calendar elements within the Calendar Timing do not have defaults 1869 in order to avoid accidental high-frequency execution of Tasks. If 1870 all possible values for an element are desired then the wildcard * is 1871 used. 1873 object { 1874 [datetime ma-calendar-start;] 1875 [datetime ma-calendar-end;] 1876 [string ma-calendar-months<0..*>;] 1877 [string ma-calendar-days-of-week<0..*>;] 1878 [string ma-calendar-days-of-month<0..*>;] 1879 [string ma-calendar-hours<0..*>;] 1880 [string ma-calendar-minutes<0..*>;] 1881 [string ma-calendar-seconds<0..*>;] 1882 [int ma-calendar-timezone-offset;] 1883 } ma-calendar-obj; 1885 ma-calendar-start: The optional date and time at which 1886 Schedules using this object are first 1887 started. If not present it defaults to 1888 immediate. 1890 ma-calendar-end: The optional date and time at which 1891 Schedules using this object are last 1892 started. If not present it defaults to 1893 indefinite. 1895 ma-calendar-months: The optional set of months (1-12) on 1896 which tasks scheduled using this object 1897 are started. The wildcard * means all 1898 months. If not present, it defaults to 1899 no months. 1901 ma-calendar-days-of-week: The optional set of days of a week 1902 ("Mon", "Tue", "Wed", "Thu", "Fri", 1903 "Sat", "Sun") on which tasks scheduled 1904 using this object are started. The 1905 wildcard * means all days of the week. 1906 If not present, it defaults to no days. 1908 ma-calendar-days-of-month: The optional set of days of a months 1909 (1-31) on which tasks scheduled using 1910 this object are started. The wildcard 1911 * means all days of a months. If not 1912 present, it defaults to no days. 1914 ma-calendar-hours: The optional set of hours (0-23) on 1915 which tasks scheduled using this object 1916 are started. The wildcard * means all 1917 hours of a day. If not present, it 1918 defaults to no hours. 1920 ma-calendar-minutes: The optional set of minutes (0-59) on 1921 which tasks scheduled using this object 1922 are started. The wildcard * means all 1923 minutes of an hour. If not present, it 1924 defaults to no hours. 1926 ma-calendar-seconds: The optional set of seconds (0-59) on 1927 which tasks scheduled using this object 1928 are started. The wildcard * means all 1929 seconds of an hour. If not present, it 1930 defaults to no seconds. 1932 ma-calendar-timezone-offset: The optional timezone offest in hours. 1933 If not present, it defaults to the 1934 system's local timezone. 1936 If a day of the month is specified that does not exist in the month 1937 (e.g., 29th of Feburary) then those values are ignored. 1939 3.11.4. Definition of ma-one-off-obj 1941 object { 1942 datetime ma-one-off-time; 1943 } ma-one-off-obj; 1945 The ma-one-off-obj timing object specifies a fixed point in time. 1946 Schedules using an ma-one-off-obj are started once at the specified 1947 date and time. The ma-one-off-obj consists of the following 1948 elements: 1950 ma-one-off-time: The date and time at which Schedules using 1951 this object are started. 1953 3.11.5. Definition of ma-immediate-obj 1955 object { 1956 // empty 1957 } ma-immediate-obj; 1959 The ma-immediate-obj event object has no further information 1960 elements. Schedules using an ma-immediate-obj are started as soon as 1961 possible. 1963 3.11.6. Definition of ma-startup-obj 1965 object { 1966 // empty 1967 } ma-startup-obj; 1969 The ma-startup-obj event object has no further information elements. 1970 Schedules or suppressions using an ma-startup-obj are started at MA 1971 initialization time. 1973 3.11.7. Definition of ma-controller-lost-obj 1975 object { 1976 // empty 1977 } ma-controller-lost-obj; 1979 The ma-controller-lost-obj event object has no further information 1980 elements. The ma-controller-lost-obj indicates that connectivity to 1981 the controller has been lost. This is determined by a timer started 1982 after each successful contact with a controller. When the timer 1983 reaches the controller-timeout (measured in seconds), an ma- 1984 controller-lost-obj event is generated. This event may be used to 1985 start a suppression. 1987 3.11.8. Definition of ma-controller-connected-obj 1989 object { 1990 // empty 1991 } ma-controller-connected-obj; 1993 The ma-controller-connected-obj event object has no further 1994 information elements. The ma-controller-connected-obj indicates that 1995 connectivity to the controller has been established again after it 1996 was lost. This event may be used to end a suppression. 1998 4. IANA Considerations 2000 This document makes no request of IANA. 2002 Note to RFC Editor: this section may be removed on publication as an 2003 RFC. 2005 5. Security Considerations 2007 This Information Model deals with information about the control and 2008 reporting of the Measurement Agent. There are broadly two security 2009 considerations for such an Information Model. Firstly the 2010 Information Model has to be sufficient to establish secure 2011 communication channels to the Controller and Collector such that 2012 other information can be sent and received securely. Additionally, 2013 any mechanisms that the Network Operator or other device 2014 administrator employs to pre-configure the MA must also be secure to 2015 protect unauthorized parties from modifying pre-configuration 2016 information. These mechanisms are important to ensure that the MA 2017 cannot be hijacked, for example to participate in a DDoS attack. 2019 The second consideration is that no mandated information items should 2020 pose a risk to confidentiality or privacy given such secure 2021 communication channels. For this latter reason items such as the MA 2022 context and MA ID are left optional and can be excluded from some 2023 deployments. This would, for example, allow the MA to remain 2024 anonymous and for information about location or other context that 2025 might be used to identify or track the MA to be omitted or blurred. 2027 The Information Model should support wherever relevant, all the 2028 security and privacy requirements associated with the LMAP Framework. 2030 6. Acknowledgements 2032 The notation was inspired by the notation used in the ALTO protocol 2033 specification. 2035 Philip Eardley, Trevor Burbridge, Marcelo Bagnulo and Juergen 2036 Schoenwaelder worked in part on the Leone research project, which 2037 received funding from the European Union Seventh Framework Programme 2038 [FP7/2007-2013] under grant agreement number 317647. 2040 Juergen Schoenwaelder was partly funded by Flamingo, a Network of 2041 Excellence project (ICT-318488) supported by the European Commission 2042 under its Seventh Framework Programme. 2044 7. References 2046 7.1. Normative References 2048 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2049 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 2050 RFC2119, March 1997, 2051 . 2053 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2054 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2055 . 2057 [RFC7594] Eardley, P., Morton, A., Bagnulo, M., Burbridge, T., 2058 Aitken, P., and A. Akhter, "A Framework for Large-Scale 2059 Measurement of Broadband Performance (LMAP)", RFC 7594, 2060 DOI 10.17487/RFC7594, September 2015, 2061 . 2063 7.2. Informative References 2065 [I-D.ietf-ippm-metric-registry] 2066 Bagnulo, M., Claise, B., Eardley, P., Morton, A., and A. 2067 Akhter, "Registry for Performance Metrics", draft-ietf- 2068 ippm-metric-registry-05 (work in progress), October 2015. 2070 [I-D.ietf-lmap-yang] 2071 Schoenwaelder, J. and V. Bajpai, "A YANG Data Model for 2072 LMAP Measurement Agents", draft-ietf-lmap-yang-01 (work in 2073 progress), July 2015. 2075 [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between 2076 Information Models and Data Models", RFC 3444, DOI 10 2077 .17487/RFC3444, January 2003, 2078 . 2080 [RFC7398] Bagnulo, M., Burbridge, T., Crawford, S., Eardley, P., and 2081 A. Morton, "A Reference Path and Measurement Points for 2082 Large-Scale Measurement of Broadband Performance", RFC 2083 7398, DOI 10.17487/RFC7398, February 2015, 2084 . 2086 Appendix A. Open Issues 2088 A.1. Remove suppress-by-default 2090 The text states already that suppress-by-default (which defaults to 2091 'true') only applies to measurement tasks but not to control tasks. 2092 Hence, a default suppression by default suppresses all non-control 2093 tasks. The proposal is to simply hardwire this. If other sets of 2094 suppression tasks are needed, we should use the tagging mechanism to 2095 define these sets. Having two mechanisms to define set of things to 2096 suppress seems more complex than needed. Proposal: Remove suppress- 2097 by-default and state that default suppression affects all non-control 2098 tasks. More specific suppressions can be configured using tags. 2100 A.2. Overlapping schedules/actions are skipped 2102 Add text that says the execution of actions or schedules is skipped 2103 if previous invocations are still running. We already have counters 2104 for this but there probably needs to be some additional text to go 2105 somewhere. 2107 A.3. Storage usage reporting and control 2109 Actions that feed results into other schedules occupy storage space. 2110 The proposal is to at least report how much storage is allocated to 2111 schedules and actions. Ideally, there would also be controls that 2112 can disable schedules or actions (or through events to start specific 2113 suppressions) if storage is getting tight. Or there should be a 2114 threshold that once crossed causes old data to be deleted. Anything 2115 more reasonable than simply failing once storage has been exhausted. 2117 A.4. Configuration vs. instruction: ma-task-obj 2119 It seems that ma-task-obj should only be configured by a system that 2120 has the access rights to setup the measurement agent. The controller 2121 should read the configured tasks and then only install schedules 2122 (with actions), suppressions, and events. That is, changing ma-task- 2123 obj is not part of an instruction but only part of the configuration. 2125 A.5. Streamline the reporting model 2127 The reporting model may need more attention; perhaps things can be 2128 streamlined and also be made more efficient. Implementation 2129 experience will help to work this out. 2131 Appendix B. Non-editorial Changes since -07 2133 o Added ma-schedule-end and ma-schedule-duration. 2135 o Changed the granularity of scheduler timings to seconds. 2137 o Added ma-status-suppression-obj to report the status of 2138 suppressions as done in the YANG data model. 2140 o Added counters to schedule and action status objects to match the 2141 counters in the YANG data model. 2143 o Using tags to pass information such as a measurement cycle 2144 identifier to the collector. 2146 o Using suppression tags and glob-style matching to select schedules 2147 and actions to be suppressed. 2149 Appendix C. Non-editorial Changes since -06 2151 o The default execution mode is pipelined (LI12) 2153 o Added text to define which action consumes data in sequential, 2154 pipelines, and parallel execution mode (LI11) 2156 o Added ma-config-measurement-point, ma-report-measurement-point, 2157 and ma-config-report-measurement-point to configure and report the 2158 measurement point (LI10) 2160 o Turned ma-suppression-obj into a list that uses a start event and 2161 a stop event to define the start and end of suppression; this 2162 unifies the handling of suppression and loss of controller 2163 connectivity (LI09) 2165 o Added ma-controller-lost-obj and ma-controller-ok-obj event 2166 objects (LI09) 2168 o Added ma-status-schedule-obj to report the status of a schedule 2169 and refactored ma-task-status-obj into ma-status-action-obj to 2170 report the status of an action (LI07, LI08) 2172 o Introduced a common ma-metric-registry-obj that identifies a 2173 metric and a set of associated roles and added this object to 2174 expose metric capabilities and to support the configuration of 2175 metrics and to report the metrics used (LI06) 2177 o Introduced ma-capability-obj and ma-capability-task-obj to expose 2178 the capabilities of a measurement agent (LI05) 2180 o Use 'ordered list' or 'unordered set' instead of list, collection, 2181 etc. (LI02) 2183 o Clarification that Actions are part of a Schedule (LI03) 2185 o Deleted terms that are not strictly needed (LI04) 2187 Appendix D. Non-editorial Changes since -05 2189 o A task can now reference multiply registry entries. 2191 o Consistent usage of the term Action and Task. 2193 o Schedules are triggered by Events instead of Timings; Timings are 2194 just one of many possible event sources. 2196 o Actions feed into other Schedules (instead of Actions within other 2197 Schedules). 2199 o Removed the notion of multiple task outputs. 2201 o Support for sequential, parallel, and pipelined execution of 2202 Actions. 2204 Authors' Addresses 2206 Trevor Burbridge 2207 BT 2208 Adastral Park, Martlesham Heath 2209 Ipswich IP5 3RE 2210 United Kingdom 2212 Email: trevor.burbridge@bt.com 2213 Philip Eardley 2214 BT 2215 Adastral Park, Martlesham Heath 2216 Ipswich IP5 3RE 2217 United Kingdom 2219 Email: philip.eardley@bt.com 2221 Marcelo Bagnulo 2222 Universidad Carlos III de Madrid 2223 Av. Universidad 30 2224 Leganes, Madrid 28911 2225 Spain 2227 Email: marcelo@it.uc3m.es 2229 Juergen Schoenwaelder 2230 Jacobs University Bremen 2231 Campus Ring 1 2232 Bremen 28759 2233 Germany 2235 Email: j.schoenwaelder@jacobs-university.de