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