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

   1 module xran-operations {
   2   yang-version 1.1;
   3   namespace "urn:xran:operations:1.0";
   4   prefix "xran-ops";
   5
   6   organization "xRAN Forum";
   7
   8   contact
   9     "www.xran.org";
  10
  11   description
  12     "This module defines the YANG model used for RU operations.
  13
  14     Copyright 2018 the xRAN Forum.
  15
  16     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  17     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26     POSSIBILITY OF SUCH DAMAGE.
  27
  28     Redistribution and use in source and binary forms, with or without
  29     modification, are permitted provided that the following conditions are met:
  30
  31     * Redistributions of source code must retain the above copyright notice,
  32     this list of conditions and the above disclaimer.
  33     * Redistributions in binary form must reproduce the above copyright notice,
  34     this list of conditions and the above disclaimer in the documentation
  35     and/or other materials provided with the distribution.
  36     * Neither the Members of the xRAN Forum nor the names of its
  37     contributors may be used to endorse or promote products derived from
  38     this software without specific prior written permission.";
  39
  40   revision "2018-07-20" {
  41     description
  42       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  43
  44       This version of the model supports v01.00 of the corrsponding xRAN
  45       M-Plane Specification.";
  46     reference "XRAN-FH.MP.0-v01.00";
  47   }
  48
  49   typedef xran-version {
  50     type string {
  51       pattern '[0-9]+(\.[0-9]+)';
  52     }
  53     description
  54       "this type definition is used to represent the version of the xRAN
  55       fronthaul interface.";
  56   }
  57
  58   container operational-info{
  59     config false;
  60     description
  61       "a collection of operational infor for the RU";
  62
  63     container xran-split {
  64       description
  65         "details about the xran split ";
  66       leaf interface-version {
  67         type xran-version;
  68         default "1.0";
  69         description "current version of the xRAN split sdupported by the RU";
  70       }
  71       leaf optional-header-support {
  72         type enumeration {
  73           enum NONE {
  74             description
  75               "Indicates that an RU only supports eCPRI C/U plane headers";
  76           }
  77           enum 1914POINT3 {
  78             description
  79               "Indicates that an RU supports the optional 1914.3 header format
  80                for the C/U plane";
  81           }
  82         }
  83         default NONE;
  84         description
  85           "Placeholder to enable future management plane aspects of 1914.3
  86            headers to be included.";
  87       }
  88       leaf ecpri-concatenation-support {
  89         type boolean;
  90         default false;
  91         description
  92           "This leaf is used to indicate whether the RU supports the optional
  93           eCPRI concatenation capability";
  94       }
  95     }
  96
  97     container operational-state {
  98       description
  99         "Operational state for the Radio Unit";
 100       leaf restart-cause {
 101         type enumeration {
 102           enum POWER-ON {
 103             description
 104               "RU restarted because it was powered on";
 105           }
 106           enum SUPERVISION-WATCHDOG {
 107             description
 108               "RU restarted because it's supervision wathcdog timer wasn't reset
 109               by a NETCONF client (inferring loss of NETCONF connectivity)";
 110           }
 111           enum MPLANE-TRIGGERED-RESTART {
 112             description
 113               "RU restarted because of an M-plane issued  rpc";
 114           }
 115           enum SOFTWARE-FAILURE {
 116             description
 117               "RU restarted because of software failure";
 118           }
 119           enum OTHER-WATCHDOG-TIMER {
 120             description
 121               "RU restarted because of some other non NETCONF watchdog timer";
 122           }
 123           enum UNKNOWN {
 124             description
 125               "The restart reason for the RU is unknown";
 126           }
 127         }
 128         description "the cause for the last restart of the RU";
 129       }
 130     }
 131
 132     leaf re-call-home-no-ssh-timer {
 133       type uint16;
 134       units seconds;
 135       default 60;
 136       description
 137         "The timer used by the xRAN Radio Unit to repeatedley call home to
 138         identified call home servers if it has not already an established SSH
 139         connection to the identified server.";
 140     }
 141   }
 142
 143   rpc reset {
 144     // TODO add nacm statement, e.g., nacm:default-deny-all;
 145     description
 146       "Management plane triggered restart of the radio unit.
 147        A server SHOULD send an rpc reply to the client before
 148        restarting the system.";
 149
 150   }
 151 }