9.1.4 Messages for IAB Procedures
38.4233GPPNG-RANRelease 17TSXn Application Protocol (XnAP)
9.1.4.1 F1-C TRAFFIC TRANSFER
This message is sent by the M-NG-RAN node to the S-NG-RAN node or by the S-NG-RAN node to the M-NG-RAN node of a dual-connected IAB-node to transfer the F1-C traffic to and from the IAB-node.
Direction: M-NG-RAN node S-NG-RAN node or S-NG-RAN node M-NG-RAN node.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
M-NG-RAN node UE XnAP ID |
M |
NG-RAN node UE XnAP ID 9.2.3.16 |
Allocated at the M-NG-RAN node |
YES |
reject |
|
S-NG-RAN node UE XnAP ID |
M |
NG-RAN node UE XnAP ID 9.2.3.16 |
Allocated at the S-NG-RAN node |
YES |
reject |
|
F1-C Traffic Container |
M |
OCTET STRING |
Contains an F1-C interface SCTP CHUNK and IP header, or an IP packet to protect the traffic on the F1-C interface as defined in TS 33.501 [28]. |
YES |
reject |
9.1.4.2 IAB TRANSPORT MIGRATION MANAGEMENT REQUEST
This message is sent by an F1-terminating IAB-donor to a non-F1-terminating IAB-donor of a boundary IAB-node, for the purpose of setting up, modifying, or releasing (e.g., for the purpose of revoking) the configuration for the migration of boundary and descendant node traffic between two IAB-donors.
Direction: F1-terminating IAB-donor non-F1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-Terminating IAB-donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID 9.2.3.16 |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID, or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non-F1-Terminating IAB-donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID 9.2.3.16 |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID, or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Traffic To Be Added List |
0..1 |
YES |
reject |
|||
>Traffic To Be Added Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Traffic Profile |
M |
9.2.2.81 |
– |
|||
>>F1-terminating Topology BH Information |
O |
9.2.2.82 |
– |
|||
Traffic To Be Modified List |
0..1 |
YES |
reject |
|||
>Traffic To Be Modified Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Traffic Profile |
O |
9.2.2.81 |
– |
|||
>>F1-terminating Topology BH Information |
O |
9.2.2.82 |
– |
|||
Traffic To Be Released Information |
O |
9.2.2.84 |
YES |
reject |
||
IAB TNL Address Request |
O |
9.2.2.85 |
YES |
reject |
||
IAB TNL Address Exception |
O |
9.2.2.98 |
YES |
reject |
Range bound |
Explanation |
maxnoofTrafficIndexEntries |
Maximum no. of traffic offloaded to the non-F1-terminating IAB-donor. The value is 1024. |
9.1.4.3 IAB TRANSPORT MIGRATION MANAGEMENT RESPONSE
This message is sent by the non-F1-terminating IAB-donor to the F1-terminating IAB-donor of a boundary IAB-node to provide inter-donor transport related configurations for the offloaded traffic.
Direction: non-F1-terminating IAB-donor F1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-Terminating IAB-Donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID, or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non-F1-Terminating IAB-Donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID, or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Traffic Added List |
0..1 |
YES |
reject |
|||
>Traffic Added Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Non-F1-terminating Topology BH Information |
M |
9.2.2.83 |
– |
|||
Traffic Modified List |
0..1 |
YES |
reject |
|||
>Traffic Modified Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Non-F1-terminating Topology BH Information |
M |
9.2.2.83 |
– |
|||
Traffic Not Added List |
0..1 |
YES |
reject |
|||
>Traffic Not Added Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Cause |
O |
9.2.3.2 |
– |
|||
Traffic Not Modified List |
0..1 |
YES |
reject |
|||
>Traffic Not Modified Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Cause |
O |
9.2.3.2 |
– |
|||
IAB TNL Address Response |
O |
9.2.2.86 |
YES |
reject |
||
Traffic Released List |
0..1 |
YES |
reject |
|||
>Traffic Released Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>BH Info List |
O |
9.2.2.99 |
– |
Range bound |
Explanation |
maxnoofTrafficIndexEntries |
Maximum no. of traffic offloaded to the non-F1-terminating IAB-donor. The value is 1024. |
9.1.4.3a IAB TRANSPORT MIGRATION MANAGEMENT REJECT
This message is sent by the non-F1-terminating IAB-donor to inform the F1-terminating IAB-donor that the IAB Transport Migration Management procedure has failed.
Direction: Non-F1-terminating IAB-donor F1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-Terminating IAB-Donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID, or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non-F1-Terminating IAB-Donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID, or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Cause |
M |
9.2.3.2 |
YES |
ignore |
||
Criticality Diagnostics |
O |
9.2.3.3 |
YES |
ignore |
9.1.4.4 IAB TRANSPORT MIGRATION MODIFICATION REQUEST
This message is sent by a non-F1-terminating IAB-donor to an F1-terminating IAB-donor of a boundary IAB-node, for the purpose of modifying or releasing (e.g., for the purpose of revoking) the configuration for the migrated traffic of boundary IAB-node or descendant IAB-node.
Direction: non-F1-terminating IAB-donor F1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-Terminating IAB-donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID 9.2.3.16 |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID, or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non-F1-Terminating IAB-donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID, or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Traffic Required To Be Modified List |
0..1 |
YES |
reject |
|||
>Traffic Required To Be Modified Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>Non-F1-terminating topology BH information |
M |
9.2.2.83 |
– |
|||
Traffic To Be Released Information |
O |
9.2.2.84 |
YES |
reject |
||
IAB TNL Address To Be Added |
O |
IAB TNL Address Response 9.2.2.86 |
YES |
reject |
||
IAB TNL Address To Be Released List |
0..1 |
YES |
reject |
|||
>IAB TNL Address To Be Released Item |
1..<maxnoofTLAsIAB> |
– |
||||
>>IAB TNL Address |
M |
9.2.2.92 |
– |
Range bound |
Explanation |
maxnoofTrafficIndexEntries |
Maximum no. of traffic offloaded to the non-F1-terminating IAB-donor. The value is 1024. |
maxnoofTLAsIAB |
Maximum total no. of IPv4 address(es), IPv6 address(es) and IPv6 address prefix(es) that can be requested in one procedure execution. The value is 1024. |
9.1.4.5 IAB TRANSPORT MIGRATION MODIFICATION RESPONSE
This message is sent by the F1-terminating IAB-donor to the non-F1-terminating IAB-donor of a boundary IAB-node to acknowledge the update of configuration requested by the non-F1-terminating IAB-donor.
Direction: F1-terminating IAB-donor non-F1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-Terminating IAB-donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID, or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non-F1-Terminating IAB-donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID, or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Traffic Required Modified List |
0..1 |
YES |
reject |
|||
>Traffic Required Modified Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
Traffic Released List IE |
0..1 |
YES |
reject |
|||
>Traffic Released Item |
1 .. <maxnoofTrafficIndexEntries> |
– |
||||
>>Traffic Index |
M |
9.2.2.80 |
– |
|||
>>BH Info List |
O |
9.2.2.99 |
– |
Range bound |
Explanation |
maxnoofTrafficIndexEntries |
Maximum no. of traffic offloaded to the non-F1-terminating IAB-donor. The value is 1024. |
9.1.4.6 IAB RESOURCE COORDINATION REQUEST
This message is sent by an F1-terminating/non-F1-terminating IAB-donor to a non-F1-terminating/F1-terminating IAB-donor of a boundary IAB-node, for the purpose of coordination of the semi-static resources of a single or dual-connected boundary IAB-node.
Direction: F1-terminating IAB-donor non-F1-terminating IAB-donor, non-F1-terminating IAB-donorF1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-terminating IAB-Donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non F1-terminating IAB-Donor UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Boundary Node Cells List |
0..1 |
List of cells served by the boundary IAB-node IAB-DU. |
YES |
reject |
||
>Boundary Node Cells List Item |
1 .. <maxnoofServedCellsIAB > |
EACH |
reject |
|||
>>Boundary Node Cell Information |
M |
IAB Cell Information 9.2.2.94 |
– |
|||
Parent Node Cells List |
0..1 |
List of cells served by the parent node IAB-DU. |
YES |
reject |
||
>Parent Node Cells List Item |
1 .. < maxnoofServingCells > |
EACH |
reject |
|||
>>Parent Node Cell Information |
M |
IAB Cell Information 9.2.2.94 |
– |
Range bound |
Explanation |
maxnoofServedCellsIAB |
Maximum number of cells served by an IAB-DU or an IAB-donor-DU. Value is 512. |
maxnoofServingCells |
Maximum no. of serving cells for an IAB-MT. Value is 32, as defined by the maxNrofServingCells in TS 38.331 [10]. |
9.1.4.7 IAB RESOURCE COORDINATION RESPONSE
This message is sent by a non-F1-terminating/F1-terminating IAB-donor to an F1-terminating/non-F1-terminating IAB-donor of a boundary IAB-node, in response to an IAB RESOURCE COORDINATION REQUEST message.
Direction: non-F1-terminating IAB-donor F1-terminating IAB-donor, F1-terminating IAB-donor non-F1-terminating IAB-donor.
IE/Group Name |
Presence |
Range |
IE type and reference |
Semantics description |
Criticality |
Assigned Criticality |
Message Type |
M |
9.2.3.1 |
YES |
reject |
||
F1-terminating IAB-Donor node UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Source NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Non F1-terminating IAB-Donor node UE XnAP ID |
M |
NG-RAN node UE XnAP ID |
This IE refers to the Target NG-RAN node UE XnAP ID or to the S-NG-RAN node UE XnAP ID or to the M-NG-RAN node UE XnAP ID. |
YES |
reject |
|
Boundary Node Cells List |
0..1 |
List of cells served by the boundary IAB-node IAB-DU. |
YES |
reject |
||
>Boundary Node Cells List Item |
1 .. <maxnoofServedCellsIAB > |
EACH |
reject |
|||
>>Boundary Node cell Information |
M |
IAB Cell Information 9.2.2.94 |
– |
|||
Parent-Node Cells List |
0..1 |
List of cells served by the parent node IAB-DU. |
YES |
reject |
||
>Parent-Node Cells List Item |
1 .. < maxnoofServingCells > |
EACH |
reject |
|||
>>Parent Node Cell Information |
M |
IAB Cell Information 9.2.2.94 |
– |
Range bound |
Explanation |
maxnoofServedCellsIAB |
Maximum number of cells served by an IAB-DU or an IAB-donor-DU. Value is 512. |
maxnoofServingCells |
Maximum no. of serving cells for an IAB-MT. Value is 32, as defined by the maxNrofServingCells in TS 38.331 [10]. |