netconf-server/schemas/common/o-ran-heartbeat-management.yang

   1 module o-ran-heartbeat-management {\r
   2   yang-version 1.1;\r
   3   namespace "urn:o-ran:heartbeat-management:1.0";\r
   4   prefix o-ran-hbeat;\r
   5 \r
   6   organization\r
   7     "CommScope Inc";\r
   8   contact\r
   9     "Radio access OneCell <5g@commscope.com>\r
  10 \r
  11      CommScope Inc\r
  12      1100 10th Ave Ct SE,\r
  13      Hickory,\r
  14      NC 28602,\r
  15      USA";\r
  16   description\r
  17     "This module defines operations and configuration for the heart beat event management.";\r
  18 \r
  19   revision 2020-06-30 {\r
  20     description\r
  21       "PLEASE READ BELOW NOTES BEFORE USING THE MODEL:\r
  22        1)  All attributes of TR 196, 181 and OneCell extensions are all covered\r
  23            in this same YANG File. In future this shall split into three\r
  24            different yang models.\r
  25 \r
  26        2) The reason for using single file is that the SDN-R Configuration APP\r
  27           doesn't load the UI properly if the yang model uses augmentations.\r
  28           Once the SDN-R Configuration App supports augmented yang files then\r
  29           the model could be split into different files.\r
  30 \r
  31        3) For tabular parameters, in yang model 'index' is used as a key and it\r
  32           is introduced to indicate the row id/index value in table. ";\r
  33     reference\r
  34       "Subset of BBF TR-196, TR-181 and CommScope OneCell Vendor Extensions\r
  35        Models";\r
  36   }\r
  37 \r
  38   container heartbeat {\r
  39         \r
  40     description\r
  41       "This object contains parameters relating to HeartBeat parameters.";\r
  42     leaf heartbeatPeriod {\r
  43       type uint8 {\r
  44         range "0 | 5..60";\r
  45       }\r
  46       units "minutes";\r
  47       default "5";\r
  48       description\r
  49         "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
  50     }\r
  51     leaf countDownTimer {\r
  52       type uint8 {\r
  53         range "0..60";\r
  54       }\r
  55       units "minutes";\r
  56       default "0";\r
  57       description\r
  58         "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
  59       reference\r
  60         "count down timer to emit next heart beat pulse";\r
  61     }\r
  62   }\r
  63 }\r
  64 \r