Refactor folder structure.

[sim/o1-interface.git] / ntsimulator / yang / x-ran / xran-supervision.yang

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