VES Heartbeat and Software Management Feature

[oam/tr069-adapter.git] / netconf-server / schemas / o-ran-heartbeat-management.yang

diff --git a/netconf-server/schemas/o-ran-heartbeat-management.yang b/netconf-server/schemas/o-ran-heartbeat-management.yang
new file mode 100644 (file)
index 0000000..60747a4
--- /dev/null
+++ b/netconf-server/schemas/o-ran-heartbeat-management.yang
@@ -0,0 +1,64 @@
+module o-ran-heartbeat-management {\r
+  yang-version 1.1;\r
+  namespace "urn:o-ran:heartbeat-management:1.0";\r
+  prefix o-ran-hbeat;\r
+\r
+  organization\r
+    "CommScope Inc";\r
+  contact\r
+    "Radio access OneCell <5g@commscope.com>\r
+\r
+     CommScope Inc\r
+     1100 10th Ave Ct SE,\r
+     Hickory,\r
+     NC 28602,\r
+     USA";\r
+  description\r
+    "This module defines operations and configuration for the heart beat event management.";\r
+\r
+  revision 2020-06-30 {\r
+    description\r
+      "PLEASE READ BELOW NOTES BEFORE USING THE MODEL:\r
+       1)  All attributes of TR 196, 181 and OneCell extensions are all covered\r
+           in this same YANG File. In future this shall split into three\r
+           different yang models.\r
+\r
+       2) The reason for using single file is that the SDN-R Configuration APP\r
+          doesn't load the UI properly if the yang model uses augmentations.\r
+          Once the SDN-R Configuration App supports augmented yang files then\r
+          the model could be split into different files.\r
+\r
+       3) For tabular parameters, in yang model 'index' is used as a key and it\r
+          is introduced to indicate the row id/index value in table. ";\r
+    reference\r
+      "Subset of BBF TR-196, TR-181 and CommScope OneCell Vendor Extensions\r
+       Models";\r
+  }\r
+\r
+  container heartbeat {\r
+       \r
+    description\r
+      "This object contains parameters relating to HeartBeat parameters.";\r
+    leaf heartbeatPeriod {\r
+      type uint8 {\r
+        range "0 | 5..60";\r
+      }\r
+      units "minutes";\r
+      default "5";\r
+      description\r
+        "It specifies the time between two emissions of heartbeat notifications. A value of zero implies there is no heartbeat emission. The unit is minute";\r
+    }\r
+    leaf countDownTimer {\r
+      type uint8 {\r
+        range "0..60";\r
+      }\r
+      units "minutes";\r
+      default "0";\r
+      description\r
+        "It represents the current value of a countdown timer. Heartbeat is emitted when value reaches or is set to 0. The unit is minute.";\r
+      reference\r
+        "count down timer to emit next heart beat pulse";\r
+    }\r
+  }\r
+}\r
+\r