draft-ietf-lmap-information-model-05.txt   draft-ietf-lmap-information-model-06.txt 
Network Working Group T. Burbridge Network Working Group T. Burbridge
Internet-Draft P. Eardley Internet-Draft P. Eardley
Intended status: Standards Track BT Intended status: Standards Track BT
Expires: October 12, 2015 M. Bagnulo Expires: January 4, 2016 M. Bagnulo
Universidad Carlos III de Madrid Universidad Carlos III de Madrid
J. Schoenwaelder J. Schoenwaelder
Jacobs University Bremen Jacobs University Bremen
April 10, 2015 July 3, 2015
Information Model for Large-Scale Measurement Platforms (LMAP) Information Model for Large-Scale Measurement Platforms (LMAP)
draft-ietf-lmap-information-model-05 draft-ietf-lmap-information-model-06
Abstract Abstract
This Information Model applies to the Measurement Agent within a This Information Model applies to the Measurement Agent within a
Large-Scale Measurement Platform. As such it outlines the Large-Scale Measurement Platform. As such it outlines the
information that is (pre-)configured on the MA or exists in information that is (pre-)configured on the MA or exists in
communications with a Controller or Collector within an LMAP communications with a Controller or Collector within an LMAP
framework. The purpose of such an Information Model is to provide a framework. The purpose of such an Information Model is to provide a
protocol and device independent view of the MA that can be protocol and device independent view of the MA that can be
implemented via one or more Control and Report protocols. implemented via one or more Control and Report protocols.
skipping to change at page 1, line 46 skipping to change at page 1, line 46
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on October 12, 2015. This Internet-Draft will expire on January 4, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 27 skipping to change at page 2, line 27
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Notation . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Notation . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. LMAP Information Model . . . . . . . . . . . . . . . . . . . 4 3. LMAP Information Model . . . . . . . . . . . . . . . . . . . 4
3.1. Pre-Configuration Information . . . . . . . . . . . . . . 8 3.1. Pre-Configuration Information . . . . . . . . . . . . . . 8
3.1.1. Definition of ma-preconfig-obj . . . . . . . . . . . 9 3.1.1. Definition of ma-preconfig-obj . . . . . . . . . . . 9
3.2. Configuration Information . . . . . . . . . . . . . . . . 9 3.2. Configuration Information . . . . . . . . . . . . . . . . 10
3.2.1. Definition of ma-config-obj . . . . . . . . . . . . . 11 3.2.1. Definition of ma-config-obj . . . . . . . . . . . . . 11
3.3. Instruction Information . . . . . . . . . . . . . . . . . 12 3.3. Instruction Information . . . . . . . . . . . . . . . . . 12
3.3.1. Definition of ma-instruction-obj . . . . . . . . . . 14 3.3.1. Definition of ma-instruction-obj . . . . . . . . . . 14
3.3.2. Definition of ma-suppression-obj . . . . . . . . . . 14 3.3.2. Definition of ma-suppression-obj . . . . . . . . . . 15
3.4. Logging Information . . . . . . . . . . . . . . . . . . . 15 3.4. Logging Information . . . . . . . . . . . . . . . . . . . 16
3.4.1. Definition of ma-log-obj . . . . . . . . . . . . . . 17 3.4.1. Definition of ma-log-obj . . . . . . . . . . . . . . 17
3.5. Capability and Status Information . . . . . . . . . . . . 17 3.5. Capability and Status Information . . . . . . . . . . . . 17
3.5.1. Definition of ma-status-obj . . . . . . . . . . . . . 17 3.5.1. Definition of ma-status-obj . . . . . . . . . . . . . 18
3.5.2. Definition of ma-task-status-obj . . . . . . . . . . 18 3.5.2. Definition of ma-task-status-obj . . . . . . . . . . 18
3.5.3. Definition of ma-interface-obj . . . . . . . . . . . 19 3.5.3. Definition of ma-interface-obj . . . . . . . . . . . 19
3.6. Reporting Information . . . . . . . . . . . . . . . . . . 20 3.6. Reporting Information . . . . . . . . . . . . . . . . . . 20
3.6.1. Definition of ma-report-obj . . . . . . . . . . . . . 21 3.6.1. Definition of ma-report-obj . . . . . . . . . . . . . 22
3.6.2. Definition of ma-report-task-obj . . . . . . . . . . 22 3.6.2. Definition of ma-report-task-obj . . . . . . . . . . 23
3.6.3. Definition of ma-report-row-obj . . . . . . . . . . . 23 3.6.3. Definition of ma-report-row-obj . . . . . . . . . . . 23
3.7. Common Objects: Schedules . . . . . . . . . . . . . . . . 23 3.7. Common Objects: Schedules . . . . . . . . . . . . . . . . 24
3.7.1. Definition of ma-schedule-obj . . . . . . . . . . . . 25 3.7.1. Definition of ma-schedule-obj . . . . . . . . . . . . 25
3.7.2. Definition of ma-action-obj . . . . . . . . . . . . . 25 3.7.2. Definition of ma-action-obj . . . . . . . . . . . . . 26
3.7.3. Definition of ma-action-dest-obj . . . . . . . . . . 26 3.8. Common Objects: Channels . . . . . . . . . . . . . . . . 27
3.8. Common Objects: Channels . . . . . . . . . . . . . . . . 26 3.8.1. Definition of ma-channel-obj . . . . . . . . . . . . 28
3.8.1. Definition of ma-channel-obj . . . . . . . . . . . . 27
3.9. Common Objects: Task Configurations . . . . . . . . . . . 28 3.9. Common Objects: Task Configurations . . . . . . . . . . . 28
3.9.1. Definition of ma-task-obj . . . . . . . . . . . . . . 29 3.9.1. Definition of ma-task-obj . . . . . . . . . . . . . . 30
3.9.2. Definition of ma-option-obj . . . . . . . . . . . . . 30 3.9.2. Definition of ma-option-obj . . . . . . . . . . . . . 30
3.10. Common Objects: Timing Information . . . . . . . . . . . 30 3.10. Common Objects: Event Information . . . . . . . . . . . . 31
3.10.1. Definition of ma-timing-obj . . . . . . . . . . . . 31 3.10.1. Definition of ma-event-obj . . . . . . . . . . . . . 32
3.10.2. Definition of ma-periodic-obj . . . . . . . . . . . 32 3.10.2. Definition of ma-periodic-obj . . . . . . . . . . . 33
3.10.3. Definition of ma-calendar-obj . . . . . . . . . . . 33 3.10.3. Definition of ma-calendar-obj . . . . . . . . . . . 33
3.10.4. Definition of ma-one-off-obj . . . . . . . . . . . . 35 3.10.4. Definition of ma-one-off-obj . . . . . . . . . . . . 35
3.10.5. Definition of ma-immediate-obj . . . . . . . . . . . 35 3.10.5. Definition of ma-immediate-obj . . . . . . . . . . . 35
3.10.6. Definition of ma-startup-obj . . . . . . . . . . . . 35 3.10.6. Definition of ma-startup-obj . . . . . . . . . . . . 36
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 35 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 36
5. Security Considerations . . . . . . . . . . . . . . . . . . . 36 5. Security Considerations . . . . . . . . . . . . . . . . . . . 36
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 36 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 37
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 36 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 37
7.1. Normative References . . . . . . . . . . . . . . . . . . 36 7.1. Normative References . . . . . . . . . . . . . . . . . . 37
7.2. Informative References . . . . . . . . . . . . . . . . . 37 7.2. Informative References . . . . . . . . . . . . . . . . . 37
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 37 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 37
Appendix B. Non-editorial Changes since -05 . . . . . . . . . . 38
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 38
1. Introduction 1. Introduction
A large-scale measurement platform is a collection of components that A large-scale measurement platform is a collection of components that
work in a coordinated fashion to perform measurements from a large work in a coordinated fashion to perform measurements from a large
number of vantage points. The main components of a large-scale number of vantage points. The main components of a large-scale
measurement platform are the Measurement Agents (hereafter MAs), the measurement platform are the Measurement Agents (hereafter MAs), the
Controller(s) and the Collector(s). Controller(s) and the Collector(s).
The MAs are the elements actually performing the measurements. The The MAs are the elements actually performing the measurements. The
skipping to change at page 4, line 5 skipping to change at page 4, line 5
the MAs and Measurement Peers (MPs), used to actually perform the the MAs and Measurement Peers (MPs), used to actually perform the
measurements. In addition some information is required to be measurements. In addition some information is required to be
configured on the MA prior to any communication with a Controller. configured on the MA prior to any communication with a Controller.
This document defines the information model for both Control and the This document defines the information model for both Control and the
Report protocols along with pre-configuration information that is Report protocols along with pre-configuration information that is
required on the MA before communicating with the Controller, broadly required on the MA before communicating with the Controller, broadly
named as the LMAP Information Model. The measurement protocols are named as the LMAP Information Model. The measurement protocols are
out of the scope of this document. out of the scope of this document.
As defined in [RFC3444], the LMAP Information Model (henceforth also As defined in [RFC3444], the LMAP Information Model defines the
referred to as LMAP IM) defines the concepts involved in a large- concepts involved in a large-scale measurement platform at a high
scale measurement platform at a high level of abstraction, level of abstraction, independent of any specific implementation or
independent of any specific implementation or actual protocol used to actual protocol used to exchange the information. It is expected
exchange the information. It is expected that the proposed that the proposed information model can be used with different
information model can be used with different protocols in different protocols in different measurement platform architectures and across
measurement platform architectures and across different types of MA different types of MA devices (e.g., home gateway, smartphone, PC,
devices (e.g., home gateway, smartphone, PC, router). router). A YANG data model implementing the information model can be
found in [I-D.ietf-lmap-yang].
The definition of an Information Model serves a number of purposes: The definition of an Information Model serves a number of purposes:
1. To guide the standardisation of one or more Control and Report 1. To guide the standardisation of one or more Control and Report
protocols and data models protocols and data models
2. To enable high-level inter-operability between different Control 2. To enable high-level inter-operability between different Control
and Report protocols by facilitating translation between their and Report protocols by facilitating translation between their
respective data models such that a Controller could instruct sub- respective data models such that a Controller could instruct sub-
populations of MAs using different protocols populations of MAs using different protocols
3. To form agreement of what information needs to be held by an MA 3. To form agreement of what information needs to be held by an MA
and passed over the Control and Report interfaces and support the and passed over the Control and Report interfaces and support the
functionality described in the LMAP framework functionality described in the LMAP framework
4. Enable existing protocols and data models to be assessed for 4. Enable existing protocols and data models to be assessed for
their suitability as part of a large-scale measurement system their suitability as part of a large-scale measurement system
2. Notation 2. Notation
This document use an object-oriented programming-like notation to This document uses a programming language-like notation to define the
define the parameters (names/values) of the objects of the properties of the objects of the information model. An optional
information model. An optional field is enclosed by [ ], and an property is enclosed by square brackets, [ ], and a list property is
array is indicated by two numbers in angle brackets, <m..n>, where m indicated by two numbers in angle brackets, <m..n>, where m indicates
indicates the minimal number of values, and n is the maximum. The the minimal number of values, and n is the maximum. The symbol * for
symbol * for n means no upper bound. n means no upper bound.
3. LMAP Information Model 3. LMAP Information Model
The information described herein relates to the information stored, The information described herein relates to the information stored,
received or transmitted by a Measurement Agent as described within received or transmitted by a Measurement Agent as described within
the LMAP framework [I-D.ietf-lmap-framework]. As such, some subsets the LMAP framework [I-D.ietf-lmap-framework]. As such, some subsets
of this information model are applicable to the measurement of this information model are applicable to the measurement
Controller, Collector and any device management system that pre- Controller, Collector and any device management system that pre-
configures the Measurement Agent. The information described in these configures the Measurement Agent. The information described in these
models will be transmitted by protocols using interfaces between the models will be transmitted by protocols using interfaces between the
skipping to change at page 6, line 48 skipping to change at page 6, line 48
communicate with the Controller. communicate with the Controller.
2. Channels. A set of Channel objects are used to communicate with 2. Channels. A set of Channel objects are used to communicate with
a number of endpoints (i.e., the Controller and Collectors). a number of endpoints (i.e., the Controller and Collectors).
Each Channel object contains the information required for the Each Channel object contains the information required for the
communication with a single endpoint such as the target location communication with a single endpoint such as the target location
and security details. and security details.
3. Task Configurations. A set of Task Configurations is used to 3. Task Configurations. A set of Task Configurations is used to
configure the Tasks that are run by the MA. This includes the configure the Tasks that are run by the MA. This includes the
registry entry for the Task and any configuration parameters. registry entries for the Task and any configuration parameters.
Task Configurations are referenced from a Schedule in order to Task Configurations are referenced from a Schedule in order to
specify what Tasks the MA should execute. specify what Tasks the MA should execute.
4. Timings. A set of Timing objects that can be referenced from the 4. Events. A set of Event objects that can be referenced from the
Schedules. Each Schedule always references exactly one Timing Schedules. Each Schedule always references exactly one Event
object. A Timing object specifies either a singleton or series object. An Event object specifies either a singleton or series
of time events. They are used to indicate when Tasks should be of events that indicate when Tasks should be executed. A
executed. commonly used kind of Event objects are Timing objects.
The following diagram illustrates the structure in which these common Figure 1 illustrates the structure in which these common information
information objects are referenced. The references are achieved by objects are referenced. The references are achieved by each object
each object (Task Configuration, Timing) being given a short text (Task Configuration, Event) being given a short textual name that is
name that is used by other objects. The objects shown in parenthesis used by other objects. The objects shown in parenthesis are part of
are part of the internal object structure of a Schedule. Channels the internal object structure of a Schedule. Channels are not shown
are not shown in the diagram since they are only used as an option by in the diagram since they are only used as an option by selected Task
selected Task Configurations but are similarly referenced using a Configurations but are similarly referenced using a short text name.
short text name.
Schedule Schedule
|----------> Timing |------> Event
|----------> (Scheduled Tasks) |------> Action 1
|----------> Task Configuration | |------> Task Configuration
|----------> Destination Tasks | `------> Destination Schedule
:
:
`------> Action N
|------> Task Configuration
`------> Destination Schedule
Figure 1: Relationship between Schedules, Events, Actions, Task
Configurations, and Destination Schedules
It should be clear that the top-level behavior of an MA is simply to It should be clear that the top-level behavior of an MA is simply to
execute Schedules. Every action referenced by a Schedule is defined execute Schedules. Every Action referenced by a Schedule is defined
as a Task. As such, these actions are configured through Task as a Task. As such, these Actions are configured through Task
Configurations and executed according to the Timing referenced by the Configurations and executed according to the Event object referenced
Schedule in which they appear. Tasks can implement a variety of by the Schedule in which they appear. Note, however, that Actions
different types of actions. While in terms of the Information Model, can have Action specific parameters.
all Tasks have the same structure, it can help conceptually to think
of different Task categories: Tasks can implement a variety of different types of actions. While
in terms of the Information Model, all Tasks have the same structure,
it can help conceptually to think of different Task categories:
1. Measurement Tasks measure some aspect of network performance or 1. Measurement Tasks measure some aspect of network performance or
traffic. They may also capture contextual information from the traffic. They may also capture contextual information from the
MA device or network interfaces such as the device type or MA device or network interfaces such as the device type or
interface speed. interface speed.
2. Data Transfer Tasks 2. Data Transfer Tasks
A. Reporting Tasks report the results of Measurement Tasks to A. Reporting Tasks report the results of Measurement Tasks to
Collectors Collectors
skipping to change at page 8, line 8 skipping to change at page 8, line 17
Protocol there may be a number of specialist tasks such as: Protocol there may be a number of specialist tasks such as:
Configuration Task; Instruction Task; Suppression Task; Configuration Task; Instruction Task; Suppression Task;
Capabilities Task; Logging Task etc. Capabilities Task; Logging Task etc.
3. Data Analysis Tasks can exist to analyse data from other 3. Data Analysis Tasks can exist to analyse data from other
Measurement Tasks locally on the MA Measurement Tasks locally on the MA
4. Data Management Tasks may exist to clean-up, filter or compress 4. Data Management Tasks may exist to clean-up, filter or compress
data on the MA such as Measurement Task results data on the MA such as Measurement Task results
Figure 1 indicates that Actions can produce data that is fed into
Destination Schedules. This can by used by Actions implementing
Measurement Tasks to feed measurement results to a Schedule that
triggers Actions implementing Reporting Tasks.
3.1. Pre-Configuration Information 3.1. Pre-Configuration Information
This information is the minimal information that needs to be pre- This information is the minimal information that needs to be pre-
configured to the MA in order for it to successfully communicate with configured to the MA in order for it to successfully communicate with
a Controller during the registration process. Some of the Pre- a Controller during the registration process. Some of the Pre-
Configuration Information elements are repeated in the Configuration Configuration Information elements are repeated in the Configuration
Information in order to allow an LMAP Controller to update these Information in order to allow an LMAP Controller to update these
items. The pre-configuration information also contains some elements items. The pre-configuration information also contains some elements
that are not under the control of the LMAP framework (such as the that are not under the control of the LMAP framework (such as the
device identifier and device security credentials). device identifier and device security credentials).
skipping to change at page 10, line 34 skipping to change at page 10, line 48
an additional flag (the Report MA ID flag) is required to control an additional flag (the Report MA ID flag) is required to control
whether the Measurement Agent ID is also to be reported. The whether the Measurement Agent ID is also to be reported. The
reporting of a Group ID without the MA ID allows the MA to remain reporting of a Group ID without the MA ID allows the MA to remain
anonymous, which may be particularly useful to prevent tracking of anonymous, which may be particularly useful to prevent tracking of
mobile MA devices. mobile MA devices.
Optionally an MA can also be configured to stop executing any Optionally an MA can also be configured to stop executing any
Instruction Schedule if the Controller is unreachable. This can be Instruction Schedule if the Controller is unreachable. This can be
used as a fail-safe to stop Measurement and other Tasks being used as a fail-safe to stop Measurement and other Tasks being
conducted when there is doubt that the Instruction Information is conducted when there is doubt that the Instruction Information is
still valid. This is simply represented as a time window in still valid. This is simply represented as a time window in seconds
milliseconds since the last communication with the Controller after since the last communication with the Controller after which
which Instruction Schedules are to be suspended. The appropriate Instruction Schedules are to be suspended. The appropriate value of
value of the time window will depend on the specified communication the time window will depend on the specified communication Schedule
Schedule with the Controller and the duration for which the system is with the Controller and the duration for which the system is willing
willing to tolerate continued operation with potentially stale to tolerate continued operation with potentially stale Instruction
Instruction Information. Information.
While Pre-Configuration Information is persistent upon device reset While Pre-Configuration Information is persistent upon device reset
or power cycle, the persistency of the Configuration Information may or power cycle, the persistency of the Configuration Information may
be device dependent. Some devices may revert back to their pre- be device dependent. Some devices may revert back to their pre-
configuration state upon reboot or factory reset, while other devices configuration state upon reboot or factory reset, while other devices
may store all Configuration and Instruction information in persistent may store all Configuration and Instruction information in persistent
storage. A Controller can check whether an MA has the latest storage. A Controller can check whether an MA has the latest
Configuration and Instruction information by examining the Capability Configuration and Instruction information by examining the Capability
and Status information for the MA. and Status information for the MA.
skipping to change at page 11, line 19 skipping to change at page 11, line 33
object { object {
uuid ma-agent-id; uuid ma-agent-id;
ma-task-obj ma-control-tasks<1..*>; ma-task-obj ma-control-tasks<1..*>;
ma-channel-obj ma-control-channels<1..*>; ma-channel-obj ma-control-channels<1..*>;
ma-schedule-obj ma-control-schedules<1..*>; ma-schedule-obj ma-control-schedules<1..*>;
[uri ma-device-id;] [uri ma-device-id;]
credentials ma-credentials; credentials ma-credentials;
[string ma-group-id;] [string ma-group-id;]
[boolean ma-report-agent-id;] [boolean ma-report-agent-id;]
[int ma-controller-lost-timeout;] [int ma-controller-timeout;]
} ma-config-obj; } ma-config-obj;
The ma-config-obj consists of the following elements: The ma-config-obj consists of the following elements:
ma-agent-id: A uuid uniquely identifying the measurement ma-agent-id: A uuid uniquely identifying the measurement
agent. agent.
ma-control-tasks: A collection of task objects. ma-control-tasks: A collection of task objects.
ma-control-channels: A collection of channel objects. ma-control-channels: A collection of channel objects.
skipping to change at page 11, line 46 skipping to change at page 12, line 13
measurement agent. measurement agent.
ma-group-id: An optional identifier of the group of ma-group-id: An optional identifier of the group of
measurement agents this measurement agent measurement agents this measurement agent
belongs to. belongs to.
ma-report-agent-id: An optional flag indicating whether the ma-report-agent-id: An optional flag indicating whether the
identifier (ma-agent-id) should be included identifier (ma-agent-id) should be included
in reports. in reports.
ma-controller-lost-timeout: A timer is started after each successful ma-controller-timeout: A timer is started after each successful
contact with a controller. When the timer contact with a controller. When the timer
reaches the controller-lost-timeout, all reaches the controller-timeout (measured in
schedules will be disabled. seconds), all schedules will be disabled,
i.e., no new actions will be executed (and
hence no new tasks started). The disabled
schedules will be reenabled automatically
once contact with a controller has been
established successfully again. Note that
this will not affect the execution of
actions that are essential to establish
contact with the controller or that perform
critical housekeeping functions.
3.3. Instruction Information 3.3. Instruction Information
The Instruction information model has four sub-elements: The Instruction information model has four sub-elements:
1. Instruction Task Configurations 1. Instruction Task Configurations
2. Report Channels 2. Report Channels
3. Instruction Schedules 3. Instruction Schedules
4. Suppression 4. Suppression
The Instruction supports the execution of all Tasks on the MA except The Instruction supports the execution of all Tasks on the MA except
those that deal with communication with the Controller (specified in those that deal with communication with the Controller (specified in
(pre-)configuration information). The Tasks are configured in (pre-)configuration information). The Tasks are configured in
Instruction Task Configurations and included by reference in Instruction Task Configurations and included by reference in
Instruction Schedules that specify when to execute them. The results Instruction Schedules that specify when to execute them. The results
can be communicated to other Tasks or a Task may implement a can be communicated to other Schedules or a Task may implement a
Reporting Protocol and communicate results over Report Channels. Reporting Protocol and communicate results over Report Channels.
Suppression is used to temporarily stop the execution of new Tasks as Suppression is used to temporarily stop the execution of new Tasks as
specified by the Instruction Schedules (and optionally to stop specified by the Instruction Schedules (and optionally to stop
ongoing Tasks). ongoing Tasks).
A Task Configuration is used to configure the mandatory and optional A Task Configuration is used to configure the mandatory and optional
parameters of a Task. It also serves to instruct the MA about the parameters of a Task. It also serves to instruct the MA about the
Task including the ability to resolve the Task to an executable and Task including the ability to resolve the Task to an executable and
specifying the schema for the Task parameters. specifying the schema for the Task parameters.
skipping to change at page 12, line 50 skipping to change at page 13, line 24
Task Configurations to transfer data to the same Collector. A single Task Configurations to transfer data to the same Collector. A single
Reporting Task Configuration can also be included in multiple Reporting Task Configuration can also be included in multiple
Schedules. E.g., a single Collector may receive data at three Schedules. E.g., a single Collector may receive data at three
different cycle rates, one Schedule reporting hourly, another different cycle rates, one Schedule reporting hourly, another
reporting daily and a third specifying that results should be sent reporting daily and a third specifying that results should be sent
immediately for on-demand measurement tasks. Alternatively multiple immediately for on-demand measurement tasks. Alternatively multiple
Report Channels can be used to send Measurement Task results to Report Channels can be used to send Measurement Task results to
different Collectors. The details of the Channel element is different Collectors. The details of the Channel element is
described later as it is common to several objects. described later as it is common to several objects.
Instruction Schedules specify which Tasks to execute according to a Instruction Schedules specify which Actions to execute according to a
given Timing (that can execute a single or repeated series of Tasks). given triggering Event. An Action is a Task with additional specific
parameters. An Event can trigger the execution of a single Action or
The Schedule also specifies how to link Tasks output data to other it can trigger a repeated series of Actions. The Schedule also
scheduled Tasks, i.e., sending selected outputs to other Tasks. specifies how to link Tasks output data to other Schedules.
Measurement Suppression information is used to over-ride the Measurement Suppression information is used to over-ride the
Instruction Schedule and temporarily stop measurements or other Tasks Instruction Schedule and temporarily stop measurements or other Tasks
from running on the MA for a defined or indefinite period. While from running on the MA for a defined or indefinite period. While
conceptually measurements can be stopped by simply removing them from conceptually measurements can be stopped by simply removing them from
the Measurement Schedule, splitting out separate information on the Measurement Schedule, splitting out separate information on
Measurement Suppression allows this information to be updated on the Measurement Suppression allows this information to be updated on the
MA on a different timing cycle or protocol implementation to the MA on a different timing cycle or protocol implementation to the
Measurement Schedule. It is also considered that it will be easier Measurement Schedule. It is also considered that it will be easier
for a human operator to implement a temporary explicit suppression for a human operator to implement a temporary explicit suppression
skipping to change at page 17, line 33 skipping to change at page 18, line 4
ma-log-code: A machine readable code describing the ma-log-code: A machine readable code describing the
event. event.
ma-log-description: A human readable description of the event. ma-log-description: A human readable description of the event.
3.5. Capability and Status Information 3.5. Capability and Status Information
The MA will hold Capability Information that can be retrieved by a The MA will hold Capability Information that can be retrieved by a
Controller. Capabilities include the device interface details Controller. Capabilities include the device interface details
available to Measurement Tasks as well as the set of Measurement available to Measurement Tasks as well as the set of Measurement
Tasks/Roles (specified by a registry entry) that are actually Tasks/Roles (specified by registry entries) that are actually
installed or available on the MA. Status information includes the installed or available on the MA. Status information includes the
times that operations were last performed such as contacting the times that operations were last performed such as contacting the
Controller or producing Reports. Controller or producing Reports.
3.5.1. Definition of ma-status-obj 3.5.1. Definition of ma-status-obj
object { object {
uuid ma-agent-id; uuid ma-agent-id;
uri ma-device-id; uri ma-device-id;
string ma-hardware; string ma-hardware;
skipping to change at page 18, line 28 skipping to change at page 19, line 4
ma-interfaces: A list of network interfaces available on ma-interfaces: A list of network interfaces available on
the device. the device.
ma-last-started: The date and time the measurement agent ma-last-started: The date and time the measurement agent
last started. last started.
ma-task-status: An optional list of status objects for each ma-task-status: An optional list of status objects for each
supported task. supported task.
3.5.2. Definition of ma-task-status-obj 3.5.2. Definition of ma-task-status-obj
object { object {
string ma-task-name; string ma-task-name;
[uri ma-task-registry-entry;] uri ma-task-registry-entries<1..*>;
[string ma-task-role<0..*>;] [string ma-task-role<0..*>;]
datetime ma-task-last-invocation; datetime ma-task-last-invocation;
datetime ma-task-last-completion; datetime ma-task-last-completion;
int ma-task-last-status; int ma-task-last-status;
string ma-task-last-message; string ma-task-last-message;
datetime ma-task-last-failed-completion; datetime ma-task-last-failed-completion;
int ma-task-last-failed-status; int ma-task-last-failed-status;
string ma-task-last-failed-message; string ma-task-last-failed-message;
} ma-task-status-obj; } ma-task-status-obj;
The ma-task-status-obj provides status information about a task and The ma-task-status-obj provides status information about a task and
consists of the following elements: consists of the following elements:
ma-task-name: A name uniquely identifying a task. ma-task-name: A name uniquely identifying a task.
ma-task-registry-entry: An optional URI identifying the ma-task-registry-entries: A possibly empty list of URIs
nature of the task. identifying the metrics a measurement
task supports.
ma-task-role: An optional and possibly empty list ma-task-role: An optional and possibly empty list
of roles of a task. of roles of a task.
ma-task-last-completion: The date and time of the last ma-task-last-completion: The date and time of the last
completion of this task. completion of this task.
ma-task-last-status: The status code returned by the last ma-task-last-status: The status code returned by the last
execution of this task. execution of this task.
skipping to change at page 22, line 31 skipping to change at page 23, line 9
measurement agents this measurement agent measurement agents this measurement agent
belongs to. belongs to.
ma-report-tasks: An optional and possibly empty list of ma-report-tasks: An optional and possibly empty list of
tasks result objects. tasks result objects.
3.6.2. Definition of ma-report-task-obj 3.6.2. Definition of ma-report-task-obj
object { object {
string ma-report-task-name; string ma-report-task-name;
[uri ma-report-task-registry-entry;] [uri ma-report-task-registry-entries<1..*>;]
[ma-option-obj ma-report-scheduled-task-options<0..*>]; [ma-option-obj ma-report-task-options<0..*>];
[ma-option-obj ma-report-task-action-options<0..*>];
[string ma-report-task-cycle-id;] [string ma-report-task-cycle-id;]
string ma-report-task-column-labels<0..*>; [string ma-report-task-column-labels<0..*>;]
ma-report-row-obj ma-report-task-rows<0..*>; [ma-report-row-obj ma-report-task-rows<0..*>;]
} ma-report-task-obj; } ma-report-task-obj;
The ma-report-task-obj provides the meta-data of a result report of a The ma-report-task-obj provides the meta-data of a result report of a
single task. It consists of the following elements: single task. It consists of the following elements:
ma-report-task-name: A name uniquely identifying the task ma-report-task-name: A name uniquely identifying the
that produced the results being task that produced the results
reported. being reported.
ma-report-task-registry-entry: An optional URI identifying the type ma-report-task-registry-entries: An optional possibly empty list of
of task. URIs identifying the metrics
reported.
ma-report-task-scheduled-task-options: An optional list of task ma-report-task-options: An optional list of task options
options provided by the scheduling provided by the task object.
object.
ma-report-task-cycle-id: An optional measurement cycle ma-report-task-action-options: An optional list of action options
identifier. provided by the scheduling object.
ma-report-task-column-labels: A possibly empty list of column ma-report-task-cycle-id: An optional measurement cycle
labels. identifier.
ma-report-task-rows: A possibly empty list of result rows. ma-report-task-column-labels: An optional and possibly empty list
of column labels.
ma-report-task-rows: An optional and possibly empty list
of result rows.
3.6.3. Definition of ma-report-row-obj 3.6.3. Definition of ma-report-row-obj
object { object {
datetime ma-report-result-start-time; datetime ma-report-result-start-time;
[datetime ma-report-result-end-time;] [datetime ma-report-result-end-time;]
string ma-report-result-conflicts<0..*>; string ma-report-result-conflicts<0..*>;
data ma-report-result-values<0..*>; data ma-report-result-values<0..*>;
} ma-report-row-obj; } ma-report-row-obj;
skipping to change at page 23, line 38 skipping to change at page 24, line 21
ma-report-result-end-time: An optional date and time indicating ma-report-result-end-time: An optional date and time indicating
when the measurement task that produced when the measurement task that produced
the reported result values finished. the reported result values finished.
ma-report-result-conflicts: A possibly empty set of names of task ma-report-result-conflicts: A possibly empty set of names of task
that might have impacted the that might have impacted the
measurement being reported. measurement being reported.
ma-report-result-values: A possibly empty set of result values. ma-report-result-values: A possibly empty set of result values.
When present, it contains an ordered
set of values that align to the set of
column labels for the report.
3.7. Common Objects: Schedules 3.7. Common Objects: Schedules
A Schedule specifies the execution of a single or repeated series of A Schedule specifies the execution of a single or repeated series of
Tasks. Each Schedule contains basically two elements: a list of Actions. An Action is a Task with additional specific parameters.
Tasks to be executed and a timing object for the Schedule. The Each Schedule contains basically two elements: a list of Actions to
Schedule states what Tasks to run (with what configuration) and when be executed and an Event object for the Schedule. The Schedule
to run the Tasks. states what Actions to run (with what configuration) and when to run
the Actions.
Multiple Tasks in the list of a single Measurement Schedule will be Multiple Actions in the list of a single Measurement Schedule will be
executed in order with minimal gaps. Tasks in different Schedules executed according to the execution mode of the Schedule. In
execute in parallel with such conflicts being reported in the sequential mode, Actions will be executed sequentially and in
Reporting Information. If two or more Schedules have the same start parallel mode, all Actions will be executed concurrently. In
time, then the two will execute in parallel. There is no mechanism pipelined mode, data produced by one Action is passed to the
to prioritise one schedule over another or to mutex scheduled tasks. subsequent Action. Actions in different Schedules execute in
parallel with such conflicts being reported in the Reporting
Information where necessary. If two or more Schedules have the same
start time, then the two will execute in parallel. There is no
mechanism to prioritise one schedule over another or to mutex
scheduled tasks.
As well as specifying which Tasks to execute, the Schedule also As well as specifying which Actions to execute, the Schedule also
specifies how to link the data outputs from each scheduled task to specifies how to link the data outputs from each Action to other
other scheduled tasks. Specifying this within the Schedule allows Schedules. Specifying this within the Schedule allows the highest
the highest level of flexibility since it is even possible to send level of flexibility since it is even possible to send the output
the output from different executions of the same Task Configuration from different executions of the same Task Configuration to different
to different destinations. Since a single Task may have multiple destinations. A single Task producing multiple different outputs is
outputs, the Schedule can independently specify which outputs go to expected to properly tag the different result. An Action receiving
which destinations. For example, a Measurement Task might report the output can then filter the results based on the tag if necessary.
routine results to a data Reporting Task that communicates hourly via For example, a Measurement Task might report routine results to a
the Broadband PPP interface, but also outputs emergency conditions data Reporting Task in a Schedule that communicates hourly via the
via an alarm Reporting Task communicating immediately over a GPRS Broadband PPP interface, but also outputs emergency conditions via an
channel. Note that task-to-task data transfer is always specified in alarm Reporting Task in a different Schedule communicating
association with the scheduled execution of the sending task - there immediately over a GPRS channel. Note that task-to-task data
is no need for a corresponding input specification for the receiving transfer is always specified in association with the scheduled
task. While it is likely that an MA implementation will use a queue execution of the sending task - there is no need for a corresponding
mechanism between the scheduled tasks, this Information Model does input specification for the receiving task. While it is likely that
not mandate or define a queue, or any potential associated parameters an MA implementation will use a queue mechanism between the Schedules
such as storage size and retention policies. or Actions, this Information Model does not mandate or define a
queue, or any potential associated parameters such as storage size
and retention policies.
When specifying the task to execute within the Schedule, it is When specifying the task to execute within the Schedule, i.e.,
possible to add to the task configuration option parameters. This creating an Action, it is possible to add to the task configuration
allows the Task Configuration to determine the common characteristics option parameters. This allows the Task Configuration to determine
of a Task, while selected parameters (e.g., the test target URL) are the common characteristics of a Task, while selected parameters
defined within the schedule. A single Tasks Configuration can even (e.g., the test target URL) are defined within the schedule. A
be used multiple times in the same schedule with different additional single Tasks Configuration can even be used multiple times in the
parameters. This allows for efficiency in creating and transferring same schedule with different additional parameters. This allows for
the Instruction. Note that the semantics of what happens if an efficiency in creating and transferring the Instruction. Note that
option is defined multiple times (either in the Task Configuration, the semantics of what happens if an option is defined multiple times
Schedule or in both) is not standardised and will depend upon the (either in the Task Configuration, Schedule or in both) is not
Task. For example, some tasks may legitimately take multiple values standardised and will depend upon the Task. For example, some tasks
for a single parameter. may legitimately take multiple values for a single parameter.
Where Options are specified in both the Schedule and the Task Where Options are specified in both the Schedule and the Task
Configuration, the Schedule Options are appended to those specified Configuration, the Schedule Options are appended to those specified
in the Task Configuration. in the Task Configuration.
Example: A Schedule references a single Measurement Task Example: An Action of a Schedule references a single Measurement
Configuration for the UDP latency. It specifies that results are Task Configuration for measuring UDP latency. It specifies that
to be sent to a scheduled Reporting Task. This Reporting Task is results are to be sent to a Schedule with a Reporting Action.
executed by a separate Schedule that specifies that it should run This Reporting Task of the Reporting Action is executed by a
hourly at 5 minutes past the hour. When run this Reporting Task separate Schedule that specifies that it should run hourly at 5
takes the data generated by the UDP latency Task as well as any minutes past the hour. When run this Reporting Action takes the
data generated by the UDP latency Measurement Task as well as any
other data to be included in the hourly report and transfers it to other data to be included in the hourly report and transfers it to
the Collector over the Report Channel specified within its own the Collector over the Report Channel specified within its own
Schedule. Schedule.
3.7.1. Definition of ma-schedule-obj 3.7.1. Definition of ma-schedule-obj
object { object {
string ma-schedule-name; string ma-schedule-name;
ma-event-obj ma-schedule-event;
ma-action-obj ma-schedule-actions<0..*>; ma-action-obj ma-schedule-actions<0..*>;
ma-timing-obj ma-schedule-timing; string ma-schedule-execution-mode;
} ma-schedule-obj; } ma-schedule-obj;
The ma-schedule-obj is the main scheduling object. It consists of The ma-schedule-obj is the main scheduling object. It consists of
the following elements: the following elements:
ma-schedule-name: A name uniquely identifying a scheduling ma-schedule-name: A name uniquely identifying a scheduling
object. object.
ma-schedule-actions: A possibly empty list of actions to invoke ma-schedule-event: An event object indicating when the
when the schedule fires. schedule fires.
ma-schedule-timing: A timing object indicating when the ma-schedule-actions: A possibly empty list of actions to
schedule fires. invoke when the schedule fires.
ma-schedule-execution-mode: Indicates whether the actions should be
executed sequentially, in parallel, or in
a pipelined mode (where data produced by
one action is passed to the subsequent
action).
3.7.2. Definition of ma-action-obj 3.7.2. Definition of ma-action-obj
object { object {
string ma-action-name; string ma-action-name;
string ma-action-task-name; string ma-action-task-name;
[ma-option-obj ma-action-task-options<0..*>]; [ma-option-obj ma-action-task-options<0..*>];
[ma-action-dest-obj ma-action-destinations<0..*>;] [string ma-action-destinations<0..*>;]
} ma-action-obj; } ma-action-obj;
The ma-sched-action-obj models an a task together with its schedule The ma-action-obj models an a task together with its schedule
specific options and destination tasks. It consists of the following specific options and destination tasks. It consists of the following
elements: elements:
ma-action-name: A name uniquely identifying an action of a ma-action-name: A name uniquely identifying an action of a
scheduling object. scheduling object.
ma-action-task-name: A name identifying the task to be invoked ma-action-task-name: A name identifying the task to be invoked
by the action. by the action.
ma-action-task-options: An optional and possibly empty list of ma-action-task-options: An optional and possibly empty list of
options (name-value pairs) that are passed options (name-value pairs) that are passed
to the task by appending them to the to the task by appending them to the
options configured for the task object. options configured for the task object.
ma-action-destinations: An optional and possibly empty list of ma-action-destinations: An optional and possibly empty list of
destination actions that consume output names of destination schedules that consume
produced by this action. output produced by this action.
3.7.3. Definition of ma-action-dest-obj
object {
string ma-action-dest-schedule-name;
string ma-action-dest-action-name;
[int ma-action-dest-action-outputs<0..*>;]
} ma-action-dest-obj;
The ma-action-dest-obj defines to which subsequent actions output
produced by an action should be sent to. It consists of the
following elements:
ma-action-dest-schedule-name: A name identifying a schedule object.
ma-action-dest-action-name: A name identifying an action within a
schedule object.
ma-action-dest-action-outputs: An optional and possibly empty list
of task outputs. If not present, the
element defaults to all outputs.
Example: A measurement task has two defined inter-task outputs, one
for routine measurement results and one for errors during the task
execution. These are defined as available outputs by the task and
are denoted by the integers 1 and 2. In this example, both
outputs are sent to the same reporting task called "Hourly
reporting Task" that is executed from the "Hourly Schedule"
schedule. This is done by creating a ma-action-dest-obj with the
output selection as [1,2] and the destination action configuration
name as ["Hourly Reporting Task"] and the destination schedule
name as "Hourly Schedule".
Measurement Task
Output 1 -----+----> "Hourly Schedule":"Hourly Reporting Task"
Output 2 ----/
3.8. Common Objects: Channels 3.8. Common Objects: Channels
A Channel defines a bi-directional communication channel between the A Channel defines a bi-directional communication channel between the
MA and a Controller or Collector. Multiple Channels can be defined MA and a Controller or Collector. Multiple Channels can be defined
to enable results to be split or duplicated across different to enable results to be split or duplicated across different
Collectors. Collectors.
Each Channel contains the details of the remote endpoint (including Each Channel contains the details of the remote endpoint (including
location and security credential information such as the location and security credential information such as the
skipping to change at page 27, line 27 skipping to change at page 27, line 44
whereas Channels to Collectors are referred to as Report Channels. whereas Channels to Collectors are referred to as Report Channels.
Hence Control Channels will be referenced from Control Tasks executed Hence Control Channels will be referenced from Control Tasks executed
by a Control Schedule, whereas Report Channels will be referenced by a Control Schedule, whereas Report Channels will be referenced
from within Reporting Tasks executed by an Instruction Schedule. from within Reporting Tasks executed by an Instruction Schedule.
Multiple interfaces are also supported. For example the Reporting Multiple interfaces are also supported. For example the Reporting
Task could be configured to send some results over GPRS. This is Task could be configured to send some results over GPRS. This is
especially useful when such results indicate the loss of connectivity especially useful when such results indicate the loss of connectivity
on a different network interface. on a different network interface.
Example: A Channel using for reporting results may specify that Example: A Channel used for reporting results may specify that
results are to be sent to the URL (https://collector.foo.org/ results are to be sent to the URL (https://collector.example.org/
report/), using the appropriate digital certificate to establish a report/), using the appropriate digital certificate to establish a
secure channel.. secure channel..
3.8.1. Definition of ma-channel-obj 3.8.1. Definition of ma-channel-obj
object { object {
string ma-channel-name; string ma-channel-name;
url ma-channel-target; url ma-channel-target;
credentials ma-channel-credentials; credentials ma-channel-credentials;
[string ma-channel-interface-name;] [string ma-channel-interface-name;]
} ma-channel-obj; } ma-channel-obj;
The ma-channel-obj consists of the following elements: The ma-channel-obj consists of the following elements:
ma-channel-name: A unique name identifying the channel ma-channel-name: A unique name identifying the channel
object. object.
ma-channel-target: A URL identifying the target channel ma-channel-target: A URL identifying the target channel
endpoint. endpoint.
ma-channel-credentials: The security credentials needed to ma-channel-credentials: The security credentials needed to
establish a secure channel. establish a secure channel.
ma-channel-interface-name: An optional name of the network interface ma-channel-interface-name: An optional name of the network interface
to be used. If not present, the system to be used. If not present, the system
will select a suitable interface. will select a suitable interface.
3.9. Common Objects: Task Configurations 3.9. Common Objects: Task Configurations
Conceptually each Task Configuration defines the parameters of a Task Conceptually each Task Configuration defines the parameters of a Task
that the Measurement Agent (MA) may perform at some point in time. that the Measurement Agent (MA) may perform at some point in time.
It does not by itself actually instruct the MA to perform them at any It does not by itself actually instruct the MA to perform them at any
particular time (this is done by a Schedule). Tasks can be particular time (this is done by a Schedule). Tasks can be
Measurement Tasks (i.e., those Tasks actually performing some type of Measurement Tasks (i.e., those Tasks actually performing some type of
passive or active measurement) or any other scheduled activity passive or active measurement) or any other scheduled activity
performed by the MA such as transferring information to or from the performed by the MA such as transferring information to or from the
Controller and Collectors. Other examples of Tasks may include data Controller and Collectors. Other examples of Tasks may include data
manipulation or processing Tasks conducted on the MA. manipulation or processing Tasks conducted on the MA.
A Measurement Task Configuration is the same in information terms to A Measurement Task Configuration is the same in information terms to
any other Task Configuration. Both measurement and non-measurement any other Task Configuration. Both measurement and non-measurement
Tasks have a registry entry to enable the MA to uniquely identify the Tasks have registry entries to enable the MA to uniquely identify the
Task it should execute and retrieve the schema for any parameters Task it should execute and retrieve the schema for any parameters
that may be passed to the Task. This registry entry is specified as that may be passed to the Task. Registry entries are specified as a
a URI and can therefore be used to identify the Task within a URI and can therefore be used to identify the Task within a namespace
namespace or point to a web or local file location for the Task or point to a web or local file location for the Task information.
information. As mentioned previously this entry may be used to As mentioned previously, these URIs may be used to identify the
identify the Measurement Task in a public namespace Measurement Task in a public namespace
[I-D.ietf-ippm-metric-registry] . [I-D.ietf-ippm-metric-registry].
Example: A Measurement Task Configuration may configure a single Example: A Measurement Task Configuration may configure a single
Measurement Task for measuring UDP latency. The Measurement Task Measurement Task for measuring UDP latency. The Measurement Task
Configuration could define the destination port and address for Configuration could define the destination port and address for
the measurement as well as the duration, internal packet timing the measurement as well as the duration, internal packet timing
strategy and other parameters (for example a stream for one hour strategy and other parameters (for example a stream for one hour
and sending one packet every 500 ms). It may also define the and sending one packet every 500 ms). It may also define the
output type and possible parameters (for example the output type output type and possible parameters (for example the output type
can be the 95th percentile mean) where the measurement task can be the 95th percentile mean) where the measurement task
accepts such parameters. It does not define when the task starts accepts such parameters. It does not define when the task starts
(this is defined by the Schedule element), so it does not by (this is defined by the Schedule element), so it does not by
itself instruct the MA to actually perform this Measurement Task. itself instruct the MA to actually perform this Measurement Task.
The Task Configuration will include a local short name for reference The Task Configuration will include a local short name for reference
by a Schedule. Task Configurations will also contain a registry by a Schedule. Task Configurations may also refer to registry
entry as described above. In addition the Task can be configured entries as described above. In addition the Task can be configured
through a set of configuration Options. The nature and number of through a set of configuration Options. The nature and number of
these Options will depend upon the Task. These options are expressed these Options will depend upon the Task. These options are expressed
as name-value pairs although the 'value' may be a structured object as name-value pairs although the 'value' may be a structured object
instead of a simple string or numeric value. The implementation of instead of a simple string or numeric value. The implementation of
these name-value pairs will vary between data models such as JSON, these name-value pairs will vary between data models.
XML or TR-069.
A Option that must be present for Reporting Tasks is the Channel An Option that must be present for Reporting Tasks is the Channel
reference specifying how to communicate with a Collector. This is reference specifying how to communicate with a Collector. This is
included in the task options and will have a value that matches a included in the task options and will have a value that matches a
channel name that has been defined in the Instruction. Similarly channel name that has been defined in the Instruction. Similarly
Control Tasks will have a similar option with the value set to a Control Tasks will have a similar option with the value set to a
specified Control Channel. specified Control Channel.
A reporting task might also have a flag parameter to indicate whether A reporting task might also have a flag parameter to indicate whether
to report if there is no measurement result data pending to be to report if there is no measurement result data pending to be
transferred to the Collector. In addition many tasks will also take transferred to the Collector. In addition many tasks will also take
as a parameter which interface to operate over. as a parameter which interface to operate over.
skipping to change at page 29, line 35 skipping to change at page 30, line 9
Measurement Cycle ID. The purpose of this ID is to easily identify a Measurement Cycle ID. The purpose of this ID is to easily identify a
set of measurement results that have been produced by Measurement set of measurement results that have been produced by Measurement
Tasks with comparable Options. This ID could be manually incremented Tasks with comparable Options. This ID could be manually incremented
or otherwise changed when an Option change is implemented which could or otherwise changed when an Option change is implemented which could
mean that two sets of results should not be directly compared. mean that two sets of results should not be directly compared.
3.9.1. Definition of ma-task-obj 3.9.1. Definition of ma-task-obj
object { object {
string ma-task-name; string ma-task-name;
uri ma-task-registry-entry; uri ma-task-registry-entries<1..*>;
[ma-option-obj ma-task-options<0..*>]; [ma-option-obj ma-task-options<0..*>];
[boolean ma-task-suppress-by-default;] [boolean ma-task-suppress-by-default;]
[string ma-task-cycle-id;] [string ma-task-cycle-id;]
} ma-task-obj; } ma-task-obj;
The ma-task-obj defines a task that can be invoked. A task can be The ma-task-obj defines a task that can be invoked. A task can be
referenced via its name and it contains an URI to link to a registry referenced by its name and it contains a set of URIs to link to a
or a local specification of the task. Options allow the metrics registry or a local specification of the task. Options allow
configuration of task parameter (in the form of name-value pairs). the configuration of task parameter (in the form of name-value
The ma-task-obj consists of the following elements: pairs). The ma-task-obj consists of the following elements:
ma-task-name: A name uniquely identifying a task ma-task-name: A name uniquely identifying a task
object. object.
ma-task-registry-entry: A URI identifying the type of task. ma-task-registry-entries: A possibly empty list of URIs
identifying the metrics a measurement
task supports.
ma-task-options: A optional and possibly empty list of ma-task-options: A optional and possibly empty list of
options (name-value pairs) that are options (name-value pairs) that are
passed to the task. passed to the task.
ma-task-suppress-by-default: A boolean flag indicating whether the ma-task-suppress-by-default: A boolean flag indicating whether the
task will be suppressed by default. task will be suppressed by default.
The default value of the flag is true. The default value of the flag is true.
ma-task-cycle-id: An optional measurement cycle ma-task-cycle-id: An optional measurement cycle
skipping to change at page 30, line 46 skipping to change at page 31, line 20
o Channel is used to specify the details of an endpoint for Control o Channel is used to specify the details of an endpoint for Control
or Reporting Task communications and is detailed elsewhere in this or Reporting Task communications and is detailed elsewhere in this
document. The common option name for specifying the channel is document. The common option name for specifying the channel is
"channel". "channel".
o Role is used to specify which Role the task should be performing o Role is used to specify which Role the task should be performing
(as defined in the registry) if multiple roles are available. The (as defined in the registry) if multiple roles are available. The
common option name for specifying the role is "role". common option name for specifying the role is "role".
3.10. Common Objects: Timing Information 3.10. Common Objects: Event Information
The Timing information object used throughout the information models The Event information object used throughout the information models
can take one of five different forms: can initially take one of five different forms. Additional forms may
be defined later in order to bind the execution of schedules to
additional events. The initially defined five Event forms are:
1. Periodic. Specifies a start, end and interval time in 1. Periodic Timing: Emits multiple events periodically according to
milliseconds an interval time defined in milliseconds
2. Calendar: Specifies a calendar based pattern, e.g., 22 minutes 2. Calendar Timing: Emits multiple events according to a calendar
past each hour of the day on weekdays based pattern, e.g., 22 minutes past each hour of the day on
weekdays
3. One Off: A single instance occurring at a specific time 3. One Off Timing: Emits one event at a specific date and time
4. Immediate: Should occur as soon as possible 4. Immediate: Emits one event as soon as possible
5. Startup: Should occur whenever the MA is started (e.g., at device 5. Startup: Emits an event whenever the MA is started (e.g., at
startup) device startup)
Optionally each of the options may also specify a randomness that Optionally each of the Event options may also specify a randomness
should be evaluated and applied separately to each indicated event. that should be evaluated and applied separately to each indicated
This randomness parameter defines a uniform interval in milliseconds event. This randomness parameter defines a uniform interval in
over which the start of the task is delayed from the starting times milliseconds over which the start of the task is delayed from the
specified by the timing object. starting times specified by the timing object.
Both the Periodic and Calendar timing objects allow for a series of Both the Periodic and Calendar timing objects allow for a series of
tasks to be executed. While both have an optional end time, it is Actions to be executed. While both have an optional end time, it is
best practice to always configure an end time and refresh the best practice to always configure an end time and refresh the
information periodically to ensure that lost MAs do not continue information periodically to ensure that lost MAs do not continue
their tasks forever. their tasks forever.
Starup timing is only executed on device startup - not when a new Startup events are only created on device startup, not when a new
Instruction is transferred to the MA. If scheduled task execution is Instruction is transferred to the MA. If scheduled task execution is
desired both on the transfer of the Instruction and on device restart desired both on the transfer of the Instruction and on device restart
then both the Immediate and Startup timing needs to be used in then both the Immediate and Startup timing needs to be used in
conjunction. conjunction.
The datetime format used for all elements in the information model The datetime format used for all elements in the information model
MUST conform to RFC 3339 [RFC3339]. MUST conform to RFC 3339 [RFC3339].
3.10.1. Definition of ma-timing-obj 3.10.1. Definition of ma-event-obj
object { object {
string ma-timing-name; string ma-event-name;
union { union {
ma-periodic-obj ma-timing-periodic; ma-periodic-obj ma-timing-periodic;
ma-calendar-obj ma-timing-calendar; ma-calendar-obj ma-timing-calendar;
ma-one-off-obj ma-timing-one-off; ma-one-off-obj ma-timing-one-off;
ma-immediate-obj ma-timing-immediate; ma-immediate-obj ma-event-immediate;
ma-startup-obj ma-timing-startup; ma-startup-obj ma-event-startup;
} }
[int ma-timing-random-spread;] [int ma-event-random-spread;]
} ma-timing-obj; } ma-event-obj;
The ma-timing-obj is the main timing object. Timing objects are
identified by a name. The timing object itself contains a more
specific timing object. These objects are further described below.
The ma-timing-obj also includes an optional uniform random spread in The ma-event-obj is the main event object. Event objects are
milliseconds that can be used to randomize the start times of identified by a name. The generic event object itself contains a
scheduled tasks. The ma-timing-obj consists of the following more specific event object and the set of specific event objects
elements: should be extensible. These five initial specific event objects are
further described below. The ma-event-obj also includes an optional
uniform random spread in milliseconds that can be used to randomize
the start times of scheduled tasks. The ma-event-obj consists of the
following elements:
ma-timing-name: The name uniquely identifies a timing ma-timing-name: The name uniquely identifies an event
object. Schedules refer to timing objects object. Schedules refer to event objects
by this name. by this name.
ma-timing-periodic: The ma-timing-periodic is present for ma-timing-periodic: The ma-timing-periodic is present for
periodic timing objects. periodic timing objects.
ma-timing-calendar: The ma-timing-calendar is present for ma-timing-calendar: The ma-timing-calendar is present for
calendar timing objects. calendar timing objects.
ma-timing-one-off: The ma-timing-one-off is present for one- ma-timing-one-off: The ma-timing-one-off is present for one-
off timing objects. off timing objects.
ma-timing-immediate: The ma-timing-immediate is present for ma-timing-immediate: The ma-event-immediate is present for
immediate timing objects. immediate event objects.
ma-timing-startup: The ma-timing-startup is present for ma-timing-startup: The ma-event-startup is present for startup
startup timing objects. event objects.
ma-timing-random-spread: The optional ma-timing-random-spread adds a ma-timing-random-spread: The optional ma-event-random-spread adds a
random delay defined in milliseconds to the random delay defined in milliseconds to the
timing object. event object.
3.10.2. Definition of ma-periodic-obj 3.10.2. Definition of ma-periodic-obj
object { object {
[datetime ma-periodic-start;] [datetime ma-periodic-start;]
[datetime ma-periodic-end;] [datetime ma-periodic-end;]
int ma-periodic-interval; int ma-periodic-interval;
} ma-periodic-obj; } ma-periodic-obj;
The ma-periodic-obj timing object has an optional start and an The ma-periodic-obj timing object has an optional start and an
optional end time plus a periodic interval. Tasks scheduled using an optional end time plus a periodic interval. Schedules using an ma-
ma-periodic-obj are started periodically between the start and end periodic-obj are started periodically between the start and end time.
time. The ma-periodic-obj consists of the following elements: The ma-periodic-obj consists of the following elements:
ma-periodic-start: The optional date and time at which tasks ma-periodic-start: The optional date and time at which
scheduled using this object are first Schedules using this object are first
started. If not present it defaults to started. If not present it defaults to
immediate. immediate.
ma-periodic-end: The optional date and time at which tasks ma-periodic-end: The optional date and time at which
scheduled using this object last started. Schedules using this object are last
If not present it defaults to indefinite. started. If not present it defaults to
indefinite.
ma-periodic-interval: The interval defines the time in ma-periodic-interval: The interval defines the time in
milliseconds between two consecutive starts milliseconds between two consecutive starts
of tasks. of tasks.
3.10.3. Definition of ma-calendar-obj 3.10.3. Definition of ma-calendar-obj
Calendar Timing supports the routine execution of Measurement Tasks Calendar Timing supports the routine execution of Actions at specific
at specific times and/or on specific dates. It can support more times and/or on specific dates. It can support more flexible timing
flexible timing than Periodic Timing since the Measurement Task than Periodic Timing since the execution of Actions does not have to
execution does not have to be uniformly spaced. For example a be uniformly spaced. For example a Calendar Timing could support the
Calendar Timing could support the execution of a Measurement Task execution of a Measurement Task every hour between 6pm and midnight
every hour between 6pm and midnight on weekdays only. on weekdays only.
Calendar Timing is also required to perform measurements at Calendar Timing is also required to perform measurements at
meaningful instances in relation to network usage (e.g., at peak meaningful times in relation to network usage (e.g., at peak times).
times). If the optional timezone offset is not supplied then local If the optional timezone offset is not supplied then local system
system time is assumed. This is essential in some use cases to time is assumed. This is essential in some use cases to ensure
ensure consistent peak-time measurements as well as supporting MA consistent peak-time measurements as well as supporting MA devices
devices that may be in an unknown timezone or roam between different that may be in an unknown timezone or roam between different
timezones (but know their own timezone information such as through timezones (but know their own timezone information such as through
the mobile network). the mobile network).
The calendar elements within the Calendar Timing do not have defaults The calendar elements within the Calendar Timing do not have defaults
in order to avoid accidental high-frequency execution of Tasks. If in order to avoid accidental high-frequency execution of Tasks. If
all possible values for an element are desired then the wildcard * is all possible values for an element are desired then the wildcard * is
used. used.
object { object {
[datetime ma-calendar-start;] [datetime ma-calendar-start;]
skipping to change at page 33, line 49 skipping to change at page 34, line 26
[string ma-calendar-months<0..*>;] [string ma-calendar-months<0..*>;]
[string ma-calendar-days-of-week<0..*>;] [string ma-calendar-days-of-week<0..*>;]
[string ma-calendar-days-of-month<0..*>;] [string ma-calendar-days-of-month<0..*>;]
[string ma-calendar-hours<0..*>;] [string ma-calendar-hours<0..*>;]
[string ma-calendar-minutes<0..*>;] [string ma-calendar-minutes<0..*>;]
[string ma-calendar-seconds<0..*>;] [string ma-calendar-seconds<0..*>;]
[int ma-calendar-timezone-offset;] [int ma-calendar-timezone-offset;]
} ma-calendar-obj; } ma-calendar-obj;
ma-calendar-start: The optional date and time at which ma-calendar-start: The optional date and time at which
tasks scheduled using this object are Schedules using this object are first
first started. If not present it started. If not present it defaults to
defaults to immediate. immediate.
ma-calendar-end: The optional date and time at which ma-calendar-end: The optional date and time at which
tasks scheduled using this object last Schedules using this object are last
started. If not present it defaults to started. If not present it defaults to
indefinite. indefinite.
ma-calendar-months: The optional set of months (1-12) on ma-calendar-months: The optional set of months (1-12) on
which tasks scheduled using this object which tasks scheduled using this object
are started. The wildcard * means all are started. The wildcard * means all
months. If not present, it defaults to months. If not present, it defaults to
no months. no months.
ma-calendar-days-of-week: The optional set of days of a week ma-calendar-days-of-week: The optional set of days of a week
("Mon", "Tue", "Wed", "Thu", "Fri", ("Mon", "Tue", "Wed", "Thu", "Fri",
"Sat", "Sun") on which tasks scheduled "Sat", "Sun") on which tasks scheduled
using this object are started. The using this object are started. The
wildcard * means all days of teh week. wildcard * means all days of the week.
If not present, it defaults to no If not present, it defaults to no days.
months.
ma-calendar-days-of-month: The optional set of days of a months ma-calendar-days-of-month: The optional set of days of a months
(1-31) on which tasks scheduled using (1-31) on which tasks scheduled using
this object are started. The wildcard this object are started. The wildcard
* means all days of a months. If not * means all days of a months. If not
present, it defaults to no days. present, it defaults to no days.
ma-calendar-hours: The optional set of hours (0-23) on ma-calendar-hours: The optional set of hours (0-23) on
which tasks scheduled using this object which tasks scheduled using this object
are started. The wildcard * means all are started. The wildcard * means all
skipping to change at page 34, line 50 skipping to change at page 35, line 27
defaults to no hours. defaults to no hours.
ma-calendar-seconds: The optional set of seconds (0-59) on ma-calendar-seconds: The optional set of seconds (0-59) on
which tasks scheduled using this object which tasks scheduled using this object
are started. The wildcard * means all are started. The wildcard * means all
seconds of an hour. If not present, it seconds of an hour. If not present, it
defaults to no seconds. defaults to no seconds.
ma-calendar-timezone-offset: The optional timezone offest in hours. ma-calendar-timezone-offset: The optional timezone offest in hours.
If not present, it defaults to the If not present, it defaults to the
system's local timezone.. system's local timezone.
If a day of the month is specified that does not exist in the month If a day of the month is specified that does not exist in the month
(e.g., 29th of Feburary) then those values are ignored. (e.g., 29th of Feburary) then those values are ignored.
3.10.4. Definition of ma-one-off-obj 3.10.4. Definition of ma-one-off-obj
object { object {
datetime ma-one-off-time; datetime ma-one-off-time;
} ma-one-off-obj; } ma-one-off-obj;
The ma-one-off-obj timing object specifies a fixed point in time. The ma-one-off-obj timing object specifies a fixed point in time.
Tasks scheduled using an ma-one-off-obj are started once at the Schedules using an ma-one-off-obj are started once at the specified
specified date and time. The ma-one-off-obj consists of the date and time. The ma-one-off-obj consists of the following
following elements: elements:
ma-one-off-time: The date and time at which tasks scheduled ma-one-off-time: The date and time at which Schedules using
using this object are started. this object are started.
3.10.5. Definition of ma-immediate-obj 3.10.5. Definition of ma-immediate-obj
object { object {
// empty // empty
} ma-immediate-obj; } ma-immediate-obj;
The ma-immediate-obj timing object has no further information The ma-immediate-obj event object has no further information
elements. Tasks scheduled using an ma-immediate-obj are started as elements. Schedules using an ma-immediate-obj are started as soon as
soon as possible. possible.
3.10.6. Definition of ma-startup-obj 3.10.6. Definition of ma-startup-obj
object { object {
// empty // empty
} ma-startup-obj; } ma-startup-obj;
The ma-startup-obj timing object has no further information elements. The ma-startup-obj event object has no further information elements.
Tasks scheduled using an ma-startup-obj are started at MA initiation Schedules using an ma-startup-obj are started at MA initiation time.
time.
4. IANA Considerations 4. IANA Considerations
This document makes no request of IANA. This document makes no request of IANA.
Note to RFC Editor: this section may be removed on publication as an Note to RFC Editor: this section may be removed on publication as an
RFC. RFC.
5. Security Considerations 5. Security Considerations
skipping to change at page 37, line 17 skipping to change at page 37, line 40
7.2. Informative References 7.2. Informative References
[I-D.ietf-ippm-metric-registry] [I-D.ietf-ippm-metric-registry]
Bagnulo, M., Claise, B., Eardley, P., Morton, A., and A. Bagnulo, M., Claise, B., Eardley, P., Morton, A., and A.
Akhter, "Registry for Performance Metrics", draft-ietf- Akhter, "Registry for Performance Metrics", draft-ietf-
ippm-metric-registry-02 (work in progress), February 2015. ippm-metric-registry-02 (work in progress), February 2015.
[I-D.ietf-lmap-yang] [I-D.ietf-lmap-yang]
Schoenwaelder, J. and V. Bajpai, "A YANG Data Model for Schoenwaelder, J. and V. Bajpai, "A YANG Data Model for
LMAP Measurement Agents", draft-ietf-lmap-yang-00 (work LMAP Measurement Agents", draft-ietf-lmap-yang-00 (work in
in progress), April 2015. progress), April 2015.
[RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between
Information Models and Data Models", RFC 3444, January Information Models and Data Models", RFC 3444, January
2003. 2003.
Appendix A. Open Issues
o Should the execution-mode have a default? If so, which one?
o Is the current handling of lost connectivity to the controller
sufficient?
o There should be status objects for schedules and actions instead
of tasks (since what is being invoked are schedules and actions,
not configured tasks). The status objects should also indicate
whether a schedule is enabled, suppressed, disabled (e.g. due to
loss of controller connectivity), or disabled for any other
reason.
Appendix B. Non-editorial Changes since -05
o A task can now reference multiply registry entries.
o Consistent usage of the term Action and Task.
o Schedules are triggered by Events instead of Timings; Timings are
just one of many possible event sources.
o Actions feed into other Schedules (instead of Actions within other
Schedules).
o Removed the notion of multiple task outputs.
o Support for sequential, parallel, and pipelined execution of
Actions.
Authors' Addresses Authors' Addresses
Trevor Burbridge Trevor Burbridge
BT BT
Adastral Park, Martlesham Heath Adastral Park, Martlesham Heath
Ipswich IP5 3RE Ipswich IP5 3RE
United Kingdom United Kingdom
Email: trevor.burbridge@bt.com Email: trevor.burbridge@bt.com
 End of changes. 104 change blocks. 
309 lines changed or deleted 355 lines changed or added

This html diff was produced by rfcdiff 1.42. The latest version is available from http://tools.ietf.org/tools/rfcdiff/