Adding additional KPIs, adding required documentation
[ric-app/mc.git] / mc-core / mc / cfg / packet_schema.txt
1
2 PROTOCOL base{
3         uint systemTime get_system_time (low_cardinality,required,increasing, snap_len 0);
4         uint schemaId get_schemaId (low_cardinality,required, snap_len 0);
5 }
6
7 // indicates release of dual connectivity for the UE
8 // Defined in context_release.json on ue_context_release.proto
9 // schemaId = 201, interface CONRELEASE
10 PROTOCOL dc_release (base){
11 // timestamp in milliseconds
12         ullong timestamp_ms get_dc_release__timestamp_ms (required,increasing);
13 // gNB ID
14         string gnb_id get_dc_release__gnb_id (required);
15 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
16         uint id_Old_eNB_UE_X2AP_ID_Extension get_dc_release__id_Old_eNB_UE_X2AP_ID_Extension (required);
17 // future UE_ID assigned by eNB for the UE over the X2. is mandatory  default=0
18         llong id_New_eNB_UE_X2AP_ID get_dc_release__id_New_eNB_UE_X2AP_ID (required);
19 // UE_ID assigned by gNB for the UE over an X2.  Match against reconfig_success.id_SgNB_UE_X2AP_ID.  is optional  default=0
20         uint id_SgNB_UE_X2AP_ID get_dc_release__id_SgNB_UE_X2AP_ID (required);
21 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
22         uint id_New_eNB_UE_X2AP_ID_Extension get_dc_release__id_New_eNB_UE_X2AP_ID_Extension (required);
23 // deprecated UE_ID assigned by eNB for the UE over the X2.  Match against reconfig_success.id_MeNB_UE_X2AP_ID. is mandatory  default=0
24         llong id_Old_eNB_UE_X2AP_ID get_dc_release__id_Old_eNB_UE_X2AP_ID (required);
25 }
26
27 // transfer per UE and bearere between given time intervals
28 // Defined in rat_data_usage.json on secondary_rat_data_usage_report.proto
29 // schemaId = 1501, interface RATDATAUSAGE
30 PROTOCOL rat_data_usage (base){
31 // timestamp in milliseconds
32         ullong timestamp_ms get_rat_data_usage__timestamp_ms (required,increasing);
33 // gNB ID
34         string gnb_id get_rat_data_usage__gnb_id (required);
35 // UE_ID assigned by eNB for the UE over the X2.  Is mandatory
36         llong id_MeNB_UE_X2AP_ID get_rat_data_usage__id_MeNB_UE_X2AP_ID (required);
37 // UE_ID assigned by gNB for the UE over an X2. Is mandatory
38         llong id_SgNB_UE_X2AP_ID get_rat_data_usage__id_SgNB_UE_X2AP_ID (required);
39 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
40         uint id_MeNB_UE_X2AP_ID_Extension get_rat_data_usage__id_MeNB_UE_X2AP_ID_Extension (required);
41 // Bearer ID
42         llong e_RAB_ID get_rat_data_usage__e_RAB_ID (required);
43 //  
44         llong secondaryRATType get_rat_data_usage__secondaryRATType (required);
45         llong startTimeStamp get_rat_data_usage__startTimeStamp (required);
46         llong endTimeStamp get_rat_data_usage__endTimeStamp (required);
47         llong usageCountDL get_rat_data_usage__usageCountDL (required);
48 }
49
50 // indicates successful configuration of Dual Connectivity
51 // Defined in recon_complete.json on sgnb_reconfiguration_complete.proto
52 // schemaId = 103, interface RECONCOMPLETE
53 PROTOCOL reconfig_all (base){
54 // timestamp in milliseconds
55         ullong timestamp_ms get_reconfig_all__timestamp_ms (required,increasing);
56 // gNB ID
57         string gnb_id get_reconfig_all__gnb_id (required);
58 // UE_ID assigned by eNB for the UE over an X2. Is mandatory  default=0
59         llong id_MeNB_UE_X2AP_ID get_reconfig_all__id_MeNB_UE_X2AP_ID (required);
60 // UE_ID assigned by gNB for the UE over the X2.  Is optional  default=0
61         llong id_SgNB_UE_X2AP_ID get_reconfig_all__id_SgNB_UE_X2AP_ID (required);
62 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
63         uint id_MeNB_UE_X2AP_ID_Extension get_reconfig_all__id_MeNB_UE_X2AP_ID_Extension (required);
64 }
65
66 // indicates unsuccessful configuration of Dual Connectivity`
67 // Defined in recon_complete.json on sgnb_reconfiguration_complete.proto
68 // schemaId = 101, interface RECONCOMPLETE
69 PROTOCOL reconfig_success (base){
70 // timestamp in milliseconds
71         ullong timestamp_ms get_reconfig_success__timestamp_ms (required,increasing);
72 // gNB ID
73         string gnb_id get_reconfig_success__gnb_id (required);
74 // UE_ID assigned by eNB for the UE over the X2.  Is mandatory  default=0
75         llong id_MeNB_UE_X2AP_ID get_reconfig_success__id_MeNB_UE_X2AP_ID (required);
76 // UE_ID assigned by gNB for the UE over an X2. Is optional  default=0
77         llong id_SgNB_UE_X2AP_ID get_reconfig_success__id_SgNB_UE_X2AP_ID (required);
78 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
79         uint id_MeNB_UE_X2AP_ID_Extension get_reconfig_success__id_MeNB_UE_X2AP_ID_Extension (required);
80 }
81
82 // indicates unsuccessful configuration of Dual Connectivity`
83 // Defined in recon_complete.json on sgnb_reconfiguration_complete.proto
84 // schemaId = 102, interface RECONCOMPLETE
85 PROTOCOL reconfig_reject (base){
86 // timestamp in milliseconds
87         ullong timestamp_ms get_reconfig_reject__timestamp_ms (required,increasing);
88 // gNB ID
89         string gnb_id get_reconfig_reject__gnb_id (required);
90 // UE_ID assigned by eNB for the UE over the X2.  Is mandatory  default=0
91         llong id_MeNB_UE_X2AP_ID get_reconfig_reject__id_MeNB_UE_X2AP_ID (required);
92 // UE_ID assigned by gNB for the UE over an X2. Is optional  default=0
93         llong id_SgNB_UE_X2AP_ID get_reconfig_reject__id_SgNB_UE_X2AP_ID (required);
94 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
95         uint id_MeNB_UE_X2AP_ID_Extension get_reconfig_reject__id_MeNB_UE_X2AP_ID_Extension (required);
96 //   default=-1
97         llong cause_radio_network get_reconfig_reject__cause_radio_network (required);
98 //   default=-1
99         llong cause_transport get_reconfig_reject__cause_transport (required);
100 //   default=-1
101         llong cause_protocol get_reconfig_reject__cause_protocol (required);
102 //   default=-1
103         llong cause_misc get_reconfig_reject__cause_misc (required);
104 }
105
106 // Confirmation of release of SgNB and SCG resources by the MeNB, list the eRABs if any (default is ALL in which case no eRABs are listed).
107 // Defined in release_confirm.json on sgnb_release_confirm.proto
108 // schemaId = 1101, interface RELCONF
109 PROTOCOL sgnb_release_confirm_from_menb_erabs (base){
110 // timestamp in milliseconds
111         ullong timestamp_ms get_sgnb_release_confirm_from_menb_erabs__timestamp_ms (required,increasing);
112 // gNB ID
113         string gnb_id get_sgnb_release_confirm_from_menb_erabs__gnb_id (required);
114 // UE_ID assigned by eNB for the UE over an X2. Is mandatory  default=0
115         llong id_MeNB_UE_X2AP_ID get_sgnb_release_confirm_from_menb_erabs__id_MeNB_UE_X2AP_ID (required);
116 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory  default=0
117         llong id_SgNB_UE_X2AP_ID get_sgnb_release_confirm_from_menb_erabs__id_SgNB_UE_X2AP_ID (required);
118 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
119         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_release_confirm_from_menb_erabs__id_MeNB_UE_X2AP_ID_Extension (required);
120 // indicates whether NR lower layers (nr-rlc, nr-MAC, and mmwave-Phy) are being used to transport the traffic.  default=-1
121         llong sCGresources get_sgnb_release_confirm_from_menb_erabs__sCGresources (required);
122 // bearer eRAB id.  default=0
123         llong e_RAB_ID get_sgnb_release_confirm_from_menb_erabs__e_RAB_ID (required);
124 // Indicates whether NR pdcp is available at the SgNB for the PDUs pertaining to the bearer.  default=-1
125         llong pDCPatSgNB get_sgnb_release_confirm_from_menb_erabs__pDCPatSgNB (required);
126 // indicates whether LTE lower layers (rlc, MAC, and Phy) are being used to transport the traffic.  default=-1
127         llong mCGresources get_sgnb_release_confirm_from_menb_erabs__mCGresources (required);
128 // Tunnel is a virtual connection over the physical X2 connection meant to handle a bearer-specific GTP (GPRS Tunneling Protocol) traffic flow in terms of PDCP PDUs.  This virtual connection has an ID given by this field.
129         string gTP_TEID get_sgnb_release_confirm_from_menb_erabs__gTP_TEID (required);
130 // logical IP address for this virtual connection over X2.
131         string transportLayerAddress get_sgnb_release_confirm_from_menb_erabs__transportLayerAddress (required);
132 }
133
134 // Confirmation of release of SgNB and SCG resources by the MeNB.
135 // Defined in release_confirm.json on sgnb_release_confirm.proto
136 // schemaId = 1102, interface RELCONF
137 PROTOCOL sgnb_release_confirm_from_menb (base){
138 // timestamp in milliseconds
139         ullong timestamp_ms get_sgnb_release_confirm_from_menb__timestamp_ms (required,increasing);
140 // gNB ID
141         string gnb_id get_sgnb_release_confirm_from_menb__gnb_id (required);
142 // UE_ID assigned by eNB for the UE over an X2. Is mandatory  default=0
143         llong id_MeNB_UE_X2AP_ID get_sgnb_release_confirm_from_menb__id_MeNB_UE_X2AP_ID (required);
144 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory  default=0
145         llong id_SgNB_UE_X2AP_ID get_sgnb_release_confirm_from_menb__id_SgNB_UE_X2AP_ID (required);
146 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
147         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_release_confirm_from_menb__id_MeNB_UE_X2AP_ID_Extension (required);
148 }
149
150 // initiated by the MeNB to request SgNB to release its SCG resources for the UE
151 // Defined in release_req.json on sgnb_release_request.proto
152 // schemaId = 801, interface RELREQ
153 PROTOCOL release_req (base){
154 // timestamp in milliseconds
155         ullong timestamp_ms get_release_req__timestamp_ms (required,increasing);
156 // gNB ID
157         string gnb_id get_release_req__gnb_id (required);
158 //   default=-1
159         llong cause_protocol get_release_req__cause_protocol (required);
160 // UE_ID assigned by eNB for the UE over an X2. Is mandatory  default=0
161         llong id_MeNB_UE_X2AP_ID get_release_req__id_MeNB_UE_X2AP_ID (required);
162 //   default=-1
163         llong cause_transport get_release_req__cause_transport (required);
164 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
165         uint id_MeNB_UE_X2AP_ID_Extension get_release_req__id_MeNB_UE_X2AP_ID_Extension (required);
166 //   default=-1
167         llong cause_radio_network get_release_req__cause_radio_network (required);
168 // UE_ID assigned by gNB for the UE over the X2.  Is optional  default=0
169         uint id_SgNB_UE_X2AP_ID get_release_req__id_SgNB_UE_X2AP_ID (required);
170 //   default=-1
171         llong cause_misc get_release_req__cause_misc (required);
172 }
173
174 // response by the SgNB back to the MeNB acknowledging release of SCG resources for the UE.
175 // Defined in release_req_ack.json on sgnb_release_request_acknowledge.proto
176 // schemaId = 901, interface RELREQACK
177 PROTOCOL release_req_ack (base){
178 // timestamp in milliseconds
179         ullong timestamp_ms get_release_req_ack__timestamp_ms (required,increasing);
180 // gNB ID
181         string gnb_id get_release_req_ack__gnb_id (required);
182 // UE_ID assigned by eNB for the UE over an X2. Is mandatory  default=0
183         llong id_MeNB_UE_X2AP_ID get_release_req_ack__id_MeNB_UE_X2AP_ID (required);
184 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory  default=0
185         llong id_SgNB_UE_X2AP_ID get_release_req_ack__id_SgNB_UE_X2AP_ID (required);
186 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
187         uint id_MeNB_UE_X2AP_ID_Extension get_release_req_ack__id_MeNB_UE_X2AP_ID_Extension (required);
188 }
189
190 // Initiated by the SgNB indicating to MeNB that SCG resources need to be released for the given underlying cause.
191 // Defined in release_rqd.json on sgnb_release_required.proto
192 // schemaId = 1001, interface SGNBRELEASERQD
193 PROTOCOL SgNB_release_rqd (base){
194 // timestamp in milliseconds
195         ullong timestamp_ms get_SgNB_release_rqd__timestamp_ms (required,increasing);
196 // gNB ID
197         string gnb_id get_SgNB_release_rqd__gnb_id (required);
198 //   default=-1
199         llong cause_protocol get_SgNB_release_rqd__cause_protocol (required);
200 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
201         llong id_MeNB_UE_X2AP_ID get_SgNB_release_rqd__id_MeNB_UE_X2AP_ID (required);
202 //   default=-1
203         llong cause_transport get_SgNB_release_rqd__cause_transport (required);
204 //   default=-1
205         llong cause_radio_network get_SgNB_release_rqd__cause_radio_network (required);
206 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
207         llong id_SgNB_UE_X2AP_ID get_SgNB_release_rqd__id_SgNB_UE_X2AP_ID (required);
208 //   default=-1
209         llong cause_misc get_SgNB_release_rqd__cause_misc (required);
210 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
211         llong e_RAB_ID0 get_SgNB_release_rqd__e_RAB_ID0;
212 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
213         llong e_RAB_ID1 get_SgNB_release_rqd__e_RAB_ID1;
214 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
215         llong e_RAB_ID2 get_SgNB_release_rqd__e_RAB_ID2;
216 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
217         llong e_RAB_ID3 get_SgNB_release_rqd__e_RAB_ID3;
218 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
219         llong e_RAB_ID4 get_SgNB_release_rqd__e_RAB_ID4;
220 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
221         llong e_RAB_ID5 get_SgNB_release_rqd__e_RAB_ID5;
222 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
223         llong e_RAB_ID6 get_SgNB_release_rqd__e_RAB_ID6;
224 // max is 8, for piz trial 4.  Optional.  If not present, release ALL bearers.
225         llong e_RAB_ID7 get_SgNB_release_rqd__e_RAB_ID7;
226 }
227
228 // Cell-wide CSI-RS measurement tuple and SSB measurement (on serving cells)
229 // Defined in rrc_metrics.json on rrctransfer.proto
230 // schemaId = 1, interface RRCXFER
231 PROTOCOL serv_nr_cell (base){
232 // timestamp in milliseconds
233         ullong timestamp_ms get_serv_nr_cell__timestamp_ms (required,increasing);
234 // gNB ID
235         string gnb_id get_serv_nr_cell__gnb_id (required);
236 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
237         llong id_MeNB_UE_X2AP_ID get_serv_nr_cell__id_MeNB_UE_X2AP_ID (required);
238 // UE_ID assigned by gNB for the UE over the X2.  Is optional
239         llong id_SgNB_UE_X2AP_ID get_serv_nr_cell__id_SgNB_UE_X2AP_ID (required);
240 // priority of the serving cell, 0 is the primary
241         llong servCellID get_serv_nr_cell__servCellID (required);
242 // CELL_ID
243         uint physCellId get_serv_nr_cell__physCellId;
244         uint rsrq get_serv_nr_cell__rsrq;
245         uint rsrp get_serv_nr_cell__rsrp;
246         uint sinr get_serv_nr_cell__sinr;
247 }
248
249 // Cell-wide  SSB measurement (from neighbor cells)
250 // Defined in rrc_metrics.json on rrctransfer.proto
251 // schemaId = 4, interface RRCXFER
252 PROTOCOL nr_neighbor (base){
253 // timestamp in milliseconds
254         ullong timestamp_ms get_nr_neighbor__timestamp_ms (required,increasing);
255 // gNB ID
256         string gnb_id get_nr_neighbor__gnb_id (required);
257 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
258         llong id_MeNB_UE_X2AP_ID get_nr_neighbor__id_MeNB_UE_X2AP_ID (required);
259 // UE_ID assigned by gNB for the UE over the X2.  Is optional
260         llong id_SgNB_UE_X2AP_ID get_nr_neighbor__id_SgNB_UE_X2AP_ID (required);
261 // CELL_ID
262         uint physCellId get_nr_neighbor__physCellId;
263         uint rsrq get_nr_neighbor__rsrq;
264         uint rsrp get_nr_neighbor__rsrp;
265         uint sinr get_nr_neighbor__sinr;
266 }
267
268 // Cell-wide beam-specific CSI-RS measurements (on serving cells) 
269 // Defined in rrc_metrics.json on rrctransfer.proto
270 // schemaId = 2, interface RRCXFER
271 PROTOCOL serv_cell_beam_csi (base){
272 // timestamp in milliseconds
273         ullong timestamp_ms get_serv_cell_beam_csi__timestamp_ms (required,increasing);
274 // gNB ID
275         string gnb_id get_serv_cell_beam_csi__gnb_id (required);
276 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
277         llong id_MeNB_UE_X2AP_ID get_serv_cell_beam_csi__id_MeNB_UE_X2AP_ID (required);
278 // UE_ID assigned by gNB for the UE over the X2.  Is optional
279         llong id_SgNB_UE_X2AP_ID get_serv_cell_beam_csi__id_SgNB_UE_X2AP_ID (required);
280 // priority of the serving cell, 0 is the primary
281         llong servCellID get_serv_cell_beam_csi__servCellID (required);
282 // CELL_ID
283         uint physCellId get_serv_cell_beam_csi__physCellId;
284 // beam id for CSI Reference Signal measurement results
285         llong csi_rs_index get_serv_cell_beam_csi__csi_rs_index (required);
286         uint rsrq get_serv_cell_beam_csi__rsrq;
287         uint rsrp get_serv_cell_beam_csi__rsrp;
288         uint sinr get_serv_cell_beam_csi__sinr;
289 }
290
291 // Cell-wide beam-specific CSI-RS measurements (from neighbor cells) 
292 // Defined in rrc_metrics.json on rrctransfer.proto
293 // schemaId = 5, interface RRCXFER
294 PROTOCOL neighbor_beam_csi (base){
295 // timestamp in milliseconds
296         ullong timestamp_ms get_neighbor_beam_csi__timestamp_ms (required,increasing);
297 // gNB ID
298         string gnb_id get_neighbor_beam_csi__gnb_id (required);
299 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
300         llong id_MeNB_UE_X2AP_ID get_neighbor_beam_csi__id_MeNB_UE_X2AP_ID (required);
301 // UE_ID assigned by gNB for the UE over the X2.  Is optional
302         llong id_SgNB_UE_X2AP_ID get_neighbor_beam_csi__id_SgNB_UE_X2AP_ID (required);
303 // CELL_ID
304         uint physCellId get_neighbor_beam_csi__physCellId;
305 // beam id for CSI Reference Signal measurement results
306         llong csi_rs_index get_neighbor_beam_csi__csi_rs_index (required);
307         uint rsrq get_neighbor_beam_csi__rsrq;
308         uint rsrp get_neighbor_beam_csi__rsrp;
309         uint sinr get_neighbor_beam_csi__sinr;
310 }
311
312 // Cell-wide beam-specific LIST of SS/PBCH reference signal measurement (on serving cells)
313 // Defined in rrc_metrics.json on rrctransfer.proto
314 // schemaId = 3, interface RRCXFER
315 PROTOCOL serv_cell_beam_ssb (base){
316 // timestamp in milliseconds
317         ullong timestamp_ms get_serv_cell_beam_ssb__timestamp_ms (required,increasing);
318 // gNB ID
319         string gnb_id get_serv_cell_beam_ssb__gnb_id (required);
320 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
321         llong id_MeNB_UE_X2AP_ID get_serv_cell_beam_ssb__id_MeNB_UE_X2AP_ID (required);
322 // UE_ID assigned by gNB for the UE over the X2.  Is optional
323         llong id_SgNB_UE_X2AP_ID get_serv_cell_beam_ssb__id_SgNB_UE_X2AP_ID (required);
324 // priority of the serving cell, 0 is the primary
325         llong servCellID get_serv_cell_beam_ssb__servCellID (required);
326 // CELL_ID
327         uint physCellId get_serv_cell_beam_ssb__physCellId;
328 // beam id for broadcast reference signals
329         llong ssb_Index get_serv_cell_beam_ssb__ssb_Index (required);
330         uint rsrq get_serv_cell_beam_ssb__rsrq;
331         uint rsrp get_serv_cell_beam_ssb__rsrp;
332         uint sinr get_serv_cell_beam_ssb__sinr;
333 }
334
335 // Cell-wide beam-specific LIST of SS/PBCH reference signal measurement (from neighbor cell)
336 // Defined in rrc_metrics.json on rrctransfer.proto
337 // schemaId = 6, interface RRCXFER
338 PROTOCOL neighbor_beam_ssb (base){
339 // timestamp in milliseconds
340         ullong timestamp_ms get_neighbor_beam_ssb__timestamp_ms (required,increasing);
341 // gNB ID
342         string gnb_id get_neighbor_beam_ssb__gnb_id (required);
343 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
344         llong id_MeNB_UE_X2AP_ID get_neighbor_beam_ssb__id_MeNB_UE_X2AP_ID (required);
345 // UE_ID assigned by gNB for the UE over the X2.  Is optional
346         llong id_SgNB_UE_X2AP_ID get_neighbor_beam_ssb__id_SgNB_UE_X2AP_ID (required);
347 // CELL_ID
348         uint physCellId get_neighbor_beam_ssb__physCellId;
349 // beam id for broadcast reference signals
350         llong ssb_Index get_neighbor_beam_ssb__ssb_Index (required);
351         uint rsrq get_neighbor_beam_ssb__rsrq;
352         uint rsrp get_neighbor_beam_ssb__rsrp;
353         uint sinr get_neighbor_beam_ssb__sinr;
354 }
355
356 // Rejection by the gNMB of an incoming request from the MeNB to the gNB for getting added as a secondary node.
357 // Defined in sgnb_add_req_reject.json on sgnb_addition_request_reject.proto
358 // schemaId = 701, interface ADDREQREJECT
359 PROTOCOL sgnb_add_req_reject (base){
360 // timestamp in milliseconds
361         ullong timestamp_ms get_sgnb_add_req_reject__timestamp_ms (required,increasing);
362 // gNB ID
363         string gnb_id get_sgnb_add_req_reject__gnb_id (required);
364 // UE_ID assigned by eNB for the UE over the X2.  Is mandatory
365         llong id_MeNB_UE_X2AP_ID get_sgnb_add_req_reject__id_MeNB_UE_X2AP_ID (required);
366 // UE_ID assigned by gNB for the UE over an X2. Is optional
367         llong id_SgNB_UE_X2AP_ID get_sgnb_add_req_reject__id_SgNB_UE_X2AP_ID (required);
368 //   default=-1
369         llong cause_radio_network get_sgnb_add_req_reject__cause_radio_network (required);
370 //   default=-1
371         llong cause_transport get_sgnb_add_req_reject__cause_transport (required);
372 //   default=-1
373         llong cause_protocol get_sgnb_add_req_reject__cause_protocol (required);
374 //   default=-1
375         llong cause_misc get_sgnb_add_req_reject__cause_misc (required);
376 }
377
378 // Indicates positive response for adding secondary node to the UE.  This record has indicated bearers not admitted by the secondary node.
379 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
380 // schemaId = 501, interface SGNB_ADDITION_REQ_ACK
381 PROTOCOL eRABs_notadmitted_for_ue (base){
382 // timestamp in milliseconds
383         ullong timestamp_ms get_eRABs_notadmitted_for_ue__timestamp_ms (required,increasing);
384 // gNB ID
385         string gnb_id get_eRABs_notadmitted_for_ue__gnb_id (required);
386 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
387         llong id_MeNB_UE_X2AP_ID get_eRABs_notadmitted_for_ue__id_MeNB_UE_X2AP_ID (required);
388 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
389         llong id_SgNB_UE_X2AP_ID get_eRABs_notadmitted_for_ue__id_SgNB_UE_X2AP_ID (required);
390 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
391         uint id_MeNB_UE_X2AP_ID_Extension get_eRABs_notadmitted_for_ue__id_MeNB_UE_X2AP_ID_Extension (required);
392 // bearer id
393         llong e_RAB_ID get_eRABs_notadmitted_for_ue__e_RAB_ID (required);
394 //   default=-1
395         llong cause_transport get_eRABs_notadmitted_for_ue__cause_transport (required);
396 //   default=-1
397         llong cause_protocol get_eRABs_notadmitted_for_ue__cause_protocol (required);
398 //   default=-1
399         llong cause_misc get_eRABs_notadmitted_for_ue__cause_misc (required);
400 //   default=-1
401         llong cause_radio_network get_eRABs_notadmitted_for_ue__cause_radio_network (required);
402 }
403
404 // Indicates positive response for adding secondary node to the UE.  This record indicates eRABs acknowledged for admission for the UE. 
405 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
406 // schemaId = 502, interface SGNB_ADDITION_REQ_ACK
407 PROTOCOL eRABs_acked_for_admit_for_ue (base){
408 // timestamp in milliseconds
409         ullong timestamp_ms get_eRABs_acked_for_admit_for_ue__timestamp_ms (required,increasing);
410 // gNB ID
411         string gnb_id get_eRABs_acked_for_admit_for_ue__gnb_id (required);
412 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
413         llong id_MeNB_UE_X2AP_ID get_eRABs_acked_for_admit_for_ue__id_MeNB_UE_X2AP_ID (required);
414 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
415         llong id_SgNB_UE_X2AP_ID get_eRABs_acked_for_admit_for_ue__id_SgNB_UE_X2AP_ID (required);
416 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
417         uint id_MeNB_UE_X2AP_ID_Extension get_eRABs_acked_for_admit_for_ue__id_MeNB_UE_X2AP_ID_Extension (required);
418         string gTP_TEID_dl get_eRABs_acked_for_admit_for_ue__gTP_TEID_dl;
419         llong mCGresources get_eRABs_acked_for_admit_for_ue__mCGresources;
420         string transportLayerAddress_dl get_eRABs_acked_for_admit_for_ue__transportLayerAddress_dl;
421         llong pDCPatSgNB get_eRABs_acked_for_admit_for_ue__pDCPatSgNB;
422         llong sCGresources get_eRABs_acked_for_admit_for_ue__sCGresources;
423 // bearer id
424         llong e_RAB_ID get_eRABs_acked_for_admit_for_ue__e_RAB_ID (required);
425 //   default=0
426         llong qCI get_eRABs_acked_for_admit_for_ue__qCI (required);
427 }
428
429 // Extracts the frequencies of the NR cells serving the eRAB.
430 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
431 // schemaId = 503, interface SGNB_ADDITION_REQ_ACK
432 PROTOCOL SgNB_ack_for_ue_NRfreqs (base){
433 // timestamp in milliseconds
434         ullong timestamp_ms get_SgNB_ack_for_ue_NRfreqs__timestamp_ms (required,increasing);
435 // gNB ID
436         string gnb_id get_SgNB_ack_for_ue_NRfreqs__gnb_id (required);
437 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
438         llong id_MeNB_UE_X2AP_ID get_SgNB_ack_for_ue_NRfreqs__id_MeNB_UE_X2AP_ID (required);
439 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
440         llong id_SgNB_UE_X2AP_ID get_SgNB_ack_for_ue_NRfreqs__id_SgNB_UE_X2AP_ID (required);
441 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
442         uint id_MeNB_UE_X2AP_ID_Extension get_SgNB_ack_for_ue_NRfreqs__id_MeNB_UE_X2AP_ID_Extension (required);
443 // rrc reconfig values for secondary cell group of sgNB
444         string scg_CellGroupConfig get_SgNB_ack_for_ue_NRfreqs__scg_CellGroupConfig;
445 // max is 8, for piz trial 4
446         llong candidate_serving_cell_freqs0 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs0;
447 // max is 8, for piz trial 4
448         llong candidate_serving_cell_freqs1 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs1;
449 // max is 8, for piz trial 4
450         llong candidate_serving_cell_freqs2 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs2;
451 // max is 8, for piz trial 4
452         llong candidate_serving_cell_freqs3 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs3;
453 // max is 8, for piz trial 4
454         llong candidate_serving_cell_freqs4 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs4;
455 // max is 8, for piz trial 4
456         llong candidate_serving_cell_freqs5 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs5;
457 // max is 8, for piz trial 4
458         llong candidate_serving_cell_freqs6 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs6;
459 // max is 8, for piz trial 4
460         llong candidate_serving_cell_freqs7 get_SgNB_ack_for_ue_NRfreqs__candidate_serving_cell_freqs7;
461 // max is 8, 4 for PIZ trial
462         uint measuredFrequenciesSN0 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN0;
463 // max is 8, 4 for PIZ trial
464         uint measuredFrequenciesSN1 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN1;
465 // max is 8, 4 for PIZ trial
466         uint measuredFrequenciesSN2 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN2;
467 // max is 8, 4 for PIZ trial
468         uint measuredFrequenciesSN3 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN3;
469 // max is 8, 4 for PIZ trial
470         uint measuredFrequenciesSN4 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN4;
471 // max is 8, 4 for PIZ trial
472         uint measuredFrequenciesSN5 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN5;
473 // max is 8, 4 for PIZ trial
474         uint measuredFrequenciesSN6 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN6;
475 // max is 8, 4 for PIZ trial
476         uint measuredFrequenciesSN7 get_SgNB_ack_for_ue_NRfreqs__measuredFrequenciesSN7;
477 }
478
479 // list of eRABs with sgNB radio bearer config info for addition or modification.
480 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
481 // schemaId = 504, interface SGNB_ADDITION_REQ_ACK
482 PROTOCOL SgNB_ack_for_add_mod_for_ue (base){
483 // timestamp in milliseconds
484         ullong timestamp_ms get_SgNB_ack_for_add_mod_for_ue__timestamp_ms (required,increasing);
485 // gNB ID
486         string gnb_id get_SgNB_ack_for_add_mod_for_ue__gnb_id (required);
487 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
488         llong id_MeNB_UE_X2AP_ID get_SgNB_ack_for_add_mod_for_ue__id_MeNB_UE_X2AP_ID (required);
489 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
490         llong id_SgNB_UE_X2AP_ID get_SgNB_ack_for_add_mod_for_ue__id_SgNB_UE_X2AP_ID (required);
491 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
492         uint id_MeNB_UE_X2AP_ID_Extension get_SgNB_ack_for_add_mod_for_ue__id_MeNB_UE_X2AP_ID_Extension (required);
493         llong toRelease0 get_SgNB_ack_for_add_mod_for_ue__toRelease0;
494         llong toRelease1 get_SgNB_ack_for_add_mod_for_ue__toRelease1;
495         llong toRelease2 get_SgNB_ack_for_add_mod_for_ue__toRelease2;
496         llong toRelease3 get_SgNB_ack_for_add_mod_for_ue__toRelease3;
497 // to come
498         bool recoverPDCP get_SgNB_ack_for_add_mod_for_ue__recoverPDCP;
499 // to come
500         bool reestablishPDCP get_SgNB_ack_for_add_mod_for_ue__reestablishPDCP;
501 // RAN drb identity of the eRAB. For split drb this value is the same for both meNB and sgNB.
502         llong drb_Identity get_SgNB_ack_for_add_mod_for_ue__drb_Identity (required);
503 // RAN - core end to end bearer identity agnostic of underlying en-dc.
504         llong eps_BearerIdentity get_SgNB_ack_for_add_mod_for_ue__eps_BearerIdentity (required);
505 }
506
507 // signaling measurements of the user while serving the eRABs
508 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
509 // schemaId = 505, interface SGNB_ADDITION_REQ_ACK
510 PROTOCOL SgNB_ack_for_ue_measurements (base){
511 // timestamp in milliseconds
512         ullong timestamp_ms get_SgNB_ack_for_ue_measurements__timestamp_ms (required,increasing);
513 // gNB ID
514         string gnb_id get_SgNB_ack_for_ue_measurements__gnb_id (required);
515 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
516         llong id_MeNB_UE_X2AP_ID get_SgNB_ack_for_ue_measurements__id_MeNB_UE_X2AP_ID (required);
517 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
518         llong id_SgNB_UE_X2AP_ID get_SgNB_ack_for_ue_measurements__id_SgNB_UE_X2AP_ID (required);
519 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
520         uint id_MeNB_UE_X2AP_ID_Extension get_SgNB_ack_for_ue_measurements__id_MeNB_UE_X2AP_ID_Extension (required);
521 // ss (synchronization signal) or broadcast cell-specific signam measurements
522         uint ssbFrequency get_SgNB_ack_for_ue_measurements__ssbFrequency;
523 // CSI RS downlink cell specific reference signal measurements
524         uint refFreqCSI_RS get_SgNB_ack_for_ue_measurements__refFreqCSI_RS;
525 // primary key of the cell id
526         uint physCellId get_SgNB_ack_for_ue_measurements__physCellId;
527         uint rsrq get_SgNB_ack_for_ue_measurements__rsrq;
528         uint rsrp get_SgNB_ack_for_ue_measurements__rsrp;
529         uint sinr get_SgNB_ack_for_ue_measurements__sinr;
530 }
531
532 // CSI beam measurements of the user while serving the eRABs
533 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
534 // schemaId = 506, interface SGNB_ADDITION_REQ_ACK
535 PROTOCOL SgNB_ack_for_ue_beam_csi (base){
536 // timestamp in milliseconds
537         ullong timestamp_ms get_SgNB_ack_for_ue_beam_csi__timestamp_ms (required,increasing);
538 // gNB ID
539         string gnb_id get_SgNB_ack_for_ue_beam_csi__gnb_id (required);
540 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
541         llong id_MeNB_UE_X2AP_ID get_SgNB_ack_for_ue_beam_csi__id_MeNB_UE_X2AP_ID (required);
542 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
543         llong id_SgNB_UE_X2AP_ID get_SgNB_ack_for_ue_beam_csi__id_SgNB_UE_X2AP_ID (required);
544 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
545         uint id_MeNB_UE_X2AP_ID_Extension get_SgNB_ack_for_ue_beam_csi__id_MeNB_UE_X2AP_ID_Extension (required);
546 // ss (synchronization signal) or broadcast cell-specific signam measurements
547         uint ssbFrequency get_SgNB_ack_for_ue_beam_csi__ssbFrequency;
548 // CSI RS downlink cell specific reference signal measurements
549         uint refFreqCSI_RS get_SgNB_ack_for_ue_beam_csi__refFreqCSI_RS;
550 // primary key of the cell id
551         uint physCellId get_SgNB_ack_for_ue_beam_csi__physCellId;
552 // beam id for CSI Reference Signal measurement results
553         llong csi_rs_index get_SgNB_ack_for_ue_beam_csi__csi_rs_index (required);
554         uint rsrq get_SgNB_ack_for_ue_beam_csi__rsrq;
555         uint rsrp get_SgNB_ack_for_ue_beam_csi__rsrp;
556         uint sinr get_SgNB_ack_for_ue_beam_csi__sinr;
557 }
558
559 // SSB beam measurements of the user while serving the eRABs
560 // Defined in sgnb_addition_ack.json on sgnb_addition_request_acknowledge.proto
561 // schemaId = 507, interface SGNB_ADDITION_REQ_ACK
562 PROTOCOL SgNB_ack_for_ue_beam_ssb (base){
563 // timestamp in milliseconds
564         ullong timestamp_ms get_SgNB_ack_for_ue_beam_ssb__timestamp_ms (required,increasing);
565 // gNB ID
566         string gnb_id get_SgNB_ack_for_ue_beam_ssb__gnb_id (required);
567 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching between addition_req and addition_req_ack.
568         llong id_MeNB_UE_X2AP_ID get_SgNB_ack_for_ue_beam_ssb__id_MeNB_UE_X2AP_ID (required);
569 // UE_ID assigned by gNB for the UE over an X2. primary key for referring to the UE within SgNB.
570         llong id_SgNB_UE_X2AP_ID get_SgNB_ack_for_ue_beam_ssb__id_SgNB_UE_X2AP_ID (required);
571 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
572         uint id_MeNB_UE_X2AP_ID_Extension get_SgNB_ack_for_ue_beam_ssb__id_MeNB_UE_X2AP_ID_Extension (required);
573 // ss (synchronization signal) or broadcast cell-specific signam measurements
574         uint ssbFrequency get_SgNB_ack_for_ue_beam_ssb__ssbFrequency;
575 // CSI RS downlink cell specific reference signal measurements
576         uint refFreqCSI_RS get_SgNB_ack_for_ue_beam_ssb__refFreqCSI_RS;
577 // primary key of the cell id
578         uint physCellId get_SgNB_ack_for_ue_beam_ssb__physCellId;
579 // beam id for SSB Reference Signal measurement results
580         llong ssb_Index get_SgNB_ack_for_ue_beam_ssb__ssb_Index (required);
581         uint rsrq get_SgNB_ack_for_ue_beam_ssb__rsrq;
582         uint rsrp get_SgNB_ack_for_ue_beam_ssb__rsrp;
583         uint sinr get_SgNB_ack_for_ue_beam_ssb__sinr;
584 }
585
586 // Indicates request for adding secondary node to the UE
587 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
588 // schemaId = 401, interface SGNB_ADDITION_REQ
589 PROTOCOL sgnb_addreq_for_ue (base){
590 // timestamp in milliseconds
591         ullong timestamp_ms get_sgnb_addreq_for_ue__timestamp_ms (required,increasing);
592 // gNB ID
593         string gnb_id get_sgnb_addreq_for_ue__gnb_id (required);
594 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
595         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue__id_MeNB_UE_X2AP_ID (required);
596 // maximum allowed fraction of traffic on the sGNB.  in bps.
597         llong uEaggregateMaximumBitRateDownlink get_sgnb_addreq_for_ue__uEaggregateMaximumBitRateDownlink;
598 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
599         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue__id_MeNB_UE_X2AP_ID_Extension (required);
600 // concatenate with plnm_identity to get the complete cell id
601         string eUTRANcellIdentifier get_sgnb_addreq_for_ue__eUTRANcellIdentifier (required);
602 // concatenate with eUTRANcellIdentifier to get the complete cell id
603         string pLMN_Identity get_sgnb_addreq_for_ue__pLMN_Identity (required);
604 }
605
606 // Indicates request for adding secondary node to the UE, with bearer details
607 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
608 // schemaId = 402, interface SGNB_ADDITION_REQ
609 PROTOCOL sgnb_addreq_for_ue_bearers (base){
610 // timestamp in milliseconds
611         ullong timestamp_ms get_sgnb_addreq_for_ue_bearers__timestamp_ms (required,increasing);
612 // gNB ID
613         string gnb_id get_sgnb_addreq_for_ue_bearers__gnb_id (required);
614 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
615         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_bearers__id_MeNB_UE_X2AP_ID (required);
616 // fraction for  the enb LTE portion (MCG)  default=0
617         llong MCG_eRAB_MaximumBitrateDL get_sgnb_addreq_for_ue_bearers__MCG_eRAB_MaximumBitrateDL (required);
618 //   default=-1
619         llong pDCPatSgNB get_sgnb_addreq_for_ue_bearers__pDCPatSgNB (required);
620 // Data radio bearer ID of this bearer
621         llong drb_ID get_sgnb_addreq_for_ue_bearers__drb_ID (required);
622 // service class priority for the corresponding bearer.  default=0
623         llong priorityLevel get_sgnb_addreq_for_ue_bearers__priorityLevel (required);
624 // Tunnel is a virtual connection over the physical X2 connection meant to handle a bearer-specific GTP (GPRS Tunneling Protocol) traffic flow in terms of PDCP PDUs.  This virtual connection has an ID given by this field.  default=""
625         string gTP_TEID get_sgnb_addreq_for_ue_bearers__gTP_TEID (required);
626 // indicates if bearer preemption is possible or not.  default=-1
627         llong pre_emptionCapability get_sgnb_addreq_for_ue_bearers__pre_emptionCapability (required);
628 // fraction for  the enb LTE portion (MCG)  default=0
629         llong MCG_eRAB_GuaranteedBitrateUL get_sgnb_addreq_for_ue_bearers__MCG_eRAB_GuaranteedBitrateUL (required);
630 //   default=-1
631         llong mCGresources get_sgnb_addreq_for_ue_bearers__mCGresources (required);
632 // logical IP address for this virtual connection over X2.  default=""
633         string transportLayerAddress get_sgnb_addreq_for_ue_bearers__transportLayerAddress (required);
634 // complete profile  default=0
635         llong full_eRAB_GuaranteedBitrateUL get_sgnb_addreq_for_ue_bearers__full_eRAB_GuaranteedBitrateUL (required);
636 //   default=-1
637         llong sCGresources get_sgnb_addreq_for_ue_bearers__sCGresources (required);
638 // fraction for  the enb LTE portion (MCG)  default=0
639         llong MCG_eRAB_MaximumBitrateUL get_sgnb_addreq_for_ue_bearers__MCG_eRAB_MaximumBitrateUL (required);
640 // complete profile  default=0
641         llong full_eRAB_MaximumBitrateUL get_sgnb_addreq_for_ue_bearers__full_eRAB_MaximumBitrateUL (required);
642 // indicates if bearer is pre-emptable or not pre-emptable.  default=-1
643         llong pre_emptionVulnerability get_sgnb_addreq_for_ue_bearers__pre_emptionVulnerability (required);
644 // radio access bearer of this bearer
645         llong e_RAB_ID get_sgnb_addreq_for_ue_bearers__e_RAB_ID (required);
646 // fraction for  the enb LTE portion (MCG)  default=0
647         llong MCG_eRAB_GuaranteedBitrateDL get_sgnb_addreq_for_ue_bearers__MCG_eRAB_GuaranteedBitrateDL (required);
648 // Qos class identifier  - this is used to refer to the traffic profile of the corresponding bearer in terms of performance metrics.  default=0
649         llong qCI get_sgnb_addreq_for_ue_bearers__qCI (required);
650 // complete profile  default=0
651         llong full_eRAB_MaximumBitrateDL get_sgnb_addreq_for_ue_bearers__full_eRAB_MaximumBitrateDL (required);
652 // complete profile  default=0
653         llong full_eRAB_GuaranteedBitrateDL get_sgnb_addreq_for_ue_bearers__full_eRAB_GuaranteedBitrateDL (required);
654 }
655
656 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
657 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
658 // schemaId = 403, interface SGNB_ADDITION_REQ
659 PROTOCOL sgnb_addreq_for_ue_sn_serv_ssb (base){
660 // timestamp in milliseconds
661         ullong timestamp_ms get_sgnb_addreq_for_ue_sn_serv_ssb__timestamp_ms (required,increasing);
662 // gNB ID
663         string gnb_id get_sgnb_addreq_for_ue_sn_serv_ssb__gnb_id (required);
664 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
665         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_sn_serv_ssb__id_MeNB_UE_X2AP_ID (required);
666 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
667         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_sn_serv_ssb__id_MeNB_UE_X2AP_ID_Extension (required);
668 // CELL_ID
669         uint physCellId get_sgnb_addreq_for_ue_sn_serv_ssb__physCellId;
670 //   default=128
671         uint rsrq get_sgnb_addreq_for_ue_sn_serv_ssb__rsrq (required);
672 //   default=128
673         uint rsrp get_sgnb_addreq_for_ue_sn_serv_ssb__rsrp (required);
674 //   default=128
675         uint sinr get_sgnb_addreq_for_ue_sn_serv_ssb__sinr (required);
676 }
677
678 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
679 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
680 // schemaId = 404, interface SGNB_ADDITION_REQ
681 PROTOCOL sgnb_addreq_for_ue_sn_serv_csi_rs (base){
682 // timestamp in milliseconds
683         ullong timestamp_ms get_sgnb_addreq_for_ue_sn_serv_csi_rs__timestamp_ms (required,increasing);
684 // gNB ID
685         string gnb_id get_sgnb_addreq_for_ue_sn_serv_csi_rs__gnb_id (required);
686 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
687         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_sn_serv_csi_rs__id_MeNB_UE_X2AP_ID (required);
688 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
689         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_sn_serv_csi_rs__id_MeNB_UE_X2AP_ID_Extension (required);
690 // CELL_ID
691         uint physCellId get_sgnb_addreq_for_ue_sn_serv_csi_rs__physCellId;
692 //   default=128
693         uint rsrq get_sgnb_addreq_for_ue_sn_serv_csi_rs__rsrq (required);
694 //   default=128
695         uint rsrp get_sgnb_addreq_for_ue_sn_serv_csi_rs__rsrp (required);
696 //   default=128
697         uint sinr get_sgnb_addreq_for_ue_sn_serv_csi_rs__sinr (required);
698 }
699
700 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
701 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
702 // schemaId = 405, interface SGNB_ADDITION_REQ
703 PROTOCOL sgnb_addreq_for_ue_mn_serv_ssb (base){
704 // timestamp in milliseconds
705         ullong timestamp_ms get_sgnb_addreq_for_ue_mn_serv_ssb__timestamp_ms (required,increasing);
706 // gNB ID
707         string gnb_id get_sgnb_addreq_for_ue_mn_serv_ssb__gnb_id (required);
708 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
709         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_mn_serv_ssb__id_MeNB_UE_X2AP_ID (required);
710 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
711         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_mn_serv_ssb__id_MeNB_UE_X2AP_ID_Extension (required);
712 // CELL_ID
713         uint physCellId get_sgnb_addreq_for_ue_mn_serv_ssb__physCellId;
714 //   default=128
715         uint rsrq get_sgnb_addreq_for_ue_mn_serv_ssb__rsrq (required);
716 //   default=128
717         uint rsrp get_sgnb_addreq_for_ue_mn_serv_ssb__rsrp (required);
718 //   default=128
719         uint sinr get_sgnb_addreq_for_ue_mn_serv_ssb__sinr (required);
720 }
721
722 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
723 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
724 // schemaId = 406, interface SGNB_ADDITION_REQ
725 PROTOCOL sgnb_addreq_for_ue_mn_serv_csi_rs (base){
726 // timestamp in milliseconds
727         ullong timestamp_ms get_sgnb_addreq_for_ue_mn_serv_csi_rs__timestamp_ms (required,increasing);
728 // gNB ID
729         string gnb_id get_sgnb_addreq_for_ue_mn_serv_csi_rs__gnb_id (required);
730 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
731         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_mn_serv_csi_rs__id_MeNB_UE_X2AP_ID (required);
732 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
733         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_mn_serv_csi_rs__id_MeNB_UE_X2AP_ID_Extension (required);
734 // CELL_ID
735         uint physCellId get_sgnb_addreq_for_ue_mn_serv_csi_rs__physCellId;
736 //   default=128
737         uint rsrq get_sgnb_addreq_for_ue_mn_serv_csi_rs__rsrq (required);
738 //   default=128
739         uint rsrp get_sgnb_addreq_for_ue_mn_serv_csi_rs__rsrp (required);
740 //   default=128
741         uint sinr get_sgnb_addreq_for_ue_mn_serv_csi_rs__sinr (required);
742 }
743
744 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
745 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
746 // schemaId = 408, interface SGNB_ADDITION_REQ
747 PROTOCOL sgnb_addreq_for_ue_sn_neigh_ssb (base){
748 // timestamp in milliseconds
749         ullong timestamp_ms get_sgnb_addreq_for_ue_sn_neigh_ssb__timestamp_ms (required,increasing);
750 // gNB ID
751         string gnb_id get_sgnb_addreq_for_ue_sn_neigh_ssb__gnb_id (required);
752 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
753         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_sn_neigh_ssb__id_MeNB_UE_X2AP_ID (required);
754 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
755         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_sn_neigh_ssb__id_MeNB_UE_X2AP_ID_Extension (required);
756 // CELL_ID
757         uint physCellId get_sgnb_addreq_for_ue_sn_neigh_ssb__physCellId;
758 //   default=128
759         uint rsrq get_sgnb_addreq_for_ue_sn_neigh_ssb__rsrq (required);
760 //   default=128
761         uint rsrp get_sgnb_addreq_for_ue_sn_neigh_ssb__rsrp (required);
762 //   default=128
763         uint sinr get_sgnb_addreq_for_ue_sn_neigh_ssb__sinr (required);
764 }
765
766 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
767 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
768 // schemaId = 409, interface SGNB_ADDITION_REQ
769 PROTOCOL sgnb_addreq_for_ue_sn_neigh_csi_rs (base){
770 // timestamp in milliseconds
771         ullong timestamp_ms get_sgnb_addreq_for_ue_sn_neigh_csi_rs__timestamp_ms (required,increasing);
772 // gNB ID
773         string gnb_id get_sgnb_addreq_for_ue_sn_neigh_csi_rs__gnb_id (required);
774 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
775         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_sn_neigh_csi_rs__id_MeNB_UE_X2AP_ID (required);
776 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
777         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_sn_neigh_csi_rs__id_MeNB_UE_X2AP_ID_Extension (required);
778 // CELL_ID
779         uint physCellId get_sgnb_addreq_for_ue_sn_neigh_csi_rs__physCellId;
780 //   default=128
781         uint rsrq get_sgnb_addreq_for_ue_sn_neigh_csi_rs__rsrq (required);
782 //   default=128
783         uint rsrp get_sgnb_addreq_for_ue_sn_neigh_csi_rs__rsrp (required);
784 //   default=128
785         uint sinr get_sgnb_addreq_for_ue_sn_neigh_csi_rs__sinr (required);
786 }
787
788 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
789 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
790 // schemaId = 410, interface SGNB_ADDITION_REQ
791 PROTOCOL sgnb_addreq_for_ue_mn_neigh_ssb (base){
792 // timestamp in milliseconds
793         ullong timestamp_ms get_sgnb_addreq_for_ue_mn_neigh_ssb__timestamp_ms (required,increasing);
794 // gNB ID
795         string gnb_id get_sgnb_addreq_for_ue_mn_neigh_ssb__gnb_id (required);
796 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
797         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_mn_neigh_ssb__id_MeNB_UE_X2AP_ID (required);
798 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
799         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_mn_neigh_ssb__id_MeNB_UE_X2AP_ID_Extension (required);
800 // CELL_ID
801         uint physCellId get_sgnb_addreq_for_ue_mn_neigh_ssb__physCellId;
802 //   default=128
803         uint rsrq get_sgnb_addreq_for_ue_mn_neigh_ssb__rsrq (required);
804 //   default=128
805         uint rsrp get_sgnb_addreq_for_ue_mn_neigh_ssb__rsrp (required);
806 //   default=128
807         uint sinr get_sgnb_addreq_for_ue_mn_neigh_ssb__sinr (required);
808 }
809
810 // Indicates request for adding secondary node to the UE.  Extract the SN / serving cell / ssb measurements.
811 // Defined in sgnb_addition_req.json on sgnb_addition_request.proto
812 // schemaId = 411, interface SGNB_ADDITION_REQ
813 PROTOCOL sgnb_addreq_for_ue_mn_neigh_csi_rs (base){
814 // timestamp in milliseconds
815         ullong timestamp_ms get_sgnb_addreq_for_ue_mn_neigh_csi_rs__timestamp_ms (required,increasing);
816 // gNB ID
817         string gnb_id get_sgnb_addreq_for_ue_mn_neigh_csi_rs__gnb_id (required);
818 // UE_ID assigned by eNB for the UE over an X2.  primary key for matching.
819         llong id_MeNB_UE_X2AP_ID get_sgnb_addreq_for_ue_mn_neigh_csi_rs__id_MeNB_UE_X2AP_ID (required);
820 // additional bytes optionally rqd. for user id (MeNB ue ID is 16 bits)  not expected to be used for PIZ trial.  default=0
821         uint id_MeNB_UE_X2AP_ID_Extension get_sgnb_addreq_for_ue_mn_neigh_csi_rs__id_MeNB_UE_X2AP_ID_Extension (required);
822 // CELL_ID
823         uint physCellId get_sgnb_addreq_for_ue_mn_neigh_csi_rs__physCellId;
824 //   default=128
825         uint rsrq get_sgnb_addreq_for_ue_mn_neigh_csi_rs__rsrq (required);
826 //   default=128
827         uint rsrp get_sgnb_addreq_for_ue_mn_neigh_csi_rs__rsrp (required);
828 //   default=128
829         uint sinr get_sgnb_addreq_for_ue_mn_neigh_csi_rs__sinr (required);
830 }
831
832 // ??? 
833 // Defined in sgnb_mod_confirm.json on sgnb_modification_confirm.proto
834 // schemaId = 1301, interface SGNBMODCONF
835 PROTOCOL sgnb_mod_conf (base){
836 // timestamp in milliseconds
837         ullong timestamp_ms get_sgnb_mod_conf__timestamp_ms (required,increasing);
838 // gNB ID
839         string gnb_id get_sgnb_mod_conf__gnb_id (required);
840 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
841         llong id_MeNB_UE_X2AP_ID get_sgnb_mod_conf__id_MeNB_UE_X2AP_ID (required);
842 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory
843         llong id_SgNB_UE_X2AP_ID get_sgnb_mod_conf__id_SgNB_UE_X2AP_ID (required);
844 }
845
846 // ??? 
847 // Defined in sgnb_mod_req.json on sgnb_modification_request.proto
848 // schemaId = 1201, interface SGNBMODREQ
849 PROTOCOL sgnb_mod_req (base){
850 // timestamp in milliseconds
851         ullong timestamp_ms get_sgnb_mod_req__timestamp_ms (required,increasing);
852 // gNB ID
853         string gnb_id get_sgnb_mod_req__gnb_id (required);
854 //   default=-1
855         llong cause_protocol get_sgnb_mod_req__cause_protocol (required);
856 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
857         llong id_MeNB_UE_X2AP_ID get_sgnb_mod_req__id_MeNB_UE_X2AP_ID (required);
858 //   default=-1
859         llong cause_transport get_sgnb_mod_req__cause_transport (required);
860 //   default=-1
861         llong failureType get_sgnb_mod_req__failureType (required);
862 //   default=-1
863         llong cause_radio_network get_sgnb_mod_req__cause_radio_network (required);
864 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory
865         llong id_SgNB_UE_X2AP_ID get_sgnb_mod_req__id_SgNB_UE_X2AP_ID (required);
866 //   default=-1
867         llong cause_misc get_sgnb_mod_req__cause_misc (required);
868 }
869
870 // ??? 
871 // Defined in sgnb_mod_req_ack.json on sgnb_modification_request_acknowledge.proto
872 // schemaId = 1701, interface SGNBMODREQACK
873 PROTOCOL sgnb_mod_req_ack (base){
874 // timestamp in milliseconds
875         ullong timestamp_ms get_sgnb_mod_req_ack__timestamp_ms (required,increasing);
876 // gNB ID
877         string gnb_id get_sgnb_mod_req_ack__gnb_id (required);
878 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
879         llong id_MeNB_UE_X2AP_ID get_sgnb_mod_req_ack__id_MeNB_UE_X2AP_ID (required);
880 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory
881         llong id_SgNB_UE_X2AP_ID get_sgnb_mod_req_ack__id_SgNB_UE_X2AP_ID (required);
882 }
883
884 // ??? 
885 // Defined in sgnb_mod_req_reject.json on sgnb_modification_request_reject.proto
886 // schemaId = 1801, interface SGNBMODREQREJECT
887 PROTOCOL sgnb_mod_req_reject (base){
888 // timestamp in milliseconds
889         ullong timestamp_ms get_sgnb_mod_req_reject__timestamp_ms (required,increasing);
890 // gNB ID
891         string gnb_id get_sgnb_mod_req_reject__gnb_id (required);
892 //   default=-1
893         llong cause_protocol get_sgnb_mod_req_reject__cause_protocol (required);
894 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
895         llong id_MeNB_UE_X2AP_ID get_sgnb_mod_req_reject__id_MeNB_UE_X2AP_ID (required);
896 //   default=-1
897         llong cause_transport get_sgnb_mod_req_reject__cause_transport (required);
898 //   default=-1
899         llong cause_radio_network get_sgnb_mod_req_reject__cause_radio_network (required);
900 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory
901         llong id_SgNB_UE_X2AP_ID get_sgnb_mod_req_reject__id_SgNB_UE_X2AP_ID (required);
902 //   default=-1
903         llong cause_misc get_sgnb_mod_req_reject__cause_misc (required);
904 }
905
906 // ??? 
907 // Defined in sgnb_mod_rqd.json on sgnb_modification_required.proto
908 // schemaId = 1901, interface SGNBMODREQUIRED
909 PROTOCOL sgnb_mod_required (base){
910 // timestamp in milliseconds
911         ullong timestamp_ms get_sgnb_mod_required__timestamp_ms (required,increasing);
912 // gNB ID
913         string gnb_id get_sgnb_mod_required__gnb_id (required);
914 //   default=-1
915         llong cause_protocol get_sgnb_mod_required__cause_protocol (required);
916 // UE_ID assigned by eNB for the UE over an X2. Is mandatory
917         llong id_MeNB_UE_X2AP_ID get_sgnb_mod_required__id_MeNB_UE_X2AP_ID (required);
918 //   default=-1
919         llong cause_transport get_sgnb_mod_required__cause_transport (required);
920 //   default=-1
921         llong cause_radio_network get_sgnb_mod_required__cause_radio_network (required);
922 // UE_ID assigned by gNB for the UE over the X2.  Is mandatory
923         llong id_SgNB_UE_X2AP_ID get_sgnb_mod_required__id_SgNB_UE_X2AP_ID (required);
924 //   default=-1
925         llong cause_misc get_sgnb_mod_required__cause_misc (required);
926 }
927
928 // ??? 
929 // Defined in sgnb_modification_refuse.json on sgnb_modification_refuse.proto
930 // schemaId = 1401, interface SGNBMODREFUSE
931 PROTOCOL sgnb_mod_refuse (base){
932 // timestamp in milliseconds
933         ullong timestamp_ms get_sgnb_mod_refuse__timestamp_ms (required,increasing);
934 // gNB ID
935         string gnb_id get_sgnb_mod_refuse__gnb_id (required);
936 // UE_ID assigned by eNB for the UE over the X2.  Is mandatory
937         llong id_MeNB_UE_X2AP_ID get_sgnb_mod_refuse__id_MeNB_UE_X2AP_ID (required);
938 // UE_ID assigned by gNB for the UE over an X2. Is optional
939         llong id_SgNB_UE_X2AP_ID get_sgnb_mod_refuse__id_SgNB_UE_X2AP_ID (required);
940 //   default=-1
941         llong cause_radio_network get_sgnb_mod_refuse__cause_radio_network (required);
942 //   default=-1
943         llong cause_transport get_sgnb_mod_refuse__cause_transport (required);
944 //   default=-1
945         llong cause_protocol get_sgnb_mod_refuse__cause_protocol (required);
946 //   default=-1
947         llong cause_misc get_sgnb_mod_refuse__cause_misc (required);
948 }
949
950 //  
951 // Defined in snstatusxfer.json on sn_status_transfer.proto
952 // schemaId = 1601, interface SNSTATUSXFER
953 PROTOCOL sn_status_transfer (base){
954 // timestamp in milliseconds
955         ullong timestamp_ms get_sn_status_transfer__timestamp_ms (required,increasing);
956 // gNB ID
957         string gnb_id get_sn_status_transfer__gnb_id (required);
958 // same as id_MeNB_UE_X2AP_ID in SgNBAdditionRequest, SgNBAdditionRequestAcknowledge, etc
959         llong id_Old_eNB_UE_X2AP_ID get_sn_status_transfer__id_Old_eNB_UE_X2AP_ID (required);
960 // UE_ID assigned by eNB for the UE over the X2.  Is mandatory  default=0
961         uint id_SgNB_UE_X2AP_ID get_sn_status_transfer__id_SgNB_UE_X2AP_ID (required);
962 // Bearer ID
963         llong e_RAB_ID get_sn_status_transfer__e_RAB_ID (required);
964         llong pDCP_SNlength18 get_sn_status_transfer__pDCP_SNlength18 (required);
965 }
966