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;
}
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).";
revision "2015-07-03" {
description
"Initial version";
reference
"RFC XXX: A YANG Data Model for LMAP Measurement Agents";
}
/*
* Typedefs
*/
typedef weekday {
type enumeration {
enum sunday {
value 0;
description "Sunday of the week";
}
enum monday {
value 1;
description "Monday of the week";
}
enum tuesday {
value 2;
description "Tuesday of the week";
}
enum wednesday {
value 3;
description "Wednesday of the week";
}
enum thursday {
value 4;
description "Thursday of the week";
}
enum friday {
value 5;
description "Friday of the week";
}
enum saturday {
value 6;
description "Saturday of the week";
}
}
description
"A type modeling the weekdays in the Greco-Roman
tradition.";
}
typedef month {
type enumeration {
enum january {
value 1;
description "January of the Julian and Gregorian calendar";
}
enum february {
value 2;
description "February of the Julian and Gregorian calendar";
}
enum march {
value 3;
description "March of the Julian and Gregorian calendar";
}
enum april {
value 4;
description "April of the Julian and Gregorian calendar";
}
enum may {
value 5;
description "May of the Julian and Gregorian calendar";
}
enum june {
value 6;
description "June of the Julian and Gregorian calendar";
}
enum july {
value 7;
description "July of the Julian and Gregorian calendar";
}
enum august {
value 8;
description "August of the Julian and Gregorian calendar";
}
enum september {
value 9;
description "September of the Julian and Gregorian calendar";
}
enum october {
value 10;
description "October of the Julian and Gregorian calendar";
}
enum november {
value 11;
description "November of the Julian and Gregorian calendar";
}
enum december {
value 12;
description "December of the Julian and Gregorian calendar";
}
}
description
"A type modeling the month in the Julian and Gregorian
tradition.";
}
typedef wildcard {
type string { pattern '\*'; }
description
"A wildcard for calendar scheduling entries.";
}
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 use in the yang:date-and-time
type. The value Z is equivalent to +00:00. The value -00:00
indicates and unknown time-offset.";
}
/*
* 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.";
}
}
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 "name";
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.";
// XXX This is kind of broken since making the option name
// XXX a key means that a certain option may only appear once.
// XXX This is not workable since some tests require a list of
// XXX targets. Turning this into a leaf-list of args also
// XXX does not work since YANG requires leaf-list values to
// XXX be unique. Oops.
leaf name {
type string;
description
"The name of the option.";
}
leaf value {
type string;
description
"The value of the option.";
}
}
}
grouping task-grouping {
description
"A grouping that defines the configuration of a task.";
list task {
key name;
description
"The list of tasks configured on the LMAP agent.";
leaf name {
type string;
description
"The unique name of a task.";
}
choice task-identification {
mandatory true;
description
"Information that identifies the task.";
leaf-list registry {
type inet:uri;
description
"A registry entry identifying the metrics a measurement
task supports.";
}
leaf program {
type string;
description
"The (local) program to invoke in order to execute
the task.";
}
}
uses task-options-grouping {
description
"The list of task specific options.";
}
leaf-list tag {
type string;
description
"A tag contains additional information that is passed
with the result record to the collector. A tag can be
used to carry the Measurement Cycle ID.";
}
leaf suppress-by-default {
type boolean;
default true;
description
"Indicates whether the task will be suppressed by
a default supression.";
}
}
}
/*
* Configuration data nodes
*/
container lmap {
description
"Configuration of the LMAP agent.";
/*
* Common Information Objects: 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 a property of 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 report-agent-id {
type boolean;
default false;
// XXX: write a must expression that requires
// group-id to be configured when this is true?
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 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, 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.";
}
}
/*
* Common Information Objects: Schedules
*/
container schedules {
description
"Configuration of LMAP schedules. Schedules control with
tasks are executed by the LMAP implementation.";
list schedule {
key name;
description
"Configuration of a particular schedule.";
leaf name {
type string;
description
"The locally-unique, administratively assigned name for
this scheduled task.";
}
leaf event {
type leafref {
path "/lmap/events/event/name";
}
mandatory true;
description
"The event source controlling the start of the scheduled
tasks.";
}
list action {
key name;
description
"An action describes a task that is invoked by the
schedule. Multiple actions are invoked sequentially.";
leaf name {
type string;
description
"The unique identifier for this action.";
}
leaf task {
type leafref {
path "/lmap/tasks/task/name";
}
mandatory true;
description
"The tasks invoked by this action.";
}
uses task-options-grouping {
description
"The list of action specific options that are
appended to the list of task specific options.";
}
leaf-list destination {
type leafref {
path "/lmap/schedules/schedule/name";
}
description
"A schedule of 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.";
}
}
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.";
}
}
mandatory true;
description
"The execution mode of this schedule determins in
which order the actions of the schedule are executed.";
}
}
}
/*
* Suppression
*/
container suppression {
description
"Suppression information to prevent schedules to start
certain tasks.";
leaf enabled {
type boolean;
default false;
description
"Setting 'enabled' to true will suppress all tasks for
which suppress-by-default is true.";
}
leaf stop-running {
type boolean;
default false;
description
"Setting 'stop-running' to true will cause running
tasks to be terminated if suppression is enabled
(the 'enabled' leaf is set to true). Otherwise,
running tasks will not be affected if suppression
is enabled.";
}
leaf start {
type yang:date-and-time;
description
"The date and time when supression starts to
become effective. If not present, supression
becomes effective immeditately when 'enabled'
is set to true.";
}
leaf end {
type yang:date-and-time;
description
"The date and time when supression stops to
be effective. If not present, supression
continues indefinite until 'enabled' is set
to false.";
}
leaf-list task {
type leafref {
path "/lmap/tasks/task/name";
}
description
"A specific task to suppress. If no tasks are
listed, then all tasks will be suppressed.";
}
leaf-list schedule {
type leafref {
path "/lmap/schedules/schedule/name";
}
description
"A specific schedule to suppress. If no schedules
are listed, then all schedules will be suppressed.";
}
}
/*
* Common Information Objects: Task Configurations
*/
container tasks {
description
"Configuration of LMAP tasks.";
uses task-grouping;
}
/*
* Common Information Objects: Event Information
*/
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 string;
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;
units "milliseconds";
mandatory true;
description
"The number of milliseconds between two triggers
generated by this periodic timing object.
The execution system must not generate triggers
for periodic timing objects that have a interval
value of 0. A periodic timing object with an
interval of 0 milliseconds will therefore never
trigger.";
}
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 union {
type month;
type wildcard;
}
description
"A month at which this calendar timing will
trigger. The wildcard means all months.";
}
leaf-list weekday {
type union {
type weekday;
type wildcard;
}
description
"A weekday at which this calendar timing will
trigger. The wildcard means all weekdays.";
}
leaf-list day-of-month {
type union {
type int8 { range "-31..-1 | 1..31"; }
type wildcard;
}
description
"A day in the month at which this calendar
timing will trigger. Negative numbers indicate
days counted backwards from the end of the
months. The wildcard means all days of a month.";
}
leaf-list hour {
type union {
type int8 { range "0..23"; }
type wildcard;
}
description
"An hour at which this calendar timing will
trigger. The wildcard means all hours of a day.";
}
leaf-list minute {
type union {
type int8 { range "0..59"; }
type wildcard;
}
description
"A minute at which this calendar timing will
trigger. The wildcard means all minutes of
an hour.";
}
leaf-list second {
type union {
type int8 { range "0..59"; }
type wildcard;
}
description
"A second at which this calendar timing will
trigger. The wildcard means all seconds of
a minute.";
}
leaf timezone-offset {
type timezone-offset;
description
"The timezone in which this calendar timing
object will be evaluated.";
}
uses timing-start-end-grouping;
}
}
case one-off {
leaf one-off-time {
type yang:date-and-time;
mandatory true;
description
"This one-off timing object triggers once at the
configured one-off-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.";
}
}
}
leaf random-spread {
type int32;
units milliseconds;
description
"This optional leaf adds a random spread to the
computation of the trigger.";
}
}
}
}
/*
* 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;
mandatory true;
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;
mandatory true;
description
"The device-id identifies a property of 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 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 string;
description
"The unique name of a task.";
}
choice task-identification {
mandatory true;
description
"Information that identifies the task.";
leaf-list registry {
type inet:uri;
description
"The registry entry identifying the configured task.";
}
leaf program {
type string;
description
"The (local) program to invoke in order to execute
the task.";
}
}
leaf last-completion {
type yang:date-and-time;
description
"The date and time of the last completion of this task.";
}
leaf last-status {
type status-code;
description
"The status code returned by the last execution of
this task.";
}
leaf last-message {
type string;
description
"The status message produced by the last execution
of this task.";
}
leaf last-failed-completion {
type yang:date-and-time;
description
"The date and time of the last failed invocation
of this task.";
}
leaf last-failed-status {
type status-code;
description
"The status code returned by the last failed execution
of this task. ";
}
leaf last-failed-message {
type string;
description
"The status message produced by the last failed
execution of this task.";
}
}
}
}
}