]> Jacobs University Bremen

j.schoenwaelder@jacobs-university.de

Jacobs University Bremen

v.bajpai@jacobs-university.de

Operations and Management LMAP YANG This document defines a data model for Large-Scale Measurement Platforms (LMAP). The data model is defined using the YANG data modeling language.

This document defines a data model for Large-Scale Measurement Platforms (LMAP) . The data model is defined using the YANG data modeling language. It aims to be consistent with the LMAP Information Model .

This document uses the LMAP terminology defined in . The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in .

A simplified graphical representation of the data model is used in this document. The meaning of the symbols in these diagrams is as follows: Brackets "[" and "]" enclose list keys. Abbreviations before data node names: "rw" means configuration (read-write), "ro" means state data (read-only), and "w" means RPC input date (write-only). Symbols after data node names: "?" means an optional node, "!" means a presence container, and "*" denotes a list and leaf-list. Parentheses enclose choice and case nodes, and case nodes are also marked with a colon (":"). Ellipsis ("...") stands for contents of subtrees that are not shown.

The LMAP framework has three basic elements: Measurement Agents, Controllers, and Collectors. Measurement Agents initiate the actual measurements, which are called Measurement Tasks in the LMAP terminology. The Controller instructs one or more MAs and communicates the set of Measurement Tasks an MA should perform and when. The Collector accepts Reports from the MAs with the Results from their Measurement Tasks. The YANG data model for LMAP has been split into three modules: The module ietf-lmap-common.yang provides common definitions such as LMAP specific data types. The module ietf-lmap-config.yang defines the data structures exchanged between a Controller and Measurement Agents. The module ietf-lmap-report.yang defines the data structures exchanged between Measurement Agents and Collectors. As shown in , a Controller, implementing ietf-lmap-common.yang and ietf-lmap-control.yang as a client, will instruct Measurement Agents, implementing ietf-lmap-common.yang and ietf-lmap-control.yang as servers. A Measurement Agent, implementing ietf-lmap-common.yang and ietf-lmap-report.yang, will send results to a Collector, implementing ietf-lmap-common.yang and ietf-lmap-report.yang as a server.

| ietf-lmap-control.yang | | | | | request -> | Client: |----------------------. | ietf-lmap-comman.yang | <- response | | ietf-lmap-report.yang | | +------------------------+ v +------------------------+ | LMAP Collector | | | | Server: | | ietf-lmap-comman.yang | | ietf-lmap-report.yang | +------------------------+ ]]>

The tree diagram below shows the structure of the configuration data model.

The tree diagram below shows the structure of the state data model.

The tree diagram below shows the structure of the reporting data model.

The LMAP information model is devided into six sections. They are mapped into the YANG data model as explained below: Pre-Configuration Information: This is not modeled explicitly since it is a subset of the configuration information. Configuration Information: This is modeled in the /lmap/agent subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree described below. Some items have been left out because they are expected to be dealt with by the underlying protocol. Instruction Information: This is modeled in the /lmap/suppressions subtree, the /lmap/schedules subtree, and the /lmap/tasks subtree described below. Logging Information: Some of the logging information, in particular 'success/failure/warning messages in response to information updates from the Controller', will be handled by the protocol used to manipulate the lmap specific configuration. For the first version of the LMAP data models, it is assumed that runtime logging information will be dealt with using protocols that do not require a formal data model, e.g., the Syslog protocol defined in . Capability and Status Information: Some of the status information is modeled in the /lmap-state/agent subtree and the /lmap-state/schedules subtree. Information about network interfaces can be obtained from the interfaces YANG data model . The list of supported tasks is modeled in the /lmap-state/tasks subtree. Reporting Information: This is modeled by the report data model to be implemented by the Collector. Measurement Agents send results to the Collector via an RPC operation. These six sections are build on the following common information objects: Schedules: This is modeled in the /lmap/schedules subtree. Channels: Channels are not modeled since the NETCONF and RESTCONF server configuration data model already provides a mechanism to configure NETCONF and RESTCONF server channels. Task Configurations: This is modeled in the /lmap/tasks subtree. Event Information: This is modeled in the /lmap/events subtree.

This module imports definitions from .

file "ietf-lmap-common@2016-10-10.yang" module ietf-lmap-common { namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-common"; prefix "lmap"; import ietf-inet-types { prefix inet; } organization "IETF Large-Scale Measurement Platforms Working Group"; contact "WG Web: WG List: Editor: Juergen Schoenwaelder Editor: Vaibhav Bajpai "; description "This module provides common definitions used by the data models written for Large-Scale Measurement Platforms (LMAP). This module defines typedefs and groupings but no schema tree elements."; revision "2016-10-10" { description "Initial version"; reference "RFC XXX: A YANG Data Model for LMAP Measurement Agents"; } /* * Typedefs */ typedef identifier { type string { length "1..max"; } description "An string value used to name something."; } typedef tag { type string { length "1..max"; } description "A tag consists of at least one character."; } typedef glob-pattern { type string { length "1..max"; } description 'A glob style pattern (following POSIX.2 fnmatch() without special treatment of file paths): * matches a sequence of characters ? matches a single character [seq] matches any character in seq [!seq] matches any character not in seq A backslash followed by a character matches the following character. In particular: \* matches * \? matches ? \\ matches \ A sequence seq may be a sequence of characters (e.g., [abc] or a range of characters (e.g., [a-c]).'; } typedef wildcard { type string { pattern '\*'; } description "A wildcard for calendar scheduling entries."; } typedef cycle-number { type string { pattern '[0-9]{8}\.[0-9]{6}'; } description "A cycle number represented in the format YYYYMMDD.HHMMSS where YYYY represents the year, MM the month (1..12), DD the day of the months (01..31), HH the hour (00..23), MM the minute (00..59), and SS the second (00..59)."; } typedef month { type enumeration { enum january { value 1; description "January of the Gregorian calendar."; } enum february { value 2; description "February of the Gregorian calendar."; } enum march { value 3; description "March of the Gregorian calendar."; } enum april { value 4; description "April of the Gregorian calendar."; } enum may { value 5; description "May of the Gregorian calendar."; } enum june { value 6; description "June of the Gregorian calendar."; } enum july { value 7; description "July of the Gregorian calendar."; } enum august { value 8; description "August of the Gregorian calendar."; } enum september { value 9; description "September of the Gregorian calendar."; } enum october { value 10; description "October of the Gregorian calendar."; } enum november { value 11; description "November of the Gregorian calendar."; } enum december { value 12; description "December of the Gregorian calendar."; } } description "A type modeling the month in the Gregorian calendar."; } typedef month-or-all { type union { type month; type wildcard; } description "A month or a wildcard indicating all twelve months."; } typedef day-of-month { type uint8 { range "1..31"; } description "A day of a month of the Gregorian calendar."; } typedef day-of-months-or-all { type union { type day-of-month; type wildcard; } description "A day of a months or a wildcard indicating all days of a month."; } typedef weekday { type enumeration { enum monday { value 1; description "Monday of the Gregorian calendar."; } enum tuesday { value 2; description "Tuesday of the Gregorian calendar."; } enum wednesday { value 3; description "Wednesday of the Gregorian calendar."; } enum thursday { value 4; description "Thursday of the Gregorian calendar."; } enum friday { value 5; description "Friday of the Gregorian calendar."; } enum saturday { value 6; description "Saturday of the Gregorian calendar."; } enum sunday { value 7; description "Sunday of the Gregorian calendar."; } } description "A type modeling the weekdays in the Gregorian calendar. The numbering follows the ISO 8601 scheme."; } typedef weekday-or-all { type union { type weekday; type wildcard; } description "A weekday or a wildcard indicating all seven weekdays."; } typedef hour { type uint8 { range "0..23"; } description "An hour of a day."; } typedef hour-or-all { type union { type hour; type wildcard; } description "An hour of a day or a wildcard indicating all hours of a day."; } typedef minute { type uint8 { range "0..59"; } description "A minute of an hour."; } typedef minute-or-all { type union { type minute; type wildcard; } description "A minute of an hour or a wildcard indicating all minutes of an hour."; } typedef second { type uint8 { range "0..59"; } description "A second of a minute."; } typedef second-or-all { type union { type second; type wildcard; } description "A second of a minute or a wildcard indicating all seconds of a minute."; } typedef status-code { type int32; description "A status code returned by the execution of a task. Note that the actual range is implementation dependent but it should be portable to use values in the range 0..127 for regular exit codes. By convention, 0 indicates successful termination. Negative values may be used to indicate abnormal termination due to a signal; the absolute value may identify the signal number in this case."; } typedef timezone-offset { type string { pattern 'Z|[\+\-]\d{2}:\d{2}'; } description "A timezone-offset as it is used by the date-and-time type defined in the ietf-yang-types module. The value Z is equivalent to +00:00. The value -00:00 indicates and unknown time-offset."; reference "RFC 6991: Common YANG Data Types"; } /* * Groupings */ grouping registry-grouping { description "This grouping models a list of entries in a registry that identify functions of a tasks."; list metric { key uri; description "A list of entries in a registry identifying functions."; leaf uri { type inet:uri; description "A URI identifying an entry in a registry."; } leaf-list role { type string; description "A set of roles for the identified registry entry."; } } } grouping task-options-grouping { description "A list of options of a task. Each option is a name/value pair (where the value may be absent)."; list option { key "id"; ordered-by user; description "A list of options passed to the task. It is a list of key / value pairs and may be used to model options. Options may be used to identify the role of a task or to pass a channel name to a task."; leaf id { type lmap:identifier; description "An identifier uniquely identifying an option. This identifier is required by YANG to uniquely identify a name value pair but it otherwise has no semantic value"; } leaf name { type string; description "The name of the option."; } leaf value { type string; description "The value of the option."; } } } } ]]>

This module imports definitions from , and the common LMAP module and it references .

file "ietf-lmap-control@2016-10-10.yang" module ietf-lmap-control { namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-control"; prefix "lmapc"; import ietf-yang-types { prefix yang; } import ietf-inet-types { prefix inet; } import ietf-netconf-acm { prefix nacm; } import ietf-lmap-common { prefix lmap; } organization "IETF Large-Scale Measurement Platforms Working Group"; contact "WG Web: WG List: Editor: Juergen Schoenwaelder Editor: Vaibhav Bajpai "; description "This module defines a data model for controlling measurement agents that are part of a Large-Scale Measurement Platform (LMAP). This data model is expected to be implemented by a measurement agent."; revision "2016-10-10" { description "Initial version"; reference "RFC XXX: A YANG Data Model for LMAP Measurement Agents"; } /* * Typedefs */ typedef event-ref { type leafref { path "/lmap/events/event/name"; } description "This type is used by data models that need to reference a configured event source."; } typedef task-ref { type leafref { path "/lmap/tasks/task/name"; } description "This type is used by data models that need to reference a configured task."; } typedef schedule-ref { type leafref { path "/lmap/schedules/schedule/name"; } description "This type is used by data models that need to reference a configured schedule."; } /* * Groupings */ grouping timing-start-end-grouping { description "A grouping that provides start and end times for timing objects."; leaf start { type yang:date-and-time; description "The date and time when the timing object starts to create triggers."; } leaf end { type yang:date-and-time; description "The date and time when the timing object stops to create triggers. It is generally a good idea to always configure an end time and to refresh the configuration of timing object as needed to ensure that agents that loose connectivity to their controller do not continue their tasks forever."; } } /* * Configuration data nodes */ container lmap { description "Configuration of the LMAP agent."; /* * Agent Configuration */ container agent { description "Configuration of parameters affecting the whole measurement agent."; leaf agent-id { type yang:uuid; description "The agent-id identifies a measurement agent with a very low probability of collision. In certain deployments, the agent-id may be considered sensitive and hence this object is optional."; } leaf device-id { type inet:uri; description "The device-id identifies the device running the measurement agent. In certain deployments, the device-id may be considered sensitive and hence this object is optional."; } leaf group-id { type string; description "The group-id identifies a group of measurement agents. In certain deployments, the group-id may be considered less sensitive than the agent-id."; } leaf measurement-point { type string; description "The measurement point indicating where the measurement agent is located on a path."; reference "RFC 7398: A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance"; } leaf report-agent-id { type boolean; must '. != "true" or ../agent-id' { description "An agent-id must exist for this to be set to true."; } default false; description "The 'report-agent-id' controls whether the 'agent-id' is reported to collectors if the 'group-id' is configured. If the 'group-id' is not configured, the agent-id is always reported."; } leaf report-measurement-point { type boolean; must '. != "true" or ../measurement-point' { description "A measurement-point must exist for this to be set to true."; } default false; description "The 'report-measurement-point' controls whether the 'measurement-point' is reported to collectors if the 'measurement-point' is configured."; } leaf controller-timeout { type uint32; units "seconds"; description "A timer is started after each successful contact with a controller. When the timer reaches the controller-timeout, an event (controller-lost) is raised indicating that connectivity to the controller has been lost."; } } /* * Task Configuration */ container tasks { description "Configuration of LMAP tasks."; list task { key name; description "The list of tasks configured on the LMAP agent."; leaf name { type lmap:identifier; description "The unique name of a task."; } uses lmap:registry-grouping; leaf program { type string; nacm:default-deny-write; description "The (local) program to invoke in order to execute the task. If this leaf is not set, then the system will try to identify a suitable program based on the registry information present."; } uses lmap:task-options-grouping { description "The list of task specific options."; } leaf-list tag { type lmap:identifier; description "A set of task specific tags that are reported together with the measurement results to a collector. A tag can be used, for example, to carry the Measurement Cycle ID."; } } } /* * Schedule Instructions */ container schedules { description "Configuration of LMAP schedules. Schedules control which tasks are executed by the LMAP implementation."; list schedule { key name; description "Configuration of a particular schedule."; leaf name { type lmap:identifier; description "The locally-unique, administratively assigned name for this schedule."; } leaf start { type event-ref; mandatory true; description "The event source controlling the start of the scheduled actions."; } choice stop { description "This choice contains optional leafs that control the graceful forced termination of scheduled actions. When the end has been reached, the scheduled actions should be forced to terminate the measurements. This may involve being active some additional time in order to properly finish the action's activity (e.g., waiting for any still outstanding messages)."; leaf end { type event-ref; description "The event source controlling the graceful forced termination of the scheduled actions."; } leaf duration { type uint32; units "seconds"; description "The duration controlling the graceful forced termination of the scheduled actions."; } } leaf execution-mode { type enumeration { enum sequential { value 1; description "The actions of the schedule are executed sequentially."; } enum parallel { value 2; description "The actions of the schedule are executed concurrently"; } enum pipelined { value 3; description "The actions of the schedule are executed in a pipelined mode. Output created by an action is passed as input to the subsequent action."; } } default pipelined; description "The execution mode of this schedule determins in which order the actions of the schedule are executed."; } leaf-list tag { type lmap:tag; description "A set of schedule specific tags that are reported together with the measurement results to a collector."; } leaf-list suppression-tag { type lmap:tag; description "A set of suppression tags that are used to select schedules to be suppressed."; } list action { key name; description "An action describes a task that is invoked by the schedule. Multiple actions are invoked sequentially."; leaf name { type lmap:identifier; description "The unique identifier for this action."; } leaf task { type task-ref; mandatory true; description "The task invoked by this action."; } container parameters { description "This container is a place-holder for run-time parameters defined in task-specific data models augmenting the base lmap control data model."; choice extension { description "This choice is provided to augment in different sets of parameters."; } } uses lmap:task-options-grouping { description "The list of action specific options that are appended to the list of task specific options."; } leaf-list destination { type schedule-ref; description "A set of schedules receiving the output produced by this action. A queue is internally used to pass results to another schedule. The behaviour of an action passing data to its own schedule is implementation specific. Data passed to a sequential or pipelined schedule is received by the schedule's first action. Data passed to a parallel schedule is received by all actions of the schedule."; } leaf-list tag { type lmap:tag; description "A set of action specific tags that are reported together with the measurement results to a collector."; } leaf-list suppression-tag { type lmap:tag; description "A set of suppression tags that are used to select actions to be suppressed."; } } } } /* * Suppression Instructions */ container suppressions { description "Suppression information to prevent schedules or certain actions from starting."; list suppression { key name; description "Configuration of a particular suppression."; leaf name { type lmap:identifier; description "The locally-unique, administratively assigned name for this suppression."; } leaf start { type event-ref; description "The event source controlling the start of the suppression period."; } leaf end { type event-ref; description "The event source controlling the end of the suppression period. If not present, supression continues indefinitely."; } leaf-list match { type lmap:glob-pattern; description "A set of suppression match pattern. The suppression will apply to all schedules (and their actions) that have a matching value in their suppression-tags and to all actions that have a matching value in their suppression-tags."; } leaf stop-running { type boolean; default false; description "If 'stop-running' is true, running schedules and actions matching the suppression will be terminated when suppression is activated. If 'stop-running' is false, running schedules and actions will not be affected if suppression is activated."; } } } /* * Event Instructions */ container events { description "Configuration of LMAP events. Implementations may be forced to delay acting upon the occurance of events in the face of local constraints. An action triggered by an event therefore should not rely on the accuracy provided by the scheduler implementation."; list event { key name; description "The list of event sources configured on the LMAP agent."; leaf name { type lmap:identifier; description "The unique name of an event source."; } choice event-type { description "Different types of events are handled by different branches of this choice. Note that this choice can be extended via augmentations."; case periodic { container periodic { description "A periodic timing object triggers periodically according to a regular interval."; leaf interval { type uint32 { range "1..max"; } units "seconds"; mandatory true; description "The number of seconds between two triggers generated by this periodic timing object."; } uses timing-start-end-grouping; } } case calendar { container calendar { description "A calendar timing object triggers based on the current calendar date and time."; leaf-list month { type lmap:month-or-all; min-elements 1; description "A set of month at which this calendar timing will trigger. The wildcard means all months."; } leaf-list day-of-month { type lmap:day-of-months-or-all; min-elements 1; description "A set of days of the month at which this calendar timing will trigger. The wildcard means all days of a month."; } leaf-list day-of-week { type lmap:weekday-or-all; min-elements 1; description "A set of weekdays at which this calendar timing will trigger. The wildcard means all weekdays."; } leaf-list hour { type lmap:hour-or-all; min-elements 1; description "A set of hours at which this calendar timing will trigger. The wildcard means all hours of a day."; } leaf-list minute { type lmap:minute-or-all; min-elements 1; description "A set of minutes at which this calendar timing will trigger. The wildcard means all minutes of an hour."; } leaf-list second { type lmap:second-or-all; min-elements 1; description "A set of second at which this calendar timing will trigger. The wildcard means all seconds of a minute."; } leaf timezone-offset { type lmap:timezone-offset; description "The timezone in which this calendar timing object will be evaluated. If not present, the systems' local timezone will be used."; } uses timing-start-end-grouping; } } case one-off { container one-off { description "A one-off timing object triggers exactly once."; leaf time { type yang:date-and-time; mandatory true; description "This one-off timing object triggers once at the configured date and time."; } } } case immediate { leaf immediate { type empty; mandatory true; description "This immediate event object triggers immediately when it is configured."; } } case startup { leaf startup { type empty; mandatory true; description "This startup event object triggers whenever the LMAP agent (re)starts."; } } case controller-lost { leaf controller-lost { type empty; mandatory true; description "The controller-lost event object triggers when the connectivity to the controller has been lost for at least 'controller-timeout' seconds."; } } case controller-connected { leaf controller-connected { type empty; mandatory true; description "The controller-connected event object triggers when the connectivity to the controller has been restored after it was lost for at least 'controller-timeout' seconds."; } } } leaf random-spread { type uint32; units seconds; description "This optional leaf adds a random spread to the computation of the event's trigger time. The random spread is a uniformly distributed random number taken from the interval [0:random-spread]."; } leaf cycle-interval { type uint32; units seconds; description "The optional cycle-interval defines the duration of the time interval in seconds that is used to calculate cycle numbers. No cycle number is calculated if the optional cycle-interval does not exist."; } } } } /* * The state subtree provides information about the capabilities * and the current status of the MA. */ container lmap-state { config false; description "A tree exporting state information about the LMAP agent."; container agent { description "Operations state of the measurement agent."; leaf agent-id { type yang:uuid; description "The agent-id identifies a measurement agent with a very low probability of collision. In certain deployments, the agent-id may be considered sensitive and hence this object is optional."; } leaf device-id { type inet:uri; description "The device-id identifies the device running the measurement agent. In certain deployments, the device-id may be considered sensitive and hence this object is optional."; } leaf hardware { type string; mandatory true; description "A short description of the hardware the measurement agent is running on. This should include the version number of the hardware"; } leaf firmware { type string; mandatory true; description "A short description of the firmware the measurement agent is running on. This should include the version number of the firmware."; } leaf version { type string; mandatory true; description "A short description of the software implementing the measurement agent. This should include the version number of the measurement agent software."; } leaf-list tag { type lmap:tag; description "An optional unordered set of tags that provide additional information about the capabilities of the measurement agent."; } leaf last-started { type yang:date-and-time; mandatory true; description "The date and time the measurement agent last started."; } } container tasks { description "Available LMAP tasks, including information about their last execution and their last failed execution."; list task { key name; description "The list of tasks available on the LMAP agent."; leaf name { type lmap:identifier; description "The unique name of a task."; } uses lmap:registry-grouping; leaf version { type string; description "A short description of the software implementing the task. This should include the version number of the measurement task software."; } leaf program { type string; description "The (local) program to invoke in order to execute the task."; } } } container schedules { description "State of LMAP schedules."; list schedule { key name; description "State of a particular schedule."; leaf name { type lmap:identifier; description "The locally-unique, administratively assigned name for this schedule."; } leaf state { type enumeration { enum enabled { value 1; description "The value 'enabled' indicates that the schedule is currently enabled."; } enum disabled { value 2; description "The value 'disabled' indicates that the schedule is currently disabled."; } enum running { value 3; description "The value 'running' indicates that the schedule is currently running."; } enum suppressed { value 4; description "The value 'suppressed' indicates that the schedule is currently suppressed."; } } description "The current state of the schedule."; } leaf storage { type yang:gauge64; units "bytes"; description "The amount of secondary storage (e.g., allocated in a file system) holding temporary data allocated to the schedule in bytes. This object reports the amount of allocated physical storage and not the storage used by logical data records."; } leaf invocations { type yang:counter32; description "Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule."; } leaf suppressions { type yang:counter32; description "Number of suppressed executions of this schedule."; } leaf overlaps { type yang:counter32; description "Number of executions prevented due to overlaps with a previous invocation of this schedule."; } leaf failures { type yang:counter32; description "Number of failed executions of this schedule. A failed execution is an execution where at least one action failed."; } leaf last-invocation { type yang:date-and-time; description "The date and time of the last invocation of this schedule."; } list action { key name; description "The state of the actions associated with this schedule entry."; leaf name { type lmap:identifier; description "The unique identifier for this action."; } leaf state { type enumeration { enum enabled { value 1; description "The value 'enabled' indicates that the action is currently enabled."; } enum disabled { value 2; description "The value 'disabled' indicates that the action is currently disabled."; } enum running { value 3; description "The value 'running' indicates that the action is currently runnning."; } enum suppressed { value 4; description "The value 'suppressed' indicates that the action is currently suppressed."; } } description "The current state of the action."; } leaf storage { type yang:gauge64; units "bytes"; description "The amount of secondary storage (e.g., allocated in a file system) holding temporary data allocated to the schedule in bytes. This object reports the amount of allocated physical storage and not the storage used by logical data records."; } leaf invocations { type yang:counter32; description "Number of invocations of this action. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this action."; } leaf suppressions { type yang:counter32; description "Number of suppressed executions of this action."; } leaf overlaps { type yang:counter32; description "Number of executions prevented due to overlaps with a previous invocation of this action."; } leaf failures { type yang:counter32; description "Number of failed executions of this action."; } leaf last-invocation { type yang:date-and-time; description "The date and time of the last invocation of this action."; } leaf last-completion { type yang:date-and-time; description "The date and time of the last completion of this action."; } leaf last-status { type lmap:status-code; description "The status code returned by the last execution of this action."; } leaf last-message { type string; description "The status message produced by the last execution of this action."; } leaf last-failed-completion { type yang:date-and-time; description "The date and time of the last failed completion of this action."; } leaf last-failed-status { type lmap:status-code; description "The status code returned by the last failed execution of this action."; } leaf last-failed-message { type string; description "The status message produced by the last failed execution of this action."; } } } } container suppressions { description "State of LMAP suppressions."; list suppression { key name; description "State of a particular suppression."; leaf name { type lmap:identifier; description "The locally-unique, administratively assigned name for this suppression."; } leaf state { type enumeration { enum enabled { value 1; description "The value 'enabled' indicates that the suppression is currently enabled."; } enum disabled { value 2; description "The value 'disabled' indicates that the suppression is currently disabled."; } enum active { value 3; description "The value 'active' indicates that the suppression is currently active."; } } description "The current state of the suppression."; } } } } } ]]>

This module imports definitions from and the common LMAP module.

file "ietf-lmap-report@2016-10-10.yang" module ietf-lmap-report { namespace "urn:ietf:params:xml:ns:yang:ietf-lmap-report"; prefix "lmapr"; import ietf-yang-types { prefix yang; } import ietf-lmap-common { prefix lmap; } organization "IETF Large-Scale Measurement Platforms Working Group"; contact "WG Web: WG List: Editor: Juergen Schoenwaelder Editor: Vaibhav Bajpai "; description "This module defines a data model for reporting results from measurement agents, which are part of a Large-Scale Measurement Platform (LMAP), to result data collectors. This data model is expected to be implemented by a collector."; revision "2016-10-10" { description "Initial version"; reference "RFC XXX: A YANG Data Model for LMAP Measurement Agents"; } rpc report { description "The report operation is used by an LMAP measurement agent to submit measurement results produced by measurement tasks to a collector."; input { leaf date { type yang:date-and-time; mandatory true; description "The date and time when this result report was sent to a collector."; } leaf agent-id { type yang:uuid; description "The agent-id of the agent from which this report originates."; } leaf group-id { type string; description "The group-id of the agent from which this report originates."; } leaf measurement-point { type string; description "The measurement-point of the agent from which this report originates."; } list result { description "The list of tasks for which results are reported."; leaf schedule-name { type lmap:identifier; description "The name of the schedule that produced the result."; } leaf action-name { type lmap:identifier; description "The name of the action in the schedule that produced the result."; } leaf task-name { type lmap:identifier; description "The name of the task that produced the result."; } container parameters { description "This container is a place-holder for run-time parameters defined in task-specific data models augmenting the base lmap report data model."; choice extension { description "This choice is provided to augment in different sets of parameters."; } } uses lmap:task-options-grouping { description "The list of options there were in use then the measurement was performed. This list must include both the task specific options as well as the action specific options."; } leaf-list tag { type lmap:tag; description "A tag contains additional information that is passed with the result record to the collector. This is the joined set of tags defined for the task object and the action object. A tag can be used to carry the Measurement Cycle ID."; } leaf event { type yang:date-and-time; description "The date and time of the event that triggered the schedule of the action that produced the reported result values. The date and time does not include any added randomization."; } leaf start { type yang:date-and-time; mandatory true; description "The date and time when the task producing this result started."; } leaf end { type yang:date-and-time; description "The date and time when the task producing this result finished."; } leaf cycle-number { type lmap:cycle-number; description "The optional cycle number is the time closest to the time reported in the event leaf that is a multiple of the cycle-interval of the event that triggered the execution of the schedule. The value is only present if the event that triggered the execution of the schedule has a defined cycle-interval."; } leaf status { type lmap:status-code; mandatory true; description "The status code returned by the execution of this action."; } list conflict { description "The names of tasks overlapping with the execution of the task that has produced this result."; leaf schedule-name { type lmap:identifier; description "The name of a schedule that might have impacted the execution of the task that has produced this result."; } leaf action-name { type lmap:identifier; description "The name of an action within the schedule that might have impacted the execution of the task that has produced this result."; } leaf task-name { type lmap:identifier; description "The name of the task executed by an action within the schedule that might have impacted the execution of the task that has produced this result."; } } list table { description "A list of result tables."; uses lmap:registry-grouping; leaf-list column { type string; description "An ordered list of column labels. The order is determined by the system and must match the order of the columns in the result rows."; } list row { description "The rows of a result table."; leaf-list value { type string; description "The value of a cell in the result row."; } } } } } } } ]]>

The YANG module defined in this memo is designed to be accessed via the NETCONF protocol . The lowest NETCONF layer is the secure transport layer and the mandatory to implement secure transport is SSH . The NETCONF access control model provides the means to restrict access for particular NETCONF users to a pre-configured subset of all available NETCONF protocol operations and content. There are a number of data nodes defined in this YANG module which are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability: This subtree configures general properties of the measurement agent such as its identity, its measurement point or controller timeout. This subtree should only have write access for the system responsible to configure the measurement agent. This subtree configures the tasks that can be invoked by a controller. This subtree should only have write access for the system responsible to configure the measurement agent. Care must be taken to not expose tasks to a controller that can cause damage to the system or the network. This subtree is used by a controller to define the schedules and actions that are executed when certain events occur. Unauthorized access can cause unwanted load on the device or network or it might direct measurement traffic to targets that become victims of an attack. This subtree is used by a controller to define suppressions that can temporarily disable the execution of schedules or actions. Unauthorized access can either disable measurements that should normally take place or it can cause measurements to take place during times when normally no measurements should take place. This subtree is used by a controller to define events that trigger the execution of schedules and actions. Unauthorized access can either disable measurements that should normally take place or it can cause measurements to take place during times when normally no measurements should take place or at frequency that is higher than normally expected. Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: This subtree provides information about the implementation (including version numbers). This information may be used to mount targeted attacks against the implementation. This subtree provides information about the tasks (including version numbers). This information may be used to mount targeted attacks against the implementation. This subtree provides information about the schedules executed on the system. This information may be used to check whether attacks against the implementation are effective. This subtree provides information about the suppressions executed on the system. This information may be used to predict time periods where measurements take place (or do not take place). Some of the RPC operations in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operations and their sensitivity/vulnerability: The report operation is used to send locally collected measurement results to a remote collector. Unauthorized access may leak measurement results. The data model uses a number of identifiers that are set by the controller. Implementors may find these identifiers useful for the identification of resources, e.g., to identify objects in a filesystem providing temporary storage. Since the identifiers used by the YANG data model may allow characters that may be given special interpretation in a specific context, implementations MUST ensure that identifiers are properly mapped into safe identifiers. The data model allows to specify options in the form of name value pairs that are passed to programs. Implementers MUST taken care that option names and values are passed literally to programs. In particular, it MUST be avoided that any shell expansions are performed that may alter the option names and values.

This document registers a URI in the "IETF XML Registry" . Following the format in RFC 3688, the following registrations have been made.

This document registers a YANG module in the "YANG Module Names" registry .

Several people contributed to this specification by reviewing early versions and actively participating in the LMAP working group (apologies to those unintentionally omitted): Timothy Carey, Al Morton, Dan Romascanu, Andrea Soppera, and Barbara Stark. (XXX: complete this list) Juergen Schoenwaelder and Vaibhav Bajpai worked in part on the Leone research project, which received funding from the European Union Seventh Framework Programme [FP7/2007-2013] under grant agreement number 317647. Juergen Schoenwaelder and Vaibhav Bajpai were partly funded by Flamingo, a Network of Excellence project (ICT-318488) supported by the European Commission under its Seventh Framework Programme.

&rfc2119; &rfc6020; &rfc6991; &rfc3688; &rfc5424; &rfc6241; &rfc6242; &rfc6536; &rfc7223; &rfc7398; &rfc7594; &I-D.ietf-lmap-information-model; &I-D.ietf-netconf-server-model;

Sometimes tasks may require complicated parameters that cannot easily be fit into options, i.e., a list of name/value pairs. In such a situation, it is possible to augment the ietf-lmap-control.yang and ietf-lmap-report.yang data models with definitions for more complex parameters. The following example module demontrates this idea using the parameters of UDP latency metrics as an example (although UDP latency metric parameters do not really need such an extension module).

550e8400-e29b-41d4-a716-446655440000 urn:dev:mac:0024befffe804ff1 true S1 E1 sequential A1 update-ping-targets A2 ping-all-targets S3 measurement:ping S2 E1 parallel A1 traceroute target target 2001:db8::1 S3 A2 traceroute target target 2001:db8::2 S3 measurement:traceroute S3 E2 A1 report collector collector https://collector.example.com/ orphaned controller-lost controller-connected measurement:* update-ping-targets /usr/bin/fping-update-targets ping-all-targets /usr/bin/fping traceroute /usr/bin/mtr csv --csv report /usr/bin/lmap-report ippm-udp-latency-client /usr/bin/ippm-udp-latency urn:example:tbd client active E1 3600000 2016-09-01T00:00:00+00:00 2016-11-01T00:00:00+00:00 60 E2 * monday * 4 0 0 +00:00 controller-lost controller-connected ]]>

550e8400-e29b-41d4-a716-446655440000 urn:dev:mac:0024befffe804ff1 Linux x86_64 #1 SMP Debian 3.16.7-ckt9-3~deb8u1 (2015-04-24) lmapd version 0.3 2016-10-31T21:26:06+01:00 fping-update-targets /usr/bin/fping-update-targets fping /usr/bin/fping mtr /usr/bin/mtr report /usr/bin/lmap-report ippm-udp-latency-client /usr/bin/ippm-udp-latency urn:example:tbd client S1 enabled 0 0 0 0 0 A1 enabled 0 0 0 0 0 A2 enabled 0 0 0 0 0 S2 enabled 0 0 0 0 0 A1 enabled 0 0 0 0 0 A2 enabled 0 0 0 0 0 S3 enabled 0 0 0 0 0 A1 enabled 0 0 0 0 0 orphaned enabled ]]>

2015-10-28T13:27:42+02:00 550e8400-e29b-41d4-a716-446655440000 S1 A1 update-ping-targets 2016-03-21T10:48:55+01:00 2016-03-21T10:48:57+01:00 0 S1 A2 ping-all-targets 2016-03-21T10:48:55+01:00 2016-03-21T10:48:57+01:00 0 targetrtt 2001:db8::1 42 2001:db8::2 24 S2 A1 traceroute target target 2001:db8::1 csv --csv 2016-03-21T10:48:55+01:00 2016-03-21T10:48:57+01:00 1 hopiprtt 1 2001:638:709:5::1 10.5 2 ? S2 A2 traceroute target target 2001:db8::2 csv --csv 2016-03-21T10:48:55+01:00 2016-03-21T10:48:57+01:00 1 hopiprtt 1 2001:638:709:5::1 11.8 2 ? ]]>

Note to the RFC Editor: this section should be removed on publication as an RFC.

Why is the device-id configurable? Should the device not report its own id without explicitely configuring it? Note, this would also be a change of the information model. Some objects in the information model (e.g., agent-id) are marked optional because of sensitivity considerations. Since there is an access control model, it would feel more natural to make these objects mandatory in YANG and leave it to the access control model to prevent access to them in deployments where this is needed. /lmap-state/agent/{hardware,firmware,device-id} overlap with /system-state/platform/{machine,os-release/os-version} and the upcoming entity (aka hardware) model provide a URI for hardware components. Shall we remove the {hardware,firmware,device-id} objects and instead add text to section 3 pointing to the places where these objects can be found?

Note to the RFC Editor: this section should be removed on publication as an RFC.

Update the example in an attempt to aligned it with the example in the information model. Added an extension hook to reports so that task-specific parameters can be echoed back to the collector. Updated the example extension module accordingly. Added text and to describe the function and purpose of the three YANG modules. Added a cycle-number type definition. Added the optional cycle-interval to event definitions. Added tags that report additional capabilities of the measurement agent. Added event time and cycle-number to the result report. Renamed the metrics-grouping to registry-grouping. Removed JSON encoding of the examples (they will go into the RESTCONF document).

Tagged /lmap/tasks/task/program with nacm:default-deny-write. Added /lmap-state/schedules/schedule/storage and /lmap-state/schedules/schedule/action/storage. Removed suppress-by-default. Moved the metric list from /report/result into /report/result/table. Conflicts are now reported as a triple (schedule, action, task). Replaced IPv4 address in the examples with IPv6 addresses. Added result/status.

Reworked the reporting data model to align it with the changes in the information model.

Added a mechanism to enforce a runtime limit for schedules. Added security considerations text warning about possible shell expansions of options. Restricted all user-defined names and tags to lmap:identifier. Added security considerations text to make implementors aware of possible security issues if identifiers are naively mapped to say filesystem paths. Schedules and actions now have tags (echoed to the collector) and suppression tags (used for suppression selection). Introduced glob-style pattern to match tags. Added an example module for IPPM udp latency metrics to demonstrate the usage of the extension mechanism. Introduced parameters, an extension point for task/metric specific parameters defined in augmenting YANG modules. Introduced the typedefs event-ref, task-ref, and schedule-ref. Changed schedule/event to schedule/start and added the optional schedule/stop and schedule/duration leafs.

Updated and split examples (config vs state vs report). Refactored the definitions so that common definitions used by both the control and report data models are in the new module ietf-lmap-common. A report is submitted via an RPC operation instead of using a notification. The default execution mode is pipelined. Clarified which action consumes data in sequential, pipelines, and parallel execution mode. Added /lmap/agent/measurement-point, /lmap/agent/report-measurement-point, and /report/measurement-point to configure and report the measurement point. Turned /lmap/suppression into a list /lmap/suppressions/suppression that uses a start and stop event to define the beginning and end of a suppression period. Added controller-lost an controller-ok event choices to /lmap/events/event. Added a metrics-grouping to identify entries in a metric registry and associated roles. Added /lmap-state/schedules to report the status of schedules and their actions. Refactored /lmap-state/tasks to only report the task capabilities.

A task can now reference multiply registry entries. Schedules are triggered by Events instead of Timings; Timings are just one of many possible event sources. Actions feed into other Schedules (instead of Actions within other Schedules). Removed the notion of multiple task outputs. Support for sequential, parallel, and pipelined execution of Actions.