idnits 2.17.1 draft-ietf-lmap-information-model-12.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 892 has weird spacing: '...ask-obj ma-ca...' == Line 938 has weird spacing: '...ace-obj ma-...' == Line 940 has weird spacing: '...ion-obj ma-st...' == Line 974 has weird spacing: '...ion-obj ma-...' == (7 more instances...) -- The document date (October 31, 2016) is 2727 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-07 == Outdated reference: A later version (-12) exists of draft-ietf-lmap-yang-05 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: May 4, 2017 M. Bagnulo 6 Universidad Carlos III de Madrid 7 J. Schoenwaelder 8 Jacobs University Bremen 9 October 31, 2016 11 Information Model for Large-Scale Measurement Platforms (LMAP) 12 draft-ietf-lmap-information-model-12 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 May 4, 2017. 48 Copyright Notice 50 Copyright (c) 2016 IETF Trust and the persons identified as the 51 document authors. All rights reserved. 53 This document is subject to BCP 78 and the IETF Trust's Legal 54 Provisions Relating to IETF Documents 55 (http://trustee.ietf.org/license-info) in effect on the date of 56 publication of this document. Please review these documents 57 carefully, as they describe your rights and restrictions with respect 58 to this document. Code Components extracted from this document must 59 include Simplified BSD License text as described in Section 4.e of 60 the Trust Legal Provisions and are provided without warranty as 61 described in the Simplified BSD License. 63 Table of Contents 65 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 66 2. Notation . . . . . . . . . . . . . . . . . . . . . . . . . . 5 67 3. LMAP Information Model . . . . . . . . . . . . . . . . . . . 5 68 3.1. Pre-Configuration Information . . . . . . . . . . . . . . 9 69 3.1.1. Definition of ma-preconfig-obj . . . . . . . . . . . 10 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 . . . . . . . 25 84 3.5.7. Definition of ma-status-interface-obj . . . . . . . . 25 85 3.6. Reporting Information . . . . . . . . . . . . . . . . . . 26 86 3.6.1. Definition of ma-report-obj . . . . . . . . . . . . . 28 87 3.6.2. Definition of ma-report-result-obj . . . . . . . . . 28 88 3.6.3. Definition of ma-report-conflict-obj . . . . . . . . 30 89 3.6.4. Definition of ma-report-table-obj . . . . . . . . . . 31 90 3.6.5. Definition of ma-report-row-obj . . . . . . . . . . . 31 91 3.7. Common Objects: Schedules . . . . . . . . . . . . . . . . 31 92 3.7.1. Definition of ma-schedule-obj . . . . . . . . . . . . 33 93 3.7.2. Definition of ma-action-obj . . . . . . . . . . . . . 34 94 3.8. Common Objects: Channels . . . . . . . . . . . . . . . . 35 95 3.8.1. Definition of ma-channel-obj . . . . . . . . . . . . 36 97 3.9. Common Objects: Task Configurations . . . . . . . . . . . 36 98 3.9.1. Definition of ma-task-obj . . . . . . . . . . . . . . 38 99 3.9.2. Definition of ma-option-obj . . . . . . . . . . . . . 38 100 3.10. Common Objects: Registry Information . . . . . . . . . . 39 101 3.10.1. Definition of ma-registry-obj . . . . . . . . . . . 39 102 3.11. Common Objects: Event Information . . . . . . . . . . . . 39 103 3.11.1. Definition of ma-event-obj . . . . . . . . . . . . . 40 104 3.11.2. Definition of ma-periodic-obj . . . . . . . . . . . 42 105 3.11.3. Definition of ma-calendar-obj . . . . . . . . . . . 42 106 3.11.4. Definition of ma-one-off-obj . . . . . . . . . . . . 44 107 3.11.5. Definition of ma-immediate-obj . . . . . . . . . . . 45 108 3.11.6. Definition of ma-startup-obj . . . . . . . . . . . . 45 109 3.11.7. Definition of ma-controller-lost-obj . . . . . . . . 45 110 3.11.8. Definition of ma-controller-connected-obj . . . . . 45 111 4. Example Execution . . . . . . . . . . . . . . . . . . . . . . 46 112 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 47 113 6. Security Considerations . . . . . . . . . . . . . . . . . . . 48 114 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 48 115 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 48 116 8.1. Normative References . . . . . . . . . . . . . . . . . . 49 117 8.2. Informative References . . . . . . . . . . . . . . . . . 49 118 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 49 119 A.1. Configuration of the device-id . . . . . . . . . . . . . 50 120 A.2. Reporting of agent-id and group-id . . . . . . . . . . . 50 121 Appendix B. Change History . . . . . . . . . . . . . . . . . . . 50 122 B.1. Non-editorial changes since -12 . . . . . . . . . . . . . 50 123 B.2. Non-editorial changes since -11 . . . . . . . . . . . . . 50 124 B.3. Non-editorial changes since -10 . . . . . . . . . . . . . 50 125 B.4. Non-editorial changes since -09 . . . . . . . . . . . . . 51 126 B.5. Non-editorial changes since -08 . . . . . . . . . . . . . 51 127 B.6. Non-editorial changes since -07 . . . . . . . . . . . . . 51 128 B.7. Non-editorial changes since -06 . . . . . . . . . . . . . 52 129 B.8. Non-editorial changes since -05 . . . . . . . . . . . . . 52 130 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 132 1. Introduction 134 A large-scale measurement platform is a collection of components that 135 work in a coordinated fashion to perform measurements from a large 136 number of vantage points. The main components of a large-scale 137 measurement platform are the Measurement Agents (hereafter MAs), the 138 Controller(s) and the Collector(s). 140 The MAs are the elements actually performing the measurements. The 141 MAs are controlled by exactly one Controller at a time and the 142 Collectors gather the results generated by the MAs. In a nutshell, 143 the normal operation of a large-scale measurement platform starts 144 with the Controller instructing a set of one or more MAs to perform a 145 set of one or more Measurement Tasks at a certain point in time. The 146 MAs execute the instructions from a Controller, and once they have 147 done so, they report the results of the measurements to one or more 148 Collectors. The overall framework for a Large Measurement platform 149 as used in this document is described in detail in [RFC7594]. 151 A large-scale measurement platform involves basically three types of 152 protocols, namely, a Control protocol (or protocols) between a 153 Controller and the MAs, a Report protocol (or protocols) between the 154 MAs and the Collector(s) and several measurement protocols between 155 the MAs and Measurement Peers (MPs), used to actually perform the 156 measurements. In addition some information is required to be 157 configured on the MA prior to any communication with a Controller. 159 This document defines the information model for both Control and the 160 Report protocols along with pre-configuration information that is 161 required on the MA before communicating with the Controller, broadly 162 named as the LMAP Information Model. The measurement protocols are 163 out of the scope of this document. 165 As defined in [RFC3444], the LMAP Information Model defines the 166 concepts involved in a large-scale measurement platform at a high 167 level of abstraction, independent of any specific implementation or 168 actual protocol used to exchange the information. It is expected 169 that the proposed information model can be used with different 170 protocols in different measurement platform architectures and across 171 different types of MA devices (e.g., home gateway, smartphone, PC, 172 router). A YANG data model implementing the information model can be 173 found in [I-D.ietf-lmap-yang]. 175 The definition of an Information Model serves a number of purposes: 177 1. To guide the standardisation of one or more Control and Report 178 protocols and data models 180 2. To enable high-level inter-operability between different Control 181 and Report protocols by facilitating translation between their 182 respective data models such that a Controller could instruct sub- 183 populations of MAs using different protocols 185 3. To form agreement of what information needs to be held by an MA 186 and passed over the Control and Report interfaces and support the 187 functionality described in the LMAP framework 189 4. To enable existing protocols and data models to be assessed for 190 their suitability as part of a large-scale measurement system 192 2. Notation 194 This document uses a programming language-like notation to define the 195 properties of the objects of the information model. An optional 196 property is enclosed by square brackets, [ ], and a list property is 197 indicated by two numbers in angle brackets, , where m indicates 198 the minimal number of values, and n is the maximum. The symbol * for 199 n means no upper bound. 201 3. LMAP Information Model 203 The information described herein relates to the information stored, 204 received or transmitted by a Measurement Agent as described within 205 the LMAP framework [RFC7594]. As such, some subsets of this 206 information model are applicable to the measurement Controller, 207 Collector and any device management system that pre-configures the 208 Measurement Agent. The information described in these models will be 209 transmitted by protocols using interfaces between the Measurement 210 Agent and such systems according to a Data Model. 212 For clarity the information model is divided into six sections: 214 1. Pre-Configuration Information. Information pre-configured on the 215 Measurement Agent prior to any communication with other 216 components of the LMAP architecture (i.e., the Controller, 217 Collector and Measurement Peers), specifically detailing how to 218 communicate with a Controller and whether the device is enabled 219 to participate as an MA. 221 2. Configuration Information. Update of the pre-configuration 222 information during the registration of the MA or subsequent 223 communication with the Controller, along with the configuration 224 of further parameters about the MA (rather than the Measurement 225 Tasks it should perform) that were not mandatory for the initial 226 communication between the MA and a Controller. 228 3. Instruction Information. Information that is received by the MA 229 from the Controller pertaining to the Measurement Tasks that 230 should be executed. This includes the task execution Schedules 231 (other than the Controller communication Schedule supplied as 232 (pre)configuration information) and related information such as 233 the Task Configuration, communication Channels to Collectors and 234 schedule Event and Timing information. It also includes Task 235 Suppression information that is used to over-ride normal Task 236 execution. 238 4. Logging Information. Information transmitted from the MA to the 239 Controller detailing the results of any configuration operations 240 along with error and status information from the operation of the 241 MA. 243 5. Capability and Status Information. Information on the general 244 status and capabilities of the MA. For example, the set of 245 measurements that are supported on the device. 247 6. Reporting Information. Information transmitted from the MA to 248 one or more Collectors including measurement results and the 249 context in which they were conducted. 251 In addition the MA may hold further information not described herein, 252 and which may be optionally transferred to or from other systems 253 including the Controller and Collector. One example of information 254 in this category is subscriber or line information that may be 255 extracted by a task and reported by the MA in the reporting 256 communication to a Collector. 258 It should also be noted that the MA may be in communication with 259 other management systems which may be responsible for configuring and 260 retrieving information from the MA device. Such systems, where 261 available, can perform an important role in transferring the pre- 262 configuration information to the MA or enabling/disabling the 263 measurement functionality of the MA. 265 The Information Model is divided into sub-sections for a number of 266 reasons. Firstly the grouping of information facilitates reader 267 understanding. Secondly, the particular groupings chosen are 268 expected to map to different protocols or different transmissions 269 within those protocols. 271 The granularity of data transmitted in each operation of the Control 272 and Report Protocols is not dictated by the Information Model. For 273 example, the Instruction object may be delivered in a single 274 operation. Alternatively, Schedules and Task Configurations may be 275 separated or even each Schedule/Task Configuration may be delivered 276 individually. Similarly the Information Model does not dictate 277 whether data is read, write, or read/write. For example, some 278 Control Protocols may have the ability to read back Configuration and 279 Instruction information which have been previously set on the MA. 280 Lastly, while some protocols may simply overwrite information (for 281 example refreshing the entire Instruction Information), other 282 protocols may have the ability to update or delete selected items of 283 information. 285 The information in these six sections is captured by a number of 286 common information objects. These objects are also described later 287 in this document and comprise of: 289 1. Schedules. A set of Schedules tells the MA to do something. 290 Without a Schedule no Task (from a measurement to reporting or 291 communicating with the Controller) is ever executed. Schedules 292 are used within the Instruction to specify what tasks should be 293 performed, when, and how to direct their results. A Schedule is 294 also used within the pre-Configuration and Configuration 295 information in order to execute the Task or Tasks required to 296 communicate with the Controller. A specific Schedule can only be 297 active once. Attempts to start a Schedule while the same 298 Schedule is still running will fail. 300 2. Channels. A set of Channel objects are used to communicate with 301 a number of endpoints (i.e., the Controller and Collectors). 302 Each Channel object contains the information required for the 303 communication with a single endpoint such as the target location 304 and security details. 306 3. Task Configurations. A set of Task Configurations is used to 307 configure the Tasks that are run by the MA. This includes the 308 registry entries for the Task and any configuration parameters. 309 Task Configurations are referenced from a Schedule in order to 310 specify what Tasks the MA should execute. 312 4. Events. A set of Event objects that can be referenced from the 313 Schedules. Each Schedule always references exactly one Event 314 object that determines when the schedule is executed. An Event 315 object specifies either a singleton or series of events that 316 indicate when Tasks should be executed. A commonly used kind of 317 Event objects are Timing objects. 319 Figure 1 illustrates the structure in which these common information 320 objects are referenced. The references are achieved by each object 321 (Task Configuration, Event) being given a short textual name that is 322 used by other objects. The objects shown in parenthesis are part of 323 the internal object structure of a Schedule. Channels are not shown 324 in the diagram since they are only used as an option by selected Task 325 Configurations but are similarly referenced using a short text name. 327 Schedule 328 |-- triggered by --> Event 329 | 330 |-- executes --> Action 1 331 | |-- using --> Task Configuration 332 | | 333 | `-- feeding to --> Destination Schedule 334 : 335 : 336 `-- executes --> Action N 337 |-- using --> Task Configuration 338 | 339 `-- feeding to --> Destination Schedule 341 Figure 1: Relationship between Schedules, Events, Actions, Task 342 Configurations, and Destination Schedules 344 The primary function of an MA is to execute Schedules. Every Action 345 contained in a Schedule is defined as a Task. As such, these Actions 346 are configured through Task Configurations and executed according to 347 the Event object referenced by the Schedule in which they appear. 348 Note, however, that Actions can have Action specific parameters. 350 Tasks can implement a variety of different types of Actions. While 351 in terms of the Information Model, all Tasks have the same structure, 352 it can help conceptually to think of different Task categories: 354 1. Measurement Tasks measure some aspect of network performance or 355 traffic. They may also capture contextual information from the 356 MA device or network interfaces such as the device type or 357 interface speed. 359 2. Data Transfer Tasks support the communication with a Controller 360 and Collectors: 362 A. Reporting Tasks report the results of Measurement Tasks to 363 Collectors 365 B. Control Task(s) implement the Control Protocol and 366 communicate with the Controller. 368 3. Data Analysis Tasks can exist to analyse data from other 369 Measurement Tasks locally on the MA 371 4. Data Management Tasks may exist to clean-up, filter or compress 372 data on the MA such as Measurement Task results 374 Figure 1 indicates that Actions can produce data that is fed into 375 Destination Schedules. This can by used by Actions implementing 376 Measurement Tasks to feed measurement results to a Schedule that 377 triggers Actions implementing Reporting Tasks. Data fed to a 378 Destination Schedule is consumed by the first Action of the 379 Destination Schedule if the Destination Schedule is using sequential 380 or pipelined execution mode and it is consumed by all Actions of the 381 Destination Schedule if the Destination Schedule is using parallel 382 execution mode. 384 3.1. Pre-Configuration Information 386 This information is the minimal information that needs to be pre- 387 configured to the MA in order for it to successfully communicate with 388 a Controller during the registration process. Some of the Pre- 389 Configuration Information elements are repeated in the Configuration 390 Information in order to allow an LMAP Controller to update these 391 items. The pre-configuration information also contains some elements 392 that are not under the control of the LMAP framework (such as the 393 device identifier and device security credentials). 395 This Pre-Configuration Information needs to include a URL of the 396 initial Controller from where configuration information can be 397 communicated along with the security information required for the 398 communication including the certificate of the Controller (or the 399 certificate of the Certification Authority which was used to issue 400 the certificate for the Controller). All this is expressed as a 401 Channel. While multiple Channels may be provided in the Pre- 402 Configuration Information they must all be associated with a single 403 Controller (e.g., over different interfaces or network protocols). 405 Where the MA pulls information from the Controller, the Pre- 406 Configuration Information also needs to contain the timing of the 407 communication with the Controller as well as the nature of the 408 communication itself (such as the protocol and data to be 409 transferred). The timing is given as a Schedule that executes the 410 Task(s) responsible for communication with the Controller. It is 411 this Task (or Tasks) that implement the Control protocol between the 412 MA and the Controller and utilises the Channel information. The 413 Task(s) may take additional parameters in which case a Task 414 Configuration can also be included. 416 Even where information is pushed to the MA from the Controller 417 (rather than pulled by the MA), a Schedule still needs to be 418 supplied. In this case the Schedule will simply execute a Controller 419 listener task when the MA is started. A Channel is still required 420 for the MA to establish secure communication with the Controller. 422 It can be seen that these Channels, Schedules and Task Configurations 423 for the initial MA-Controller communication are no different in terms 424 of the Information Model to any other Channel, Schedule or Task 425 Configuration that might execute a Measurement Task or report the 426 measurement results (as described later). 428 The MA may be pre-configured with an MA ID, or may use a Device ID in 429 the first Controller contact before it is assigned an MA ID. The 430 Device ID may be a MAC address or some other device identifier 431 expressed as a URI. If the MA ID is not provided at this stage then 432 it must be provided by the Controller during Configuration. 434 3.1.1. Definition of ma-preconfig-obj 436 object { 437 [uuid ma-preconfig-agent-id;] 438 ma-task-obj ma-preconfig-control-tasks<1..*>; 439 ma-channel-obj ma-preconfig-control-channels<1..*>; 440 ma-schedule-obj ma-preconfig-control-schedules<1..*>; 441 [uri ma-preconfig-device-id;] 442 credentials ma-preconfig-credentials; 443 } ma-preconfig-obj; 445 The ma-preconfig-obj is essentially a subset of the ma-config-obj 446 described below. The ma-preconfig-obj consists of the following 447 elements: 449 ma-preconfig-agent-id: An optional uuid uniquely identifying 450 the measurement agent. 452 ma-preconfig-control-tasks: An unordered set of tasks objects. 454 ma-preconfig-control-channels: An unordered set of channel objects. 456 ma-preconfig-control-schedules: An unordered set of scheduling 457 objects. 459 ma-preconfig-device-id: An optional identifier for the 460 device. 462 ma-preconfig-credentials: The security credentials used by the 463 measurement agent. 465 3.2. Configuration Information 467 During registration or at any later point at which the MA contacts 468 the Controller (or vice-versa), the choice of Controller, details for 469 the timing of communication with the Controller or parameters for the 470 communication Task(s) can be changed (as captured by the Channels, 471 Schedules and Task Configurations objects). For example the pre- 472 configured Controller (specified as a Channel or Channels) may be 473 over-ridden with a specific Controller that is more appropriate to 474 the MA device type, location or characteristics of the network (e.g., 475 access technology type or broadband product). The initial 476 communication Schedule may be over-ridden with one more relevant to 477 routine communications between the MA and the Controller. 479 While some Control protocols may only use a single Schedule, other 480 protocols may use several Schedules (and related data transfer Tasks) 481 to update the Configuration Information, transfer the Instruction 482 Information, transfer Capability and Status Information and send 483 other information to the Controller such as log or error 484 notifications. Multiple Channels may be used to communicate with the 485 same Controller over multiple interfaces (e.g., to send logging 486 information over a different network). 488 In addition the MA will be given further items of information that 489 relate specifically to the MA rather than the measurements it is to 490 conduct or how to report results. The assignment of an ID to the MA 491 is mandatory. If the MA Agent ID was not optionally provided during 492 the pre-configuration then one must be provided by the Controller 493 during Configuration. Optionally a Group ID may also be given which 494 identifies a group of interest to which that MA belongs. For example 495 the group could represent an ISP, broadband product, technology, 496 market classification, geographic region, or a combination of 497 multiple such characteristics. Where the Measurement Group ID is set 498 an additional flag (the Report MA ID flag) is required to control 499 whether the Measurement Agent ID is also to be reported. The 500 reporting of a Group ID without the MA ID allows the MA to remain 501 anonymous, which may be particularly useful to prevent tracking of 502 mobile MA devices. 504 Optionally an MA can also be configured to stop executing any 505 Instruction Schedule if the Controller is unreachable. This can be 506 used as a fail-safe to stop Measurement and other Tasks being 507 conducted when there is doubt that the Instruction Information is 508 still valid. This is simply represented as a time window in seconds 509 since the last communication with the Controller after which an Event 510 is generated that can trigger the suspension of Instruction 511 Schedules. The appropriate value of the time window will depend on 512 the specified communication Schedule with the Controller and the 513 duration for which the system is willing to tolerate continued 514 operation with potentially stale Instruction Information. 516 While Pre-Configuration Information is persistent upon device reset 517 or power cycle, the persistency of the Configuration Information may 518 be device dependent. Some devices may revert back to their pre- 519 configuration state upon reboot or factory reset, while other devices 520 may store all Configuration and Instruction information in persistent 521 storage. A Controller can check whether an MA has the latest 522 Configuration and Instruction information by examining the Capability 523 and Status information for the MA. 525 3.2.1. Definition of ma-config-obj 527 object { 528 uuid ma-config-agent-id; 529 ma-task-obj ma-config-control-tasks<1..*>; 530 ma-channel-obj ma-config-control-channels<1..*>; 531 ma-schedule-obj ma-config-control-schedules<1..*>; 532 [uri ma-config-device-id;] 533 credentials ma-config-credentials; 534 [string ma-config-group-id;] 535 [string ma-config-measurement-point;] 536 [boolean ma-config-report-agent-id;] 537 [boolean ma-config-report-measurement-point;] 538 [int ma-config-controller-timeout;] 539 } ma-config-obj; 541 The ma-config-obj consists of the following elements: 543 ma-config-agent-id: A uuid uniquely identifying the 544 measurement agent. 546 ma-config-control-tasks: An unordered set of task objects. 548 ma-config-control-channels: An unordered set of channel 549 objects. 551 ma-config-control-schedules: An unordered set of scheduling 552 objects. 554 ma-config-device-id: An optional identifier for the 555 device. 557 ma-config-credentials: The security credentials used by 558 the measurement agent. 560 ma-config-group-id: An optional identifier of the 561 group of measurement agents this 562 measurement agent belongs to. 564 ma-config-measurement-point: An optional identifier for the 565 measurement point indicating 566 where the measurement agent is 567 located on a path (see [RFC7398] 568 for further details). 570 ma-config-report-agent-id: An optional flag indicating 571 whether the identifier (ma- 572 config-agent-id) should be 573 included in reports. The default 574 value is false. 576 ma-config-report-measurement-point: An optional flag indicating 577 whether the measurement point 578 (ma-config-measurement-point) 579 should be included in reports. 580 The default value is false. 582 ma-config-controller-timeout: A timer is started after each 583 successful contact with a 584 controller. When the timer 585 reaches the controller-timeout 586 (measured in seconds), an event 587 is raised indicating that 588 connectivity to the controller 589 has been lost (see ma-controller- 590 lost-obj). 592 3.3. Instruction Information 594 The Instruction information model has four sub-elements: 596 1. Instruction Task Configurations 598 2. Report Channels 600 3. Instruction Schedules 602 4. Suppression 604 The Instruction supports the execution of all Tasks on the MA except 605 those that deal with communication with the Controller (specified in 606 (pre-)configuration information). The Tasks are configured in 607 Instruction Task Configurations and included by reference in 608 Instruction Schedules that specify when to execute them. The results 609 can be communicated to other Schedules or a Task may implement a 610 Reporting Protocol and communicate results over Report Channels. 611 Suppression is used to temporarily stop the execution of new Tasks as 612 specified by the Instruction Schedules (and optionally to stop 613 ongoing Tasks). 615 A Task Configuration is used to configure the mandatory and optional 616 parameters of a Task. It also serves to instruct the MA about the 617 Task including the ability to resolve the Task to an executable and 618 specifying the schema for the Task parameters. 620 A Report Channel defines how to communicate with a single remote 621 system specified by a URL. A Report Channel is used to send results 622 to a single Collector but is no different in terms of the Information 623 Model to the Control Channel used to transfer information between the 624 MA and the Controller. Several Report Channels can be defined to 625 enable results to be split or duplicated across different 626 destinations. A single Channel can be used by multiple (reporting) 627 Task Configurations to transfer data to the same Collector. A single 628 Reporting Task Configuration can also be included in multiple 629 Schedules. E.g., a single Collector may receive data at three 630 different cycle rates, one Schedule reporting hourly, another 631 reporting daily and a third specifying that results should be sent 632 immediately for on-demand measurement tasks. Alternatively multiple 633 Report Channels can be used to send Measurement Task results to 634 different Collectors. The details of the Channel element is 635 described later as it is common to several objects. 637 Instruction Schedules specify which Actions to execute according to a 638 given triggering Event. An Action is a Task with additional specific 639 parameters. An Event can trigger the execution of a single Action or 640 it can trigger a repeated series of Actions. The Schedule also 641 specifies how to link Tasks output data to other Schedules. 643 Measurement Suppression information is used to over-ride the 644 Instruction Schedule and temporarily stop measurements or other Tasks 645 from running on the MA for a defined or indefinite period. While 646 conceptually measurements can be stopped by simply removing them from 647 the Measurement Schedule, splitting out separate information on 648 Measurement Suppression allows this information to be updated on the 649 MA on a different timing cycle or protocol implementation to the 650 Measurement Schedule. It is also considered that it will be easier 651 for a human operator to implement a temporary explicit suppression 652 rather than having to move to a reduced Schedule and then roll-back 653 at a later time. 655 It should be noted that control schedules and tasks cannot be 656 suppressed as evidenced by the lack of suppression information in the 657 Configuration. The control schedule must only reference tasks listed 658 as control tasks (i.e., within the Configuration information). 660 A single Suppression object is able to enable/disable a set of 661 Instruction Tasks that are tagged for suppression. This enabled fine 662 grained control on which Tasks are suppressed. Suppression of both 663 matching Actions and Measurement Schedules is supported. Support for 664 disabling specific Actions allows malfunctioning or mis-configured 665 Tasks or Actions that have an impact on a particular part of the 666 network infrastructure (e.g., a particular Measurement Peer) to be 667 targeted. Support for disabling specific Schedules allows for 668 particularly heavy cycles or sets of less essential Measurement Tasks 669 to be suppressed quickly and effectively. Note that Suppression has 670 no effect on either Controller Tasks or Controller Schedules. 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. If not present, 738 the suppression starts immediately, 739 i.e., as if the value would be 740 'immediate'. 742 ma-suppression-end: The optional event indicating when 743 suppression ends. If not present, the 744 suppression does not have a defined 745 end, i.e., the suppression remains for 746 an indefinite period of time. 748 ma-suppression-match: An optional and possibly empty 749 unordered set of match patterns. The 750 suppression will apply to all schedules 751 (and their actions) that have a 752 matching value in their ma-schedule- 753 suppression-tags and all actions that 754 have a matching value in their ma- 755 action-suppression-tags. Pattern 756 matching is done using glob style 757 pattern (see below). 759 ma-suppression-stop-running: An optional boolean indicating whether 760 suppression will stop any running 761 matching schedules or actions. The 762 default value for this boolean is 763 false. 765 Glob style pattern matching is following POSIX.2 fnmatch() without 766 special treatment of file paths: 768 * matches a sequence of characters 769 ? matches a single character 770 [seq] matches any character in seq 771 [!seq] matches any character not in seq 773 A backslash followed by a character matches the following character. 774 In particular: 776 \* matches * 777 \? matches ? 778 \\ matches \ 780 A sequence seq may be a sequence of characters (e.g., [abc] or a 781 range of characters (e.g., [a-c]). 783 3.4. Logging Information 785 The MA may report on the success or failure of Configuration or 786 Instruction communications from the Controller. In addition further 787 operational logs may be produced during the operation of the MA and 788 updates to capabilities may also be reported. Reporting this 789 information is achieved in exactly the same manner as scheduling any 790 other Task. We make no distinction between a Measurement Task 791 conducting an active or passive network measurement and one which 792 solely retrieves static or dynamic information from the MA such as 793 capabilities or logging information. One or more logging tasks can 794 be programmed or configured to capture subsets of the Logging 795 Information. These logging tasks are then executed by Schedules 796 which also specify that the resultant data is to be transferred over 797 the Controller Channels. 799 The type of Logging Information will fall into three different 800 categories: 802 1. Success/failure/warning messages in response to information 803 updates from the Controller. Failure messages could be produced 804 due to some inability to receive or parse the Controller 805 communication, or if the MA is not able to act as instructed. 806 For example: 808 * "Measurement Schedules updated OK" 810 * "Unable to parse JSON" 812 * "Missing mandatory element: Measurement Timing" 814 * "'Start' does not conform to schema - expected datetime" 816 * "Date specified is in the past" 818 * "'Hour' must be in the range 1..24" 820 * "Schedule A refers to non-existent Measurement Task 821 Configuration" 823 * "Measurement Task Configuration X registry entry Y not found" 825 * "Updated Measurement Task Configurations do not include M used 826 by Measurement Schedule N" 828 2. Operational updates from the MA. For example: 830 * "Out of memory: cannot record result" 832 * "Collector 'collector.example.com' not responding" 834 * "Unexpected restart" 836 * "Suppression timeout" 838 * "Failed to execute Measurement Task Configuration H" 840 3. Status updates from the MA. For example: 842 * "Device interface added: eth3" 844 * "Supported measurements updated" 846 * "New IP address on eth0: xxx.xxx.xxx.xxx" 848 This Information Model document does not detail the precise format of 849 logging information since it is to a large extent protocol and MA 850 specific. However, some common information can be identified. 852 3.4.1. Definition of ma-log-obj 854 object { 855 uuid ma-log-agent-id; 856 datetime ma-log-event-time; 857 code ma-log-code; 858 string ma-log-description; 859 } ma-log-obj; 861 The ma-log-obj models the generic aspects of a logging object and 862 consists of the following elements: 864 ma-log-agent-id: A uuid uniquely identifying the measurement 865 agent. 867 ma-log-event-time: The date and time of the event reported in 868 the logging object. 870 ma-log-code: A machine readable code describing the 871 event. 873 ma-log-description: A human readable description of the event. 875 3.5. Capability and Status Information 877 The MA will hold Capability Information that can be retrieved by a 878 Controller. Capabilities include the device interface details 879 available to Measurement Tasks as well as the set of Measurement 880 Tasks/Roles (specified by registry entries) that are actually 881 installed or available on the MA. Status information includes the 882 times that operations were last performed such as contacting the 883 Controller or producing Reports. 885 3.5.1. Definition of ma-capability-obj 887 object { 888 string ma-capability-hardware; 889 string ma-capability-firmware; 890 string ma-capability-version; 891 [string ma-capability-tags<0..*>;] 892 [ma-capability-task-obj ma-capability-tasks<0..*>;] 893 } ma-capability-obj; 895 The ma-capability-obj provides information about the capabilities of 896 the measurement agent and consists of the following elements: 898 ma-capability-hardware: A description of the hardware of the device 899 the measurement agent is running on. 901 ma-capability-firmware: A description of the firmware of the device 902 the measurement agent is running on. 904 ma-capability-version: The version of the measurement agent. 906 ma-capability-tags: An optional unordered set of tags that 907 provide additional information about the 908 capabilities of the measurement agent. 910 ma-capability-tasks: An optional unordered set of capability 911 objects for each supported task. 913 3.5.2. Definition of ma-capability-task-obj 915 object { 916 string ma-capability-task-name; 917 ma-registry-obj ma-capability-task-functions<0..*>; 918 string ma-capability-task-version; 919 } ma-capability-task-obj; 921 The ma-capability-task-obj provides information about the capability 922 of a task and consists of the following elements: 924 ma-capability-task-name: A name uniquely identifying a task. 926 ma-capability-task-functions: A possibly empty unordered set of 927 registry entries identifying 928 functions this task implements. 930 ma-capability-task-version: The version of the measurement task. 932 3.5.3. Definition of ma-status-obj 934 object { 935 uuid ma-status-agent-id; 936 uri ma-status-device-id; 937 datetime ma-status-last-started; 938 ma-status-interface-obj ma-status-interfaces<0..*>; 939 [ma-status-schedule-obj ma-status-schedules<0..*>;] 940 [ma-status-suppression-obj ma-status-suppressions<0..*>;] 941 } ma-status-obj; 943 The ma-status-obj provides status information about the measurement 944 agent and consists of the following elements: 946 ma-status-agent-id: A uuid uniquely identifying the measurement 947 agent. 949 ma-status-device-id: A URI identifying the device. 951 ma-status-last-started: The date and time the measurement agent 952 last started. 954 ma-status-interfaces: An unordered set of network interfaces 955 available on the device. 957 ma-status-schedules: An optional unordered set of status objects 958 for each schedule. 960 ma-status-suppressions: An optional unordered set of status objects 961 for each suppression. 963 3.5.4. Definition of ma-status-schedule-obj 965 object { 966 string ma-status-schedule-name; 967 string ma-status-schedule-state; 968 int ma-status-schedule-storage; 969 counter ma-status-schedule-invocations; 970 counter ma-status-schedule-suppressions; 971 counter ma-status-schedule-overlaps; 972 counter ma-status-schedule-failures; 973 datetime ma-status-schedule-last-invocation; 974 [ma-status-action-obj ma-status-schedule-actions<0..*>;] 975 } ma-status-schedule-obj; 977 The ma-status-schedule-obj provides status information about the 978 status of a schedule and consists of the following elements: 980 ma-status-schedule-name: The name of the schedule this 981 status object refers to. 983 ma-status-schedule-state: The state of the schedule. The 984 value 'enabled' indicates that 985 the schedule is currently 986 enabled. The value 'suppressed' 987 indicates that the schedule is 988 currently suppressed. The value 989 'disabled' indicates that the 990 schedule is currently disabled. 991 The value 'running' indicates 992 that the schedule is currently 993 running. 995 ma-status-schedule-storage: The amount of secondary storage 996 (e.g., allocated in a file 997 system) holding temporary data 998 allocated to the schedule in 999 bytes. This object reports the 1000 amount of allocated physical 1001 storage and not the storage used 1002 by logical data records. Data 1003 models should use a 64-bit 1004 integer type. 1006 ma-status-schedule-invocations Number of invocations of this 1007 schedule. This counter does not 1008 include suppressed invocations or 1009 invocations that were prevented 1010 due to an overlap with a previous 1011 invocation of this schedule. 1013 ma-status-schedule-suppressions Number of suppressed executions 1014 of this schedule. 1016 ma-status-schedule-overlaps Number of executions prevented 1017 due to overlaps with a previous 1018 invocation of this schedule. 1020 ma-status-schedule-failures Number of failed executions of 1021 this schedule. A failed 1022 execution is an execution where 1023 at least one action failed. 1025 ma-status-schedule-last-invocation: The date and time of the last 1026 invocation of this schedule. 1028 ma-status-schedule-actions: An optional ordered list of 1029 status objects for each action of 1030 the schedule. 1032 3.5.5. Definition of ma-status-action-obj 1033 object { 1034 string ma-status-action-name; 1035 string ma-status-action-state; 1036 int ma-status-action-storage; 1037 counter ma-status-action-invocations; 1038 counter ma-status-action-suppressions; 1039 counter ma-status-action-overlaps; 1040 counter ma-status-action-failures; 1041 datetime ma-status-action-last-invocation; 1042 datetime ma-status-action-last-completion; 1043 int ma-status-action-last-status; 1044 string ma-status-action-last-message; 1045 datetime ma-status-action-last-failed-completion; 1046 int ma-status-action-last-failed-status; 1047 string ma-status-action-last-failed-message; 1048 } ma-status-action-obj; 1050 The ma-status-action-obj provides status information about an action 1051 of a schedule and consists of the following elements: 1053 ma-status-action-name: The name of the action of a 1054 schedule this status object 1055 refers to. 1057 ma-status-action-state: The state of the action. 1058 The value 'enabled' 1059 indicates that the action is 1060 currently enabled. The 1061 value 'suppressed' indicates 1062 that the action is currently 1063 suppressed. The value 1064 'disabled' indicates that 1065 the action is currently 1066 disabled. The value 1067 'running' indicates that the 1068 action is currently running. 1070 ma-status-action-storage: The amount of secondary 1071 storage (e.g., allocated in 1072 a file system) holding 1073 temporary data allocated to 1074 the action in bytes. This 1075 object reports the amount of 1076 allocated physical storage 1077 and not the storage used by 1078 logical data records. Data 1079 models should use a 64-bit 1080 integer type. 1082 ma-status-action-invocations Number of invocations of 1083 this action. This counter 1084 does not include suppressed 1085 invocations or invocations 1086 that were prevented due to 1087 an overlap with a previous 1088 invocation of this action. 1090 ma-status-action-suppressions Number of suppressed 1091 executions of this action. 1093 ma-status-action-overlaps Number of executions 1094 prevented due to overlaps 1095 with a previous invocation 1096 of this action. 1098 ma-status-action-failures Number of failed executions 1099 of this action. 1101 ma-status-action-last-invocation: The date and time of the 1102 last invocation of this 1103 action. 1105 ma-status-action-last-completion: The date and time of the 1106 last completion of this 1107 action. 1109 ma-status-action-last-status: The status code returned by 1110 the last execution of this 1111 action. 1113 ma-status-action-last-message: The status message produced 1114 by the last execution of 1115 this action. 1117 ma-status-action-last-failed-completion: The date and time of the 1118 last failed completion of 1119 this action. 1121 ma-status-action-last-failed-status: The status code returned by 1122 the last failed execution of 1123 this action. 1125 ma-status-action-last-failed-message: The status message produced 1126 by the last failed execution 1127 of this action. 1129 3.5.6. Definition of ma-status-suppression-obj 1131 object { 1132 string ma-status-suppression-name; 1133 string ma-status-suppression-state; 1134 } ma-status-suppression-obj; 1136 The ma-status-suppression-obj provides status information about that 1137 status of a suppression and consists of the following elements: 1139 ma-status-suppression-name: The name of the suppression this status 1140 object refers to. 1142 ma-status-suppression-state: The state of the suppression. The 1143 value 'enabled' indicates that the 1144 suppression is currently enabled. The 1145 value 'active indicates that the 1146 suppression is currently active. The 1147 value 'disabled' indicates that the 1148 suppression is currently disabled. 1150 3.5.7. Definition of ma-status-interface-obj 1152 object { 1153 string ma-status-interface-name; 1154 string ma-status-interface-type; 1155 [int ma-status-interface-speed;] 1156 [string ma-status-interface-link-layer-address;] 1157 [ip-address ma-status-interface-ip-addresses<0..*>;] 1158 [ip-address ma-status-interface-gateways<0..*>;] 1159 [ip-address ma-status-interface-dns-servers<0..*>;] 1160 } ma-status-interface-obj; 1162 The ma-status-interface-obj provides status information about network 1163 interfaces and consists of the following elements: 1165 ma-status-interface-name: A name uniquely identifying a 1166 network interface. 1168 ma-status-interface-type: The type of the network 1169 interface. 1171 ma-status-interface-speed: An optional indication of the 1172 speed of the interface 1173 (measured in bits-per- 1174 second). 1176 ma-status-interface-link-layer-address: An optional link-layer 1177 address of the interface. 1179 ma-status-interface-ip-addresses: An optional ordered list of 1180 IP addresses assigned to the 1181 interface. 1183 ma-status-interface-gateways: An optional ordered list of 1184 gateways assigned to the 1185 interface. 1187 ma-status-interface-dns-servers: An optional ordered list of 1188 DNS servers assigned to the 1189 interface. 1191 3.6. Reporting Information 1193 At a point in time specified by a Schedule, the MA will execute tasks 1194 that communicate a set of measurement results to the Collector. 1195 These Reporting Tasks will be configured to transmit task results 1196 over a specified Report Channel to a Collector. 1198 It should be noted that the output from Tasks does not need to be 1199 sent to communication Channels. It can alternatively, or 1200 additionally, be sent to other Tasks on the MA. This facilitates 1201 using a first Measurement Task to control the operation of a later 1202 Measurement Task (such as first probing available line speed and then 1203 adjusting the operation of a video testing measurement) and also to 1204 allow local processing of data to output alarms (e.g., when 1205 performance drops from earlier levels). Of course, subsequent Tasks 1206 also include Tasks that implement the reporting protocol(s) and 1207 transfer data to one or more Collector(s). 1209 The Report generated by a Reporting Task is structured hierarchically 1210 to avoid repetition of report header and Measurement Task 1211 Configuration information. The report starts with the timestamp of 1212 the report generation on the MA and details about the MA including 1213 the optional Measurement Agent ID and Group ID (controlled by the 1214 Configuration Information). 1216 Much of the report Information is optional and will depend on the 1217 implementation of the Reporting Task and any parameters defined in 1218 the Task Configuration for the Reporting Task. For example some 1219 Reporting Tasks may choose not to include the Measurement Task 1220 Configuration or Action parameters, while others may do so dependent 1221 on the Controller setting a configurable parameter in the Task 1222 Configuration. 1224 It is possible for a Reporting Task to send just the Report header 1225 (datetime and optional agent ID and/or Group ID) if no measurement 1226 data is available. Whether to send such empty reports again is 1227 dependent on the implementation of the Reporting Task and potential 1228 Task Configuration parameter. 1230 The handling of measurement data on the MA before generating a Report 1231 and transfer from the MA to the Collector is dependent on the 1232 implementation of the device, MA and/or scheduled Tasks and not 1233 defined by the LMAP standards. Such decisions may include limits to 1234 the measurement data storage and what to do when such available 1235 storage becomes depleted. It is generally suggested that 1236 implementations running out of storage stop executing new measurement 1237 tasks and retain old measurement data. 1239 No context information, such as line speed or broadband product are 1240 included within the report header information as this data is 1241 reported by individual tasks at the time they execute. Either a 1242 Measurement Task can report contextual parameters that are relevant 1243 to that particular measurement, or specific tasks can be used to 1244 gather a set of contextual and environmental data at certain times 1245 independent of the reporting schedule. 1247 After the report header information the results are reported grouped 1248 according to different Measurement Task Configurations. Each Task 1249 section optionally starts with replicating the Measurement Task 1250 Configuration information before the result headers (titles for data 1251 columns) and the result data rows. The Options reported are those 1252 used for the scheduled execution of the Measurement Task and 1253 therefore include the Options specified in the Task Configuration as 1254 well as additional Options specified in the Action. The Action 1255 Options are appended to the Task Configuration Options in exactly the 1256 same order as they were provided to the Task during execution. 1258 The result row data includes a time for the start of the measurement 1259 and optionally an end time where the duration also needs to be 1260 considered in the data analysis. 1262 Some Measurement Tasks may optionally include an indication of the 1263 cross-traffic although the definition of cross-traffic is left up to 1264 each individual Measurement Task. Some Measurement Tasks may also 1265 output other environmental measures in addition to cross-traffic such 1266 as CPU utlilisation or interface speed. 1268 Where the Configuration and Instruction information represent 1269 information transmitted via the Control Protocol, the Report 1270 represents the information that is transmitted via the Report 1271 Protocol. It is constructed at the time of sending a report and 1272 represents the inherent structure of the information that is sent to 1273 the Collector. 1275 3.6.1. Definition of ma-report-obj 1277 object { 1278 datetime ma-report-date; 1279 [uuid ma-report-agent-id;] 1280 [string ma-report-group-id;] 1281 [string ma-report-measurement-point;] 1282 [ma-report-result-obj ma-report-results<0..*>;] 1283 } ma-report-obj; 1285 The ma-report-obj provides the meta-data of a single report and 1286 consists of the following elements: 1288 ma-report-date: The date and time when the report was 1289 sent to a collector. 1291 ma-report-agent-id: An optional uuid uniquely identifying 1292 the measurement agent. 1294 ma-report-group-id: An optional identifier of the group of 1295 measurement agents this measurement 1296 agent belongs to. 1298 ma-report-measurement-point: An optional identifier for the 1299 measurement point indicating where the 1300 measurement agent is located on a path 1301 (see [RFC7398] for further details). 1303 ma-report-results: An optional and possibly empty 1304 unordered set of result objects. 1306 3.6.2. Definition of ma-report-result-obj 1307 object { 1308 string ma-report-result-schedule-name; 1309 string ma-report-result-action-name; 1310 string ma-report-result-task-name; 1311 [ma-option-obj ma-report-result-options<0..*>;] 1312 [string ma-report-result-tags<0..*>;] 1313 datetime ma-report-result-event-time; 1314 datetime ma-report-result-start-time; 1315 [datetime ma-report-result-end-time;] 1316 [string ma-report-result-cycle-number;] 1317 int ma-report-result-status; 1318 [ma-report-conflict-obj ma-report-result-conflicts<0..*>;] 1319 [ma-report-table-obj ma-report-result-tables<0..*>;] 1320 } ma-report-result-obj; 1322 The ma-report-result-obj provides the meta-data of a result report of 1323 a single executed action. It consists of the following elements: 1325 ma-report-result-schedule-name: The name of the schedule that 1326 produced the result. 1328 ma-report-result-action-name: The name of the action in the 1329 schedule that produced the result. 1331 ma-report-result-task-name: The name of the task that produced 1332 the result. 1334 ma-report-result-options: An optional ordered joined list of 1335 options provided by the task object 1336 and the action object when the action 1337 was started. 1339 ma-report-result-tags: An optional unordered set of tags. 1340 This is the joined set of tags 1341 provided by the task object and the 1342 action object and schedule object 1343 when the action was started. 1345 ma-report-result-event-time: The date and time of the event that 1346 triggered the schedule of the action 1347 that produced the reported result 1348 values. The date and time does not 1349 include any added randomization. 1351 ma-report-result-start-time: The date and time of the start of the 1352 action that produced the reported 1353 result values. 1355 ma-report-result-end-time: An optional date and time indicating 1356 when the action finished. 1358 ma-report-result-cycle-number: An optional cycle number derived from 1359 ma-report-result-event-time. It is 1360 the time closest to ma-report-result- 1361 event-time that is a multiple of the 1362 ma-event-cycle-interval of the event 1363 that triggered the execution of the 1364 schedule. The value is only present 1365 in an ma-report-result-obj if the 1366 event that triggered the execution of 1367 the schedule has a defined ma-event- 1368 cycle-interval. The cycle number is 1369 represented in the format 1370 YYYYMMDD.HHMMSS where YYYY represents 1371 the year, MM the month (1..12), DD 1372 the day of the months (01..31), HH 1373 the hour (00..23), MM the minute 1374 (00..59), and SS the second (00..59). 1376 ma-report-result-status: The status code returned by the 1377 execution of the action. 1379 ma-report-result-conflicts: A possibly empty set of conflict 1380 actions that might have impacted the 1381 measurement results being reported. 1383 ma-report-result-tables: An optional and possibly empty 1384 unordered set of result tables. 1386 3.6.3. Definition of ma-report-conflict-obj 1388 object { 1389 string ma-report-conflict-schedule-name; 1390 string ma-report-conflict-action-name; 1391 string ma-report-conflict-task-name; 1392 } ma-report-conflict-obj; 1394 The ma-report-conflict-obj provides the information about conflicting 1395 action that might have impacted the measurement results. It consists 1396 of the following elements: 1398 ma-report-result-schedule-name: The name of the schedule that may 1399 have impacted the result. 1401 ma-report-result-action-name: The name of the action in the 1402 schedule that may have impacted the 1403 result. 1405 ma-report-result-task-name: The name of the task that may have 1406 impacted the result. 1408 3.6.4. Definition of ma-report-table-obj 1410 object { 1411 [ma-registry-obj ma-report-table-functions<0..*>;] 1412 [string] ma-report-table-column-labels<0..*>;] 1413 [ma-report-row-obj ma-report-table-rows<0..*>;] 1414 } ma-report-table-obj; 1416 The ma-report-table-obj represents a result table and consists of the 1417 following elements: 1419 ma-report-table-functions: An optional and possibly empty 1420 unordered set of registry entries 1421 identifying the functions for which 1422 results that are reported. 1424 ma-report-table-column-labels: An optional and possibly empty 1425 ordered list of column labels. 1427 ma-report-table-rows: A possibly empty ordered list of 1428 result rows. 1430 3.6.5. Definition of ma-report-row-obj 1432 object { 1433 data ma-report-row-values<0..*>; 1434 } ma-report-row-obj; 1436 The ma-report-row-obj represents a result row and consists of the 1437 following elements: 1439 ma-report-row-values: A possibly empty ordered list of result 1440 values. When present, it contains an 1441 ordered list of values that align to the 1442 set of column labels for the report. 1444 3.7. Common Objects: Schedules 1446 A Schedule specifies the execution of a single or repeated series of 1447 Actions. An Action is a Task with additional specific parameters. 1448 Each Schedule contains basically two elements: an ordered list of 1449 Actions to be executed and an Event object triggering the execution 1450 of the Schedule. The Schedule states what Actions to run (with what 1451 configuration) and when to run the Actions. A Schedule may 1452 optionally have an Event that stops the execution of the Schedule or 1453 a maximum duration after which a schedule is stopped. 1455 Multiple Actions contained as an ordered list of a single Measurement 1456 Schedule will be executed according to the execution mode of the 1457 Schedule. In sequential mode, Actions will be executed sequentially 1458 and in parallel mode, all Actions will be executed concurrently. In 1459 pipelined mode, data produced by one Action is passed to the 1460 subsequent Action. Actions contained in different Schedules execute 1461 in parallel with such conflicts being reported in the Reporting 1462 Information where necessary. If two or more Schedules have the same 1463 start time, then the two will execute in parallel. There is no 1464 mechanism to prioritise one schedule over another or to mutex 1465 scheduled tasks. 1467 As well as specifying which Actions to execute, the Schedule also 1468 specifies how to link the data outputs from each Action to other 1469 Schedules. Specifying this within the Schedule allows the highest 1470 level of flexibility since it is even possible to send the output 1471 from different executions of the same Task Configuration to different 1472 destinations. A single Task producing multiple different outputs is 1473 expected to properly tag the different result. An Action receiving 1474 the output can then filter the results based on the tag if necessary. 1475 For example, a Measurement Task might report routine results to a 1476 data Reporting Task in a Schedule that communicates hourly via the 1477 Broadband PPP interface, but also outputs emergency conditions via an 1478 alarm Reporting Task in a different Schedule communicating 1479 immediately over a GPRS channel. Note that task-to-task data 1480 transfer is always specified in association with the scheduled 1481 execution of the sending task - there is no need for a corresponding 1482 input specification for the receiving task. While it is likely that 1483 an MA implementation will use a queue mechanism between the Schedules 1484 or Actions, this Information Model does not mandate or define a 1485 queue. The Information Model, however, reports the storage allocated 1486 to Schedules and Actions so that storage usage can be monitored. 1487 Furthermore, it is recommended that MA implementations by default 1488 retain old data and stop the execution of new measurement tasks if 1489 the MA runs out of storage capacity. 1491 When specifying the task to execute within the Schedule, i.e., 1492 creating an Action, it is possible to add to the Action option 1493 parameters. This allows the Task Configuration to determine the 1494 common characteristics of a Task, while selected parameters (e.g., 1495 the test target URL) are defined within as option parameters of the 1496 Action in the schedule. A single Tasks Configuration can even be 1497 used multiple times in the same schedule with different additional 1498 parameters. This allows for efficiency in creating and transferring 1499 the Instruction. Note that the semantics of what happens if an 1500 option is defined multiple times (either in the Task Configuration, 1501 Action or in both) is not standardised and will depend upon the Task. 1502 For example, some tasks may legitimately take multiple values for a 1503 single parameter. 1505 Where Options are specified in both the Action and the Task 1506 Configuration, the Action Options are appended to those specified in 1507 the Task Configuration. 1509 Example: An Action of a Schedule references a single Measurement 1510 Task Configuration for measuring UDP latency. It specifies that 1511 results are to be sent to a Schedule with a Reporting Action. 1512 This Reporting Task of the Reporting Action is executed by a 1513 separate Schedule that specifies that it should run hourly at 5 1514 minutes past the hour. When run this Reporting Action takes the 1515 data generated by the UDP latency Measurement Task as well as any 1516 other data to be included in the hourly report and transfers it to 1517 the Collector over the Report Channel specified within its own 1518 Schedule. 1520 Schedules and Actions may optionally also be given tags that are 1521 included in result reports sent to a Collector. In addition, 1522 schedules can be given suppression tags that may be used to select 1523 Schedules and Actions for suppression. 1525 3.7.1. Definition of ma-schedule-obj 1527 object { 1528 string ma-schedule-name; 1529 ma-event-obj ma-schedule-start; 1530 [ma-event-obj ma-schedule-end;] 1531 [int ma-schedule-duration;] 1532 ma-action-obj ma-schedule-actions<0..*>; 1533 string ma-schedule-execution-mode; 1534 [string ma-schedule-tags<0..*>;] 1535 [string ma-schedule-suppression-tags<0..*>;] 1536 } ma-schedule-obj; 1538 The ma-schedule-obj is the main scheduling object. It consists of 1539 the following elements: 1541 ma-schedule-name: A name uniquely identifying a 1542 scheduling object. 1544 ma-schedule-start: An event object indicating when the 1545 schedule starts. 1547 ma-schedule-end: An optional event object controlling 1548 the forceful termination of scheduled 1549 actions. When the event occurs, all 1550 actions of the schedule will be forced 1551 to terminate gracefully. 1553 ma-schedule-duration: An optional duration in seconds for the 1554 schedule. All actions of the schedule 1555 will be forced to terminate gracefully 1556 after the duration number of seconds 1557 past the start of the schedule. 1559 ma-schedule-actions: A possibly empty ordered list of 1560 actions to invoke when the schedule 1561 starts. 1563 ma-schedule-execution-mode: Indicates whether the actions should be 1564 executed sequentially, in parallel, or 1565 in a pipelined mode (where data 1566 produced by one action is passed to the 1567 subsequent action). The default 1568 execution mode is pipelined. 1570 ma-schedule-tags: An optional unordered set of tags that 1571 are reported together with the 1572 measurement results to a collector. 1574 ma-schedule-suppression-tags: An optional unordered set of 1575 suppression tags that are used to 1576 select schedules to be suppressed. 1578 3.7.2. Definition of ma-action-obj 1580 object { 1581 string ma-action-name; 1582 string ma-action-config-task-name; 1583 [ma-option-obj ma-action-task-options<0..*>;] 1584 [string ma-action-destinations<0..*>;] 1585 [string ma-action-tags<0..*>;] 1586 [string ma-action-suppression-tags<0..*>;] 1587 } ma-action-obj; 1589 The ma-action-obj models a task together with its schedule specific 1590 task options and destination schedules. It consists of the following 1591 elements: 1593 ma-action-name: A name uniquely identifying an action 1594 of a scheduling object. 1596 ma-action-config-task-name: A name identifying the configured task 1597 to be invoked by the action. 1599 ma-action-task-options: An optional and possibly empty ordered 1600 list of options (name-value pairs) that 1601 are passed to the task by appending 1602 them to the options configured for the 1603 task object. 1605 ma-action-destinations: An optional and possibly empty 1606 unordered set of names of destination 1607 schedules that consume output produced 1608 by this action. 1610 ma-action-tags: An optional unordered set of tags that 1611 are reported together with the 1612 measurement results to a collector. 1614 ma-action-suppression-tags: An optional unordered set of 1615 suppression tags that are used to 1616 select actions to be suppressed. 1618 3.8. Common Objects: Channels 1620 A Channel defines a bi-directional communication channel between the 1621 MA and a Controller or Collector. Multiple Channels can be defined 1622 to enable results to be split or duplicated across different 1623 Collectors. 1625 Each Channel contains the details of the remote endpoint (including 1626 location and security credential information such as the 1627 certificate). The timing of when to communicate over a Channel is 1628 specified by the Schedule which executes the corresponding Control or 1629 Reporting Task. The certificate can be the digital certificate 1630 associated to the FQDN in the URL or it can be the certificate of the 1631 Certification Authority that was used to issue the certificate for 1632 the FQDN (Fully Qualified Domain Name) of the target URL (which will 1633 be retrieved later on using a communication protocol such as TLS). 1634 In order to establish a secure channel, the MA will use it's own 1635 security credentials (in the Configuration Information) and the given 1636 credentials for the individual Channel end-point. 1638 As with the Task Configurations, each Channel is also given a text 1639 name by which it can be referenced as a Task Option. 1641 Although the same in terms of information, Channels used for 1642 communication with the Controller are referred to as Control Channels 1643 whereas Channels to Collectors are referred to as Report Channels. 1644 Hence Control Channels will be referenced from Control Tasks executed 1645 by a Control Schedule, whereas Report Channels will be referenced 1646 from within Reporting Tasks executed by an Instruction Schedule. 1648 Multiple interfaces are also supported. For example the Reporting 1649 Task could be configured to send some results over GPRS. This is 1650 especially useful when such results indicate the loss of connectivity 1651 on a different network interface. 1653 Example: A Channel used for reporting results may specify that 1654 results are to be sent to the URL (https://collector.example.org/ 1655 report/), using the appropriate digital certificate to establish a 1656 secure channel. 1658 3.8.1. Definition of ma-channel-obj 1660 object { 1661 string ma-channel-name; 1662 url ma-channel-target; 1663 credentials ma-channel-credentials; 1664 [string ma-channel-interface-name;] 1665 } ma-channel-obj; 1667 The ma-channel-obj consists of the following elements: 1669 ma-channel-name: A unique name identifying the channel 1670 object. 1672 ma-channel-target: A URL identifying the target channel 1673 endpoint. 1675 ma-channel-credentials: The security credentials needed to 1676 establish a secure channel. 1678 ma-channel-interface-name: An optional name of the network interface 1679 to be used. If not present, the IP 1680 protocol stack will select a suitable 1681 interface. 1683 3.9. Common Objects: Task Configurations 1685 Conceptually each Task Configuration defines the parameters of a Task 1686 that the Measurement Agent (MA) may perform at some point in time. 1687 It does not by itself actually instruct the MA to perform them at any 1688 particular time (this is done by a Schedule). Tasks can be 1689 Measurement Tasks (i.e., those Tasks actually performing some type of 1690 passive or active measurement) or any other scheduled activity 1691 performed by the MA such as transferring information to or from the 1692 Controller and Collectors. Other examples of Tasks may include data 1693 manipulation or processing Tasks conducted on the MA. 1695 A Measurement Task Configuration is the same in information terms to 1696 any other Task Configuration. Both measurement and non-measurement 1697 Tasks have registry entries to enable the MA to uniquely identify the 1698 Task it should execute and retrieve the schema for any parameters 1699 that may be passed to the Task. Registry entries are specified as a 1700 URI and can therefore be used to identify the Task within a namespace 1701 or point to a web or local file location for the Task information. 1702 As mentioned previously, these URIs may be used to identify the 1703 Measurement Task in a public namespace 1704 [I-D.ietf-ippm-metric-registry]. 1706 Example: A Measurement Task Configuration may configure a single 1707 Measurement Task for measuring UDP latency. The Measurement Task 1708 Configuration could define the destination port and address for 1709 the measurement as well as the duration, internal packet timing 1710 strategy and other parameters (for example a stream for one hour 1711 and sending one packet every 500 ms). It may also define the 1712 output type and possible parameters (for example the output type 1713 can be the 95th percentile mean) where the measurement task 1714 accepts such parameters. It does not define when the task starts 1715 (this is defined by the Schedule element), so it does not by 1716 itself instruct the MA to actually perform this Measurement Task. 1718 The Task Configuration will include a local short name for reference 1719 by a Schedule. Task Configurations may also refer to registry 1720 entries as described above. In addition the Task can be configured 1721 through a set of configuration Options. The nature and number of 1722 these Options will depend upon the Task. These options are expressed 1723 as name-value pairs although the 'value' may be a structured object 1724 instead of a simple string or numeric value. The implementation of 1725 these name-value pairs will vary between data models. 1727 An Option that must be present for Reporting Tasks is the Channel 1728 reference specifying how to communicate with a Collector. This is 1729 included in the task options and will have a value that matches a 1730 channel name that has been defined in the Instruction. Similarly 1731 Control Tasks will have a similar option with the value set to a 1732 specified Control Channel. 1734 A Reporting Task might also have a flag parameter to indicate whether 1735 to send a report without measurement results if there is no 1736 measurement result data pending to be transferred to the Collector. 1738 In addition many tasks will also take as a parameter which interface 1739 to operate over. 1741 In addition the Task Configuration may optionally also be given tags 1742 that can carry a Measurement Cycle ID. The purpose of this ID is to 1743 easily identify a set of measurement results that have been produced 1744 by Measurement Tasks with comparable Options. This ID could be 1745 manually incremented or otherwise changed when an Option change is 1746 implemented which could mean that two sets of results should not be 1747 directly compared. 1749 3.9.1. Definition of ma-task-obj 1751 object { 1752 string ma-task-name; 1753 ma-registry-obj ma-task-functions<0..*>; 1754 [ma-option-obj ma-task-options<0..*>;] 1755 [string ma-task-tags<0..*>;] 1756 } ma-task-obj; 1758 The ma-task-obj defines a configured task that can be invoked as part 1759 of an action. A configured task can be referenced by its name and it 1760 contains a set of URIs to link to registry entries or a local 1761 specification of the task. Options allow the configuration of task 1762 parameters (in the form of name-value pairs). The ma-task-obj 1763 consists of the following elements: 1765 ma-task-name: A name uniquely identifying a configured 1766 task object. 1768 ma-task-functions: A possibly empty unordered set of registry 1769 entries identifying the functions of the 1770 configured task. 1772 ma-task-options: An optional and possibly empty ordered list 1773 of options (name-value pairs) that are 1774 passed to the configured task. 1776 ma-task-tags: An optional unordered set of tags that are 1777 reported together with the measurement 1778 results to a collector. 1780 3.9.2. Definition of ma-option-obj 1782 object { 1783 string ma-option-name; 1784 [object ma-option-value;] 1785 } ma-option-obj; 1787 The ma-option-obj models a name-value pair and consists of the 1788 following elements: 1790 ma-option-name: The name of the option. 1792 ma-option-value: The optional value of the option. 1794 The ma-option-obj is used to define Task Configuration Options. Task 1795 Configuration Options are generally task specific. For tasks 1796 associated with an entry in a registry, the registry may define well- 1797 known option names (e.g., the so-called parameters in the IPPM metric 1798 registry [I-D.ietf-ippm-metric-registry]). Control and Reporting 1799 Tasks need to know the Channel they are going to use. The common 1800 option name for specifying the channel is "channel" where the 1801 option's value refers to the name of an ma-channel-obj. 1803 3.10. Common Objects: Registry Information 1805 Tasks and actions can be associated with entries in a registry. A 1806 registry object refers to an entry in a registry (identified by a 1807 URI) and it may define a set of roles. 1809 3.10.1. Definition of ma-registry-obj 1811 object { 1812 uri ma-registry-uri; 1813 [string ma-registry-role<0..*>;] 1814 } ma-registry-obj; 1816 The ma-registry-obj refers to an entry of a registry and it defines 1817 the associated role(s). The ma-registry-obj consists of the 1818 following elements: 1820 ma-registry-uri: A URI identifying an entry in a registry. 1822 ma-registry-role: An optional and possibly empty unordered 1823 set of roles for the identified registry 1824 entry. 1826 3.11. Common Objects: Event Information 1828 The Event information object used throughout the information models 1829 can initially take one of several different forms. Additional forms 1830 may be defined later in order to bind the execution of schedules to 1831 additional events. The initially defined Event forms are: 1833 1. Periodic Timing: Emits multiple events periodically according to 1834 an interval time defined in seconds 1836 2. Calendar Timing: Emits multiple events according to a calendar 1837 based pattern, e.g., 22 minutes past each hour of the day on 1838 weekdays 1840 3. One Off Timing: Emits one event at a specific date and time 1842 4. Immediate: Emits one event as soon as possible 1844 5. Startup: Emits an event whenever the MA is started (e.g., at 1845 device startup) 1847 6. Controller Lost: Emits an event when connectivity to the 1848 controller has been lost 1850 7. Controller Connected: Emits an event when connectivity to the 1851 controller has been (re-)established 1853 Optionally each of the Event options may also specify a randomness 1854 that should be evaluated and applied separately to each indicated 1855 event. This randomness parameter defines a uniform interval in 1856 seconds over which the start of the task is delayed from the starting 1857 times specified by the event object. 1859 Both the Periodic and Calendar timing objects allow for a series of 1860 Actions to be executed. While both have an optional end time, it is 1861 best practice to always configure an end time and refresh the 1862 information periodically to ensure that lost MAs do not continue 1863 their tasks forever. 1865 Startup events are only created on device startup, not when a new 1866 Instruction is transferred to the MA. If scheduled task execution is 1867 desired both on the transfer of the Instruction and on device restart 1868 then both the Immediate and Startup timing needs to be used in 1869 conjunction. 1871 The datetime format used for all elements in the information model 1872 MUST conform to RFC 3339 [RFC3339]. 1874 3.11.1. Definition of ma-event-obj 1875 object { 1876 string ma-event-name; 1877 union { 1878 ma-periodic-obj ma-event-periodic; 1879 ma-calendar-obj ma-event-calendar; 1880 ma-one-off-obj ma-event-one-off; 1881 ma-immediate-obj ma-event-immediate; 1882 ma-startup-obj ma-event-startup; 1883 ma-controller-lost-obj ma-event-controller-lost; 1884 ma-controller-connected-obj ma-event-controller-connected; 1885 } 1886 [int ma-event-random-spread;] 1887 [int ma-event-cycle-interval;] 1888 } ma-event-obj; 1890 The ma-event-obj is the main event object. Event objects are 1891 identified by a name. A generic event object itself contains a more 1892 specific event object. The set of specific event objects should be 1893 extensible. The initial set of specific event objects is further 1894 described below. The ma-event-obj also includes an optional uniform 1895 random spread that can be used to randomize the start times of 1896 schedules triggered by an event. The ma-event-obj consists of the 1897 following elements: 1899 ma-event-name: The name uniquely identifies an event 1900 object. Schedules refer to event 1901 objects by this name. 1903 ma-event-periodic: The ma-event-periodic is present for 1904 periodic timing objects. 1906 ma-event-calendar: The ma-event-calendar is present for 1907 calendar timing objects. 1909 ma-event-one-off: The ma-event-one-off is present for 1910 one-off timing objects. 1912 ma-event-immediate: The ma-event-immediate is present for 1913 immediate event objects. 1915 ma-event-startup: The ma-event-startup is present for 1916 startup event objects. 1918 ma-event-controller-lost: The ma-event-controller-lost is 1919 present for connectivity to 1920 controller lost event objects. 1922 ma-event-controller-connected: The ma-event-controller-connected is 1923 present for connectivity to a 1924 controller established event objects. 1926 ma-event-random-spread: The optional ma-event-random-spread 1927 adds a random delay defined in 1928 seconds to the event object. No 1929 random delay is added if ma-event- 1930 random-spread does not exist. 1932 ma-event-cycle-interval: The optional ma-event-cycle-interval 1933 defines the duration of the time 1934 interval in seconds that is used to 1935 calculate cycle numbers. No cycle 1936 number is calculated if ma-event- 1937 cycle-interval does not exist. 1939 3.11.2. Definition of ma-periodic-obj 1941 object { 1942 [datetime ma-periodic-start;] 1943 [datetime ma-periodic-end;] 1944 int ma-periodic-interval; 1945 } ma-periodic-obj; 1947 The ma-periodic-obj timing object has an optional start and an 1948 optional end time plus a periodic interval. Schedules using an ma- 1949 periodic-obj are started periodically between the start and end time. 1950 The ma-periodic-obj consists of the following elements: 1952 ma-periodic-start: The optional date and time at which 1953 Schedules using this object are first 1954 started. If not present it defaults to 1955 immediate. 1957 ma-periodic-end: The optional date and time at which 1958 Schedules using this object are last 1959 started. If not present it defaults to 1960 indefinite. 1962 ma-periodic-interval: The interval defines the time in seconds 1963 between two consecutive starts of tasks. 1965 3.11.3. Definition of ma-calendar-obj 1967 Calendar Timing supports the routine execution of Schedules at 1968 specific times and/or on specific dates. It can support more 1969 flexible timing than Periodic Timing since the execution of Schedules 1970 does not have to be uniformly spaced. For example a Calendar Timing 1971 could support the execution of a Measurement Task every hour between 1972 6pm and midnight on weekdays only. 1974 Calendar Timing is also required to perform measurements at 1975 meaningful times in relation to network usage (e.g., at peak times). 1976 If the optional timezone offset is not supplied then local system 1977 time is assumed. This is essential in some use cases to ensure 1978 consistent peak-time measurements as well as supporting MA devices 1979 that may be in an unknown timezone or roam between different 1980 timezones (but know their own timezone information such as through 1981 the mobile network). 1983 The calendar elements within the Calendar Timing do not have defaults 1984 in order to avoid accidental high-frequency execution of Tasks. If 1985 all possible values for an element are desired then the wildcard * is 1986 used. 1988 object { 1989 [datetime ma-calendar-start;] 1990 [datetime ma-calendar-end;] 1991 [string ma-calendar-months<0..*>;] 1992 [string ma-calendar-days-of-week<0..*>;] 1993 [string ma-calendar-days-of-month<0..*>;] 1994 [string ma-calendar-hours<0..*>;] 1995 [string ma-calendar-minutes<0..*>;] 1996 [string ma-calendar-seconds<0..*>;] 1997 [int ma-calendar-timezone-offset;] 1998 } ma-calendar-obj; 2000 ma-calendar-start: The optional date and time at which 2001 Schedules using this object are first 2002 started. If not present it defaults to 2003 immediate. 2005 ma-calendar-end: The optional date and time at which 2006 Schedules using this object are last 2007 started. If not present it defaults to 2008 indefinite. 2010 ma-calendar-months: The optional set of months (1-12) on 2011 which tasks scheduled using this object 2012 are started. The wildcard * means all 2013 months. If not present, it defaults to 2014 no months. 2016 ma-calendar-days-of-week: The optional set of days of a week 2017 ("Mon", "Tue", "Wed", "Thu", "Fri", 2018 "Sat", "Sun") on which tasks scheduled 2019 using this object are started. The 2020 wildcard * means all days of the week. 2021 If not present, it defaults to no days. 2023 ma-calendar-days-of-month: The optional set of days of a months 2024 (1-31) on which tasks scheduled using 2025 this object are started. The wildcard 2026 * means all days of a months. If not 2027 present, it defaults to no days. 2029 ma-calendar-hours: The optional set of hours (0-23) on 2030 which tasks scheduled using this object 2031 are started. The wildcard * means all 2032 hours of a day. If not present, it 2033 defaults to no hours. 2035 ma-calendar-minutes: The optional set of minutes (0-59) on 2036 which tasks scheduled using this object 2037 are started. The wildcard * means all 2038 minutes of an hour. If not present, it 2039 defaults to no hours. 2041 ma-calendar-seconds: The optional set of seconds (0-59) on 2042 which tasks scheduled using this object 2043 are started. The wildcard * means all 2044 seconds of an hour. If not present, it 2045 defaults to no seconds. 2047 ma-calendar-timezone-offset: The optional timezone offest in hours. 2048 If not present, it defaults to the 2049 system's local timezone. 2051 If a day of the month is specified that does not exist in the month 2052 (e.g., 29th of Feburary) then those values are ignored. 2054 3.11.4. Definition of ma-one-off-obj 2056 object { 2057 datetime ma-one-off-time; 2058 } ma-one-off-obj; 2060 The ma-one-off-obj timing object specifies a fixed point in time. 2061 Schedules using an ma-one-off-obj are started once at the specified 2062 date and time. The ma-one-off-obj consists of the following 2063 elements: 2065 ma-one-off-time: The date and time at which Schedules using 2066 this object are started. 2068 3.11.5. Definition of ma-immediate-obj 2070 object { 2071 // empty 2072 } ma-immediate-obj; 2074 The ma-immediate-obj event object has no further information 2075 elements. Schedules using an ma-immediate-obj are started as soon as 2076 possible. 2078 3.11.6. Definition of ma-startup-obj 2080 object { 2081 // empty 2082 } ma-startup-obj; 2084 The ma-startup-obj event object has no further information elements. 2085 Schedules or suppressions using an ma-startup-obj are started at MA 2086 initialization time. 2088 3.11.7. Definition of ma-controller-lost-obj 2090 object { 2091 // empty 2092 } ma-controller-lost-obj; 2094 The ma-controller-lost-obj event object has no further information 2095 elements. The ma-controller-lost-obj indicates that connectivity to 2096 the controller has been lost. This is determined by a timer started 2097 after each successful contact with a controller. When the timer 2098 reaches the controller-timeout (measured in seconds), an ma- 2099 controller-lost-obj event is generated. This event may be used to 2100 start a suppression. 2102 3.11.8. Definition of ma-controller-connected-obj 2104 object { 2105 // empty 2106 } ma-controller-connected-obj; 2108 The ma-controller-connected-obj event object has no further 2109 information elements. The ma-controller-connected-obj indicates that 2110 connectivity to the controller has been established again after it 2111 was lost. This event may be used to end a suppression. 2113 4. Example Execution 2115 The example execution has two event sources E1 and E2 and three 2116 schedules S1, S2, and S3. The schedule S3 is started by events of 2117 event source E2 while the schedules S1 and S2 are both started by 2118 events of the event source E1. The schedules S1 and S2 have two 2119 actions each and schedule S3 has a single action. The event source 2120 E2 has no randomization while the event source E1 has the 2121 randomization r. 2123 Figure 2 shows a possible timeline of an execution. The time T is 2124 progressing downwards. The dotted vertial line indicates progress of 2125 time while a dotted horizontal line indicates which schedule are 2126 triggered by an event. Tilded lines indicate data flowing from an 2127 action to another schedule. Actions within a schedule are named A1, 2128 A2, etc. 2130 E2 E1 T S1 S2 S3 2131 sequential parallel pipelined 2132 : 2133 e0 + 2134 : 2135 : 2136 e0+r + .......... + .......... ++ 2137 : | A1 A1 || A2 2138 : + |+ ~~~~~~~> 2139 : | A2 | 2140 : | + ~~~~~~~~> 2141 : + ~~~~~~~~~~~~~~~~~~~~~> 2142 : 2143 : 2144 e1 + 2145 : 2146 e1+r + .......... + .......... ++ 2147 : | A1 A1 || 2148 : | +|~~~~~~~> 2149 : | | A2 2150 : + +~~~~~~~> 2151 : | A2 2152 : + ~~~~~~~~~~~~~~~~~~~~> 2153 e0 + ................................... + 2154 : | A1 2155 e3 + | 2156 e3+r + .......... + .......... ++ | 2157 : | A1 A1 || A2 | 2158 : + ++ ~~~~~~> | 2159 : | A2 + 2160 : + ~~~~~~~~~~~~~~~~~~~~> 2161 V 2163 Figure 2: Example Execution 2165 Note that implementations must handle possible concurrency issues. 2166 In the example execution, action A1 of schedule S3 is consuming the 2167 data that has been forwarded to schedule S3 while additional data is 2168 arriving from action A2 of schedule S2. 2170 5. IANA Considerations 2172 This document makes no request of IANA. 2174 Note to the RFC Editor: this section may be removed on publication as 2175 an RFC. 2177 6. Security Considerations 2179 This Information Model deals with information about the control and 2180 reporting of the Measurement Agent. There are broadly two security 2181 considerations for such an Information Model. Firstly the 2182 Information Model has to be sufficient to establish secure 2183 communication channels to the Controller and Collector such that 2184 other information can be sent and received securely. Additionally, 2185 any mechanisms that the Network Operator or other device 2186 administrator employs to pre-configure the MA must also be secure to 2187 protect unauthorized parties from modifying pre-configuration 2188 information. These mechanisms are important to ensure that the MA 2189 cannot be hijacked, for example to participate in a distributed 2190 denial of service attack. 2192 The second consideration is that no mandated information items should 2193 pose a risk to confidentiality or privacy given such secure 2194 communication channels. For this latter reason items such as the MA 2195 context and MA ID are left optional and can be excluded from some 2196 deployments. This would, for example, allow the MA to remain 2197 anonymous and for information about location or other context that 2198 might be used to identify or track the MA to be omitted or blurred. 2200 The Information Model should support wherever relevant, all the 2201 security and privacy requirements associated with the LMAP Framework. 2203 7. Acknowledgements 2205 Several people contributed to this specification by reviewing early 2206 versions and actively participating in the LMAP working group 2207 (apologies to those unintentionally omitted): Vaibhav Bajpai, Timothy 2208 Carey, Al Morton, Dan Romascanu, Andrea Soppera, and Barbara Stark. 2209 (XXX: complete this list) 2211 Philip Eardley, Trevor Burbridge, Marcelo Bagnulo and Juergen 2212 Schoenwaelder worked in part on the Leone research project, which 2213 received funding from the European Union Seventh Framework Programme 2214 [FP7/2007-2013] under grant agreement number 317647. 2216 Juergen Schoenwaelder was partly funded by Flamingo, a Network of 2217 Excellence project (ICT-318488) supported by the European Commission 2218 under its Seventh Framework Programme. 2220 8. References 2221 8.1. Normative References 2223 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2224 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 2225 RFC2119, March 1997, 2226 . 2228 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2229 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2230 . 2232 [RFC7594] Eardley, P., Morton, A., Bagnulo, M., Burbridge, T., 2233 Aitken, P., and A. Akhter, "A Framework for Large-Scale 2234 Measurement of Broadband Performance (LMAP)", RFC 7594, 2235 DOI 10.17487/RFC7594, September 2015, 2236 . 2238 8.2. Informative References 2240 [I-D.ietf-ippm-metric-registry] 2241 Bagnulo, M., Claise, B., Eardley, P., Morton, A., and A. 2242 Akhter, "Registry for Performance Metrics", draft-ietf- 2243 ippm-metric-registry-07 (work in progress), July 2016. 2245 [I-D.ietf-lmap-yang] 2246 Schoenwaelder, J. and V. Bajpai, "A YANG Data Model for 2247 LMAP Measurement Agents", draft-ietf-lmap-yang-05 (work in 2248 progress), July 2016. 2250 [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between 2251 Information Models and Data Models", RFC 3444, DOI 10 2252 .17487/RFC3444, January 2003, 2253 . 2255 [RFC7398] Bagnulo, M., Burbridge, T., Crawford, S., Eardley, P., and 2256 A. Morton, "A Reference Path and Measurement Points for 2257 Large-Scale Measurement of Broadband Performance", RFC 2258 7398, DOI 10.17487/RFC7398, February 2015, 2259 . 2261 Appendix A. Open Issues 2263 Note to the RFC Editor: this section should be removed on publication 2264 as an RFC. 2266 A.1. Configuration of the device-id 2268 Is it the job of the LMAP information model to configure a device-id? 2269 If not, remove ma-preconfig-device-id from ma-preconfig-obj and ma- 2270 config-device-id from ma-config-obj. 2272 A.2. Reporting of agent-id and group-id 2274 The description of ma-config-report-agent-id is not consistent with 2275 some other text where it is stated that setting ma-config-report- 2276 agent-id to false will have no effect if the group-id is not set. 2277 This behavior is somewhat surprising; it seems simpler to have two 2278 controls, namely ma-config-report-agent-id and ma-config-report- 2279 group-id, each independently controlling whether the agent-id or the 2280 group-id is contained in reports. 2282 Appendix B. Change History 2284 Note to the RFC Editor: this section should be removed on publication 2285 as an RFC. 2287 B.1. Non-editorial changes since -12 2289 o Renamed the ma-metrics-registry-obj to ma-registry-obj since tasks 2290 may refer to different registries (not just a metrics registry). 2292 o Clarifications and bug fixes. 2294 B.2. Non-editorial changes since -11 2296 o Clarifications and bug fixes. 2298 B.3. Non-editorial changes since -10 2300 o Rewrote the text concerning the well-known "channel" option name. 2302 o Added ma-report-result-event-time, ma-report-result-cycle-number, 2303 and ma-event-cycle-interval. 2305 o Added ma-capability-tags. 2307 o Added a new section showing an example execution. 2309 o Several clarifications and bug fixes. 2311 B.4. Non-editorial changes since -09 2313 o Added ma-status-schedule-storage and ma-status-action-storage. 2315 o Removed suppress-by-default. 2317 o Moved ma-report-result-metrics of the ma-report-result-obj to ma- 2318 report-table-metrics of the ma-report-table-obj so that the 2319 relationship between metrics and result tables is clear. 2321 o Added ma-report-conflict-obj. 2323 o Added ma-report-result-status to ma-report-result-obj. 2325 o Several clarifications and bug fixes. 2327 B.5. Non-editorial changes since -08 2329 o Refactored the ma-report-task-obj into the ma-report-result-obj. 2331 o Introduced the ma-report-table-obj so that a result can contain 2332 multiple tables. 2334 o Report schedule, action, and task name as part of the ma-report- 2335 result-obj. 2337 o Report conflicts per ma-report-result-obj and not per ma-report- 2338 row-obj. 2340 o Report the start/end time as part of the ma-report-result-obj. 2342 B.6. Non-editorial changes since -07 2344 o Added ma-schedule-end and ma-schedule-duration. 2346 o Changed the granularity of scheduler timings to seconds. 2348 o Added ma-status-suppression-obj to report the status of 2349 suppressions as done in the YANG data model. 2351 o Added counters to schedule and action status objects to match the 2352 counters in the YANG data model. 2354 o Using tags to pass information such as a measurement cycle 2355 identifier to the collector. 2357 o Using suppression tags and glob-style matching to select schedules 2358 and actions to be suppressed. 2360 B.7. Non-editorial changes since -06 2362 o The default execution mode is pipelined (LI12) 2364 o Added text to define which action consumes data in sequential, 2365 pipelines, and parallel execution mode (LI11) 2367 o Added ma-config-measurement-point, ma-report-measurement-point, 2368 and ma-config-report-measurement-point to configure and report the 2369 measurement point (LI10) 2371 o Turned ma-suppression-obj into a list that uses a start event and 2372 a stop event to define the start and end of suppression; this 2373 unifies the handling of suppression and loss of controller 2374 connectivity (LI09) 2376 o Added ma-controller-lost-obj and ma-controller-ok-obj event 2377 objects (LI09) 2379 o Added ma-status-schedule-obj to report the status of a schedule 2380 and refactored ma-task-status-obj into ma-status-action-obj to 2381 report the status of an action (LI07, LI08) 2383 o Introduced a common ma-metric-registry-obj that identifies a 2384 metric and a set of associated roles and added this object to 2385 expose metric capabilities and to support the configuration of 2386 metrics and to report the metrics used (LI06) 2388 o Introduced ma-capability-obj and ma-capability-task-obj to expose 2389 the capabilities of a measurement agent (LI05) 2391 o Use 'ordered list' or 'unordered set' instead of list, collection, 2392 etc. (LI02) 2394 o Clarification that Actions are part of a Schedule (LI03) 2396 o Deleted terms that are not strictly needed (LI04) 2398 B.8. Non-editorial changes since -05 2400 o A task can now reference multiply registry entries. 2402 o Consistent usage of the term Action and Task. 2404 o Schedules are triggered by Events instead of Timings; Timings are 2405 just one of many possible event sources. 2407 o Actions feed into other Schedules (instead of Actions within other 2408 Schedules). 2410 o Removed the notion of multiple task outputs. 2412 o Support for sequential, parallel, and pipelined execution of 2413 Actions. 2415 Authors' Addresses 2417 Trevor Burbridge 2418 BT 2419 Adastral Park, Martlesham Heath 2420 Ipswich IP5 3RE 2421 United Kingdom 2423 Email: trevor.burbridge@bt.com 2425 Philip Eardley 2426 BT 2427 Adastral Park, Martlesham Heath 2428 Ipswich IP5 3RE 2429 United Kingdom 2431 Email: philip.eardley@bt.com 2433 Marcelo Bagnulo 2434 Universidad Carlos III de Madrid 2435 Av. Universidad 30 2436 Leganes, Madrid 28911 2437 Spain 2439 Email: marcelo@it.uc3m.es 2441 Juergen Schoenwaelder 2442 Jacobs University Bremen 2443 Campus Ring 1 2444 Bremen 28759 2445 Germany 2447 Email: j.schoenwaelder@jacobs-university.de