E2sm Ni Tab

The E2SM-Ni (E2 Service Model - Network Interface ) defines functionalities through E2 Network Interface procedures within xApps.

The interface that is designed for communication between DU/CU and Near-Real Time RIC is called E2. The protocol for the communication over E2 interface is called E2AP.

The E2SM-NI is available in RIC Node Test Case.

Spec Reference :

O-RAN.WG3.RICARCH-v03.00
O-RAN.WG3.E2AP-v02.03
O-RAN.WG3.E2GAP-v02.02
O-RAN.WG3.UCR-v02.00
O-RAN.WG3.E2SM-v02.01
O-RAN.WG3.E2SM-RC-v01.03
O-RAN.WG3.E2SM-KPM-v02.03
O-RAN.WG3.E2SM-CCC-R003-v01.01
O-RAN.WG3.E2SM-NI-v01.00.00

RIC Node

Number of Subscription Details
Subscription
Event Trigger Style (Interface Message Event)
- NI Type
- NI Direction
  - NI Type = X2
  - NI Type = NG
  - NI Type = Xn
    - NG-RAN Node Type (gNB)
    - PLMN Identity
    - Length
    - gNB ID
    - NG-RAN Node Type (ng-eNB)
    - PLMN Identity
    - ng-eNB ID Type
    - ng-eNB ID
  - NI Type = F1
    - NG-RAN Node Type (gNB)
    - PLMN Identity
    - Length
    - gNB ID
    - gNB-DU ID
    - NG-RAN Node Type (ng-eNB)
    - PLMN Identity
    - ng-eNB ID Type
    - ng-eNB ID
    - gNB-DU ID
  - NI Type = E1
    - NG-RAN Node Type (gNB)
    - PLMN Identity
    - Length
    - gNB ID
    - gNB-CU-UP ID
    - NG-RAN Node Type (ng-eNB)
    - PLMN Identity
    - ng-eNB ID Type
    - ng-eNB ID
    - gNB-CU-UP ID
- Procedure Code
- Message Type
- Number of Protocol Tests
  - Message Protocol IE ID

RIC Node

Event Trigger Style (Interface Message Event)

Number of Actions
Action

RIC Node

Number of Control Details
Control
RIC Style Type (Complete Message )
- NI Type
- NI Direction
  - NI Type = X2
  - NI Type = NG
  - NI Type = Xn
    - NG-RAN Node Type (gNB)
    - PLMN Identity
    - Length
    - gNB ID
    - NG-RAN Node Type (ng-eNB)
    - PLMN Identity
    - ng-eNB ID Type
    - ng-eNB ID
  - NI Type = F1
    - NG-RAN Node Type (gNB)
    - PLMN Identity
    - Length
    - gNB ID
    - gNB-DU ID
    - NG-RAN Node Type (ng-eNB)
    - PLMN Identity
    - ng-eNB ID Type
    - ng-eNB ID
    - gNB-DU ID
  - NI Type = E1
    - NG-RAN Node Type (gNB)
    - PLMN Identity
    - Length
    - gNB ID
    - gNB-CU-UP ID
    - NG-RAN Node Type (ng-eNB)
    - PLMN Identity
    - ng-eNB ID Type
    - ng-eNB ID
    - gNB-CU-UP ID
- NI Direction
- Message Priority
- Control Ack Request

Related Measurements

Measurements collected for E2SM related processing are reported on the E2SM Measurements tab.

Number of Subscription Details

Select the Number of Subscription Details. Available in the RIC Node test case.

Range : 1 to 16

Default : 1

Tcl Parameters: E2smNiNumSubs

Subscription

Event Trigger Style

Select the Event trigger Style.

Options : Interface Message Event

Tcl Parameters: E2smNiSubEvtTrigStyle_1

Interface Message Event

Available in the RIC Node test case when Event Trigger Style = Interface Message Event.

NI Type	Select the NI (Network Interface) Type. Options : X2, NG, Xn, F1, E1 Tcl Parameters: E2smNiSubEvtDefNiType_1 When NI (Network Interface) Type = X2, enter the following parameters: Select the Node Type. Options : eNB Enter the PLMN Identity. Range : 6 Hex characters, Default : 000000 Select the eNB ID Type. Options : Macro, Home, Short Macro, Long Macro Enter the eNB ID. Range : 0 to 2097151, default : 0 When NI (Network Interface) Type = NG or Xn or F1 or E1, enter the following parameters: Select the NG-RAN Node Type. Options : gNB or ng-eNB (when type = Xn , F1 or E1). For type = ng-eNB, enter the ng-eNB ID Type (see eNB ID type above) and ng-eNB ID (see eNB ID above) Enter the PLMN Identity. Range : 6 Hex characters, Default : 000000 Enter the Length. Range : 22 to 32, Default : 22 Enter the gNB ID. Range : 0 to 4294967295, default : 0 When NI (Network Interface) Type = F1, in addition to the parameters listed above, enter gNB-DU ID. Range : 0 to 68719476735, default : 0 When NI (Network Interface) Type = E1, in addition to the parameters listed above, enter gNB-CU-UP ID. Range : 0 to 68719476735, default : 0 Tcl Parameters: E2smNiSubEvtDefNiIdNodeType_1 Tcl Parameters: E2smNiSubEvtDefNiIdPlmnId_1 Tcl Parameters: E2smNiSubEvtDefNiIdEnbIdType_1 Tcl Parameters: E2smNiSubEvtDefNiIdEnbId_1 Tcl Parameters: E2smNiSubEvtDefNiIdNgRanNodeType_1 Tcl Parameters: E2smNiSubEvtDefNiIdGnbIdLen_1 Tcl Parameters: E2smNiSubEvtDefNiIdGnbId_1 Tcl Parameters: E2smNiSubEvtDefNiIdGnbDuId_1 Tcl Parameters: E2smNiSubEvtDefNiIdGnbCuUpId_1
NI Direction	Select the NI (Network Interface) Direction. Options : Incoming (default), Outgoing, Both Tcl Parameters: E2smNiSubEvtDefNiDirection_1
Procedure Code	Select the NI (Network Interface) Procedure code. Range : 0 to 255 Default : 0 Tcl Parameters: E2smNiSubEvtDefNiMsgProcCode_1
Message Type	Select the NI (Network Interface) Message Type. Options : E2SM_NI_nothing (default), Incoming (default), E2SM_NI_initiating_message, E2SM_NI_successful_outcome, E2SM_NI_unsuccessful_outcome Tcl Parameters: E2smNiSubEvtDefNiMsgType_1
Number of Protocol Tests	Select the maximum number of Network Interface Protocol Tests in event trigger definition supported by RAN Function. Range : 0 to 15, Default : 0 Enter the Message Protocol IE ID for each protocol test. Tcl Parameters: E2smNiSubEvtDefTestNum_1 Tcl Parameters: E2smNiSubEvtDefMsgProtoIeId_1_1

Select the Number of Actions. Available in the RIC Node test case when Event Trigger Style = Periodic.

Range : 1 to 16

Default : 1

Tcl Parameters: E2smNiSubNumActs_1

Actions

Action Type

Select the Action Type.

Options : Report, Insert, Policy

Tcl Parameters: E2smNiSubActType_1_1

RIC Style Type

Select the RIC Style Type. Each RIC Style Type has its own Action Definition Format, which is described below.

Options :

Complete Message, Partial Message

Default : Complete Message

Tcl Parameters: E2smNiSubActStyleType_1_1

Action Type = Report

Sequence of RAN Parameters

This Sequence of RAN Parameters table is the same for either Complete or Partial Message. When Partial message is selected, enter the Target Protocol IE Identifier.

Range : 0 to 65535, default : 0

Click to add up to 255 RAN Parameters.

Enter the Parameter ID.

Enter the Parameter Value Type. Options : INTEGER, ENUMERATED, BOOLEAN , BIT STRING , OCTET STRING , PRINTABLE STRING

Enter the Parameter Value.

Values are validated based on the type selection listed here:

INTEGER - Range : 0-4294967295

ENUMERATED - Range : 0-4294967295

BOOLEAN - Range : 0-4294967295

BIT STRING- format: [#bits]-[hex chars], example: 16-A0FB (max 256 bits)

OCTET STRING - up to 256 Hex characters

PRINTABLE STRING - up to 256 ASCII characters

Tcl Parameters: E2smNiSubActTgtProtoIeId_1_1

Tcl Parameters: E2smNiSubActRptParamsNum_1_1_1

Tcl Parameters: E2smNiSubActRptParamsId_1_1_1

Tcl Parameters: E2smNiSubActRptParamsValueType_1_1_1

Tcl Parameters: E2smNiSubActRptParamsValue_1_1_1

Action Type = Policy - Message Administration

Number of RAN UE Groups	Enter up to 10 RAN UE Groups for Policy Message Administration. Range : 0 to 10 Default : 0 Tcl Parameters: E2smNiSubActRanUeGrpNum_1_1
RAN UE Group ID	For each RAN UE Group, enter the RAN UE Group ID for Policy Message Administration. Range : 0 to 255 Default : 0 Tcl Parameters: E2smNiSubActRanUeGrpId_1_1_1
RAN Parameters	For each RAN UE Group, enter the RAN Parameters for Policy Message Administration. Click to add up to 255 RAN Parameters. Enter the Parameter ID. Enter the Test Condition. Options : equal, greaterthan, lessthan, contains, present Enter the Parameter Value Type. Options : INTEGER, ENUMERATED, BOOLEAN , BIT STRING , OCTET STRING , PRINTABLE STRING Enter the Parameter Value. Values are validated based on the type selection listed here: INTEGER - Range : 0-4294967295 ENUMERATED - Range : 0-4294967295 BOOLEAN - Range : 0-4294967295 BIT STRING- format: [#bits]-[hex chars], example: 16-A0FB (max 256 bits) OCTET STRING - up to 256 Hex characters PRINTABLE STRING - up to 256 ASCII characters Tcl Parameters: E2smNiSubActRanUeGrpParamsNum_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpParamsId_1_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpParamsCond_1_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpParamsValueType_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpParamsValue_1_1_1
RAN Imperative Policy	For each RAN UE Group, enter the RAN Imperative Policy Parameters for Policy Message Administration. Click to add up to 255 RAN Imperative Policy Parameters. Enter the Parameter ID. Enter the Parameter Value Type. Options : INTEGER, ENUMERATED, BOOLEAN , BIT STRING , OCTET STRING , PRINTABLE STRING Enter the Parameter Value. Values are validated based on the type selection listed here: INTEGER - Range : 0-4294967295 ENUMERATED - Range : 0-4294967295 BOOLEAN - Range : 0-4294967295 BIT STRING- format: [#bits]-[hex chars], example: 16-A0FB (max 256 bits) OCTET STRING - up to 256 Hex characters PRINTABLE STRING - up to 256 ASCII characters Tcl Parameters: E2smNiSubActRanUeGrpPolicyNum_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpPolicyId_1_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpPolicyValueType_1_1_1 Tcl Parameters: E2smNiSubActRanUeGrpPolicyValue_1_1_1

Action Type = Insert - Complete Message

Subsequent Action

Enable Subsequent Action to select the Action Type and the Time to Wait.

Select the Action Type. Options : Continue (default), Halt

Select the Time to Wait.

Options : 1ms, 2ms, 5ms, 10ms, 20ms, 30ms, 40ms, 50ms, 100ms, 200ms, 500ms, 1s, 2s, 5s, 10s, 20s, 60s

Tcl Parameters: E2smNiSubActInsertSubActEn_1_1

Tcl Parameters: E2smNiSubActInsertSubActType_1_1

Tcl Parameters: E2smNiSubActInsertSubActWaitTime_1_1

Following Control

Enter the Control Message Priority. Range : 0 to 5, default : 0

Select the Control Ack Request. Options : NoAck (default), Ack

Tcl Parameters: E2smNiSubActInsertMsgPriority_1_1

Tcl Parameters: E2smNiSubActInsertCtrlAckReqEn_1_1

Tcl Parameters: E2smNiSubActInsertCtrlAckReq_1_1

Number of Control Details

Select the Number of Control Details. Available in the RIC Node test case.

Range : 1 to 16

Default : 1

Tcl Parameters: E2smNiNumCtrls

Control

RIC Style Type

Select the RIC Style Type.

Options : Complete Message

Tcl Parameters: E2smNiCtrlStyle_1

Complete Message

Available in the RIC Node test case when RIC Style Type =Complete Message.

NI Type	Select the NI (Network Interface) Type. Options : X2, NG, Xn, F1, E1 Tcl Parameters: E2smNiCtrlNiType_1 When NI (Network Interface) Type = X2, enter the following parameters: Select the Node Type. Options : eNB Enter the PLMN Identity. Range : 6 Hex characters, Default : 000000 Select the eNB ID Type. Options : Macro, Home, Short Macro, Long Macro Enter the eNB ID. Range : 0 to 2097151, default : 0 When NI (Network Interface) Type = NG or Xn or F1 or E1, enter the following parameters: Select the NG-RAN Node Type. Options : gNB or ng-eNB (when type = Xn , F1 or E1). For type = ng-eNB, enter the ng-eNB ID Type (see eNB ID type above) and ng-eNB ID (see eNB ID above) Enter the PLMN Identity. Range : 6 Hex characters, Default : 000000 Enter the Length. Range : 22 to 32, Default : 22 Enter the gNB ID. Range : 0 to 4294967295, default : 0 When NI (Network Interface) Type = F1, in addition to the parameters listed above, enter gNB-DU ID. Range : 0 to 68719476735, default : 0 When NI (Network Interface) Type = E1, in addition to the parameters listed above, enter gNB-CU-UP ID. Range : 0 to 68719476735, default : 0 Tcl Parameters: E2smNiCtrlNiIdNodeType_1 Tcl Parameters: E2smNiCtrlNiIdPlmnId_1 Tcl Parameters: E2smNiCtrlNiIdEnbIdType_1 Tcl Parameters: E2smNiCtrlNiIdEnbId_1 Tcl Parameters: E2smNiCtrlNiIdNgRanNodeType_1 Tcl Parameters: E2smNiCtrlNiIdGnbIdLen_1 Tcl Parameters: E2smNiCtrlNiIdGnbId_1 Tcl Parameters: E2smNiCtrlNiIdGnbDuId_1 Tcl Parameters: E2smNiCtrlNiIdGnbCuUpId_1
NI Direction	Select the NI (Network Interface) Direction. Options : Incoming (default), Outgoing, Both Tcl Parameters: E2smNiCtrlNiDirection_1
Message Priority	Select the Message Priority. Range : 0 to 4294967295 Default : 0 Tcl Parameters: E2smNiCtrlMsgPriority_1
Control Ack Request	Enable to select the Control Ack Request. Options : NoAck (default), Ack Tcl Parameters: E2smNiCtrlAckReqEn_1 Tcl Parameters: E2smNiCtrlAckReq_1

^ Back to Top