Support of WG4 OpenFronthaul Management-Plane VES
[scp/oam/modeling.git] / data-model / yang / working / o-ran-sc / o-ran-sc-topology / o-ran-sc-topology-common.yang
index ed48d35..fd1cfcf 100644 (file)
@@ -6,14 +6,17 @@ module o-ran-sc-topology-common {
   import ietf-interfaces {
     prefix if;
   }
+  import tapi-common {
+    prefix tapi-common;
+  }
 
   organization
     "O-RAN Software Community";
   contact
     "www.o-ran.org";
   description
-    "This module contains YANG definitions for the O-RAN Topology augmentation 
-     of TAPI Topology used as network model. 
+    "This module contains YANG definitions for the O-RAN Topology augmentation
+     of TAPI Topology used as network model.
 
      Copyright 2022 the O-RAN Software Community.
 
@@ -29,78 +32,95 @@ module o-ran-sc-topology-common {
      See the License for the specific language governing permissions and
      limitations under the License.";
 
+  revision 2022-05-26 {
+    description
+      "SCTP protocol added for E2 interfaces";
+    reference
+      "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-269";
+  }
+  revision 2022-03-06 {
+    description
+      "Initial revision";
+    reference
+      "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-255";
+  }
   revision 2022-02-05 {
     description
       "Initial revision";
     reference
       "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-248
        O-RAN.WG1.O-RAN-Architecture-Description
-       Chapter: 1.3.1  Definitions";
+       Chapter: 1.3.1\tDefinitions";
   }
 
   // O-RAN functional identity types
 
   identity function-type {
     description
-      "Base identity as abstract function type for by O-RAN Alliance and others 
-       entities. 
-       An unique identification of a (network) function. 
+      "Base identity as abstract function type for by O-RAN Alliance and others
+       entities.
+       An unique identification of a (network) function.
 
        This identity is abstract and MUST NOT be used for alarms.";
-
     reference
       "O-RAN.WG1.O-RAN-Architecture-Description
-       Chapter: 1.3.1  Definitions
+       Chapter: 1.3.1\tDefinitions
        https://jira.o-ran-sc.org/browse/OAM-248";
   }
 
   identity smo {
     base function-type;
     description
-      "An identity corresponding to an 
+      "An identity corresponding to an
        O-RAN Service Management and Orchestration Function (SMO).";
   }
 
+  identity o-cloud {
+    base function-type;
+    description
+      "An identity corresponding to an O-RAN Cloud component (O-Cloud).";
+  }
+
   identity non-rt-ric {
     base function-type;
     description
-      "An identity corresponding to an 
-       O-RAN Service Management and Orchestration SMO component corresponding to 
+      "An identity corresponding to an
+       O-RAN Service Management and Orchestration SMO component corresponding to
        a Non-real-time RAN Intelligent Controller Function (Near-RT-RIC).";
   }
 
   identity oam-controller {
     base function-type;
     description
-      "An identity corresponding to an 
-       O-RAN Service Management and Orchestration SMO component corresponding to 
-       an Operation and Maintenance Controller Controller Function 
+      "An identity corresponding to an
+       O-RAN Service Management and Orchestration SMO component corresponding to
+       an Operation and Maintenance Controller Controller Function
        (OAM Controller).";
   }
 
   identity ves-collector {
     base function-type;
     description
-      "An identity corresponding to an 
-       O-RAN Service Management and Orchestration SMO component corresponding to 
-       an (Virtual) Event Streaming Collector Function 
+      "An identity corresponding to an
+       O-RAN Service Management and Orchestration SMO component corresponding to
+       an (Virtual) Event Streaming Collector Function
        (VES Collector).";
   }
 
   identity message-router {
     base function-type;
     description
-      "An identity corresponding to an 
-       O-RAN Service Management and Orchestration SMO component corresponding to 
+      "An identity corresponding to an
+       O-RAN Service Management and Orchestration SMO component corresponding to
        Message Router Function (MR).";
   }
 
   identity transport-node {
     base function-type;
     description
-      "An identity corresponding to a Transport Node Function 
-       (such as  Transponders, Muxponders, ROADM, Wavelength Selected Switch, 
-       Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter, 
+      "An identity corresponding to a Transport Node Function
+       (such as  Transponders, Muxponders, ROADM, Wavelength Selected Switch,
+       Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter,
        Optical Multiplexer, Microwave Terminal, Carrier Ethernet Routers, ... .";
   }
 
@@ -115,18 +135,30 @@ module o-ran-sc-topology-common {
     description
       "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
   }
-  
+
+  identity access-and-mobility-management-function {
+    base function-type;
+    description
+      "An identity corresponding to a 3GPP 5G-Core Access and mobility Management Function (AMF).";
+  }
+
+  identity user-plane-function {
+    base function-type;
+    description
+      "An identity corresponding to a3GPP 5G-Core User Plane Function (UPF).";
+  }
+
   identity near-rt-ric {
     base function-type;
     description
       "An identity corresponding to an O-RAN Near real-time RAN intelligent
-       controller Function (NEar-RT-RIC).";
+       controller Function (Near-RT-RIC).";
   }
 
   identity managed-application {
     base function-type;
     description
-      "An identity corresponding to an O-RAN Managed Application Function (MA), 
+      "An identity corresponding to an O-RAN Managed Application Function (MA),
        also called 'xApp'.";
   }
 
@@ -137,15 +169,15 @@ module o-ran-sc-topology-common {
   }
 
   identity o-cu-up {
-    base o-cu-function-type;
+    base function-type;
     description
       "An identity corresponding to an O-RAN Central Unit User Plane Function.";
   }
 
   identity o-cu-cp {
-    base o-cu-function-type;
+    base function-type;
     description
-      "An identity corresponding to an O-RAN Central Unit Control Plane 
+      "An identity corresponding to an O-RAN Central Unit Control Plane
        Function.";
   }
 
@@ -173,25 +205,25 @@ module o-ran-sc-topology-common {
     description
       "An identity corresponding to an User Equipment Function.";
   }
-  
+
   identity o-cloud-ims {
     base function-type;
     description
-      "An identity corresponding to an Infrastructure Management Service 
+      "An identity corresponding to an Infrastructure Management Service
        Function (IMS).";
   }
 
   identity o-cloud-dms {
     base function-type;
     description
-      "An identity corresponding to a 
+      "An identity corresponding to a
        Deployment Management Service Function (DMS).";
   }
 
   // O-RAN interface types
 
   identity interface-type {
-    base if:interface-type
+    base if:interface-type;
     description
       "Base identity for interface types used in RAN, Transport and Core.
        A unique identification of the management interface.
@@ -216,6 +248,30 @@ module o-ran-sc-topology-common {
       "An identity for the e2 interface as defined by O-RAN Alliance.";
   }
 
+  identity n1 {
+    base interface-type;
+    description
+      "An identity for the n1 interface as defined by 3GPP.";
+    reference
+      "3GPP TS 23.501 System architecture for the 5G System (5GS)";
+  }
+
+  identity n2 {
+    base interface-type;
+    description
+      "An identity for the n1 interface as defined by 3GPP.";
+    reference
+      "3GPP TS 23.501 System architecture for the 5G System (5GS)";
+  }
+
+  identity n3 {
+    base interface-type;
+    description
+      "An identity for the n1 interface as defined by 3GPP.";
+    reference
+      "3GPP TS 23.501 System architecture for the 5G System (5GS)";
+  }
+
   identity o1 {
     base interface-type;
     description
@@ -244,4 +300,88 @@ module o-ran-sc-topology-common {
     description
       "An identity for a yang based management interface for transport nodes.";
   }
+
+  // O-RAN-SC LAYER_PROTOCOL_QUALIFIER
+
+  identity LAYER_PROTOCOL_QUALIFIER {
+    base tapi-common:LAYER_PROTOCOL_QUALIFIER;
+    description
+      "Base identity for layer protocol qualifiers used in RAN, Transport and Core.
+       A unique identification of layer protocol qualifiers.
+       Typically the layer protocol qualifier is used to identify the interface
+       protocol, like VES or NETCONF.
+       This identity is abstract and MUST NOT be used as a value.";
+  }
+
+  identity unknown {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for an unknown qualifier.";
+  }
+
+  identity file {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for a FILE transfer protocol qualifier.";
+  }
+
+  identity grpc {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for an generic remote procedure call (gRPC) protocol qualifier.";
+  }
+
+  identity nas {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for a Non-access stratum protocol qualifier.";
+    reference
+      "3GPP TS 24.301\tNon-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3";
+  }
+
+  identity netconf {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for a NETCONF protocol qualifier.";
+  }
+
+  identity radio {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for a Radio protocol qualifier.";
+  }
+
+  identity rest {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for a REST protocol qualifier.";
+  }
+
+  identity restconf {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for a RESTCONF protocol qualifier.";
+  }
+
+  identity ves {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for an REST based event stream (VES) protocol qualifier.";
+  }
+
+  identity ofh {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for an O-RAN Fronthaul based protocol qualifier.";
+  }
+
+  identity sctp {
+    base LAYER_PROTOCOL_QUALIFIER;
+    description
+      "An identity for an Stream Control Transmission Protocol (SCTP)  based
+       protocol qualifier.";
+    reference
+      "RFC 8261,
+       RFC 4960";
+  }
 }