Update module description

[scp/oam/modeling.git] / data-model / yang / working / o-ran-sc / o-ran-du / o-ran-sc-du-hello-world.yang

diff --git a/data-model/yang/working/o-ran-sc/o-ran-du/o-ran-sc-du-hello-world.yang b/data-model/yang/working/o-ran-sc/o-ran-du/o-ran-sc-du-hello-world.yang
index 77115f5..29365eb 100644 (file)
--- a/data-model/yang/working/o-ran-sc/o-ran-du/o-ran-sc-du-hello-world.yang
+++ b/data-model/yang/working/o-ran-sc/o-ran-du/o-ran-sc-du-hello-world.yang
@@ -9,10 +9,20 @@ module o-ran-sc-du-hello-world {
     "www.o-ran-sc.org";
   description
     "This module contains the O-RAN Software Community Distributed Unit
-     API description. This schema was created to support the
-     O-RAN-SC D-Release RSAC use case.
-     This standalone model is the absolute minimum and therefore
-     called 'hello-world'.
+     API description. This API data model describes Cell and Radio Resource
+     Management (RRM) parameters defined by 3GPP in the context
+     of the O-RAN Software Community E-Release and its
+     'Slice Resource Quota Provisioning and Assurance' use case.
+
+     The module is inspired by 3GPP TS 28.541 5G Network Resource Model (NRM).
+     The intent is to reduce the implementation efforts. It is not intended
+     to fragment the industry.
+
+     Due the reduction of the model in terms of scope and completeness this
+     module cannot and must not be used in production environments.
+     The main purpose is to show case the implemented functions by
+     O-RAN-SC O-DU project. The module name 'hello-world' highlights
+     this fact.
 
      Copyright 2021 the O-RAN Software Community.
 
@@ -28,6 +38,19 @@ module o-ran-sc-du-hello-world {
      See the License for the specific language governing permissions and
      limitations under the License.";
 
+  revision 2021-10-01 {
+    description
+      "Updates based on the RSAC use case descriptions of O-RAN-SC E-Release.";
+    reference
+      "https://jira.o-ran-sc.org/browse/OAM-229
+       https://wiki.o-ran-sc.org/download/attachments/35881433/RSY-2021.08.04-OSC-Slice_Discovery%20and%20Registration_v01.pptx?api=v2";
+  }
+  revision 2021-04-08 {
+    description
+      "Updates based on the RSAC call 2021-04-08.";
+    reference
+      "https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878423";
+  }
   revision 2021-03-06 {
     description
       "initial revision";
@@ -90,10 +113,77 @@ module o-ran-sc-du-hello-world {
       description
         "It is proposed to use the network unique identifier of the remote
          network function.
-         Note: After discussion the string was not restricted by a 'length' 
+         Note: After discussion the string was not restricted by a 'length'
          statement of a 'pattern' statement. Please avoid leading and ending
          spaces and consecutive spaces and any character outside of UTF-8-";
     }
+    leaf operational-state {
+      type enumeration {
+        enum DISABLED {
+          description
+            "The resource is not functional.";
+        }
+        enum ENABLED {
+          description
+            "The resource is functional.";
+        }
+      }
+      config false;
+      description
+        "Operational state of a connection. Indicates
+         whether the resource is functional (ENABLED) or not (DISABLED).";
+      reference
+        "3GPP TS 28.625 and ITU-T X.731";
+    }
+    leaf administrative-state {
+      type enumeration {
+        enum LOCKED {
+          description
+            "LOCKED refers to a situation which is NOT considered as
+             ‘normal operation'. Therefore, the O-DU will shut down the
+             connection to the related O-RU, when the value is set to LOCKED.";
+        }
+        enum UNLOCKED {
+          description
+            "UNLOCKED refers to a situation which is considered as
+             'normal operation'. Therefore, the O-DU will establish the
+             connection to the related O-RU, when the value is set to UNLOCKED.";
+        }
+        enum SHUTTING_DOWN {
+          description
+            "This value should not be used. At least the system
+             behavior is not defined.";
+        }
+      }
+      default "LOCKED";
+      description
+        "Administrative state of a connection.";
+      reference
+        "3GPP TS 28.625 and ITU-T X.731";
+    }
+    leaf cell-state {
+      type enumeration {
+        enum IDLE {
+          description
+            "Indicates whether the O-RU is not in use.";
+        }
+        enum INACTIVE {
+          description
+            "Indicates whether the O-RU is in use but not
+             configured to carry traffic.";
+        }
+        enum ACTIVE {
+          description
+            "Indicates whether the O-RU is in use and
+             configured to carry traffic.";
+        }
+      }
+      config false;
+      description
+        "Cell state of the O-RU instance.";
+      reference
+        "3GPP TS 28.625";
+    }
     leaf status {
       type connection-status;
       default "disconnected";
@@ -165,6 +255,7 @@ module o-ran-sc-du-hello-world {
   // Remote procedure calls - actions on root level
 
   rpc connect {
+    status deprecated;
     description
       "An action to establish the connection to a remote network function.";
     input {
@@ -182,6 +273,7 @@ module o-ran-sc-du-hello-world {
   }
 
   rpc disconnect {
+    status deprecated;
     description
       "An action to destroy the connection to a remote network function.";
     input {