hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.1 NETCONF operations | The O-RU shall use the ietf-yang-library mode, as specified in IETF RFC 8525 [59] to signal the namespaces of the YANG models supported by the NETCONF Server. When the O-RU signals it supports the YANG module for NETCONF Monitoring, as specified in IETF RFC 6022 [67], an O-RU Controller shall be able to retrieve the models from the O-RU using the <get-schema> operation. Clause 9 describes NETCONF standard operation (edit-config/get-config/get) as specified in clause 7 of IETF RFC 6241 [3] which belongs to the CM in Module to modify/retrieve any parameters in YANG modules. Examples below use o-ran-hardware as an example YANG module. The following scenarios are feasible for Configuration Management purposes: • 1 phase (modify) operation using writable running datastore. • 2 phase (modify/commit) operation using candidate datastore. • 3 phase (modify/commit/confirm) operation using candidate datastore. As described in clause 6.6, the NETCONF client can use sub-tree based <filter> and XPath based <filter> to recover particular sub-trees from the O-RU. When using XPath filtering, the O-RU returns a node-set which matches the criteria expressed in the XPath. An example of a get operation with XPath based filtering is shown in Figure 9.1.1-1. <rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <get> <source> <running/> </source> <!-- get all critical alarms --> <filter xmlns:o-ran-fm="urn:o-ran:fm:1.0" type="xpath" select="/o-ran-fm:active-alarm-list/o-ran-fm:active-alarms[o-ran-fm:fault- severity='CRITICAL']"/> </get> </rpc> Figure 9.1.1-1: Example of filtering based on XPath |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.2 Retrieve state | O-RU Controller is able to retrieve state which is defined in o-ran-hardware by using NETCONF <get> procedure, as illustrated in Figure 9.1.2-1. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 88 Figure 9.1.2-1: Retrieve Resource State Preconditions: • O-RU Controller has completed exchange of NETCONF capabilities as part of connection establishment between O-RU and O-RU Controllers. Post conditions: • O-RU controller has retrieved O-RU state as per <get> request. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.3 Modify state | For O-RUs that support the optional hardware-state feature defined in ietf-hardware, the O-RU Controller is able to change state which can be configurable by using NETCONF <edit-config> procedure without reset, as illustrated in Figure 9.1.3-1. The configurable state is admin-state defined in o-ran-hardware YANG model. In case of a failure, an error shall be returned. Refer to IETF RFC 6241 [3] Appendix A for error codes. The vendor can define the behaviour after the error occurred. The power-state is read-only state defined in o-ran-hardware.yang. This state is only exposed by the O-RUs supporting ENERGYSAVING feature and is used by O-RU to inform if unit is in energy saving state, not in energy saving state or in transition between energy saving state and non-energy saving state. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 89 Figure 9.1.3-1: Modify Resource State without reset The followings are the information of state transition for each state. [admin-state] The admin-state transition diagram for the O-RU is illustrated in Figure 9.1.3-2. Figure 9.1.3-2: Admin State • locked: This state indicates that any resource activation is prohibited for the O-RU and all resources have been deactivated administratively. O-RU shuts down all RF emission. When O-RU's admin state is locked, all its tx-array-carriers and rx-array-carriers parameter active are set by NETCONF server autonomously to "INACTIVE" and state are "DISABLED". When O-RU's administrative-state is LOCKED, O-RU shall reject NETCONF client's request to set tx-array-carrier and rx-array-carrier parameter active to "ACTIVE". Antenna lines and ALD ports on the O-RU are powered off. O-RU shall reject NETCONF configuration to power on the ALD port and antenna lines. • shutting-down: That usage is administratively limited to current instances of use. It is optional. For admin state transition using autonomous trigger from shutting-down to state locked, refer to Recommendation ITU-T X.731 [77] Figures 5 and 6. • unlocked: This state indicates that any resource activation is allowed and any resources can be active. The state "unlocked" is the initial state after the reset of the O-RU. [power-state] The power-state transition diagram for O-RU is presented in Figure 9.1.3-3. This state can be indirectly controlled by editing the parameters energy-saving-enabled and [tr]x-array-carrier::active, as illustrated in Figure 9.1.3-3. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 90 Figure 9.1.3-3: Transition diagram for power-state node Figure 9.1.3-4: Void • AWAKE: This value of power-state node indicates that the O-RU is operating normally, i.e. not in energy saving mode. AWAKE is the initial value of power-state node after the reset of the O-RU. AWAKE is power-state of O-RU in case energy-saving-enabled is FALSE or when at least one carrier is active. • SLEEPING: This value of power-state node indicates that the O-RU is in energy saving mode. M-plane connection and functions are alive whereas other C/U/S functions may be autonomously stopped by the O-RU if there is no active carrier and value of energy-saving-enabled is TRUE - to reduce energy consumption. • UNKNOWN: This value of power-state node can be exposed by the O-RU e.g. in case the O-RU does not know its power-state value is AWAKE or SLEEPING. This value of power-state node is optional. When the value of any of the following states changes, an O-RU supporting feature hardware-state shall send the hardware-state-change notification to the notification subscriber: • admin-state, oper-state, usage-state (as specified in ietf-hardware.yang) • power-state, availability-state (as specified in o-ran-hardware.yang) On receiving the notification, the notification subscriber should read the state by using get RPC operation. [oper-state] O-RU's oper-state is not configurable. It reflects whether the O-RU can provide service or not. The oper-state transition diagram for O-RU is presented in Figure 9.1.3-5. Figure 9.1.3-5: Oper State enabled: O-RU is partially or fully operational. disabled: O-RU is not operational. This is the initial state of oper-sate after the reset of the O-RU. • O-RU Controller is able to reset the O-RU, even if the O-RU state is "disabled" or "enabled". [availability-state] The availability-state transition diagram for the O-RU is presented in Figure 9.1.3-6. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 91 Figure 9.1.3-6: Availability State The availability state is derived from detected and active faults and their impact to O-RU's operation. The availability state is not affected by faults caused by external reasons: • normal: There is no fault. • degraded: When major or critical fault affecting module or any of O-RU's subcomponents (e.g. transmitter) is active. • faulty: The critical fault affecting whole O-RU is active and O-RU cannot continue any services. [usage-state] The usage-state transition diagram for the O-RU is presented in Figure 9.1.3-7. Figure 9.1.3-7: usage State • idle: No carrier is configured in O-RU. • active: The carrier(s) is(are) configured in O-RU. • busy: No more carrier can be configured in O-RU. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.4 Retrieve parameters | O-RU Controller is able to retrieve parameters of the YANG module by using NETCONF <get> or <get-config> procedure, as illustrated in Figure 9.1.4-1. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 92 Figure 9.1.4-1: Retrieve Parameters Preconditions: • O-RU Controller has completed exchange of NETCONF capabilities as part of connection establishment between O-RU and O-RU Controller(s). Post conditions: • O-RU controller has retrieved O-RU parameters as per <get><source><running/><filter> or <get- config><source><running/><filter> request. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.5 Modify parameters | Before an O-RU Controller modifies the configuration (candidate or running) of an O-RU, it shall first lock the target configuration. This prevents other NETCONF clients from changing the shared configuration database until the O-RU Controller releases the lock. If another NETCONF client has already locked the configuration datastore, then the O-RU shall respond with a NETCONF error indicating that the requested lock is denied. In such circumstances, the O-RU controller should wait for a period of time before re-attempting to modify the O-RU's configuration. O-RU Controller is able to modify parameters of the YANG module by using the NETCONF <edit-config> procedure, as illustrated in Figure 9.1.5-1. When supported by an O-RU, the O-RU Controller shall perform any required modify operations ONLY on the candidate configuration datastore before committing the validated configuration to the running configuration datastore. When an O-RU does not support the candidate configuration datastore, the O-RU Controller should take extreme care whenever modifying the running configuration datastore as such will likely impact system operation. NOTE: Validation of the modified configuration is based on: 1) basic YANG constraints (e.g. min-elements, range, pattern), 2) XPATH based YANG constraints (e.g. "leafref", "must" and "when" statements), and 3) external code which implements YANG constraints (e.g. defined in O-RAN specifications, YANG description statements, etc.). In case of failures, an error shall be returned. Refer to IETF RFC 6241 [3] Appendix A for error codes. The vendor can define the behaviour after error occurred. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 93 Figure 9.1.5-1: Modify Parameters Preconditions: • O-RU Controller has completed exchange of NETCONF capabilities as part of connection establishment between the O-RU and O-RU Controller(s). • O-RU Controller has locked the target configuration. Post conditions: • O-RU controller has retrieved O-RU resource state as per <edit-config> request: - Success case: The update is confirmed to O-RU Controller. - Failure case: Failure reason is provided to O-RU Controller Sequential processing is assumed. Only a single <edit-config> rpc is allowed at a time. Next <edit-config> rpc shall be performed after previous <edit-config> rpc reply. O-RU shall be allowed to reject <edit-config> in case the content is found to be against e.g. functions supported by O-RU - like carrier configured out of band. After the modification procedure is complete, the O-RU Controller releases the lock on the target configuration. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.6 Deleting parameters | Before an O-RU Controller deletes any configuration (candidate or running) of an O-RU, it shall first lock the target configuration. This prevents other NETCONF clients from changing the shared configuration database until the O-RU Controller releases the lock. If another NETCONF client has already locked the configuration datastore, then the O-RU shall respond with a NETCONF error indicating that the requested lock is denied. In such circumstances, the O-RU controller should wait for a period of time before re-attempting to delete the O-RU's configuration. O-RU Controller is able to delete parameters of the YANG module by using the NETCONF <edit-config> procedure with the "operation" attribute set to delete, as illustrated in Figure 9.1.6-1. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 94 If the configuration data does not exist, an <rpc-error> element is returned with an <error-tag> value of "data-missing". When supported by an O-RU, the O-RU Controller shall perform any required delete operations ONLY on the candidate configuration datastore before committing the validated configuration to the running configuration datastore. When an O-RU does not support the candidate configuration datastore, the O-RU Controller should take extreme care whenever modifying the running configuration datastore as such will likely impact system operation. Figure 9.1.6-1: Delete Parameters Preconditions: • O-RU Controller has completed exchange of NETCONF capabilities as part of connection establishment between the O-RU and O-RU Controller(s). • O-RU Controller has locked the target configuration. Post conditions: • O-RU controller has updated the O-RU resource state as per <edit-config> request: - Success case: The delete is confirmed to O-RU Controller. - Failure case: Failure reason is provided to O-RU Controller Sequential processing is assumed. Only a single <edit-config> rpc is allowed at a time. Next <edit-config> rpc shall be performed after previous <edit-config> rpc reply. Delete Parameters is used to: • delete parameters of existing configuration. After the delete procedure is complete, the O-RU Controller releases the lock on the target configuration. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 95 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.7 Notification framework | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.7.1 General | YANG notifications are used to signal event information to notification subscribers. The present document support two types of subscriptions for receiving YANG notifications: • dynamic, which is supported by all O-RUs; and • configured, which is supported by O-RUs that support the NON-PERSISTENT-MPLANE feature. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.7.2 Event streams | All O-RUs shall support the default "NETCONF" event stream, as specified in clause 3.2.3 of IETF RFC 5277 [21]. In addition to the default event stream, O-RUs should support the following event streams: • "fault-management" used to subscribe to YANG notification events defined in o-ran-fm YANG model. • "measurement-result-stats" used to subscribe to YANG notification events defined in o-ran-performance- management YANG model. • "supervision-notification" used to subscribe to YANG notification events defined in o-ran-supervision YANG model. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.7.3 Event stream discovery and subscription | An O-RU controller discovers the O-RU's ability to process and send event notifications via capability exchange, as defined in clause 3.1 of IETF RFC 5277 [21]. The O-RU shall support event stream discovery as defined in clause 3.2.5 of IETF RFC 5277 [21]. Prior to initiating a dynamic subscription to an event stream, an O-RU controller can discover the O-RU's supported event streams. Refer to clause 3.2.5 of IETF RFC 5277 [21] for detail. All O-RUs shall support event stream subscription using the <create-subscription> RPC specified in clause 2 of IETF RFC 5277 [21]. An O-RU may support event stream subscription using <establish-subscription> RPC specified in clause 2.4 of IETF RFC 8639 [37]. An O-RU indicates it supports <establish-subscription> by including the ietf-subscribed-notifications YANG model in its YANG library. An O-RU supporting event stream subscription using <establish-subscription> RPC shall be able to support concurrent operation of <establish-subscription> and <create-subscription> RPCs on separate NETCONF sessions. If the O-RU supports the NON-PERSISTENT-MPLANE feature, the O-RU shall maintain the streams container as defined in clause 3.1 of IETF RFC 8639 [37]. An O-RU controller supporting IETF RFC 8639 [37] operating with an O-RU that supports the NON-PERSISTENT-MPLANE feature may use the streams container to recover the list of available streams supported by the O-RU. The O-RU supported event streams can be subscribed using dynamic subscriptions and, for those O-RUs that support the NON-PERSISTENT-MPLANE feature, using configured subscriptions. These are transported using NETCONF and VES respectively. • When no <stream> parameter is provided at creation of subscription, the default "NETCONF" stream is subscribed. • The "NETCONF" default event stream can be subscribed to by all O-RU controllers. Events defined in the YANG modules to which the O-RU controller does not have "execute" access privileges, i.e. modules without an "X" in Table 6.5-1, shall be excluded before the events which are sent to the subscriber. • For non-default streams, the NACM "execute" privileges defined in clause 6.5 shall be used by the O-RU to determine whether an O-RU controller has privileges to establish a subscription to a particular non-default event-stream. An O-RU Controller that has used the <establish-subscription> RPC to subscribe to an event stream may cancel the subscription by using the <delete-subscription> RPC. An O-RU receiving a <delete-subscription> RPC for an existing subscription-id shall cease sending notification messages for this subscription. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 96 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.1.8 Transactions and configuration data validity | An O-RU shall ensure that its configuration datastore has always been updated with any modified configuration before sending the <rpc-reply><ok/></rpc-reply> in response to a transaction that is intended to update the O-RU's system configuration. Except when using the o-ran-uplane-conf YANG model to configure the carrier configuration as described in clause 15.3, the O-RU's system implementation of the modification to its running configuration should occur before sending the <rpc-reply> message. In the case of o-ran-uplane-conf YANG model based carrier configuration, because implementation of the carrier activation/deactivation/energy savings can require operation of some closed loop control system, the YANG model defines the following notifications that allow a subscribing O-RU controller to be signalled when a configuration change has been implemented: • tx-array-carriers-state-change: used to be able to notify subscribers that the changes to a tx-array-carrier have been implemented. • rx-array-carriers-state-change: used to be able to notify subscribers that the changes to an rx-array-carrier have been implemented. • data-layer-control-wakeup-notification: used to be able to notify subscribers that the changes to energy-savings group have been implemented. • mplane-trx-control-ant-mask-update: used to be able to notify subscribers that the changes to the antenna mask have been implemented. In the above cases, the O-RU may send the <rpc-reply><ok/></rpc-reply> before the updated configuration has been implemented. This avoids extended periods of time when the configuration would otherwise be locked while configuration changes are implemented. 9.1.9 YANG model support for target value configuration and used-value retrieval An O-RU can support target value configuration which means that the O-DU configures a target value for a configuration and the O-RU returns its used-value which is an approximation of the target value that is suitable for the O-RU. Parameters can have individual restrictions regarding how this approximation or selection shall be done (see relevant clauses describing the parameters in CUS-plane specification). The following steps show the general procedure to perform such target value configuration method, as illustrated in Figure 9.1.9-1. 1) The O-DU configures the O-RU using <rpc><edit-config> consisting of one or more parameter(s) (e.g. eq-scale-offset-config, sinr-reference-level-config, etc.) with target value(s). 2) The O-RU sets the used-value(s) in corresponding read-only parameter(s) (e.g. eq-scale-offset-used, sinr-reference-level-used) for the configured target value(s). 3) The O-RU replies <rpc-reply>. 4) The O-DU receives the O-RU's rpc reply, which indicates the configuration process in steps 1 and 2 is finished. The used-value(s) of the read-only parameter(s) (e.g. eq-scale-offset-used, sinr-reference-level- used) are available. 5) The O-DU retrieves the used-value(s) from the O-RU using <rpc><get> when the O-DU wants, e.g. before carrier activation. 6) The O-DU receives the used-value(s) of the read-only parameter(s), so the O-DU is aware of precise value(s) selected and used by the O-RU. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 97 Figure 9.1.9-1: Procedure of target value configuration and used-value retrieval |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.2 Framework for optional feature handling | This clause describes the common and optional features about Configuration Management. An O-RU may have some features which are not supported by other O-RUs, i.e. optional feature(s). In this case, the O-RU needs to inform the O-RU controller which features the O-RU can provide, and this can be achieved by exchanging NETCONF capabilities. Some of the YANG models are optional for the O-RU to support. For example, in this version of the management plane specification, those models associated with External IO and Antenna Line Devices are not essential for the operation of the O-RAN fronthaul interface. Other mandatory models define optional feature capabilities. Both the NETCONF Server and NETCONF Client shall use the ietf-yang-library mode, as specified in IETF RFC 8525 [59] to signal the namespaces of the models supported by the NETCONF Server. If an O-RU/NETCONF Server does not return the namespace associated with an optional YANG model, the NETCONF Client determines that the O-RU/NETCONF Server does not support the optional capability associated with the model. In addition, for each supported schema, the ietf-yang-library lists the YANG feature names from this module that are supported by the server. The details of optional models and features are defined in Annex C. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.3 M-Plane operational state | The o-ran-mplane-int YANG model allows the O-RU to report the connectivity to NETCONF clients on a per sub- interface level. The client information includes the IP address(es) for the client(s) as well as the link-layer address used to forward packets towards the various management plane clients. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 98 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.4 Notification of updates to configuration datastore | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.4.1 Introduction | This clause defines an optional O-RU capability which allows O-RU Controllers to configure the O-RU to provide notifications of modifications to its YANG datastore. This capability can be used when the O-RU is operating in a hybrid environment with multiple simultaneous NETCONF sessions established to different O-RU controllers. Using this capability, one particular O-RU controller uses the NETCONF notifications functionality as specified in IETF RFC 6470 [35] to enable it to be automatically signalled changes to the O-RU's configuration made by a second O-RU controller. Additionally, if the O-RU supports a vendor specific interface to allow manual configuration, this functionality can also be used to signal such configuration modifications to an O-RU Controller. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.4.2 Subscribing to updates from an O-RU | When an O-DU receives an indication from an O-RU that it supports the optional capability to support notification of updates to its configuration data store, as a minimum, it may subscribe to the netconf-config-change notification. An example event notification is shown in Figure 9.4.2-1, where a notification indicates that the configuration of the O-RU's timezone offset has been modified by a second O-RU controller. Figure 9.4.2-1: Example of a netconf-config-change notification |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.5 Resetting O-RU | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.5.1 O-RU reset procedure | An O-RU reset may be triggered by an O-RU controller or autonomously triggered by an O-RU, e.g. as a result of supervision failure specified in clause 14.1.1. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.5.2 O-RU controller triggered O-RU reset operation | The reset procedure can be used by an O-RU controller to trigger the reset of the O-RU. The reset of an O-RU triggers the O-RU to perform a re-start and follow the procedures defined in clause 6. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 9.5.3 O-RU controller triggered O-RU reset procedure | O-RU Controller is able to trigger the reset of an O-RU by using the reset rpc, as illustrated in Figure 9.5.3-1. <notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2020-03-01T08:00:14.12Z</eventTime> <netconf-config-change xmlns= "urn:ietf:params:xml:ns:yang:ietf-netconf- notifications"> <id>102</id> <changed-by> <username>nms-user</username> <session-id>1099</session-id> <source-host>10.10.10.10</source-host> </changed-by> <datastore>running</datastore> ETSI ETSI TS 104 023 V17.1.0 (2026-01) 99 Pre-condition: • M-Plane connection is established and running between O-RU and O-RU controller. Post-condition: • O-RU performs reset followed by start-up sequence described in clause 6. Figure 9.5.3-1: O-RU Reset Procedure |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10 Performance management | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.1 General | This clause provides the description of scenarios related to performance management. It consists of 2 functions. One is for the measurement activation and the other is the collection of measurement results. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.2 Measurement activation and de-activation | The measurement activation at the start-up installation is also allowed as described in clause 6. Pre-condition: • M-Plane is operational. Post-condition: • Measurement is activated or deactivated as per NETCONF client's request. This clause provides information about how to activate and de-activate the performance measurement via NETCONF <edit-config> to O-RU. The performance measurement is defined as o-ran-performance-management YANG module. In case of multiple NETCONF clients, only one NETCONF client shall activate/deactivate the measurements in the O-RU. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 100 In the performance-management YANG module, the following parameters are defined: • measurement-capabilitites e.g. transceiver-objects, rx-window-objects, tx-stats-objects, shared-cell-stats- objects, epe-stats-objects, symbol-rssi-stats-objects, tssi-stats-objects, rssi-stats-objects, tx-antenna- measurement-objects, tx-output-power-stats-objects and ethernet-objects. • group of the measurement results, e.g. transceiver-measurement-objects, rx-window-measurement-objects, tx-measurement-objects, epe-measurement-objects, symbol-rssi-measurement-objects, tssi-measurement- objects, rssi-measurement-objects, tx-antenna-measurement-objects, tx-output-power-stats-objects and ethernet-measurement-objects. • measurement-interval: measurement interval for the measurement-objects to measure the performance periodically, e.g. 300, 600, 900 seconds. It is defined per the group of the measurement result. • measurement-object: target metric to measure the performance, e.g. RX_POWER, TX_POWER, defined as key parameter. The set of supported measurement-objects is provided in measurement-capabilitites (sic). • active: enable/disable the performance measurement per measurement-object. This value is Boolean. Default is FALSE. • start-time and end-time: to report the time of measurement start and end for the measurement-object at each measurement-interval. • object-unit: unit to measure the performance per object, e.g. O-RU, physical port number, antenna, carrier. The object-unit may be configurable Identifier object-unit-id means e.g. physical port number when object unit set to physical port number. • report-info: the reporting info to the measurement-object, e.g. MAXIMUM, MINIMUM, FIRST, LATEST, FREQUENCY_TABLE and COUNT. Multiple info can be considered for one object if necessary. The set of supported report-infos is provided in measurement-capabilitites. • Optional configurable parameter(s) for report-info: some configurable parameters to report, e.g. function, bin-count, upper-bound, lower-bound. For the bin-count configuration, it shall be less than the parameter max-bin-count provided in measurement-capabilitites that is the capability information of NETCONF server for the maximum configurable value for bin-count. For the function configuration, the set of supported functions is provided in measurement-capabilitites. • Additional reporting information for report-info: some additional information to report info, e.g. date-and- time. The detail of the parameters per measurement-object and the group of measurement result are defined in Annex B. The measurement-interval of measurement-object may be set to common or different values per group of the measurement result. It is allowed that the measurement is activated and deactivated at any time. When different parameter measurements have intervals with a common factor, the O-RU shall synchronize the boundary of these measurements aligned with this factor, irrespective of when the different measurements are activated, as illustrated in Figure 10.2-1. And all of start points of the measurement-intervals shall be synchronized to zero o'clock mid-night by using an equation {full seconds (hour, minute and second) modulo 'measurement-interval' = 0}, in order to ensure the same start and end of the measurement-intervals between O-RUs. For more details see Figure 10.2-1. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 101 Figure 10.2-1: Synchronization of measurement-interval The modification of the configurable parameters (except active) for the measurement and removal of measurement objects (e.g. transceiver-measurement-objects, rx-window-measurement-objects, etc.) shall be allowed only while active for the corresponding measurement-object has value FALSE. O-RU shall support those measurements described as mandatory in clause 9.1 of the O-RAN CUS plane specification [2]. The report-info, e.g. count, shall be started from 0 at the boundary of every measurement-interval. No accumulation is applied between the measurement-intervals. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.3 Collection and reporting of measurement result | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.3.0 Introduction | This clause provides the description of scenarios used to collect measurement results. There are three options: 1) NETCONF process: Create-subscription from NETCONF client and NETCONF notification from NETCONF server are used. 2) File Management process: File upload mechanism is used to transfer the measurement file from O-RU to configured file server(s) that O-RU can reach to. 3) Configured subscription process: Create configured subscription from O-RU as Event-Producer to Event-Collector. Methods 1 and 2 are mandatory for the O-RU. Method 3 shall be supported by those O-RUs that support the optional NON-PERSISTENT-MPLANE feature. The method(s) to be used is the matter of NETCONF client. In case of multiple NETCONF clients and/or Event-Collectors, the O-RU shall report the same notification-based measurement results to all subscribed NETCONF clients/Event-Collectors, and the O-RU shall upload file-based results to all configured fileservers. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 102 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.3.1 NETCONF process for dynamic subscriptions | This process needs the NETCONF capability: urn:ietf:params:netconf:capability:notification:1.0. 1) NETCONF client subscribes to one or more measurement group(s) and/or measurement-object(s) to collect the measurement result by sending NETCONF <create-subscription> to NETCONF server in the O-RU. In this message, startTime and stopTime for the notification may be configurable. NETCONF client can configure the notification-interval in the performance-measurement YANG module. 2) NETCONF server sends NETCONF notification messages periodically to the client as configured by the notification-interval. The NETCONF notification message contains subscribed measurement group(s) and/or measurement-object(s). The notification-interval does not need to be same as the measurement-interval. The notification timing different from the measurement-interval is a matter to O-RU implementation. This procedure is described in Figure 10.3.1-1. Figure 10.3.1-1: NETCONF process of Measurement Result Collection NOTE 1: A NETCONF client may use the create-subscription for the single event-stream "measurement-result- stats", or alternatively subscribe the default event-stream using additional filter criteria to identify those measurements of interest to the client. In order to subscribe multiple notifications, the appropriate create- subscription message is required. Refer to clause 11.3 for the appropriate example of create- subscription of multiple notifications. In order to terminate the subscription, the NETCONF client shall send <close-session> operation from the subscription session or configuring the <stopTime> parameter when the subscription was created. If NETCONF session is terminated by <kill-session>, the subscribed notification is terminated as well. This procedure is described in Figure 10.3.1-2. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 103 Figure 10.3.1-2: NETCONF process of Measurement Result Collection to end When notification-interval is larger than measurement-interval, O-RUs implementing v07.00 or later of the present document may use a single notification that contains multiple stats included in the list such as multiple-transceiver- measurement-result, multiple-rx-window-measurement-result, multiple-tx-measurement-result, multiple-epe- measurement-result or multiple-symbol-rssi-measurement-result which have consecutive periods indicating start- time and end-time for the measurement. NOTE 2: When multiple measurements stats corresponding to the same measurement-group are available in an O-RU that implements an earlier version of the present document, the O-RU is only able to include a single statistic in the notification. In such circumstances, the O-RU should report the latest available statistic in the notification. NOTE 3: An O-RU Controller that implements an earlier version of the present document can ensure that the configuration of notification-interval and measurement-interval results in only a single measurement statistic corresponding to a specific measurement-group being reported by the O-RU in any one notification. In other cases, the O-RU Controller can use the rules defined in clause 4.3 to ignore the newly introduced schema-nodes for reporting multiple measurements. When notification-interval is smaller than measurement-interval, one notification may not contain the stats which start-time and end-time are not applicable to the period for the notification. For example, when notification-interval = 60min, measurement-interval for measurement-object#A= 30min and measurement-interval for measurement-object#B = 15min, one notification contains 2 measurement results for measurement-object#A with consecutive start-time and end-time, and 4 measurement results for measurement- object#B with consecutive start-time and end-time. For the other example, when notification-interval = 15min, measurement-interval for measurement-object#A= 30min and measurement-interval for measurement-object#B = 15min, one notification contains one measurement results for measurement-object#B but not for measurement-object#A. next notification contains both measurements result for measurement-object#A and #B. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.3.2 File management process | NETCONF client needs to configure a parameter of performance measurement YANG module 'enable-file-upload' to enable or disable the periodic file upload mechanism via NETCONF <edit-config>. Its default is FALSE. In addition, the performance measurement YANG module defines file-upload-interval, remote-file-upload-path, credentials information of the file server and enable-random-file-upload as configurable parameters. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 104 Following types of authentications shall be supported for performance file upload: a) Password for RU authentication and list of public keys (see clause 5.4 in the present document) for sFTP server authentication. Following types of authentications may be supported for performance file upload: a) X.509 Certificate for FTPES client (O-RU) and FTPES server. b) Certificate for both O-RU and sFTP server authentication. When the parameter enable-file-upload is set to TRUE, O-RU shall store the performance measurement files in the generic folder in O-RU, i.e. O-RAN/PM/ or o-ran/pm/. Every file-upload-interval, O-RU pushes the latest file to upload to the remote-file-upload-path of the configured SFTP/FTPES servers if enable-file-upload is set to TRUE. Otherwise, the performance measurement file is not created and uploaded. The O-RU shall use the URI scheme of the remote-file-path leaf to determine whether to use sFTP or FTPES for the file upload. The number of maximum performance files to be stored in O-RU simultaneously is a matter for O-RU implementation. The O-RU shall manage its own storage space by deleting the older files autonomously. An O-RU Controller shall only trigger file upload using FTPES if it is using NETCONF/TLS to configure the O-RU. The O-RU shall ensure that the start-time and the end-time within the name of the performance measurement file are synchronized with the same manner as measurement-interval by using file-upload-interval. If the parameter enable-random-file-upload is set to TRUE, the O-RU shall randomize the timing to upload SFTP or FTPES file after the performance measurement file is ready to upload. The randomized timing is an O-RU implementation matter and shall not be later than next file-upload-interval. The file name of the performance measurement is: C<start-time>_<end-time>_<name>.csv • Starting with a capital letter "C". • Format of <start-time> and <end-time> can be local time or UTC. Local time format is YYYYMMDDHHMM+HHMM, indicating, year, month, day, hour, minute, timezone "+" or "-" , hour and minute for the time zone. UTC format is YYYYMMDDHHMMZ, indicating, year, month, day, hour, minute and with a special UTC designator ("Z") Time zone offset is provided by timezone-utc-offset in o-ran-operation.yang. • <name> in ietf-hardware is used. • "_" underscore is located between <start-time>, <end-time> and <name>. • File extension is "csv" as csv format file. Example of measurement file is: • C201805181300+0900_201805181330+0900_ABC0123456.csv. The file format of the performance measurement has following rule: 1) Each line starts with an identifier. The identifier should be used to identify each measurement-group defined by its row in Table B.1-1, e.g. transceiver-stats should be identified by an identifier of "1", rx-window-stats should be identified by a measurement-group identifier of "2" and tx-measurement-objects should be identified by a measurement-group of "3", etc. NOTE 1: The use of the identifier to identify a measurement group is only recommended in order to accommodate an earlier release of the present document where the use of the identifier was ambiguous. 2) After the measurement-object identifier, the name of measurement-object, start-time, end-time are appended. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 105 3) Then the object-unit and object-unit-id are appended, followed by the set of report-info are repeated in one line. NOTE 2: If the leading identifier is not used to signal a measurement-group, the measurement-group needs to be derived from the object-unit. For example, an object-unit of "PORT_NUMBER" is used to identify the transceiver-stats measurement-group, and an object-unit of "ianahw:port" is used to identify an epe-stats measurement group for the ianahw:port hardware class. NOTE 3: If a measurement is referenced by multiple object-units, each object-unit and corresponding object- unit-id are appended in turn. 4) When the YANG definition of the measurement-result-grouping includes one or more lists and multiple report-info parameters exist per object-unit, all of the report-info are consecutively listed until the next object-unit-id. The order of parameters, such as object-unit-id, report-info and additional information for the report-info, shall be same as the order of those listed in NETCONF notification defined in o-ran-performance- management YANG module. 5) When the YANG definition of the measurement-result-grouping includes one or more containers, the container name is included in the report-info. NOTE 4: In versions prior v13.0 of the present document, the use of the container name in the report-info was not defined and hence how such measurement reports were encoded was not specified. Example of multiple transceiver measurements on one line is: 1, RX_POWER, 2018-05-18T13:00:00+09:00, 2018-05-18T13:15:00+09:00, PORT_NUMBER, 0, min, 0,10232, 2018-05-18T13:01:12+09:00, max, 1,5849, 2018-05-18T13:09:54+09:00 • Measurement-group identifier: 1 (transceiver-stats) • Name of measurement-object: RX_POWER • start-time: 2018-05-18T13:00:00+09:00 as measurement start-time • end-time: 2018-05-18T13:30:00+09:00 as measurement end-time • object-unit: PORT_NUMBER • object-unit-id: 0 (Port number 0) • Report-Info: - Minimum 0,10232 mW Rx input Power measured at 2018-05-18T13:01:12+09:00 - Maximum 1,589 mW Rx input Power measured at 2018-05-18T13:09:54+09:00 Example of multiple rx-window measurement results on one line is: 2, RX_LATE, 2018-05-18T13:00:00+09:00, 2018-05-18T13:30:00+09:00, EAXC_ID, 0, 123, 1, 153 • Measurement-group identifier: 2 (rx-window-stats) • Name of measurement-object: RX_LATE • start-time: 2018-05-18T13:00:00+09:00 as measurement start-time • end-time: 2018-05-18T13:30:00+09:00 as measurement end-time • object-unit: EAXC_ID • object-unit-id: 0 (EAXC_ID: 0) • Count for EAXC_ID#0 : 123 • object-unit-id: 1 (EAXC_ID: 1) • Count for EAXC_ID#1 : 153 ETSI ETSI TS 104 023 V17.1.0 (2026-01) 106 Example of hardware class based reporting of epe statistics: 4, TEMPERATURE, 2018-05-18T13:00:00+09:00, 2018-05-18T13:15:00+09:00, or-hw:O-RU-POWER-AMPLIFIER, PA1, min, 25, max, 44, avg, 33 • Measurement-group identifier: 4 (epe-stats object) • Name of measurement-object: TEMPERATURE • start-time: 2018-05-18T13:00:00+09:00 as measurement start-time • end-time: 2018-05-18T13:30:00+09:00 as measurement end-time • object-unit: or-hw:O-RU-POWER-AMPLIFIER (Power amplifier hardware class) • object-unit-id: PA1 (the name associated with a power amplifier) • Report-Info: - minimum 25 degrees - maximum 44 degrees - average 33 degrees Example of frequency bin based reporting of multiple symbol RSSI measurements: 5, ALL-UL-SYMBOLS, 2018-05-18T13:00:00+09:00, 2018-05-18T13:15:00+09:00, rx-array-carrier, RX-ARRAY- CARRIER1, frequency-bin-table, 0, 2046, 1, 9718, 2, 19437, 3, 15345, 4, 4092, 5, 511 • Measurement-group identifier: 5 (symbol-rssi-stats object) • Name of measurement-object: ALL-UL-SYMBOLS • start-time: 2018-05-18T13:00:00+09:00 as measurement start-time • end-time: 2018-05-18T13:30:00+09:00 as measurement end-time • object-unit: rx-array-carrier • object-unit-id: RX-ARRAY-CARRIER1 (the name associated with rx-array carrier) • Report-Info corresponding to a frequency bin table: - bin-id 0, value 2046 - bin-id 1, value 9718 - bin-id 2, value 19437 - bin-id 3, value 15345 - bin-id 4, value 4092 - bin-id 5, value 511 Example of combine reporting requiring multiple object-unit-id values: 6, RX_UP_UL_COMBINED, 2018-05-18T13:00:00+09:00, 2018-05-18T13:10:00+09:00, TRANSPORT, PROC_ELEMENT1, 123400, PROC_ELEMENT2, 123400 • Measurement-group identifier: 6 (shared-cell statistics object) • Name of measurement-object: RX_UP_UL_COMBINED • start-time: 2018-05-18T13:00:00+09:00 as measurement start-time ETSI ETSI TS 104 023 V17.1.0 (2026-01) 107 • end-time: 2018-05-18T13:30:00+09:00 as measurement end-time • object-unit: TRANSPORT • object-unit-id: PROC_ELEMENT1 (Processing element name: "PROC_ELEMENT1") • Count for PROC_ELEMENT1: 123400 • object-unit-id: PROC_ELEMENT2 (Processing element name: "PROC_ELEMENT2") • Count for PROC_ELEMENT2: 102431 Example of frequency bin based reporting of VSWR measurements: 7, VSWR, 2023-10-02T13:00:00+02:00, 2023-10-02T13:30:00+02:00, ARRAY_ELEMENT, tx-array1:2, frequency- bin-table, 0, 21, 1, 37, 2, 77, 3, 11, 4, 101, 5, 1 • Measurement-group identifier: 7 (tx-antenna-stats object) • Name of measurement-object: VSWR • start-time: 2023-10-02T13:00:00+02:00 as measurement start-time • end-time: 2023-10-02T13:30:00+02:00 as measurement end-time • object-unit: ARRAY_ELEMENT • object-unit-id: tx-array1:2 (an array element k=2 on the tx-array named "tx-array-1") • Report-Info corresponding to a frequency bin table: - bin-id 0, value 21 - bin-id 1, value 37 - bin-id 2, value 77 - bin-id 3, value 11 - bin-id 4, value 101 - bin-id 5, value 1 Example of reporting of TSSI measurements: 8, TSSI-IQ-POWER-LEVEL, 2023-10-02T13:00:00+02:00, 2023-10-02T13:30:00+02:00, TX-ARRAY-CARRIER, TX-ARRAY-CARRIER1, per-tx-array-element-index-result, tx-array1:2, min, -39,40, max, -16,33, avg, -26,93 • Measurement-group identifier: 8 (tssi-stats-object) • Name of measurement-object: TSSI-IQ-POWER-LEVEL • start-time: 2023-10-02T13:00:00+02:00 as measurement start-time • end-time: 2023-10-02T13:30:00+02:00 as measurement end-time • object-unit: TX-ARRAY-CARRIER • object-unit-id: TX-ARRAY-CARRIER1 (the name associated with tx-array carrier) • per-tx-array-element-index-result • tx-array1:2 (an array element k=2 on the tx-array named "tx-array-1") • Report-Info: - minimum -39,40 ETSI ETSI TS 104 023 V17.1.0 (2026-01) 108 - maximum -16,33 - average -26,93 Example of reporting of RSSI measurements: 9, RSSI, 2023-10-02T13:00:00+02:00, 2023-10-02T13:30:00+02:00, RX-ARRAY-CARRIER, RX-ARRAY- CARRIER1, per-rx-array-element-index-result, rx-array1:2, min, -106,1, max, -52,8, avg, -89,2 • Measurement-group identifier: 9 (rssi-stats-object) • Name of measurement-object: RSSI • start-time: 2023-10-02T13:00:00+02:00 as measurement start-time • end-time: 2023-10-02T13:30:00+02:00 as measurement end-time • object-unit: RX-ARRAY-CARRIER • object-unit-id: RX-ARRAY-CARRIER1 (the name associated with rx-array carrier) • per-rx-array-element-index-result • rx-array1:2 (an array element k=2 on the rx-array named "rx-array-1") • Report-Info: - minimum -106,1 - maximum -52,8 - average -89,2 Example of reporting of TX-OUTPUT-POWER measurements: 10, TX-OUTPUT-POWER, 2024-08-06T13:00:00+02:00, 2024-08-06T13:30:00+02:00, TX-ARRAY-CARRIER, TX- ARRAY-CARRIER1, per-tx-array-element-index-result, tx-array-1:0, min, 42,90, max 43,24, avg 43,01, tx-array-1:1, min, 42,92, max 43,26, avg 43,03. • Measurement-group identifier: 10 (tx-output-power-stats-object) • Name of measurement-object: TX-OUTPUT-POWER • start-time: 2024-08-06T13:00:00+02:00 as measurement start-time • end-time: 2024-08-06T13:30:00+02:00 as measurement end-time • object-unit: CARRIER-ARRAY-ELEMENT • object-unit-id: TX-ARRAY-CARRIER1(the name associated with tx-array-carrier) • per-tx-array-element-index-result • tx-array-1:0 (an array element k=0 on the tx-array named "tx-array-1") • Report-Info: - minimum 42,90 - maximum 43,24 - average 43,01 • tx-array-1:1 (an array element k=1 on the tx-array named "tx-array-1") ETSI ETSI TS 104 023 V17.1.0 (2026-01) 109 • Report-Info: - minimum 42,92 - maximum 43,26 - average 43,03 Example of multiple ethernet measurements on one line is: 11, RECEIVED-CRC-ERRORED-FRAMES, 2018-05-18T13:00:00+09:00, 2018-05-18T13:15:00+09:00, ETH_INTERFACE, 10Geth0.100, count, 1499 • Measurement-group identifier: 11 (ethernet-stats object) • Name of measurement-object: IN-CRC-ERRORS • start-time: 2018-05-18T13:00:00+09:00 as measurement start-time • end-time: 2018-05-18T13:30:00+09:00 as measurement end-time • object-unit: ETH_INTERFACE • object-unit-id: 10Geth0.100 (Ethernet interface with name 10Geth0.100) • Report-Info: - Count for 10Geth0.100: 1499. When file-upload-interval is larger than measurement-interval, one performance measurement file may contain multiple lines for the stats which have consecutive periods indicating start-time and end-time for the measurement. When file-upload-interval is smaller than measurement-interval, one performance measurement file may not contain the line for the stats which start-time and end-time are not applicable to the period for the performance measurement file. For example, when file-upload-interval = 60 min, measurement-interval for measurement-object#A= 30 min and measurement-interval for measurement-object#B = 15 min, one performance measurement file contains 2 measurement result lines for measurement-object#A with consecutive start-time and end-time, and 4 measurement result lines for measurement-object#B with consecutive start-time and end-time as follows: 1, RX_POWER, 2018-05-18T13:00:00+09:00, 2018-05-18T13:15:00+09:00, PORT_NUMBER, 0, max, 1.5849, 2018-05-18T13:09:54+09:00 1, RX_POWER, 2018-05-18T13:15:00+09:00, 2018-05-18T13:30:00+09:00, PORT_NUMBER, 0, max, 1.4125, 2018-05-18T13:21:08+09:00 2, RX_LATE, 2018-05-18T13:00:00+09:00, 2018-05-18T13:30:00+09:00, EAXC_ID, 0, 123, 1, 153 1, RX_POWER, 2018-05-18T13:30:00+09:00, 2018-05-18T13:45:00+09:00, PORT_NUMBER, 0, max, 1.2882, 2018-05-18T13:44:00+09:00 1, RX_POWER, 2018-05-18T13:45:00+09:00, 2018-05-18T14:00:00+09:00, PORT_NUMBER, 0, max, 1.2022, 2018-05-18T13:49:44+09:00 2, RX_LATE, 2018-05-18T13:30:00+09:00, 2018-05-18T14:00:00+09:00, EAXC_ID, 0, 13, 1, 23 For the other example, when file-upload-interval = 15 min, measurement-interval for measurement-object#A = 30 min and measurement-interval for measurement-object#B = 15 min, one performance measurement file contains one measurement result line for measurement-object#B but not for measurement-object#A. next performance measurement file contains both measurements result for measurement-object#A and #B as follows: C201805181300Z+0900_201805181315+0900_ABC0123456.csv. 1, RX_POWER, 2018-05-18T13:00:00+09:00, 2018-05-18T13:15:00+09:00, PORT_NUMBER, 0, max, 1.5849, 2018-05-18T13:09:54+09:00 C201805181315Z+0900_201805181330+0900_ABC0123456.csv. 1, RX_POWER, 2018-05-18T13:15:00+09:00, 2018-05-18T13:30:00+09:00, PORT_NUMBER, 0, max, 1.4125, 2018-05-18T13:21:08+09:00 2, RX_LATE, 2018-05-18T13:00:00+09:00, 2018-05-18T13:30:00+09:00, EAXC_ID, 0, 123, 1, 153 The performance measurement files stored in O-RAN/PM or o-ran/pm/ can be uploaded on-demand. For the file upload mechanism by on-demand way, retrieve-file-list and file-upload operations are used. For more detail, refer to clause 12. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 110 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 10.3.3 Configured subscription process | This optional process requires the O-RU to support configured subscriptions, as described in clause 18. The structure of the process follows the NETCONF process described in clause 10.3.1. However, instead of sending a NETCONF <create-subscription > to the NETCONF server in the O-RU to subscribe to the measurement-result-stats notifications, the NETCONF client installs the subscription via configuration of the O-RU's datastore. Based on configured subscriptions, the O-RU sends asynchronous YANG notifications over HTTPS to the configured Event-Collector. In order to terminate the subscription, the NETCONF client shall delete the corresponding configuration in the O-RU. Immediately after the subscription is successfully deleted, the O-RU shall send to a subscription state change notification indicating that the subscription has ended to the Event-Collector. NOTE: Unlike the NETCONF process described in clause 10.3.1, the subscription to the subscribed notifications is not terminated when the NETCONF session used to establish the subscription is terminated. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11 Fault management | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11.1 Introduction | Fault management is used to manage active-alarm-list and optionally historical-alarm-list; handle alarm subscription and send alarm notifications to subscribers, which will typically be the NETCONF Client unless the O-RU supports the configured subscription capability, as described in clause 18, when the configured subscriber may be an Event-Collector. The NETCONF Server shall manage the active-alarm-list. Alarms with fault-severity set to WARNING are excluded from this list. When the raise alarm criteria are met, an alarm is raised and it is added to the list; when clear alarm conditions are fulfilled then the alarm is cleared and removed from the active-alarm-list. Furthermore, when the element that was the fault-source of an alarm is deleted then all related alarms are removed from the active-alarm-list. Optionally, the NETCONF Server is also responsible for managing the historical-alarm-list. Alarms with fault-severity set to WARNING are excluded from this list. When an alarm is cleared, it is added to this list with is-cleared set to "true". The NETCONF Client can read " active-alarm-list" by get RPC operation, as illustrated in Figure 11.1-1. Figure 11.1-1: Read Active Alarms ETSI ETSI TS 104 023 V17.1.0 (2026-01) 111 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11.2 Alarm notification | The O-RU shall send <alarm-notif> to a subscriber when the NETCONF Client has established a subscription to alarm notification and: • a new alarm is added to active-alarm-list; • an alarm is removed from the list. Removal of alarms from the active-alarm-list due to deletion of "fault-source" element is considered as clearing and cause sending of <alarm-notif> to the notification subscriber. This applies to alarms which were explicitly related to the deleted "fault-source" element. The rationale for such is to avoid misalignment between NETCONF Clients when one NETCONF Client deletes an element. The O-RU reports in <alarm-notif> only for new active or cancelled alarms, not all active alarms, as illustrated in Figure 11.2-1. Figure 11.2-1: Alarm Notification |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11.3 Manage alarm subscription to NETCONF clients | The NETCONF Client can "subscribe" to alarm notifications by sending create-subscription, as specified in clause 2.1 of IETF RFC 5277 [21], to NETCONF Server. IETF RFC 5277 [21] allows <create-subscription> below: <netconf:rpc netconf:message-id="101" xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <filter netconf:type="subtree"> <event xmlns="http://example.com/event/1.0"> <eventClass>fault</eventClass> <severity>critical</severity> </event> <event xmlns="http://example.com/event/1.0"> <eventClass>fault</eventClass> <severity>major</severity> </event> <event xmlns="http://example.com/event/1.0"> <eventClass>fault</eventClass> <severity>minor</severity> </event> ETSI ETSI TS 104 023 V17.1.0 (2026-01) 112 </filter> </create-subscription> </netconf:rpc> NOTE: The NETCONF Client can define the filter for alarm notification base on severity. The appropriate example for O-RAN YANG modules for create-subscription is as follows: Case 1) NETCONF client subscribes alarm-notif filtering fault-severity: CRITICAL, MAJOR and MINOR and measurement-result-stats filtering transceiver-stats and rx-window-stats which measurement-object is RX_ON_TIME only: <rpc xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101"> <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <filter netconf:type="subtree"> <alarm-notif xmlns="urn:o-ran:fm:1.0"> <fault-severity>CRITICAL</fault-severity> </alarm-notif> <alarm-notif xmlns="urn:o-ran:fm:1.0"> <fault-severity>MAJOR</fault-severity> </alarm-notif> <alarm-notif xmlns="urn:o-ran:fm:1.0"> <fault-severity>MINOR</fault-severity> </alarm-notif> <measurement-result-stats xmlns="urn:o-ran:performance-management:1.0"> <transceiver-stats/> </measurement-result-stats> <measurement-result-stats xmlns="urn:o-ran:performance-management:1.0"> <rx-window-stats> <measurement-object>RX_ON_TIME</measurement-object> </rx-window-stats> </measurement-result-stats> </filter> </create-subscription> </rpc> Case 2) NETCONF client subscribes default event stream NETCONF to receive all notifications defined in O- RAN YANG modules: <rpc xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101"> <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <stream>NETCONF</stream> </create-subscription> </rpc> A high-level view of a NETCONF Client subscribing is shown in Figure 11.3-1. After the NETCONF Client requests a subscription, the server sends an alarm-notif notification to the client when there is any change in the active alarms matching the filter specified in the subscription request. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 113 Figure 11.3-1: Manage Alarm Notification Subscription Request To terminate the subscription, the NETCONF client shall send a <close-session> operation from the subscription's session, as illustrated in Figure 11.3-2. Figure 11.3-2: Terminating an Alarm Notification Subscription |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11.4 Fault sources | Alarm notifications reported by NETCONF Server contain element "fault-source" which indicates the origin of an alarm. In general values of "fault-source" are derived from names defined as YANG leafs: • Source (Examples: fan, module, PA, port) indicates that origin of the alarm within the O-RU. Value of "fault-source" is derived from element name. • Source (other than when an element is within the O-RU) ETSI ETSI TS 104 023 V17.1.0 (2026-01) 114 Value of fault-source may identify the O-RU external resource; for example, antenna line. Alarm instance can be identified by value combination of fault-id, fault-source and fault-severity. Alarms with different "fault-id", "fault-source" or "fault-severity" are independent: • Multiple alarms with same "fault-id" may be reported with different "fault-source". • Multiple alarms with same "fault-source" may be reported with different "fault-id". • Among alarms with same value of fault-id and fault-source and different value of fault-severity, only one of them can be in the active-alarm-list at a given time. When an alarm with a "fault-id" and a "fault-source" is reported with a "fault-severity", and there is already an alarm in the active-alarm-list with same fault-id, fault-source value, but with a different fault-severity, NETCONF server shall simultaneously add the alarm with new fault-severity in active-alarm-list and clear the previous alarm with different fault-severity by setting is-cleared to TRUE and shall remove the alarm with previous fault-severity from the active-alarm- list. NETCONF server shall notify subscribers of added and removed alarms. The range of "fault-id" is separated to common and vendor specific. The common fault-ids are defined in Annex A and more numbers may be used in future. The vendor specific range for the fault-id shall be [1000 .. 65535]. Alarm notifications reported by the NETCONF Server contain names of the "affected-objects" which indicate elements affected by the fault. In case the origin of the alarm is within the O-RU, other elements than "fault-source" which do not function correctly due to the fault are reported via "affected-objects". In case the origin of the fault is outside of the O-RU, the O-RU elements which do not function correctly due to the fault are reported via "affected-objects". |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11.5 Manage alarm notification to event-collector | This optional capability requires the O-RU to support configured subscriptions, as described in clause 18. For details for alarm subscription and notification sending to event-collector, refer to clause 18. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 11.6 Historical Alarms List | The O-RU may optionally support the historical-alarm-list container, enabling alarm events with is-cleared status is "true" to be captured. The procedures for aging out entries in the historical-alarms list based on time and/or memory is left to vendor specific implementation of the O-RU. NOTE: The persistence of historical-alarms list entries on O-RU upon reset is left to vendor specific implementation The NETCONF Client can read historical-alarm-list by get RPC operation, as illustrated in Figure 11.6-1. Figure 11.6-1: Read Historical Alarms In case of multiple NETCONF clients and/or Event-Collectors, the O-RU shall report the same notification to all subscribed NETCONF clients/Event-Collectors. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 115 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 12 File management | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 12.1 Introduction | This clause specifies File Management for the O-RU. Following operations are supported as a File Management. • upload (see clause 12.3) File upload from O-RU to file server triggered by O-RU Controller. • retrieve file list (see clause 12.4) O-RU Controller retrieves the file list in O-RU. • download (see clause 12.5) File download from file server to O-RU triggered by O-RU Controller. NOTE 1: file-download has different purpose with software-download specified in clause 8.5. For example, file-download can be used for Beamforming configuration in clause 15.4. File transfers are done with sFTP or FTPES. Following types of authentications shall be supported for file management: a) Password for RU authentication and list of public keys (see clause 5.4 in the present document) for sFTP server authentication. b) X.509 Certificate for TLS between O-RU and FTPES file server. In addition to the X.509 certificate, the O-RU shall use any configured application password, appl-password, to authenticate to the FTPES server for the associated username defined in the remote-file-path. NOTE 2: The appl-password is optional for FTPES server authentication to support scenarios where the username embedded in the remote-file-path corresponds to an anonymous account as defined in IETF RFC 1635 [i.5]. Following types of authentications may be supported for file management: c) Certificate for both O-RU and sFTP server authentication. Following other clauses are related with File Management: • Clause 10.3.2: File management process (can be used for on demand file upload purpose, since clause 10.3.2 covers periodic file upload). • Clause 14.2: Log management. • Clause 14.3: Trace. • Clause 15.4.3: Beamforming configuration update. NOTE 3: The file management functions involve the O-RU controller subscribing to receive particular YANG notifications from the O-RU. All O-RUs support the NETCONF Create-Subscription method, enabling those notifications to be transported using NETCONF notifications. In addition, those O-RUs that support the optional NON-PERSISTENT-MPLANE feature, the O-RU Controller can create a configured subscription from the O-RU, enabling those notifications to be transported over HTTPS to an Event-Collector as described in clause 18. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 12.2 File system structure | The file System structure of the O-RU is represented as a logical structure that is used by the file management procedures defined in the rest of this clause. If the O-RU's physical file structure differs from the logical file structure defined below, the O-RU performs the mapping between the two structures. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 116 The O-RU shall support the standardised logical folders. Prior to version 10.0, the following standardised folders were defined: • O-RAN/log/ • O-RAN/PM/ • O-RAN/transceiver/ And for those O-RU's supporting beamforming: • O-RAN/beamforming/ The folders listed above are inconsistent with the folders used in figures elsewhere in the present document. Because of such inconsistencies, the use of the folders listed above is not preferred. These folders may be subject to removal in a future version of the present document. To avoid interoperability issues between case-sensitive and non-case sensitive file systems, the following additional standardised folders are defined and are preferred in the present document: • o-ran/log/ - used to store troubleshooting and trace logs • o-ran/pm/ - used to store performance measurement files • o-ran/transceiver/ - used to store data recovered from the transceiver module and for those O-RUs supporting beamforming: • o-ran/beamforming/ - used to store beamforming configuration files and for those O-RUs supporting O-RAN defined security logging: • o-ran/security/ - used to store security log files The O-RU may additionally support vendor defined folders which are out of scope of the present document. Versions of the present document prior to v17.0 did not define the standardised folder "o-ran/security/" and consequently O-RUs compliant to versions earlier than v17.0 should use vendor defined folders for supporting security logging functionality. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 12.3 File management operation: upload | This clause describes file upload method from O-RU to the fileserver. sFTP or FTPES is used for File management, and one file can be uploaded by one upload operation. The O-RU Controller triggers file upload operation to O-RU. Simultaneous multiple file upload operations can be supported under the same FTP connection between O-RU to the fileserver. If the O-RU has a limitation with regard to the ability to upload files simultaneously, it is allowed that O-RU reports failure notification for the simultaneous upload request which exceeds its capability. The behaviour of O-RU Controller is out of scope when O-RU Controller receives failure notification from the O-RU. Following rpc is used for upload operation: • rpc: file-upload - input local-logical-file-path: the logical path of file to be uploaded (no wildcard is allowed) remote-file-path: URI of file on the fileserver - output status: whether O-RU accepted or rejected the upload request ETSI ETSI TS 104 023 V17.1.0 (2026-01) 117 reject-reason: the human readable reason why O-RU rejects the request (only applicable if status is rejected) In the rpc-reply, status whether the O-RU receives the upload request or rejects due to some reason (e.g. the number of limitation to upload simultaneously) is replied. If rejected, the human readable reject reason is also replied. In notification, the result of the upload process (successfully uploaded or failed upload) is replied in addition to local-logical-file-path and remote-file-path. If failure, the human readable reason is also replied. Figure 12.3-1 shows the file upload sequence diagram. Figure 12.3-1: File Upload Sequence |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 12.4 File management operation: retrieve file list | This clause describes file retrieve method which the O-RU Controller retrieves the file list from the O-RU. One or multiple files' information can be retrieved by one retrieve file list operation (use of wildcard is allowed). The O-RU Controller triggers the retrieve file list operation from the O-RU. The following rpc is used for retrieve file list operation: • rpc: retrieve-file-list - input logical path: the logical path of files to be retrieved (* is allowed as wild-card) file-name-filter: the files which has the "file name filter" in the file name (* is allowed as wild-card) - output status: whether O-RU accepted or rejected the retrieve file list request reject-reason: the human readable reason why O-RU rejects the request (only applicable if status is rejected) file list ETSI ETSI TS 104 023 V17.1.0 (2026-01) 118 In rpc-reply, status whether the O-RU accepts the retrieve-file-list request or rejects due to some reason is replied. If rejected, the human readable reject reason is also replied. Figure 12.4-1 shows the retrieve file list sequence diagram. Figure 12.4-1: Retrieve File List Sequence |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 12.5 File management operation: download | This clause describes the file download method from O-RU Controller to O-RU. sFTP or FTPES is used for File management, and one file can be downloaded by one download operation. O-RU Controller triggers the file download operation to O-RU. Simultaneous multiple file download operations can be supported under the same FTP connection between the O-RU and O-DU/SMO. If the O-RU has the number of limitation to download simultaneously as a capability, it is allowed that the O-RU reports a failure notification for the download request which is larger than the capability. The behaviour of the O-RU Controller is out of scope when O-DU/SMO receives failure notification from O-RU. The following rpc is used for download operation: • rpc: file-download - input local-logical-file-path: the logical path of file to be downloaded (no wildcard is allowed) remote-file-path: URI of file on the fileserver - output status: whether O-RU accepted or rejected the download request reject-reason: the human readable reason why O-RU rejects the request (only applicable if status is rejected) The O-RU shall reject any file-download rpc where the local-logical-file-path starts with "o-ran/log/", "o-ran/pm/", "o-ran/transceiver/" or "o-ran/security/". In rpc-reply, status whether the O-RU receives the download request or rejects due to some reason (e.g. the number of limitation to download simultaneously) is replied. If rejected, the human readable reject reason is also replied. In notification, the result of the download process (successfully downloaded or download is failure) is replied in addition to the local-logical-file-path and remote-file-path. If failure, the human readable reason is also replied. Figure 12.5-1 below shows the file download sequence diagram. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 119 Figure 12.5-1: File Download Sequence |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13 Synchronization aspects | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.1 Introduction | This clause describes the YANG model (o-ran-sync.yang) containers that are used for the Management Plane's interactions with various aspects of the time synchronization of the O-RU. In general, the O-RU shall manage its synchronization status and select one or more synchronization input source(s) (based on vendor specific implementation). Additional information regarding the interactions between M-Plane and S-Plane are described in the current specification's clause 15.3.3 and in the CUS-Plane specification [2], clause 11.4. The o-ran-sync.yang YANG model defines configuration, status and notification containers which are used to enable O-RU controller to recover the state of the O-RU's S-Plane. Before going into the details of each of these an overview of these objects is provided here. The YANG model defines several configuration containers. These containers comprise read/write parameters that can be read or set by the O-RU controller. The O-RU controller can read them (to determine O-RU configuration) or set them (to change the O-RU's configuration). These are: • PTP Configuration - ptp-config: O-RU controller can set or read PTP parameters like PTP Full/Partial timing support profiles, accepted clock classes, and set network address among other parameters • PLFS/SyncE Configuration - synce-config: This container provides SyncE information such as the acceptable list of SSMs. • GNSS (Global Network Satellite System) Configuration - gnss-config: This container comprises leaves which define whether GNNS can be used, and if so which satellite constellation to use. • Sync Capability - sync-capability: This is a read-only container indicates to the O-RU controller the time accuracy of the T-TSC or T-BC that is integrated into the O-RU. The O-RU should store the above synchronization configuration in reset persistent memory. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 120 During the start -up installation process (see clause 6.1) the O-RU's default startup configuration settings may allow the O-RU's S-Plane to become operational without any configuration by the O-RU controller. The O-RU uses its default configuration settings to execute the PTP and/or PLFS/SyncE protocols, or GNSS settings to complete the synchronization process (including optional features such as PER-PORT-PTP-CONFIG, PER-PORT-SYNCE- CONFIG, GNSS, ANTI-JAM). During the start-up installation flow the startup settings may be changed. This may be necessary if the default synchronization settings are incompatible with the network implementation. If the startup configuration requires changes, the O-RU controller first retrieves the synchronization configuration and status from O-RU, and then the O-RU controller modifies the configuration. The O-RU then executes the synchronization process using the updated settings. Having these settings stored in reset persistent memory typically simplifies subsequent startup flows by enabling O-RU to start up without reconfiguration. Once the O-RU is operational, the O-RU controller can subscribe to several synchronization notifications which report to the O-RU controller the status of the O-RU. The following notifications are defined in the YANG model: • synchronization-state-change - conveys the sync-state. • ptp-state-change - conveys the ptp-status. • synce-state-change - If SyncE or another PLFS is used, this conveys the synce-status. • gnss-state-change - If a O-RU supports GNSS capability, this conveys the gnss-status. During normal operation, the O-DU should monitor the operational state of the O-RU's S-Plane. This is accomplished by subscribing to receive the synchronisation-state-change notification. If the O-DU is notified that the O-RU's state has changed to UNLOCKED, the O-DU shall stop sending data to the O-RU and shall ignore any data from that O-RU. Clause 15.3.3 describes in more detail the interactions between S-Plane and M-Plane when synchronization is lost and when synchronization is recovered. NOTE: Except for possible configuration during the start-up installation process, the synchronization start-up and reference clock selection are accomplished via S-Plane protocols independent of M-Plane. The remainder of this clause describes in more detail the main objects within the configuration, status, and notification containers. However, this clause does not describe all of the leafs/objects within the containers. Some items for example time-error, frequency-error, supported-reference-type are not mentioned in this clause, but are defined and described in o-ran-sync.yang. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.2 Sync status object | This sync-state container provides synchronization state of the module. If the O-RU Controller is interested in receiving Synchronization status state information, it may configure a subscription to the synchronization-state-change notification from the O-RU. Event notifications will be sent whenever the state of the O-RU synchronization changes. For an O-DU that is communicating with an O-RU, the synchronization-state-change notification is the primary mechanism by which the O-DU knows whether the O-RU is synchronized and is ready to transmit/receive when fully configured. This notification is the primary mechanism to transfer status information required to implement the flows described in clause 15.3.3. The state diagram of O-RU synchronization is shown in Figure 13.2-1, and is indicated by the following allowed values: • LOCKED: O-RU is in the locked mode, as defined in Recommendation ITU-T G.810 [23]. • HOLDOVER: O-RU clock is in holdover mode. • FREERUN: O-RU clock is not locked to an input reference and is not in the holdover mode. Figure 13.2-1 illustrated the state transitions. The sync-state container allows the O-RU to list via an array of the synchronization sources, called supported-reference-types, which it can support. The allowed values are: • GNSS • PTP ETSI ETSI TS 104 023 V17.1.0 (2026-01) 121 • SYNCE NOTE: HOLDOVER mode is optional and depends on internal O-RU design. Figure 13.2-1: Allowed sync state transitions |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.3 Sync capability object | The module's synchronization capability is provided via the sync-t-tsc object. This object indicates the accuracy of the O-RU's derived Telecom Subordinate Clock (T-TSC). For details on the actual capability levels, see clause 11.3 of the O-RAN WG4 CUS plane specification [2]. There are two enumerations possible: • CLASS_B: Regular accuracy (previously referred to class B) for synchronization is supported by the device as per IEEE 802.1CM [80] clause 6.4.1, Case 1.1. • ENHANCED: Enhanced accuracy for synchronization is supported by the device as per IEEE802.1CM [80] clause 6.4.1, Case 1.2. Other leaves in this container include: • a Boolean called boundary-clock-supported, which indicates whether the O-RU supports T-BC profiles defined in Recommendation ITU-T 8275.1 [22]. • a Boolean called extended-ql-tlv-supported, which indicates whether the O-RU supports the extended Quality Level TLV defined in Recommendation ITU-T 8264 [76] clause 11.3. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 122 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.4 PTP configuration | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.4.1 Introduction | The ptp-config container contains information about the O-RU's configuration of Precision Time Protocol. This clause describes the definitions of the items contained within ptp-config. domain-number: This parameter indicates the Domain Number for PTP announce messages. Allowed values: 0 ~ 255. • Recommendation ITU-T G.8275.1 [22] uses domain numbers in the range 24...43, but the entire range is allowed to ensure flexibility of the M-Plane specification. For Recommendation ITU-T G.8275.2 [90] domain numbers from range 44…63 shall be used. default: 24. accepted-clock-classes: Contains the list of PTP acceptable Clock Classes, sorted in the descending order. • The sender shall generate the list of acceptable clock classes. The list shall be sorted in descending order. Each accepted Clock Class value shall appear only once in the list. Depending on implementation, the receiver may interpret the list in either of two ways: a) use only the first (i.e. the maximum) item in the list, interpreting it as a threshold value for acceptable clock classes, while ignoring all other items in the list; b) use the whole list, interpreting it as an explicit list of acceptable clock classes. default: 7, 6 clock-classes: The PTP Clock Class accepted by the O-RU. Allowed values: 0 ~ 255. • Not all values are compliant to [22], but the entire range is allowed in M-plane specification to ensure flexibility. The values can be validated/filtered on the receiver side, if necessary. ptp-profile: Defines which PTP profile will be used. • Allowed values: - G_8275_1 (multicast over Ethernet will be used, see Recommendation ITU-T G.8275.1 [22]) - G_8275_2 (unicast over IP will be used, see Recommendation ITU-T G.8275.2 [90]) default: G_8275_1. delay-asymmetry: Defines the static phase error in the recovered PTP timing signal to be compensated at the O-RU. The error is defined in units of nanoseconds in the range ±10 000 ns. This is a single global value that is common for all the O-RU's ports. As specified in Recommendation ITU-T G.810 [23] and IEEE 1588 [24] and [50], the sign of the parameter shall be interpreted as follows: • If the phase error to be compensated is negative, then the recovered timing signal shall be advanced by the time interval equal to the configured value to compensate the error. • If the phase error to be compensated is positive, then the recovered timing signal shall be delayed by the time interval equal to the configured value to compensate the error. default: 0 Modification of this parameter may have impact on RF transmission but shall occur without unit restart. This parameter is optional for support. If the O-RU does not support this value, the O-RU uses the default value. If the O-RU does not support manual compensation, it ignores the parameter setting. Granularity of the applied value depends on the architecture and implementation of the system clock, and therefore, may vary across vendors. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 123 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.4.2 G.8275.1 specific parameters | This container within ptp-config, called g-8275-1-config, is used when ptp-profile is set to G_8275_1. When enabled it instantiates multicast-mac -address. The parameter defines the destination MAC address, used by the O-RU in the egress PTP messages. This is a common configuration parameter for all G.8275.1 compliant ports of the O-RU. • Allowed values: - FORWARDABLE (means that PTP shall use 01-1B-19-00-00-00 destination MAC address) - NONFORWARDABLE (means that PTP shall use 01-80-C2-00-00-0E destination MAC address) default: FORWARDABLE. sources: When PER-PORT-PTP-CONFIG optional feature is supported, this parameter contains several ITU-T G.8275.1-specific configuration parameters determining optional attributes for each of the physical ports defined by local-port-number. Descriptions for these can be found in o-ran-sync.yang. • time-transmitter-only: (default: FALSE) When set to TRUE, this optional parameter forces all PTP ports assigned to the physical port to act only as a TimeTransmitter one, i.e. they cannot be selected as time source for the O-RU. When set to FALSE, the O-RU can determine the port state without this restriction. • not-time-transmitter: (default : FALSE) When set to TRUE, this optional parameter prevents all PTP ports assigned to the physical port from acting as a TimeTransmitter one, i.e. they cannot deliver time from the O-RU. When set to FALSE, the O-RU can determine the port state without this restriction. • local-priority: (default : 128) This optional parameter allows configuring a common local priority for all PTP ports assigned to the physical port, used in the ITU-T G.8275.1 best PTP source selection (ABTCA). The lower the value, the higher the priority. Time-transmitter-only and not-time-transmitter shall not be set to TRUE simultaneously. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.4.3 G.8275.2 specific parameters | This container, g-8275-2-config, within ptp-config contains G.8275.2 specific parameters. It is used with ptp-profile is set to G_8275_2. The full list of fields within this container and their meaning are listed directly in the YANG model. local-ip-port: The parameter defines local IP address which will be used as a port for receiving ptp signal. master-ip-configuration: The parameter defines list of IP configuration of devices acting as PTP signal source. local-priority: The parameter defines local priority or underlying master IP address. ip-address: This parameter defines master IP address. log-inter-sync-period: The parameter defines number of sync message during 1 second. Allowed values: 0 ~ -7 (this represents the value from 1 message per second to 128 messages per second). log-inter-announce-period: The parameter defines number of announce message during 1 second. Allowed values: 0 ~ -3 (this represents the value from 1 message per second to 8 messages per second). ETSI ETSI TS 104 023 V17.1.0 (2026-01) 124 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.5 PTP status | The PTP Status container is used to collect operational status information of the PTP clock, controlled by the O-RU. The object may be used to display operational information, which facilitates troubleshooting, to the operator. The information in the object shall not be used by the O-DU to autonomously alter its operation. If the O-RU Controller is interested in PTP status, it may configure a subscription to the ptp-state-change notification in the O-RU. Notifications will only indicate changes to the lock-state. Before requesting or subscribing to PTP status information, the O-RU Controller shall ensure that PTP is supported by the O-RU by requesting the supported-timing-reference-types, as defined in clause 13.2. The following list includes the related parameters of this container. reporting-period: This parameter defines minimum period in seconds between reports, sent by the O-RU, for parameters in this container. default : 10 lock-state: This parameter indicates whether the integrated clock is synchronizing to the reference, recovered from PTP flow. The exact definition when to indicate locked or unlocked is up to specific implementation. • LOCKED: The integrated clock is synchronizing to the reference, recovered from PTP flow. • UNLOCKED: The integrated clock is not synchronizing to the reference, recovered from PTP flow. clock-class: This parameter contains the clock class of the clock, controlled by the O-RU. sources: This parameter contains several parameters describing the characteristics of PTP sources of the clock, controlled by the O-RU. Descriptions for these can be found in o-ran-sync.yang. state: This parameter indicates status of the PTP port: • PARENT: Indicates that the PTP signal from this source is currently used as a synchronization reference. • OK: Indicates that the PTP signal from this source can be potentially used as a synchronization reference, i.e. Announce messages, received from this source, contain acceptable content (domain-number, clock-class, flags, etc.). • NOK: Indicates that the PTP signal from this source cannot be used as a synchronization reference, i.e. Announce messages, received from this source, contain unacceptable content (domain number, clockclass, flags, etc.). • DISABLED: Indicates that PTP connection is not available from this PTP source. See the related o-ran-sync YANG Model for additional information on the contents of the ptp-status container. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.6 PLFS/SyncE configuration | The CUS-Plane Specification allows for different methods of PLFS (Physical Layer Frequency Synchronization), however only the use of SyncE is defined in the present document. The synce-config container defines the configuration of SyncE. The following list includes the related parameters of this container. acceptance-list-of-ssm: The parameter contains the list of SyncE acceptable Synchronization Status Messages (SSM). NOTE 1: The extended SSM TLV in not supported in the present document, and YANG definitions. Allowed values: • ePRTC (enhanced Primary Reference Time Clock, note 2) • PRTC (Primary Reference Time Clock, note 2) • ePRC (enhanced Primary Reference Clock, note 2) • PRC (Primary Reference Clock) • PRS (Primary Reference Source-Stratum 1) ETSI ETSI TS 104 023 V17.1.0 (2026-01) 125 • SSU_A (Synchronization Supply Unit A) • SSU_B (Synchronization Supply Unit B) • ST2 (Stratum 2) • ST3 (Stratum 3) • ST3E (Stratum 3E) • eEEC (enhanced Ethernet Equipment Clock, note 2) • EEC1 (Ethernet Equipment Clock 1) • EEC2 (Ethernet Equipment Clock 2) • DNU (Do Not Use) • NONE NOTE 2: These values are ignored when extended-ql-tlv-supported capability is FALSE. ssm-timeout: The parameter contains the value of maximum duration in seconds for which the actual SSM value may be different than configured values. sources: When PER-PORT-SYNCE-CONFIG optional feature is supported, this parameter contains several ITU-T G.781-specific configuration parameters determining more detailed attributes for each of the physical ports defined by local-port-number. Descriptions for these can be found in o-ran-sync.yang. • ssm-send-enable: (default : FALSE) When set to TRUE, this optional parameter allows all SyncE ports assigned to the physical port to send SSM Quality Level, i.e. it can be used to synchronize downstream clocks. When set to FALSE, the O-RU does not send the SSM Quality Level. • local-priority: (default : 0) This optional parameter allows configuring a common local priority for all SyncE ports assigned to the physical port, used in the Recommendation ITU-T G.781 [81] best SyncE source selection. The lower the value, the higher the priority, except for value 0 that removes the port from the selection process. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.7 PLFS/SyncE status | The synce-status container is used to collect operational status information of SyncE reference on a node, controlled by O-RU. If the O-RU Controller is interested in SyncE status, it may configure a subscription to the synce-state-change notification in the O-RU. Notifications will only indicate changes to the lock-state. Before requesting or subscribing to SyncE status information, the O-RU Controller shall ensure that SyncE is supported at the O-RU by requesting the supported timing reference types, as defined earlier in clause 13.2. The following list summarizes the related parameters of this container. reporting-period: This parameter defines minimum period in seconds between reports, sent by the O-RU, for parameters in this container. default: 10 lock-state: This parameter indicates whether the integrated ordinary clock is synchronizing to the reference, recovered from the SyncE signal. The exact definition when to indicate locked or unlocked is up to specific implementation. • LOCKED: The integrated ordinary clock is synchronizing to the reference, recovered from the SyncE signal. • UNLOCKED: The integrated ordinary clock is not synchronizing to the reference, recovered from the SyncE signal. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 126 sources: This parameter contains characteristics of SyncE sources of the clock, controlled by the NETCONF Server, and reporting optional attributes for each of the physical ports defined by local-port-number. Descriptions for these can be found in o-ran-sync.yang. state: This parameter indicates status of the SyncE source: • PARENT: Indicates that the SyncE signal from this source is currently used as a synchronization reference. • OK: Indicates that the SyncE signal from this source can be potentially used as a synchronization reference, i.e. SSM messages, received from this source, contain acceptable clock quality level. • NOK: Indicates that the SyncE signal from this source cannot be used as a synchronization reference, i.e. SSM messages, received from this source, contain unacceptable clock quality level. • DISABLED: Indicates that SSMs are not received from this SyncE source. quality-level: This parameter contains value of the SSM clock quality level, received in SSM messages from the SyncE source. Unit is uint8, e.g. PRC SSM QL is reported as 0x02. ssm-quality-level: this parameter contains human-readable value of the extended clock quality level, received in SSM messages from the SyncE source. Unit is ssm-code enumeration as specified in clause 13.6 of the present document, e.g. ePRC enhanced SSM QL is reported as ePRC. The following optional parameters can also be reported if extended-ql-tlv-supported capability is TRUE, as per Recommendation ITU-T G.8264 [76] clause 11.3. They report what is received on the port in SSM messages from the SyncE source: • enhanced-ssm-code: Unit is uint8, e.g. ePRC enhanced SSM QL is reported as 0x23. • originator-synce-clock-id: this parameter contains the clockIdentity of the originator clock. Unit is uint64, e.g. 0x0123456789ABCDEF. • flag0-mixed-eec-eeec: Boolean meaning mixed EEC/eEEC (i.e. TRUE if at least one of the clocks is not an eEEC; FALSE if all clocks are eEEC). • flag1-partial-chain: Boolean meaning means partial chain (i.e. TRUE , if the TLV has been generated in the middle of the chain and the count of the EEC/eEEC is incomplete, FALSE otherwise). • number-of-eeec: the number of cascaded eEECs from the nearest SSU/PRC/ePRC. Unit is uint8. • number-of-eec: the number of cascaded EECs from the nearest SSU/PRC/ePRC. Unit is uint8. See the related o-ran-sync.yang YANG Model for the full details. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.8 GNSS configuration | The gnss-config container defines the configuration of Global Navigation Satellite System (GNSS). The following list summarizes the related parameters of this container. enable: This parameter defines if GNSS receiver shall be enabled or not. Allowed values: true/false; default: false satellite-constellation-list: This parameter defines list of constellations to be used to acquire synchronization. • Allowed values: - GPS - GLONASS - GALILEO - BEIDOU ETSI ETSI TS 104 023 V17.1.0 (2026-01) 127 polarity: This parameter defines pulse polarity. • Allowed values: - POSITIVE - NEGATIVE default: POSITIVE cable-delay: This parameter is used to compensate cable delay. Allowed values: 0 ~ 1000. default: 5 NOTE: This value is given in ns (nanoseconds) it is recommended to compensate 5ns per each meter of the cable. anti-jam-enable {if feature GNSS-ANTI-JAM}: This parameter is used to enable or disable anti-jamming. Allowed values: true/false. default: false. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 13.9 GNSS status | An O-RU supporting GNSS capability uses the gnss-status container to report the state of its GNSS receiver. If the O-RU Controller is interested in GNSS status, it may configure a subscription to the gnss-state-change notification in the O-RU before requesting or subscribing the GNSS status information. Notifications will only provide changes to the gnss-status. The O-RU Controller shall ensure that GNSS is supported by the O-RU by requesting supported timing reference types, as defined in clause 13.2. The following list summarizes the related parameters of this container. gnss-status: This parameter indicates the status of the GNSS receiver: • SYNCHRONIZED: Indicates that the GNSS receiver is synchronized. • ACQUIRING-SYNC: Indicates the GNSS receiver is functioning correctly, but has not acquired synchronization. • ANTENNA-DISCONNECTED: Indicates the GNSS receiver is reporting that its antenna is disconnected. • INITIALIZING: Indicates that the GNSS receiver is initializing. • ANTENNA-SHORT-CIRCUIT: Indicates that the GNSS receiver is reporting that its antenna is short circuited. Additionally, when the GNSS receiver is synchronized, the O-RU can report the following additional information: • satellites-tracked: The number of satellites being tracked by the O-RU receiver. • altitude, latitude and longitude: The geospatial location reported by the GNSS receiver. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14 Operations use cases | 14.1 Supervision failure handling and supervision termination handling |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.1.1 Supervision failure handling | This clause clarifies Supervision Failure Handling and Supervision Termination Handling. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 128 When Supervision Failure is detected by O-RU, the O-RU immediately disables operation of the watchdog timers for the corresponding NETCONF session. O-RU assumes NETCONF session related to failed supervision is no longer valid. O-RU terminates this invalid NETCONF session by closing underlying SSH or TLS connection. Then O-RU starts performing the call home procedure towards the NETCONF client, using the re-call-home-no-ssh-timer to repeat the call home attempts. This activity is repeated by the O-RU until, either: • New NETCONF session is established by the original NETCONF client; or • The original NETCONF client is no longer a "call home O-RU Controller" as defined in clause 6.3, e.g. when reperforming DHCP configuration, the O-RU Controller identity corresponding to the NETCONF client is no longer signalled by the DHCP server, and/or the NETCONF client was previously configured using the configured-client-info container and this configuration has been deleted. Case #1: After entering Supervision Failure handling, the O-RU is still having at least one running and valid NETCONF session with a NETCONF client that has subscribed to receive the supervision-notification and where the per-odu-monitoring container is not present in the O-RU's configuration. The O-RU remains operational and performs periodical Call Home towards call home O-RU controllers as described in clause 6.3. Case #2: After entering Supervision Failure handling, the O-RU does not have running NETCONF session with any NETCONF client that has subscribed to receive the supervision-notification. The O-RU ceases all radio transmission and performs autonomous reset. When an O-RU indicates it supports the SHARED-ORU-MULTI-ODU feature, an O-RU Controller can enable supervision operation on a per O-DU identity basis by configuring one or more odu-id parameters in the per-odu- monitoring container in o-ran-supervision YANG model. When an odu-id has been configured in the per-odu- monitoring container, the O-RU shall enable operation of watchdog supervision timers (supervision timer and notification timer) on a per odu-id basis. When enabled, an O-RU controller that has subscribed to the supervision- notification is expected to configure one of the odu-id values in the supervision-watchdog-reset rpc. Operation of watchdog supervision timers on a per o-du basis does not obviate the O-RU from performing autonomous reset according to the scenario described in case #2 above. NOTE: The format of the odu-id string is not defined and not interpreted by the shared O-RU. Case #3: If the supervision timer associated with an odu-id expires, the O-RU shall set the state leaf of the following array carriers to DISABLED and the active leaf of the same carriers to INACTIVE: Any tx-array-carriers list entry including a list of odu-ids containing only expired odu-id. Any rx-array-carriers list entry including a list of odu-ids containing only expired odu-id. O-RU shall raise an alarm. The specific alarm #35 "Lost O-DU ID based Supervision " is described in Annex A. The O-RU sends tx-array-carriers-state-change and rx-array-carriers-state-change notifications to any notification subscribers. O-RU shall not perform an autonomous reset unless the requirements described in case #2 are met. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.1.2 Supervision termination handling | If NETCONF session used for the supervision subscription is terminated by NETCONF client, the O-RU disables operation of the watchdog timers for terminated NETCONF session and starts performing Call Home procedure towards call home O-RU Controllers, following specification in clause 6.3. Before terminating its NETCONF session, a NETCONF client that has subscribed to receive supervision notification, should at least de-activate all carriers previously configured by this NETCONF client. Optionally, such a NETCONF client can also remove (full or partial) configuration applied by this NETCONF client to the O-RU. If the per-odu-monitoring container is not present in the O-RU's configuration, in case when entering Supervision Termination handling, if the O-RU does not have running NETCONF session with any NETCONF client that has subscribed to receive the supervision-notification, the O-RU ceases all radio transmission. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 129 If the per-odu-monitoring container is present in the O-RU's configuration, in case when entering Supervision Termination handling, the O-RU deactivates the array carriers associated with the odu-id value in its supervision- watchdog-reset rpc as specified in clause 14.1.1. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.2 Log management | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.2.1 Introduction | There are three type of log managements, troubleshooting log, security log and trace log. They are independent each other. Troubleshooting log file contains the logs continuously collected before <start-troubleshooting-logs> rpc. Any logs collected after <start-troubleshooting-logs> rpc are not contained. Trace log file contains the logs continuously collected after <start-trace-logs> rpc. Any logs collected before <start-trace-logs> rpc are not contained. Security log files contain logs of security event information. The creation and storage of security log-data by the O-RU shall always be possible, i.e. there is no O-RAN defined procedure for starting or stopping the logging of security events. An O-RU indicates it supports O-RAN defined security logging procedures by including the SECURITY-LOGGING feature in its YANG library. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.2.2 Troubleshooting log management | By requesting trouble shooting log files an O-RU controller is able to obtain collected log data files that can be used for troubleshooting purposes. The O-RU can provide all possible troubleshooting log files. The contents and log formats are dependent on O-RU implementation. The number and size of files provided by O-RU is not restricted but the O-RU may keep the number and size of files reasonably small to allow completion of the whole "Troubleshooting data upload" scenario (all files) within 15 minutes (with target to complete within 3 minutes) - assuming no additional upload restrictions from connectivity bandwidth or file server implementation. It is also recommended to provide more useful files first. NOTE 1: The detailed O-RU controller behaviour is not specified. An O-RU controller can continue the scenario till completion past the allowed time or skip requesting further files. The files should be compressed with compression method indicated by file name extension: • .gz (DEFLATE); • .lz4 (LZ4); • .xz (LZMA2 - xz utils); • .zip (DEFLATE - zlib library). O-RU collects log information. The RPC <start-troubleshooting-logs> triggers the O-RU to start generating troubleshooting log files containing troubleshooting logs, as illustrated in Figure 14.2.2-1. Completed generation of files is indicated by NETCONF server to NETCONF client in form of a notification. The notification <troubleshooting-log-generated> is signalled to the notification subscriber after the O-RU has finished generation of all troubleshooting log files, indicating to the subscriber that the troubleshooting log files are ready to be uploaded. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 130 Figure 14.2.2-1: Start Generation of Troubleshooting Log Files The O-RU shall include file names for troubleshooting log files in the <troubleshooting-log-generated> notification, with illustrative notification contents shown in Figure 14.2.2-2. After sending the notification, the O-RU shall stop generating further troubleshooting log files unless a new RPC <start- troubleshooting-logs> is triggered. The file transfer for the generated troubleshooting log files shall be handled by the file management defined in clause 12. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 131 Figure 14.2.2-2: Notification Troubleshooting Log Generated NOTE 2: Prior to version 10, the present document contained inconsistent definition of the log-file-name string between Figure 14.2.2-2 and associated YANG models. In present document previously permitted content of node log-file-name is considered as not preferred. Not preferred file formats may be subject to removal in a future version of the present document. NETCONF client cancels generation of troubleshooting logs files using RPC <stop-troubleshooting-logs>. The NETCONF client is no longer interested in troubleshooting log files and O-RU does not need to send <troubleshooting- log-generated> notification, as illustrated in Figure 14.2.2-3. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 132 Figure 14.2.2-3: Stop Generation of Troubleshooting Logs The overall troubleshooting log behaviour is illustrated in Figure 14.2.2-4. It contains 2 cases, successful notification case with illustrative notification contents and no notification as abnormal case. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 133 Figure 14.2.2-4: Overall Troubleshooting Log behaviour ETSI ETSI TS 104 023 V17.1.0 (2026-01) 134 NOTE 3: Prior to version 10, the present document contained inconsistent definition of the log-file-name string between Figure 14.2.2-4 and associated YANG models. In present document previously permitted content of node log-file-name is considered as not preferred. Not preferred file formats may be subject to removal in a future version of the present document. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.2.3 Security logs | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.2.3.1 Security log format | An O-RU supporting the SECURITY-LOGGING feature shall ensure that the fields of individual security logs comply with the security log field requirements as specified in clause 5.3.8.8 of O-RAN Security Requirements Specifications [83]. The security logging by such an O-RU shall include the events mapped to an O-RAN Network Function in table 5.3.8.11.1-1 of [83]. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.2.3.2 Security log management | There is no defined procedure for starting or stopping the logging of security events. The security log data shall be integrity protected and persistently stored in a non-volatile memory. An O-RU supporting the SECURITY-LOGGING feature shall support the configuration of log-data rotation functionality. Log-rotation refers to closing a first log file and opening a second new log file. A log file can be closed based on a configured time interval, using the security-log-max-duration leaf, and/or a configured maximum size, using the security-log-max-size leaf. An O-RU may expose read-only data pertaining to the maximum size of the security log storage media using the leaf security-folder-memory-size. The O-RU controller should configure log rotation parameters such that the size of a security log file does not exceed the maximum storage available in the O-RU. NOTE 1: How the O-RU Controller uses the value of security-folder-memory-size and/or other available information to determine the log rotation parameters is out of scope of the present document. The O-RU controller can arbitrarily decide to trigger the rotation of the current security log by sending the rotate-security-log rpc to the O-RU. An O-RU receiving the rotate-security-log rpc shall close the current security log file and open a new security log file. When a log file is rotated, the preserved integrity protected log file should be stored. The O-RU shall store the security log files in the o-ran/security/ folder in O-RU. NOTE 2: The details of the process used for file integrity protection is out of scope of the present document. The use by an O-RU of an encrypted file systems and/or encrypted folders to protect security logging data at rest are out of scope of the present document. The filename name for security logs shall be of the format: S<start-time>_<end-time>_<name>.<ext> • Starting with a capital letter "S". • Format of <start-time> and <end-time> can be local time or UTC. - Local time format is YYYYMMDDHHMM+HHMM, indicating, year, month, day, hour, minute, timezone "+" or "-" , hour and minute for the time zone. - UTC format is YYYYMMDDHHMMZ, indicating, year, month, day, hour, minute and with a special UTC designator ("Z") - Time zone offset is provided by timezone-utc-offset in o-ran-operation.yang. • <name> in ietf-hardware is used. • "_" underscore is located between <start-time>, <end-time> and <name>. • <ext> being the file extension. The extension shall indicate the archiving/encryption/compression method. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 135 The O-RU Controller shall configure one or more remote-security-log-upload-path and associated credential information in the O-RU. Once a security log file is closed, the O-RU shall upload the integrity protected preserved log file to the one or more configured security log servers. After successful upload to at least one server, the O-RU marks the file as being eligible to be overwritten. The O-RU shall send the security-log-upload-notification to notification subscribers indicating the output status of the security upload procedure. The overall security log procedure is illustrated in Figure 14.2.3-1. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 136 Figure 14.2.3-1: Security Log Operations ETSI ETSI TS 104 023 V17.1.0 (2026-01) 137 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.3 Trace | By requesting trace log files an O-RU controller is able to get them. Those trace log files contain collected log data files that can be used for trace purposes. The O-RU can provide all possible trace log files. The contents and log formats are dependent on O-RU implementation. The files should be compressed with compression method indicated by file name extension. O-RU shall start collecting the trace logs at the moment of receiving <start-trace-logs> rpc. Notification <trace-log- generated> shall be periodically sent to O-RU controller whenever generated trace log files is(are) ready. File names of newly created log file(s) shall be included in notification. The number and size of files provided by O-RU in a single <trace-log-generated> notification is not restricted but the O-RU may keep the number and size of files reasonably small to allow completion of the whole "Trace data upload" scenario (all files from notification) within 15 minutes (with target to complete within 3 minutes) - assuming no additional upload restrictions from connectivity bandwidth or file server implementation. NOTE 1: Timing of creating new group of trace log files is up to O-RU implementation. After <stop-trace-logs> rpc received from O-RU controller, O-RU is mandated to stop collecting trace logs and start generating trace log files which contain log data already collected after previous <trace-log-generated> notification. The overall procedure is shown in Figure 14.3-1, with illustrative notification contents. Figure 14.3-1 shows the O-RU last <trace-log-generated> notification with the is-notification-last::'true' and file names of trace log files being signalled to the notification subscriber. The file transfer mechanism for the created trace log files shall be handled by the file management described in clause 12. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 138 Figure 14.3-1: Overall Trace Log behaviour ETSI ETSI TS 104 023 V17.1.0 (2026-01) 139 NOTE 2: Prior to version 10, the present document contained inconsistent definition of the log-file-name string between Figure 14.3-1 and associated YANG models. In present document previously permitted content of node log-file-name is considered as not preferred. Not preferred file formats may be subject to removal in a future version of the present document. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.4 Operational aspects of antenna line devices | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.4.1 Introduction | An O-RU can connect to one or more external equipment including antenna line devices such as a RET, MultiRET, MHA, RAE, etc. • For the communication with antenna line devices, AISG 2.0 protocol [26] as Layer 7 application and HDLC protocol as Layer 2 data link are used. • HDLC protocol as specified in ISO/IEC 13239 [65]. Detailed information can also be found in ETSI TS 137 462 [27]. • AISG 2.0 protocol is standardised by "Control interface for antenna line devices Standard No. AISG v2.0" [26] which is an adaptation of Iuant interface application layer defined in ETSI TS 137 466 [28]. An O-RU may provide one or more ALD ports supporting connection with Antenna Line Devices. Each ALD port shall be able to support more than one ALD (i.e. a chained ALD configuration). Through the model O-RU may optionally inform about hardware relation between ALD port and O-RU connector(s) used by specific ALD port. In case more than one O-RU connector is used by single ALD port, O-RU may extend "overcurrent-report" notification by adding exact list of O-RU connectors for which overcurrent condition is detected. This clause describes the communication mechanisms based on AISG 2.0 protocol as specified in AISG 2.0 [26]. For communication with external equipment, AISG 2.0 uses Application Part protocols (RETAP, TMAAP, etc.) at Layer 7 and HDLC as a Layer 2 datalink protocol. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.4.2 HDLC interworking | HDLC protocol is standardised by ISO/IEC 13239 [65]. Detailed information can also be found in ETSI TS 137 462 [27]. NOTE: The assumed HDLC communication speed is 9 600 bits per second. In order to handle collision detection in the HDLC branch, an O-RU supporting the ALD functionality shall support the following running counters reported using the corresponding YANG model: • Frames with wrong FCS • Frames without stop flag • Number of received octets For running counters served by the O-RU, both the O-RU and NETCONF Client shall handle wrap-over mechanism in a way, that wrap over zero is not considered as erroneous situation. A NETCONF client can recover these counters. From the changes observed in above counters, a NETCONF Client can deduce the presence of a collision on the HDLC bus. Additional diagnostic information may be derived from how these counters are incrementing. Additionally, the O-RU implements "RPC Status" to indicate status of last "ald-communication" RPC to requestor. • Status - flow control indicator of last requested operation (Status of RPC). Prior to any communication with ALD(s), the O-RU shall provide ALDs with DC power. The way of how DC power is managed is out of scope of the present document. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 140 In order to support collision detection and flow control, Figure 14.4.2-1 defines the reference architecture with HDLC interworking functional split. RU Flow control FCS calculation FCS addition Start / stop flag addition Modulation FCS removal FCS control Start / stop flag removal Octet forming Start / stop flag detection Frames with wrong FCS Frames without stop flag Number of received octets Netconf Client Antenna Line Device note: can be chain of ALDs Netconf / Yang handler Netconf / Yang HDLC AISG (I-frame, U-frame), RETAP, TMAAP Modem Byte stuffing Byte un-stuffing ALD controller RPC Status Figure 14.4.2-1: ALD Reference Architecture The result of the above architecture is that below mentioned parts of HDLC message are processed by entities as illustrated in Figure 14.4.2-2. AISG message Flag 1 octet ADDR 1 octet Control 1 octet INFO N octets FCS 2 octets Flag 1 octet 0x7E Secondary station address Control bits Variable length CRC 0x7E HDLC frame RU Netconf Client RU Figure 14.4.2-2: Component's responsibility split |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.4.3 ALD operations | Figure 14.4.3-1 illustrates the ALD transfer procedure: 1) The NETCONF Client sends RPC <ald-communication> to the O-RU. The RPC has following input parameters: - leaf: ald-port-id (uint8) - contains the identity of the ALD port. The O-RU shall output the data to (corresponds to O-RU resources provided to NETCONF Client as inventory information). - leaf: ald-req-msg (up to 1 200 bytes) - may contain HDLC address, control bits and payload (see ETSI TS 137 462 [27] for details). The O-RU shall perform HDLC communication with the ALD as specified in [27] clause 4.5 "Message timing". 2) Immediately after the requested payload is sent to the ALD over the desired ALD port, the O-RU switches the ALD port into reception mode. 3) Bits received within reception window are formed to octets and inserted as payload into ald-resp-msg. 4) The O-RU responds to the NETCONF Client using the <rpc-reply> message containing following parameters: - leaf: ald-port-id (uint8) - leaf: status - leaf: ald-resp-msg (up to 1 200 bytes) ETSI ETSI TS 104 023 V17.1.0 (2026-01) 141 - leaf: frames-with-wrong-crc (4 bytes) - leaf: frames-without-stop-flag (4 bytes) - leaf: number-of-received-octets (4 bytes) In case there is no response from the ALD received within the reception window, the record "ald-resp-msg" in <rpc-reply> sent by the O-RU shall be empty. 5) After reception, the O-RU shall wait a minimum of 3ms before the next transmission as per ETSI TS 137 462 [27], clause 4.5 "Message timing". Figure 14.4.3-1: ALD Message Transfer General scenario for HDLC link establishment: Precondition: M-Plane connectivity between NETCONF Client and NETCONF Server is successfully established. NETCONF Server reports presence of the supported HDLC Primary Devices. Procedure: 1) NETCONF Client triggers DC voltage on desired ALD ports using NETCONF <edit-config> RPC. After DC is turned on - NETCONF Client shall wait at least 3 s. 2) NETCONF Client performs HDLC bus scan using desired HDLC Primary Device offered by O-RU. 3) NETCONF Client determines presence of HDLC Secondary Devices connected to the ALD port. 4) NETCONF Client assigns HDLC addresses to desired HDLC Secondary Devices using HDLC Secondary Device unique id obtained from step 3-4 or from other pre-configured sources. 5) NETCONF Client initiates link establishment with secondary devices by sending SNRM command and the secondary device answers with UA command which will be used in ald-resp-msg. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 142 6) NETCONF Client starts polling procedure for every HDLC-addressed Secondary Device. NETCONF client may skip step 2 and/or 3 in the procedure. HDLC speed alignment between ALD ports and secondary device(s) that supports multiple speeds is performed prior to step 2, 3, 4. For detail of speed alignment, refer to [88] clause 4.1. Postcondition: Detected and addressed HDLC Secondary Devices are available for configuration. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.5 Operational aspects of external IO | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.5.1 Introduction | An O-RU can connect to one or more input and output ports for external device supervision and control. The External IO has the following functions: • INPUT: Supervising external devices. • OUTPUT: Controlling external devices. Also, external IO function includes signalling to get the O-RU and O-RU controller in sync, enables port monitoring on the O-RU and provides notification from the O-RU to an O-RU controller, and provides control from an O-RU controller to the O-RU and enables output port controlling on the O-RU. The O-RU only implements external IO yang module if the O-RU supports External IO aspect. Through the model O-RU may optionally inform about hardware relation between External IO and O-RU connector(s) used by specific External IO. Separate O-RU connectors may be reported for single External IO. A change in condition of the external IO shall not affect other O-RU services such as RF transmission / reception behaviour. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.5.2 External input | This clause explains single external input line case. For multiple external inputs case, same behaviour for each input shall be processed individually. For input, the O-RU and O-RU controller shall support two scenarios, as illustrated in Figure 14.5.2-1. 1) To retrieve input state from O-RU controller and respond the input state from the O-RU to O-RU controller. 2) To send notification from the O-RU to O-RU controller when input state is changed. The value shall be: • TRUE: Circuit is open. • FALSE: Circuit is closed When nothing is connected to the line the value shall be TRUE. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 143 Figure 14.5.2-1: Retrieve external line-in |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.5.3 External output | This clause explains single external output line case. For multiple external outputs case, same behaviour for each output shall be processed individually. For output, the O-RU and O-RU controller shall support two scenarios, as illustrated in Figures 14.5.3-1 and 14.5.3-2. 1) To retrieve output state from O-RU controller and respond the output state from the O-RU to O-RU controller. 2) To send edit-config from the O-RU to O-RU controller when output state change is required. The value shall be: • TRUE: Circuit is open. • FALSE: Circuit is closed. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 144 The default values shall be TRUE. Figure 14.5.3-1: Retrieve external line-out ETSI ETSI TS 104 023 V17.1.0 (2026-01) 145 Figure 14.5.3-2: Control external line-out |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6 O-RU connectors | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.1 Introduction to O-RU connectors | The O-RU may indicate presence and label of its physical connectors of specific type. The O-RU connectors can be exposed through o-ran-hardware.yang module as objects of class "O-RU-CONNECTOR". In the present document, coaxial antenna connectors serving for antenna feeders and beamforming-calibration lines are introduced. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.2 Connectors related to antennas and antenna arrays | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.2.1 Antenna connectors | This clause describes usage of antenna connectors related to feeders (used to carry air interface signals between O-RU and external antennas or external antenna arrays) and beamforming calibration lines (used by O-RU i.e. to handle supplementary signals needed for external antenna arrays calibration). Exposed O-RU Connectors of class "O-RU-ANTENNA-CONNECTOR" are based on class "O-RU-CONNECTOR" and are used in o-ran-uplane-conf.yang module to show how feeders and beamforming calibration lines are related to antenna arrays and their array elements. This allows to align configuration with physical cabling that technicians need to connect between O-RU and external physical antenna array. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 146 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.2.2 Distinguishable types of antenna connectors | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.2.2.1 Feeder | Exposed O-RU connectors of class "O-RU-FEEDER" are based on class "O-RU-ANTENNA-CONNECTOR". Objects of this class are intended to represent physical connectors for coaxial feeders between O-RU and external antennas or antenna arrays. The feeder connector can be referenced by single array element of specific array, however in case the array element is shared between tx-array and rx-array or by multiband arrays, such O-RU connector is expected to be referenced by each of arrays containing array element fed with RF signals through such connector. For this class of O-RU connectors, name shown in the model shall be identical to the label of physical connector visible on the O-RU's enclosure. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.2.2.2 Beamforming calibration | Exposed O-RU connectors of class "O-RU-BF-CAL" are based on class "O-RU-ANTENNA-CONNECTOR". Objects of this class are intended to represent physical connectors for supplementary coaxial cables used in antenna calibration process for external antenna arrays. The beamforming calibration connector is to be referenced by group of array elements belonging to single array. This is also possible, that there will be references to few groups of array elements belonging to different antenna arrays (e.g. related tx-array and rx-array or arrays for different bands that share array elements). For this class of O-RU connectors, name shown in the model shall be identical to the label of physical connector visible on the O-RU's enclosure. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.3 Connectors related to other O-RU functions | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.3.1 Overview | This clause describes usage of other types of O-RU connectors physically available on O-RU's enclosure. Exposed O-RU Connectors of classes described in this clause are based on class "O-RU-CONNECTOR" and are used in o-ran-ald-port.yang and o-ran-externalio.yang module to show how these connectors are related to internal O-RU elements. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.3.2 RS-485 connectors | Exposed O-RU connectors of class "RS-485" are based on class "O-RU-CONNECTOR". Objects of this class are intended to represent physical connectors for RS-485 interface used e.g. for communication between O-RU and Antenna Line Devices. For this class of O-RU connectors, name shown in the model shall be identical to the label of physical connector visible on the O-RU's enclosure. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 14.6.3.3 External IO connectors | Exposed O-RU connectors of class "O-RU-EXTIO" are based on class "O-RU-CONNECTOR". Objects of this class are intended to represent physical connectors for externally available input / output lines that may optionally be offered by the O-RU. For this class of O-RU connectors, name shown in the model shall be identical to the label of physical connector visible on the O-RU's enclosure. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 147 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15 Details of O-RU operations | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.1 Retrieval of O-RU information | This clause provides handling for O-RU controller(s) to retrieve O-RU information from O-RU. The further actions such as SW Management, U-plane configuration and Performance Management use these retrieved O-RU information. The following information, for example, can be retrieved from the O-RU: hw/hardware/component - retrieve mfg-name - the name of the O-RU manufacturer - retrieve serial-num -- the serial number of the O-RU - retrieve software-rev - the version of the O-RU software build o-ran-hardware/hardware/component/ - retrieve product-code - the O-RAN defined product code o-ran-operations/operational-info/declarations - retrieve supported-mplane-version - the version of the O-RAN M-Plane interface - retrieve supported-cusplane-version - the version of the O-RAN CUS-Plane interface - retrieve supported-header-mechanism - the type of C/U plane headers supported by the O-RU o-ran-operations/operational-state - retrieve restart-cause - the reason for the last restart o-ran-sync/sync - retrieve sync-state - the synchronization state of the O-RU The detail of O-RU information, see corresponding YANG modules in Annex D. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.2 User plane message routing | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.2.1 Introduction | The purpose of U-Plane configuration is to define the relationship between U-Plane application endpoints in the O-DU and those in the O-RU. After such relationships are defined, the application endpoints are able to exchange IQ data using the U-Plane application protocol defined in clause 5.4 of [2]. Precondition: • M-Plane connectivity is established between NETCONF Client and NETCONF Server. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.2.2 Configurable format for eAxC_ID | The eAxC_ID is used by C/U-plane application to manage eCPRI communication between desired C/U-Plane application components in O-DU and O-RU. As defined in clause 5.1.3.2.7 of [2], the eAxC_ID consists of four parameters: DU_Port_ID, RU_Port_ID, CC_ID and BandSector_ID. Order of parameters in eAxC_ID shall follow definitions in CUS-Plane spec. In this version of the O-RAN WG4 specification, the length of eAxC_ID is constant and equal to 16 bits. To enable optimal sharing of the 16 bits between these four parameters, the assignment of eAxC_ID bits to parameters is not fixed. As a consequence, there is a need for NETCONF client to configure the bit assignment to parameters mappings using the M-Plane interface. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 148 NOTE 1: [2] refers to the eAxC_ID parameters as DU_Port_ID, RU_Port_ID, CC_ID and BandSector_ID and the present document and associated YANG models refer to the eaxc-id parameters as du-ports, ru-ports, cc-ids and band-sectors. To handle flexible bit assignment, configurable bitmasks are defined for each parameter. NOTE 2: Flexible configuration means, that bits of eAxC_ID can be assigned to parameters in runtime. Rules to be followed by NETCONF Client when configuring bit assignments: • notation used for parameters forming eAxC_ID is from the LSB. • each parameter uses consecutive bits. • each parameter can occupy 0-16 bits. • single bit of eAxC_ID cannot be assigned to more than one parameter. RPC edit-config shall be used to configure bit assignments to O-RU. Bit assignment change for parameters related to an existing carrier is not allowed. (Impacted carriers need to be deactivated and deleted prior to any change in eAxC_ID configuration, and then be subsequently created and activated.) An example of bit assignment usage where 3 bits are assigned to the BAND-SECTOR-ID, 3 bits for CC-ID, 7 bit for DU-PORT-ID and 3 bits for RU-PORT-ID is shown below: <du-port-bitmask>1111111000000000</du-port-bitmask> <band-sector-bitmask>0000000111000000</band-sector-bitmask> <ccid-bitmask>0000000000111000</ccid-bitmask> <ru-port-bitmask>0000000000000111</ru-port-bitmask> |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.2.3 U-Plane endpoint addressing | Parameter "eaxc-id" for low-level-tx-endpoint and low-level-rx-endpoint, defined using an unsigned 16-bit integer, shall follow the eaxc-id addressing schema defined in clause 15.2.2. Refer to the eaxc-id parameter description in CUS plane specification clause 5.1.3.2.7 of [2]. The NETCONF Client shall assign unique values to the "eaxc_id" addresses to all low-level-rx-endpoint elements and low-level-tx-endpoint elements, within the O-RU when operating in the same direction (Tx or Rx), even when these operate across different named interfaces of the O-RU. More precisely, the same eaxc-id cannot be simultaneously assigned to multiple low-level-rx-endpoints or to multiple and low-level-tx-endpoints. Clarifying eaxc-id assignment by example, and unless otherwise specified, within the same O-RU (considering a 2 × 2 MIMO): Case 1: Allowed eaxc-id assignment (same antenna ports used for Tx and Rx) low-level-rx-endpoint (name 1) - eaxc-id=1 low-level-tx-endpoint (name 1) - eaxc-id=1 low-level-rx-endpoint (name 2) - eaxc-id=2 low-level-tx-endpoint (name 2) - eaxc-id=2 Case 2: Allowed eaxc-id assignment (separate antenna ports used for Tx and Rx) low-level-rx-endpoint (name 1) - eaxc-id=1 low-level-tx-endpoint (name 1) - eaxc-id=2 low-level-rx-endpoint (name 2) - eaxc-id=3 low-level-tx-endpoint (name 2) - eaxc-id=4 ETSI ETSI TS 104 023 V17.1.0 (2026-01) 149 Case 3: Prohibited eaxc-id assignment (separate antenna ports used for Tx and Rx) low-level-rx-endpoint (name 1) - eaxc-id=1 low-level-tx-endpoint (name 1) - eaxc-id=2 low-level-rx-endpoint (name 2) - eaxc-id=1 low-level-tx-endpoint (name 2) - eaxc-id=2 The O-RU shall reject any configuration that corresponds to a prohibited eaxc-id assignment. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.2.4 General configuration scenario | Below is the general scenario to be followed by a NETCONF Client in order to properly configure communication between C/U-Plane endpoints in the O-DU and O-RU. Operations can be performed in other order (including combining some of them in one request) than provided below assumed the highlighted rules are followed and result (overall configuration) of each request sent by NETCONF Client is valid. NOTE 1: Selected highlighted rules below: eaxc-id is unique for all low-level-[tr]x-endpoints within the O-RU in the same direction (Tx or Rx) and linked with any low-level-rx-link or low-level-tx-link. at the moment of creation, every low-level-rx-link shall be linked to an existing rx-array-carrier, an existing low-level-rx-endpoint and an existing processing-element (or an existing transport- qualified-processing-element when the processing element is configured by the list additional- transport-session-type-elements). In this latter case, the O-RU shall use the /user-plane- configuration/low-level-rx-links/transport-qualified-processing-element schema nodes instead of the /user-plane-configuration/low-level-rx-links/processing-element schema node, an O-RU Controller shall still configure the processing-element schema node in the low-level-rx-links list with a leafref to valid ru-element, but this shall not be used by the O-RU. at the moment of creation, every low-level-tx-link shall be linked to an existing tx-array-carrier, an existing low-level-tx-endpoint and an existing processing-element (or an existing transport- qualified-processing-element when the processing element is configured by the list additional- transport-session-type-elements). In this latter case, the O-RU shall use the /user-plane- configuration/low-level-tx-links/transport-qualified-processing-element schema nodes instead of the /user-plane-configuration/low-level-tx-links/processing-element schema node, an O-RU Controller shall still configure the processing-element schema node in the low-level-tx-links list with a leafref to valid ru-element, but this shall not be used by the O-RU. 1) NETCONF Client determines the presence of following operational data offered by NETCONF Server: - tx-array(s) - by fetching the list of tx-arrays in o-ran-uplane-conf.yang - rx-array(s) - by fetching the list of rx-arrays in o-ran-uplane-conf.yang - endpoint-type(s) - by fetching list endpoint-types in o-ran-uplane-conf.yang - static-low-level-tx-endpoint element(s) - by fetching the list static-low-level-tx-endpoints in o-ran- uplane-conf.yang - static-low-level-rx-endpoint element(s) - by fetching the list static-low-level-rx-endpoints in o-ran- uplane-conf.yang - endpoint-capacity-sharing-group(s)- by fetching list endpoint-capacity-sharing-groups in o-ran-uplane- conf.yang if it is reported - endpoint-bf-profile-group(s) - by fetching list endpoint-bf-profile-group in o-ran-uplane-conf.yang if O-RU supports YANG feature BF-DELAY-PROFILE - interface(s)- by fetching list of interfaces in o-ran-interfaces.yang ETSI ETSI TS 104 023 V17.1.0 (2026-01) 150 - O-RU's connector(s) - by fetching list of related-o-ru-connectors (if exist) in o-ran-uplane-conf.yang 2) NETCONF Client determines capabilities exposed by endpoint-type(s), static-low-level-tx-endpoint(s) and static-low-level-rx-endpoint(s). Additionally. NETCONF Client determines capabilities exposed by endpoint-capacity-sharing-groups and specific parameters proprietary to [tr]x-array(s). 3) For operational data determined in step 1) NETCONF Client examines the relationship between: - static-low-level-tx-endpoint(s) and tx-array(s) in o-ran-uplane-conf.yang - static-low-level-rx-endpoint(s) and rx-array(s) in o-ran-uplane-conf.yang - endpoint-type and all static-low-level-[tr]x-endpoint(s) of this endpoint-type - each endpoint-capacity-sharing-group and member static-low-level-[tr]x-endpoint(s) - each endpoint-type and all endpoint-bf-profile-group(s) it supports - each static-low-level-tx-endpoint and interface - each static-low-level-rx-endpoint and interface - tx-array(s), rx-array(s) and their elements in o-ran-uplane-conf.yang - o-ru-connector(s) and [tr]x-array in o-ran-uplane-conf.yang (if available) - interface(s) and port(s) in ietf-interfaces.yang (with o-ran port-reference augmentation) NOTE 2: NETCONF Client retrieves the content of o-ran-beamforming.yang module to obtain knowledge regarding beamforming-related parameters that apply for particular NETCONF Server. This step is optional, as o-ran-beamforming.yang module exists only in case NETCONF Server supports beamforming. Obtained parameters are needed by Netconf Client to perform beamforming control. 4) NETCONF Client determines the endpoint's ability of all supported beamforming methods list and related delay profiles. Information about beamforming method lists supported by endpoints is exposed through parameter endpoint-bf-profile-group. If the beamforming method list does not report its associated supported-delay-profile, it uses the default bandwidth-scs-delay-state list to find its delay parameter values. Each bf-profile-id is used to identify an endpoint-bf-profile-group which indicates a list of beamforming methods that can be used simultaneously, and delay profiles associated with each list of beamforming methods. When O-RU indicates support for a combination of BF-METHOD(s) and associated delay-profile per endpoint, all endpoints supporting the same combination of BF-METHOD(s) shall advertise the same delay-profile value. Multiple bf-profile-id(s) capabilities can be exposed by endpoint-types. 5) NETCONF Client determines each static-low-level-rx-endpoint's ability to support non-time managed and/or time managed traffic. Information about managed delayed traffic type supported by an endpoint-type is exposed through parameter managed-delay-support (enumeration) and it indicates whether the endpoints of this particular endpoint-type can support time managed traffic (MANAGED), non-time managed traffic (NON_MANAGED), or both (BOTH). 6) NETCONF Client determines and selects static-low-level-rx-endpoint(s) and static-low-level-tx-endpoint(s), that are suitable for the desired O-DU cell configuration to be used for configuring array carriers. Example considerations for selection are listed below: Transport aspect: static-low-level-rx-endpoint and static-low-level-tx-endpoint selected should be accessible via the intended interface(s), extra consideration is needed for optional interface restrictions declared by static-low-level-[tr]x-endpoints Antenna array: O-DU's intention of which antenna array is going to be used by the O-DU cell related configuration will be input for selection Type of traffic: O-DU's intention of type of traffic to be used on endpoint, for example, non-time managed traffic or time managed traffic will be input for selection Beamforming type: O-DU's intention for beamforming type to be used for UL and DL will impact selection ETSI ETSI TS 104 023 V17.1.0 (2026-01) 151 7) NETCONF Client performs C/U-Plane transport configuration between O-DU and O-RU. NETCONF Client configures interfaces and creates processing-elements related to the interfaces offering access to selected endpoints (suitable in terms of capabilities and able to process signals related with desired [tr]x-array) and ports (suitable in terms of capabilities and able to transfer signals from/to a desired interface). Details of configuring interfaces and processing-elements are described in clause 7. 8) Once transport layer is configured, O-DU may perform initial verification of C/U Plane Transport Connectivity as described in clause 7.6 - with respect to content of list "restricted-interfaces" every selected endpoint is reachable through. 9) NETCONF Client creates low-level-tx-endpoints and low-level-rx-endpoints referring to static-low-level-tx- endpoints and static-low-level-rx-endpoints determined and selected in step 6) as suitable for desired array- carrier configuration. NETCONF Client assigns unique eaxc-id(s) values to every created low-level-[tr]x- endpoint. Obtained information from step 2)-5) shall be respected when NETCONF Client configures low- level-[tr]x-endpoints referenced to static-low-level[tr]x-endpoints by parameter name. NOTE 3: Uniqueness of eaxc-id is mandatory within the O-RU in the same direction (Tx or Rx) even across interface elements having relationship to low-level-rx-endpoint elements or low-level-tx-endpoint elements. In case NETCONF Client wants particular value of eAxC_ID to be used for non-time managed traffic, NETCONF Client shall assign this eAxC_ID to parameter "eaxc-id" belonging to low-level-rx-endpoint, that is capable to support non-time managed traffic (as per reference to capabilities exposed by corresponding static-low-level-rx-endpoint corresponding to low-level-rx-endpoint by name). When assigning eAxC_ID to a low-level-rx-endpoint, NETCONF Client shall also configure whether the low- level-rx-endpoint is to work in non-time-managed mode (when applicable) or not using non-time-managed- delay-enabled. NETCONF client shall not change time management types of a low-level-rx-endpoint in case there is traffic served by the endpoint. Configuration is assumed to be static for run-time. When NETCONF server declares that an endpoint supports multiple bf-profile-id(s), NETCONF Client may configure configured-bf-profile-id in the list of low-level-[tr]x-endpoint to one of the values reported in bf- profile-group reported in the related endpoint-type and the O-RU shall use it. If the NETCONF Client does not configure configured-bf-profile-id per endpoint, the O-RU shall use the beamforming method determined by section type supported by endpoint and default delay profile. 10) NETCONF Client creates tx-array-carrier(s) and rx-array-carrier(s). The tx-array-carriers and rx-array-carriers can be configured with type set to LTE, NR or DSS-LTE-NR. The configuration of array carrier with type DSS-LTE-NR is only allowed when the O-RU supports Dynamic Spectrum Sharing (DSS) feature as indicated by feature DSS_LTE_NR in o-ran-module-cap.yang. If the O-RU indicates it supports the feature DSS_LTE_NR but does not support Section Extension 9, then instead of configuring a carrier as DSS-LTE- NR, the O-DU shall configure DSS by using different eAxC ids (i.e. different endpoints) as described in CUS plane specification clause 7.2.6 of [2]. Table 15.2.4-1: Centre Bandwidth Calculation Type NRB Centre of channel bandwidth (same as FREF as defined in clause 5.4.2.1 of ETSI TS 138 104 [66]) LTE or DSS NRBmod2=1 Between (k-1) RE and k RE of nPRB RB NRBmod2=0 Between the highest RE of (nPRB-1) RB and k RE of nPRB RB NR NRBmod2=1 Centre of kth RE of nPRB RB NRBmod2=0 The parameters k, nPRB and NRB referenced here are specified in Table 5.4.2.2-1 of ETSI TS 138 104 [66]. 11) NETCONF Client creates low-level-[tr]x-link(s) to make relationship between low-level-[tr]x-endpoint(s), [tr]x-array-carriers and processing-elements belonging to transport. Respective TX path and RX path linkage shall be followed. This is illustrated in Figure 15.2.4-1. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 152 NOTE 4: C/U-Plane traffic can be prioritized by reference user-plane-uplink-marking indicated by low-level-rx- link in o-ran-uplane-conf.yang. The reference is to o-ran-processing-element.yang, where it is linked to up-marking-name. Further the up-marking-name points to o-ran-interfaces.yang, where it ends up pointing to priority depending on actually used u-plane transport (either PCP for Ethernet or DSCP for IP). For details regarding priorities see [2], clause 5.3. Figure 15.2.4-1: Diagram showing relations between CU-Plane and Carrier configuration elements Detailed contents of objects shown in "u-plane configuration" box in Figure 15.2.4-1 are defined in the o-ran-uplane- conf.yang module. High level sequences about carrier creation are described in clause 15.3.1. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3 Carrier configuration | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3.1 Carrier creation | This clause provides high level scenario for carrier creation procedure. Precondition for below steps are steps 1 to 6 from clause 15.2.4. The below steps are covered by steps 7 and 9 to 11 in clause 15.2.4 where those steps are described with more details. 1) NETCONF Client creates the tx-array-carriers in relation to the desired tx-arrays. NOTE 1: Generally the number of tx-array-carriers is the same as multiple of the desired number of tx-arrays and the number of component carriers. 2) NETCONF Client creates the rx-array-carriers in relation to the desired rx-arrays. NOTE 2: Generally the number of rx-array-carriers is the same as multiple of the desired number of rx-arrays and the number of component carriers. 3) NETCONF Client creates the processing-elements related to interfaces offering access to endpoints. 4) NETCONF Client creates low-level-tx-endpoints and low-level-rx-endpoints related to desired static-low- level-tx endpoints and static-low-level-rx-endpoints respectively. 5) NETCONF Client creates the low-level-tx-links containing relationship to the existing tx-array-carriers, low-level-tx-endpoints and existing processing-elements. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 153 6) NETCONF Client creates the low-level-rx-links containing the relationship to existing rx-array-carriers, low-level-rx-endpoints and existing processing-elements. With the above steps successfully performed, the relationship between C/U-Plane application endpoints at O-DU and O-RU is configured. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3.2 Activation, deactivation and sleep | The NETCONF Client performs activation of a tx/rx-array-carrier by setting the value of the parameter "active" at tx- array-carrier element / rx-array-carrier element to "ACTIVE". The NETCONF Client performs deactivation of a tx/rx-array-carrier by setting the value of the parameter "active" at tx- array-carrier element / rx-array-carrier element to "INACTIVE" Communication between related U-Plane endpoints is enabled under condition, that for corresponding tx-array-carrier or rx-array-carrier value of parameter "active" is "ACTIVE" and value of parameter "state" is "READY". Otherwise, communication is disabled. The NETCONF Client can put the tx-array-carrier / rx-array-carrier to sleep by setting value of parameter "active" in the corresponding tx-array-carrier element / rx-array-carrier element to "SLEEP". A particular tx-array-carrier / rx-array-carrier is in sleep mode when value of its parameter "active" is "SLEEP" and value of its parameter "state" is "READY". To save energy, O-RU may disable all elements of tx-array / rx-array associated with the tx-array-carrier / rx-array-carrier in sleep mode provided there is no impact to operation of other tx-array-carriers / rx-array-carriers. This means that, the O-RU may disable tx-array / rx-array elements only if all affected tx-array-carriers / rx-array-carriers (associated with the tx-array / rx-array or any tx-array / rx-array that shares elements with the tx-array / rx-array) are in sleep mode, as defined in this clause. For any newly activated tx-array- carrier / rx-array-carrier, the O-RU shall use the antenna mask (refer to clause 20.3.2), if an antenna mask is configured, for the tx-array / rx-array associated with the tx-array-carrier / rx-array-carrier. If a tx-array-carrier / rx-array-carrier is assigned to a tx-array / rx-array all of whose elements are at that time disabled due to sleep mode as defined in this clause, O-RU shall enable all those elements of the tx-array / rx-array to allow carrier activation. O-RU shall not autonomously change [tr]x-array-carrier::active to "ACTIVE". For detailed description of tx-array-carriers and rx-array-carriers, refer to description substatement in YANG models. Figure 15.3.2-0a shows the flow for successful carrier activation and illustrates the communication between the O-RU and O-DU during carrier activation procedure. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 154 Figure 15.3.2-0a: Carrier activation sequence ETSI ETSI TS 104 023 V17.1.0 (2026-01) 155 Figure 15.3.2-0b shows a flow for carrier deactivation and illustrates the communication between the O-RU and O-DU during carrier deactivation procedure. Figure 15.3.2-0b: Carrier deactivation sequence ETSI ETSI TS 104 023 V17.1.0 (2026-01) 156 The O-RU may optionally expose parameter availability-status for configured [tr]x-array-carrier(s). This availability-status parameter is intended to supplement parameter state. This allows O-RU to provide the current status about various conditions related to a [tr]x-array-carrier, as shown in Table 15.3.2-1. Table 15.3.2-1: Availability Status Value of availability-status Current condition of [tr]x-array-carrier Notes (empty) There are no faults that impact the [tr]x-array-carrier state FAILED There is at least one fault related to source internal to O-RU that made the ACTIVE [tr]x-array-carrier to turn to INACTIVE and/or makes INACTIVE [tr]x-array-carrier not able to become ACTIVE. DEPENDENCY There is at least one fault related to source external to O-RU that made the ACTIVE [tr]x-array-carrier to turn to INACTIVE and/or makes INACTIVE [tr]x-array-carrier not able to become ACTIVE. Example of fault related to external source can be the one related to lost synchronization source. Figure 15.3.2-1 shows possible transitions and values combination to be followed by "active" and "state". Combination or transitions outside of below diagram is not allowed. Figure 15.3.2-1: Diagram showing all possible transitions and combination of "active" and "state" parameters NOTE: BUSY state is only available during transition and existence of this state depends on internal O-RU design. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 157 |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3.3 Carrier state's relationship to synchronization state | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3.3.1 Synchronization state and carrier state transitions | The O-RU's tx-array-carrier and rx-array-carrier states depend upon the O-RU's sync-state. The flow chart shown in Figure 15.3.3.1-1 illustrate the possible transitions and associated parameters values for the two array-carrier in the possible synchronization state. When the O-RU implements HOLDOVER, tx-array-carrier and rx-array-carrier possible states and transitions are the same for sync LOCKED and HOLDOVER mode. When O-RU transitions to the FREERUN state the only possible tx-array-carrier and rx-array-carrier state is DISABLE/INACTIVE. Figure 15.3.3.1-1 shows possible transitions and according to parameters value combination. sync::LOCKED carrier_state::DISABLED carrier_active::INACTIVE sync::FREERUN external time source restored external sync lost (without HOLDOVER mode) Holdover time elapsed external time source lost external time source restored carrier_state::DISABLED carrier_active::INACTIVE carrier_state::BUSY carrier_active::ACTIVE carrier_active::INACTIVE O-DU controlled carrier activation (active->ACTIVE) carrier_state::READY carrier_active::ACTIVE carrier_active::SLEEP O-DU controlled carrier activation (active- >ACTIVE) O-DU controlled carrier going to sleep (active->SLEEP) O-DU controlled carrier activation (active->ACTIVE) O-DU controlled carrier deactivation (active->INACTIVE) O-DU controlled carrier deactivation (active->INACTIVE) FAULTY CASE (other than sync) O-RU autonomous recover action sync::HOLDOVER carrier_state::DISABLED carrier_active::INACTIVE carrier_state::BUSY carrier_active::ACTIVE carrier_active::INACTIVE O-DU controlled carrier activation (active->ACTIVE) carrier_state::READY carrier_active::ACTIVE carrier_active::SLEEP O-DU controlled carrier activation (active- >ACTIVE) O-DU controlled carrier going to sleep (active->SLEEP) O-DU controlled carrier activation (active->ACTIVE) O-DU controlled carrier deactivation (active->INACTIVE) O-DU controlled carrier deactivation (active->INACTIVE) FAULTY CASE (other than sync) O-RU autonomous recover action Figure 15.3.3.1-1: Combination of tx-array-carrier/rx-array-carrier transitions and allowed states compared to sync state When an O-RU changes its synchronization state sync-state to FREERUN, it shall perform carrier deactivation of all active tx-array-carrier(s) and rx-array-carrier(s). The O-RU shall communicate the synchronization-state-change, tx-array-carriers-state-change and rx-array-carriers-state-change notifications to all notification subscribers. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 158 The following two sections describe the tx-array-carrier/rx-array-carrier behaviour and O-RU/O-DU communication when synchronization is lost, and when synchronization is restored. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3.3.2 Synchronization lost and HOLDOVER mode expired | Figure 15.3.3.2-1 shows the tx-array-carrier and rx-array-carrier behaviour and illustrates the communication between the O-RU and O-DU when O-RU loose synchronization and enters to FREERUN mode. The process can be divided into 5 steps as shown in Figure 15.3.3.2-1 and briefly described below. 1) If the O-RU implements the optional HOLDOVER state, once the O-RU detects that it has lost connection to its timing source and its sync-state moves to HOLDOVER, the O-RU will send a synchronization-state- change notification to one (or more) subscribed O-DU(s) indicating that the O-RU is in HOLDOVER. If the O-RU does not implement HOLDOVER, then this step is skipped. 2) After the O-RU HOLDOVER timer expires, or if the O-RU does not implement HOLDOVER, the O-RU moves the sync-state to FREERUN. 3) The O-RU sends a synchronization-state-change notification to all subscribed O-DUs indicating that the O-RU is in FREERUN. 4) The O-RU deactivates all active array-carriers, stops RF transmission and ceases sending traffic to O-DU. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 159 Figure 15.3.3.2-1: Synchronization lost scenario |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.3.3.3 External timing source restored | Figure 15.3.3.3-1 shows how tx-array-carrier and rx-array-carrier can be reactivated when external timing source is restored, and it illustrates the communication between O-RU and O-DU to restore operation between O-RU and O-DU. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 160 The restoration process can be divided into 4 steps as shown in Figure 15.3.3.2-1 and described below: 1) Once the O-RU detects that synchronization has been restored, it changes the sync-state to LOCKED, and then sends a synchronization-state-change notification to all subscribed O-DUs. 2) The O-RU then waits for the O-DU reaction. 3) O-DU triggers activation of all O-RUs carriers. For activation of a carrier, see Figure 15.3.2-0a. Figure 15.3.3.3-1: Synchronization restored and carrier reactivation scenario |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.4 Beamforming | |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.4.1 Beamforming configuration | The beamforming functionality allows the O-RU to influence the angle of the main lobe of the signal which is radiated from/received by the O-RU. Beamforming support is optional, and an O-RU shall indicate that it supports such functionality by indicating that it supports the "urn:o-ran:beamforming:x.y" namespace. A multi-band capable O-RU shall be able to support independent beamforming configuration on each of its supported tx-arrays and/or rx-arrays depends on O-RU antenna configuration. An O-RU indicates the support of a beamforming mode of operation per endpoint. Endpoints capable of either BF or non-BF operation are distinguished by the capabilities exposed by endpoint-types in endpoint-beam-capacity grouping. ETSI ETSI TS 104 023 V17.1.0 (2026-01) 161 Arrays capable of BF operation are distinguished by the relation to the endpoints and the reference from o-ran- beamforming yang module. |
520fd169b99a3782dbe78bb36391dd5e | 104 023 | 15.4.2 Pre-defined beamforming configuration | In case the O-RU supports beamforming, the o-ran-beamforming.yang and o-ran-uplane-conf.yang modules are used to report the pre-defined relationship between supported beams to a NETCONF client. A capabilities-group is used to uniquely identify separate tx-arrays and/or rx-arrays supported by an O-RU with the beamforming configuration referencing the set of tx-arrays and rx-arrays that are associated with this capabilities-group. A default service area of the O-RU is determined as the grid of pre-defined beams. When O-RU updates beamforming configuration as described in clause 15.4.3, the grid of pre-defined beams can be newly defined. In this case, the default service area is changed accordingly. O-RU may support new service area by applying tilt-offset to the given default service area in elevation and/or azimuth domains as described in clause 15.4.3. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.