X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ntsimulator%2Fyang%2Fx-ran%2Fxran-supervision.yang;fp=ntsimulator%2Fyang%2Fx-ran%2Fxran-supervision.yang;h=72bfb1d252da768b79724794d60d79a127068471;hb=1f1479ff8ce3a268acb7b70a32bb789d859a915b;hp=0000000000000000000000000000000000000000;hpb=34ec819462d5f81ceeb723e47467bf50a8454f34;p=sim%2Fo1-interface.git

diff --git a/ntsimulator/yang/x-ran/xran-supervision.yang b/ntsimulator/yang/x-ran/xran-supervision.yang
new file mode 100644
index 0000000..72bfb1d
--- /dev/null
+++ b/ntsimulator/yang/x-ran/xran-supervision.yang
@@ -0,0 +1,103 @@
+module xran-supervision {
+  yang-version 1.1;
+  namespace "urn:xran:supervision:1.0";
+  prefix "xran-supervision";
+
+  import ietf-yang-types {
+    prefix yang;
+  }
+
+  organization "xRAN Forum";
+
+  contact
+    "www.xran.org";
+
+  description
+    "This module defines the configuration data and supervision RPCs that are
+    used by the NETCONF client and NETCONF server to detect loss of NETCONF
+    connectivity.
+
+    Copyright 2018 the xRAN Forum.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the above disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the above disclaimer in the documentation
+    and/or other materials provided with the distribution.
+    * Neither the Members of the xRAN Forum nor the names of its
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.";
+
+  revision "2018-07-20" {
+    description
+      "version 1.0.0 - First release of the xRAN YANG M-Plane models.
+
+      This version of the model supports v01.00 of the corrsponding xRAN
+      M-Plane Specification.";
+    reference "XRAN-FH.MP.0-v01.00";
+  }
+
+  rpc supervision-watchdog-reset {
+    description
+      "rpc to reset the watchdog timer";
+    input {
+
+      leaf supervision-notification-interval {
+        type uint16;
+        units seconds;
+        default 60;
+        description
+          "The interval in seconds at which supervision notifications are sent.
+          If not specified the default value of 60 seconds shall apply.";
+      }
+      leaf guard-timer-overhead {
+        type uint16;
+        units seconds;
+        default 10;
+        description
+          "This is overhead added to the supervision timer used to calculate the
+           supervision wathcdog timer. i.e.,
+
+           supervision timer = notification timer + guard-timer-overhead
+
+           If not specified the default value of 10 seconds shall apply.
+
+           Failure to send this rpc again within the timeout sets the radio into
+           'loss of supervision' state.
+
+           NOTE - The supervision timer MUST not be less that the confimed
+           timeout timer (when the feature is supported).
+
+           This type of constraint (using an RPCs input) cannot be formally
+           expressed in YANG.";
+      }
+    }
+  }
+
+  notification supervision-notification {
+    description
+      "Notification to indicate that NETCONF management interface is up
+      and also indicate the values of the timers for this NETCONF session";
+
+    leaf next-update-at {
+      type yang:date-and-time;
+      description
+        "Indicates the time when the next supervision notification is expected.";
+    }
+  }
+}