/
O-RAN Information Model (from Eclipse/Papyrus)

O-RAN Information Model (from Eclipse/Papyrus)

Nov 16, 2020

Updates in this release include:

  • PolicyError and related entities

  • PolicyList and related entities

  • PolicyNotification and related entities

 

 

 

1         Diagrams

1.1        Overview

Qualified Name: ORAN::Diagrams

Description:

This IOC represents the logical function CU-CP of gNB and en-gNB

1.1.1        Diagrams

Figure 1‑1: Diagram ORAN Class Diagram

 

 

 

 

 

Figure 1‑2: Diagram ORAN Component Diagram

Figure 1‑3: Diagram ORAN Datatypes

Figure 1‑4: Diagram ORAN Interfaces

Figure 1‑5: Diagram PolicyList

Figure 1‑6: Diagram Policy

Figure 1‑7: Diagram Policy Notification

 

 

 

 

Figure 1‑8: Diagram Policy Error

2         Interfaces

2.1        Overview

Qualified Name: ORAN::Interfaces

2.1.1        Interfaces

2.1.1.1         A1 interface

Qualified Name: ORAN::Interfaces::A1

Description:

The A1 interface is between the Non Real-Time RIC (RGPF) and the Near Real-Time RIC.   This is a streaming interface.

 

The interface is used to provide the following:

- Enrichment Information

- Policy Objectives

- Policy Resources

- Machine Learnings (Feedback)

Applied Stereotypes:

  • OpenModelInterface

  • support: MANDATORY

 

2.1.1.2         A1-EI interface

Qualified Name: ORAN::Interfaces::A1-EI

Applied Stereotypes:

  • OpenModelInterface

  • support: MANDATORY

 

2.1.1.3         A1-ML interface

Qualified Name: ORAN::Interfaces::A1-ML

Applied Stereotypes:

  • OpenModelInterface

  • support: MANDATORY

 

2.1.1.4         A1-P interface

Qualified Name: ORAN::Interfaces::A1-P

Applied Stereotypes:

  • OpenModelInterface

  • support: MANDATORY

  • Reference

  • reference: 08.14-oRAN.WG2-A1AP_v00.00.01

Table 5‑1 Operations for Interface A1-P

 

Operation Name

Parameters

Description

Stereotypes

CreatePolicy

policy

-  type: Policy

-  direction: inout

policyError

-  type: PolicyError

-  direction: out

responseCode

-  type: Integer

-  direction: return

-  Note: Return code on the CreatePolicy operation with the following values:
201- Created
204 - No content
4xx - An error case.

 

Create a policy for a single UE or for multiple UEs.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

QueryPolicy

policyId

-  type: String

-  direction: in

policy

-  type: Policy

-  direction: out

policyList

-  type: PolicyList

-  direction: out

returnCode

-  type: Integer

-  direction: return

-  Note: Return code with the following values
200 - Ok
4xx - Error

pollicyError

-  type: PolicyError

-  direction: out

 

The operation to read a policy ofr a single UE or a group of UEs.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

UpdatePolicyComplete

policyId

-  type: String

-  direction: in

policy

-  type: Policy

-  direction: inout

policyError

-  type: PolicyError

-  direction: out

responseCode

-  type: Integer

-  direction: return

-  Note: Response codes area s follows:
- 201 - Created
- 204 - No conent
- 4xx  - Error

 

The operation to completely update a policy for a single UE or a group of UEs.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

UpdatePolicyPartial

policyId

-  type: String

-  direction: in

policy

-  type: Policy

-  direction: inout

policyError

-  type: PolicyError

-  direction: in

responseCode

-  type: Integer

-  direction: in

-  Note: responseCode values include:
201 - Created
204 - No conent
4xx - error

 

The operation to partially update a policy for a single UE or a group of UEs.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

DeletePolicy

policyId

-  type: String

-  direction: in

-  Note: Policy to be deleted.

policyError

-  type: PolicyError

-  direction: in

responseCode

-  type: String

-  direction: in

-  Note: response codes are as follows:
204 - No Content
4xx - Error

 

The operation to delete a policy for a single UE or a group of UEs.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

NotifyPolicy (FeedbackPolicy)

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

QueryCapabilities

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

Reference

·         reference:  From 2019.08.14-oRAN.WG2-A1AP_v00.00.01

 

 

 

 

2.1.1.5         E1 interface

Qualified Name: ORAN::Interfaces::E1

Description:

The E1 interface specifications facilitates the inter-connection of a gNB-CU-CP and a gNB-CU-UP supplied by different manufacturers.

Applied Stereotypes:

  • OpenModelInterface

  • support: MANDATORY

  • Reference

  • reference: 3GPP TS 38.460

Table 5‑2 Operations for Interface E1

 

Operation Name

Parameters

Description

Stereotypes

Reset

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

GnbCuUpE1Setup

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

GnbCuCpE1Setup

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

GnbCuCpConfigUpdate

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

GnbCuUpConfig Update

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

E1Release

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

GnbCuUpStatusIndication

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

 

 

2.1.1.6         E2 interface

Qualified Name: ORAN::Interfaces::E2

Description:

The purpose of the E2 interface is to allow the RIC to communicate with a RAN to provide guidance, optimization and value added services.  The RIC is assumed to consist of a RIC Platform that includes the "E2 Termination" and one or more xApps, including the "E2 Manager" which is also responsible for terminating E2 Global Procedures (E2 SETUP, etc.)

Interface connecting the near-RT RIC and one or more O-CU-CPs, one or more O-CU-UPs, and one or more O-DUs.

Applied Stereotypes:

  • OpenModelInterface

  • support: MANDATORY

  • Reference

  • reference: ORAN-WG3.E2GAP.0-v0.1

Table 5‑3 Operations for Interface E2

 

Operation Name

Parameters

Description

Stereotypes

RICSubscriptionManagement

 

Used to establish E2 subscriptions on the E2 node consisting of an event trigger and a sequence of actions.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

RIC Indication

 

Used to carry messages from a specific RAN Function to the RIC resulting from a REPORT or INSERT Action

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

NearRTRICServiceReport

 

Near-RT RIC requests that E2 NODE sends a REPORT message to Near-RT RIC and the associated procedure continues in E2 NODE after each occurrence of a defined SUBSCRIPTION
The REPORT service involves following steps:
1.            Near-RT RIC configures a SUBSCRIPTION in the E2 NODE with information used to configure an INDICATION (Report) that is to be performed by E2 NODE with each occurrence of trigger event
2.            During normal functioning of the E2 NODE, a trigger event is detected.
3.            E2 NODE sends INDICATION to Near-RT RIC containing requested REPORT information along with originating Request ID.
4.            Normal functionality continues on the E2 NODE.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

NearRTRICServiceInsert

 

Near-RT RIC requests that E2 NODE sends an INSERT message to Near-RT RIC and suspends the associated procedure in E2 NODE after each occurrence of a defined SUBSCRIPTION
The INSERT service involves following steps:
1.   Near-RT RIC configures a SUBSCRIPTION in the E2 NODE with information used to configure an INDICATION(Insert) along with a wait timer that is to be performed by E2 NODE with each occurrence of EVENT
2.            During normal functioning of the E2 NODE, a trigger event is detected.
3.            E2 Node sends INDICATION to Near-RT RIC containing requested INSERT information along with originating Request ID.
4.            E2 Node suspends or halts the associated procedure after a defined Wait period (wait may be set to zero).
This process may then be followed by either:
-              Near-RT RIC sends a CONTROL message to trigger a new associated procedure or resume suspended procedure using modified call state or information
-              Wait timer associated for suspended procedure expires, and original associated procedure continues or halted

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

NearRTRICServiceControl

 

Near-RT RIC sends a Control message to E2 Node to initiate or resume the suspended associated procedure in the E2 Node
The CONTROL service involves following steps:
1.            Near-RT RIC detects a trigger event. This step may be either triggered by a previous INDICATION sent by E2 Node or internal to Near-RT RIC
2.            Near-RT RIC performs action
3.            Near-RT RIC sends CONTROL request to E2 Node.  This step may contain an information used to identify a previous suspended call process and may request acknowledgement
4.            E2 NODE initiates or resumes a call process
5.            If requested, E2 Node sends a CONTROL Acknowledgement

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

NearRTRICServicePolicy

 

Near-RT RIC requests that E2 Node executes a specific POLICY during functioning of the E2 Node after each occurrence of a defined SUBSCRIPTION
The POLICY service involves following steps:
1.            Near-RT RIC configures a SUBSCRIPTION in the E2 NODE with information used to configure a POLICY that is to be performed by E2 NODE with each occurrence of trigger event
2.            During normal functioning of the E2 NODE, a trigger event is detected.
3.            E2 NODE modifies ongoing call process according to information contained in the POLICY description statement
4.            Normal functionality continues on the E2 NODE.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

NearRTRICServiceUpdate

 

a E2 NODE initiated procedure to inform Near-RT RIC of changes to list of supported Near-RT RIC services and mapping of services to functions.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

RANConfigurationUpdate

 

a E2 node-initiated procedure to inform Near-RT RIC of changes to RAN configuration information.

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

InterfaceManagement

 

E2 set-up, E2 reset, Reporting of General Error Situations

 

 

OpenModelOperation

·         isOperationIdempotent:  false

·         isAtomic:  false

·         support: MANDATORY

 

 

 

 

2.1.1.7         F1-c interface

Qualified Name: ORAN::Interfaces::F1-c

Description: