data-model/yang/working/o-ran-sc/near-rt-ric/o-ran-sc-ric-ueec-config-v1.yang

   1 module o-ran-sc-ric-ueec-config-v1 {
   2     yang-version 1.1;
   3     namespace "urn:o-ran:ric:ueec-config:1.0";
   4     prefix ruc;
   5
   6     import o-ran-sc-ric-xapp-desc-v1 {
   7         prefix rxad;
   8     }
   9     import o-ran-sc-root-v1 {
  10         prefix root;
  11     }
  12     import o-ran-sc-types-v1 {
  13         prefix ot;
  14     }
  15
  16     organization
  17       "O-RAN Software Community";
  18     contact
  19       "www.o-ran.org";
  20     description
  21       "This module defines configuration parameters of UEEC xApp
  22
  23        Copyright 2020 the O-RAN Alliance.
  24
  25        Licensed under the Apache License, Version 2.0 (the 'License');
  26        you may not use this file except in compliance with the License.
  27        You may obtain a copy of the License at
  28
  29        http://www.apache.org/licenses/LICENSE-2.0
  30
  31        Unless required by applicable law or agreed to in writing, software
  32        distributed under the License is distributed on an 'AS IS' BASIS,
  33        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  34        See the License for the specific language governing permissions and
  35        limitations under the License.";
  36
  37     revision 2020-02-25 {
  38         description
  39           "Dependency to a common and abstract root module added.";
  40         reference
  41           "O-RAN-OAM-architecture-Specification (O1)";
  42     }
  43     revision 2020-01-29 {
  44         description
  45           "initial revision";
  46         reference
  47           "O-RAN-OAM-Interface-Specification (O1)";
  48     }
  49
  50     grouping subscription {
  51         leaf active {
  52             type boolean;
  53             description
  54               "Subscription status: active or deactive
  55                TODO: please see other subscription modules.";
  56         }
  57         container interfaceId {
  58             container globalENBId {
  59                 leaf plmnId {
  60                     type ot:sized-printable-string;
  61                     description
  62                       "PLMN ID";
  63                 }
  64                 leaf eNBId {
  65                     type uint64;
  66                     description
  67                       "eNB ID";
  68                 }
  69                 description
  70                   "Global ID";
  71             }
  72             description
  73               "gNB interface ID - TODO: is this container needed?";
  74         }
  75         description
  76           "Subscription related parameters";
  77     }
  78
  79     grouping ric-specific-grp {
  80         container config {
  81             uses root:control-base-grp;
  82             leaf namespace {
  83                 type string;
  84                 description
  85                   "The namespace";
  86             }
  87             container control {
  88                 uses subscription;
  89                 description
  90                   "The control object";
  91             }
  92             description
  93               "The container for configuration data";
  94         }
  95         description
  96           "Root object for gNB status";
  97     }
  98
  99     // Inherit from controlled-function
 100     augment "/root:controlled-element/root:controlled-function" {
 101         when "derived-from-or-self(./root:function-type, 'rxad:near-realtime-ran-intelligent-controller')";
 102         uses ric-specific-grp;
 103         description
 104           "Inheritance from root object class.";
 105     }
 106 }