netconfcentral logo

openconfig-probes

HTML

openconfig-probes@2017-09-05



  module openconfig-probes {

    yang-version 1;

    namespace
      "http://openconfig.net/yang/probes";

    prefix oc-probes;

    import ietf-yang-types {
      prefix yang;
    }
    import openconfig-types {
      prefix oc-types;
    }
    import openconfig-extensions {
      prefix oc-ext;
    }
    import openconfig-inet-types {
      prefix oc-inet;
    }
    import openconfig-probes-types {
      prefix oc-probes-types;
    }

    organization "OpenConfig working group";

    contact
      "OpenConfig working group
    www.openconfig.net";

    description
      "This module defines configuration and operational state data
    for the probes.
    A probe consists on a group of tests, each test being a
    source-destination pair to poll. The destination can be either
    IP Address (and eventually port) or URL, depending on the
    nature of the test. The test can send ICMP, UDP, TCP, or HTTP
    requests.
    Each test groups a list of test items, the test results
    being an overall view or average of the items list.
    However, the test preserves only a limited set of history
    items, whose length can be controlled using the history-size.";

    revision "2017-09-05" {
      description "Initial public revision";
      reference
        "0.0.1";

    }

    oc-ext:openconfig-version "0.0.1";

    grouping test-target {
      description
        "Groups the config and state containers
     for an individual test.";
      container target {
        description
          "The target configuration of the test.
       The nature of the target depends on the probe type:
       for HTTP probes we need to provide an URL to poll,
       while ICMP probes require an IP address to monitor.";
        container config {
          description
            "Configuration data for the test target.";
          uses test-target-base;
        }  // container config

        container state {
          config false;
          description
            "Operational data for the test target.";
          uses test-target-base;
        }  // container state
      }  // container target
    }  // grouping test-target

    grouping test-target-base {
      description
        "Targe types for the probe test.";
      leaf address {
        type oc-inet:ip-address;
        description
          "IP address of the target, either IPv4 or IPv6.";
      }

      leaf port {
        type oc-inet:port-number;
        description "Destination port.";
      }

      leaf url {
        type oc-inet:url;
        description "Target URL to probe.";
      }
    }  // grouping test-target-base

    grouping probe-test-config-base {
      description
        "Definition of test details.";
      leaf test-type {
        type oc-probes-types:test-type;
        mandatory true;
        description
          "The type of the probe test.";
      }

      leaf count {
        type yang:counter64;
        description
          "The number of probes per test.";
      }

      leaf interval {
        type yang:counter64;
        description
          "Time between two consecutive probes.";
      }

      leaf source {
        type oc-inet:ip-address;
        description
          "Source address used when probing, either IPv4 or IPv6.";
      }

      leaf history-size {
        type yang:counter64;
        description
          "The number of history entries stored.";
      }

      leaf source-port {
        type oc-inet:port-number;
        description "Source number used.";
      }

      leaf dscp {
        type oc-inet:dscp;
        description "DSCP code points";
      }
    }  // grouping probe-test-config-base

    grouping probe-test-state-history-item-base {
      description
        "The test item results counters and statistics.
       An item presents the results of a single execution
       of the test.
       The results of the test depend on the values
       of the total items, or an average over a certain
       period of time.";
      leaf id {
        type yang:counter64;
        description "The test item ID.";
      }

      leaf timestamp {
        type oc-types:timeticks64;
        description
          "The test timestamp.
         This is not the timestamp when the test
         was actually executed nither when it finished.
         Should be the timestamp when the test has been scheduled.
         It may not be the same with start-timestamp.";
      }

      leaf start-timestamp {
        type oc-types:timeticks64;
        description
          "The timestamp when the test started.";
      }

      leaf end-timestamp {
        type oc-types:timeticks64;
        description
          "The timestamp when the test finished.";
      }

      leaf test-duration {
        type yang:counter64;
        description
          "The duration of the test, in microseconds.";
      }

      leaf failed {
        type boolean;
        description
          "Whether the test failed or succeeded.";
      }

      leaf probes-sent {
        type yang:counter64;
        description
          "Number of test probes sent.";
      }

      leaf probes-received {
        type yang:counter64;
        description
          "Number of test probes received.";
      }

      leaf loss-percentage {
        type oc-types:percentage;
        description "The loss percentage.";
      }

      leaf jitter {
        type yang:counter64;
        description
          "The round trip jitter, in microseconds.";
      }

      leaf min-delay {
        type yang:counter64;
        description
          "The minimum delay recorded during the test, in microseconds.";
      }

      leaf max-delay {
        type yang:counter64;
        description
          "The maximum delay recorded during the test, in microseconds.";
      }

      leaf avg-delay {
        type yang:counter64;
        description
          "The average delay recorded during the test, in microseconds.";
      }

      leaf stddev-delay {
        type yang:counter64;
        description
          "The standard deviation of the delay of the test.";
      }
    }  // grouping probe-test-state-history-item-base

    grouping probe-test-state-history-item {
      description
        "A history item of the probe results.";
      container state {
        config false;
        description
          "A history item of the probe results: operational data only.";
        uses probe-test-state-history-item-base;
      }  // container state
    }  // grouping probe-test-state-history-item

    grouping probe-test-state-history {
      description
        "The history of the test results.";
      container items {
        description
          "The list of items in the probe history.
         The length depends on the history size.";
        list item {
          key "id";
          description
            "List of history items.";
          leaf id {
            type leafref {
              path "../state/id";
            }
            description
              "Reference to the history entry ID.";
          }

          uses probe-test-state-history-item;
        }  // list item
      }  // container items
    }  // grouping probe-test-state-history

    grouping probe-test-state-results {
      description
        "The test results counters and statistics.";
      leaf timestamp {
        type oc-types:timeticks64;
        description
          "The test timestamp.
         This is not the timestamp when the test
         was actually executed nither when it finished.
         Should be the timestamp when the test has been scheduled.
         It may not be the same with start-timestamp.";
      }

      leaf start-timestamp {
        type oc-types:timeticks64;
        description
          "The timestamp when the test started.";
      }

      leaf last-test-timestamp {
        type oc-types:timeticks64;
        description
          "The timestamp when the test finished.";
      }

      leaf test-duration {
        type yang:counter64;
        description
          "The duration of the test, in microseconds.";
      }

      leaf failed {
        type boolean;
        description
          "Whether the test failed or succeeded.";
      }

      leaf probes-sent {
        type yang:counter64;
        description
          "Number of test probes sent.";
      }

      leaf probes-received {
        type yang:counter64;
        description
          "Number of test probes received.";
      }

      leaf loss-percentage {
        type oc-types:percentage;
        description "The loss percentage.";
      }

      leaf jitter {
        type yang:counter64;
        description
          "The round trip jitter, in microseconds.";
      }

      leaf min-delay {
        type yang:counter64;
        description
          "The minimum delay recorded during the test, in microseconds.";
      }

      leaf max-delay {
        type yang:counter64;
        description
          "The maximum delay recorded during the test, in microseconds.";
      }

      leaf avg-delay {
        type yang:counter64;
        description
          "The average delay recorded during the test, in microseconds.";
      }

      leaf stddev-delay {
        type yang:counter64;
        description
          "The standard deviation of the delay of the test.";
      }
    }  // grouping probe-test-state-results

    grouping probe-test-state {
      description
        "Operational data and results for the probes.";
    }  // grouping probe-test-state

    grouping probe-test-config {
      description
        "Definition of test details.";
      leaf name {
        type string;
        mandatory true;
        description
          "The name of the test probe";
      }

      leaf enabled {
        type boolean;
        default 'true';
        description
          "Whether the test is enabled.";
      }

      uses probe-test-config-base;
    }  // grouping probe-test-config

    grouping probe-tests-top {
      description
        "Top-level grouping for the tests withing a probe.";
      list test {
        key "name";
        description
          "List of tests associated with this probe.";
        leaf name {
          type leafref {
            path "../config/name";
          }
          description
            "Reference to the list key";
        }

        container config {
          description
            "Configuration data for the test of this probe.";
          uses probe-test-config;
        }  // container config

        container state {
          config false;
          description
            "Operational state data";
          uses probe-test-config;

          uses probe-test-state;
        }  // container state

        uses test-target;

        container results {
          description
            "Contains the results of the tests.";
          container state {
            config false;
            description
              "Results of this test: operational data only";
            uses probe-test-state-results;
          }  // container state

          container history {
            config false;
            description
              "Historical data of the tests.";
            uses probe-test-state-history;
          }  // container history
        }  // container results
      }  // list test
    }  // grouping probe-tests-top

    grouping probe-config {
      description
        "Definition of probe details.";
      leaf name {
        type string;
        mandatory true;
        description "The name of the probe.";
      }

      leaf enabled {
        type boolean;
        default 'true';
        description
          "Whether the probe is enabled.";
      }
    }  // grouping probe-config

    grouping probe-state {
      description
        "Definition of probes operation data.";
    }  // grouping probe-state

    grouping probes-top {
      description
        "Top-level grouping for probes model";
      list probe {
        key "name";
        description
          "List of probes configured.";
        leaf name {
          type leafref {
            path "../config/name";
          }
          description
            "Reference to the list key";
        }

        container config {
          description
            "Configuration data for the probes.";
          uses probe-config;
        }  // container config

        container state {
          config false;
          description
            "Operational state data";
          uses probe-config;

          uses probe-state;
        }  // container state

        container tests {
          description
            "The tests associated to be executed for the probe.";
          uses probe-tests-top;
        }  // container tests
      }  // list probe
    }  // grouping probes-top

    grouping openconfig-probes-top {
      description
        "The top level grouping of the probes model.";
      container probes {
        description
          "The container containing the list of probes.";
        uses probes-top;
      }  // container probes
    }  // grouping openconfig-probes-top

    uses openconfig-probes-top;
  }  // module openconfig-probes

Summary

  
  
Organization OpenConfig working group
  
Module openconfig-probes
Version 2017-09-05
File openconfig-probes.yang
  
Prefix oc-probes
Namespace http://openconfig.net/yang/probes
  
Cooked /cookedmodules/openconfig-probes/2017-09-05
YANG /src/openconfig-probes@2017-09-05.yang
XSD /xsd/openconfig-probes@2017-09-05.xsd
  
Abstract This module defines configuration and operational state data for the probes. A probe consists on a group of tests, each test bei...
  
Contact
OpenConfig working group
www.openconfig.net

Description

 
This module defines configuration and operational state data
for the probes.
A probe consists on a group of tests, each test being a
source-destination pair to poll. The destination can be either
IP Address (and eventually port) or URL, depending on the
nature of the test. The test can send ICMP, UDP, TCP, or HTTP
requests.
Each test groups a list of test items, the test results
being an overall view or average of the items list.
However, the test preserves only a limited set of history
items, whose length can be controlled using the history-size.

Groupings

Grouping Objects Abstract
openconfig-probes-top probes The top level grouping of the probes model.
probe-config name enabled Definition of probe details.
probe-state Definition of probes operation data.
probe-test-config name enabled test-type count interval source history-size source-port dscp Definition of test details.
probe-test-config-base test-type count interval source history-size source-port dscp Definition of test details.
probe-test-state Operational data and results for the probes.
probe-test-state-history items The history of the test results.
probe-test-state-history-item state A history item of the probe results.
probe-test-state-history-item-base id timestamp start-timestamp end-timestamp test-duration failed probes-sent probes-received loss-percentage jitter min-delay max-delay avg-delay stddev-delay The test item results counters and statistics. An item presents the results of a single execution of the test. The results of the test depend on the values of the total items, or an average over a certain period of time.
probe-test-state-results timestamp start-timestamp last-test-timestamp test-duration failed probes-sent probes-received loss-percentage jitter min-delay max-delay avg-delay stddev-delay The test results counters and statistics.
probe-tests-top test Top-level grouping for the tests withing a probe.
probes-top probe Top-level grouping for probes model
test-target target Groups the config and state containers for an individual test.
test-target-base address port url Targe types for the probe test.

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
probes container The container containing the list of probes.
   probe list List of probes configured.
      config container Configuration data for the probes.
         enabled leaf Whether the probe is enabled.
         name leaf The name of the probe.
      name leaf Reference to the list key
      state container Operational state data
         enabled leaf Whether the probe is enabled.
         name leaf The name of the probe.
      tests container The tests associated to be executed for the probe.
         test list List of tests associated with this probe.
            config container Configuration data for the test of this probe.
               count leaf The number of probes per test.
               dscp leaf DSCP code points
               enabled leaf Whether the test is enabled.
               history-size leaf The number of history entries stored.
               interval leaf Time between two consecutive probes.
               name leaf The name of the test probe
               source leaf Source address used when probing, either IPv4 or IPv6.
               source-port leaf Source number used.
               test-type leaf The type of the probe test.
            name leaf Reference to the list key
            results container Contains the results of the tests.
               history container Historical data of the tests.
                  items container The list of items in the probe history. The length depends on the history size.
                     item list List of history items.
                        id leaf Reference to the history entry ID.
                        state container A history item of the probe results: operational data only.
                           avg-delay leaf The average delay recorded during the test, in microseconds.
                           end-timestamp leaf The timestamp when the test finished.
                           failed leaf Whether the test failed or succeeded.
                           id leaf The test item ID.
                           jitter leaf The round trip jitter, in microseconds.
                           loss-percentage leaf The loss percentage.
                           max-delay leaf The maximum delay recorded during the test, in microseconds.
                           min-delay leaf The minimum delay recorded during the test, in microseconds.
                           probes-received leaf Number of test probes received.
                           probes-sent leaf Number of test probes sent.
                           start-timestamp leaf The timestamp when the test started.
                           stddev-delay leaf The standard deviation of the delay of the test.
                           test-duration leaf The duration of the test, in microseconds.
                           timestamp leaf The test timestamp. This is not the timestamp when the test was actually executed nither when it finished. Should be the timestamp when the test has been scheduled. It may not be the same with start-timestamp.
               state container Results of this test: operational data only
                  avg-delay leaf The average delay recorded during the test, in microseconds.
                  failed leaf Whether the test failed or succeeded.
                  jitter leaf The round trip jitter, in microseconds.
                  last-test-timestamp leaf The timestamp when the test finished.
                  loss-percentage leaf The loss percentage.
                  max-delay leaf The maximum delay recorded during the test, in microseconds.
                  min-delay leaf The minimum delay recorded during the test, in microseconds.
                  probes-received leaf Number of test probes received.
                  probes-sent leaf Number of test probes sent.
                  start-timestamp leaf The timestamp when the test started.
                  stddev-delay leaf The standard deviation of the delay of the test.
                  test-duration leaf The duration of the test, in microseconds.
                  timestamp leaf The test timestamp. This is not the timestamp when the test was actually executed nither when it finished. Should be the timestamp when the test has been scheduled. It may not be the same with start-timestamp.
            state container Operational state data
               count leaf The number of probes per test.
               dscp leaf DSCP code points
               enabled leaf Whether the test is enabled.
               history-size leaf The number of history entries stored.
               interval leaf Time between two consecutive probes.
               name leaf The name of the test probe
               source leaf Source address used when probing, either IPv4 or IPv6.
               source-port leaf Source number used.
               test-type leaf The type of the probe test.
            target container The target configuration of the test. The nature of the target depends on the probe type: for HTTP probes we need to provide an URL to poll, while ICMP probes require an IP address to monitor.
               config container Configuration data for the test target.
                  address leaf IP address of the target, either IPv4 or IPv6.
                  port leaf Destination port.
                  url leaf Target URL to probe.
               state container Operational data for the test target.
                  address leaf IP address of the target, either IPv4 or IPv6.
                  port leaf Destination port.
                  url leaf Target URL to probe.