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-sc:yang:o-ran-sc-ric-ueec-config-v1";
   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 2021 the O-RAN Software Community.
  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 2021-03-09 {
  38     description
  39       "The namespace was updated according to O-RAN-SC yang guidelines.
  40        The namespace must end with the full module name.";
  41     reference
  42       "https://jira.o-ran-sc.org/browse/OAM-168";
  43   }
  44   revision 2020-02-25 {
  45     description
  46       "Dependency to a common and abstract root module added.";
  47     reference
  48       "O-RAN-OAM-architecture-Specification (O1)";
  49   }
  50   revision 2020-01-29 {
  51     description
  52       "initial revision";
  53     reference
  54       "O-RAN-OAM-Interface-Specification (O1)";
  55   }
  56
  57   grouping subscription {
  58     leaf active {
  59       type boolean;
  60       description
  61         "Subscription status: active or deactive
  62          TODO: please see other subscription modules.";
  63     }
  64     container interfaceId {
  65       container globalENBId {
  66         leaf plmnId {
  67           type ot:sized-printable-string;
  68           description
  69             "PLMN ID";
  70         }
  71         leaf eNBId {
  72           type uint64;
  73           description
  74             "eNB ID";
  75         }
  76         description
  77           "Global ID";
  78       }
  79       description
  80         "gNB interface ID - TODO: is this container needed?";
  81     }
  82     description
  83       "Subscription related parameters";
  84   }
  85
  86   grouping ric-specific-grp {
  87     container config {
  88       uses root:control-base-grp;
  89       leaf namespace {
  90         type string;
  91         description
  92           "The namespace";
  93       }
  94       container control {
  95         uses subscription;
  96         description
  97           "The control object";
  98       }
  99       description
 100         "The container for configuration data";
 101     }
 102     description
 103       "Root object for gNB status";
 104   }
 105
 106   // Inherit from controlled-function
 107
 108   augment "/root:controlled-element/root:controlled-function" {
 109     when "derived-from-or-self(./root:function-type, 'rxad:near-realtime-ran-intelligent-controller')";
 110     uses ric-specific-grp;
 111     description
 112       "Inheritance from root object class.";
 113   }
 114 }