netconfcentral logo

ietf-lmap@2015-01-23



  module ietf-lmap {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-lmap";

    prefix lmap;

    import ietf-yang-types {
      prefix yang;
    }
    import ietf-inet-types {
      prefix inet;
    }
    import ietf-interfaces {
      prefix if;
    }

    organization
      "IETF Large-Scale Measurement Platforms Working Group";

    contact
      "WG Web:   <http://tools.ietf.org/wg/lmap/>
     WG List:  <mailto:lmap@ietf.org>

     Editor:   Juergen Schoenwaelder
               <j.schoenwaelder@jacobs-university.de>

     Editor:   Vaibhav Bajpai
               <v.bajpai@jacobs-university.de>";

    description
      "This module defines a data model for Large-Scale Measurement
     Platforms (LMAP).";

    revision "2015-01-23" {
      description "Initial version";
      reference
        "RFC XXX: A YANG Data Model for LMAP Measurement Agents";

    }


    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 "saturdary" {
          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 0;
          description
            "January of the Julian and Gregorian calendar";
        }
        enum "february" {
          value 1;
          description
            "February of the Julian and Gregorian calendar";
        }
        enum "march" {
          value 2;
          description
            "March of the Julian and Gregorian calendar";
        }
        enum "april" {
          value 3;
          description
            "April of the Julian and Gregorian calendar";
        }
        enum "may" {
          value 4;
          description
            "May of the Julian and Gregorian calendar";
        }
        enum "june" {
          value 5;
          description
            "June of the Julian and Gregorian calendar";
        }
        enum "july" {
          value 6;
          description
            "July of the Julian and Gregorian calendar";
        }
        enum "august" {
          value 7;
          description
            "August of the Julian and Gregorian calendar";
        }
        enum "september" {
          value 8;
          description
            "September of the Julian and Gregorian calendar";
        }
        enum "october" {
          value 9;
          description
            "October of the Julian and Gregorian calendar";
        }
        enum "november" {
          value 10;
          description
            "November of the Julian and Gregorian calendar";
        }
        enum "december" {
          value 11;
          description
            "December of the Julian and Gregorian calendar";
        }
      }
      description
        "A type modeling the month in the Julian and Gregorian
       tradition.";
    }

    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.";
    }

    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 timing-start-end-grouping

    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.";
        leaf name {
          type string;
          description
            "The name of the option.";
        }

        leaf value {
          type string;
          description
            "The value of the option.";
        }
      }  // list option
    }  // grouping task-options-grouping

    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 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.";
          }
        }  // choice task-identification

        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.";
        }
      }  // list task
    }  // grouping task-grouping

    container lmap {
      description
        "Configuration of the LMAP agent.";
      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 credentials {
          type string;
          description
            "The credentials of the agent.";
        }

        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';
          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.";
        }
      }  // container agent

      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.";
          }

          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.";
            }

            list destination {
              key "name";
              description
                "A destination receives information from the task
               associated with this action. A queue is internally
               used to pass the information to another (scheduled)
               action.";
              leaf name {
                type string;
                description
                  "The name of this destination (queue) that passes
                 information to another (scheduled) action.";
              }

              leaf-list output {
                type uint16;
                description
                  "The list of outputs of a task directed to another
                 (scheduled) action. If no output is specified,
                 then all output is directed to another (scheduled)
                 action.";
              }

              leaf schedule {
                type leafref {
                  path "/lmap/schedules/schedule/name";
                }
                mandatory true;
                description
                  "The schedule of the (scheduled) action receiving
                 the output.";
              }

              leaf action {
                type leafref {
                  path "/lmap/schedules/schedule[name = current()/../schedule]/action/name";
                }
                mandatory true;
                description
                  "The (scheduled) action receiving the output (the
                 destination consuming the data from the queue).";
              }
            }  // list destination
          }  // list action

          leaf timing {
            type leafref {
              path "/lmap/timings/timing/name";
            }
            mandatory true;
            description
              "The timing source controlling the start of the scheduled
             tasks.";
          }
        }  // list schedule
      }  // container schedules

      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 that
           where suppress-by-default is true.";
        }

        leaf stop-ongoing-tasks {
          type boolean;
          default 'false';
          description
            "Setting 'stop-ongoing-tasks' to true will cause
           running tasks to be terminated if 'enabled' is set
           to true. Otherwise, running tasks will not be
           affected.";
        }

        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.";
        }
      }  // container suppression

      container channels {
        description
          "A channel describes properties of an LMAP control or
         reporting channel.";
        list channel {
          key "name";
          description
            "The list of channels configured on the LMAP agent.";
          leaf name {
            type string;
            description
              "The unique name of a channel.";
          }

          leaf url {
            type inet:uri;
            description
              "The remote endpoint of the channel.";
          }

          leaf credentials {
            type string;
            description
              "The credentials of the channel.";
          }

          leaf interface {
            type leafref {
              path "/if:interfaces/if:interface/if:name";
            }
            description
              "The local interface to use for reaching the remote
             endpoint of the channel.";
          }
        }  // list channel
      }  // container channels

      container tasks {
        description
          "Configuration of LMAP tasks.";
        uses task-grouping;
      }  // container tasks

      container timings {
        description
          "Configuration of LMAP timings.

         Implementations may be forced to delay acting
         upon triggers in the face of local constraints.
         A task triggered therefore not rely on the accuracy
         provided by the scheduler implementation.";
        list timing {
          key "name";
          description
            "The list of timings configured on the LMAP agent.";
          leaf name {
            type string;
            description
              "The unique name of a timing.";
          }

          choice timing-type {
            description
              "Different types of timing objects are handled by
             different branches of this choices.";
            container periodic {
              description
                "A periodic timing object triggers periodically
                 driven by 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 timing object with an interval of
                    0 milliseconds will therefore never trigger.";
              }

              uses timing-start-end-grouping;
            }  // container periodic
            container calendar {
              description
                "A calendar timing object trigger based on the
                 current calendar date and time.";
              leaf-list month {
                type month;
                description
                  "A month at which this calendar timing will
                   trigger.";
              }

              leaf-list weekday {
                type weekday;
                description
                  "A weekday at which this calendar timing will
                   trigger.";
              }

              leaf-list day-of-months {
                type int8 {
                  range "-31..-1 | 1..31";
                }
                description
                  "A day in the months at which this calendar
                   timing will trigger. Negative numbers indicate
                   days counted backwards from the end of the
                   months.";
              }

              leaf-list hour {
                type int8 {
                  range "0..23";
                }
                description
                  "An hour at which this calendar timing will
                   trigger.";
              }

              leaf-list minute {
                type int8 {
                  range "0..59";
                }
                description
                  "A minute at which this calendar timing will
                   trigger.";
              }

              leaf-list second {
                type int8 {
                  range "0..59";
                }
                description
                  "A second at which this calendar timing will
                   trigger.";
              }

              leaf timezone-offset {
                type timezone-offset;
                description
                  "The timezone in which this calendar timing
                   object will be evaluated.";
              }

              uses timing-start-end-grouping;
            }  // container calendar
            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.";
            }
            leaf immediate {
              type empty;
              mandatory true;
              description
                "This immediate timing object triggers immediately
                 when it is configured.";
            }
            leaf startup {
              type empty;
              mandatory true;
              description
                "This startup timing object triggers whenever the
                 LMAP agent (re)starts.";
            }
          }  // choice timing-type

          leaf random-spread {
            type int32;
            units "milliseconds";
            description
              "This optional leaf adds a random spread to the
           computation of the trigger.";
          }
        }  // list timing
      }  // container timings
    }  // container lmap

    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.";
        }
      }  // container agent

      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 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.";
            }
          }  // choice task-identification

          leaf last-execution {
            type yang:date-and-time;
            description
              "The date and time of the last invocation of this task.";
          }

          leaf last-status {
            type string;
            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-execution {
            type yang:date-and-time;
            description
              "The date and time of the last failed invocation
             of this task.";
          }

          leaf last-failed-status {
            type string;
            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.";
          }
        }  // list task
      }  // container tasks
    }  // container lmap-state

    notification report {
      description
        "The result record produced by a certain task.";
      leaf date {
        type yang:date-and-time;
        mandatory true;
        description
          "The date and time when this report was sent.";
      }

      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.";
      }

      uses task-grouping;

      container header {
        description
          "The header of the result records.";
        leaf-list column {
          type string;
          description
            "A header of a column in the result rows.";
        }
      }  // container header

      list row {
        description
          "The rows of the result record.";
        leaf start {
          type yang:date-and-time;
          mandatory true;
          description
            "The date and time when the measurement producing
           this result row started.";
        }

        leaf end {
          type yang:date-and-time;
          description
            "The date and time when the measurement producing
           this result row stopped.";
        }

        leaf-list conflict {
          type string;
          description
            "The name of a task overlapping with the execution
           of the task that has produced this result record.";
        }

        leaf cross-traffic {
          type uint64;
          description
            "The number of bytes of non-measurement traffic on
           the measurement interface(s) during the measurement
           period.";
        }

        leaf-list value {
          type string;
          description
            "The value of a cell in the result.";
        }
      }  // list row
    }  // notification report
  }  // module ietf-lmap