ntsimulator/yang/x-ran/xran-supervision.yang

   1 module xran-supervision {\r
   2   yang-version 1.1;\r
   3   namespace "urn:xran:supervision:1.0";\r
   4   prefix "xran-supervision";\r
   5 \r
   6   import ietf-yang-types {\r
   7     prefix yang;\r
   8   }\r
   9 \r
  10   organization "xRAN Forum";\r
  11 \r
  12   contact\r
  13     "www.xran.org";\r
  14 \r
  15   description\r
  16     "This module defines the configuration data and supervision RPCs that are\r
  17     used by the NETCONF client and NETCONF server to detect loss of NETCONF\r
  18     connectivity.\r
  19 \r
  20     Copyright 2018 the xRAN Forum.\r
  21 \r
  22     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'\r
  23     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  24     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  25     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE\r
  26     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
  27     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
  28     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  29     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  30     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  31     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  32     POSSIBILITY OF SUCH DAMAGE.\r
  33 \r
  34     Redistribution and use in source and binary forms, with or without\r
  35     modification, are permitted provided that the following conditions are met:\r
  36 \r
  37     * Redistributions of source code must retain the above copyright notice,\r
  38     this list of conditions and the above disclaimer.\r
  39     * Redistributions in binary form must reproduce the above copyright notice,\r
  40     this list of conditions and the above disclaimer in the documentation\r
  41     and/or other materials provided with the distribution.\r
  42     * Neither the Members of the xRAN Forum nor the names of its\r
  43     contributors may be used to endorse or promote products derived from\r
  44     this software without specific prior written permission.";\r
  45 \r
  46   revision "2018-07-20" {\r
  47     description\r
  48       "version 1.0.0 - First release of the xRAN YANG M-Plane models.\r
  49 \r
  50       This version of the model supports v01.00 of the corrsponding xRAN\r
  51       M-Plane Specification.";\r
  52     reference "XRAN-FH.MP.0-v01.00";\r
  53   }\r
  54 \r
  55   rpc supervision-watchdog-reset {\r
  56     description\r
  57       "rpc to reset the watchdog timer";\r
  58     input {\r
  59 \r
  60       leaf supervision-notification-interval {\r
  61         type uint16;\r
  62         units seconds;\r
  63         default 60;\r
  64         description\r
  65           "The interval in seconds at which supervision notifications are sent.\r
  66           If not specified the default value of 60 seconds shall apply.";\r
  67       }\r
  68       leaf guard-timer-overhead {\r
  69         type uint16;\r
  70         units seconds;\r
  71         default 10;\r
  72         description\r
  73           "This is overhead added to the supervision timer used to calculate the\r
  74            supervision wathcdog timer. i.e.,\r
  75 \r
  76            supervision timer = notification timer + guard-timer-overhead\r
  77 \r
  78            If not specified the default value of 10 seconds shall apply.\r
  79 \r
  80            Failure to send this rpc again within the timeout sets the radio into\r
  81            'loss of supervision' state.\r
  82 \r
  83            NOTE - The supervision timer MUST not be less that the confimed\r
  84            timeout timer (when the feature is supported).\r
  85 \r
  86            This type of constraint (using an RPCs input) cannot be formally\r
  87            expressed in YANG.";\r
  88       }\r
  89     }\r
  90   }\r
  91 \r
  92   notification supervision-notification {\r
  93     description\r
  94       "Notification to indicate that NETCONF management interface is up\r
  95       and also indicate the values of the timers for this NETCONF session";\r
  96 \r
  97     leaf next-update-at {\r
  98       type yang:date-and-time;\r
  99       description\r
 100         "Indicates the time when the next supervision notification is expected.";\r
 101     }\r
 102   }\r
 103 }\r