Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- marked/Rel-18/29_series/29013/raw.md +770 -0
- marked/Rel-18/29_series/29116/raw.md +0 -0
- marked/Rel-18/29_series/29118/raw.md +0 -0
- marked/Rel-18/29_series/29119/raw.md +296 -0
- marked/Rel-18/29_series/29128/raw.md +0 -0
- marked/Rel-18/29_series/29173/raw.md +643 -0
- marked/Rel-18/29_series/29202/raw.md +0 -0
- marked/Rel-18/29_series/29204/raw.md +0 -0
- marked/Rel-18/29_series/29205/raw.md +953 -0
- marked/Rel-18/29_series/29217/raw.md +938 -0
- marked/Rel-18/29_series/29219/raw.md +862 -0
- marked/Rel-18/29_series/29228/raw.md +0 -0
- marked/Rel-18/29_series/29250/raw.md +1157 -0
- marked/Rel-18/29_series/29251/raw.md +0 -0
- marked/Rel-18/29_series/29256/raw.md +1155 -0
- marked/Rel-18/29_series/29257/raw.md +0 -0
- marked/Rel-18/29_series/29272/raw.md +0 -0
- marked/Rel-18/29_series/29275/raw.md +0 -0
- marked/Rel-18/29_series/29281/raw.md +0 -0
- marked/Rel-18/29_series/29292/raw.md +0 -0
- marked/Rel-18/29_series/29379/raw.md +0 -0
- marked/Rel-18/29_series/29510/raw.md +0 -0
- marked/Rel-18/29_series/29517/raw.md +0 -0
- marked/Rel-18/29_series/29519/raw.md +0 -0
- marked/Rel-18/29_series/29520/raw.md +0 -0
- marked/Rel-18/29_series/29521/raw.md +0 -0
- marked/Rel-18/29_series/29526/raw.md +0 -0
- marked/Rel-18/29_series/29542/raw.md +849 -0
- marked/Rel-18/29_series/29543/raw.md +0 -0
- marked/Rel-18/29_series/29544/raw.md +767 -0
- marked/Rel-18/29_series/29572/raw.md +0 -0
- marked/Rel-18/29_series/29573/raw.md +0 -0
- marked/Rel-18/29_series/29574/raw.md +0 -0
- marked/Rel-18/29_series/29575/raw.md +0 -0
- marked/Rel-18/29_series/29580/raw.md +0 -0
- marked/Rel-18/29_series/29581/raw.md +0 -0
- marked/Rel-18/29_series/29586/raw.md +0 -0
- marked/Rel-18/29_series/29673/raw.md +0 -0
- marked/Rel-18/29_series/29674/raw.md +0 -0
- marked/Rel-18/29_series/29893/raw.md +0 -0
- marked/Rel-18/37_series/37104/10d81b2cc455e3563e3e562a7f451124_img.jpg +3 -0
- marked/Rel-18/37_series/37104/455c842681aadb4969bd61d71f556744_img.jpg +3 -0
- marked/Rel-18/37_series/37104/5fb340ad68b0c71df0b56698b137e35b_img.jpg +3 -0
- marked/Rel-18/37_series/37104/64662465bba247703fdec49c8f3309f9_img.jpg +3 -0
- marked/Rel-18/37_series/37104/673e9e5873f9a4b71bbe7bac2cf6b758_img.jpg +3 -0
- marked/Rel-18/37_series/37104/a26e142d3df5bef41a84a9dd099d7825_img.jpg +3 -0
- marked/Rel-18/37_series/37104/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg +3 -0
- marked/Rel-18/37_series/37104/c67407c82ad10179bcb338347ded4245_img.jpg +3 -0
- marked/Rel-18/37_series/37104/cab0834804fb031b43865554cc8d06ab_img.jpg +3 -0
- marked/Rel-18/37_series/37113/27b06ec9f42b5d727a2630f61a5f1861_img.jpg +3 -0
marked/Rel-18/29_series/29013/raw.md
ADDED
|
@@ -0,0 +1,770 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.013 V18.0.0 (2024-03)
|
| 4 |
+
|
| 5 |
+
Technical Specification
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Signalling interworking between ISDN supplementary services; Application Service Element (ASE) and Mobile Application Part (MAP) protocols (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
**GLOBAL SYSTEM FOR
|
| 12 |
+
MOBILE COMMUNICATIONS**
|
| 13 |
+
|
| 14 |
+
GSMA logo
|
| 15 |
+
|
| 16 |
+

|
| 17 |
+
|
| 18 |
+
3GPP logo
|
| 19 |
+
|
| 20 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 21 |
+
|
| 22 |
+
## **3GPP**
|
| 23 |
+
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
Postal address
|
| 27 |
+
|
| 28 |
+
---
|
| 29 |
+
|
| 30 |
+
---
|
| 31 |
+
|
| 32 |
+
3GPP support office address
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 37 |
+
Valbonne - FRANCE
|
| 38 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 39 |
+
|
| 40 |
+
---
|
| 41 |
+
|
| 42 |
+
Internet
|
| 43 |
+
|
| 44 |
+
---
|
| 45 |
+
|
| 46 |
+
<http://www.3gpp.org>
|
| 47 |
+
|
| 48 |
+
## --- **Copyright Notification** ---
|
| 49 |
+
|
| 50 |
+
No part may be reproduced except as authorized by written permission.
|
| 51 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 52 |
+
|
| 53 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 54 |
+
All rights reserved.
|
| 55 |
+
|
| 56 |
+
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
|
| 57 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 58 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 59 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 60 |
+
|
| 61 |
+
# Contents
|
| 62 |
+
|
| 63 |
+
| | |
|
| 64 |
+
|---------------------------------------------------------------------------|-----------|
|
| 65 |
+
| Foreword ..... | 4 |
|
| 66 |
+
| 1 Scope..... | 4 |
|
| 67 |
+
| 2 References..... | 4 |
|
| 68 |
+
| 3 Definitions and abbreviations ..... | 5 |
|
| 69 |
+
| 3.1 Definitions..... | 5 |
|
| 70 |
+
| 3.2 Abbreviations ..... | 5 |
|
| 71 |
+
| 4 General..... | 6 |
|
| 72 |
+
| 4.1 GSM CCBS Architecture Overview ..... | 6 |
|
| 73 |
+
| 4.2 GSM CCBS - ISDN CCBS ASE Interworking Overview ..... | 7 |
|
| 74 |
+
| 4.3 Overview on the use of CCBS procedures and parameters values ..... | 8 |
|
| 75 |
+
| 4.4 Mapping between MAP and SSAP application layer messages ..... | 8 |
|
| 76 |
+
| 4.4.1 MAP D-interface to SSAP interface mapping in HLR A..... | 8 |
|
| 77 |
+
| 4.4.2 SSAP interface to MAP D-interface interface mapping in HLR A..... | 8 |
|
| 78 |
+
| 5 Mapping between MAP message parameters and SSAP message parameters..... | 9 |
|
| 79 |
+
| 5.1 CCBS Request Invocation..... | 9 |
|
| 80 |
+
| 5.1.1 Encoding of called party subaddress information ..... | 11 |
|
| 81 |
+
| 5.2 CCBS Request Result..... | 11 |
|
| 82 |
+
| 5.3 CCBS Request Error ..... | 12 |
|
| 83 |
+
| 6 Dialogue handling on the SSAP interface..... | 13 |
|
| 84 |
+
| 6.1 Dialogue Beginning..... | 13 |
|
| 85 |
+
| 6.1.1 CCBS Request Invocation..... | 13 |
|
| 86 |
+
| 6.2 Dialogue Continuation ..... | 13 |
|
| 87 |
+
| 6.2.1 CCBS Request Result..... | 13 |
|
| 88 |
+
| 6.2.2 CCBS Remote User Free Invocation..... | 14 |
|
| 89 |
+
| 6.2.3 CCBS Suspend Invocation ..... | 14 |
|
| 90 |
+
| 6.2.4 CCBS Resume Invocation..... | 15 |
|
| 91 |
+
| 6.3 Dialogue End..... | 15 |
|
| 92 |
+
| 6.3.1 Normal dialogue end ..... | 15 |
|
| 93 |
+
| 6.3.2 CCBS Cancel Invocation (from A-side)..... | 16 |
|
| 94 |
+
| 6.3.3 CCBS Cancel Invocation (from B-side)..... | 16 |
|
| 95 |
+
| 6.3.4 CCBS Request Error..... | 17 |
|
| 96 |
+
| 7 Addressing of SCCP layer messages on the SSAP interface..... | 17 |
|
| 97 |
+
| 7.1 Use of SCCP..... | 17 |
|
| 98 |
+
| 7.2 Addressing of messages at the originating PLMN..... | 17 |
|
| 99 |
+
| 7.2.1 TC-BEGIN message from the originating network HLR..... | 17 |
|
| 100 |
+
| 7.2.2 TC-CONTINUE, TC-END messages from the originating network HLR ..... | 18 |
|
| 101 |
+
| 7.3 Addressing of messages at the destination PLMN..... | 18 |
|
| 102 |
+
| 7.3.1 TC-CONTINUE, TC-END messages from the destination network HLR ..... | 18 |
|
| 103 |
+
| 7.4 Number formats of the SCCP address parameters..... | 19 |
|
| 104 |
+
| 7.4.1 Originating PLMN..... | 19 |
|
| 105 |
+
| 7.4.2 Destination PLMN..... | 19 |
|
| 106 |
+
| <b>Annex A (informative): Change history.....</b> | <b>20</b> |
|
| 107 |
+
|
| 108 |
+
# --- Foreword
|
| 109 |
+
|
| 110 |
+
This Technical Specification has been produced by the 3GPP.
|
| 111 |
+
|
| 112 |
+
This TS provides a detailed specification for interworking between the ISDN Supplementary Services ASE protocol and the Mobile Application Part (MAP) D interface protocol for handling of supplementary services within the 3GPP system.
|
| 113 |
+
|
| 114 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of this TS, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 115 |
+
|
| 116 |
+
Version 3.y.z
|
| 117 |
+
|
| 118 |
+
where:
|
| 119 |
+
|
| 120 |
+
- x the first digit:
|
| 121 |
+
- 1 presented to TSG for information;
|
| 122 |
+
- 2 presented to TSG for approval;
|
| 123 |
+
- 3 Indicates TSG approved document under change control.
|
| 124 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 125 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the specification;
|
| 126 |
+
|
| 127 |
+
# --- 1 Scope
|
| 128 |
+
|
| 129 |
+
The scope of the present document is to provide a specification for interworking between the ISDN Application Service Element (ASE) protocol for supplementary services and the Mobile Application Part (MAP) protocol on MAP D-interface protocol for handling of supplementary services within the digital cellular telecommunications system (Phase 2+). This version of the specification includes the interworking for the Call Completion to Busy Subscriber (CCBS) service between the ISDN CCBS-ASE and MAP.
|
| 130 |
+
|
| 131 |
+
The MAP protocol for CCBS service is specified in GSM 09.02. The ISDN CCBS-ASE protocol is specified in ETS 300 356-18. The ISDN CCBS-ASE protocol is also commonly referred to as the SSAP protocol in GSM 03.93. This specification clarifies the interworking within the HLR between these protocols for the Call Completion to Busy Subscriber (CCBS) service.
|
| 132 |
+
|
| 133 |
+
Clause 4 describes the mapping between MAP application layer messages and SSAP application layer messages.
|
| 134 |
+
|
| 135 |
+
Clause 5 describes the mapping between MAP message parameters and SSAP message parameters.
|
| 136 |
+
|
| 137 |
+
Clause 6 describes the dialogue handling on the SSAP interface.
|
| 138 |
+
|
| 139 |
+
Clause 7 describes the SCCP layer addressing for messages on the SSAP interface.
|
| 140 |
+
|
| 141 |
+
# --- 2 References
|
| 142 |
+
|
| 143 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 144 |
+
|
| 145 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 146 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 147 |
+
|
| 148 |
+
- For a non-specific reference, the latest version applies.
|
| 149 |
+
- [1] GSM 01.04: "Digital cellular telecommunications system (Phase 2+); Abbreviations and acronyms".
|
| 150 |
+
- [2] GSM 02.93: "Digital cellular telecommunications system (Phase 2+); Completion of calls to busy subscriber (CCBS) supplementary services - Stage 1".
|
| 151 |
+
- [3] GSM 03.93: "Digital cellular telecommunications system (Phase 2+); Technical Realisation of Completion of Calls to Busy Subscriber (CCBS); Stage 2".
|
| 152 |
+
- [4] GSM 04.80: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 supplementary services specification Formats and coding".
|
| 153 |
+
- [5] GSM 04.93: "Digital cellular telecommunications system (Phase 2+); Technical Realisation of Completion of Calls to Busy Subscriber (CCBS); Stage 3".
|
| 154 |
+
- [6] GSM 09.02 "Digital cellular telecommunications system (Phase 2+); Mobile Application Part (MAP) specification".
|
| 155 |
+
- [7] GSM 09.07 : "Digital cellular telecommunications system (Phase 2+); General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)".
|
| 156 |
+
- [8] ETS 300 102-1 (1990): "Integrated Services Digital Network (ISDN); User-network interface layer 3 specifications for basic call control".
|
| 157 |
+
- [9] ETS 300 356-18: "ISDN User Part (ISUP) version 2 for the international interface: Part 18: Completion of Calls to Busy Subscriber (CCBS) supplementary service".
|
| 158 |
+
- [10] ETS 300 358: "Integrated Services Digital Network (ISDN); Completion of Calls to Busy Subscriber (CCBS) supplementary service; Functional capabilities and information flows".
|
| 159 |
+
|
| 160 |
+
# --- 3 Definitions and abbreviations
|
| 161 |
+
|
| 162 |
+
## 3.1 Definitions
|
| 163 |
+
|
| 164 |
+
For the purposes of this specification, the following definitions apply:
|
| 165 |
+
|
| 166 |
+
**SSAP:** Supplementary Service Application Part. SSAP is the protocol used for CCBS procedures on the interface between the originating and destination network. Communication across this interface is performed using SCCP Connectionless Signalling (Refer to ETS 300 358). The terms CCBS-ASE defined in ETS 300 356-18 for the ISDN CCBS service and SSAP defined in GSM 03.93 are the same and are used interchangeably in this specification. The SSAP interface is between the originating network entities (HLR A, OLE) and the destination network entities (HLR B, DLE).
|
| 167 |
+
|
| 168 |
+
## 3.2 Abbreviations
|
| 169 |
+
|
| 170 |
+
Abbreviations used in this specification are listed in GSM 01.04.
|
| 171 |
+
|
| 172 |
+
For the purposes of this specification, the following abbreviations apply:
|
| 173 |
+
|
| 174 |
+
| | |
|
| 175 |
+
|------|----------------------------------------|
|
| 176 |
+
| ASE | Application Service Element |
|
| 177 |
+
| CCBS | Call Completion to Busy Subscriber |
|
| 178 |
+
| DLE | Destination Local Exchange |
|
| 179 |
+
| ISDN | Integrated Services Digital Network |
|
| 180 |
+
| MAP | Mobile Application Part |
|
| 181 |
+
| OLE | Originating Local Exchange |
|
| 182 |
+
| SCCP | Signalling Connection Control Part |
|
| 183 |
+
| SSAP | Supplementary Service Application Part |
|
| 184 |
+
| TC | Transaction Capabilities |
|
| 185 |
+
|
| 186 |
+
# 4 General
|
| 187 |
+
|
| 188 |
+
## 4.1 GSM CCBS Architecture Overview
|
| 189 |
+
|
| 190 |
+
The stage 1 of the CCBS service is defined in GSM 02.93.
|
| 191 |
+
|
| 192 |
+
The network architecture to support the CCBS service in GSM networks is defined in GSM 03.93. For convenience, the architecture is shown again in this specification. Figure 4.1.1 is an architectural overview of the CCBS service when interworking between the originating and the destination networks involved. The originating network may be a mobile network or a fixed network and the destination network may also be a mobile network or a fixed network.
|
| 193 |
+
|
| 194 |
+
The call related signalling (see ETS 300 356-18) for CCBS is performed on ISUP links on the following interfaces:
|
| 195 |
+
|
| 196 |
+
VMSC A - GMSC B;
|
| 197 |
+
|
| 198 |
+
VMSC A - DLE;
|
| 199 |
+
|
| 200 |
+
OLE - GMSC B;
|
| 201 |
+
|
| 202 |
+
whereas the specific CCBS procedures (see ETS 300 356-18) are performed via the SSAP protocol, which is signalled on the following interfaces:
|
| 203 |
+
|
| 204 |
+
HLR A - HLR B;
|
| 205 |
+
|
| 206 |
+
HLR A - DLE;
|
| 207 |
+
|
| 208 |
+
OLE - HLR B.
|
| 209 |
+
|
| 210 |
+
This specification only describes the MAP - SSAP protocol interworking.
|
| 211 |
+
|
| 212 |
+

|
| 213 |
+
|
| 214 |
+
```
|
| 215 |
+
graph LR
|
| 216 |
+
subgraph Originating_Network [Originating Network]
|
| 217 |
+
subgraph Fixed_Network_A [Fixed Network]
|
| 218 |
+
OLE[OLE]
|
| 219 |
+
end
|
| 220 |
+
subgraph Mobile_Network_A [Mobile Network]
|
| 221 |
+
HLR_A[HLR A]
|
| 222 |
+
VLR_A[VLR A]
|
| 223 |
+
VMSC_A[VMSC A]
|
| 224 |
+
end
|
| 225 |
+
end
|
| 226 |
+
subgraph Destination_Network [Destination Network]
|
| 227 |
+
subgraph Fixed_Network_B [Fixed Network]
|
| 228 |
+
DLE[DLE]
|
| 229 |
+
end
|
| 230 |
+
subgraph Mobile_Network_B [Mobile Network]
|
| 231 |
+
HLR_B[HLR B]
|
| 232 |
+
VLR_B[VLR B]
|
| 233 |
+
VMSC_B[VMSC B]
|
| 234 |
+
GMSC_B[GMSC B]
|
| 235 |
+
end
|
| 236 |
+
end
|
| 237 |
+
TRANSIT((TRANSIT NETWORK(S)))
|
| 238 |
+
OLE -- ISUP --> TRANSIT
|
| 239 |
+
OLE -- SSAP --> TRANSIT
|
| 240 |
+
VMSC_A -- ISUP --> TRANSIT
|
| 241 |
+
HLR_A -- SSAP --> TRANSIT
|
| 242 |
+
HLR_A -- SSAP --> DLE
|
| 243 |
+
HLR_A -- MAP --> HLR_B
|
| 244 |
+
HLR_A -- MAP --> GMSC_B
|
| 245 |
+
TRANSIT -- ISUP --> DLE
|
| 246 |
+
TRANSIT -- SSAP --> DLE
|
| 247 |
+
TRANSIT -- ISUP --> GMSC_B
|
| 248 |
+
TRANSIT -- SSAP --> HLR_B
|
| 249 |
+
GMSC_B -- ISUP --> VMSC_B
|
| 250 |
+
```
|
| 251 |
+
|
| 252 |
+
Figure 4.1: Architectural overview showing common point of interworking. The diagram shows an Originating Network on the left and a Destination Network on the right, both connected to a central TRANSIT NETWORK(S). In the Originating Network, a Fixed Network (OLE) and a Mobile Network (VMSC A) are connected to the transit network via ISUP and SSAP links. The Mobile Network also includes HLR A and VLR A. In the Destination Network, a Fixed Network (DLE) and a Mobile Network (VMSC B) are connected to the transit network via ISUP and SSAP links. The Mobile Network also includes HLR B, VLR B, and GMSC B. SSAP links connect OLE to DLE, HLR A to HLR B, and HLR A to DLE. MAP links connect HLR A to HLR B and HLR A to GMSC B. ISUP links connect VMSC A to GMSC B and VMSC A to DLE.
|
| 253 |
+
|
| 254 |
+
Figure 4.1: Architectural overview showing common point of interworking
|
| 255 |
+
|
| 256 |
+
## 4.2 GSM CCBS - ISDN CCBS ASE Interworking Overview
|
| 257 |
+
|
| 258 |
+
The non-call related signalling procedures for CCBS between the originating network and the destination network are defined in ETS 300 356-18 as the ISDN CCBS-ASE. The GSM network also uses these signalling procedures for CCBS without any changes. The ISDN CCBS ASE protocol is supported in GSM networks in the HLR A (originating network) and HLR B (destination network). Therefore no protocol interworking for ISDN CCBS-ASE is needed for the CCBS service between GSM networks and ISDN networks.
|
| 259 |
+
|
| 260 |
+
In GSM networks, the CCBS functionality is distributed across several network entities (see GSM 03.93) including the HLR, VLR, MSC and the MS. The HLR shall provide any necessary signalling interworking between the MAP protocol for call completion services on the MAP D-interface (between the VLR and the HLR) and ISDN CCBS-ASE protocol between the originating and destination networks.
|
| 261 |
+
|
| 262 |
+
The MAP protocol for CCBS service is specified in GSM 09.02. The ISDN CCBS-ASE protocol is specified in ETS 300 356-18. This specification clarifies the interworking within the HLR between these protocols.
|
| 263 |
+
|
| 264 |
+
## 4.3 Overview on the use of CCBS procedures and parameters values
|
| 265 |
+
|
| 266 |
+
A GSM subscriber can roam while there is an active CCBS request. The called party address (MSISDN) information is used to initiate a dialogue with the destination network on the SSAP interface. The dialogue on the SSAP interface is opened and maintained while there is an active CCBS request (see ETS 300 356-18). However, the dialogues on the MAP D interface can be closed and reopened as necessary (see GSM 09.02 and GSM 03.93) and use the IMSI information for addressing.
|
| 267 |
+
|
| 268 |
+
## 4.4 Mapping between MAP and SSAP application layer messages
|
| 269 |
+
|
| 270 |
+
The mapping of MAP messages on the D interface and SSAP messages between the originating and destination networks is described. The precise coding of these messages is given in GSM 09.02 and ETS 300 356-18.
|
| 271 |
+
|
| 272 |
+
### 4.4.1 MAP D-interface to SSAP interface mapping in HLR A
|
| 273 |
+
|
| 274 |
+
**Table 4.1: Mapping of GSM 09.02 (MAP) operations to ETS 300 356-18 (SSAP) operations**
|
| 275 |
+
|
| 276 |
+
| MAP OPERATIONS | SSAP OPERATIONS |
|
| 277 |
+
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
|
| 278 |
+
| RegisterCCEntry | CcbsRequest |
|
| 279 |
+
| EraseCCEntry/ A GSM 03.93 Event (note 1) | CcbsCancel |
|
| 280 |
+
| RemoteUserFree Result/<br>RemoteUserFree Error/<br>A GSM 03.93 Event (note 2) | CcbsSuspend |
|
| 281 |
+
| StatusReport/<br>A GSM 03.93 Event (note 3) | CcbsResume |
|
| 282 |
+
| NOTE 1 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being cancelled. The SSAP CcbsCancel operation can include a cause code parameter; this shall be set to the appropriate value corresponding to the actual dynamic event by HLR A (e.g. cCBS-T3-Timeout, cCBS-T4-Timeout). | |
|
| 283 |
+
| NOTE 2 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being suspended. | |
|
| 284 |
+
| NOTE 3 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being resumed. | |
|
| 285 |
+
|
| 286 |
+
### 4.4.2 SSAP interface to MAP D-interface interface mapping in HLR A
|
| 287 |
+
|
| 288 |
+
| SSAP OPERATIONS | MAP OPERATIONS |
|
| 289 |
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
|
| 290 |
+
| CcbsRequest Result | RegisterCCEntry Result |
|
| 291 |
+
| CcbsRequest Error | RegisterCCEntry Error |
|
| 292 |
+
| RemoteUserFree | RemoteUserFree |
|
| 293 |
+
| CcbsCancel | SetReportingState/A GSM 03.93 Event (note 1) |
|
| 294 |
+
| NOTE 1 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A resulting from a CCBS request being cancelled. The SSAP CcbsCancel operation can include a cause code parameter(e.g. cCBS-T7-Timeout, cCBS-T9-Timeout). | |
|
| 295 |
+
|
| 296 |
+
# 5 Mapping between MAP message parameters and SSAP message parameters
|
| 297 |
+
|
| 298 |
+
The mapping between MAP message parameters and SSAP message parameters is described. The precise coding of these messages is given in GSM 09.02 and ETS 300 356-18.
|
| 299 |
+
|
| 300 |
+
The following messages on the SSAP interface do not contain any parameters:
|
| 301 |
+
|
| 302 |
+
- RemoteUserFree;
|
| 303 |
+
- Suspend;
|
| 304 |
+
- Resume.
|
| 305 |
+
|
| 306 |
+
## 5.1 CCBS Request Invocation
|
| 307 |
+
|
| 308 |
+

|
| 309 |
+
|
| 310 |
+
```
|
| 311 |
+
sequenceDiagram
|
| 312 |
+
participant VLRA
|
| 313 |
+
participant HLRA
|
| 314 |
+
participant DN as DESTINATION NETWORK B
|
| 315 |
+
Note left of VLRA: +--+\n | |\n +--+\n VLRA->>HLRA: RegisterCCEntry\n Note right of VLRA: TC-BEGIN\n Note left of HLRA: +--+\n | |\n +--+\n HLRA->>DN: CcbsRequest\n Note right of HLRA: TC-BEGIN\n Note left of DN: +--+\n | |\n +--+\n
|
| 316 |
+
```
|
| 317 |
+
|
| 318 |
+
The diagram illustrates the signalling flow for CCBS Request Invocation. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: VLRA sends a RegisterCCEntry message to HLRA, accompanied by a TC-BEGIN message. HLRA then sends a CcbsRequest message to DESTINATION NETWORK B, also accompanied by a TC-BEGIN message. Each entity is represented by a vertical dashed line with a '+' at the top and bottom, indicating the start and end of the interaction period.
|
| 319 |
+
|
| 320 |
+
Signalling flow for CCBS Request Invocation diagram
|
| 321 |
+
|
| 322 |
+
Figure 5.1: Signalling flow for CCBS Request Invocation
|
| 323 |
+
|
| 324 |
+
Table 5.1: Mapping of CCBS Request Invocation parameters
|
| 325 |
+
|
| 326 |
+
| RegisterCCEntry PARAMETERS | CcbsRequest PARAMETERS |
|
| 327 |
+
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
|
| 328 |
+
| ss-Code | not present |
|
| 329 |
+
| ccbs-Feature<br>- b-subscriberSubaddress (note 1) | accessTransportParameter (note 2) |
|
| 330 |
+
| translatedB-Number | calledPartyNumber (note 3) |
|
| 331 |
+
| serviceIndicator | not present |
|
| 332 |
+
| callInfo | not present |
|
| 333 |
+
| networkSignallInfo<br>- ISDN BC Tag, Length, Content (note 4) | userServiceInf |
|
| 334 |
+
| networkSignallInfo<br>- HLC Tag, Length, Content (note 5) | accessTransportParameter (note 2) |
|
| 335 |
+
| networkSignallInfo<br>- LLC Tag, Length, Content (note 6) | accessTransportParameter (note 2) |
|
| 336 |
+
| not present | retainSupported (note 7) |
|
| 337 |
+
| not present | callingPartyNumber (note 8) |
|
| 338 |
+
| not present | userServiceInfPrime (note 9) |
|
| 339 |
+
| NOTE 1 CCBS-Feature contains the b-subscriberSubaddress parameter which is the called party subaddress. The GSM HLR A shall map the called party subaddress into the accessTransportParameter if received from the VLR. The entire called party subaddress information (i.e. called party subaddress IEI, LENGTH and CONTENT) is mapped into the accessTransportParameter. See subclause 5.1.1. for details of the required encoding. | |
|
| 340 |
+
| NOTE 2 The CcbsRequest contains only one accessTransportParameter. This parameter contains information on the ISDN HLC, LLC and Subaddress. | |
|
| 341 |
+
| NOTE 3 The calledParty Number shall be in the international E.164 format. | |
|
| 342 |
+
| NOTE 4 The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The ISDN BC information element CONTENT (i.e. without ISDN BC TAG, LENGTH) is mapped into the userServiceInf parameter. | |
|
| 343 |
+
| NOTE 5 The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The entire ISDN HLC information element (i.e. ISDN HLC TAG, LENGTH and CONTENT) is mapped into the accessTransportParameter. | |
|
| 344 |
+
| NOTE 6 The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The entire ISDN LLC information element (i.e. ISDN LLC TAG, LENGTH and CONTENT) is mapped into the accessTransportParameter. | |
|
| 345 |
+
| NOTE 7 This information is local to the HLR A. This information element shall be coded by HLR A to reflect whether it supports CCBS Retention capability. | |
|
| 346 |
+
| NOTE 8 This information is local to HLR A. The HLR A provides callingPartyNumber if CLIR was not invoked (See the serviceIndicator parameter in GSM 09.02 and GSM 03.93). If sent, the A subscriber's identity shall be the Basic MSISDN (i.e. the main MSISDN) and shall be in the international E.164 format. | |
|
| 347 |
+
| NOTE 9 The GSM HLR A shall not send the userServiceInfPrime | |
|
| 348 |
+
|
| 349 |
+
### 5.1.1 Encoding of called party subaddress information
|
| 350 |
+
|
| 351 |
+
The CCBS-Feature parameter is received from the VLR and it may include the b-subscriberSubaddress parameter as defined in GSM 09.02. The Called Party Subaddress information requires additional processing in HLR to ensure correct encoding of this information on the SSAP interface. The HLR shall add two octets to the ISDN-SubaddressString received from the VLR as indicated in figure 5.2.
|
| 352 |
+
|
| 353 |
+

|
| 354 |
+
|
| 355 |
+
| |
|
| 356 |
+
|--------------------------------------------------------------------------|
|
| 357 |
+
| Called Party Subaddress IEI<br>(See ETS 300 102-1)<br>0111 0001 (note 1) |
|
| 358 |
+
| Length of the called party address<br>contents (note 2) |
|
| 359 |
+
| ISDN-SubaddressString<br>(See GSM 09.02)<br><br>(note 3) |
|
| 360 |
+
|
| 361 |
+
NOTE 1 Called Party Subaddress Information Element Identifier (IEI) is defined by ETS 300 102-1. Its value is "01110001". This information is not sent from the VLR and has to be derived locally in the HLR for interworking purposes.
|
| 362 |
+
|
| 363 |
+
NOTE 2 This information has to be derived locally in the HLR for interworking purposes.
|
| 364 |
+
|
| 365 |
+
NOTE 3 This information is sent by the VLR. The ISDN-SubaddressString contents is defined in GSM 09.02.
|
| 366 |
+
|
| 367 |
+
**Figure 5.2: Encoding of Called Party Subaddress information**
|
| 368 |
+
|
| 369 |
+
## 5.2 CCBS Request Result
|
| 370 |
+
|
| 371 |
+

|
| 372 |
+
|
| 373 |
+
```
|
| 374 |
+
|
| 375 |
+
sequenceDiagram
|
| 376 |
+
participant VLRA
|
| 377 |
+
participant HLRA
|
| 378 |
+
participant DN as DESTINATION NETWORK B
|
| 379 |
+
Note right of DN: CcbsRequest-Result
|
| 380 |
+
TC-CONTINUE
|
| 381 |
+
DN-->HLRA:
|
| 382 |
+
Note right of HLRA: RegisterCCEntry-Result
|
| 383 |
+
TC-END
|
| 384 |
+
HLRA-->VLRA:
|
| 385 |
+
|
| 386 |
+
```
|
| 387 |
+
|
| 388 |
+
The diagram illustrates the signalling flow for the CCBS Request Result. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The flow starts with a message from DESTINATION NETWORK B to HLRA labeled 'CcbsRequest-Result' and 'TC-CONTINUE'. HLRA then sends a response back to DESTINATION NETWORK B. Next, HLRA sends a message to VLRA labeled 'RegisterCCEntry-Result' and 'TC-END'.
|
| 389 |
+
|
| 390 |
+
Signalling flow diagram for CCBS Request Result showing interactions between VLRA, HLRA, and DESTINATION NETWORK B.
|
| 391 |
+
|
| 392 |
+
**Figure 5.3: Signalling flow for CCBS Request Result**
|
| 393 |
+
|
| 394 |
+
Table 5.2: Mapping of CCBS Request Result parameters
|
| 395 |
+
|
| 396 |
+
| CcbsRequest_ Result PARAMETERS | RegisterCCEntry_ Result PARAMETERS |
|
| 397 |
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
|
| 398 |
+
| retainSupported (note 1) | not present |
|
| 399 |
+
| not present | ccbs-Feature (note 2) |
|
| 400 |
+
| NOTE 1 This information is associated with each CCBS Request and indicates whether CCBS Retention is supported by the destination B network (see GSM 03.93). | |
|
| 401 |
+
| NOTE 2 This information is local to the HLR A. Some of information contained in ccbs-Feature (e.g. ccbs-index) is allocated by the HLR A. The ccbs-Feature information is sent to the MS (see GSM 03.93, GSM 04.93). | |
|
| 402 |
+
|
| 403 |
+
## 5.3 CCBS Request Error
|
| 404 |
+
|
| 405 |
+

|
| 406 |
+
|
| 407 |
+
```
|
| 408 |
+
|
| 409 |
+
sequenceDiagram
|
| 410 |
+
participant VLRA
|
| 411 |
+
participant HLRA
|
| 412 |
+
participant DESTINATION_NETWORK_B as DESTINATION NETWORK B
|
| 413 |
+
Note right of DESTINATION_NETWORK_B: +--+\n | | |\n Note left of HLRA: +--+\n | | |\n Note left of VLRA: +--+\n | | |\n DESTINATION_NETWORK_B->>HLRA: CcbsRequest-Error\n Note right of HLRA: TC-END\n HLRA-->>VLRA: RegisterCCEntry-Error\n Note left of VLRA: TC-END
|
| 414 |
+
|
| 415 |
+
```
|
| 416 |
+
|
| 417 |
+
Signalling flow for CCBS Request Error diagram showing three vertical lifelines: VLRA, HLRA, and DESTINATION NETWORK B. The flow starts with a message from DESTINATION NETWORK B to HLRA labeled 'CcbsRequest-Error' and 'TC-END'. HLRA then sends a message back to VLRA labeled 'RegisterCCEntry-Error' and 'TC-END'.
|
| 418 |
+
|
| 419 |
+
Figure 5.4: Signalling flow for CCBS Request Error
|
| 420 |
+
|
| 421 |
+
Table 5.3: Mapping of CCBS Request Error parameters
|
| 422 |
+
|
| 423 |
+
| CcbsRequest_ Error PARAMETERS | RegisterCCEntry_ Error PARAMETERS |
|
| 424 |
+
|----------------------------------------------------------------------------------------------------------------------|------------------------------------------|
|
| 425 |
+
| shortTermDenial/ longTermDenial (note 1) | shortTermDenial/ longTermDenial (note 2) |
|
| 426 |
+
| NOTE 1 For coding of these User Errors see ETS 300 356-18. | |
|
| 427 |
+
| NOTE 2 For coding of these User Errors see GSM 09.02. This information is sent to the MS (see GSM 04.93, GSM 04.80). | |
|
| 428 |
+
|
| 429 |
+
# 6 Dialogue handling on the SSAP interface
|
| 430 |
+
|
| 431 |
+
The dialogue handling on the SSAP interface and the mapping between the corresponding TC transaction sublayer messages on the MAP D and SSAP interfaces is described. The diagrams show the general principle of dialogue handling. Specific message flows depend on the dynamics of the application in the network elements, see GSM 03.93 and GSM 09.02.
|
| 432 |
+
|
| 433 |
+
## 6.1 Dialogue Beginning
|
| 434 |
+
|
| 435 |
+
### 6.1.1 CCBS Request Invocation
|
| 436 |
+
|
| 437 |
+

|
| 438 |
+
|
| 439 |
+
```
|
| 440 |
+
sequenceDiagram
|
| 441 |
+
participant VLRA
|
| 442 |
+
participant HLRA
|
| 443 |
+
participant DN as DESTINATION NETWORK B
|
| 444 |
+
Note left of VLRA: +--+\n VLRA->>HLRA: RegisterCCEntry\n Note right of HLRA: TC-BEGIN\n HLRA->>DN: CcbsRequest\n Note right of HLRA: TC-BEGIN SCCP
|
| 445 |
+
```
|
| 446 |
+
|
| 447 |
+
The diagram illustrates the signalling flow for CCBS REQUEST INVOCATION. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: VLRA sends a RegisterCCEntry message to HLRA, which is mapped to TC-BEGIN. HLRA then sends a CcbsRequest message to DESTINATION NETWORK B, which is mapped to TC-BEGIN SCCP.
|
| 448 |
+
|
| 449 |
+
Signalling flow for CCBS REQUEST INVOCATION
|
| 450 |
+
|
| 451 |
+
Figure 6.1: Signalling flow for CCBS REQUEST INVOCATION
|
| 452 |
+
|
| 453 |
+
The CCBS Request invocation is carried by TC-BEGIN. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.1.
|
| 454 |
+
|
| 455 |
+
## 6.2 Dialogue Continuation
|
| 456 |
+
|
| 457 |
+
### 6.2.1 CCBS Request Result
|
| 458 |
+
|
| 459 |
+

|
| 460 |
+
|
| 461 |
+
```
|
| 462 |
+
sequenceDiagram
|
| 463 |
+
participant VLRA
|
| 464 |
+
participant HLRA
|
| 465 |
+
participant DN as DESTINATION NETWORK B
|
| 466 |
+
Note left of VLRA: +--+\n DN->>HLRA: CcbsRequest-Result\n Note right of HLRA: TC-CONTINUE SCCP\n HLRA->>VLRA: RegisterCCEntry-Result\n Note right of VLRA: TC-END
|
| 467 |
+
```
|
| 468 |
+
|
| 469 |
+
The diagram illustrates the signalling flow for CCBS Request Result. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: DESTINATION NETWORK B sends a CcbsRequest-Result message to HLRA, which is mapped to TC-CONTINUE SCCP. HLRA then sends a RegisterCCEntry-Result message to VLRA, which is mapped to TC-END.
|
| 470 |
+
|
| 471 |
+
Signalling flow for CCBS Request Result
|
| 472 |
+
|
| 473 |
+
Figure 6.2: Signalling flow for CCBS Request Result
|
| 474 |
+
|
| 475 |
+
The CCBS Request Result is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3.
|
| 476 |
+
|
| 477 |
+
### 6.2.2 CCBS Remote User Free Invocation
|
| 478 |
+
|
| 479 |
+

|
| 480 |
+
|
| 481 |
+
```
|
| 482 |
+
|
| 483 |
+
sequenceDiagram
|
| 484 |
+
participant VLRA
|
| 485 |
+
participant HLRA
|
| 486 |
+
participant DNB as DESTINATION NETWORK B
|
| 487 |
+
Note right of HLRA: RemoteUserFree
|
| 488 |
+
HLRA->>DNB: TC-CONTINUE SCCP
|
| 489 |
+
Note left of HLRA: RemoteUserFree
|
| 490 |
+
HLRA->>VLRA: TC-BEGIN
|
| 491 |
+
|
| 492 |
+
```
|
| 493 |
+
|
| 494 |
+
The diagram illustrates the signaling flow for CCBS Remote User Free Invocation. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a message 'RemoteUserFree' being processed at the HLRA. A 'TC-CONTINUE SCCP' message is sent from the HLRA to the DESTINATION NETWORK B. Simultaneously, another 'RemoteUserFree' message is processed at the HLRA, and a 'TC-BEGIN' message is sent from the HLRA to the VLRA.
|
| 495 |
+
|
| 496 |
+
Sequence diagram for CCBS Remote User Free Invocation showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.
|
| 497 |
+
|
| 498 |
+
**Figure 6.3: Signalling flow for Remote User Free Invocation**
|
| 499 |
+
|
| 500 |
+
The CCBS Remote User Free Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3.
|
| 501 |
+
|
| 502 |
+
### 6.2.3 CCBS Suspend Invocation
|
| 503 |
+
|
| 504 |
+

|
| 505 |
+
|
| 506 |
+
```
|
| 507 |
+
|
| 508 |
+
sequenceDiagram
|
| 509 |
+
participant VLRA
|
| 510 |
+
participant HLRA
|
| 511 |
+
participant DNB as DESTINATION NETWORK B
|
| 512 |
+
Note left of HLRA: RemoteUserFree-Result
|
| 513 |
+
VLRA->>HLRA: TC-END
|
| 514 |
+
Note right of HLRA: CcbsSuspend (note 1)
|
| 515 |
+
HLRA->>DNB: TC-CONTINUE SCCP
|
| 516 |
+
|
| 517 |
+
```
|
| 518 |
+
|
| 519 |
+
The diagram illustrates the signaling flow for CCBS Suspend Invocation (RemoteUserFree\_Result). It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a message 'RemoteUserFree-Result' being processed at the VLRA. A 'TC-END' message is sent from the VLRA to the HLRA. Simultaneously, a 'CcbsSuspend (note 1)' message is processed at the HLRA, and a 'TC-CONTINUE SCCP' message is sent from the HLRA to the DESTINATION NETWORK B.
|
| 520 |
+
|
| 521 |
+
Sequence diagram for CCBS Suspend Invocation (RemoteUserFree\_Result) showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.
|
| 522 |
+
|
| 523 |
+
NOTE 1 For conditions leading to a request being suspended, see GSM 03.93
|
| 524 |
+
|
| 525 |
+
**Figure 6.4: Signalling flow for CCBS Suspend Invocation (RemoteUserFree\_Result)**
|
| 526 |
+
|
| 527 |
+

|
| 528 |
+
|
| 529 |
+
```
|
| 530 |
+
|
| 531 |
+
sequenceDiagram
|
| 532 |
+
participant VLRA
|
| 533 |
+
participant HLRA
|
| 534 |
+
participant DNB as DESTINATION NETWORK B
|
| 535 |
+
Note left of HLRA: RemoteUserFree-Error
|
| 536 |
+
VLRA->>HLRA: TC-END
|
| 537 |
+
Note right of HLRA: CcbsSuspend (note 1)
|
| 538 |
+
HLRA->>DNB: TC-CONTINUE SCCP
|
| 539 |
+
|
| 540 |
+
```
|
| 541 |
+
|
| 542 |
+
The diagram illustrates the signaling flow for CCBS Suspend Invocation (RemoteUserFree\_Error). It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a message 'RemoteUserFree-Error' being processed at the VLRA. A 'TC-END' message is sent from the VLRA to the HLRA. Simultaneously, a 'CcbsSuspend (note 1)' message is processed at the HLRA, and a 'TC-CONTINUE SCCP' message is sent from the HLRA to the DESTINATION NETWORK B.
|
| 543 |
+
|
| 544 |
+
Sequence diagram for CCBS Suspend Invocation (RemoteUserFree\_Error) showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.
|
| 545 |
+
|
| 546 |
+
NOTE 1 For conditions leading to a request being suspended, see GSM 03.93
|
| 547 |
+
|
| 548 |
+
**Figure 6.5: Signalling flow for CCBS Suspend Invocation (RemoteUserFree\_Error)**
|
| 549 |
+
|
| 550 |
+
The CCBS Suspend Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2
|
| 551 |
+
|
| 552 |
+
### 6.2.4 CCBS Resume Invocation
|
| 553 |
+
|
| 554 |
+

|
| 555 |
+
|
| 556 |
+
```
|
| 557 |
+
|
| 558 |
+
sequenceDiagram
|
| 559 |
+
participant VLRA
|
| 560 |
+
participant HLRA
|
| 561 |
+
participant DN as DESTINATION NETWORK B
|
| 562 |
+
Note left of VLRA: StatusReport
|
| 563 |
+
VLRA->>HLRA: TC-BEGIN
|
| 564 |
+
HLRA->>DN: CcbsResume (note 1)
|
| 565 |
+
TC-CONTINUE
|
| 566 |
+
SCCP
|
| 567 |
+
|
| 568 |
+
```
|
| 569 |
+
|
| 570 |
+
The diagram illustrates the signalling flow for CCBS Resume Invocation. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a 'StatusReport' message from VLRA to HLRA. VLRA then sends a 'TC-BEGIN' message to HLRA. HLRA sends a 'CcbsResume (note 1)' message to DESTINATION NETWORK B, which includes 'TC-CONTINUE' and 'SCCP' components.
|
| 571 |
+
|
| 572 |
+
Signalling flow for CCBS Resume Invocation diagram
|
| 573 |
+
|
| 574 |
+
NOTE 1 For conditions leading to a request being resumed, see GSM 03.93
|
| 575 |
+
|
| 576 |
+
**Figure 6.6: Signalling flow for CCBS Resume Invocation**
|
| 577 |
+
|
| 578 |
+
The CCBS Resume Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2.
|
| 579 |
+
|
| 580 |
+
## 6.3 Dialogue End
|
| 581 |
+
|
| 582 |
+
### 6.3.1 Normal dialogue end
|
| 583 |
+
|
| 584 |
+

|
| 585 |
+
|
| 586 |
+
```
|
| 587 |
+
|
| 588 |
+
sequenceDiagram
|
| 589 |
+
participant VLRA
|
| 590 |
+
participant HLRA
|
| 591 |
+
participant DN as DESTINATION NETWORK B
|
| 592 |
+
Note right of DN: No component primitive
|
| 593 |
+
DN->>HLRA: TC-END
|
| 594 |
+
SCCP
|
| 595 |
+
HLRA->>VLRA: SetReportingState (note 1)
|
| 596 |
+
TC-BEGIN
|
| 597 |
+
|
| 598 |
+
```
|
| 599 |
+
|
| 600 |
+
The diagram illustrates the signalling flow for normal dialogue end. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a 'No component primitive' message from DESTINATION NETWORK B to HLRA. DESTINATION NETWORK B then sends a 'TC-END' message to HLRA, which includes 'SCCP' components. HLRA sends a 'SetReportingState (note 1)' message to VLRA, which includes 'TC-BEGIN' components.
|
| 601 |
+
|
| 602 |
+
Signalling flow for normal dialogue end diagram
|
| 603 |
+
|
| 604 |
+
NOTE 1 If the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated, the HLR A sends SetReportingState to deactivate the monitoring function (see GSM 03.93).
|
| 605 |
+
|
| 606 |
+
**Figure 6.7: Signalling flow for normal dialogue end**
|
| 607 |
+
|
| 608 |
+
The normal ending of CCBS dialogue from the B-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3.
|
| 609 |
+
|
| 610 |
+
### 6.3.2 CCBS Cancel Invocation (from A-side)
|
| 611 |
+
|
| 612 |
+

|
| 613 |
+
|
| 614 |
+
```
|
| 615 |
+
|
| 616 |
+
sequenceDiagram
|
| 617 |
+
participant VLRA
|
| 618 |
+
participant HLRA
|
| 619 |
+
participant DN as DESTINATION NETWORK B
|
| 620 |
+
Note left of VLRA: (note 1)
|
| 621 |
+
VLRA->>HLRA: EraseCCEntry
|
| 622 |
+
Note right of HLRA: TC-BEGIN
|
| 623 |
+
HLRA->>DN: CcbsCancel
|
| 624 |
+
Note right of DN: TC-END (note 1)
|
| 625 |
+
SCCP
|
| 626 |
+
|
| 627 |
+
```
|
| 628 |
+
|
| 629 |
+
The diagram illustrates the signalling flow for CCBS Cancel Invocation from the A-side. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with VLRA sending an 'EraseCCEntry' message to HLRA, with a note indicating this is note 1. HLRA responds with 'TC-BEGIN'. HLRA then sends a 'CcbsCancel' message to DESTINATION NETWORK B, with a note indicating this is TC-END (note 1) and SCCP.
|
| 630 |
+
|
| 631 |
+
Signalling flow for CCBS Cancel Invocation (from A-side)
|
| 632 |
+
|
| 633 |
+
NOTE 1 Where all outstanding CCBS Requests have been deactivated, CCBS Cancel is sent to each corresponding Destination Network B with the appropriate Destination Network B E.164 Called Party Address (see GSM 03.93, GSM 04.93).
|
| 634 |
+
|
| 635 |
+
**Figure 6.8: Signalling flow for CCBS Cancel Invocation (from A-side)**
|
| 636 |
+
|
| 637 |
+
The CCBS Cancel Invocation from the A-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2.
|
| 638 |
+
|
| 639 |
+
### 6.3.3 CCBS Cancel Invocation (from B-side)
|
| 640 |
+
|
| 641 |
+

|
| 642 |
+
|
| 643 |
+
```
|
| 644 |
+
|
| 645 |
+
sequenceDiagram
|
| 646 |
+
participant VLRA
|
| 647 |
+
participant HLRA
|
| 648 |
+
participant DN as DESTINATION NETWORK B
|
| 649 |
+
Note left of DN: (note 1)
|
| 650 |
+
DN->>HLRA: CcbsCancel
|
| 651 |
+
Note right of HLRA: TC-END
|
| 652 |
+
SCCP
|
| 653 |
+
HLRA->>VLRA: SetReportingState
|
| 654 |
+
Note left of VLRA: TC-BEGIN
|
| 655 |
+
|
| 656 |
+
```
|
| 657 |
+
|
| 658 |
+
The diagram illustrates the signalling flow for CCBS Cancel Invocation from the B-side. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with DESTINATION NETWORK B sending a 'CcbsCancel' message to HLRA, with a note indicating this is note 1. HLRA responds with 'TC-END' and 'SCCP'. HLRA then sends a 'SetReportingState' message to VLRA, with a note indicating this is TC-BEGIN.
|
| 659 |
+
|
| 660 |
+
Signalling flow for CCBS Cancel Invocation (from B-side)
|
| 661 |
+
|
| 662 |
+
NOTE 1: If the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated, the HLR A sends SetReportingState to deactivate the monitoring function (see GSM 03.93).
|
| 663 |
+
|
| 664 |
+
**Figure 6.9: Signalling flow for CCBS Cancel Invocation (from B-side)**
|
| 665 |
+
|
| 666 |
+
The CCBS Cancel Invocation from the B-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3.
|
| 667 |
+
|
| 668 |
+
### 6.3.4 CCBS Request Error
|
| 669 |
+
|
| 670 |
+

|
| 671 |
+
|
| 672 |
+
```
|
| 673 |
+
sequenceDiagram
|
| 674 |
+
participant VLRA
|
| 675 |
+
participant HLRA
|
| 676 |
+
participant DN as DESTINATION NETWORK B
|
| 677 |
+
Note right of DN: CcbsRequest-Error
|
| 678 |
+
DN-->HLRA: TC-END SCCP
|
| 679 |
+
Note right of HLRA: RegisterCCEntry-Error
|
| 680 |
+
HLRA-->VLRA: TC-END
|
| 681 |
+
```
|
| 682 |
+
|
| 683 |
+
The diagram illustrates the signalling flow for a CCBS Request Error. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: 1. A message labeled 'CcbsRequest-Error' is sent from DESTINATION NETWORK B to HLRA. 2. Below this, a message labeled 'TC-END SCCP' is sent from DESTINATION NETWORK B to HLRA. 3. Next, a message labeled 'RegisterCCEntry-Error' is sent from HLRA to VLRA. 4. Finally, a message labeled 'TC-END' is sent from HLRA to VLRA.
|
| 684 |
+
|
| 685 |
+
Sequence diagram showing the signalling flow for CCBS Request Error between VLRA, HLRA, and DESTINATION NETWORK B.
|
| 686 |
+
|
| 687 |
+
**Figure 6.10: Signalling flow for CCBS Request Error**
|
| 688 |
+
|
| 689 |
+
The CCBS Request Error is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3.
|
| 690 |
+
|
| 691 |
+
# 7 Addressing of SCCP layer messages on the SSAP interface
|
| 692 |
+
|
| 693 |
+
The SCCP layer addressing for messages on the SSAP interface is described.
|
| 694 |
+
|
| 695 |
+
## 7.1 Use of SCCP
|
| 696 |
+
|
| 697 |
+
Clarifications and restrictions on the use and coding of the main SCCP parameters impacted by CCBS on the SSAP interface are indicated. See ETS 300 356-18 and the associated references for the full specification on the use of SCCP on the SSAP interface. The SCCP routeing on the SSAP interface shall be based on the Global Title (GT) translation mechanism as for routeing on the international interface. GT addressing shall be used for inter and intra PLMN signalling. This allows any impact of other network features e.g. Mobile Number Portability to be minimised.
|
| 698 |
+
|
| 699 |
+
## 7.2 Addressing of messages at the originating PLMN
|
| 700 |
+
|
| 701 |
+
### 7.2.1 TC-BEGIN message from the originating network HLR
|
| 702 |
+
|
| 703 |
+
The relevant SCCP parameters in the first message from the HLR A transporting TC-BEGIN are shown in table 7.1. All other SCCP parameters shall be as indicated in ETS 300 356-18.
|
| 704 |
+
|
| 705 |
+
**Table 7.1: SCCP parameters used by HLR A for TC-BEGIN**
|
| 706 |
+
|
| 707 |
+
| <b>SCCP PARAMETERS for the message transporting TC-BEGIN</b> | <b>PARAMETER VALUE</b> |
|
| 708 |
+
|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 709 |
+
| CdPA-Called Party Address | E.164 number of the Called Party. This may be in either international or national E.164 format, see subclause 7.4.1. It is derived from the translatedB-Number parameter which is available from the CCBS application in HLRA, see RegisterCCEntry in GSM 09.02. |
|
| 710 |
+
| CgPA-Calling Party Address | E.164 number of HLR A. This may be in either international or national E.164 format, see subclause 7.4.1. |
|
| 711 |
+
| SSN- Subsystem Number | 0000 1011<br>(See ETS 300 356-18) |
|
| 712 |
+
| TT- Translation Type | 0001 0001<br>(See ETS 300 356-18) |
|
| 713 |
+
| Other SCCP Parameters | See ETS 300 356-18 |
|
| 714 |
+
|
| 715 |
+
### 7.2.2 TC-CONTINUE, TC-END messages from the originating network HLR
|
| 716 |
+
|
| 717 |
+
The relevant SCCP parameters in the subsequent messages from the HLR A transporting TC-CONTINUE and TC-END are shown in table 7.2. All other SCCP parameters shall be as indicated in ETS 300 356-18.
|
| 718 |
+
|
| 719 |
+
**Table 7.2: SCCP parameters used by HLR A for TC-CONTINUE, TC-END**
|
| 720 |
+
|
| 721 |
+
| <b>SCCP PARAMETERS for the message transporting TC-CONTINUE, TC-END</b> | <b>PARAMETER VALUE</b> |
|
| 722 |
+
|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 723 |
+
| CdPA-Called Party Address | The Called Party Address is the E.164 address of the calling entity in the destination network that was received in the first response message from the destination network (note 1). |
|
| 724 |
+
| CgPA-Calling Party Address | E.164 number of HLR A. This may be in either international or national E.164 format as used in the message transporting TC-BEGIN, see subclause 7.4.1. |
|
| 725 |
+
| SSN- Subsystem Number | 0000 1011<br>(See ETS 300 356-18) |
|
| 726 |
+
| TT- Translation Type | 0001 0001<br>(See ETS 300 356-18) |
|
| 727 |
+
| Other SCCP Parameters | See ETS 300 356-18 |
|
| 728 |
+
| NOTE 1 | If the destination network is a GSM PLMN, this is E.164 number of HLR B. |
|
| 729 |
+
|
| 730 |
+
## 7.3 Addressing of messages at the destination PLMN
|
| 731 |
+
|
| 732 |
+
### 7.3.1 TC-CONTINUE, TC-END messages from the destination network HLR
|
| 733 |
+
|
| 734 |
+
The relevant SCCP parameters in the first and subsequent messages from the HLR B transporting TC-CONTINUE and TC-END are shown in table 7.3. All other SCCP parameters shall be as indicated in ETS 300 356-18.
|
| 735 |
+
|
| 736 |
+
**Table 7.3: SCCP parameters for TC-CONTINUE, TC-END used by HLR B**
|
| 737 |
+
|
| 738 |
+
| SCCP PARAMETERS for the message transporting TC-CONTINUE, TC-END | PARAMETER VALUE |
|
| 739 |
+
|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 740 |
+
| CdPA-Called Party Address | The Called Party Address is the E.164 address of the calling entity in the originating network that was received in the first message transporting TC-BEGIN from the originating network (note 1). |
|
| 741 |
+
| CgPA-Calling Party Address | E.164 number of HLR B. This may be in either international or national E.164 format, see subclause 7.4.2 (note 2) |
|
| 742 |
+
| SSN- Subsystem Number | 0000 1011<br>(See ETS 300 356-18) |
|
| 743 |
+
| TT- Translation Type | 0001 0001<br>(See ETS 300 356-18) |
|
| 744 |
+
| Other SCCP Parameters | See ETS 300 356-18 |
|
| 745 |
+
| NOTE 1 | If the originating network is a GSM PLMN, this is E.164 number of HLR A. |
|
| 746 |
+
| NOTE 2 | The E.164 number of HLRB is used as this allows any impact of other network features to be minimised. |
|
| 747 |
+
|
| 748 |
+
## 7.4 Number formats of the SCCP address parameters
|
| 749 |
+
|
| 750 |
+
The Called and Calling Party Address information in SCCP should be in international E.164 format. Optionally national format E.164 addresses may be used in SCCP for routing of national traffic. For this, the HLR has to modify the addresses which are in international E.164 format to a national E.164 format. If a national format E.164 option is used, all involved network nodes in a given country (i.e. the originating network, any transit networks and the destination network) need support that option. As negotiation is not possible, the option selected by the originating network shall determine the addressing used for all messages which are a part of a single dialogue.
|
| 751 |
+
|
| 752 |
+
### 7.4.1 Originating PLMN
|
| 753 |
+
|
| 754 |
+
The Called and Calling Party Address information in SCCP should be in international E.164 format.
|
| 755 |
+
|
| 756 |
+
The originating network HLR A may use the SCCP Called Party Address in national E.164 format if the called destination (as indicated by the translatedB-number) is in the same country as HLR A.
|
| 757 |
+
|
| 758 |
+
The originating network HLR A may use the SCCP Calling Party Address in national E.164 format if the called destination (as indicated by the translatedB-number) is in the same country as HLR A.
|
| 759 |
+
|
| 760 |
+
The originating network HLR A shall ensure that the SCCP Called and Calling Party Addresses are either both in international format or national format.
|
| 761 |
+
|
| 762 |
+
### 7.4.2 Destination PLMN
|
| 763 |
+
|
| 764 |
+
The Called and Calling Party Address information in SCCP should be in international E.164 format.
|
| 765 |
+
|
| 766 |
+
The destination network HLR B may use the SCCP Called Party Address in national E.164 format if the originating network is in the same country as HLR B.
|
| 767 |
+
|
| 768 |
+
The destination network HLR B may use the SCCP Calling Party Address in national E.164 format if the originating network is in the same country as HLR B.
|
| 769 |
+
|
| 770 |
+
The destination network HLR B shall ensure that the SCCP Called and Calling Party Addresses are either both in international format or national format.
|
marked/Rel-18/29_series/29116/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29118/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29119/raw.md
ADDED
|
@@ -0,0 +1,296 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.119 V18.0.0 (2024-03)
|
| 4 |
+
|
| 5 |
+
Technical Specification
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; GPRS Tunnelling Protocol (GTP) specification for Gateway Location Register (GLR) (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
The logo for LTE Advanced Pro, featuring the letters 'lte' in a bold, lowercase font. Above the 't' is a green signal icon with three bars. To the right of the 't' are the words 'Advanced' and 'Pro' in a smaller font, with 'Pro' in red.
|
| 12 |
+
|
| 13 |
+
LTE Advanced Pro logo
|
| 14 |
+
|
| 15 |
+

|
| 16 |
+
|
| 17 |
+
The 3GPP logo, consisting of the letters '3GPP' in a stylized, bold font. Below the 'P' is a red signal icon with three bars. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
|
| 18 |
+
|
| 19 |
+
3GPP logo
|
| 20 |
+
|
| 21 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 22 |
+
|
| 23 |
+
## **3GPP**
|
| 24 |
+
|
| 25 |
+
Postal address
|
| 26 |
+
|
| 27 |
+
---
|
| 28 |
+
|
| 29 |
+
3GPP support office address
|
| 30 |
+
|
| 31 |
+
---
|
| 32 |
+
|
| 33 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 34 |
+
|
| 35 |
+
Valbonne - FRANCE
|
| 36 |
+
|
| 37 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 38 |
+
|
| 39 |
+
Internet
|
| 40 |
+
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
<http://www.3gpp.org>
|
| 44 |
+
|
| 45 |
+
## --- ***Copyright Notification*** ---
|
| 46 |
+
|
| 47 |
+
No part may be reproduced except as authorized by written permission.
|
| 48 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 49 |
+
|
| 50 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 51 |
+
All rights reserved.
|
| 52 |
+
|
| 53 |
+
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
|
| 54 |
+
|
| 55 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 56 |
+
|
| 57 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 58 |
+
|
| 59 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 60 |
+
|
| 61 |
+
# --- Contents
|
| 62 |
+
|
| 63 |
+
| | |
|
| 64 |
+
|-------------------------------------------------------------|-----------|
|
| 65 |
+
| Foreword ..... | 4 |
|
| 66 |
+
| 1 Scope..... | 5 |
|
| 67 |
+
| 1.1 References..... | 5 |
|
| 68 |
+
| 2 Definitions and abbreviations ..... | 5 |
|
| 69 |
+
| 2.1 Definitions..... | 5 |
|
| 70 |
+
| 2.2 Abbreviations ..... | 6 |
|
| 71 |
+
| 3 General..... | 6 |
|
| 72 |
+
| 4 Transmission order and bit definitions..... | 7 |
|
| 73 |
+
| 5 GTP header ..... | 7 |
|
| 74 |
+
| 6 GTP Message and Message Formats ..... | 7 |
|
| 75 |
+
| 6.1 Signalling Message Formats ..... | 7 |
|
| 76 |
+
| 6.2 Path Management messages..... | 8 |
|
| 77 |
+
| 6.3 Tunnel Management messages..... | 8 |
|
| 78 |
+
| 6.4 Location Management message ..... | 9 |
|
| 79 |
+
| 6.5 Mobility Management messages..... | 9 |
|
| 80 |
+
| 6.6 Reliable delivery of signalling messages ..... | 9 |
|
| 81 |
+
| 6.7 Information element ..... | 10 |
|
| 82 |
+
| 7 Signalling Plane (GTP-C) ..... | 10 |
|
| 83 |
+
| 8 GTP-U ..... | 10 |
|
| 84 |
+
| 9 Path Protocol..... | 10 |
|
| 85 |
+
| 10 Error handling ..... | 10 |
|
| 86 |
+
| 11 Inter-PLMN GTP communication over the Gp Interface ..... | 10 |
|
| 87 |
+
| 12 IP, the networking technology used by GTP ..... | 10 |
|
| 88 |
+
| 13 GTP parameters..... | 10 |
|
| 89 |
+
| <b>Annex A (informative): Change history.....</b> | <b>11</b> |
|
| 90 |
+
|
| 91 |
+
# --- Foreword
|
| 92 |
+
|
| 93 |
+
The present document has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
|
| 94 |
+
|
| 95 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 96 |
+
|
| 97 |
+
Version x.y.z
|
| 98 |
+
|
| 99 |
+
where:
|
| 100 |
+
|
| 101 |
+
- x the first digit:
|
| 102 |
+
- 1 presented to TSG for information;
|
| 103 |
+
- 2 presented to TSG for approval;
|
| 104 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 105 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 106 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 107 |
+
|
| 108 |
+
# 1 Scope
|
| 109 |
+
|
| 110 |
+
The present document describes the signalling requirements and procedures used at network elements related to the GLR for GTP within the 3GPP system at the application level.
|
| 111 |
+
|
| 112 |
+
The present document gives the description of the systems needed only in the network utilising GLR as the delta document against 3GPP TS 29.060.
|
| 113 |
+
|
| 114 |
+
## 1.1 References
|
| 115 |
+
|
| 116 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 117 |
+
|
| 118 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 119 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 120 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 121 |
+
- [1] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description Stage2".
|
| 122 |
+
- [2] 3GPP TS 23.119: "Gateway Location Register (GLR) – stage2".
|
| 123 |
+
- [3] 3GPP TS 24.008: "Mobile radio interface layer 3 specification, Core Network Protocols – Stage 3".
|
| 124 |
+
- [4] 3GPP TS 29.002: "Mobile Application Part (MAP) specification".
|
| 125 |
+
- [5] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface".
|
| 126 |
+
|
| 127 |
+
# 2 Definitions and abbreviations
|
| 128 |
+
|
| 129 |
+
## 2.1 Definitions
|
| 130 |
+
|
| 131 |
+
For the purposes of the present document, the following terms and definitions apply.
|
| 132 |
+
|
| 133 |
+
**Gateway Location Register:** this entity handles location management of roaming subscriber in visited network without involving HLR
|
| 134 |
+
|
| 135 |
+
**Intermediate GSN:** this entity is used as serving GSN towards home network and relay some PDU notification messages between serving GSN and Gateway GSN
|
| 136 |
+
|
| 137 |
+
**MM context:** information sets held in MS and GSNs for a GPRS subscriber related to mobility management (MM)
|
| 138 |
+
|
| 139 |
+
**MM Context ID:** IMSI or equivalent for use in conjunction with Anonymous Access (please refer to section GTP Header)
|
| 140 |
+
|
| 141 |
+
**Path:** UDP/IP path and TCP/IP path are examples of paths that may be used to multiplex GTP tunnels
|
| 142 |
+
|
| 143 |
+
**Path Protocol:** path Protocol is the protocol(s) used as a bearer of GTP between GSNs
|
| 144 |
+
|
| 145 |
+
**PDP:** packet Data Protocol (PDP) is a network protocol used by an external packet data network interfacing to GPRS
|
| 146 |
+
|
| 147 |
+
- PDP Context:** information sets held in MS and GSNs for a PDP address
|
| 148 |
+
- Signalling message:** GTP signalling messages are exchanged between GSN pairs in a path. The signalling messages are used to transfer GSN capability information between GSN pairs and to create, update and delete GTP tunnels
|
| 149 |
+
- T-PDU:** original packet, for example an IP datagram, from an MS or a network node in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP tunnel
|
| 150 |
+
- Tunnel Endpoint Identifier (TEID):** this field unambiguously identifies a tunnel endpoint in the receiving GTP-U or GTP-C protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID values are exchanged between tunnel endpoints using GTP-C messages
|
| 151 |
+
|
| 152 |
+
## 2.2 Abbreviations
|
| 153 |
+
|
| 154 |
+
For the purposes of the present document, the following abbreviations apply:
|
| 155 |
+
|
| 156 |
+
| | |
|
| 157 |
+
|--------|------------------------------|
|
| 158 |
+
| GGSN | Gateway GPRS support node |
|
| 159 |
+
| GLR | Gateway Location Register |
|
| 160 |
+
| GPRS | General Packet Radio Service |
|
| 161 |
+
| GTP | GPRS Tunnelling Protocol |
|
| 162 |
+
| IM_GSN | Intermediate GSN |
|
| 163 |
+
| IP | Internet Protocol |
|
| 164 |
+
| GLR | Gateway Location Register |
|
| 165 |
+
| SGSN | Serving GPRS support node |
|
| 166 |
+
| TEID | Tunnel Endpoint Identifier |
|
| 167 |
+
| UDP | User Datagram Protocol |
|
| 168 |
+
|
| 169 |
+
# --- 3 General
|
| 170 |
+
|
| 171 |
+
The present document defines the GPRS Tunnelling Protocol (GTP) specific to the network with the GLR, i.e. the protocol between IM\_GSN and other nodes (i.e. GGSN, SGSN and GTP-MAP protocol converting GSN). It includes only the GTP signalling but not data transfer procedures.
|
| 172 |
+
|
| 173 |
+
The interface between IM\_GSM and GGSN is either intra-PLMN interface or inter-PLMN interface.
|
| 174 |
+
|
| 175 |
+

|
| 176 |
+
|
| 177 |
+
Figure 1: Logical Architecture for PS domain in the network with GLR. The diagram shows a hierarchy of network elements. At the top are GLR and HLR connected by a dotted line (Signalling Interface). Below GLR is a GTP-MAP Protocol Converting GSN, which is connected to GLR by a dotted line and to an IM\_GSN by a dotted line. Below HLR is another GTP-MAP Protocol Converting GSN, which is connected to HLR by a dotted line and to a GGSN by a dotted line. The IM\_GSN is connected to the GTP-MAP Protocol Converting GSN under GLR by a dotted line, to an SGSN by a solid line (Signalling and Data Transfer Interface), and to the GGSN by a dotted line. The SGSN is connected to the GGSN by a solid line. A legend at the bottom indicates that dotted lines represent Signalling Interfaces and solid lines represent Signalling and Data Transfer Interfaces.
|
| 178 |
+
|
| 179 |
+
**Figure 1: Logical Architecture for PS domain in the network with GLR**
|
| 180 |
+
|
| 181 |
+
The GTP protocol is implemented only by IM\_GSNs, SGSNs and GGSNs. No other systems need to be aware of GTP. GPRS MSs are connected to a SGSN without being aware of GTP.
|
| 182 |
+
|
| 183 |
+
It is assumed that there will be a many-to-many relationship between IM\_GSNs, SGSNs and GGSNs. An IM\_GSN may provide service to many GGSNs. A SGSN may provide service to many IM\_GSNs and GGSNs.
|
| 184 |
+
|
| 185 |
+
# 4 Transmission order and bit definitions
|
| 186 |
+
|
| 187 |
+
Transmission order and bit definitions on the interface between the IM\_GSN and other nodes in the network with GLR are the same as that used in the network without the GLR, see 3GPP TS 29.060.
|
| 188 |
+
|
| 189 |
+
# 5 GTP header
|
| 190 |
+
|
| 191 |
+
The GTP header used on interface between the IM\_GSN and other nodes in the network with GLR is the same as that used in the network without the GLR, see 3GPP TS 29.060.
|
| 192 |
+
|
| 193 |
+
# 6 GTP Message and Message Formats
|
| 194 |
+
|
| 195 |
+
The only signalling plane exists between the IM\_GSN and other nodes (i.e. GGSN, SGSN and GTP-MAP protocol converting GSN).
|
| 196 |
+
|
| 197 |
+
## 6.1 Signalling Message Formats
|
| 198 |
+
|
| 199 |
+
GTP defines a set of signalling messages between two associated GSNs. The signalling messages to be used between the IM\_GSN and other nodes are defined in the table below. For the GTP signalling messages to be used on other interfaces see 3GPP TS 29.060.
|
| 200 |
+
|
| 201 |
+
Table 1: Signalling messages
|
| 202 |
+
|
| 203 |
+
| Message Type value (Decimal) | Signalling message | Reference |
|
| 204 |
+
|------------------------------|---------------------------------------------|--------------------------|
|
| 205 |
+
| 3 | Version Not Supported | 7.4.3 in 3GPP TS 29.060 |
|
| 206 |
+
| 27 | PDU Notification Request | 7.5.12 in 3GPP TS 29.060 |
|
| 207 |
+
| 28 | PDU Notification Response | 7.5.13 in 3GPP TS 29.060 |
|
| 208 |
+
| 29 | PDU Notification Reject Request | 7.5.14 in 3GPP TS 29.060 |
|
| 209 |
+
| 30 | PDU Notification Reject Response | 7.5.15 in 3GPP TS 29.060 |
|
| 210 |
+
| 32 | Send Routeing Information for GPRS Request | 7.6.1 in 3GPP TS 29.060 |
|
| 211 |
+
| 33 | Send Routeing Information for GPRS Response | 7.6.2 in 3GPP TS 29.060 |
|
| 212 |
+
| 34 | Failure Report Request | 7.6.3 in 3GPP TS 29.060 |
|
| 213 |
+
| 35 | Failure Report Response | 7.6.4 in 3GPP TS 29.060 |
|
| 214 |
+
|
| 215 |
+
## 6.2 Path Management messages
|
| 216 |
+
|
| 217 |
+
The messages, which are listed in following table, are used on the interface between the IM\_GSN and other nodes. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060.
|
| 218 |
+
|
| 219 |
+
| Messages | Sending node | Receiving node |
|
| 220 |
+
|-----------------------|--------------|----------------|
|
| 221 |
+
| Version Not Supported | IM_GSN | GGSN, SGSN |
|
| 222 |
+
| | GGSN, SGSN | IM_GSN |
|
| 223 |
+
|
| 224 |
+
## 6.3 Tunnel Management messages
|
| 225 |
+
|
| 226 |
+
In following table, only the messages used between the IM\_GSN and GGSN and between the IM\_GSN and SGSN are listed. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060.
|
| 227 |
+
|
| 228 |
+
| Messages | Sending node | Receiving node |
|
| 229 |
+
|----------------------------------|--------------|----------------|
|
| 230 |
+
| PDU Notification Request | GGSN | IM_GSN |
|
| 231 |
+
| | IM_GSN | SGSN |
|
| 232 |
+
| PDU Notification Response | SGSN | IM_GSN |
|
| 233 |
+
| | IM_GSN | GGSN |
|
| 234 |
+
| PDU Notification Reject Request | SGSN | IM_GSN |
|
| 235 |
+
| | IM_GSN | GGSN |
|
| 236 |
+
| PDU Notification Reject Response | GGSN | IM_GSN |
|
| 237 |
+
| | IM_GSN | SGSN |
|
| 238 |
+
|
| 239 |
+
## 6.4 Location Management message
|
| 240 |
+
|
| 241 |
+
In the network with the GLR, The optional Location Management messages are defined to support the case when Network-Requested PDP Context Activation procedures are used and an IM\_GSN does not have a SS7 MAP interface. GTP is then used to transfer signalling messages between the IM\_GSN and a GTP-MAP protocol-converting GSN in the GPRS backbone network. The GTP-MAP protocol-converting GSN converts the signalling messages described in this section between GTP and MAP. The MAP messages are sent to and received from the GLR. The GTP-MAP protocol-converting function is described in 3GPP TS 23.060. The MAP protocol describing the corresponding procedures and messages is described in 3GPP TS 29.002. This alternative method is illustrated in Figure 2.
|
| 242 |
+
|
| 243 |
+

|
| 244 |
+
|
| 245 |
+
Diagram illustrating the GTP-MAP Interworking between IM\_GSN, GSN, and GLR. The diagram shows three protocol stacks. The IM\_GSN stack has layers GTP, UDP, IP, L2, and L1. The GSN stack has layers GTP, UDP, IP, L2, and L1, with a 'GTP-MAP Interworking' block above the GTP layer. This block contains two sub-stacks: one with GTP, MAP, TCAP, SCCP, MTP3, MTP2, and L1; the other with MAP, TCAP, SCCP, MTP3, MTP2, and L1. The GLR stack has layers MAP, TCAP, SCCP, MTP3, MTP2, and L1. Vertical dashed lines separate the three stacks, and horizontal lines connect corresponding layers across them.
|
| 246 |
+
|
| 247 |
+
Figure 2: IM\_GSN - GLR Signalling via a GTP-MAP protocol-converter in a GSN
|
| 248 |
+
|
| 249 |
+
In following table, only the messages used between the IM\_GSN and The GTP-MAP protocol-converting GSN are listed. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060.
|
| 250 |
+
|
| 251 |
+
| Messages | Sending node | Receiving node |
|
| 252 |
+
|---------------------------------------------|-----------------------------|-----------------------------|
|
| 253 |
+
| Send Routeing Information for GPRS Request | IM_GSN | GTP-MAP protocol-converting |
|
| 254 |
+
| Send Routeing Information for GPRS Response | GTP-MAP protocol-converting | IM_GSN |
|
| 255 |
+
| Failure Report Request | IM_GSN | GTP-MAP protocol-converting |
|
| 256 |
+
| Failure Report Response | GTP-MAP protocol-converting | IM_GSN |
|
| 257 |
+
|
| 258 |
+
## 6.5 Mobility Management messages
|
| 259 |
+
|
| 260 |
+
The messages belonging to the mobility management messages are not used on the interface between the IM\_GSN and other nodes in the network with the GLR.
|
| 261 |
+
|
| 262 |
+
## 6.6 Reliable delivery of signalling messages
|
| 263 |
+
|
| 264 |
+
For the Reliability mechanism in the IM\_GSN, see section 7.8 in 3GPP TS 29.060.
|
| 265 |
+
|
| 266 |
+
## 6.7 Information element
|
| 267 |
+
|
| 268 |
+
The format of information elements in the message used on the interface between the IM\_GSN and other nodes in the network with GLR is the same as that in the network without the GLR. See 3GPP TS 29.060.
|
| 269 |
+
|
| 270 |
+
# --- 7 Signalling Plane (GTP-C)
|
| 271 |
+
|
| 272 |
+
The definition of signalling plane used in the network with the GLR is the same as that used in the network without the GLR, see in 3GPP TS 29.060.
|
| 273 |
+
|
| 274 |
+
# --- 8 GTP-U
|
| 275 |
+
|
| 276 |
+
GTP-U is not used on the interface between the IM\_GSN and other nodes. For the definition of GTP-U on the other interfaces, see in 3GPP TS 29.060.
|
| 277 |
+
|
| 278 |
+
# --- 9 Path Protocol
|
| 279 |
+
|
| 280 |
+
The Path Protocol on the interface between the IM\_GSN and other nodes in the network with the GLR is the same as that used in the network without the GLR. See 3GPP TS 29.060.
|
| 281 |
+
|
| 282 |
+
# --- 10 Error handling
|
| 283 |
+
|
| 284 |
+
The error handling on the interface between the IM\_GSN and other nodes is the same as that in the network without the GLR. See 3GPP TS 29.060. One exception is that the IM\_GSN doesn't have a Restart Counter because the IM\_GSM stores no PDP and MM context and therefore the synchronisation of the status of these with other GSNs is not needed.
|
| 285 |
+
|
| 286 |
+
# --- 11 Inter-PLMN GTP communication over the Gp Interface
|
| 287 |
+
|
| 288 |
+
Refer to the corresponding section in 3GPP TS 29.060.
|
| 289 |
+
|
| 290 |
+
# --- 12 IP, the networking technology used by GTP
|
| 291 |
+
|
| 292 |
+
Refer to the corresponding section in 3GPP TS 29.060.
|
| 293 |
+
|
| 294 |
+
# --- 13 GTP parameters
|
| 295 |
+
|
| 296 |
+
The definitions and directions for use of the parameters in GTP (inc. timer values or counter values and so on) on the interface between the IM\_GSN and other nodes is the same as that used in the network without the GLR. See 3GPP TS 29.060.
|
marked/Rel-18/29_series/29128/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29173/raw.md
ADDED
|
@@ -0,0 +1,643 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.173 V18.0.0 (2024-03)
|
| 4 |
+
|
| 5 |
+
Technical Specification
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Location Services (LCS); Diameter-based SLh interface for Control Plane LCS (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
The LTE logo, featuring the letters 'lte' in a bold, lowercase font. Above the 'l' is a red signal strength icon consisting of four curved lines. A small 'TM' trademark symbol is located to the right of the 'e'.
|
| 12 |
+
|
| 13 |
+
LTE logo
|
| 14 |
+
|
| 15 |
+

|
| 16 |
+
|
| 17 |
+
The 3GPP logo, featuring the letters '3GPP' in a stylized, bold, black font. The '3' is larger and positioned to the left of the 'G', 'P', and 'P'. A small red signal strength icon is located below the 'P'. A small 'TM' trademark symbol is located to the top right of the 'P'.
|
| 18 |
+
|
| 19 |
+
3GPP logo
|
| 20 |
+
|
| 21 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 22 |
+
|
| 23 |
+
## **3GPP**
|
| 24 |
+
|
| 25 |
+
---
|
| 26 |
+
|
| 27 |
+
Postal address
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
3GPP support office address
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 36 |
+
Valbonne - FRANCE
|
| 37 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
Internet
|
| 42 |
+
|
| 43 |
+
---
|
| 44 |
+
|
| 45 |
+
<http://www.3gpp.org>
|
| 46 |
+
|
| 47 |
+
## --- **Copyright Notification** ---
|
| 48 |
+
|
| 49 |
+
No part may be reproduced except as authorized by written permission.
|
| 50 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 51 |
+
|
| 52 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 53 |
+
All rights reserved.
|
| 54 |
+
|
| 55 |
+
UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
|
| 56 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 57 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 58 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 59 |
+
|
| 60 |
+
# Contents
|
| 61 |
+
|
| 62 |
+
| | |
|
| 63 |
+
|---------------------------------------------------------------------|----|
|
| 64 |
+
| Foreword ..... | 5 |
|
| 65 |
+
| 1 Scope..... | 6 |
|
| 66 |
+
| 2 References..... | 6 |
|
| 67 |
+
| 3 Definitions, symbols and abbreviations ..... | 7 |
|
| 68 |
+
| 3.1 Definitions..... | 7 |
|
| 69 |
+
| 3.2 Abbreviations ..... | 7 |
|
| 70 |
+
| 4 General Description ..... | 7 |
|
| 71 |
+
| 4.1 Introduction ..... | 7 |
|
| 72 |
+
| 4.2 Architecture Overview ..... | 7 |
|
| 73 |
+
| 4.3 Functional Requirements of SLh Interface ..... | 8 |
|
| 74 |
+
| 5 Diameter-based SLh Interface ..... | 8 |
|
| 75 |
+
| 5.1 Introduction ..... | 8 |
|
| 76 |
+
| 5.2 Procedure Descriptions ..... | 8 |
|
| 77 |
+
| 5.2.1 Send Routing Information for LCS ..... | 8 |
|
| 78 |
+
| 5.2.1.1 General..... | 8 |
|
| 79 |
+
| 5.2.1.2 Detailed Behaviour of the HSS..... | 10 |
|
| 80 |
+
| 5.2.1.3 Detailed Behaviour of the GLMC ..... | 10 |
|
| 81 |
+
| 6 Protocol Specification and Implementations ..... | 11 |
|
| 82 |
+
| 6.1 Introduction ..... | 11 |
|
| 83 |
+
| 6.1.1 Use of Diameter Base Protocol ..... | 11 |
|
| 84 |
+
| 6.1.2 Securing Diameter Messages ..... | 11 |
|
| 85 |
+
| 6.1.3 Accounting Functionality ..... | 11 |
|
| 86 |
+
| 6.1.4 Use of Sessions..... | 11 |
|
| 87 |
+
| 6.1.5 Transport Protocol ..... | 11 |
|
| 88 |
+
| 6.1.6 Routing Considerations ..... | 11 |
|
| 89 |
+
| 6.1.7 Advertising Application Support..... | 11 |
|
| 90 |
+
| 6.1.8 Diameter Application Identifier..... | 12 |
|
| 91 |
+
| 6.1.9 User Identity to HSS resolution..... | 12 |
|
| 92 |
+
| 6.2 Commands..... | 12 |
|
| 93 |
+
| 6.2.1 Introduction ..... | 12 |
|
| 94 |
+
| 6.2.2 Command-Code values ..... | 12 |
|
| 95 |
+
| 6.2.3 LCS-Routing-Info-Request (RIR) Command ..... | 13 |
|
| 96 |
+
| 6.2.4 LCS-Routing-Info-Answer (RIA) Command..... | 13 |
|
| 97 |
+
| 6.3 Result-Code AVP and Experimental-Result AVP Values ..... | 14 |
|
| 98 |
+
| 6.3.1 General ..... | 14 |
|
| 99 |
+
| 6.3.2 Success ..... | 14 |
|
| 100 |
+
| 6.3.3 Permanent Failures ..... | 14 |
|
| 101 |
+
| 6.3.3.1 DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 14 |
|
| 102 |
+
| 6.3.3.2 DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK (5490) ..... | 15 |
|
| 103 |
+
| 6.3.4 Transient Failures ..... | 15 |
|
| 104 |
+
| 6.3.4.1 DIAMETER_ERROR_ABSENT_USER (4201) ..... | 15 |
|
| 105 |
+
| 6.4 AVPs ..... | 15 |
|
| 106 |
+
| 6.4.1 General ..... | 15 |
|
| 107 |
+
| 6.4.2 LMSI..... | 16 |
|
| 108 |
+
| 6.4.3 Serving-Node..... | 16 |
|
| 109 |
+
| 6.4.4 MME-Name..... | 16 |
|
| 110 |
+
| 6.4.5 MSC-Number ..... | 16 |
|
| 111 |
+
| 6.4.6 LCS-Capabilities-Sets ..... | 17 |
|
| 112 |
+
| 6.4.7 GMLC-Address ..... | 17 |
|
| 113 |
+
| 6.4.8 Additional-Serving-Node ..... | 17 |
|
| 114 |
+
| 6.4.9 PPR-Address..... | 17 |
|
| 115 |
+
| 6.4.10 Feature-List-ID AVP ..... | 17 |
|
| 116 |
+
| 6.4.11 Feature-List AVP..... | 17 |
|
| 117 |
+
|
| 118 |
+
6.4.12 MME-Realm..... 18
|
| 119 |
+
6.4.13 SGSN-Name ..... 18
|
| 120 |
+
6.4.14 SGSN-Realm ..... 18
|
| 121 |
+
**Annex A (informative): Change history..... 19**
|
| 122 |
+
|
| 123 |
+
# --- Foreword
|
| 124 |
+
|
| 125 |
+
This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
|
| 126 |
+
|
| 127 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 128 |
+
|
| 129 |
+
Version x.y.z
|
| 130 |
+
|
| 131 |
+
where:
|
| 132 |
+
|
| 133 |
+
- x the first digit:
|
| 134 |
+
- 1 presented to TSG for information;
|
| 135 |
+
- 2 presented to TSG for approval;
|
| 136 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 137 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 138 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 139 |
+
|
| 140 |
+
# 1 Scope
|
| 141 |
+
|
| 142 |
+
The present document describes the Diameter-based SLh interface between the GMLC and the HSS defined for the Control Plane LCS in EPC.
|
| 143 |
+
|
| 144 |
+
LCS procedures over the SLh interface are defined in the 3GPP TS 23.271 [2].
|
| 145 |
+
|
| 146 |
+
This specification defines the Diameter application for the GMLC-HSS, SLh reference point. The interactions between the HSS and the GMLC are specified, including the signalling flows. As LCS procedures over the Diameter-based SLh interface are identical to the MAP-based Lh interface, the descriptions of the Lh MAP operations defined in the 3GPP TS 29.002 [3] are mapped into the descriptions of the SLh Diameter commands.
|
| 147 |
+
|
| 148 |
+
# 2 References
|
| 149 |
+
|
| 150 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 151 |
+
|
| 152 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 153 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 154 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 155 |
+
|
| 156 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 157 |
+
- [2] 3GPP TS 23.271: "Functional stage 2 description of Location Services (LCS)".
|
| 158 |
+
- [3] 3GPP TS 29.002: "Mobile Application Part (MAP) specification".
|
| 159 |
+
- [4] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements".
|
| 160 |
+
- [5] Void.
|
| 161 |
+
- [6] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security".
|
| 162 |
+
- [7] IETF RFC 4960: "Stream Control Transport Protocol".
|
| 163 |
+
- [8] 3GPP TS 29.229: "Cx and Dx Interfaces based on the Diameter protocol; protocol details".
|
| 164 |
+
- [9] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; protocol details".
|
| 165 |
+
- [10] 3GPP TS 23.003: "Numbering, addressing and identification ".
|
| 166 |
+
- [11] 3GPP TS 23.012: "Location Management Procedures".
|
| 167 |
+
- [12] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol".
|
| 168 |
+
- [13] IETF RFC 2234: "Augmented BNF for syntax specifications".
|
| 169 |
+
- [14] Void
|
| 170 |
+
- [15] ITU-T Recommendation E.164: "The international public telecommunication numbering plan".
|
| 171 |
+
- [16] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces".
|
| 172 |
+
- [17] IETF RFC 6733: "Diameter Base Protocol".
|
| 173 |
+
|
| 174 |
+
# --- 3 Definitions, symbols and abbreviations
|
| 175 |
+
|
| 176 |
+
## 3.1 Definitions
|
| 177 |
+
|
| 178 |
+
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 23.271 [2] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
|
| 179 |
+
|
| 180 |
+
## 3.2 Abbreviations
|
| 181 |
+
|
| 182 |
+
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
|
| 183 |
+
|
| 184 |
+
| | |
|
| 185 |
+
|--------|-------------------------------------------|
|
| 186 |
+
| ABNF | Augmented Backus-Naur form |
|
| 187 |
+
| AVP | Attribute Value Pair |
|
| 188 |
+
| H-GMLC | Home-Gateway Mobile Location Centre |
|
| 189 |
+
| IANA | Internet Assigned Numbers Authority |
|
| 190 |
+
| PMD | Pseudonym mediation device functionality |
|
| 191 |
+
| PPR | Privacy Profile Register |
|
| 192 |
+
| R-GMLC | Requesting-Gateway Mobile Location Centre |
|
| 193 |
+
| RFC | Request For Comments |
|
| 194 |
+
| V-GMLC | Visited-Gateway Mobile Location Centre |
|
| 195 |
+
|
| 196 |
+
# --- 4 General Description
|
| 197 |
+
|
| 198 |
+
## 4.1 Introduction
|
| 199 |
+
|
| 200 |
+
The SLh reference point between the GMLC and the HSS is defined in the 3GPP TS 23.271 [2].
|
| 201 |
+
|
| 202 |
+
This document describes the Diameter-based SLh interface related procedures, message parameters and protocol specifications.
|
| 203 |
+
|
| 204 |
+
## 4.2 Architecture Overview
|
| 205 |
+
|
| 206 |
+
The architecture for support of Location Services in GSM, UMTS and EPS has been defined in 3GPP TS 23.271 [2] and the relevant network elements and interfaces are shown in the figure 4.2-1.
|
| 207 |
+
|
| 208 |
+

|
| 209 |
+
|
| 210 |
+
```
|
| 211 |
+
|
| 212 |
+
graph TD
|
| 213 |
+
HSS[HSS] -- SLh --> GMLC[GMLC]
|
| 214 |
+
GMLC -- Le --> ELCS[External LCS Client]
|
| 215 |
+
GMLC -- SLg --> MME[MME]
|
| 216 |
+
GMLC -- Lg --> SGSN[SGSN]
|
| 217 |
+
GMLC -- Lg --> MSC[MSC/ MSC Server]
|
| 218 |
+
GMLC -- Lpp --> PPR[PPR]
|
| 219 |
+
GMLC -- Lid --> PMD[PMD]
|
| 220 |
+
GMLC -- La --> AAA[AAA Server]
|
| 221 |
+
|
| 222 |
+
```
|
| 223 |
+
|
| 224 |
+
Figure 4.2-1: Overview of the LCS Functional Architecture. The diagram shows a central GMLC connected to an HSS via the SLh interface. The GMLC is also connected to seven other entities via various interfaces: Le (External LCS Client), SLg (MME), Lg (SGSN), Lg (MSC/ MSC Server), Lpp (PPR), Lid (PMD), and La (AAA Server).
|
| 225 |
+
|
| 226 |
+
**Figure 4.2-1: Overview of the LCS Functional Architecture**
|
| 227 |
+
|
| 228 |
+
In this architecture, the SLh interface is defined between the Gateway Mobile Location Center (GMLC) and the Home Subscriber Server (HSS) to allow the GMLC to request routing information from the HLR or HSS.
|
| 229 |
+
|
| 230 |
+
## 4.3 Functional Requirements of SLh Interface
|
| 231 |
+
|
| 232 |
+
The requirements for SLh interface are defined in 3GPP TS 23.271 [2].
|
| 233 |
+
|
| 234 |
+
The SLh interface is used by the GMLC to request routing information from the HSS i.e. the address of the H-GMLC, and/or the address of the visited MSC/MSC server, SGSN, 3GPP AAA server or MME for a particular target UE whose location has been requested.
|
| 235 |
+
|
| 236 |
+
# 5 Diameter-based SLh Interface
|
| 237 |
+
|
| 238 |
+
## 5.1 Introduction
|
| 239 |
+
|
| 240 |
+
This section describes the Diameter-based SLh interface related procedures and Information elements exchanged between functional entities.
|
| 241 |
+
|
| 242 |
+
In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in section 6 of the 3GPP TS 29.228 [4].
|
| 243 |
+
|
| 244 |
+
## 5.2 Procedure Descriptions
|
| 245 |
+
|
| 246 |
+
### 5.2.1 Send Routing Information for LCS
|
| 247 |
+
|
| 248 |
+
#### 5.2.1.1 General
|
| 249 |
+
|
| 250 |
+
This procedure is used between the GMLC and the HSS. The procedure is invoked by the GMLC and is used:
|
| 251 |
+
|
| 252 |
+
- To retrieve routing information for LCS for a specified user from the HSS.
|
| 253 |
+
|
| 254 |
+
This procedure is mapped to the commands LCS-Routing-Info-Request/Answer in the Diameter application specified in chapter 6. Tables 5.2.1.1/1 and 5.2.1.1/2 detail the involved information elements.
|
| 255 |
+
|
| 256 |
+
**Table 5.2.1.1/1: Send Routing Information for LCS (SLh-LCS-SRI)**
|
| 257 |
+
|
| 258 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 259 |
+
|---------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------|
|
| 260 |
+
| IMSI | User-Name | C | This information element shall contain the IMSI of the targeted user. This IE shall be present if the MSISDN is absent. |
|
| 261 |
+
| MSISDN | MSISDN | C | This information element shall contain the MSISDN of the targeted user. This IE shall be present if the IMSI is absent. |
|
| 262 |
+
| GMLC Number | GMLC-Number | O | This information element shall contain the ISDN (E.164) number of the requesting GMLC. |
|
| 263 |
+
| Supported Features (See 3GPP TS 29.229 [8]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. |
|
| 264 |
+
|
| 265 |
+
**Table 5.2.1.1/2: Send Routing Information for LCS (SLh-LCS-SRI) Resp**
|
| 266 |
+
|
| 267 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 268 |
+
|---------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 269 |
+
| Result (See 5.3.5) | Result-Code / Experimental-Result | M | Result of the request.<br>Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [17]).<br>Experimental-Result AVP shall be used for SLh errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. |
|
| 270 |
+
| IMSI | User-Name | C | This information element shall contain the IMSI of the targeted user. This IE shall be present if Result-Code is DIAMETER_SUCCESS and the MSISDN is absent. |
|
| 271 |
+
| MSISDN | MSISDN | C | This information element shall contain the MSISDN of the targeted user. This IE shall be present if Result-Code is DIAMETER_SUCCESS and the IMSI is absent. |
|
| 272 |
+
| LMSI | LMSI | C | This information element shall contain the LMSI allocated by the VLR. This IE should be present if Result-Code is DIAMETER_SUCCESS and LMSI is available in the HSS and MSC-Number is included in the Serving-Node AVP or in an Additional-Serving-Node AVP. |
|
| 273 |
+
| Serving Node | Serving-Node | C | This information element shall contain the information about the network node serving the targeted user i.e. the name/number of the serving node (MME, SGSN, 3GPP AAA server or MSC/MSC server), the LCS capabilities sets supported by the serving node and the IP address of the visited GMLC associated with the serving node. This IE shall be present if the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. |
|
| 274 |
+
| Additional Serving Node | Additional-Serving-Node | C | This information element shall contain the information about another network node serving the targeted user. This IE may be present if Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. There may be multiple instances of this IE in the response provided by the HSS. |
|
| 275 |
+
| Home GMLC Address | GMLC-Address | C | This information element shall contain the IP address of the H-GMLC. This IE should be present if the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. |
|
| 276 |
+
| PPR Address | PPR-Address | C | This information element shall contain the IP address of the Privacy Profile Register (PPR). This IE should be present if available in the HSS and the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. |
|
| 277 |
+
| RIA Flags | RIA-Flags | O | This Information Element contains a bit mask. See 6.4.15 for the meaning of the bits. |
|
| 278 |
+
| Supported Features (See 3GPP TS 29.229 [8]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. |
|
| 279 |
+
|
| 280 |
+
#### 5.2.1.2 Detailed Behaviour of the HSS
|
| 281 |
+
|
| 282 |
+
Upon reception of the Send Routing Info for LCS request, the HSS shall, in the following order:
|
| 283 |
+
|
| 284 |
+
1. Check whether the requesting GMLC belongs to a network authorized to request UE location information. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK in the Send Routing Information for LCS Response.
|
| 285 |
+
2. Check that the User Identity for whom data is asked exists in HSS. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Send Routing Information for LCS Response.
|
| 286 |
+
- 2a. If both IMSI and MSISDN are present in the request, check whether they identify the same User. If not, the HSS Result-Code shall be set to DIAMETER\_CONTRADICTING\_AVPS in the Send Routing Information for LCS Response.
|
| 287 |
+
3. Check that there is at least one serving node associated with the targeted user. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_ABSENT\_USER in the Send Routing Information for LCS Response.
|
| 288 |
+
|
| 289 |
+
If there is an error in any of the above steps then the HSS shall stop processing and shall return the error code specified in the respective step (see 3GPP TS 29.329 [9] and 3GPP TS 29.229 [8] for an explanation of the error codes).
|
| 290 |
+
|
| 291 |
+
If the HSS cannot fulfil the received request for reasons not stated in the above steps, e.g. due to a database error or empty mandatory data elements, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY.
|
| 292 |
+
|
| 293 |
+
Otherwise, the requested operation shall take place and the HSS shall return the Result-Code AVP set to DIAMETER\_SUCCESS. The HSS returns one or several of the network addresses of the current MME, SGSN, 3GPP AAA server and/or VMSC/MSC server, the LCS capabilities of the serving nodes if available, the V-GMLC address associated with the serving nodes, if available, and whichever of the IMSI and MSISDN that was not provided in the Send Routing Info for LCS request. If MSISDN was not provided in the Send Routing Info for LCS request and the subscription is MSISDN-less, the HSS shall return the dummy MSISDN value (see 3GPP TS 23.003 [10]). If both MSISDN and IMSI were provided in the Send Routing Info for LCS request, the HSS returns either MSISDN or IMSI or both. The HSS returns the address of the H-GMLC. The HSS also provides the address of the PPR, if available.
|
| 294 |
+
|
| 295 |
+
The HSS shall include the Diameter Identity of the SGSN (i.e. SGSN-Name and SGSN-Realm), within the Serving-Node AVP or within an Additional-Serving-Node AVP, if and only if the HSS has received an indication that the Lgd interface is supported by the SGSN (see 3GPP TS 29.272 [12]).
|
| 296 |
+
|
| 297 |
+
The HSS shall include the SGSN Number, within the Serving-Node AVP or Additional Serving-Node AVP, except if the HSS has received an indication that the Lg interface is not supported by the SGSN (see 3GPP TS 29.272 [12]).
|
| 298 |
+
|
| 299 |
+
If the UE is served by the MME and SGSN parts of the same combined MME/SGSN (see 3GPP TS 29.272 [12] subclause 5.2.2.1.1 for how the HSS determines if the UE is served by the combined MME/SGSN) and if this combined MME/SGSN has indicated the support for optimized LCS procedure (via the Supported-Feature AVP as defined in 3GPP TS 29.272 [12] subclause 7.3.10) and if HSS supports this optimized LCS procedure, then the HSS shall set the "Combined-MME/SGSN-Supporting-Optimized-LCS-Proc" bit of the RIA-Flags.
|
| 300 |
+
|
| 301 |
+
Regarding the LCS capabilities of the serving nodes, if the HSS registered an SGSN via the S6d reference point (i.e., the registered serving node is an S4-SGSN), the HSS shall set the LCS-Capabilities-Set value to indicate support of Capability Set 5 (i.e., LCS release 7 or later version). If the HSS registered an MME, the HSS shall not indicate any LCS capability value to the GMLC (i.e., the LCS-Capabilities-Set AVP shall be absent over SLh when the serving node is an MME); in this case, the GMLC shall assume that the MME supports LCS Capability Set 5.
|
| 302 |
+
|
| 303 |
+
#### 5.2.1.3 Detailed Behaviour of the GLMC
|
| 304 |
+
|
| 305 |
+
If there are a serving node as well as additional serving nodes in a successful Send Routing Info for LCS response, the receiving shall use the serving node in preference to the additional serving nodes.
|
| 306 |
+
|
| 307 |
+
# 6 Protocol Specification and Implementations
|
| 308 |
+
|
| 309 |
+
## 6.1 Introduction
|
| 310 |
+
|
| 311 |
+
### 6.1.1 Use of Diameter Base Protocol
|
| 312 |
+
|
| 313 |
+
The Diameter base protocol as specified in IETF RFC 6733 [17] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified.
|
| 314 |
+
|
| 315 |
+
### 6.1.2 Securing Diameter Messages
|
| 316 |
+
|
| 317 |
+
For secure transport of Diameter messages, see 3GPP TS 33.210 [6].
|
| 318 |
+
|
| 319 |
+
### 6.1.3 Accounting Functionality
|
| 320 |
+
|
| 321 |
+
Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the SLh interface.
|
| 322 |
+
|
| 323 |
+
### 6.1.4 Use of Sessions
|
| 324 |
+
|
| 325 |
+
Between the GMLC and the HSS, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server.
|
| 326 |
+
|
| 327 |
+
The Diameter base protocol as specified in IETF RFC 6733 [17] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions.
|
| 328 |
+
|
| 329 |
+
The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [17]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses.
|
| 330 |
+
|
| 331 |
+
### 6.1.5 Transport Protocol
|
| 332 |
+
|
| 333 |
+
Diameter messages over the SLh interface shall make use of SCTP IETF RFC 4960 [7] as transport protocol.
|
| 334 |
+
|
| 335 |
+
### 6.1.6 Routing Considerations
|
| 336 |
+
|
| 337 |
+
This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host.
|
| 338 |
+
|
| 339 |
+
If GMLC knows the address/name of the HSS for a certain user, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by a GMLC.
|
| 340 |
+
|
| 341 |
+
Destination-Realm AVP is declared as mandatory in the ABNF for all requests.
|
| 342 |
+
|
| 343 |
+
If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes.
|
| 344 |
+
|
| 345 |
+
### 6.1.7 Advertising Application Support
|
| 346 |
+
|
| 347 |
+
The HSS and GMLC shall advertise support of the Diameter SLh Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands.
|
| 348 |
+
|
| 349 |
+
The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands.
|
| 350 |
+
|
| 351 |
+
The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [17].
|
| 352 |
+
|
| 353 |
+
### 6.1.8 Diameter Application Identifier
|
| 354 |
+
|
| 355 |
+
The SLh interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP (<http://www.iana.org/assignments/enterprise-numbers>) is 10415.
|
| 356 |
+
|
| 357 |
+
The Diameter application identifier assigned to the SLh interface application is 16777291 (allocated by IANA).
|
| 358 |
+
|
| 359 |
+
### 6.1.9 User Identity to HSS resolution
|
| 360 |
+
|
| 361 |
+
The User identity to HSS resolution mechanism enables the GMLC (for non-roaming case) or Diameter Relay/proxy agents in the home network (for roaming case) to find the identity of the HSS that holds the LCS subscription data and routing information for the target user when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS.
|
| 362 |
+
|
| 363 |
+
This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described in the 3GPP TS 29.272 [12] shall apply.
|
| 364 |
+
|
| 365 |
+
NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification.
|
| 366 |
+
|
| 367 |
+
## 6.2 Commands
|
| 368 |
+
|
| 369 |
+
### 6.2.1 Introduction
|
| 370 |
+
|
| 371 |
+
This section defines the Command code values and related ABNF for each command described in this specification.
|
| 372 |
+
|
| 373 |
+
### 6.2.2 Command-Code values
|
| 374 |
+
|
| 375 |
+
This section defines Command-Code values for the SLh interface application as allocated by IANA.
|
| 376 |
+
|
| 377 |
+
Every command is defined by means of the ABNF syntax IETF RFC 2234 [13], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [17]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [17] shall apply.
|
| 378 |
+
|
| 379 |
+
The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node.
|
| 380 |
+
|
| 381 |
+
NOTE: The Vendor-Specific-Application-Id AVP is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [17].
|
| 382 |
+
|
| 383 |
+
The following Command Codes are defined in this specification:
|
| 384 |
+
|
| 385 |
+
**Table 6.2.2/1: Command-Code values for SLh**
|
| 386 |
+
|
| 387 |
+
| <b>Command-Name</b> | <b>Abbreviation</b> | <b>Code</b> | <b>Section</b> |
|
| 388 |
+
|--------------------------|---------------------|-------------|----------------|
|
| 389 |
+
| LCS-Routing-Info-Request | RIR | 8388622 | 6.2.3 |
|
| 390 |
+
| LCS-Routing-Info-Answer | RIA | 8388622 | 6.2.4 |
|
| 391 |
+
|
| 392 |
+
For these commands, the Application-ID field shall be set to 16777291 (application identifier of the SLh interface application, allocated by IANA).
|
| 393 |
+
|
| 394 |
+
### 6.2.3 LCS-Routing-Info-Request (RIR) Command
|
| 395 |
+
|
| 396 |
+
The LCS-Routing-Info-Request (RIR) command, indicated by the Command-Code field set to 8388622 and the "R" bit set in the Command Flags field, is sent from GMLC to HSS.
|
| 397 |
+
|
| 398 |
+
Message Format
|
| 399 |
+
|
| 400 |
+
```
|
| 401 |
+
< LCS-Routing-Info-Request > ::= < Diameter Header: 8388622, REQ, PXY, 16777291 >
|
| 402 |
+
|
| 403 |
+
< Session-Id >
|
| 404 |
+
|
| 405 |
+
[ Vendor-Specific-Application-Id ]
|
| 406 |
+
|
| 407 |
+
{ Auth-Session-State }
|
| 408 |
+
|
| 409 |
+
{ Origin-Host }
|
| 410 |
+
|
| 411 |
+
{ Origin-Realm }
|
| 412 |
+
|
| 413 |
+
[ Destination-Host ]
|
| 414 |
+
|
| 415 |
+
{ Destination-Realm }
|
| 416 |
+
|
| 417 |
+
[ User-Name ]
|
| 418 |
+
|
| 419 |
+
[ MSISDN ]
|
| 420 |
+
|
| 421 |
+
[ GMLC-Number ]
|
| 422 |
+
|
| 423 |
+
*[ Supported-Features ]
|
| 424 |
+
|
| 425 |
+
*[ Proxy-Info ]
|
| 426 |
+
|
| 427 |
+
*[ Route-Record ]
|
| 428 |
+
|
| 429 |
+
*[ AVP ]
|
| 430 |
+
```
|
| 431 |
+
|
| 432 |
+
### 6.2.4 LCS-Routing-Info-Answer (RIA) Command
|
| 433 |
+
|
| 434 |
+
The LCS-Routing-Info-Answer (RIA) command, indicated by the Command-Code field set to 8388622 and the 'R' bit cleared in the Command Flags field, is sent from HSS to GMLC.
|
| 435 |
+
|
| 436 |
+
Message Format
|
| 437 |
+
|
| 438 |
+
```
|
| 439 |
+
< LCS-Routing-Info-Answer > ::= < Diameter Header: 8388622, PXY, 16777291 >
|
| 440 |
+
|
| 441 |
+
< Session-Id >
|
| 442 |
+
|
| 443 |
+
[ Vendor-Specific-Application-Id ]
|
| 444 |
+
|
| 445 |
+
[ Result-Code ]
|
| 446 |
+
```
|
| 447 |
+
|
| 448 |
+
```
|
| 449 |
+
|
| 450 |
+
[ Experimental-Result ]
|
| 451 |
+
{ Auth-Session-State }
|
| 452 |
+
{ Origin-Host }
|
| 453 |
+
{ Origin-Realm }
|
| 454 |
+
*[ Supported-Features ]
|
| 455 |
+
[ User-Name ]
|
| 456 |
+
[ MSISDN ]
|
| 457 |
+
[ LMSI ]
|
| 458 |
+
[ Serving-Node ]
|
| 459 |
+
*[ Additional-Serving-Node ]
|
| 460 |
+
[ GMLC-Address ]
|
| 461 |
+
[ PPR-Address ]
|
| 462 |
+
[ RIA-Flags ]
|
| 463 |
+
*[ AVP ]
|
| 464 |
+
[ Failed-AVP ]
|
| 465 |
+
*[ Proxy-Info ]
|
| 466 |
+
*[ Route-Record ]
|
| 467 |
+
|
| 468 |
+
```
|
| 469 |
+
|
| 470 |
+
## 6.3 Result-Code AVP and Experimental-Result AVP Values
|
| 471 |
+
|
| 472 |
+
### 6.3.1 General
|
| 473 |
+
|
| 474 |
+
This section defines result code values that shall be supported by all Diameter implementations that conform to this specification.
|
| 475 |
+
|
| 476 |
+
### 6.3.2 Success
|
| 477 |
+
|
| 478 |
+
Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [17] shall be applied.
|
| 479 |
+
|
| 480 |
+
### 6.3.3 Permanent Failures
|
| 481 |
+
|
| 482 |
+
Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [17] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent.
|
| 483 |
+
|
| 484 |
+
#### 6.3.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001)
|
| 485 |
+
|
| 486 |
+
This result code shall be sent by the HSS to indicate that the user identified by the IMSI or the MSISDN is unknown. This error code is defined in 3GPP TS 29.229 [8]
|
| 487 |
+
|
| 488 |
+
#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK (5490)
|
| 489 |
+
|
| 490 |
+
This result code shall be sent by the HSS to indicate that the requesting GMLC's network is not authorized to request UE location information.
|
| 491 |
+
|
| 492 |
+
### 6.3.4 Transient Failures
|
| 493 |
+
|
| 494 |
+
Errors that fall within the transient failures category are those used to inform a peer that the request could not be satisfied at the time that it was received. The request may be able to be satisfied in the future.
|
| 495 |
+
|
| 496 |
+
#### 6.3.4.1 DIAMETER\_ERROR\_ABSENT\_USER (4201)
|
| 497 |
+
|
| 498 |
+
This result code shall be sent by the HSS to indicate that the location of the targeted user is not known at this time to satisfy the requested operation.
|
| 499 |
+
|
| 500 |
+
## 6.4 AVPs
|
| 501 |
+
|
| 502 |
+
### 6.4.1 General
|
| 503 |
+
|
| 504 |
+
The following table specifies the Diameter AVPs defined for the SLh interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415).
|
| 505 |
+
|
| 506 |
+
For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used.
|
| 507 |
+
|
| 508 |
+
**Table 6.4.1/1: SLh specific Diameter AVPs**
|
| 509 |
+
|
| 510 |
+
| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | May Encr. |
|
| 511 |
+
|-------------------------|----------|-----------------|------------------|----------------|-----|------------|----------|--|-----------|
|
| 512 |
+
| | | | | Must | May | Should not | Must not | | |
|
| 513 |
+
| LMSI | 2400 | 6.4.2 | OctetString | M, V | | | | | No |
|
| 514 |
+
| Serving-Node | 2401 | 6.4.3 | Grouped | M, V | | | | | No |
|
| 515 |
+
| MME-Name | 2402 | 6.4.4 | DiameterIdentity | M, V | | | | | No |
|
| 516 |
+
| MSC-Number | 2403 | 6.4.5 | OctetString | M, V | | | | | No |
|
| 517 |
+
| LCS-Capabilities-Sets | 2404 | 6.4.6 | Unsigned32 | M, V | | | | | No |
|
| 518 |
+
| GMLC-Address | 2405 | 6.4.7 | Address | M, V | | | | | No |
|
| 519 |
+
| Additional-Serving-Node | 2406 | 6.4.8 | Grouped | M, V | | | | | No |
|
| 520 |
+
| PPR-Address | 2407 | 6.4.9 | Address | M, V | | | | | No |
|
| 521 |
+
| MME-Realm | 2408 | 6.4.12 | DiameterIdentity | V | | | M | | No |
|
| 522 |
+
| SGSN-Name | 2409 | 6.4.13 | DiameterIdentity | V | | | M | | No |
|
| 523 |
+
| SGSN-Realm | 2410 | 6.4.14 | DiameterIdentity | V | | | M | | No |
|
| 524 |
+
| RIA-Flags | 2411 | 6.4.15 | Unsigned32 | V | | | M | | No |
|
| 525 |
+
|
| 526 |
+
NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [17].
|
| 527 |
+
|
| 528 |
+
The following table specifies the Diameter AVPs re-used by the SLh interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SLh.
|
| 529 |
+
|
| 530 |
+
Any other AVPs from existing Diameter Applications, except for the AVPs from the Diameter base protocol as specified in IETF RFC 6733 [17], do not need to be supported. The AVPs from the Diameter base protocol as specified in IETF RFC 6733 [17] are not included in table 6.4.1/2, but they may be re-used for the SLh protocol.
|
| 531 |
+
|
| 532 |
+
Table 6.4.1/2: SLh re-used Diameter AVPs
|
| 533 |
+
|
| 534 |
+
| Attribute Name | Reference | Comments |
|
| 535 |
+
|----------------------|---------------------|--------------------|
|
| 536 |
+
| MSISDN | 3GPP TS 29.329 [9] | |
|
| 537 |
+
| SGSN-Number | 3GPP TS 29.272 [12] | |
|
| 538 |
+
| Supported-Features | 3GPP TS 29.229 [8] | |
|
| 539 |
+
| Feature-List-ID | 3GPP TS 29.229 [8] | See section 6.4.10 |
|
| 540 |
+
| Feature-List | 3GPP TS 29.229 [8] | See section 6.4.11 |
|
| 541 |
+
| GMLC-Number | 3GPP TS 29.272 [12] | |
|
| 542 |
+
| 3GPP-AAA-Server-Name | 3GPP TS 29.273 [16] | |
|
| 543 |
+
|
| 544 |
+
### 6.4.2 LMSI
|
| 545 |
+
|
| 546 |
+
The LMSI AVP is of type OctetString and it shall contain the Local Mobile Station Identity (LMSI) allocated by the VLR, as defined in 3GPP TS 23.003 [10]. For further details on the encoding of this AVP, see 3GPP TS 23.003[10].
|
| 547 |
+
|
| 548 |
+
### 6.4.3 Serving-Node
|
| 549 |
+
|
| 550 |
+
The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user.
|
| 551 |
+
|
| 552 |
+
AVP format
|
| 553 |
+
|
| 554 |
+
```
|
| 555 |
+
Serving-Node ::= <AVP header: 2401 10415>
|
| 556 |
+
[ SGSN-Number ]
|
| 557 |
+
[ SGSN-Name ]
|
| 558 |
+
[ SGSN-Realm ]
|
| 559 |
+
[ MME-Name ]
|
| 560 |
+
[ MME-Realm ]
|
| 561 |
+
[ MSC-Number ]
|
| 562 |
+
[ 3GPP-AAA-Server-Name ]
|
| 563 |
+
[ LCS-Capabilities-Sets ]
|
| 564 |
+
[ GMLC-Address ]
|
| 565 |
+
*[AVP]
|
| 566 |
+
```
|
| 567 |
+
|
| 568 |
+
The GMLC-Address AVP included in the Serving-Node grouped AVP shall contain, if present, the IPv4 or IPv6 address of the GMLC associated with the serving node (i.e., either the home GMLC or the visited GMLC, depending on the location of the serving node).
|
| 569 |
+
|
| 570 |
+
### 6.4.4 MME-Name
|
| 571 |
+
|
| 572 |
+
The MME-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving MME. For further details on the encoding of this AVP, see IETF RFC 6733 [17].
|
| 573 |
+
|
| 574 |
+
### 6.4.5 MSC-Number
|
| 575 |
+
|
| 576 |
+
The MSC-Number AVP is of type OctetString and it shall contain the ISDN number of the serving MSC or MSC server in international number format as described in ITU-T Rec E.164 [15] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [3] for encoding of TBCD-strings.
|
| 577 |
+
|
| 578 |
+
### 6.4.6 LCS-Capabilities-Sets
|
| 579 |
+
|
| 580 |
+
The LCS-Capabilities-Sets AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in 3GPP 29.002 [3].
|
| 581 |
+
|
| 582 |
+
### 6.4.7 GMLC-Address
|
| 583 |
+
|
| 584 |
+
The GMLC-Address AVP is of type Address and shall contain the IPv4 or IPv6 address of H-GMLC or the V-GMLC associated with the serving node.
|
| 585 |
+
|
| 586 |
+
### 6.4.8 Additional-Serving-Node
|
| 587 |
+
|
| 588 |
+
The Additional-Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user.
|
| 589 |
+
|
| 590 |
+
AVP format
|
| 591 |
+
|
| 592 |
+
```
|
| 593 |
+
Additional-Serving-Node ::= <AVP header: 2406 10415>
|
| 594 |
+
[ SGSN-Number ]
|
| 595 |
+
[ MME-Name ]
|
| 596 |
+
[ SGSN-Name ]
|
| 597 |
+
[ SGSN-Realm ]
|
| 598 |
+
[ MME-Realm ]
|
| 599 |
+
[ MSC-Number ]
|
| 600 |
+
[ 3GPP-AAA-Server-Name ]
|
| 601 |
+
[ LCS-Capabilities-Sets ]
|
| 602 |
+
[ GMLC-Address ]
|
| 603 |
+
*[AVP]
|
| 604 |
+
```
|
| 605 |
+
|
| 606 |
+
The GMLC-Address AVP included in the Additional-Serving-Node grouped AVP shall contain, if present, the IPv4 or IPv6 address of the GMLC associated with the serving node (i.e., either the home GMLC or the visited GMLC, depending on the location of the serving node).
|
| 607 |
+
|
| 608 |
+
### 6.4.9 PPR-Address
|
| 609 |
+
|
| 610 |
+
The PPR-Address AVP is of type Address and contains the IPv4 or IPv6 address of the Privacy Profile Register for the targeted user.
|
| 611 |
+
|
| 612 |
+
### 6.4.10 Feature-List-ID AVP
|
| 613 |
+
|
| 614 |
+
The syntax of this AVP is defined in 3GPP TS 29.229 [8]. For this release, the Feature-List-ID AVP value shall be set to 1.
|
| 615 |
+
|
| 616 |
+
### 6.4.11 Feature-List AVP
|
| 617 |
+
|
| 618 |
+
The syntax of this AVP is defined in 3GPP TS 29.229 [8]. A null value indicates that there is no feature used by the application.
|
| 619 |
+
|
| 620 |
+
NOTE: There is no feature defined for this release.
|
| 621 |
+
|
| 622 |
+
### 6.4.12 MME-Realm
|
| 623 |
+
|
| 624 |
+
The MME-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving MME. For further details on the encoding of this AVP, see IETF RFC 6733 [17].
|
| 625 |
+
|
| 626 |
+
### 6.4.13 SGSN-Name
|
| 627 |
+
|
| 628 |
+
The SGSN-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving SGSN. For further details on the encoding of this AVP, see IETF RFC 6733 [17].
|
| 629 |
+
|
| 630 |
+
### 6.4.14 SGSN-Realm
|
| 631 |
+
|
| 632 |
+
The SGSN-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving SGSN. For further details on the encoding of this AVP, see IETF RFC 6733 [17].
|
| 633 |
+
|
| 634 |
+
### 6.4.15 RIA-Flags
|
| 635 |
+
|
| 636 |
+
The RIA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.4.15/1:
|
| 637 |
+
|
| 638 |
+
**Table 6.4.15/1: RIA-Flags**
|
| 639 |
+
|
| 640 |
+
| Bit | Name | Description |
|
| 641 |
+
|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 642 |
+
| 0 | Combined-MME/SGSN-Supporting-Optimized-LCS-Proc | This bit, when set, indicates that the UE is served by the MME and the SGSN parts of the same combined MME/SGSN and this combined MME/SGSN supports the optimized LCS procedure. |
|
| 643 |
+
| NOTE1: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving GMLC. | | |
|
marked/Rel-18/29_series/29202/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29204/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29205/raw.md
ADDED
|
@@ -0,0 +1,953 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.205 V18.0.0 (2024-03)
|
| 4 |
+
|
| 5 |
+
Technical Specification
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Application of Q.1900 series to bearer independent Circuit Switched (CS) core network architecture; Stage 3 (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
The 3GPP logo, featuring the letters '3GPP' in a stylized font. The '3' is large and bold, with a red signal icon below it. The 'G' and 'P' are also bold, with the 'P' having a small 'TM' symbol above it.
|
| 12 |
+
|
| 13 |
+
3GPP logo
|
| 14 |
+
|
| 15 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 16 |
+
|
| 17 |
+
## **3GPP**
|
| 18 |
+
|
| 19 |
+
---
|
| 20 |
+
|
| 21 |
+
Postal address
|
| 22 |
+
|
| 23 |
+
---
|
| 24 |
+
|
| 25 |
+
3GPP support office address
|
| 26 |
+
|
| 27 |
+
---
|
| 28 |
+
|
| 29 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 30 |
+
Valbonne - FRANCE
|
| 31 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
Internet
|
| 36 |
+
|
| 37 |
+
---
|
| 38 |
+
|
| 39 |
+
<http://www.3gpp.org>
|
| 40 |
+
|
| 41 |
+
## --- **Copyright Notification** ---
|
| 42 |
+
|
| 43 |
+
No part may be reproduced except as authorized by written permission.
|
| 44 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 45 |
+
|
| 46 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 47 |
+
All rights reserved.
|
| 48 |
+
|
| 49 |
+
UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
|
| 50 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 51 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 52 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 53 |
+
|
| 54 |
+
# Contents
|
| 55 |
+
|
| 56 |
+
| | |
|
| 57 |
+
|--------------------------------------------------------------------------|-----------|
|
| 58 |
+
| Foreword ..... | 5 |
|
| 59 |
+
| 1 Scope..... | 6 |
|
| 60 |
+
| 2 References..... | 6 |
|
| 61 |
+
| 3 Definitions, symbols and abbreviations ..... | 7 |
|
| 62 |
+
| 3.1 Definitions..... | 7 |
|
| 63 |
+
| 3.2 Symbols..... | 7 |
|
| 64 |
+
| 3.3 Abbreviations ..... | 7 |
|
| 65 |
+
| 4 Protocols..... | 8 |
|
| 66 |
+
| 4.1 Call control protocol (Nc interface) ..... | 8 |
|
| 67 |
+
| 4.2 Interworking with other protocols..... | 8 |
|
| 68 |
+
| 4.3 Resource control protocol (G)MSC and MGW (Mc Interface) ..... | 8 |
|
| 69 |
+
| 4.4 Bearer control protocol between MGWs (Nb interface)..... | 9 |
|
| 70 |
+
| 4.5 Signalling Transport..... | 9 |
|
| 71 |
+
| 4.5.1 Call Control protocols ..... | 9 |
|
| 72 |
+
| 4.5.2 Resource control protocol (G)MSC and MGW (Mc Interface) ..... | 9 |
|
| 73 |
+
| 4.5.3 Bearer control protocol between MGWs (Nb interface) ..... | 9 |
|
| 74 |
+
| <b>Annex A: Void.....</b> | <b>9</b> |
|
| 75 |
+
| <b>Annex B (normative): Transparent Support of Mobile Services .....</b> | <b>9</b> |
|
| 76 |
+
| B.1 Introduction..... | 9 |
|
| 77 |
+
| B.2 Mobile Service Transport (MST) – Format and Codes ..... | 10 |
|
| 78 |
+
| B.2.1 Encapsulated Application Information..... | 10 |
|
| 79 |
+
| B.2.1.1 General Layout ..... | 10 |
|
| 80 |
+
| B.2.1.2 List of Identifiers ..... | 12 |
|
| 81 |
+
| B.2.1.3 Mobile Equipment Identifier ..... | 12 |
|
| 82 |
+
| B.2.1.4 LCLS Negotiation Request..... | 13 |
|
| 83 |
+
| B.2.1.5 LCLS Negotiation Response ..... | 13 |
|
| 84 |
+
| B.2.1.6 LCLS Status..... | 14 |
|
| 85 |
+
| B.2.1.7 LCLS Status Change ..... | 14 |
|
| 86 |
+
| B.2.1.8 LCLS Status Result ..... | 14 |
|
| 87 |
+
| B.2.1.9 LCLS Global Call Reference..... | 15 |
|
| 88 |
+
| B.2.1.10 LCLS Configuration Preference..... | 16 |
|
| 89 |
+
| B.2.1.11 LCLS Configuration Change Request..... | 17 |
|
| 90 |
+
| B.2.1.12 LCLS Configuration Change Result ..... | 17 |
|
| 91 |
+
| B.2.2 Application Transport Instruction Indicators ..... | 18 |
|
| 92 |
+
| <b>Annex C (normative): LCLS Service Application .....</b> | <b>18</b> |
|
| 93 |
+
| C.1 Use of MST ASE ..... | 18 |
|
| 94 |
+
| C.2 Procedures..... | 18 |
|
| 95 |
+
| C.2.1 Indication of LCLS Capability ..... | 18 |
|
| 96 |
+
| C.2.1.1 LCLS Service Capability Indication ..... | 18 |
|
| 97 |
+
| C.2.1.2 Actions at Originating Serving Node ..... | 19 |
|
| 98 |
+
| C.2.1.3 Actions at Intermediate Serving Node ..... | 19 |
|
| 99 |
+
| C.2.1.4 Actions at Destination Serving Node ..... | 19 |
|
| 100 |
+
| C.2.2 Backward LCLS Negotiation during Call Setup..... | 20 |
|
| 101 |
+
| C.2.2.1 Introduction ..... | 20 |
|
| 102 |
+
| C.2.2.2 Actions at Destination Serving Node ..... | 20 |
|
| 103 |
+
| C.2.2.3 Actions at Intermediate Serving Node ..... | 20 |
|
| 104 |
+
| C.2.2.4 Actions at Originating Serving Node ..... | 20 |
|
| 105 |
+
| C.2.3 Answer message..... | 21 |
|
| 106 |
+
| C.2.3.1 Introduction ..... | 21 |
|
| 107 |
+
|
| 108 |
+
- C.2.3.2 Actions at Destination Serving Node ..... 21
|
| 109 |
+
- C.2.3.3 Actions at Intermediate Serving Node ..... 21
|
| 110 |
+
- C.2.3.4 Actions at Originating Serving Node ..... 21
|
| 111 |
+
- C.2.4 LCLS Configuration Change Request..... 21
|
| 112 |
+
- C.2.4.1 Introduction ..... 21
|
| 113 |
+
- C.2.4.2 Actions at Initiating Serving Node ..... 22
|
| 114 |
+
- C.2.4.3 Actions at Intermediate Serving Node ..... 22
|
| 115 |
+
- C.2.4.4 Actions at Terminating Serving Node..... 22
|
| 116 |
+
- C.2.5 LCLS Status Update..... 22
|
| 117 |
+
- C.2.5.1 Introduction ..... 22
|
| 118 |
+
- C.2.5.2 Actions at Initiating Serving Node ..... 23
|
| 119 |
+
- C.2.5.3 Actions at Intermediate Serving Node ..... 23
|
| 120 |
+
- C.2.5.4 Actions at Terminating Serving Node..... 23
|
| 121 |
+
- C.2.6 LCLS Status Change Request ..... 23
|
| 122 |
+
- C.2.6.1 Introduction ..... 23
|
| 123 |
+
- C.2.6.2 Actions at Initiating Serving Node ..... 23
|
| 124 |
+
- C.2.6.3 Actions at Intermediate Serving Node ..... 24
|
| 125 |
+
- C.2.6.4 Actions at Terminating Serving Node..... 24
|
| 126 |
+
|
| 127 |
+
**Annex D (informative): Change history ..... 25**
|
| 128 |
+
|
| 129 |
+
# --- Foreword
|
| 130 |
+
|
| 131 |
+
This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
|
| 132 |
+
|
| 133 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 134 |
+
|
| 135 |
+
Version x.y.z
|
| 136 |
+
|
| 137 |
+
where:
|
| 138 |
+
|
| 139 |
+
- x the first digit:
|
| 140 |
+
- 1 presented to TSG for information;
|
| 141 |
+
- 2 presented to TSG for approval;
|
| 142 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 143 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 144 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 145 |
+
|
| 146 |
+
# 1 Scope
|
| 147 |
+
|
| 148 |
+
The present document describes the protocols to be used when ITU-T Q.1902 "Bearer Independent Call Control" is used as call control protocol in a 3GPP Bearer Independent CS core network 3GPP TS 23.205 [1]. The Q.1902 operates between (G)MSC servers. The BICC architecture as described in ITU-T Q.1902 [6]-[10] consists of a number of protocols. The following types of protocols are described: call control protocol, bearer control protocols and a resource control protocol for this architecture. The architecture complies with the requirements imposed by 3GPP TS 23.205 [1] and TS 23.153 [2].
|
| 149 |
+
|
| 150 |
+
The present document is valid for a 3<sup>rd</sup> generation PLMN (UMTS) complying with Release 4 and later.
|
| 151 |
+
|
| 152 |
+
Note: Q.1902 can be used in other network architectures than the one defined in 3GPP TS 23.205 [1]
|
| 153 |
+
|
| 154 |
+
# 2 References
|
| 155 |
+
|
| 156 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 157 |
+
|
| 158 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 159 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 160 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 161 |
+
|
| 162 |
+
- [1] 3GPP TS 23.205: "Bearer Independent CS Core Network – Stage 2".
|
| 163 |
+
- [2] 3GPP TS 23.153: "Out of Band Transcoder Control - Stage 2".
|
| 164 |
+
- [3] 3GPP TS 29.232: "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3".
|
| 165 |
+
- [4] 3GPP TS 29.414: "Core Network Nb Data Transport and Signalling Transport".
|
| 166 |
+
- [5] ITU-T Recommendation Q.765.5 (06/2000): "Application Transport Mechanism".
|
| 167 |
+
- [6] ITU-T Recommendation Q.1902.1 (07/2001): "Bearer Independent Call Control CS2 Functional Description". Inclusive Amendment 3: "Support for the Customized Alerting Tone (CAT) service".
|
| 168 |
+
- [7] ITU-T Recommendation Q.1902.2 (07/2001): "Bearer Independent Call Control CS2 General functions of messages and parameters". Inclusive Amendment 5: "Support for the Customized Alerting Tone (CAT) service".
|
| 169 |
+
- [8] ITU-T Q.1902.3 (07/2001): "Bearer Independent Call Control CS2 Formats and Codes". Inclusive Amendment 5: "Support for the Customized Alerting Tone (CAT) service".
|
| 170 |
+
- [9] ITU-T Recommendation Q.1902.4 (07/2001): "Bearer Independent Call Control CS2 Basic Call Procedures".
|
| 171 |
+
- [10] ITU-T Recommendation Q.1902.5 (07/2001): "Exceptions to the Application Transport Mechanism in the Context of Bearer Independent Call Control".
|
| 172 |
+
- [11] ITU-T Recommendation Q.1902.6 (07/2001): "Generic Signalling Procedures for the support of the ISDN User Part Supplementary Services and for bearer redirection".
|
| 173 |
+
- [12] ITU-T Recommendation Q.1950 (07/2001): "Call Bearer Control Protocol".
|
| 174 |
+
- [13] ITU-T Recommendations Q.2630.1 (12/1999), Q.2630.2 (12/2000): "AAL type 2 signalling protocol".
|
| 175 |
+
|
| 176 |
+
- [14] ITU-T Recommendation Q.1990 (07/2001): "BICC Bearer Control tunnelling protocol".
|
| 177 |
+
- [15] ITU-T Recommendation Q.1970 (07/2001): "BICC IP Bearer Control protocol".
|
| 178 |
+
- [16] ITU-T Recommendation Q.1912.1 (07/2001): "Interworking between Signalling System No. 7 ISDN user part and the Bearer Independent Call Control protocol".
|
| 179 |
+
- [17] ITU-T Recommendation Q.1912.2 (07/2001): "Interworking between selected Signalling System (PSTN Access DSS1, C5, R1, R2, TUP) and the Bearer Independent Call Control Protocol".
|
| 180 |
+
- [18] ITU-T Recommendation Q.2150.0 (05/2001): "Generic Signalling Transport Service".
|
| 181 |
+
- [19] ITU-T Recommendation Q.2150.1 (05/2001): "Signalling Transport Converter on MTP3 and MTP3b".
|
| 182 |
+
- [20] ITU-T Recommendation Q.2150.3 (12/2002): "Signalling Transport Converter on SCTP".
|
| 183 |
+
- [21] ITU-T Recommendation H.248.4 (11/2000): "Gateway Control Protocol: Transport over SCTP".
|
| 184 |
+
- [22] 3GPP TS 29.202: "SS7 signalling transport in core network".
|
| 185 |
+
- [23] ITU-T Recommendation H.248.5 (11/2000): "Gateway control protocol: Transport over ATM".
|
| 186 |
+
- [24] ITU-T Q.765 (06/2000): "Signalling system No. 7 – Application transport mechanism".
|
| 187 |
+
- [25] 3GPP TS 23.003: "Numbering, addressing and identification".
|
| 188 |
+
- [26] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2".
|
| 189 |
+
- [27] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2".
|
| 190 |
+
- [28] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 191 |
+
- [29] 3GPP TS 23.284: "Local Call Local Switch; Stage 2".
|
| 192 |
+
|
| 193 |
+
# --- 3 Definitions, symbols and abbreviations
|
| 194 |
+
|
| 195 |
+
## 3.1 Definitions
|
| 196 |
+
|
| 197 |
+
## 3.2 Symbols
|
| 198 |
+
|
| 199 |
+
For the purposes of the present document, the following symbols apply:
|
| 200 |
+
|
| 201 |
+
| | |
|
| 202 |
+
|----|-----------------------------------------------------|
|
| 203 |
+
| Nc | Interface between the (G)MSC servers. |
|
| 204 |
+
| Mc | Interface between the server and the media gateway. |
|
| 205 |
+
| Nb | Interface between media gateways (MGW). |
|
| 206 |
+
|
| 207 |
+
## 3.3 Abbreviations
|
| 208 |
+
|
| 209 |
+
For the purposes of the present document, the abbreviations as defined in 3GPP TR 21.905 [28] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [28].
|
| 210 |
+
|
| 211 |
+
| | |
|
| 212 |
+
|------|----------------------------------|
|
| 213 |
+
| APM | Application Transport Mechanism |
|
| 214 |
+
| | Application Transport Message |
|
| 215 |
+
| APP | Application Transport Parameter |
|
| 216 |
+
| BAT | Bearer Association Transport |
|
| 217 |
+
| BICC | Bearer Independent Call Control |
|
| 218 |
+
| C5 | CCITT signalling system number 5 |
|
| 219 |
+
| GCR | Global Call Reference |
|
| 220 |
+
|
| 221 |
+
| | |
|
| 222 |
+
|------|--------------------------------------|
|
| 223 |
+
| LCLS | Local Call Local Switch |
|
| 224 |
+
| M3UA | MTP3 – User Adaptation Layer |
|
| 225 |
+
| MGC | Media Gateway Controller |
|
| 226 |
+
| MST | Mobile Service Transport |
|
| 227 |
+
| R1 | Regional Signalling System 1 |
|
| 228 |
+
| R2 | Regional Signalling System 2 |
|
| 229 |
+
| SCTP | Stream Control Transmission Protocol |
|
| 230 |
+
| SN | Serving Node |
|
| 231 |
+
| TUP | Telephony User Part |
|
| 232 |
+
|
| 233 |
+
# 4 Protocols
|
| 234 |
+
|
| 235 |
+
Implementations providing any of the interfaces or protocols identified in the subclauses below shall implement the requirements of the specifications identified in those subclauses.
|
| 236 |
+
|
| 237 |
+
## 4.1 Call control protocol (Nc interface)
|
| 238 |
+
|
| 239 |
+
| | |
|
| 240 |
+
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 241 |
+
| Q.1902.1 | BICC PROTOCOL (CS2) FUNCTIONAL DESCRIPTION [6] |
|
| 242 |
+
| Q.1902.2 | BICC PROTOCOL (CS2) AND SIGNALLING SYSTEM NO 7 ISUP<br>GENERAL FUNCTIONS OF MESSAGES AND PARAMETERS [7] |
|
| 243 |
+
| Q.1902.3 | BICC PROTOCOL (CS2) AND SIGNALLING SYSTEM NO 7 ISUP<br>FORMATS AND CODES [8] (NOTE) |
|
| 244 |
+
| Q.1902.4 | BICC (CS2) BASIC CALL PROCEDURES [9] |
|
| 245 |
+
| Q.1902.5 | EXCEPTIONS TO THE APM IN THE CONTEXT OF BICC [10]<br>AMENDMENT TO ITU-T RECOMMENDATION Q.765.5 FOR BICC CS2 [5] |
|
| 246 |
+
| Q.1902.6 | GENERIC SIGNALLING PROCEDURES AND SUPPORT OF THE ISDN USER PART SUPPLEMENTARY<br>SERVICES WITH THE BEARER INDEPENDENT CALL CONTROL PROTOCOL [11] |
|
| 247 |
+
| NOTE: | The "Backward CAT indicators" parameter shall be encoded as an optional 3-octet parameter in the ACM, CPG and SEG messages rather than as a 1-octet parameter as incorrectly defined in Amendment 5 of ITU-T Recommendation Q.1902.3 [8]. |
|
| 248 |
+
|
| 249 |
+
## 4.2 Interworking with other protocols
|
| 250 |
+
|
| 251 |
+
| | |
|
| 252 |
+
|----------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
| 253 |
+
| Q.1912.1 | ISUP-BICC INTERWORKING [16] |
|
| 254 |
+
| Q.1912.2 | INTERWORKING BETWEEN SELECTED SIGNALLING SYSTEMS (PSTN ACCESS DSS1 C5 R1 R2 TUP)<br>AND THE BEARER INDEPENDENT CALL CONTROL PROTOCOL [17] |
|
| 255 |
+
|
| 256 |
+
## 4.3 Resource control protocol (G)MSC and MGW (Mc Interface)
|
| 257 |
+
|
| 258 |
+
| | |
|
| 259 |
+
|----------------|------------------------------------------------------------------------------|
|
| 260 |
+
| 3GPP TS 29.232 | "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface;Stage 3" [3] |
|
| 261 |
+
|----------------|------------------------------------------------------------------------------|
|
| 262 |
+
|
| 263 |
+
## 4.4 Bearer control protocol between MGWs (Nb interface)
|
| 264 |
+
|
| 265 |
+
| | |
|
| 266 |
+
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 267 |
+
| 3GPP TS 29.414 | "Core Network Nb Data Transport and Signalling Transport" [4] including ITU-T Recommendation Q.1970 "IP bearer control protocol" [15] , ITU-T Recommendation Q.1990 "BICC tunneling control protocol" [14] , ITU-T Recommendation Q.2630.1-2 "AAL type 2 signalling protocol" [13]. |
|
| 268 |
+
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 269 |
+
|
| 270 |
+
## 4.5 Signalling Transport
|
| 271 |
+
|
| 272 |
+
### 4.5.1 Call Control protocols
|
| 273 |
+
|
| 274 |
+
| | |
|
| 275 |
+
|----------------|--------------------------------------------------------------------------------------------|
|
| 276 |
+
| Q.2150.0 | "Generic Signalling Transport Service" [18] |
|
| 277 |
+
| Q.2150.1 | "Signalling Transport Converter on MTP3 and MTP3b" [19] |
|
| 278 |
+
| Q.2150.3 | "Signalling Transport Converter on SCTP" [20] |
|
| 279 |
+
| 3GPP TS 29.202 | "SS7 signalling transport in core network" [22] Annex A: The use of M3UA in 3GPP networks. |
|
| 280 |
+
|
| 281 |
+
### 4.5.2 Resource control protocol (G)MSC and MGW (Mc Interface)
|
| 282 |
+
|
| 283 |
+
| | |
|
| 284 |
+
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 285 |
+
| 3GPP TS 29.232 | "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3" [3] including ITU-T Recommendation H.248.4 "Transport over SCTP" [21], ITU-T Recommendation H.248.5 "Transport over ATM" [23], and 3GPP TS 29.202 "SS7 signalling transport in core network" [22] Annex A: The use of M3UA in 3GPP networks. |
|
| 286 |
+
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 287 |
+
|
| 288 |
+
### 4.5.3 Bearer control protocol between MGWs (Nb interface)
|
| 289 |
+
|
| 290 |
+
| | |
|
| 291 |
+
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 292 |
+
| 3GPP TS 29.414 | "Core Network Nb Data Transport and signalling transport" [4] including ITU-T Recommendation Q.2630.1-2: "AAL type 2 signalling protocol" [13] and the tunnel-up and tunnel-down procedure in 3GPP TS 29.232 [31] |
|
| 293 |
+
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 294 |
+
|
| 295 |
+
# --- Annex A: Void
|
| 296 |
+
|
| 297 |
+
# Annex B (normative): Transparent Support of Mobile Services
|
| 298 |
+
|
| 299 |
+
## B.1 Introduction
|
| 300 |
+
|
| 301 |
+
This Annex specifies a new mobile APM usage "Transparent support of mobile services".
|
| 302 |
+
|
| 303 |
+
In ITU-T Recommendation Q.1902.3 [8], for the Application Transport Parameter (APP), the following codepoint is defined to refer to this application context identifier (ACI):
|
| 304 |
+
|
| 305 |
+
0 0 0 0 1 1 1 MST <as defined in ETSI TS 129.205>
|
| 306 |
+
|
| 307 |
+
The text in ITU-T Recommendation Q.1902.5 [10] shall be followed when implementing this application with the following clarification:
|
| 308 |
+
|
| 309 |
+
- where the text refers to BAT ASE this shall be interpreted to mean Mobile Service Transport (MST) service.
|
| 310 |
+
|
| 311 |
+
The MST service shall use implicit addressing; see ITU-T Recommendation Q.765 [24].
|
| 312 |
+
|
| 313 |
+
## B.2 Mobile Service Transport (MST) – Format and Codes
|
| 314 |
+
|
| 315 |
+
### B.2.1 Encapsulated Application Information
|
| 316 |
+
|
| 317 |
+
#### B.2.1.1 General Layout
|
| 318 |
+
|
| 319 |
+
The general layout of the Encapsulated Application Information field of the Application Transport parameter as defined in ITU-T Recommendation Q.1902.3 [8] is shown in Table B.2.1.1.1.
|
| 320 |
+
|
| 321 |
+
**Table B.2.1.1.1: Encapsulated application information field**
|
| 322 |
+
|
| 323 |
+
| MSB | | | | | | | | LSB | | Octet |
|
| 324 |
+
|-----------------------------|---|---|---|---|---|---|---|-----|--|-------|
|
| 325 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | |
|
| 326 |
+
| Identifier 1 | | | | | | | | | | 1 |
|
| 327 |
+
| Length indicator 1 | | | | | | | | | | 2 |
|
| 328 |
+
| Compatibility information 1 | | | | | | | | | | 3 |
|
| 329 |
+
| Contents 1 | | | | | | | | | | 4 |
|
| 330 |
+
| | | | | | | | | | | |
|
| 331 |
+
| Identifier n | | | | | | | | | | m |
|
| 332 |
+
| Length indicator n | | | | | | | | | | |
|
| 333 |
+
| Compatibility information n | | | | | | | | | | |
|
| 334 |
+
| Contents n | | | | | | | | | | p |
|
| 335 |
+
|
| 336 |
+
Each information element within the Encapsulated Application Information field has the same structure. An information element consists of four fields which always appear in the following order: Identifier (one octet), Length indicator, Compatibility information, Contents.
|
| 337 |
+
|
| 338 |
+
The Identifier distinguishes one type from another one and governs the interpretation of the contents. There are two types of Identifiers: type "constructor" and type "simple", for which the contents are defined as follows:
|
| 339 |
+
|
| 340 |
+
- For a "constructor" type, the Contents field shall again consist of one or more information elements, each of which is structured as described above, i.e., Identifier, Length indicator, Compatibility information, Contents.
|
| 341 |
+
- For a "simple" type, the Contents field contains one value only.
|
| 342 |
+
|
| 343 |
+
When passing on an information element of type "constructor", the order of the information elements within this "constructor" shall be maintained.
|
| 344 |
+
|
| 345 |
+
The Length indicator specifies the length (i.e., integral number of octets in pure binary representation) of the Compatibility information and Contents. The length does not include the Identifier nor the Length indicator.
|
| 346 |
+
|
| 347 |
+
The format of the Length indicator is shown in Table B.2.1.1.2. Bit 8 is defined as Extension indicator and indicates whether or not the information on the length continues through the next octet. Value "0" of the Extension indicator means "*information continues through the next octet*", while value "1" means "*last octet*". The Length indicator itself has a maximum length of 2 octets, i.e., if octet 1a is needed, the Extension indicator of octet 1a is always set to value "1".
|
| 348 |
+
|
| 349 |
+
**Table B.2.1.1.2: Length indicator**
|
| 350 |
+
|
| 351 |
+
| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet |
|
| 352 |
+
|--------|---|---|---|-----|---|---|---|-----|-------|
|
| 353 |
+
| ext. | | | | | | | | LSB | 1 |
|
| 354 |
+
| ext. 1 | 0 | 0 | 0 | MSB | | | | | 1a |
|
| 355 |
+
|
| 356 |
+
The Compatibility information contains corresponding instructions for the case that the received information element is unrecognised. The format of this field is shown in Table B.2.1.1.3.
|
| 357 |
+
|
| 358 |
+
**Table B.2.1.1.3: Compatibility information**
|
| 359 |
+
|
| 360 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet |
|
| 361 |
+
|------|-----------------------------|-----------------------|----------------|-----------------------------|-----------------------|---|---|-------|
|
| 362 |
+
| ext. | pass-on not possible | | general action | | | | | 1 |
|
| 363 |
+
| | send notification indicator | instruction indicator | reserved | send notification indicator | instruction indicator | | | |
|
| 364 |
+
|
| 365 |
+
The following codes are used in the subfields of the Compatibility information field.
|
| 366 |
+
|
| 367 |
+
Bits 2 1 *Instruction indicator for general action*
|
| 368 |
+
|
| 369 |
+
0 0 Pass on information element
|
| 370 |
+
|
| 371 |
+
0 1 Discard information element
|
| 372 |
+
|
| 373 |
+
1 0 Discard MST data
|
| 374 |
+
|
| 375 |
+
1 1 Release call
|
| 376 |
+
|
| 377 |
+
Bit 3 *Send notification indicator for general action*
|
| 378 |
+
|
| 379 |
+
0 Do not send notification
|
| 380 |
+
|
| 381 |
+
1 Send notification
|
| 382 |
+
|
| 383 |
+
Bit 4 reserved
|
| 384 |
+
|
| 385 |
+
Bits 6 5 *Instruction indicator for pass-on not possible*
|
| 386 |
+
|
| 387 |
+
0 0 Release call
|
| 388 |
+
|
| 389 |
+
0 1 Discard information element
|
| 390 |
+
|
| 391 |
+
1 0 Discard MST data
|
| 392 |
+
|
| 393 |
+
1 1 reserved (interpreted as 00)
|
| 394 |
+
|
| 395 |
+
Bit 7 *Send notification indicator for pass-on not possible*
|
| 396 |
+
|
| 397 |
+
0 Do not send notification
|
| 398 |
+
|
| 399 |
+
1 Send notification
|
| 400 |
+
|
| 401 |
+
Bit 8 *Extension indicator*
|
| 402 |
+
|
| 403 |
+
- 0 Information continues through the next octet
|
| 404 |
+
- 1 Last octet
|
| 405 |
+
|
| 406 |
+
The Contents field is the substance of the element and contains the information the element is intended to convey.
|
| 407 |
+
|
| 408 |
+
#### B.2.1.2 List of Identifiers
|
| 409 |
+
|
| 410 |
+
Table B.2.1.2.1 contains the list of Identifiers.
|
| 411 |
+
|
| 412 |
+
**Table B.2.1.2.1: List of identifiers**
|
| 413 |
+
|
| 414 |
+
| Value | Information element name | Type | Reference |
|
| 415 |
+
|------------------------------|-----------------------------------|--------|-----------|
|
| 416 |
+
| 0000 0000 | spare | - | |
|
| 417 |
+
| 0000 0001 | Mobile Equipment Identifier | simple | B.2.1.3 |
|
| 418 |
+
| 0000 0010 | LCLS Negotiation Request | simple | B.2.1.4 |
|
| 419 |
+
| 0000 0011 | LCLS Negotiation Response | simple | B.2.1.5 |
|
| 420 |
+
| 0000 0100 | LCLS Status | simple | B.2.1.6 |
|
| 421 |
+
| 0000 0101 | LCLS Status Change | simple | B.2.1.7 |
|
| 422 |
+
| 0000 0110 | LCLS Status Result | simple | B.2.1.8 |
|
| 423 |
+
| 0000 0111 | LCLS Global Call Reference | simple | B.2.1.9 |
|
| 424 |
+
| 0000 1000 | LCLS Configuration Preference | simple | B.2.1.10 |
|
| 425 |
+
| 0000 1001 | LCLS Configuration Change Request | simple | B.2.1.11 |
|
| 426 |
+
| 0000 1010 | LCLS Configuration Change Result | simple | B.2.1.12 |
|
| 427 |
+
| 0000 1011<br>to<br>1101 1111 | reserved for 3GPP use | - | |
|
| 428 |
+
| 1110 0000<br>to<br>1111 1111 | reserved for national use | - | |
|
| 429 |
+
|
| 430 |
+
#### B.2.1.3 Mobile Equipment Identifier
|
| 431 |
+
|
| 432 |
+
The format of the Mobile Equipment Identifier is shown in Table B.2.1.3.1.
|
| 433 |
+
|
| 434 |
+
**Table B.2.1.3.1: Mobile Equipment Identifier**
|
| 435 |
+
|
| 436 |
+
| MSB | | | | | | | | LSB | | | | | | | | Octet |
|
| 437 |
+
|-----------------------------|---|---|---|---|---|---|---|-----|---|---|---|---|---|---|---|-------|
|
| 438 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 439 |
+
| Mobile Equipment Identifier | | | | | | | | | | | | | | | | 1 |
|
| 440 |
+
| | | | | | | | | | | | | | | | | ... |
|
| 441 |
+
| | | | | | | | | | | | | | | | | x |
|
| 442 |
+
|
| 443 |
+
The MEI contains either the International Mobile station Equipment Identity (IMEI) or the International Mobile station Equipment Identity and Software Version Number (IMEISV) as defined in subclause 6.2 of 3GPP TS 23.003 [25].
|
| 444 |
+
|
| 445 |
+
Both IMEI and IMEISV are TBCD encoded where IMEI is 15 digits and IMEISV is 16 digits. Bits 5 to 8 of octet n+1 (where n represents the octet of the IMEI(SV) being encoded) encodes digit 2n, bits 1 to 4 of octet n+1 encodes digit 2n-1 (i.e. the order of digits is swapped in each octet compared to the digit order defined in 3GPP TS 23.003 [25]). For IMEI, bits 5 to 8 of the last octet shall be filled with an end mark coded as '1111'.
|
| 446 |
+
|
| 447 |
+
For the use of the Mobile Equipment Identifier (MEI) see 3GPP TS 23.216 [26] and 3GPP TS 23.237 [27].
|
| 448 |
+
|
| 449 |
+
#### B.2.1.4 LCLS Negotiation Request
|
| 450 |
+
|
| 451 |
+
The format of the LCLS Negotiation Request is shown in Table B.2.1.4.1.
|
| 452 |
+
|
| 453 |
+
**Table B.2.1.4.1: LCLS Negotiation Request**
|
| 454 |
+
|
| 455 |
+
| MSB | | | | | | | LSB | | |
|
| 456 |
+
|---------------------|-------|---|---|---|---|----------------------|-----|--|---------|
|
| 457 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | |
|
| 458 |
+
| Extension Indicator | Spare | | | | | Permission Indicator | | | Octet 1 |
|
| 459 |
+
|
| 460 |
+
The LCLS Negotiation Request is sent in the forward direction to indicate LCLS usage permission.
|
| 461 |
+
|
| 462 |
+
##### Bit 1 2 **Permission Indicator**
|
| 463 |
+
|
| 464 |
+
| | |
|
| 465 |
+
|---------|-------------------------|
|
| 466 |
+
| 00 | LCLS is allowed |
|
| 467 |
+
| 01 | LCLS is not allowed |
|
| 468 |
+
| 10 – 11 | Reserved for future use |
|
| 469 |
+
|
| 470 |
+
Bit 3 - 7 Spare
|
| 471 |
+
|
| 472 |
+
##### Bit 8 **Extension Indicator**
|
| 473 |
+
|
| 474 |
+
| | |
|
| 475 |
+
|---|-------------------------------------|
|
| 476 |
+
| 0 | information continues in next octet |
|
| 477 |
+
| 1 | last octet |
|
| 478 |
+
|
| 479 |
+
For the use of the LCLS Negotiation Request IE see Annex C.2.1 and 3GPP TS 23.284 [29].
|
| 480 |
+
|
| 481 |
+
#### B.2.1.5 LCLS Negotiation Response
|
| 482 |
+
|
| 483 |
+
The format of the LCLS Negotiation Response is shown in Table B.2.1.5.1.
|
| 484 |
+
|
| 485 |
+
**Table B.2.1.5.1: LCLS Negotiation Response**
|
| 486 |
+
|
| 487 |
+
| MSB | | | | | | | LSB | | |
|
| 488 |
+
|-------|---|---|---|---|----------------------|---|-----|--|---------|
|
| 489 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | |
|
| 490 |
+
| Spare | | | | | Permission Indicator | | | | Octet 1 |
|
| 491 |
+
|
| 492 |
+
The LCLS Negotiation Response contains information sent in the backwards direction to indicate result of the LCLS Negotiation Request. The LCLS Negotiation Response is coded as follows:
|
| 493 |
+
|
| 494 |
+
##### Bits 1 2 **Permission Indicator**
|
| 495 |
+
|
| 496 |
+
| | |
|
| 497 |
+
|----|--------------------------------------------|
|
| 498 |
+
| 00 | LCLS is allowed |
|
| 499 |
+
| 01 | LCLS is not allowed |
|
| 500 |
+
| 10 | LCLS is not supported by a subsequent node |
|
| 501 |
+
| 11 | spare |
|
| 502 |
+
|
| 503 |
+
Bits 3 - 8 Spare
|
| 504 |
+
|
| 505 |
+
For the use of the LCLS Negotiation Response IE see Annex C.2.2 and 3GPP TS 23.284 [29].
|
| 506 |
+
|
| 507 |
+
#### B.2.1.6 LCLS Status
|
| 508 |
+
|
| 509 |
+
The format of the LCLS Status is shown in Table B.2.1.6.1.
|
| 510 |
+
|
| 511 |
+
**Table B.2.1.6.1: LCLS Status**
|
| 512 |
+
|
| 513 |
+
| • MSB | | | | | | | | • LSB | Octet |
|
| 514 |
+
|-------------|---|---|---|---|---|---|---|-------|-------|
|
| 515 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | |
|
| 516 |
+
| LCLS Status | | | | | | | | | 1 |
|
| 517 |
+
|
| 518 |
+
The LCLS Status contains information sent in forward and backward directions to indicate LCLS connection status. The LCLS Status is coded as follows:
|
| 519 |
+
|
| 520 |
+
| Value | Meaning |
|
| 521 |
+
|-----------|----------------------------------------|
|
| 522 |
+
| 0000 0000 | no indication |
|
| 523 |
+
| 0000 0001 | LCLS is feasible but not yet connected |
|
| 524 |
+
| 0000 0010 | LCLS not connected |
|
| 525 |
+
| 0000 0011 | LCLS connected |
|
| 526 |
+
|
| 527 |
+
All other values are reserved.
|
| 528 |
+
|
| 529 |
+
For the use of the LCLS Status IE see Annex C.2.3, C.2.5 and 3GPP TS 23.284 [29].
|
| 530 |
+
|
| 531 |
+
#### B.2.1.7 LCLS Status Change
|
| 532 |
+
|
| 533 |
+
The format of the LCLS Status Change is shown in Table B.2.1.7.1.
|
| 534 |
+
|
| 535 |
+
**Table B.2.1.7.1: LCLS Status Change**
|
| 536 |
+
|
| 537 |
+
| MSB | | | | | | | | LSB | Octet |
|
| 538 |
+
|--------------------|---|---|---|---|---|---|---|-----|-------|
|
| 539 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | |
|
| 540 |
+
| LCLS Status Change | | | | | | | | | 1 |
|
| 541 |
+
|
| 542 |
+
The LCLS Status Change Identifier contains information sent in forward and backward directions to indicate requested change of LCLS connection status. The LCLS Status Change Identifier is coded as follows:
|
| 543 |
+
|
| 544 |
+
| Value | Meaning |
|
| 545 |
+
|-----------|---------------------------------------------|
|
| 546 |
+
| 0000 0000 | LCLS connection preparation |
|
| 547 |
+
| 0000 0001 | LCLS disconnection preparation |
|
| 548 |
+
| 0000 0010 | LCLS disconnection preparation for Handover |
|
| 549 |
+
|
| 550 |
+
All other values are reserved.
|
| 551 |
+
|
| 552 |
+
For the use of the LCLS Status Change IE see Annex C.2.6 and 3GPP TS 23.284 [29].
|
| 553 |
+
|
| 554 |
+
#### B.2.1.8 LCLS Status Result
|
| 555 |
+
|
| 556 |
+
The format of the LCLS Status Result is shown in Table B.2.1.8.1.
|
| 557 |
+
|
| 558 |
+
**Table B.2.1.8.1: LCLS Status Result**
|
| 559 |
+
|
| 560 |
+
| MSB | | | LSB | | | | | Octet |
|
| 561 |
+
|-------|---|---|---------------------|---|---|----------------------|---|-------|
|
| 562 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 563 |
+
| Spare | | | Rejection Indicator | | | Acceptance Indicator | | 1 |
|
| 564 |
+
|
| 565 |
+
The LCLS Status Result contains information sent in forward and backward directions to indicate result of the LCLS Status Change Request. The LCLS Status Result is coded as follows:
|
| 566 |
+
|
| 567 |
+
##### **Bit 1 Acceptance Indicator**
|
| 568 |
+
|
| 569 |
+
| | |
|
| 570 |
+
|---|-------------------------------------|
|
| 571 |
+
| 0 | LCLS Status Change request accepted |
|
| 572 |
+
| 1 | LCLS Status Change request rejected |
|
| 573 |
+
|
| 574 |
+
##### **Bits 2 3 4 5 Rejection Indicator**
|
| 575 |
+
|
| 576 |
+
| | |
|
| 577 |
+
|-------------|-------------------------------|
|
| 578 |
+
| 0000 | No indication |
|
| 579 |
+
| 0001 | Ongoing supplementary service |
|
| 580 |
+
| 0010 – 1111 | Reserved for future use |
|
| 581 |
+
|
| 582 |
+
Bits 6 - 8 Spare
|
| 583 |
+
|
| 584 |
+
For the use of the LCLS Status Result IE see Annex C.2.6 and 3GPP TS 23.284 [29].
|
| 585 |
+
|
| 586 |
+
#### B.2.1.9 LCLS Global Call Reference
|
| 587 |
+
|
| 588 |
+
The format of the LCLS Global Call Reference (GCR) is shown in Table B.2.1.9.1.
|
| 589 |
+
|
| 590 |
+
**Table B.2.1.9.1: LCLS Global Call Reference**
|
| 591 |
+
|
| 592 |
+
| MSB | | | LSB | | | | | Octet |
|
| 593 |
+
|------------------------------------|---|---|-----|---|---|---|---|---------------|
|
| 594 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 595 |
+
| Network ID length indicator | | | | | | | | 1 |
|
| 596 |
+
| Network ID | | | | | | | | 2 |
|
| 597 |
+
| (variable length 3 – 5 octets) | | | | | | | | 4+m (m=0,1,2) |
|
| 598 |
+
| Node ID length indicator | | | | | | | | 5+m |
|
| 599 |
+
| Node ID | | | | | | | | 6+m |
|
| 600 |
+
| (fixed length: 2 octets) | | | | | | | | 7+m |
|
| 601 |
+
| Call Reference ID length indicator | | | | | | | | 8+m |
|
| 602 |
+
| | | | | | | | | 9+m |
|
| 603 |
+
| Call Reference ID | | | | | | | | |
|
| 604 |
+
| (fixed length: 5 octets) | | | | | | | | 13+m |
|
| 605 |
+
|
| 606 |
+
The LCLS GCR is information sent in forward direction to uniquely identify a call and correlate activities associated with that call. The LCLS GCR is coded as follows:
|
| 607 |
+
|
| 608 |
+
- Network ID length indicator
|
| 609 |
+
Binary coded information indicating the number of octets in the Network ID field.
|
| 610 |
+
- Network ID
|
| 611 |
+
Information identifying a network. The Network ID field is specified in ITU-T Recommendation Q.1902.3 [8].
|
| 612 |
+
- Node ID length Indicator
|
| 613 |
+
Binary coded information indicating the number of octets in the Node ID field.
|
| 614 |
+
|
| 615 |
+
- Node ID
|
| 616 |
+
A binary number that uniquely identifies within the network the node which generates the call reference.
|
| 617 |
+
- Call Reference ID length indicator
|
| 618 |
+
Binary coded information indicating the number of octets in the Call Reference ID field.
|
| 619 |
+
- Call Reference ID
|
| 620 |
+
A binary number used for the call reference of the call. It is generated by the originating serving node for each call.
|
| 621 |
+
|
| 622 |
+
NOTE: If the originating serving radio access is GERAN the format of the Call Reference ID subfield is shown in Table B.2.1.9.2. The originating BSS ID is an integer that uniquely identifies the Base Station Subsystem (BSS) Node within an operator's network.
|
| 623 |
+
|
| 624 |
+
**Table B.2.1.9.2: Call Reference ID**
|
| 625 |
+
|
| 626 |
+
| MSB | | | | | | | | LSB | | | | | | | | Octet |
|
| 627 |
+
|------------------------------------------------|---|---|---|---|---|---|---|-----|---|---|---|---|---|---|---|-------|
|
| 628 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 629 |
+
| Call Identifier<br>(fixed length: 3 octets) | | | | | | | | | | | | | | | | 1 |
|
| 630 |
+
| | | | | | | | | | | | | | | | | 2 |
|
| 631 |
+
| | | | | | | | | | | | | | | | | 3 |
|
| 632 |
+
| Originating BSS ID<br>(fixed length: 2 octets) | | | | | | | | | | | | | | | | 4 |
|
| 633 |
+
| | | | | | | | | | | | | | | | | 5 |
|
| 634 |
+
|
| 635 |
+
For the use of the LCLS GCR IE see Annex C.2.1 and 3GPP TS 23.284 [29].
|
| 636 |
+
|
| 637 |
+
#### B.2.1.10 LCLS Configuration Preference
|
| 638 |
+
|
| 639 |
+
The format of the LCLS Configuration Preference is shown in Table B.2.1.10.1.
|
| 640 |
+
|
| 641 |
+
**Table B.2.1.10.1: LCLS Configuration Preference**
|
| 642 |
+
|
| 643 |
+
| MSB | | | | LSB | | | | Octet |
|
| 644 |
+
|---------------------|-------|---|---|-----------------------------------|----------------------------------|---------------------------------|--------------------------------|-------|
|
| 645 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 646 |
+
| Extension Indicator | Spare | | | Backward Data Reception Indicator | Forward Data Reception Indicator | Backward Data Sending Indicator | Forward Data Sending Indicator | 1 |
|
| 647 |
+
|
| 648 |
+
The LCLS Configuration Preference contains information sent in forward and backward directions to indicate negotiated LCLS configuration preference.
|
| 649 |
+
|
| 650 |
+
##### Bit 1 Forward Data Sending Indicator
|
| 651 |
+
|
| 652 |
+
0 not required
|
| 653 |
+
1 required
|
| 654 |
+
|
| 655 |
+
##### Bit 2 Backward Data Sending Indicator
|
| 656 |
+
|
| 657 |
+
0 not required
|
| 658 |
+
1 required
|
| 659 |
+
|
| 660 |
+
##### Bit 3 Forward Data Reception Indicator
|
| 661 |
+
|
| 662 |
+
0 not required
|
| 663 |
+
1 required
|
| 664 |
+
|
| 665 |
+
##### Bit 4 Backward Data Reception Indicator
|
| 666 |
+
|
| 667 |
+
0 not required
|
| 668 |
+
1 required
|
| 669 |
+
|
| 670 |
+
Bits 5 - 7 Spare
|
| 671 |
+
|
| 672 |
+
**Bit 8 Extension Indicator**
|
| 673 |
+
0 information continues in next octet
|
| 674 |
+
1 last octet
|
| 675 |
+
|
| 676 |
+
For the use of the LCLS Configuration Preference IE see Annex C.2.1, C.2.2, C.2.4 and 3GPP TS 23.284 [29].
|
| 677 |
+
|
| 678 |
+
#### B.2.1.11 LCLS Configuration Change Request
|
| 679 |
+
|
| 680 |
+
The format of the LCLS Configuration Change Request is shown in Table B.2.1.11.1.
|
| 681 |
+
|
| 682 |
+
**Table B.2.1.11.1: LCLS Configuration Change Request**
|
| 683 |
+
|
| 684 |
+
| MSB | LSB | | | | | | | Octet |
|
| 685 |
+
|---------------------|-------|---|---|---|---|---|------|-------|
|
| 686 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 687 |
+
| Extension Indicator | Spare | | | | | | Type | 1 |
|
| 688 |
+
|
| 689 |
+
The LCLS Configuration Change Request contains information sent in the forward and backward directions to indicate type of LCLS Configuration Change Request.
|
| 690 |
+
|
| 691 |
+
**Bit 1 2 Type**
|
| 692 |
+
00 LCLS Configuration Preference Modification Request
|
| 693 |
+
01 - 11 Spare
|
| 694 |
+
|
| 695 |
+
Bit 3 - 7 Spare
|
| 696 |
+
|
| 697 |
+
**Bit 8 Extension Indicator**
|
| 698 |
+
0 information continues in next octet
|
| 699 |
+
1 last octet
|
| 700 |
+
|
| 701 |
+
For the use of the LCLS Configuration Change Request IE see Annex C.2.4 and 3GPP TS 23.284 [29].
|
| 702 |
+
|
| 703 |
+
#### B.2.1.12 LCLS Configuration Change Result
|
| 704 |
+
|
| 705 |
+
The format of the LCLS Configuration Change Result is shown in Table B.2.1.12.1.
|
| 706 |
+
|
| 707 |
+
**Table B.2.1.12.1: LCLS Configuration Change Result**
|
| 708 |
+
|
| 709 |
+
| MSB | | | | | | | LSB | Octet |
|
| 710 |
+
|-------|---|---------------------|---|---|---|---|----------------------|-------|
|
| 711 |
+
| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
|
| 712 |
+
| Spare | | Rejection Indicator | | | | | Acceptance Indicator | 1 |
|
| 713 |
+
|
| 714 |
+
The LCLS Configuration Change Result contains information sent in the backward direction to indicate result of the LCLS Configuration Change Request. The LCLS Configuration Change Result is coded as follows:
|
| 715 |
+
|
| 716 |
+
**Bit 1 Acceptance Indicator**
|
| 717 |
+
0 LCLS Configuration Change request accepted
|
| 718 |
+
1 LCLS Configuration Change request rejected (if set then Rejection Indicator provides further details)
|
| 719 |
+
|
| 720 |
+
**Bits 2 3 4 5 Rejection Indicator**
|
| 721 |
+
|
| 722 |
+
| | |
|
| 723 |
+
|-------------|--------------------------------------------|
|
| 724 |
+
| 0000 | No indication |
|
| 725 |
+
| 0001 | Requested LCLS configuration not supported |
|
| 726 |
+
| 0010 | Ongoing supplementary service |
|
| 727 |
+
| 0011 – 1111 | Reserved for future use |
|
| 728 |
+
| Bits 6 - 8 | Spare |
|
| 729 |
+
|
| 730 |
+
For the use of the LCLS Configuration Change Result IE see Annex C.2.4 and 3GPP TS 23.284 [29].
|
| 731 |
+
|
| 732 |
+
### B.2.2 Application Transport Instruction Indicators
|
| 733 |
+
|
| 734 |
+
For the MST service the Application Transport Instruction Indicators (ATII) shall be set as follows:
|
| 735 |
+
|
| 736 |
+
| | | |
|
| 737 |
+
|------|---|------------------------------------------|
|
| 738 |
+
| Bits | 1 | <i>Release call indicator (RCI)</i> |
|
| 739 |
+
| | 0 | do not release call |
|
| 740 |
+
| Bit | 2 | <i>Send notification indicator (SNI)</i> |
|
| 741 |
+
| | 0 | do not send notification |
|
| 742 |
+
|
| 743 |
+
# --- Annex C (normative): LCLS Service Application
|
| 744 |
+
|
| 745 |
+
LCLS Service is defined in 3GPP TS 23.284 [29] and is dependent on the following identifiers being included in BICC/ISUP messaging. The following sections describe the detailed protocol behaviour when these identifiers are included.
|
| 746 |
+
|
| 747 |
+
## --- C.1 Use of MST ASE
|
| 748 |
+
|
| 749 |
+
LCLS service makes use of the services of the MST ASE described in Annex B. The services of the MST ASE are accessed by means of primitives (such as "MST\_data") which are the same as BAT ASE primitives defined in ITU-T Recommendation Q.765.5 [5].
|
| 750 |
+
|
| 751 |
+
## --- C.2 Procedures
|
| 752 |
+
|
| 753 |
+
### C.2.1 Indication of LCLS Capability
|
| 754 |
+
|
| 755 |
+
#### C.2.1.1 LCLS Service Capability Indication
|
| 756 |
+
|
| 757 |
+
LCLS service shall be used for a call if MST\_data primitive associated with an IAM includes LCLS Information Elements: a LCLS GCR, a LCLS Negotiation Request and a LCLS Configuration Preference. The absence of the LCLS Negotiation, the LCLS Configuration Preference and the LCLS GCR Information Elements in the IAM specifies that the LCLS service shall not be used.
|
| 758 |
+
|
| 759 |
+
The compatibility information of the LCLS Negotiation Request, the LCLS Configuration Preference and the LCLS GCR Information Elements shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service.
|
| 760 |
+
|
| 761 |
+
The procedures for call establishment using the LCLS service are described in 3GPP TS 23.284 [29].
|
| 762 |
+
|
| 763 |
+
#### C.2.1.2 Actions at Originating Serving Node
|
| 764 |
+
|
| 765 |
+
An originating Serving Node (SN) that supports the LCLS service shall indicate this within the IAM message of the mobile originating call by including the LCLS Negotiation Request, the LCLS Configuration Preference and the LCLS GCR Information Elements within the MST Application Transport Parameter (APP) within the IAM.
|
| 766 |
+
|
| 767 |
+
When the LCLS service is allowed to be used the IAM is sent to the succeeding node with the Permission Indicator of the LCLS Negotiation Request Information Element set to "LCLS is allowed".
|
| 768 |
+
|
| 769 |
+
Depending on network requirements the originating SN may additionally indicate required configurations for user plane connectivity towards originating or terminating UE within the LCLS Configuration Preference Information Element. If the originating MSC server needs to:
|
| 770 |
+
|
| 771 |
+
- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required";
|
| 772 |
+
- send data towards the originating UE it shall set Backward Data Sending Indicator to "required";
|
| 773 |
+
- receive data from the originating UE it shall set Forward Data Reception Indicator to "required";
|
| 774 |
+
- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required".
|
| 775 |
+
|
| 776 |
+
The originating SN shall perform the setting of LCLS Configuration Preference Information Element according to rules specified in sub-clause 4.2 of 3GPP TS 23.284 [29] or it may determine that LCLS is not allowed and indicate this by setting the value of Permission Indicator of the LCLS Negotiation Request Information Element to "LCLS is not allowed".
|
| 777 |
+
|
| 778 |
+
#### C.2.1.3 Actions at Intermediate Serving Node
|
| 779 |
+
|
| 780 |
+
For the intermediate Serving Node (SN), LCLS service indication (i.e. LCLS GCR, LCLS Negotiation Request and LCLS Configuration Preference Information Elements) shall be included only if received from the preceding node and if the node itself supports the LCLS service.
|
| 781 |
+
|
| 782 |
+
The intermediate SN shall not change the LCLS GCR Information Element. If the intermediate SN receives Permission Indicator of the LCLS Negotiation Request Information Element set to "LCLS is not allowed" it shall not change it.
|
| 783 |
+
|
| 784 |
+
Depending on network requirements the intermediate SN may additionally indicate required configurations for user plane connectivity towards originating or terminating UE by changing the received LCLS Configuration Preference Information Element. If the intermediate SN needs to:
|
| 785 |
+
|
| 786 |
+
- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required";
|
| 787 |
+
- send data towards the originating UE it shall set Backward Data Sending Indicator to "required";
|
| 788 |
+
- receive data from the originating UE it shall set Forward Data Reception Indicator to "required";
|
| 789 |
+
- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required".
|
| 790 |
+
|
| 791 |
+
If the intermediate SN receives any of these indicators set to "required" it shall not change them.
|
| 792 |
+
|
| 793 |
+
#### C.2.1.4 Actions at Destination Serving Node
|
| 794 |
+
|
| 795 |
+
For the destination Serving Node (SN), LCLS service shall be supported only if the IAM with the LCLS Negotiation Request, LCLS Configuration Preference and LCLS GCR Information Elements within the MST Application Transport Parameter (APP) is received from the preceding node and if the node itself supports the LCLS service.
|
| 796 |
+
|
| 797 |
+
Depending on network requirements the destination SN may additionally modify received configurations for user plane connectivity towards originating or terminating UE, by changing the settings of the LCLS Configuration Preference Information Element. If the destination SN needs to:
|
| 798 |
+
|
| 799 |
+
- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required";
|
| 800 |
+
- send data towards the originating UE it shall set Backward Data Sending Indicator to "required";
|
| 801 |
+
- receive data from the originating UE it shall set Forward Data Reception Indicator to "required";
|
| 802 |
+
|
| 803 |
+
- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required".
|
| 804 |
+
|
| 805 |
+
If the destination SN receives any of these indicators set to "required" it shall not change them.
|
| 806 |
+
|
| 807 |
+
The destination SN shall perform modification of LCLS Configuration Preference Information Element according to rules specified in sub-clause 4.2 of 3GPP TS 23.284 [29] or it may determine that LCLS is not allowed and shall indicate this by setting the value of Permission Indicator of the LCLS Negotiation Response Information Element to "LCLS is not allowed".
|
| 808 |
+
|
| 809 |
+
### C.2.2 Backward LCLS Negotiation during Call Setup
|
| 810 |
+
|
| 811 |
+
#### C.2.2.1 Introduction
|
| 812 |
+
|
| 813 |
+
LCLS service shall be used for a call if MST\_data primitive associated with first backward (APM or ACM) message includes a LCLS Negotiation Response and a LCLS Configuration Preference Information Elements. The absence of the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements in the first backward message specifies that the LCLS service shall not be used.
|
| 814 |
+
|
| 815 |
+
The compatibility information of the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service.
|
| 816 |
+
|
| 817 |
+
#### C.2.2.2 Actions at Destination Serving Node
|
| 818 |
+
|
| 819 |
+
If LCLS service is supported according to conditions specified in sub-clause C.2.1.4 a destination SN shall include in the first backward message (APM or ACM) the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements in the MST\_Data request primitive.
|
| 820 |
+
|
| 821 |
+
#### C.2.2.3 Actions at Intermediate Serving Node
|
| 822 |
+
|
| 823 |
+
If LCLS service is supported according to conditions specified in sub-clause C.2.1.3 but a succeeding node does not return LCLS Negotiation Response Information Element in the first backward message, an Intermediate SN shall include the LCLS Negotiation Response Information Element. The Permission Indicator of the LCLS Negotiation Response Information Element shall be set to "LCLS is not supported by a subsequent node".
|
| 824 |
+
|
| 825 |
+
On receipt of a backward message (APM, ACM or CPG) with the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements the Intermediate SN shall store the LCLS configuration settings from the LCLS Configuration Preference Information Element and shall forward the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements unchanged.
|
| 826 |
+
|
| 827 |
+
#### C.2.2.4 Actions at Originating Serving Node
|
| 828 |
+
|
| 829 |
+
If the first backward message does not contain the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements the originating SN shall assume that LCLS is not supported by succeeding node and LCLS shall not be performed for that call; no further LCLS signalling shall take place for that call.
|
| 830 |
+
|
| 831 |
+
If the first backward message contains the LCLS Negotiation Response Information Element but the Permission Indicator is set to "LCLS Not Allowed" or "LCLS is not supported by a subsequent node" then the originating SN shall not request establishment of the LCLS connection at this time.
|
| 832 |
+
|
| 833 |
+
NOTE: A subsequent LCLS Negotiation Response Information Element can be received from succeeding nodes, e.g. in the event of a call forwarding on no reply.
|
| 834 |
+
|
| 835 |
+
### C.2.3 Answer message
|
| 836 |
+
|
| 837 |
+
#### C.2.3.1 Introduction
|
| 838 |
+
|
| 839 |
+
LCLS connection may be established for a call if MST\_data primitive associated with an ANM includes a LCLS Status Identifier Information Element. The absence of the LCLS Status Identifier Information Element in the ANM specifies that the LCLS connection shall not be requested.
|
| 840 |
+
|
| 841 |
+
The compatibility information of the LCLS Status Identifier shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service.
|
| 842 |
+
|
| 843 |
+
#### C.2.3.2 Actions at Destination Serving Node
|
| 844 |
+
|
| 845 |
+
If a destination SN determines that LCLS service is feasible according to the conditions specified in sub-clause 6.2.1.3.4 of 3GPP TS 23.284 [29] it shall include the LCLS Status Identifier Information Element set to "LCLS feasible but not yet connected" within the MST Application Transport Parameter (APP) within the ANM.
|
| 846 |
+
|
| 847 |
+
#### C.2.3.3 Actions at Intermediate Serving Node
|
| 848 |
+
|
| 849 |
+
An Intermediate SN shall pass the LCLS Status Identifier within the ANM unchanged.
|
| 850 |
+
|
| 851 |
+
#### C.2.3.4 Actions at Originating Serving Node
|
| 852 |
+
|
| 853 |
+
When an originating SN receives an ANM with the LCLS Status Identifier indicating the LCLS service is feasible it shall request LCLS connection.
|
| 854 |
+
|
| 855 |
+
### C.2.4 LCLS Configuration Change Request
|
| 856 |
+
|
| 857 |
+
#### C.2.4.1 Introduction
|
| 858 |
+
|
| 859 |
+
Modification of a LCLS configuration can only occur after the LCLS negotiation has been performed during the call set-up phase according to the procedures described in sub-clauses C.2.1 and C.2.2. A SN involved in a LCLS Configuration Change procedure must not initiate a new LCLS Configuration Change Request until the existing LCLS Configuration Change procedure has been completed.
|
| 860 |
+
|
| 861 |
+
A LCLS Configuration Change Request message may be sent in either direction and at any time during the active phase of a call, after the LCLS negotiation has been performed during the call establishment. A LCLS Configuration Change Request and a LCLS Configuration Preference Information Elements indicating the requested change of the LCLS configuration shall be included in a MST\_data primitive, corresponding to an APM message.
|
| 862 |
+
|
| 863 |
+
A MST\_Data primitive, corresponding to the APM message shall be issued in response, including the LCLS Configuration Preference and the LCLS Configuration Change Result Information Elements indicating if the requested change of LCLS configuration has been accepted and if it has not been accepted the reason for rejection.
|
| 864 |
+
|
| 865 |
+
The compatibility information of the LCLS Configuration Preference, the LCLS Configuration Change Request and LCLS Configuration Change Result Information Elements shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service.
|
| 866 |
+
|
| 867 |
+
NOTE: The term "initiating" SN in the following clauses refers to a SN which initiates the LCLS Configuration Change Request. The term "terminating" SN in the following clauses refers to a SN which terminates the LCLS Configuration Change Request.
|
| 868 |
+
|
| 869 |
+
#### C.2.4.2 Actions at Initiating Serving Node
|
| 870 |
+
|
| 871 |
+
If a SN determines that LCLS configuration needs to be changed it may send an APM message which includes a LCLS Configuration Change Request and the LCLS Configuration Preference Information Elements to its succeeding and/or preceding node. The initiating SN shall set the desired configurations as described in sub-clause C.2.1.2.
|
| 872 |
+
|
| 873 |
+
The LCLS Configuration Change Request may only be initiated if LCLS Negotiation was performed during call establishment.
|
| 874 |
+
|
| 875 |
+
NOTE: this does not require that LCLS was permitted during the call establishment.
|
| 876 |
+
|
| 877 |
+
On receipt of an APM message containing the LCLS Configuration Preference and the LCLS Configuration Change Result Information Elements, if the result indicates "accepted" the modification of the LCLS Configuration settings has been successful. If the LCLS Configuration Change Result Information Element indicates "rejected" the initiating SN shall resume the LCLS connection with the LCLS configuration unchanged.
|
| 878 |
+
|
| 879 |
+
#### C.2.4.3 Actions at Intermediate Serving Node
|
| 880 |
+
|
| 881 |
+
When an intermediate SN receives an APM message with the LCLS Configuration Change Request and the LCLS Configuration Preference Information Elements requesting a certain LCLS Configuration Change the intermediate SN shall check if it can support the requested LCLS configuration. If the intermediate SN can support the proposed LCLS configuration it shall forward the LCLS Configuration Preference and the LCLS Configuration Change Request Information Elements to its succeeding or preceding node. If the intermediate SN cannot support/permit the proposed LCLS configuration it shall respond with a LCLS Configuration Change Result Information Element set to "LCLS Configuration Change request rejected" along with the Rejection Indicator detailing the reason for rejection.
|
| 882 |
+
|
| 883 |
+
On receipt of an APM message with the LCLS Configuration Change Result and LCLS Configuration Preference Information Elements from its succeeding/preceding node if the LCLS Configuration Change Result Information Element indicates "accepted" the intermediate SN shall store the LCLS configuration settings from the LCLS Configuration Preference Information Element and shall forward the APM message to its preceding/succeeding node.
|
| 884 |
+
|
| 885 |
+
If the LCLS Configuration Change Result Information Element indicates "rejected" the intermediate SN shall resume the LCLS connection with the LCLS configuration unchanged and the intermediate SN shall forward the APM message to its preceding/succeeding node.
|
| 886 |
+
|
| 887 |
+
#### C.2.4.4 Actions at Terminating Serving Node
|
| 888 |
+
|
| 889 |
+
When an SN which is a terminating SN with respect to a LCLS Configuration Change Request receives an APM message with the LCLS Configuration Change Request and LCLS Configuration Preference Information Elements requesting a certain LCLS Configuration Change the terminating SN shall check if it can support the requested LCLS configuration.
|
| 890 |
+
|
| 891 |
+
If the terminating SN can support the proposed LCLS configuration change it shall return the LCLS Configuration Preference Information Element and the LCLS Configuration Change Result Information Element indicating acceptance of the LCLS Configuration Change to its succeeding or preceding node. If the terminating SN cannot support/permit the proposed LCLS configuration it shall respond with a LCLS Configuration Change Result Information Element set to "LCLS Configuration Change request rejected" along with the Rejection Indicator detailing the reason for rejection.
|
| 892 |
+
|
| 893 |
+
### C.2.5 LCLS Status Update
|
| 894 |
+
|
| 895 |
+
#### C.2.5.1 Introduction
|
| 896 |
+
|
| 897 |
+
A LCLS Status Update message may be sent in either direction to indicate that a LCLS connection status has been changed. A LCLS Status Identifier Information Element indicating the new LCLS connection status value shall be included in a MST\_data primitive, corresponding to an APM message.
|
| 898 |
+
|
| 899 |
+
The compatibility information of the LCLS Status Identifier shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service.
|
| 900 |
+
|
| 901 |
+
NOTE: The term "initiating" SN in the following clauses refers to an originating SN or a destination SN that may initiate the LCLS Status Update message. The term "terminating" SN in the following clauses refers to an originating SN or a destination SN that may receive the LCLS Status Update message.
|
| 902 |
+
|
| 903 |
+
#### C.2.5.2 Actions at Initiating Serving Node
|
| 904 |
+
|
| 905 |
+
If a SN determines that the LCLS connection status has been changed it shall send the new LCLS connection status value to an adjacent SN. An initiating SN shall send the LCLS Status Identifier Information Element within the MST Application Transport Parameter (APP) within the APM message.
|
| 906 |
+
|
| 907 |
+
#### C.2.5.3 Actions at Intermediate Serving Node
|
| 908 |
+
|
| 909 |
+
When an intermediate SN receives the APM message with the LCLS Status Identifier Information Element from the preceding/succeeding SN and if the same LCLS connection status value has not been already received from the succeeding/preceding SN, the intermediate SN shall store the new LCLS Connection status value and shall pass the LCLS Status Identifier Information Element within the APM message unchanged to its succeeding/preceding SN.
|
| 910 |
+
|
| 911 |
+
#### C.2.5.4 Actions at Terminating Serving Node
|
| 912 |
+
|
| 913 |
+
When a terminating SN receives the APM message with the LCLS Status Identifier Information Element from the adjacent SN, it shall update its LCLS connection status value.
|
| 914 |
+
|
| 915 |
+
### C.2.6 LCLS Status Change Request
|
| 916 |
+
|
| 917 |
+
#### C.2.6.1 Introduction
|
| 918 |
+
|
| 919 |
+
A LCLS Status Change Request message may be sent in either direction and at any time during the active phase of a call, after the LCLS has been initially established. A LCLS Status Change Identifier Information Element indicating the requested change of the LCLS connection status shall be included in a MST\_data primitive, corresponding to an APM message.
|
| 920 |
+
|
| 921 |
+
An MST\_Data primitive, corresponding to the APM message shall be issued in response, including the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element indicating if the requested change of LCLS connection status has been accepted and if it has not been accepted the reason for rejection.
|
| 922 |
+
|
| 923 |
+
The compatibility information of the LCLS Status Change Identifier and the LCLS Status Result Identifier shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service.
|
| 924 |
+
|
| 925 |
+
NOTE: The term "initiating" SN in the following clauses refers to a SN which initiates the LCLS Status Change. The term "terminating" SN in the following clauses refers to a SN which terminates the LCLS Status Change.
|
| 926 |
+
|
| 927 |
+
#### C.2.6.2 Actions at Initiating Serving Node
|
| 928 |
+
|
| 929 |
+
When a SN determines that the LCLS connection status needs to be changed, it shall request the change of the LCLS connection status from its preceding and/or succeeding SN. An initiating SN shall send the LCLS Status Change Identifier Information Element within the MST Application Transport Parameter (APP) within an APM message.
|
| 930 |
+
|
| 931 |
+
An APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element will be received in response from the succeeding and/or preceding SN.
|
| 932 |
+
|
| 933 |
+
If initiating SN is an SN serving a Radio Network (originating SN or destination SN), upon reception of the LCLS Status Result Identifier Information Element indicating the acceptance of the requested LCLS connection status change, the initiating SN shall change the LCLS connection status.
|
| 934 |
+
|
| 935 |
+
NOTE: This change of LCLS connection status can be deferred until signalling interaction with the served Radio Network Controller, which is outside of the scope of this specification.
|
| 936 |
+
|
| 937 |
+
#### C.2.6.3 Actions at Intermediate Serving Node
|
| 938 |
+
|
| 939 |
+
When an intermediate SN receives from a preceding/succeeding SN an APM message that includes a LCLS Status Change Identifier Information Element within the MST Application Transport Parameter (APP) it shall check if it can support the required change of the LCLS connection status.
|
| 940 |
+
|
| 941 |
+
If the intermediate SN cannot support the requested change of the LCLS connection status it shall respond to the preceding/succeeding SN with the APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element with an Acceptance indicator set to "LCLS Status Change request rejected" along with a Rejection Indicator detailing the reason for rejection.
|
| 942 |
+
|
| 943 |
+
If the intermediate SN can support the required change of the LCLS connection status it shall pass the LCLS Status Change Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. An APM message will be received in response, including the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element from its succeeding/preceding SN. The intermediate SN shall pass the LCLS Status Change Identifier Information Element and the LCLS Status Result Identifier Information Element within the APM message unchanged to its succeeding/preceding SN.
|
| 944 |
+
|
| 945 |
+
#### C.2.6.4 Actions at Terminating Serving Node
|
| 946 |
+
|
| 947 |
+
Upon reception of an APM message that includes a LCLS Status Change Identifier Information Element, from the adjacent SN, a terminating SN shall check if it can support the required change of the LCLS connection status.
|
| 948 |
+
|
| 949 |
+
If the terminating SN can support the required change, it shall change the LCLS connection status. If the result of the LCLS connection status change is successful the terminating SN shall send to the adjacent SN the APM message with the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element indicating the acceptance of the requested LCLS connection status change.
|
| 950 |
+
|
| 951 |
+
NOTE: If the terminating SN is an SN serving a Radio Network (originating SN or destination SN), there can be additional signalling with the served Radio Network Controller, prior to responding to the LCLS Status Change Request; this is, however, outside of the scope of this specification.
|
| 952 |
+
|
| 953 |
+
If the result of the LCLS connection status change is unsuccessful or if the terminating SN cannot support the required change it shall respond to the adjacent SN with the APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element with an Acceptance indicator set to "LCLS Status Change request rejected" along with a Rejection Indicator detailing the reason for rejection.
|
marked/Rel-18/29_series/29217/raw.md
ADDED
|
@@ -0,0 +1,938 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.217 V18.0.0 (2024-03) ---
|
| 4 |
+
|
| 5 |
+
*Technical Specification*
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Policy and Charging Control (PCC); Congestion reporting over Np reference point (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right.
|
| 14 |
+
|
| 15 |
+
5G Advanced logo
|
| 16 |
+
|
| 17 |
+

|
| 18 |
+
|
| 19 |
+
The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
|
| 20 |
+
|
| 21 |
+
3GPP logo
|
| 22 |
+
|
| 23 |
+
The present document has been developed within the 3<sup>rd</sup> Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
|
| 24 |
+
|
| 25 |
+
The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
|
| 26 |
+
This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
|
| 27 |
+
Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 28 |
+
|
| 29 |
+
## --- **Keywords**
|
| 30 |
+
|
| 31 |
+
LTE, Policy
|
| 32 |
+
|
| 33 |
+
### **3GPP**
|
| 34 |
+
|
| 35 |
+
### --- **Postal address**
|
| 36 |
+
|
| 37 |
+
### --- **3GPP support office address**
|
| 38 |
+
|
| 39 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 40 |
+
Valbonne - FRANCE
|
| 41 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 42 |
+
|
| 43 |
+
## --- **Internet**
|
| 44 |
+
|
| 45 |
+
<http://www.3gpp.org>
|
| 46 |
+
|
| 47 |
+
## --- **Copyright Notification**
|
| 48 |
+
|
| 49 |
+
No part may be reproduced except as authorized by written permission.
|
| 50 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 51 |
+
|
| 52 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 53 |
+
All rights reserved.
|
| 54 |
+
|
| 55 |
+
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
|
| 56 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 57 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 58 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 59 |
+
|
| 60 |
+
## Contents
|
| 61 |
+
|
| 62 |
+
| | |
|
| 63 |
+
|--------------------------------------------------------------------------------|----|
|
| 64 |
+
| Foreword ..... | 5 |
|
| 65 |
+
| 1 Scope..... | 6 |
|
| 66 |
+
| 2 References..... | 6 |
|
| 67 |
+
| 3 Definitions and abbreviations ..... | 7 |
|
| 68 |
+
| 3.1 Definitions..... | 7 |
|
| 69 |
+
| 3.2 Abbreviations ..... | 7 |
|
| 70 |
+
| 4 Np reference point..... | 7 |
|
| 71 |
+
| 4.1 Overview ..... | 7 |
|
| 72 |
+
| 4.2 Np reference model ..... | 8 |
|
| 73 |
+
| 4.3 Functional elements..... | 8 |
|
| 74 |
+
| 4.3.1 RCAF..... | 8 |
|
| 75 |
+
| 4.3.2 PCRF ..... | 9 |
|
| 76 |
+
| 4.3.3 H-PCRF ..... | 9 |
|
| 77 |
+
| 4.3.4 V-PCRF ..... | 9 |
|
| 78 |
+
| 4.4 Procedures over Np reference point..... | 9 |
|
| 79 |
+
| 4.4.1 RUCI Report..... | 9 |
|
| 80 |
+
| 4.4.1.1 General..... | 9 |
|
| 81 |
+
| 4.4.1.2 Non-aggregated RUCI report..... | 10 |
|
| 82 |
+
| 4.4.1.3 Aggregated RUCI report..... | 10 |
|
| 83 |
+
| 4.4.2 Reporting Restriction Provisioning ..... | 10 |
|
| 84 |
+
| 4.4.3 UE mobility between RCAFs..... | 11 |
|
| 85 |
+
| 4.4.4 Removal of UE context ..... | 11 |
|
| 86 |
+
| 4.4.5 Race condition handling ..... | 12 |
|
| 87 |
+
| 5 Np protocol ..... | 12 |
|
| 88 |
+
| 5.1 Protocol support ..... | 12 |
|
| 89 |
+
| 5.2 Initialization, maintenance and termination of connection and session..... | 12 |
|
| 90 |
+
| 5.3 Np specific AVPs..... | 13 |
|
| 91 |
+
| 5.3.1 General ..... | 13 |
|
| 92 |
+
| 5.3.2 Aggregated-Congestion-Info AVP ..... | 13 |
|
| 93 |
+
| 5.3.3 Aggregated-RUCI-Report AVP ..... | 13 |
|
| 94 |
+
| 5.3.4 Congestion-Level-Definition AVP..... | 14 |
|
| 95 |
+
| 5.3.5 Congestion-Level-Range AVP..... | 14 |
|
| 96 |
+
| 5.3.6 Congestion-Level-Set-Id AVP ..... | 14 |
|
| 97 |
+
| 5.3.7 Congestion-Level-Value AVP..... | 14 |
|
| 98 |
+
| 5.3.8 Congestion-Location-Id AVP..... | 15 |
|
| 99 |
+
| 5.3.9 Conditional-Restriction AVP ..... | 15 |
|
| 100 |
+
| 5.3.10 eNodeB-Id AVP ..... | 15 |
|
| 101 |
+
| 5.3.11 IMSI-List AVP ..... | 15 |
|
| 102 |
+
| 5.3.12 RCAF-Id AVP ..... | 16 |
|
| 103 |
+
| 5.3.13 Reporting-Restriction AVP ..... | 16 |
|
| 104 |
+
| 5.3.14 RUCI-Action AVP ..... | 16 |
|
| 105 |
+
| 5.3.15 Extended-eNodeB-Id AVP ..... | 17 |
|
| 106 |
+
| 5.4 Np re-used AVPs..... | 17 |
|
| 107 |
+
| 5.4.1 General ..... | 17 |
|
| 108 |
+
| 5.4.2 Use of the Supported-Features AVP on the Np reference point..... | 18 |
|
| 109 |
+
| 5.5 Np specific Experimental-Result-Code AVP values ..... | 19 |
|
| 110 |
+
| 5.5.1 General ..... | 19 |
|
| 111 |
+
| 5.5.2 Success ..... | 19 |
|
| 112 |
+
| 5.5.3 Permanent Failures ..... | 19 |
|
| 113 |
+
| 5.5.4 Transient Failures ..... | 19 |
|
| 114 |
+
| 5.6 Np messages..... | 19 |
|
| 115 |
+
| 5.6.0 Command-Code Values..... | 19 |
|
| 116 |
+
| 5.6.1 Non-Aggregated-RUCI-Report-Request (NRR) command ..... | 20 |
|
| 117 |
+
| 5.6.2 Non-Aggregated-RUCI-Report-Answer (NRA) command..... | 20 |
|
| 118 |
+
|
| 119 |
+
5.6.3 Aggregated-RUCI-Report-Request (ARR) command ..... 21
|
| 120 |
+
5.6.4 Aggregated-RUCI-Report-Answer (ARA) command..... 21
|
| 121 |
+
5.6.5 Modify-Uecontext-Request (MUR) command..... 21
|
| 122 |
+
5.6.6 Modify-Uecontext-Answer (MUA) command..... 22
|
| 123 |
+
**Annex A (informative): Change history..... 23**
|
| 124 |
+
|
| 125 |
+
# --- Foreword
|
| 126 |
+
|
| 127 |
+
This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
|
| 128 |
+
|
| 129 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 130 |
+
|
| 131 |
+
Version x.y.z
|
| 132 |
+
|
| 133 |
+
where:
|
| 134 |
+
|
| 135 |
+
- x the first digit:
|
| 136 |
+
- 1 presented to TSG for information;
|
| 137 |
+
- 2 presented to TSG for approval;
|
| 138 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 139 |
+
- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 140 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 141 |
+
|
| 142 |
+
# 1 Scope
|
| 143 |
+
|
| 144 |
+
The present document provides the stage 3 specification of the Np reference point. The functional requirements and the stage 2 specifications of the Np reference point are contained in 3GPP TS 23.203 [2]. The Np reference point lies between the RAN Congestion Awareness Function (RCAF) and the Policy and Charging Rules Function (PCRF) for the non-roaming case, between the RCAF and the H-PCRF for the home-routed scenario and between the RCAF and the V-PCRF for the visited access scenario.
|
| 145 |
+
|
| 146 |
+
NOTE: If not specified explicitly, the PCRF also means H-PCRF for the home-routed scenario or V-PCRF in the visited access scenario in the specification.
|
| 147 |
+
|
| 148 |
+
# 2 References
|
| 149 |
+
|
| 150 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 151 |
+
|
| 152 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 153 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 154 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 155 |
+
|
| 156 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 157 |
+
- [2] 3GPP TS 23.203: "Policy and charging control architecture".
|
| 158 |
+
- [3] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping".
|
| 159 |
+
- [4] IETF RFC 4005: "Diameter Network Access Server Application".
|
| 160 |
+
- [5] IETF RFC 4006: "Diameter Credit Control Application".
|
| 161 |
+
- [6] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details".
|
| 162 |
+
- [7] IETF RFC 3588: "Diameter Base Protocol".
|
| 163 |
+
- [8] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access".
|
| 164 |
+
- [9] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2".
|
| 165 |
+
- [10] 3GPP TS 29.215: "Policy and Charging Control (PCC) over S9 reference point; Stage 3".
|
| 166 |
+
- [11] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)".
|
| 167 |
+
- [12] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)".
|
| 168 |
+
- [13] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users".
|
| 169 |
+
- [14] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points".
|
| 170 |
+
- [15] IETF RFC 7683: "Diameter Overload Indication Conveyance".
|
| 171 |
+
- [16] IETF RFC 7944: "Diameter Routing Message Priority".
|
| 172 |
+
- [17] IETF RFC 8583: "Diameter Load Information Conveyance".
|
| 173 |
+
- [18] IETF RFC 6733: "Diameter Base Protocol".
|
| 174 |
+
|
| 175 |
+
- [19] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations".
|
| 176 |
+
- [20] IETF RFC 2234: "Augmented BNF for syntax specifications".
|
| 177 |
+
|
| 178 |
+
# --- 3 Definitions and abbreviations
|
| 179 |
+
|
| 180 |
+
## 3.1 Definitions
|
| 181 |
+
|
| 182 |
+
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
|
| 183 |
+
|
| 184 |
+
**Home Routed Access:** Roaming scenario where the PCEF is located in the HPLMN. In a Home Routed roaming scenario, the UE obtains access to the packet data network from the HPLMN.
|
| 185 |
+
|
| 186 |
+
**RAN user plane congestion:** RAN user plane congestion occurs when the demand for RAN resources exceeds the available RAN capacity to deliver the user data for a prolonged period of time.
|
| 187 |
+
|
| 188 |
+
NOTE: Short-duration traffic bursts is a normal condition at any traffic load level, and is not considered to be RAN user plane congestion. Likewise, a high-level of utilization of RAN resources (based on operator configuration) is considered a normal mode of operation and might not be RAN user plane congestion.
|
| 189 |
+
|
| 190 |
+
**Visited Access (also known as local breakout):** Roaming scenario where the PCEF is located in the VPLMN. In a Visited Access Roaming scenario, the UE obtains access to the packet data network from the VPLMN.
|
| 191 |
+
|
| 192 |
+
## 3.2 Abbreviations
|
| 193 |
+
|
| 194 |
+
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
|
| 195 |
+
|
| 196 |
+
| | |
|
| 197 |
+
|--------|---------------------------------------|
|
| 198 |
+
| AF | Application Function |
|
| 199 |
+
| ARR | Aggregated RUCI Report Request |
|
| 200 |
+
| ARA | Aggregated RUCI Report Answer |
|
| 201 |
+
| DRMP | Diameter Routing Message Priority |
|
| 202 |
+
| H-PCRF | Home PCRF |
|
| 203 |
+
| MUR | Modify Uecontext Request |
|
| 204 |
+
| MUA | Modify Uecontext Answer |
|
| 205 |
+
| NRR | Non-Aggregated RUCI Report Request |
|
| 206 |
+
| NRA | Non-Aggregated RUCI Report Answer |
|
| 207 |
+
| PCC | Policy and Charging Control |
|
| 208 |
+
| PCRF | Policy and Charging Rule Function |
|
| 209 |
+
| RCAF | RAN Congestion Awareness Function |
|
| 210 |
+
| RUCI | RAN User Plane Congestion Information |
|
| 211 |
+
| V-PCRF | Visited PCRF |
|
| 212 |
+
|
| 213 |
+
# --- 4 Np reference point
|
| 214 |
+
|
| 215 |
+
## 4.1 Overview
|
| 216 |
+
|
| 217 |
+
The Np reference point is located between the RCAF and the PCRF for the non-roaming scenario, between the RCAF and the H-PCRF for the home-routed scenario and between the RCAF and the V-PCRF for the visited access scenario. The Np reference point is used for:
|
| 218 |
+
|
| 219 |
+
- Reporting the RUCI from the RCAF to the PCRF;
|
| 220 |
+
- Provisioning the Reporting Restriction from the PCRF to the RCAF;
|
| 221 |
+
|
| 222 |
+
- The User Equipment (UE) mobility between RCAF;
|
| 223 |
+
- The removal of the UE context in the RCAF.
|
| 224 |
+
|
| 225 |
+
The stage 2 level requirements for the Np reference point are defined in 3GPP TS 23.203 [2].
|
| 226 |
+
|
| 227 |
+
Signalling flows related to Np interface are specified in 3GPP TS 29.213 [3].
|
| 228 |
+
|
| 229 |
+
Refer to Annex G of 3GPP TS 29.213 [3] for Diameter overload control procedures over the Np interface.
|
| 230 |
+
|
| 231 |
+
Refer to Annex J of 3GPP TS 29.213 [3] for Diameter message priority mechanism procedures over the Np interface.
|
| 232 |
+
|
| 233 |
+
Refer to Annex K of 3GPP TS 29.213 [3] for Diameter load control procedures over the Np interface.
|
| 234 |
+
|
| 235 |
+
## 4.2 Np reference model
|
| 236 |
+
|
| 237 |
+
The relationships between the involved functional entities are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [3] .
|
| 238 |
+
|
| 239 |
+

|
| 240 |
+
|
| 241 |
+
The diagram shows two green rectangular boxes, labeled 'RCAF' on the left and 'PCRF' on the right, connected by a horizontal line. Above the line, the label 'Np' is centered. There is a small vertical tick mark on the line between the two boxes.
|
| 242 |
+
|
| 243 |
+
Diagram of the Np reference model showing RCAF and PCRF connected via the Np interface.
|
| 244 |
+
|
| 245 |
+
**Figure 4.2.1: Np reference model**
|
| 246 |
+
|
| 247 |
+
NOTE: For the home-routed access scenario, the RCAF interacts with the H-PCRF. For the visited access scenario, the RCAF interacts with the V-PCRF.
|
| 248 |
+
|
| 249 |
+
**Figure 4.2.2: Void**
|
| 250 |
+
|
| 251 |
+
**Figure 4.2.3: Void**
|
| 252 |
+
|
| 253 |
+
## 4.3 Functional elements
|
| 254 |
+
|
| 255 |
+
### 4.3.1 RCAF
|
| 256 |
+
|
| 257 |
+
The RCAF is a functional element which reports RAN User Plane Congestion Information (RUCI) via the Np interface to the PCRF to enable the PCRF to take the RAN user plane congestion status into account for policy decisions. RUCI includes the following information:
|
| 258 |
+
|
| 259 |
+
- The user id (e.g. IMSI) identifying the UE impacted by congestion;
|
| 260 |
+
- PDN ID for which congestion information is reported;
|
| 261 |
+
- Congestion level information (either congestion level value or congestion level set id) of the UE impacted by congestion;
|
| 262 |
+
- eNodeB identifier, ECGI or SAI identifying the eNodeB, E-UTRAN cell or Service Area respectively, serving the UE if a conditional restriction to restrict location reporting is not enabled.
|
| 263 |
+
|
| 264 |
+
NOTE 1: In case of E-UTRAN, whether the eNodeB identifier or the ECGI are included in the RUCI is up to operator configuration in the RCAF.
|
| 265 |
+
|
| 266 |
+
The RCAF sends the RUCI to the PCRFs serving the UEs' PDN connections as follows:
|
| 267 |
+
|
| 268 |
+
- For a PDN connection in a non-roaming scenario the RCAF reports the RUCI to the PCRF;
|
| 269 |
+
- For a PDN connection in a local breakout scenario, based on operator configuration, the RCAF reports the RUCI to the V-PCRF;
|
| 270 |
+
|
| 271 |
+
- For a PDN connection in a home routed scenario, based on the roaming agreement with the HPLMN and operator configuration, the RCAF reports the RUCI to the H-PCRF
|
| 272 |
+
|
| 273 |
+
NOTE 2: Reporting of congestion information to the HPLMN may be used e.g. in case of a group of PLMNs which belong to a single business entity.
|
| 274 |
+
|
| 275 |
+
The RCAF determines whether a given PDN connection is served in a local breakout or a home routed roaming scenario based on the APN operator identifier received as part of the APN information from the MME or the SGSN as documented in 3GPP TS 23.401 [8] and 3GPP TS 23.060 [9], respectively.
|
| 276 |
+
|
| 277 |
+
NOTE 3: Operator configuration can be used to limit RUCI reporting on the Np interface to certain APNs only.
|
| 278 |
+
|
| 279 |
+
The RCAF maintains a context per user id and APN. The context is identified by the IMSI and the APN. It contains the following information:
|
| 280 |
+
|
| 281 |
+
- The previously reported congestion level over the Np reference point;
|
| 282 |
+
- The reporting restrictions received from the PCRF. The reporting restrictions are stored by the RCAF until the PCRF explicitly signals to remove the reporting restrictions.
|
| 283 |
+
- The logical PCRF id received from the PCRF to identify the PCRF that is the Np destination for the RCAF when sending aggregate messages.
|
| 284 |
+
|
| 285 |
+
### 4.3.2 PCRF
|
| 286 |
+
|
| 287 |
+
The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities.
|
| 288 |
+
|
| 289 |
+
The PCRF may receive RUCI from the RCAF as input for policy decisions of congestion mitigation. The PCRF may provide, update or remove the reporting restrictions of RUCI, or stop or enable RUCI reporting for a given user id and PDN ID. The PCRF may enable or disable the reporting of congestion location identifier as part of RUCI. The PCRF may also remove the context at the RCAF for a given user id and PDN ID.
|
| 290 |
+
|
| 291 |
+
NOTE: Depending on the RUCI reporting interval configured in the RCAF, a UE can move outside the area indicated without the RCAF immediately notifying the PCRF. In case the PCRF receives information about the cell currently serving a UE via Np and Gx when the location change reporting is enabled, then the information received via Gx is expected to take precedence.
|
| 292 |
+
|
| 293 |
+
### 4.3.3 H-PCRF
|
| 294 |
+
|
| 295 |
+
Functionality defined in clause 4.3.2 shall apply if UE is roaming with home-routed access scenario.
|
| 296 |
+
|
| 297 |
+
NOTE: Reporting of congestion information to the HPLMN can be used e.g. in case of a group of PLMNs which belong to a single business entity.
|
| 298 |
+
|
| 299 |
+
### 4.3.4 V-PCRF
|
| 300 |
+
|
| 301 |
+
Functionality defined in clause 4.3.2 shall apply if UE is roaming with visited access scenario.
|
| 302 |
+
|
| 303 |
+
## 4.4 Procedures over Np reference point
|
| 304 |
+
|
| 305 |
+
### 4.4.1 RUCI Report
|
| 306 |
+
|
| 307 |
+
#### 4.4.1.1 General
|
| 308 |
+
|
| 309 |
+
The RCAF shall perform the RUCI reporting to the PCRF when at least one of the following conditions applies:
|
| 310 |
+
|
| 311 |
+
- the RCAF detects a UE in the congestion area for the first time;
|
| 312 |
+
- a reporting restriction is enabled and the congestion level set id is changed;
|
| 313 |
+
|
| 314 |
+
- a reporting restriction is not enabled and the congestion level value is changed;
|
| 315 |
+
- a conditional restriction to restrict location reporting is not enabled and the UE is in a congested area and the location is changed; or
|
| 316 |
+
- the RCAF detects that the UE is no longer experiencing congestion (i.e. the UE is no longer detected in any of the congested cells that the RCAF is monitoring).
|
| 317 |
+
|
| 318 |
+
The RCAF shall report the RUCI to the PCRF unless the RUCI reporting is disabled for the PDN ID or for the user id and the PDN ID.
|
| 319 |
+
|
| 320 |
+
Two types of RUCI reports may be used on Np for transfer of congestion information from RCAF to PCRF: Non-aggregated RUCI report and Aggregated RUCI report. If the RCAF does not know the destination PCRF for the user id and PDN ID, the Non-aggregated RUCI report shall be used; otherwise the RCAF may use either the Non-aggregate RUCI report or Aggregated RUCI report for the user id and PDN ID.
|
| 321 |
+
|
| 322 |
+
#### 4.4.1.2 Non-aggregated RUCI report
|
| 323 |
+
|
| 324 |
+
For a Non-aggregated RUCI report, the RCAF shall send an NRR command to the PCRF by including the user id within the Subscription-Id AVP, PDN ID within the Called-Station-Id AVP and a congestion level set id within the Congestion-Level-Set-Id AVP if the reporting restriction was provided earlier or a congestion level value within the Congestion-Level-Value AVP if the reporting restriction was not provided earlier at the command level. The RCAF may also provide congestion location identifier of the UE within the Congestion-Location-Id AVP in the NRR command. The RCAF shall also include the RCAF Identity within the RCAF-Id AVP in every NRR command for a specific user id and PDN ID.
|
| 325 |
+
|
| 326 |
+
Once the PCRF receives the NRR command, the PCRF shall store the related info and respond with an NRA command including the PCRF id within the PCRF-Address AVP. The PCRF may use the RUCI received from the RCAF as input for policy decisions. When the RCAF receives the NRA command, the RCAF may store the PCRF id in the UE context for this specific user id together with PDN ID for further aggregated RUCI report.
|
| 327 |
+
|
| 328 |
+
If the ReportRestriction feature is supported by both the RCAF and the PCRF, the PCRF may provide reporting restrictions in the NRA command according to clause 4.4.2.
|
| 329 |
+
|
| 330 |
+
#### 4.4.1.3 Aggregated RUCI report
|
| 331 |
+
|
| 332 |
+
For an Aggregated RUCI report, the RCAF shall aggregate the RUCIs of different user ids and PDN IDs that have the same destination PCRF. The RCAF shall send an ARR command to the destination PCRF by including the PCRF id within the Destination-Host AVP, one or more Aggregated-RUCI-Report AVP with a congestion level set id within the Congestion-Level-Set-Id AVP if the reporting restriction was provided earlier or a congestion level value within the Congestion-Level-Value AVP if the reporting restriction was not provided earlier, the PDN ID within the Called-Station-ID AVP and a list of aggregated congestion information within the Aggregated-Congestion-Info AVP.
|
| 333 |
+
|
| 334 |
+
NOTE 1: Each instance of Aggregated-RUCI-Report AVP aggregates the user id list of the subscribers that share the same level of congestion or share the same congestion level set id.
|
| 335 |
+
|
| 336 |
+
NOTE 2: When the RCAF assembles a Diameter ARR command, if the message length of ARR command has exceeded the maximum length of Diameter message which can be configurable, the RCAF can divide the original ARR command into multiple aggregated RUCI messages for the delivery over Np reference point.
|
| 337 |
+
|
| 338 |
+
Once the PCRF receives the ARR command, the PCRF shall store the related info and respond with an ARA command. The PCRF may use the RUCI received from the RCAF as input for policy decisions.
|
| 339 |
+
|
| 340 |
+
### 4.4.2 Reporting Restriction Provisioning
|
| 341 |
+
|
| 342 |
+
If the ReportRestriction feature is supported by both the RCAF and the PCRF, the PCRF may provide the reporting restrictions for a specific user id and PDN ID in the initial NRA command. The PCRF may also provide, modify or disable restrictions for RUCI reporting or stop or enable RUCI reporting for the specific user id and PDN ID at any later time. The PCRF may also use this procedure to enable or disable the reporting of congestion location identifier as part of RUCI.
|
| 343 |
+
|
| 344 |
+
In order to initially provide the reporting restrictions, the PCRF shall send a Modify-Uecontext-Request (MUR) command including the targeted Subscription-Id AVP indicating the user id, the Called-Station-Id AVP indicating the targeted PDN ID and one or more Congestion-Level-Definition AVP(s) including the defined congestion level set within the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP or reply with an NRA command including one or more Congestion-Level-Definition AVP(s) including the defined congestion level set within the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP . The PCRF may also include the Reporting-Restriction AVP and Conditional-Restriction AVP to indicate when conditional reporting restrictions apply.
|
| 345 |
+
|
| 346 |
+
The PCRF may modify already provided reporting restrictions. To do so the PCRF shall provide the complete list of congestion level sets and corresponding congestion levels to be used in the same manner as when initially providing reporting restrictions. This complete list shall replace any previously provided list. The absence of Reporting-Restriction AVP and Conditional-Restriction AVP indicates that previous state of reporting restrictions remains valid.
|
| 347 |
+
|
| 348 |
+
If reporting restrictions has been provided for a specific user id and PDN ID, the PCRF may remove the reporting restrictions by, in the MUR command, including the Reporting-Restriction AVP set to 0 (No reporting restriction), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the Reporting-Restriction AVP set to 0 (No reporting restriction).
|
| 349 |
+
|
| 350 |
+
The PCRF may disable RUCI reporting by, in the MUR command, including the RUCI-Action AVP set to 0 (Disable RUCI Reporting), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the RUCI-Action AVP set to 0 (Disable RUCI Reporting).
|
| 351 |
+
|
| 352 |
+
To enable RUCI Reporting if previously disabled, the PCRF in the MUR command shall include the RUCI-Action AVP set to 1 (Enable RUCI Reporting), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the RUCI-Action AVP set to 1 (Enable RUCI Reporting).
|
| 353 |
+
|
| 354 |
+
If reporting restrictions also applies, the PCRF shall include one or more Congestion-Level-Definition AVP(s) including the defined congestion level set with the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP, within the same command.
|
| 355 |
+
|
| 356 |
+
To provision the reporting restriction which disables the reporting of congestion location identifier of the UE as part of RUCI, the PCRF shall include Reporting-Restriction AVP set to 1 (Conditional reporting restriction) and Conditional-Restriction AVP with the bit 0 be set. To enable a previously disabled reporting of the congestion location identifier of the UE as part of RUCI, the PCRF shall include Reporting-Restriction AVP set to 2 (Unconditional reporting restriction).
|
| 357 |
+
|
| 358 |
+
The PCRF shall include the value of the RCAF-Id AVP received in the NRR command for the specific user id and PDN ID in the Destination-Host AVP of the MUR command.
|
| 359 |
+
|
| 360 |
+
The RCAF acknowledges the received MUR command by sending a Modify-Uecontext-Answer (MUA) command in all cases above.
|
| 361 |
+
|
| 362 |
+
### 4.4.3 UE mobility between RCAFs
|
| 363 |
+
|
| 364 |
+
If RUCI reporting is used for a specific user id and PDN ID and the PCRF receives a new non-aggregated RUCI report for the same user id and PDN ID but with a different RCAF id included in the RCAF-Id AVP, the PCRF shall update the related information and respond with an NRA command according to clause 4.4.1.1.
|
| 365 |
+
|
| 366 |
+
The PCRF shall also initiate a removal of the UE context to the old RCAF according to clause 4.4.4.
|
| 367 |
+
|
| 368 |
+
### 4.4.4 Removal of UE context
|
| 369 |
+
|
| 370 |
+
This procedure is initiated when the PCRF needs to remove a UE context from the RCAF, e.g. at UE mobility between RCAFs.
|
| 371 |
+
|
| 372 |
+
If the PCRF due to an event determines that a UE context needs to be removed from the RCAF, the PCRF shall send an MUR command to the targeted RCAF to explicitly release the context related to the user id and PDN ID by including the Subscription-Id AVP indicating the user id, the Called-Station-Id AVP indicating the PDN ID, the Destination-Host AVP indicating the targeted RCAF id and the RUCI-Action AVP set to 2 (Release Context).
|
| 373 |
+
|
| 374 |
+
The RCAF when receiving the MUR command from the PCRF shall release the context related to the user id and PDN ID. If this is the last PDN ID stored for this user id the RCAF shall release the complete context.
|
| 375 |
+
|
| 376 |
+
The RCAF shall acknowledge the received MUR command by sending an MUA command.
|
| 377 |
+
|
| 378 |
+
### 4.4.5 Race condition handling
|
| 379 |
+
|
| 380 |
+
If the RCAF receives an MUR command to remove a context for a specific user id and PDN ID, the request shall be handled immediately, regardless of whether there are any ongoing RUCI report transactions for that user id and PDN ID.
|
| 381 |
+
|
| 382 |
+
If the PCRF receives an NRR command for a specific user id and PDN ID, and if there is an ongoing MUR command to remove the context for that user id and PDN ID, the PCRF shall reject the incoming request with a Diameter experimental result code of DIAMETER\_PENDING\_TRANSACTION.
|
| 383 |
+
|
| 384 |
+
If the PCRF receives an ARR command for specific user id and PDN ID combinations for which there is at least one ongoing MUR command to remove the context, the PCRF shall accept the request and only update the context(s) that are not in the process of being removed.
|
| 385 |
+
|
| 386 |
+
# --- 5 Np protocol
|
| 387 |
+
|
| 388 |
+
## 5.1 Protocol support
|
| 389 |
+
|
| 390 |
+
The Np application is defined as a vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Np Application in the present release is 16777342. The vendor identifier assigned by IANA to 3GPP (<http://www.iana.org/assignments/enterprise-numbers>) is 10415.
|
| 391 |
+
|
| 392 |
+
NOTE: A route entry can have a different destination based on the application identification AVP of the message. Therefore, Diameter agents (relay, proxy, redirection, translation agents) must be configured appropriately to identify the 3GPP Np application within the Auth-Application-Id AVP in order to create suitable routeing tables.
|
| 393 |
+
|
| 394 |
+
With regard to the Diameter protocol defined over the Np interface, the PCRF acts as a Diameter server, in the sense that it is the network element that handles the RUCI reporting for a particular realm. The RCAF acts as the Diameter client, in the sense that it is the network element reporting the RUCI.
|
| 395 |
+
|
| 396 |
+
## 5.2 Initialization, maintenance and termination of connection and session
|
| 397 |
+
|
| 398 |
+
The initialization and maintenance of the connection between the RCAF and PCRF are defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes are described in IETF RFC 6733 [18].
|
| 399 |
+
|
| 400 |
+
After establishing the transport connection, the RCAF and the PCRF shall advertise the support of the Np specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [18]).
|
| 401 |
+
|
| 402 |
+
The Np Diameter session shall be terminated after each request and answer pair interaction.
|
| 403 |
+
|
| 404 |
+
In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [18]).
|
| 405 |
+
|
| 406 |
+
## 5.3 Np specific AVPs
|
| 407 |
+
|
| 408 |
+
### 5.3.1 General
|
| 409 |
+
|
| 410 |
+
Table 5.3.1.1 describes the Diameter AVPs defined for the Np reference point, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415).
|
| 411 |
+
|
| 412 |
+
**Table 5.3.1.1: Np specific Diameter AVPs**
|
| 413 |
+
|
| 414 |
+
| Attribute Name | AVP Code | Clause defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability (NOTE 3) |
|
| 415 |
+
|-----------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|-----------|------------------------|
|
| 416 |
+
| | | | | Mus t | May | Should not | Must not | | |
|
| 417 |
+
| Aggregated-Congestion-Info | 4000 | 5.3.2 | Grouped | V, M | P | | | Y | |
|
| 418 |
+
| Aggregated-RUCI-Report | 4001 | 5.3.3 | Grouped | V, M | P | | | Y | |
|
| 419 |
+
| Congestion-Level-Definition | 4002 | 5.3.4 | Grouped | V | P | | M | Y | ReportRestriction |
|
| 420 |
+
| Congestion-Level-Range | 4003 | 5.3.5 | Unsigned32 | V | P | | M | Y | ReportRestriction |
|
| 421 |
+
| Congestion-Level-Set-Id | 4004 | 5.3.6 | Unsigned32 | V | P | | M | Y | ReportRestriction |
|
| 422 |
+
| Congestion-Level-Value | 4005 | 5.3.7 | Unsigned32 | V, M | P | | | Y | |
|
| 423 |
+
| Congestion-Location-Id | 4006 | 5.3.8 | Grouped | V | P | | M | Y | ReportRestriction |
|
| 424 |
+
| Conditional-Restriction | 4007 | 5.3.9 | Unsigned32 | V | P | | M | Y | ReportRestriction |
|
| 425 |
+
| eNodeB-Id | 4008 | 5.3.10 | OctetString | V, M | P | | | Y | |
|
| 426 |
+
| IMSI-List | 4009 | 5.3.11 | OctetString | V, M | P | | | Y | |
|
| 427 |
+
| RCAF-Id | 4010 | 5.3.12 | DiameterIdentity | V, M | P | | | Y | |
|
| 428 |
+
| Reporting-Restriction | 4011 | 5.3.13 | Unsigned32 | V | P | | M | Y | ReportRestriction |
|
| 429 |
+
| RUCI-Action | 4012 | 5.3.14 | Unsigned32 | V | P | | M | Y | ReportRestriction |
|
| 430 |
+
| Extended-eNodeB-Id | 4013 | 5.3.15 | OctetString | V, M | P | | M | Y | |
|
| 431 |
+
|
| 432 |
+
NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [18].
|
| 433 |
+
|
| 434 |
+
NOTE 2: The value types are defined in IETF RFC 6733 [18].
|
| 435 |
+
|
| 436 |
+
NOTE 3: AVPs marked with a supported feature (e.g. "ReportRestriction") are applicable as described in clause 5.4.2.
|
| 437 |
+
|
| 438 |
+
### 5.3.2 Aggregated-Congestion-Info AVP
|
| 439 |
+
|
| 440 |
+
The Aggregated-Congestion-Info AVP (AVP code 4000) is of type Grouped. It contains a list of user ids identified by IMSI and optionally the congestion location id in which the list of user ids are located.
|
| 441 |
+
|
| 442 |
+
```
|
| 443 |
+
Aggregated-Congestion-Info ::= < AVP Header: 4000 >
|
| 444 |
+
[ Congestion-Location-Id ]
|
| 445 |
+
[ IMSI-List ]
|
| 446 |
+
*[ AVP ]
|
| 447 |
+
```
|
| 448 |
+
|
| 449 |
+
### 5.3.3 Aggregated-RUCI-Report AVP
|
| 450 |
+
|
| 451 |
+
The Aggregated-RUCI-Report AVP (AVP code 4001) is of type Grouped, and it is used to contain the congestion level value or congestion level set id for a set of users which have the same PCRF for the same PDN ID.
|
| 452 |
+
|
| 453 |
+
The congestion-Level-Value AVP contains the congestion level value if the PCRF did not provide the reporting restriction earlier for the user id and PDN ID.
|
| 454 |
+
|
| 455 |
+
The Congestion-Level-Set-Id AVP contains the congestion level set identifier between the PCRF and the RCAF if the PCRF provided the reporting restriction earlier for the user id and PDN ID.
|
| 456 |
+
|
| 457 |
+
The Called-Station-Id AVP contains the PDN ID.
|
| 458 |
+
|
| 459 |
+
The Aggregated-Congestion-Info AVP shall indicate the list of users included in the IMSI-List AVP and the congested location included in the Congestion-Location-Id AVP (if applicable), where a congestion level included in the Congestion-Level-Value AVP or congestion level set included in the Congestion-Level-Set-Id AVP shall apply.
|
| 460 |
+
|
| 461 |
+
```
|
| 462 |
+
Aggregated-RUCI-Report ::= < AVP Header: 4001 >
|
| 463 |
+
1*{ Aggregated-Congestion-Info }
|
| 464 |
+
[ Called-Station-Id ]
|
| 465 |
+
[ Congestion-Level-Value ]
|
| 466 |
+
[ Congestion-Level-Set-Id ]
|
| 467 |
+
*[ AVP ]
|
| 468 |
+
```
|
| 469 |
+
|
| 470 |
+
### 5.3.4 Congestion-Level-Definition AVP
|
| 471 |
+
|
| 472 |
+
The Congestion-Level-Definition AVP (AVP code 4002) is of type Grouped, and it is used to define a congestion level set and corresponding congestion level(s) to be used by the RCAF for a specific user id and PDN ID at congestion reporting. When this AVP is present in the MUR command reporting restrictions apply, when this AVP is absent there are no reporting restriction for the specific user id and PDN ID.
|
| 473 |
+
|
| 474 |
+
```
|
| 475 |
+
Congestion-Level-Definition ::= < AVP Header: 4002 >
|
| 476 |
+
{ Congestion-Level-Set-Id }
|
| 477 |
+
{ Congestion-Level-Range }
|
| 478 |
+
*[ AVP ]
|
| 479 |
+
```
|
| 480 |
+
|
| 481 |
+
### 5.3.5 Congestion-Level-Range AVP
|
| 482 |
+
|
| 483 |
+
The Congestion-Level-Range AVP (AVP code 4003) is of type Unsigned32, and it is used to indicate the list of congestion level(s) bound to a certain congestion level set, between the PCRF and the RCAF. The Congestion-Level-Range AVP shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below:
|
| 484 |
+
|
| 485 |
+
**Table 5.3.5.1: Congestion Level Range**
|
| 486 |
+
|
| 487 |
+
| Bit | Name | Description |
|
| 488 |
+
|-----|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 489 |
+
| 0 | No congestion | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when there is no congestion for a certain user id and PDN ID. |
|
| 490 |
+
| 1 | Congestion level 1 | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when congestion level 1 is reached for a certain user id and PDN ID. |
|
| 491 |
+
| 1+n | Congestion level 1+n | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when congestion level 1+n is reached for a certain user id and PDN ID. |
|
| 492 |
+
|
| 493 |
+
### 5.3.6 Congestion-Level-Set-Id AVP
|
| 494 |
+
|
| 495 |
+
The Congestion-Level-Set-Id AVP (AVP code 4004) is of type Unsigned32, and it is used to indicate the congestion level set identifier between the PCRF and the RCAF.
|
| 496 |
+
|
| 497 |
+
### 5.3.7 Congestion-Level-Value AVP
|
| 498 |
+
|
| 499 |
+
The Congestion-Level-Value AVP (AVP code 4005) is of type Unsigned32, and it is used to indicate the congestion level associated with the user id and PDN ID.
|
| 500 |
+
|
| 501 |
+
The following values are defined:
|
| 502 |
+
|
| 503 |
+
0 (No congestion):
|
| 504 |
+
|
| 505 |
+
This value indicates that there is no congestion.
|
| 506 |
+
|
| 507 |
+
N (Congestion level n):
|
| 508 |
+
|
| 509 |
+
These values indicate that there is congestion. The value n is an integer between 1 and 31 and indicates a congestion level. The value 1 is the lowest congestion level and value 31 is the highest congestion level.
|
| 510 |
+
|
| 511 |
+
### 5.3.8 Congestion-Location-Id AVP
|
| 512 |
+
|
| 513 |
+
The Congestion-Location -Id AVP (AVP code 4006) is of type Grouped, and it indicates the identifier of a congested location in which the UE is currently located. The congested location is one of the following: the eNodeB, E-UTRAN cell or Service Area serving the UE. If ECGI is included in the 3GPP-User-Location-Info AVP within Congestion-Location-Id AVP, then the eNodeB identifier within eNodeB-Id AVP or Extended-eNodeB-Id AVP shall not be included in this AVP. This AVP is provided in the RUCI per user id and APN. If the eNodeB identifier has a length of 18 or 21 bits it shall be provided in the Extended-eNodeB-Id AVP and otherwise in the eNodeB-Id AVP.
|
| 514 |
+
|
| 515 |
+
AVP Format:
|
| 516 |
+
|
| 517 |
+
```
|
| 518 |
+
Congestion-Location-Id ::= < AVP Header: 4006 >
|
| 519 |
+
[ 3GPP-User-Location-Info ]
|
| 520 |
+
[ eNodeB-Id ]
|
| 521 |
+
[ Extended-eNodeB-Id ]
|
| 522 |
+
*[ AVP ]
|
| 523 |
+
```
|
| 524 |
+
|
| 525 |
+
### 5.3.9 Conditional-Restriction AVP
|
| 526 |
+
|
| 527 |
+
The Conditional-Restriction AVP (AVP code 4007) is of type Unsigned32 and it shall contain a bit mask, and indicates what conditional reporting restrictions apply. Conditional reporting restrictions shall apply when this AVP is provided. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below:
|
| 528 |
+
|
| 529 |
+
**Table 5.3.9.1: Conditional-Restriction over Np**
|
| 530 |
+
|
| 531 |
+
| Bit | Name | Description |
|
| 532 |
+
|-----|---------------------------------------|--------------------------------------------------------------------------------------------------------------------|
|
| 533 |
+
| 0 | UE location info not included in RUCI | This bit, when set, indicates that the location information of the UE shall not be included in RUCI for reporting. |
|
| 534 |
+
|
| 535 |
+
### 5.3.10 eNodeB-Id AVP
|
| 536 |
+
|
| 537 |
+
The eNodeB-Id AVP (AVP code 4008) is of type OctetString, and indicates the eNodeB in which the UE is currently located. The AVP shall be coded as in clause 8.51 of 3GPP TS 29.274 [12].
|
| 538 |
+
|
| 539 |
+
### 5.3.11 IMSI-List AVP
|
| 540 |
+
|
| 541 |
+
The IMSI-List AVP (AVP code 4009) is of type OctetString, and it contains a list of user ids identified by IMSI. Each IMSI shall be encoded as TBCD digits as defined in ITU-T Recommendation E.212 [13], i.e. digits from 0 through 9 are encoded "0000" to "1001". Each IMSI shall be encoded as 8 octets. If the length of the IMSI is 14, then the last octet shall be encoded as "1111 1111". If the length of the IMSI is 15, bits 5 to 8 of the last octet shall be encoded with the filler "1111". The maximum number of digits is 15. An example of the encoding of the IMSI List as the data part of the OctetString AVP is given below in Figure 5.3.11-1. Octet 1 given below is the first octet of the data part of the IMSI-List AVP.
|
| 542 |
+
|
| 543 |
+
| Octets | Bits | | | | | | | |
|
| 544 |
+
|-----------|---------------------------|---|---|---|---------------------------|---|---|---|
|
| 545 |
+
| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
|
| 546 |
+
| 1 | Number digit 2 of IMSI-1 | | | | Number digit 1 of IMSI-1 | | | |
|
| 547 |
+
| 2 | Number digit 4 of IMSI-1 | | | | Number digit 3 of IMSI-1 | | | |
|
| 548 |
+
| ... | ... | | | | ... | | | |
|
| 549 |
+
| 8 | 1111 | | | | Number digit 15 of IMSI-1 | | | |
|
| 550 |
+
| 9 | Number digit 2 of IMSI-2 | | | | Number digit 1 of IMSI-2 | | | |
|
| 551 |
+
| 10 | Number digit 4 of IMSI-2 | | | | Number digit 3 of IMSI-2 | | | |
|
| 552 |
+
| ... | ... | | | | ... | | | |
|
| 553 |
+
| 15 | Number digit 14 of IMSI-2 | | | | Number digit 13 of IMSI-2 | | | |
|
| 554 |
+
| 16 | 1111 | | | | 1111 | | | |
|
| 555 |
+
| 17 | Number digit 2 of IMSI-3 | | | | Number digit 1 of IMSI-3 | | | |
|
| 556 |
+
| 18 | Number digit 4 of IMSI-3 | | | | Number digit 3 of IMSI-3 | | | |
|
| 557 |
+
| ... | ... | | | | ... | | | |
|
| 558 |
+
| 23 | Number digit 14 of IMSI-3 | | | | Number digit 13 of IMSI-3 | | | |
|
| 559 |
+
| 24 | 1111 | | | | 1111 | | | |
|
| 560 |
+
| ... | ... | | | | ... | | | |
|
| 561 |
+
| (n-1)*8+1 | Number digit 2 of IMSI-n | | | | Number digit 1 of IMSI-n | | | |
|
| 562 |
+
| (n-1)*8+2 | Number digit 4 of IMSI-n | | | | Number digit 3 of IMSI-n | | | |
|
| 563 |
+
| ... | ... | | | | ... | | | |
|
| 564 |
+
| (n-1)*8+8 | 1111 | | | | Number digit 15 of IMSI-n | | | |
|
| 565 |
+
|
| 566 |
+
NOTE: In the above figure showing an example of encoding, it is assumed that n IMSIs are included in the IMSI-List AVP. The digit length of IMSI-1, IMSI-2, IMSI-3 and IMSI-n are 15, 14, 14, 15 respectively.
|
| 567 |
+
|
| 568 |
+
**Figure 5.3.11-1: Encoding of IMSI-List AVP**
|
| 569 |
+
|
| 570 |
+
### 5.3.12 RCAF-Id AVP
|
| 571 |
+
|
| 572 |
+
The RCAF-Id AVP (AVP code 4010) is of type DiameterIdentity, and it is used to contain the RCAF identity.
|
| 573 |
+
|
| 574 |
+
### 5.3.13 Reporting-Restriction AVP
|
| 575 |
+
|
| 576 |
+
The Reporting-Restriction AVP (AVP code 4011) is of type Unsigned32, and it is used to indicate the applicable reporting restrictions between the PCRF and RCAF. If this AVP is not provided during the initial reporting restriction provisioning, it shall be understood as unconditional reporting restrictions apply.
|
| 577 |
+
|
| 578 |
+
The following values are defined:
|
| 579 |
+
|
| 580 |
+
0 (No reporting restriction):
|
| 581 |
+
|
| 582 |
+
This value shall be used by the PCRF to indicate to the RCAF that there are no restrictions on congestion reporting for a specific user id and PDN ID. This value shall not be used if congestion level definitions are included in the same command.
|
| 583 |
+
|
| 584 |
+
1 (Conditional reporting restriction):
|
| 585 |
+
|
| 586 |
+
This value shall be used by the PCRF to indicate to the RCAF that there are conditional restrictions on congestion reporting for a specific user id and PDN ID.
|
| 587 |
+
|
| 588 |
+
2 (Unconditional reporting restriction):
|
| 589 |
+
|
| 590 |
+
This value shall be used by the PCRF to indicate to the RCAF that there are unconditional restrictions on congestion reporting for a specific user id and PDN ID.
|
| 591 |
+
|
| 592 |
+
### 5.3.14 RUCI-Action AVP
|
| 593 |
+
|
| 594 |
+
The RUCI-Action AVP (AVP code 4012) is of type Unsigned32, and it is used to disable or enable RUCI reporting between the PCRF and RCAF or to release the context for a specific user id and PDN ID.
|
| 595 |
+
|
| 596 |
+
The following values are defined:
|
| 597 |
+
|
| 598 |
+
0 (Disable RUCI reporting):
|
| 599 |
+
|
| 600 |
+
This value shall be used by the PCRF to indicate to the RCAF that RUCI reporting shall not be performed for a specific user id and PDN ID.
|
| 601 |
+
|
| 602 |
+
1 (Enable RUCI reporting):
|
| 603 |
+
|
| 604 |
+
This value shall be used by the PCRF to indicate to the RCAF that RUCI reporting shall be performed for a specific user id and PDN ID.
|
| 605 |
+
|
| 606 |
+
2 (Release Context):
|
| 607 |
+
|
| 608 |
+
This value shall be used by the PCRF to indicate to the RCAF that the context shall be released for a specific user id and PDN ID.
|
| 609 |
+
|
| 610 |
+
### 5.3.15 Extended-eNodeB-Id AVP
|
| 611 |
+
|
| 612 |
+
The Extended-eNodeB-Id AVP (AVP code 4013) is of type OctetString, and indicates the eNodeB in which the UE is currently located. The AVP shall be coded as in clause 8.51 of 3GPP TS 29.274 [12] for Type Extended Macro eNodeB.
|
| 613 |
+
|
| 614 |
+
## 5.4 Np re-used AVPs
|
| 615 |
+
|
| 616 |
+
### 5.4.1 General
|
| 617 |
+
|
| 618 |
+
Table 5.4.1.1 lists the Diameter AVPs re-used by the Np reference point from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Np reference point and which supported features the AVP is applicable to. AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 5.4.1.1, but they are re-used for the Np reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where RADIUS VSAs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [4] with the exception that the 'M' flag shall be set and the 'P' flag may be set.
|
| 619 |
+
|
| 620 |
+
Table 5.4.1.1: Np re-used Diameter AVPs
|
| 621 |
+
|
| 622 |
+
| Attribute Name | Reference | Description | Applicability (NOTE) |
|
| 623 |
+
|-----------------------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
|
| 624 |
+
| Called-Station-Id | IETF RFC 4005 [4] | The address the user is connected to (i.e. the PDN identifier). | |
|
| 625 |
+
| DRMP | IETF RFC 7944 [16] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | |
|
| 626 |
+
| Load | IETF RFC 8583 [17] | The AVP used to convey load information between Diameter nodes.<br>This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | |
|
| 627 |
+
| OC-OLR | IETF RFC 7683 [15] | Contains the necessary information to convey an overload report. | |
|
| 628 |
+
| OC-Supported-Features | IETF RFC 7683 [15] | Defines the support for the Diameter overload indication conveyance by the sending node. | |
|
| 629 |
+
| PCRF-Address | TS 29.215 [10] | The identity, which indicates the destination PCRF. | |
|
| 630 |
+
| Subscription-Id | IETF RFC 4006 [5] | The identification of the subscription (i.e. IMSI) | |
|
| 631 |
+
| Supported-Features | TS 29.229 [6] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange | |
|
| 632 |
+
| 3GPP-User-Location-Info | TS 29.061 [11], clause 16.4.7.2. | Indicates details of where the UE is currently located. Only SAI (Geographic Location Type set to 1) or ECGI (Geographic Location Type set to 129) is included in this information. | |
|
| 633 |
+
| NOTE: AVPs marked with a supported feature are applicable as described in clause 5.4.2. | | | |
|
| 634 |
+
|
| 635 |
+
### 5.4.2 Use of the Supported-Features AVP on the Np reference point
|
| 636 |
+
|
| 637 |
+
When new functionality is introduced on the Np reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Np reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [6].
|
| 638 |
+
|
| 639 |
+
When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF.
|
| 640 |
+
|
| 641 |
+
As defined in 3GPP TS 29.229 [6], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another.
|
| 642 |
+
|
| 643 |
+
The Supported-Features AVP shall be included in every NRR and NRA command if supported by the RCAF and PCRF respectively.
|
| 644 |
+
|
| 645 |
+
The table below defines the features applicable to the Np interface for the feature list with a Feature-List-ID of 1.
|
| 646 |
+
|
| 647 |
+
Table 5.4.2.1: Features of Feature-List-ID 1 used in Np
|
| 648 |
+
|
| 649 |
+
| Feature bit | Feature | M/O | Description |
|
| 650 |
+
|-------------------------------------------------------------------------------------------------------------------------------------|-------------------|-----|-------------------------------------------------------------|
|
| 651 |
+
| 0 | ReportRestriction | O | This feature indicates the support of reporting restriction |
|
| 652 |
+
| <b>Feature bit:</b> The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0". | | | |
|
| 653 |
+
| <b>Feature:</b> A short name that can be used to refer to the bit and to the feature, e.g. "EPS". | | | |
|
| 654 |
+
| <b>M/O:</b> Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | | |
|
| 655 |
+
| <b>Description:</b> A clear textual description of the feature. | | | |
|
| 656 |
+
|
| 657 |
+
## 5.5 Np specific Experimental-Result-Code AVP values
|
| 658 |
+
|
| 659 |
+
### 5.5.1 General
|
| 660 |
+
|
| 661 |
+
This clause defines result code values that shall be supported by Diameter implementations that conform to this specification.
|
| 662 |
+
|
| 663 |
+
### 5.5.2 Success
|
| 664 |
+
|
| 665 |
+
Result Codes that fall into the Success category are used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter BASE IETF RFC 6733 [18] are applied.
|
| 666 |
+
|
| 667 |
+
### 5.5.3 Permanent Failures
|
| 668 |
+
|
| 669 |
+
Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed. The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [18] are applied. As an addition the following Result-Code AVP value defined in IETF RFC 4006 [5] is applicable:
|
| 670 |
+
|
| 671 |
+
DIAMETER\_USER\_UNKNOWN (5030):
|
| 672 |
+
|
| 673 |
+
This error shall be used by the PCRF to indicate to the RCAF that the end user specified in the request is unknown to the PCRF, or it shall be used by the RCAF to indicate to the PCRF that the end user specified in the request is unknown to the RCAF. This result code does not apply for aggregated RUCI report.
|
| 674 |
+
|
| 675 |
+
### 5.5.4 Transient Failures
|
| 676 |
+
|
| 677 |
+
Errors that fall within the Transient Failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future.
|
| 678 |
+
|
| 679 |
+
The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [18] are applicable. As an addition the following Experimental-Result-Code value defined in 3GPP TS 29.212 [14] is applicable:
|
| 680 |
+
|
| 681 |
+
DIAMETER\_PENDING\_TRANSACTION (4144):
|
| 682 |
+
|
| 683 |
+
This error shall be used when a node receives an incoming request for a specific user id and PDN ID while it has an ongoing transaction for the same user id and PDN ID and cannot handle the request as described in clause 4.4.5.
|
| 684 |
+
|
| 685 |
+
## 5.6 Np messages
|
| 686 |
+
|
| 687 |
+
### 5.6.0 Command-Code Values
|
| 688 |
+
|
| 689 |
+
This clause defines the Command-Code values for the Np interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [x]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [y], and according to the rules in IETF RFC 6733 [18].
|
| 690 |
+
|
| 691 |
+
NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [7]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [18]).
|
| 692 |
+
|
| 693 |
+
The Np application identifier shall be included in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP contained in the commands defined in this specification.
|
| 694 |
+
|
| 695 |
+
The following Command Codes are defined in this specification:
|
| 696 |
+
|
| 697 |
+
Table 5.6.0.1: Command-Code values for Np
|
| 698 |
+
|
| 699 |
+
| Command-Name | Abbreviation | Code | Section |
|
| 700 |
+
|------------------------------------|--------------|---------|---------|
|
| 701 |
+
| Non-Aggregated-RUCI-Report-Request | NRR | 8388720 | 5.6.1 |
|
| 702 |
+
| Non-Aggregated-RUCI-Report-Answer | NRA | 8388720 | 5.6.2 |
|
| 703 |
+
| Aggregated-RUCI-Report-Request | ARR | 8388721 | 5.6.3 |
|
| 704 |
+
| Aggregated-RUCI-Report-Answer | ARA | 8388721 | 5.6.4 |
|
| 705 |
+
| Modify-Uecontext-Request | MUR | 8388722 | 5.6.5 |
|
| 706 |
+
| Modify-Uecontext-Answer | MUA | 8388722 | 5.6.6 |
|
| 707 |
+
|
| 708 |
+
#### 5.6.1 Non-Aggregated-RUCI-Report-Request (NRR) command
|
| 709 |
+
|
| 710 |
+
The NRR command, indicated by the Command-Code field set to 8388720 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as part of the Non-aggregated RUCI report procedure.
|
| 711 |
+
|
| 712 |
+
Message Format:
|
| 713 |
+
|
| 714 |
+
```
|
| 715 |
+
<NR-Request> ::= <Diameter Header: 8388720, REQ, PXY >
|
| 716 |
+
< Session-Id >
|
| 717 |
+
[ DRMP ]
|
| 718 |
+
{ Vendor-Specific-Application-Id }
|
| 719 |
+
{ Auth-Session-State }
|
| 720 |
+
{ Origin-Host }
|
| 721 |
+
{ Origin-Realm }
|
| 722 |
+
{ Destination-Realm }
|
| 723 |
+
[ Destination-Host ]
|
| 724 |
+
[ Origin-State-Id ]
|
| 725 |
+
[ Subscription-Id ]
|
| 726 |
+
[ Called-Station-Id ]
|
| 727 |
+
[ Congestion-Level-Value ]
|
| 728 |
+
[ Congestion-Level-Set-Id ]
|
| 729 |
+
[ Congestion-Location-Id ]
|
| 730 |
+
[ OC-Supported-Features ]
|
| 731 |
+
[ RCAF-Id ]
|
| 732 |
+
*[ Proxy-Info ]
|
| 733 |
+
*[ Route-Record ]
|
| 734 |
+
*[ Supported-Features ]
|
| 735 |
+
*[ AVP ]
|
| 736 |
+
```
|
| 737 |
+
|
| 738 |
+
#### 5.6.2 Non-Aggregated-RUCI-Report-Answer (NRA) command
|
| 739 |
+
|
| 740 |
+
The NRA command, indicated by the Command-Code field set to 8388720 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the RCAF as part of the Non-aggregated RUCI report procedure.
|
| 741 |
+
|
| 742 |
+
Message Format:
|
| 743 |
+
|
| 744 |
+
```
|
| 745 |
+
<NR-Answer> ::= < Diameter Header: 8388720, PXY >
|
| 746 |
+
< Session-Id >
|
| 747 |
+
[ DRMP ]
|
| 748 |
+
{ Vendor-Specific-Application-Id }
|
| 749 |
+
{ Auth-Session-State }
|
| 750 |
+
{ Origin-Host }
|
| 751 |
+
{ Origin-Realm }
|
| 752 |
+
[ Result-Code ]
|
| 753 |
+
[ Experimental-Result ]
|
| 754 |
+
[ Error-Message ]
|
| 755 |
+
[ Error-Reporting-Host ]
|
| 756 |
+
[ Failed-AVP ]
|
| 757 |
+
[ OC-Supported-Features ]
|
| 758 |
+
[ OC-OLR ]
|
| 759 |
+
[ Reporting-Restriction ]
|
| 760 |
+
[ Conditional-Restriction ]
|
| 761 |
+
[ RUCI-Action ]
|
| 762 |
+
*[ Congestion-Level-Definition ]
|
| 763 |
+
[ PCRF-Address ]
|
| 764 |
+
[ Origin-State-Id ]
|
| 765 |
+
*[ Redirect-Host ]
|
| 766 |
+
[ Redirect-Host-Usage ]
|
| 767 |
+
[ Redirect-Max-Cache-Time ]
|
| 768 |
+
*[ Proxy-Info ]
|
| 769 |
+
*[ Supported-Features ]
|
| 770 |
+
```
|
| 771 |
+
|
| 772 |
+
```
|
| 773 |
+
|
| 774 |
+
*[ Load ]
|
| 775 |
+
*[ AVP ]
|
| 776 |
+
|
| 777 |
+
```
|
| 778 |
+
|
| 779 |
+
### 5.6.3 Aggregated-RUCI-Report-Request (ARR) command
|
| 780 |
+
|
| 781 |
+
The ARR command, indicated by the Command-Code field set to 8388721 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as part of the Aggregated RUCI report procedure.
|
| 782 |
+
|
| 783 |
+
Message Format:
|
| 784 |
+
|
| 785 |
+
```
|
| 786 |
+
|
| 787 |
+
<AR-Request> ::= <Diameter Header: 8388721, REQ, PXY >
|
| 788 |
+
< Session-Id >
|
| 789 |
+
[ DRMP ]
|
| 790 |
+
{ Vendor-Specific-Application-Id }
|
| 791 |
+
{ Auth-Session-State }
|
| 792 |
+
{ Origin-Host }
|
| 793 |
+
{ Origin-Realm }
|
| 794 |
+
{ Destination-Realm }
|
| 795 |
+
[ Destination-Host ]
|
| 796 |
+
[ Origin-State-Id ]
|
| 797 |
+
*[ Aggregated-RUCI-Report ]
|
| 798 |
+
[ OC-Supported-Features ]
|
| 799 |
+
*[ Proxy-Info ]
|
| 800 |
+
*[ Route-Record ]
|
| 801 |
+
*[ Supported-Features ]
|
| 802 |
+
*[ AVP ]
|
| 803 |
+
|
| 804 |
+
```
|
| 805 |
+
|
| 806 |
+
### 5.6.4 Aggregated-RUCI-Report-Answer (ARA) command
|
| 807 |
+
|
| 808 |
+
The ARA command, indicated by the Command-Code field set to 8388721 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the RCAF as part of the Aggregated RUCI report procedure.
|
| 809 |
+
|
| 810 |
+
Message Format:
|
| 811 |
+
|
| 812 |
+
```
|
| 813 |
+
|
| 814 |
+
<AR-Answer> ::= < Diameter Header: 8388721, PXY >
|
| 815 |
+
< Session-Id >
|
| 816 |
+
[ DRMP ]
|
| 817 |
+
{ Vendor-Specific-Application-Id }
|
| 818 |
+
{ Auth-Session-State }
|
| 819 |
+
{ Origin-Host }
|
| 820 |
+
{ Origin-Realm }
|
| 821 |
+
[ Result-Code ]
|
| 822 |
+
[ Experimental-Result ]
|
| 823 |
+
[ Error-Message ]
|
| 824 |
+
[ Error-Reporting-Host ]
|
| 825 |
+
[ Failed-AVP ]
|
| 826 |
+
[ Origin-State-Id ]
|
| 827 |
+
[ OC-Supported-Features ]
|
| 828 |
+
[ OC-OLR ]
|
| 829 |
+
*[ Redirect-Host ]
|
| 830 |
+
[ Redirect-Host-Usage ]
|
| 831 |
+
[ Redirect-Max-Cache-Time ]
|
| 832 |
+
*[ Proxy-Info ]
|
| 833 |
+
*[ Supported-Features ]
|
| 834 |
+
*[ Load ]
|
| 835 |
+
*[ AVP ]
|
| 836 |
+
|
| 837 |
+
```
|
| 838 |
+
|
| 839 |
+
### 5.6.5 Modify-Uecontext-Request (MUR) command
|
| 840 |
+
|
| 841 |
+
The MUR command, indicated by the Command-Code field set to 8388722 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the RCAF in order to request congestion reporting restrictions or remove the context for a specific user id and PDN ID.
|
| 842 |
+
|
| 843 |
+
Message Format:
|
| 844 |
+
|
| 845 |
+
```
|
| 846 |
+
|
| 847 |
+
< Modify-Uecontext-Request > ::= < Diameter Header: 8388722, REQ, PXY >
|
| 848 |
+
< Session-Id >
|
| 849 |
+
[ DRMP ]
|
| 850 |
+
{ Vendor-Specific-Application-Id }
|
| 851 |
+
{ Auth-Session-State }
|
| 852 |
+
{ Origin-Host }
|
| 853 |
+
|
| 854 |
+
```
|
| 855 |
+
|
| 856 |
+
```
|
| 857 |
+
{ Origin-Realm }
|
| 858 |
+
{ Destination-Realm }
|
| 859 |
+
{ Destination-Host }
|
| 860 |
+
[ Origin-State-Id ]
|
| 861 |
+
[ Subscription-Id ]
|
| 862 |
+
[ Called-Station-Id ]
|
| 863 |
+
[ OC-Supported-Features ]
|
| 864 |
+
[ Reporting-Restriction ]
|
| 865 |
+
[ Conditional-Restriction ]
|
| 866 |
+
[ RUCI-Action ]
|
| 867 |
+
*[ Congestion-Level-Definition ]
|
| 868 |
+
*[ Proxy-Info ]
|
| 869 |
+
*[ Route-Record ]
|
| 870 |
+
*[ AVP ]
|
| 871 |
+
```
|
| 872 |
+
|
| 873 |
+
### 5.6.6 Modify-Uecontext-Answer (MUA) command
|
| 874 |
+
|
| 875 |
+
The MUA command, indicated by the Command-Code field set to 8388722 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as a response to the request for congestion reporting restrictions to or remove the context a specific user id and PDN ID.
|
| 876 |
+
|
| 877 |
+
Message Format:
|
| 878 |
+
|
| 879 |
+
```
|
| 880 |
+
< Modify-Uecontext-Answer > ::= < Diameter Header: 8388722, PXY >
|
| 881 |
+
< Session-Id >
|
| 882 |
+
[ DRMP ]
|
| 883 |
+
{ Vendor-Specific-Application-Id }
|
| 884 |
+
{ Auth-Session-State }
|
| 885 |
+
{ Origin-Host }
|
| 886 |
+
{ Origin-Realm }
|
| 887 |
+
[ Result-Code ]
|
| 888 |
+
[ Experimental-Result ]
|
| 889 |
+
[ Failed-AVP ]
|
| 890 |
+
[ Origin-State-Id ]
|
| 891 |
+
[ OC-Supported-Features ]
|
| 892 |
+
[ OC-OLR ]
|
| 893 |
+
*[ Redirect-Host ]
|
| 894 |
+
[ Redirect-Host-Usage ]
|
| 895 |
+
[ Redirect-Max-Cache-Time ]
|
| 896 |
+
*[ Proxy-Info ]
|
| 897 |
+
*[ AVP ]
|
| 898 |
+
```
|
| 899 |
+
|
| 900 |
+
# Annex A (informative): Change history
|
| 901 |
+
|
| 902 |
+
| <b>Change history</b> | | | | | | | |
|
| 903 |
+
|-----------------------|--------------|-----------------|-----------|------------|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------|
|
| 904 |
+
| <b>Date</b> | <b>TSG #</b> | <b>TSG Doc.</b> | <b>CR</b> | <b>Rev</b> | <b>Subject/Comment</b> | <b>Old</b> | <b>New</b> |
|
| 905 |
+
| 2015-06 | CT#68 | CP-150367 | | | Cleaned-up by MCC, based on the version sent by e-mail on June 5th and agreed. | 2.1.0 | 2.2.0 |
|
| 906 |
+
| 2015-06 | - | - | - | - | MCC Editorial update after approval by TSG CT#68 | 2.2.0 | 13.0.0 |
|
| 907 |
+
| 2015-09 | CP-69 | CP-150477 | 0003 | 2 | Alignment of RUCI reporting restrictions' basis for UPCON | 13.0.0 | 13.1.0 |
|
| 908 |
+
| 2015-09 | CP-69 | CP-150477 | 0005 | 2 | Correction to the PCRF functionality | 13.0.0 | 13.1.0 |
|
| 909 |
+
| 2015-09 | CP-69 | CP-150477 | 0006 | 1 | Correction to the RCAF functionality | 13.0.0 | 13.1.0 |
|
| 910 |
+
| 2015-09 | CP-69 | CP-150477 | 0008 | 1 | Corrections to the wrong implementation of C3-150441 | 13.0.0 | 13.1.0 |
|
| 911 |
+
| 2015-09 | CP-69 | CP-150477 | 0009 | 1 | Fixing Ambiguous Flag Rules for AVPs reused from TS 29.061 | 13.0.0 | 13.1.0 |
|
| 912 |
+
| 2015-12 | CP-70 | CP-150672 | 0010 | 1 | Some corrections to 29.217 | 13.1.0 | 13.2.0 |
|
| 913 |
+
| 2015-12 | CP-70 | CP-150797 | 0011 | 1 | Update the PCC architecture figures in 29.217 | 13.1.0 | 13.2.0 |
|
| 914 |
+
| 2015-12 | CP-70 | CP-150630 | 0012 | 1 | Update draft-ietf-dime-ovli reference to RFC 7683 | 13.1.0 | 13.2.0 |
|
| 915 |
+
| 2015-12 | CP-70 | CP-150672 | 0013 | 1 | Vendor Specific Application ID over Np interface | 13.1.0 | 13.2.0 |
|
| 916 |
+
| 2015-12 | CP-70 | CP-150672 | 0016 | 2 | Race condition handling for aggregated RUCI report | 13.1.0 | 13.2.0 |
|
| 917 |
+
| 2015-12 | CP-70 | CP-150730 | 0018 | 1 | Diameter Message Priority over Np | 13.1.0 | 13.2.0 |
|
| 918 |
+
| <b>Change history</b> | | | | | | | |
|
| 919 |
+
| <b>Date</b> | <b>TSG #</b> | <b>TSG Doc.</b> | <b>CR</b> | <b>Rev</b> | <b>Cat</b> | <b>Subject/Comment</b> | <b>New</b> |
|
| 920 |
+
| 2016-03 | CT#71 | CP-160094 | 0022 | 1 | F | Congestion Level for the specific user id | 13.3.0 |
|
| 921 |
+
| 2016-03 | CT#71 | CP-160094 | 0023 | 1 | F | Add command codes and AVP numbers for Np protocol | 13.3.0 |
|
| 922 |
+
| 2016-03 | CT#71 | CP-160093 | 0024 | - | F | Reference of the Diameter message priority mechanism procedure | 13.3.0 |
|
| 923 |
+
| 2016-03 | CT#71 | CP-160094 | 0025 | 1 | F | Add missing abbreviations | 13.3.0 |
|
| 924 |
+
| 2016-06 | CT#72 | CP-160276 | 0026 | 2 | F | Correct Modify-Uecontext-Answer command definition and some editorial errors | 13.4.0 |
|
| 925 |
+
| 2016-09 | CT#73 | CP-160442 | 0027 | - | F | Correction of IETF drmp draft version | 13.5.0 |
|
| 926 |
+
| 2016-09 | CT#73 | CP-160453 | 0028 | 1 | F | Correction to the Np reused Diameter AVPs table | 13.5.0 |
|
| 927 |
+
| 2016-12 | CT#74 | CP-160614 | 0029 | - | F | Correction to change IETF drmp draft version to official RFC 7944 | 13.6.0 |
|
| 928 |
+
| 2016-12 | CT#74 | CP-160615 | 0030 | 2 | B | Diameter Load Control Mechanism | 14.0.0 |
|
| 929 |
+
| 2016-12 | CT#74 | CP-160616 | 0031 | 1 | F | Diameter base protocol specification update | 14.0.0 |
|
| 930 |
+
| 2017-03 | CT#75 | CP-170086 | 0033 | 2 | F | Support of long and short Macro eNodeB IDs | 14.1.0 |
|
| 931 |
+
| 2017-03 | CT#75 | CP-170076 | 0034 | - | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 |
|
| 932 |
+
| 2017-06 | CT#76 | CP-171119 | 0035 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 |
|
| 933 |
+
| 2017-06 | CT#76 | CP-171133 | 0040 | 1 | F | Vendor-Specific-Application-Id AVP handling | 14.2.0 |
|
| 934 |
+
| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 |
|
| 935 |
+
| 2019-09 | CT#85 | CP-192154 | 0042 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.1.0 |
|
| 936 |
+
| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 |
|
| 937 |
+
| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 |
|
| 938 |
+
| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 |
|
marked/Rel-18/29_series/29219/raw.md
ADDED
|
@@ -0,0 +1,862 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.219 V18.0.0 (2024-03) ---
|
| 4 |
+
|
| 5 |
+
*Technical Specification*
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Policy and Charging Control: Spending Limit Reporting over Sy reference point (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right.
|
| 14 |
+
|
| 15 |
+
5G Advanced logo
|
| 16 |
+
|
| 17 |
+

|
| 18 |
+
|
| 19 |
+
The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
|
| 20 |
+
|
| 21 |
+
3GPP logo
|
| 22 |
+
|
| 23 |
+
## --- **Keywords**
|
| 24 |
+
|
| 25 |
+
UMTS, LTE, QoS, Charging, Policy
|
| 26 |
+
|
| 27 |
+
## **3GPP**
|
| 28 |
+
|
| 29 |
+
## --- **Postal address**
|
| 30 |
+
|
| 31 |
+
## --- **3GPP support office address**
|
| 32 |
+
|
| 33 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 34 |
+
Valbonne - FRANCE
|
| 35 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 36 |
+
|
| 37 |
+
## --- **Internet**
|
| 38 |
+
|
| 39 |
+
<http://www.3gpp.org>
|
| 40 |
+
|
| 41 |
+
## --- **Copyright Notification**
|
| 42 |
+
|
| 43 |
+
No part may be reproduced except as authorized by written permission.
|
| 44 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 45 |
+
|
| 46 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 47 |
+
All rights reserved.
|
| 48 |
+
|
| 49 |
+
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
|
| 50 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 51 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 52 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 53 |
+
|
| 54 |
+
## Contents
|
| 55 |
+
|
| 56 |
+
| | |
|
| 57 |
+
|--------------------------------------------------------------------|----|
|
| 58 |
+
| Foreword ..... | 5 |
|
| 59 |
+
| 1 Scope..... | 6 |
|
| 60 |
+
| 2 References..... | 6 |
|
| 61 |
+
| 3 Definitions and abbreviations ..... | 7 |
|
| 62 |
+
| 3.1 Definitions..... | 7 |
|
| 63 |
+
| 3.2 Abbreviations ..... | 7 |
|
| 64 |
+
| 4 Sy reference point ..... | 8 |
|
| 65 |
+
| 4.1 Overview ..... | 8 |
|
| 66 |
+
| 4.2 Sy Reference model ..... | 8 |
|
| 67 |
+
| 4.3 Subscriber Spending Limits ..... | 8 |
|
| 68 |
+
| 4.4 Functional elements..... | 9 |
|
| 69 |
+
| 4.4.1 PCRF ..... | 9 |
|
| 70 |
+
| 4.4.2 OCS ..... | 9 |
|
| 71 |
+
| 4.5 Spending Limits procedures over Sy reference point ..... | 9 |
|
| 72 |
+
| 4.5.1 Initial/Intermediate Spending Limit Report Request..... | 9 |
|
| 73 |
+
| 4.5.1.1 General..... | 9 |
|
| 74 |
+
| 4.5.1.2 Detailed behaviour of the PCRF ..... | 10 |
|
| 75 |
+
| 4.5.1.3 The behaviour of the OCS ..... | 10 |
|
| 76 |
+
| 4.5.2 Spending Limit Report ..... | 11 |
|
| 77 |
+
| 4.5.2.1 General..... | 11 |
|
| 78 |
+
| 4.5.2.2 The behaviour of the OCS ..... | 12 |
|
| 79 |
+
| 4.5.2.3 Detailed behaviour of the PCRF..... | 12 |
|
| 80 |
+
| 4.5.3 Final Spending Limit Report Request ..... | 12 |
|
| 81 |
+
| 4.5.3.1 General..... | 12 |
|
| 82 |
+
| 4.5.3.2 Detailed behaviour of the PCRF ..... | 13 |
|
| 83 |
+
| 4.5.3.3 The behaviour of the OCS ..... | 13 |
|
| 84 |
+
| 4.5.4 Sy Session Termination by the OCS ..... | 13 |
|
| 85 |
+
| 5 Sy protocol..... | 13 |
|
| 86 |
+
| 5.1 Protocol support ..... | 13 |
|
| 87 |
+
| 5.1.1 Use of Diameter base protocol ..... | 13 |
|
| 88 |
+
| 5.1.2 Void ..... | 14 |
|
| 89 |
+
| 5.1.3 Accounting functionality ..... | 14 |
|
| 90 |
+
| 5.1.4 Transport protocol ..... | 14 |
|
| 91 |
+
| 5.1.5 Advertising Application Support..... | 14 |
|
| 92 |
+
| 5.1.6 Use of the Supported-Features AVP ..... | 14 |
|
| 93 |
+
| 5.2 Initialization and maintenance of connection and session ..... | 15 |
|
| 94 |
+
| 5.3 Sy specific AVPs..... | 15 |
|
| 95 |
+
| 5.3.0 General ..... | 15 |
|
| 96 |
+
| 5.3.1 Policy-Counter-Identifier AVP ..... | 16 |
|
| 97 |
+
| 5.3.2 Policy-Counter-Status AVP..... | 16 |
|
| 98 |
+
| 5.3.3 Policy-Counter-Status-Report AVP ..... | 16 |
|
| 99 |
+
| 5.3.4 SL-Request-Type AVP..... | 16 |
|
| 100 |
+
| 5.3.5 Pending-Policy-Counter-Information AVP ..... | 16 |
|
| 101 |
+
| 5.3.6 Pending-Policy-Counter-Change-Time AVP ..... | 17 |
|
| 102 |
+
| 5.3.7 SN-Request-Type AVP ..... | 17 |
|
| 103 |
+
| 5.4 Sy re-used AVPs ..... | 17 |
|
| 104 |
+
| 5.5 Sy specific Experimental-Result-Code AVP values ..... | 18 |
|
| 105 |
+
| 5.5.1 General ..... | 18 |
|
| 106 |
+
| 5.5.2 Permanent Failures ..... | 18 |
|
| 107 |
+
| 5.5.3 Transient Failures ..... | 19 |
|
| 108 |
+
| 5.6 Sy Messages ..... | 19 |
|
| 109 |
+
| 5.6.1 Command-Code Values..... | 19 |
|
| 110 |
+
| 5.6.2 Spending-Limit-Request (SLR) command..... | 19 |
|
| 111 |
+
| 5.6.3 Spending-Limit-Answer (SLA) command ..... | 20 |
|
| 112 |
+
|
| 113 |
+
5.6.4 Spending-Status-Notification-Request (SNR) command..... 20
|
| 114 |
+
5.6.5 Spending-Status-Notification-Answer (SNA) command ..... 20
|
| 115 |
+
5.6.6 Session-Termination-Request (STR) command..... 21
|
| 116 |
+
5.6.7 Session-Termination-Answer (STA) command ..... 21
|
| 117 |
+
**Annex A (normative): User Identity for Fixed Broadband Access network convergence..... 22**
|
| 118 |
+
**Annex B (informative): Change history..... 23**
|
| 119 |
+
|
| 120 |
+
# --- Foreword
|
| 121 |
+
|
| 122 |
+
This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
|
| 123 |
+
|
| 124 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 125 |
+
|
| 126 |
+
Version x.y.z
|
| 127 |
+
|
| 128 |
+
where:
|
| 129 |
+
|
| 130 |
+
- x the first digit:
|
| 131 |
+
- 1 presented to TSG for information;
|
| 132 |
+
- 2 presented to TSG for approval;
|
| 133 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 134 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 135 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 136 |
+
|
| 137 |
+
# --- 1 Scope
|
| 138 |
+
|
| 139 |
+
The present document provides the stage 3 specification of the Sy reference point for the present release. The functional requirements and the stage 2 specifications of the Sy reference point are contained in TS 23.203 [2]. The Sy reference point lies between the Policy and Charging Rule Function (PCRF) and the Online Charging System (OCS). The internal OCS functionality for policy counter provision management pertaining to Sy is specified in TS 32.296 [16].
|
| 140 |
+
|
| 141 |
+
# --- 2 References
|
| 142 |
+
|
| 143 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 144 |
+
|
| 145 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 146 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 147 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 148 |
+
|
| 149 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 150 |
+
- [2] 3GPP TS 23.203: "Policy Control and Charging architecture".
|
| 151 |
+
- [3] Void.
|
| 152 |
+
- [4] IETF RFC 4005: "Diameter Network Access Server Application"
|
| 153 |
+
- [5] IETF RFC 4006: "Diameter Credit Control Application".
|
| 154 |
+
- [6] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations"
|
| 155 |
+
- [7] IETF RFC 2234: "Augmented BNF for syntax specifications".
|
| 156 |
+
- [8] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping".
|
| 157 |
+
- [9] Void.
|
| 158 |
+
- [10] Void.
|
| 159 |
+
- [11] Void.
|
| 160 |
+
- [12] Void.
|
| 161 |
+
- [13] IETF RFC 791: "Transmission Control Protocol".
|
| 162 |
+
- [14] IETF RFC 4960: "Stream Control Transmission Protocol".
|
| 163 |
+
- [15] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol".
|
| 164 |
+
- [16] 3GPP TS 32.296: "Telecommunication management; charging management; Online Charging System (OCS) applications and interfaces".
|
| 165 |
+
- [17] ETSI TS 283 034 v2.2.0: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol".
|
| 166 |
+
- [18] IETF RFC 3046: "DHCP Relay Agent Information Option".
|
| 167 |
+
- [19] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points".
|
| 168 |
+
|
| 169 |
+
- [20] IETF RFC 7683: "Diameter Overload Indication Conveyance".
|
| 170 |
+
- [21] IETF RFC 7944: "Diameter Routing Message Priority".
|
| 171 |
+
- [22] IETF RFC 8583: "Diameter Load Information Conveyance".
|
| 172 |
+
- [23] IETF RFC 6733: "Diameter Base Protocol".
|
| 173 |
+
|
| 174 |
+
# --- 3 Definitions and abbreviations
|
| 175 |
+
|
| 176 |
+
## 3.1 Definitions
|
| 177 |
+
|
| 178 |
+
For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
|
| 179 |
+
|
| 180 |
+
**policy counter:** A mechanism within the OCS to track spending applicable for a subscriber.
|
| 181 |
+
|
| 182 |
+
**policy counter identifier:** A reference to a policy counter in the OCS for a subscriber.
|
| 183 |
+
|
| 184 |
+
**policy counter status:** A label whose values are not standardized and that is associated with a policy counter's value relative to the spending limit(s) (the number of possible policy counter status values for a policy counter is one greater than the number of thresholds associated with that policy counter, i.e policy counter status values describe the status around the thresholds). This is used to convey information relating to subscriber spending from OCS to PCRF. Specific labels are configured jointly in OCS and PCRF.
|
| 185 |
+
|
| 186 |
+
**spending limit:** A spending limit is the usage limit of a policy counter (e.g. monetary, volume, duration) that a subscriber is allowed to consume.
|
| 187 |
+
|
| 188 |
+
**spending limit report:** a notification, containing the current policy counter status generated from the OCS to the PCRF via the Sy reference point.
|
| 189 |
+
|
| 190 |
+
## 3.2 Abbreviations
|
| 191 |
+
|
| 192 |
+
For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
|
| 193 |
+
|
| 194 |
+
| | |
|
| 195 |
+
|------|----------------------------------------------------|
|
| 196 |
+
| DRMP | Diameter Routing Message Priority |
|
| 197 |
+
| OCS | Online charging system |
|
| 198 |
+
| OFCS | Offline charging system |
|
| 199 |
+
| PCEF | Policy and Charging Enforcement Function |
|
| 200 |
+
| PCRF | Policy and Charging Rule Function |
|
| 201 |
+
| RCAF | RAN Congestion Awareness Function |
|
| 202 |
+
| SLA | Spending-Limit-Answer (SL-Answer) |
|
| 203 |
+
| SLR | Spending-Limit-Request (SL- Request) |
|
| 204 |
+
| SNA | Spending-Status-Notification-Answer (SN-Answer) |
|
| 205 |
+
| SNR | Spending-Status-Notification-Request (SN- Request) |
|
| 206 |
+
| STA | Session-Termination-Answer (ST-Answer) |
|
| 207 |
+
| STR | Session-Termination-Request (ST- Request) |
|
| 208 |
+
|
| 209 |
+
# --- 4 Sy reference point
|
| 210 |
+
|
| 211 |
+
## 4.1 Overview
|
| 212 |
+
|
| 213 |
+
The Sy reference point is located between the Policy and Charging Rules Function (PCRF) and the Online Charging System (OCS). The Sy reference point enables transfer of policy counter status information relating to subscriber spending from OCS to PCRF and supports the following functions:
|
| 214 |
+
|
| 215 |
+
- Request of policy counter status reporting from PCRF to OCS and subscribe to or unsubscribe from spending limit reports (i.e. notifications of policy counter status changes).
|
| 216 |
+
- Notification of spending limit reports from OCS to PCRF.
|
| 217 |
+
- Cancellation of spending limit reporting from PCRF to OCS.
|
| 218 |
+
|
| 219 |
+
Since the Sy reference point resides between the PCRF and OCS in the HPLMN, roaming with home routed or visited access as well as non-roaming scenarios are supported in the same manner.
|
| 220 |
+
|
| 221 |
+
The stage 2 level requirements for the Sy reference point are defined in 3GPP TS 23.203 [2].
|
| 222 |
+
|
| 223 |
+
Signalling flows related to the Sy interface are specified in 3GPP TS 29.213 [8].
|
| 224 |
+
|
| 225 |
+
Refer to Annex G of 3GPP TS 29.213 [8] for Diameter overload control procedures over the Sy interface.
|
| 226 |
+
|
| 227 |
+
Refer to Annex J of 3GPP TS 29.213 [8] for Diameter message priority mechanism procedures over the Sy interface.
|
| 228 |
+
|
| 229 |
+
Refer to Annex K of 3GPP TS 29.213 [8] for Diameter load control procedures over the Sy interface.
|
| 230 |
+
|
| 231 |
+
## 4.2 Sy Reference model
|
| 232 |
+
|
| 233 |
+
The Sy reference point is defined between the PCRF and the OCS. The relationships between the involved functional entities are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [8]
|
| 234 |
+
|
| 235 |
+

|
| 236 |
+
|
| 237 |
+
The diagram shows two rectangular boxes, one on the left labeled 'PCRF' and one on the right labeled 'OCS'. A horizontal line connects the two boxes. Above the line, centered between the boxes, is the label 'Sy'. There is a small vertical tick mark on the line directly below the 'Sy' label.
|
| 238 |
+
|
| 239 |
+
Diagram of the Sy reference model showing PCRF and OCS connected by the Sy interface.
|
| 240 |
+
|
| 241 |
+
Figure 4.2.1: Sy reference model
|
| 242 |
+
|
| 243 |
+
.Figure 4.2.2: Void
|
| 244 |
+
|
| 245 |
+
## 4.3 Subscriber Spending Limits
|
| 246 |
+
|
| 247 |
+
Policy decisions based on spending limits is a function that allows the PCRF to make policy decisions based on the status of policy counters that are maintained in the OCS. The PCRF uses the policy counter statuses received from the OCS as input to its policy decisions, e.g. downgrade the QoS (e.g. APN-AMBR) or modify the PCC/QoS/ADC Rules.
|
| 248 |
+
|
| 249 |
+
When the status of policy counters is first required to make a policy decision for a subscriber, the PCRF uses the Initial Spending Limit Report Request procedure. The PCRF may request specific or all policy counter statuses to be reported by the OCS for the user. The OCS provides the status to the PCRF of the requested policy counters, and will notify the PCRF of any changes in the status of those policy counters. Optionally, the OCS can provide one or more pending statuses for a requested policy counter with the times that have to be applied. The pending status of a policy counter shall autonomously become the current status of a policy counter at the PCRF when the indicated corresponding time is reached. Subsequently, the provided information for pending statuses of a policy counter shall overwrite the previously received information.
|
| 250 |
+
|
| 251 |
+
NOTE 1: The mechanism for provisioning the policy counters in the OCS is out of scope of this document.
|
| 252 |
+
|
| 253 |
+
NOTE 2: A policy counter in the OCS can represent the spending for one or more services, one or more devices, one or more subscribers, etc. The representation is operator dependent. There is no explicit relationship between Charging-Key and policy counter.
|
| 254 |
+
|
| 255 |
+
The PCRF may request reporting for specific policy counter(s) that it is not currently subscribed and/or cancel reporting for specific policy counter status(es) using the Intermediate Spending Limit Report Request. The PCRF may cancel spending limit reporting for all policy counter(s) using the Final Spending Limit Report Request.
|
| 256 |
+
|
| 257 |
+
The updated subscriber profile may also trigger the PCRF sending the Initial/Intermediate/Final Spending Limit Report Request to the OCS to subscribe and/or cancel reporting for policy counter status(es). If spending limit reporting for a policy counter is enabled, the OCS shall notify the PCRF of changes in the status of this policy counter (e.g. daily spending limit of \$2 reached) and optionally pending statuses of this policy counter with the activation time (e.g. due to a billing period that will expire at midnight).
|
| 258 |
+
|
| 259 |
+
## 4.4 Functional elements
|
| 260 |
+
|
| 261 |
+
### 4.4.1 PCRF
|
| 262 |
+
|
| 263 |
+
The Policy Control and Charging Rules Function (PCRF) is a functional element that encompasses policy control decision and flow based charging control functionalities.
|
| 264 |
+
|
| 265 |
+
The PCRF may take information on the subscriber's spending status into account in its policy decisions. The PCRF may request spending limit reporting for policy counters from the OCS using the Initial or Intermediate Spending Limit Report Request procedure as specified in clause 4.5.1. The PCRF may cancel spending limit reporting for specific policy counter(s) using the Intermediate Spending Limit Report Request procedure, or for all policy counter(s) using the Final Spending Limit Report Request procedure as specified in clause 4.5.3.
|
| 266 |
+
|
| 267 |
+
The PCRF shall have at least one active IP-CAN session to be able to initiate an Sy session to be used when required for spending limit reporting for that subscriber. The PCRF shall terminate the Sy session when the last IP-CAN session for that subscriber is terminated or no IP-CAN session for the same user depends on the spending status information provided over Sy reference point.
|
| 268 |
+
|
| 269 |
+
The PCRF may use the status of each relevant policy counter as input to its policy decision as required by the decision logic.
|
| 270 |
+
|
| 271 |
+
### 4.4.2 OCS
|
| 272 |
+
|
| 273 |
+
The Online Charging System (OCS), for the purpose of policy decisions based on the subscriber's spending, shall:
|
| 274 |
+
|
| 275 |
+
- maintain the policy counter statuses applicable for a subscriber.
|
| 276 |
+
- report the policy counter status values for the subscriber when requested to the PCRF.
|
| 277 |
+
- when a policy counter status changes, report the change to the PCRF.
|
| 278 |
+
|
| 279 |
+
## 4.5 Spending Limits procedures over Sy reference point
|
| 280 |
+
|
| 281 |
+
### 4.5.1 Initial/Intermediate Spending Limit Report Request
|
| 282 |
+
|
| 283 |
+
#### 4.5.1.1 General
|
| 284 |
+
|
| 285 |
+
This procedure shall be used by the PCRF to request the status of policy counters available at the OCS, and to subscribe or unsubscribe to updates of policy counters by the OCS.
|
| 286 |
+
|
| 287 |
+
This procedure is mapped to the Spending-Limit-Request/Answer commands specified in clause 5.6.
|
| 288 |
+
|
| 289 |
+
**Table 4.5.1.1/1: Initial/Intermediate Spending Limit Report Request**
|
| 290 |
+
|
| 291 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 292 |
+
|-------------------------------------------|---------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 293 |
+
| User Identity | Subscription-Id, Logical-Access-ID AVP, Physical-Access-ID (NOTE 1) | C | This IE shall contain the identity of the user. It shall be present in the initial request when the SL-Request-Type=INITIAL_REQUEST. |
|
| 294 |
+
| Request Type | SL-Request-Type | M | This IE shall indicate whether this is the initial or a subsequent request for the user. |
|
| 295 |
+
| Subscribed Policy Counter Identifier List | Policy-Counter-Identifier | O | This IE shall indicate the list of policy counter identifiers to be subscribed to. In the intermediate spending limit report request procedure, this list overrides a previously provisioned list. If omitted in either the Initial or Intermediate Spending Limit Report Request procedures the PCRF requests subscription to all available policy counters. |
|
| 296 |
+
|
| 297 |
+
NOTE 1: The Logical-Access-ID AVP and Physical-Access-ID AVP are only applicable to Fixed Broadband Access network convergence as defined in annex A.
|
| 298 |
+
|
| 299 |
+
**Table 4.5.1.1/2: Initial/Intermediate Spending Limit Report Response**
|
| 300 |
+
|
| 301 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 302 |
+
|------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 303 |
+
| Policy Counter Status Report | Policy-Counter-Status-Report | O | If present, this information element shall contain a policy counter identifier, the current status value and if applicable pending policy counter statuses with the activation times. |
|
| 304 |
+
| Result | Result-Code or Experimental-Result | M | This IE shall contain the result of the operation. |
|
| 305 |
+
|
| 306 |
+
#### 4.5.1.2 Detailed behaviour of the PCRF
|
| 307 |
+
|
| 308 |
+
The PCRF shall make use of this procedure when it determines for a subscriber that
|
| 309 |
+
|
| 310 |
+
- The status of policy counter(s) to which the PCRF does not have an existing subscription for status change notifications is/are required.
|
| 311 |
+
- The status of one or more, but not all, policy counter(s) to which the PCRF has an existing subscription for status change notifications are no longer required.
|
| 312 |
+
|
| 313 |
+
NOTE: The Final Spending Limit Request procedure in clause 4.5.3 is used to remove all subscriptions.
|
| 314 |
+
|
| 315 |
+
In the initial request, i.e. when the request is sent for the first time for the Subscriber, the PCRF shall set the SL-Request-Type AVP to the value INITIAL\_REQUEST (0). For subsequent requests for the same Subscriber, the PCRF shall set the SL-Request-Type AVP to INTERMEDIATE\_REQUEST (1).
|
| 316 |
+
|
| 317 |
+
For each policy counter that the PCRF requires the current status and notifications of future status changes, the PCRF shall indicate the concerned policy counter identifiers in the request. Alternatively, the policy counter identifiers may be omitted if the PCRF requires the current status and notifications of future status changes of all available policy counters.
|
| 318 |
+
|
| 319 |
+
#### 4.5.1.3 The behaviour of the OCS
|
| 320 |
+
|
| 321 |
+
Upon reception of the request from the PCRF, the OCS shall check if there is an ongoing Sy session associated with the received Session-Id AVP. If there is no Sy session and the SL-Request-Type AVP is set to INITIAL\_REQUEST (0), an Sy session is created on the OCS. If there is an Sy session and the SL-Request-Type AVP is not set to INTERMEDIATE\_REQUEST (1), the OCS shall return a response with the Result-Code set to DIAMETER\_INVALID\_AVP\_VALUE and with the Failed-AVP AVP containing the SL-Request-Type AVP. If there is no Sy session and the SL-Request-Type AVP is not set to INITIAL\_REQUEST (0), the OCS shall return a response with the Result-Code AVP set to DIAMETER\_UNKNOWN\_SESSION\_ID.
|
| 322 |
+
|
| 323 |
+
Upon reception of the request from the PCRF provided with explicit Policy Counter Identifier(s):
|
| 324 |
+
|
| 325 |
+
If all the policy counter identifiers are known to the OCS, the OCS shall be able to subsequently notify the PCRF of any policy counter state changes and/or additions, removal or changes of pending policy counter statuses along with their activation time.
|
| 326 |
+
|
| 327 |
+
If a policy counter identifier is known by the OCS, but is not applicable to the subscriber (e.g. not provisioned), the OCS may use an operator configured policy counter status to indicate this to the PCRF.
|
| 328 |
+
|
| 329 |
+
If the OCS is configured to accept the request provided with unknown policy counter identifier(s), and if the OCS determines that one or more policy counter identifiers are unknown, an operator configured policy counter status may be used to indicate the policy counter identifier(s) determined as unknown by OCS. The status of known policy counter identifier(s) shall be returned to the PCRF in the same procedure in this case.
|
| 330 |
+
|
| 331 |
+
Alternatively, if the OCS is configured to reject the request provided with unknown policy counter identifier(s), and if the OCS determines that one or more policy counter identifiers are unknown, the OCS shall return a response with the Experimental-Result-Code AVP set to DIAMETER\_ERROR\_UNKNOWN\_POLICY\_COUNTERS and with the Failed-AVP AVP indicating the unknown policy counter identifiers. When this failure occurs, if the SL-Request-Type AVP is set to:
|
| 332 |
+
|
| 333 |
+
- INITIAL\_REQUEST (0), then the Sy session is not created.
|
| 334 |
+
- INTERMEDIATE\_REQUEST (1), then none of the changes in the request take effect but the Sy session is maintained.
|
| 335 |
+
|
| 336 |
+
NOTE 1: In order to avoid misbehaviors due to the policy counters maintained in the Sy session, the PCRF can terminate the Sy session invoking the Final Spending Limit Request procedure in clause 4.5.3.
|
| 337 |
+
|
| 338 |
+
When the PCRF provides a new subscribed policy counter identifier list, the OCS shall remove any policy counter identifiers no longer in the list from association with the Sy session such that the OCS will no longer notify the PCRF of those policy counter state changes.
|
| 339 |
+
|
| 340 |
+
If an initial or intermediate request contains no policy counter identifiers, the OCS shall subsequently notify the PCRF of all available policy counter state changes and optionally the pending policy counter statuses with the activation times. If the OCS has no available policy counters for that subscriber during the Initial Spending Limit Report Request procedure, it sets the Experimental-Result-Code to DIAMETER\_ERROR\_NO\_AVAILABLE\_POLICY\_COUNTERS. When this failure occurs, if the SL-Request-Type AVP is set to:
|
| 341 |
+
|
| 342 |
+
- INITIAL\_REQUEST (0), then the Sy session is not created.
|
| 343 |
+
- INTERMEDIATE\_REQUEST (1), then none of the changes in the request take effect but the Sy session is maintained.
|
| 344 |
+
|
| 345 |
+
NOTE 2: The PCRF can terminate the Sy session invoking the Final Spending Limit Request procedure in clause 4.5.3, or maintain the Sy session assuming that further available policy counters will be notified.
|
| 346 |
+
|
| 347 |
+
If the user identified in an initial request is not known to the OCS, the OCS shall reject the Spending Limit Report Request by including the result code of DIAMETER\_USER\_UNKNOWN in the Spending Limit Report Answer. In this case, the Sy session is not created.
|
| 348 |
+
|
| 349 |
+
Upon successful creation of an Sy session, the OCS shall include the current status of all subscribed policy counters (if any) in the response and set the Result-Code to DIAMETER\_SUCCESS.
|
| 350 |
+
|
| 351 |
+
### 4.5.2 Spending Limit Report
|
| 352 |
+
|
| 353 |
+
#### 4.5.2.1 General
|
| 354 |
+
|
| 355 |
+
This procedure shall be used by the OCS to notify the PCRF of changes in the status of subscribed policy counter(s).
|
| 356 |
+
|
| 357 |
+
This procedure is mapped to the Spending-Status-Notification-Request /Answer commands specified commands specified in clause 5.6.
|
| 358 |
+
|
| 359 |
+
**Table 4.5.2.1/1: Spending Limit Report Request**
|
| 360 |
+
|
| 361 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 362 |
+
|------------------------------|------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 363 |
+
| Policy Counter Status Report | Policy-Counter-Status-Report | M | If present, this information element shall contain a policy counter identifier, the current status value and if applicable pending policy counter statuses with the activation times. |
|
| 364 |
+
|
| 365 |
+
**Table 4.5.2.1/2: Spending Limit Report Response**
|
| 366 |
+
|
| 367 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 368 |
+
|--------------------------|------------------------------------|------|----------------------------------------------------|
|
| 369 |
+
| Result | Result-Code or Experimental-Result | M | This IE shall contain the result of the operation. |
|
| 370 |
+
|
| 371 |
+
#### 4.5.2.2 The behaviour of the OCS
|
| 372 |
+
|
| 373 |
+
When the status of a specific policy counter changes or when pending statuses associated with the policy counter are added, removed or changed, the OCS shall determine the Sy sessions impacted by the change (i.e. those Sy sessions that have subscribed to status change notifications for the changed policy counter) and send a Spending-Status-Notification-Request command including the current policy counter status, and if applicable pending policy counter statuses with the activation times to the PCRF associated with each affected Sy session. The OCS shall not send the policy counter status for the same policy counter until it received the response of the previous status report of the policy counter.
|
| 374 |
+
|
| 375 |
+
If several policy counters change status at the same time, the OCS may group the status change notifications into a single Spending-Status-Notification-Request command to the PCRF by sending multiple Policy-Counter-Status-Report AVPs in the request.
|
| 376 |
+
|
| 377 |
+
#### 4.5.2.3 Detailed behaviour of the PCRF
|
| 378 |
+
|
| 379 |
+
The PCRF shall acknowledge the request by sending a response with a Result-Code AVP set to DIAMETER\_SUCCESS and use the status of the received policy counter(s) as input to its policy decision to apply operator defined actions, e.g. downgrade the QoS.
|
| 380 |
+
|
| 381 |
+
NOTE: The values related to the status of a policy counter (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the values are out of scope of 3GPP.
|
| 382 |
+
|
| 383 |
+
The PCRF shall ignore an unknown policy counter status report for all unknown policy counter identifiers in an SLA or in an SNR from the OCS.
|
| 384 |
+
|
| 385 |
+
If the PCRF receives an SNR command while it has an ongoing SLR transaction with the OCS, the PCRF shall update the policy counter information based on the SNR command. When the corresponding SLA command for the ongoing SLR transaction is eventually received, the PCRF shall only update policy counter information for counters that were not provided in the previously received SNR command.
|
| 386 |
+
|
| 387 |
+
If the PCRF receives a Policy-Counter-Status-Report with one or more Pending-Policy-Counter-Information AVPs, then at the time defined by the Pending-Policy-Counter-Change-Time AVP, the pending Policy-Counter-Status shall autonomously become the current status of a policy counter. Subsequently provided information for pending statuses of a policy counter shall overwrite the previously received information. If the pending policy counter statuses are applicable to a policy counter identifier but the Pending-Policy-Counter-Information AVPs are omitted in the new policy counter status report, the PCRF shall remove all the pending policy counter statuses.
|
| 388 |
+
|
| 389 |
+
### 4.5.3 Final Spending Limit Report Request
|
| 390 |
+
|
| 391 |
+
#### 4.5.3.1 General
|
| 392 |
+
|
| 393 |
+
This procedure shall be used by the PCRF to unsubscribe to any future updates of policy counters for a given subscriber by the OCS.
|
| 394 |
+
|
| 395 |
+
This procedure is mapped to the Session-Termination-Request/Answer commands specified in IETF RFC 6733 [23].
|
| 396 |
+
|
| 397 |
+
**Table 4.5.3.1/1: Final Spending Limit Report Request**
|
| 398 |
+
|
| 399 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 400 |
+
|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------|
|
| 401 |
+
| Termination Cause | Termination-Cause | M | This IE shall contain the reason why the session was terminated. It shall be set to "DIAMETER_LOGOUT". |
|
| 402 |
+
|
| 403 |
+
**Table 4.5.3.1/2: Final Spending Limit Report Response**
|
| 404 |
+
|
| 405 |
+
| Information element name | Mapping to Diameter AVP | Cat. | Description |
|
| 406 |
+
|--------------------------|-------------------------|------|----------------------------------------------------|
|
| 407 |
+
| Result | Result-Code | M | This IE shall contain the result of the operation. |
|
| 408 |
+
|
| 409 |
+
#### 4.5.3.2 Detailed behaviour of the PCRF
|
| 410 |
+
|
| 411 |
+
When the PCRF decides that policy decisions for a given user no longer depend on policy counter(s) to which the PCRF has existing subscriptions for status change notifications, the PCRF shall send the Final Spending Limit Report Request to the OCS.
|
| 412 |
+
|
| 413 |
+
#### 4.5.3.3 The behaviour of the OCS
|
| 414 |
+
|
| 415 |
+
Upon reception of the request from the PCRF, the OCS shall check that there is an ongoing Sy session associated with the received Session-Id AVP. If there is no Sy session, the OCS shall return a response with the Result-Code AVP set to DIAMETER\_UNKNOWN\_SESSION\_ID.
|
| 416 |
+
|
| 417 |
+
The OCS shall remove all policy counter subscriptions associated with the Sy session such that the OCS will no longer notify the PCRF of policy counter state changes and close the session by returning a response with the Result-Code AVP set to DIAMETER\_SUCCESS.
|
| 418 |
+
|
| 419 |
+
### 4.5.4 Sy Session Termination by the OCS
|
| 420 |
+
|
| 421 |
+
If the ASR feature is supported, and the OCS decides that the Sy session for a subscriber needs to be terminated (e.g. because subscriber is removed from an OCS system), the OCS shall send the Spending-Status-Notification-Request (SNR) containing the SN-Request-Type AVP with bit 1 (Abort Session Request) set to the PCRF.
|
| 422 |
+
|
| 423 |
+
Upon receipt of the SNR containing the SN-Request-Type AVP with bit 1 set, the PCRF shall acknowledge the receipt of the SNR by sending the Spending-Status-Notification-Answer (SNA) and shall then send a Final Spending Limit Report Request as specified in clause 4.5.3.
|
| 424 |
+
|
| 425 |
+
NOTE: The termination of the Sy session causes the H-PCRF to make the applicable policy decision and act accordingly, i.e. sessions on other interfaces such as the Rx or Gx interface will remain established, unless the policy decision causes their termination.
|
| 426 |
+
|
| 427 |
+
# 5 Sy protocol
|
| 428 |
+
|
| 429 |
+
## 5.1 Protocol support
|
| 430 |
+
|
| 431 |
+
### 5.1.1 Use of Diameter base protocol
|
| 432 |
+
|
| 433 |
+
The Diameter Base Protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified.
|
| 434 |
+
|
| 435 |
+
With regard to the Diameter protocol defined over the Sy interface, the OCS acts as a Diameter server, in the sense that it is the network element that handles policy counter status requests for a particular realm. The PCRF acts as the Diameter client, in the sense that it is the network element requesting policy counter status to the OCS.
|
| 436 |
+
|
| 437 |
+
A Diameter routing table entry can have a different destination based on the application identifier of the command. The application identifier stored in the command header must match the value of any application identifier AVPs in the command body. Diameter agents (relay, proxy, redirection, translation agents) should use the application identifier in the command header to route to a suitable destination.
|
| 438 |
+
|
| 439 |
+
### 5.1.2 Void
|
| 440 |
+
|
| 441 |
+
### 5.1.3 Accounting functionality
|
| 442 |
+
|
| 443 |
+
Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the Sy interface.
|
| 444 |
+
|
| 445 |
+
### 5.1.4 Transport protocol
|
| 446 |
+
|
| 447 |
+
Diameter messages over the Sy interface shall make use of TCP IETF RFC 791 [13] or SCTP IETF RFC 4960 [14].
|
| 448 |
+
|
| 449 |
+
### 5.1.5 Advertising Application Support
|
| 450 |
+
|
| 451 |
+
The Diameter application identifier assigned to the Sy interface application is 16777302.
|
| 452 |
+
|
| 453 |
+
The PCRF and OCS shall advertise support of the Diameter Sy Application by including the value of the Sy application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands.
|
| 454 |
+
|
| 455 |
+
The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands.
|
| 456 |
+
|
| 457 |
+
The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23].
|
| 458 |
+
|
| 459 |
+
### 5.1.6 Use of the Supported-Features AVP
|
| 460 |
+
|
| 461 |
+
The Supported-Features AVP is used during session establishment to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP on the Sy reference point shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of TS 29.229 [15].
|
| 462 |
+
|
| 463 |
+
The base functionality for the Sy reference point is the 3GPP Rel-11 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Sy commands. As defined in clause 7.1.1 of TS 29.229 [15], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF.
|
| 464 |
+
|
| 465 |
+
As defined in TS 29.229 [15], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the Sy reference point, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the Sy reference point, the Feature-List-ID AVP shall differentiate those lists from one another.
|
| 466 |
+
|
| 467 |
+
On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of TS 29.229 [15]. The following exceptions apply to the initial SLR/SLA command pair:
|
| 468 |
+
|
| 469 |
+
- If the PCRF supports any supported features defined for Sy, the SLR shall include the features supported by the PCRF within Supported-Features AVP(s) with the 'M' bit cleared.
|
| 470 |
+
|
| 471 |
+
NOTE 2: One instance of Supported-Features AVP is needed per Feature-List-ID.
|
| 472 |
+
|
| 473 |
+
- If the SLR command does not contain any Supported-Features AVP(s) and the OCS supports no supported features defined for Sy functionality, the OCS shall not include the Supported-Features AVP in the SLA command. In this case, both PCRF and OCS shall not use any supported features defined for Sy.
|
| 474 |
+
|
| 475 |
+
Once the PCRF and OCS have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session.
|
| 476 |
+
|
| 477 |
+
The table below defines the features applicable to the Sy interface for the feature list with a Feature-List-ID of 1.
|
| 478 |
+
|
| 479 |
+
**Table 5.1.6-1: Features of Feature-List-ID 1 used on the Sy interface**
|
| 480 |
+
|
| 481 |
+
| Feature bit | Feature | M/O | Description |
|
| 482 |
+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|----------------------------------------------------------------|
|
| 483 |
+
| 0 | ASR | O | Sy Session Termination by the OCS as specified in clause 4.5.4 |
|
| 484 |
+
| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".<br>Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".<br>M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").<br>Description: A clear textual description of the feature. | | | |
|
| 485 |
+
|
| 486 |
+
## 5.2 Initialization and maintenance of connection and session
|
| 487 |
+
|
| 488 |
+
The Diameter protocol between the PCRF and the OCS, shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session.
|
| 489 |
+
|
| 490 |
+
Each Diameter session shall identify a Sy session for a given user. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [23]).
|
| 491 |
+
|
| 492 |
+
The PCRF shall link the Gx session(s) or S9 session with the Sy session at Sy session initialization and maintain that until the IP-CAN session(s) for that subscriber are terminated or no IP-CAN session for the same user depends on the spending status information provided over Sy reference point.
|
| 493 |
+
|
| 494 |
+
## 5.3 Sy specific AVPs
|
| 495 |
+
|
| 496 |
+
### 5.3.0 General
|
| 497 |
+
|
| 498 |
+
Table 5.3.0.1 describes the Diameter AVPs defined for the Sy reference point, their AVP Code values, types and possible flag values. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415).
|
| 499 |
+
|
| 500 |
+
**Table 5.3.0.1: Sy specific Diameter AVPs**
|
| 501 |
+
|
| 502 |
+
| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules (Note 1) | | | | Applicability (Note 2) |
|
| 503 |
+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------|------------|-------------------------|-----|------------|----------|------------------------|
|
| 504 |
+
| | | | | Must | May | Should not | Must not | |
|
| 505 |
+
| Pending-Policy-Counter-Information | 2905 | 5.3.5 | Grouped | M,V | P | | | |
|
| 506 |
+
| Pending-Policy-Counter-Change-Time | 2906 | 5.3.6 | Time | M,V | P | | | |
|
| 507 |
+
| Policy-Counter-Identifier | 2901 | 5.3.1 | UTF8String | M,V | P | | | |
|
| 508 |
+
| Policy-Counter-Status | 2902 | 5.3.2 | UTF8String | M,V | P | | | |
|
| 509 |
+
| Policy-Counter-Status-Report | 2903 | 5.3.3 | Grouped | M,V | P | | | |
|
| 510 |
+
| SL-Request-Type | 2904 | 5.3.4 | Enumerated | M,V | P | | | |
|
| 511 |
+
| SN-Request-Type | 2907 | 5.3.7 | Unsigned32 | V | P | | M | ASR |
|
| 512 |
+
| NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. | | | | | | | | |
|
| 513 |
+
| NOTE 2: AVPs marked with a supported feature are applicable as described in clause 5.1.6. | | | | | | | | |
|
| 514 |
+
|
| 515 |
+
### 5.3.1 Policy-Counter-Identifier AVP
|
| 516 |
+
|
| 517 |
+
The Policy-Counter-Identifier AVP (AVP code 2901) is of type UTF8String, and it uniquely identifies a policy counter that is maintained per subscriber within the OCS.
|
| 518 |
+
|
| 519 |
+
### 5.3.2 Policy-Counter-Status AVP
|
| 520 |
+
|
| 521 |
+
The Policy-Counter-Status AVP (AVP code 2902) is of type UTF8String, and identifies the policy counter status applicable for a specific policy counter and subscriber.
|
| 522 |
+
|
| 523 |
+
NOTE: The valid values for the Policy-Counter-Status AVP are specific for each Policy-Counter-Identifier value.
|
| 524 |
+
|
| 525 |
+
The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.
|
| 526 |
+
|
| 527 |
+
### 5.3.3 Policy-Counter-Status-Report AVP
|
| 528 |
+
|
| 529 |
+
The Policy-Counter-Status-Report AVP (AVP code 2903) is of type Grouped. It is used by the OCS to report the status of a specific policy counter.
|
| 530 |
+
|
| 531 |
+
Associated pending policy counter statuses shall always be provided within Pending-Policy-Counter-Information AVPs if the pending policy counter statuses are applicable to the policy counter identifier. If there are no Pending-Policy-Counter-Information AVPs provided within the Policy-Counter-Status-Report AVP, previously provided pending counter statuses are removed. In addition, newly provided pending policy counter statuses overwrite previously provided ones.
|
| 532 |
+
|
| 533 |
+
AVP Format:
|
| 534 |
+
|
| 535 |
+
```
|
| 536 |
+
Policy-Counter-Status-Report ::= < AVP Header: 2903 >
|
| 537 |
+
{ Policy-Counter-Identifier }
|
| 538 |
+
{ Policy-Counter-Status }
|
| 539 |
+
*[ Pending-Policy-Counter-Information ]
|
| 540 |
+
*[ AVP ]
|
| 541 |
+
```
|
| 542 |
+
|
| 543 |
+
### 5.3.4 SL-Request-Type AVP
|
| 544 |
+
|
| 545 |
+
The SL-Request-Type AVP (AVP code 2904) is of type Enumerated, and informs the OCS whether the SLR command is being sent as part of the initial or intermediate spending limit report request procedure.
|
| 546 |
+
|
| 547 |
+
The following values are defined:
|
| 548 |
+
|
| 549 |
+
INITIAL\_REQUEST (0)
|
| 550 |
+
|
| 551 |
+
This value indicates that this is the first request in the Diameter session.
|
| 552 |
+
|
| 553 |
+
INTERMEDIATE\_REQUEST (1)
|
| 554 |
+
|
| 555 |
+
This value indicates that this is the second or subsequent request in the Diameter session.
|
| 556 |
+
|
| 557 |
+
### 5.3.5 Pending-Policy-Counter-Information AVP
|
| 558 |
+
|
| 559 |
+
The Pending-Policy-Counter-Information AVP (AVP code 2905) is of type Grouped, which contains the pending policy counter status and the active time. If multiple pending policy counter AVPs are included, they shall be sorted in order of change time.
|
| 560 |
+
|
| 561 |
+
AVP Format:
|
| 562 |
+
|
| 563 |
+
```
|
| 564 |
+
Pending-Policy-Counter-Information ::= < AVP Header: 2905 >
|
| 565 |
+
{ Policy-Counter-Status }
|
| 566 |
+
{ Pending-Policy-Counter-Change-Time }
|
| 567 |
+
*[ AVP ]
|
| 568 |
+
```
|
| 569 |
+
|
| 570 |
+
NOTE: The valid values for the Pending-Policy-Counter-Information AVP are specific for each Policy-Counter-Identifier value.
|
| 571 |
+
|
| 572 |
+
### 5.3.6 Pending-Policy-Counter-Change-Time AVP
|
| 573 |
+
|
| 574 |
+
The Pending-Policy-Counter-Change-Time AVP (AVP code 2906) is of type Time. This value indicates the NTP time at which the pending policy counter status becomes the current status of a policy counter.
|
| 575 |
+
|
| 576 |
+
### 5.3.7 SN-Request-Type AVP
|
| 577 |
+
|
| 578 |
+
The SN-Request-Type AVP (AVP code 2907) shall be of type Unsigned32 and shall contain a bit mask, and informs the PCRF about the type of the Spending-Status-Notification-Request (SNR). The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used.
|
| 579 |
+
|
| 580 |
+
The following values are defined, and multiple bits may be set in combination:
|
| 581 |
+
|
| 582 |
+
**Table 5.3.7-1: SN-Request-Type AVP**
|
| 583 |
+
|
| 584 |
+
| Bit | Name | Description |
|
| 585 |
+
|-----|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 586 |
+
| 0 | Normal Request | This bit, when set, indicates that the SNR is used only to convey a spending limit report as detailed in clause 4.5.2. This shall be the default value that applies when the SN-Request-Type AVP is not included in an SNR. |
|
| 587 |
+
| 1 | Abort Session Request | This bit, when set, indicates that the SNR is used to request the termination of the Sy session as detailed in clause 4.5.4 |
|
| 588 |
+
|
| 589 |
+
## 5.4 Sy re-used AVPs
|
| 590 |
+
|
| 591 |
+
Table 5.4 lists the Diameter AVPs re-used by the Sy reference point from existing Diameter Applications, reference to their respective specifications and a short description of their usage within the Sy reference point. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 5.4, but they are re-used for the Sy reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where 3GPP Radius VSAs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [4] with the exception that the 'M' flag shall be set and the 'P' flag may be set.
|
| 592 |
+
|
| 593 |
+
**Table 5.4: Sy re-used Diameter AVPs**
|
| 594 |
+
|
| 595 |
+
| Attribute Name | Reference | Description |
|
| 596 |
+
|-----------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 597 |
+
| DRMP | IETF RFC 7944 [21] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. |
|
| 598 |
+
| Subscription-Id | IETF RFC 4006 [5] | The identification of the subscription (IMSI, MSISDN, etc) |
|
| 599 |
+
| Load | IETF RFC 8583 [22] | The AVP used to convey load information between Diameter nodes.<br>This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. |
|
| 600 |
+
| Logical-Access-ID | ETSI TS 283 034 [17] | Contains a Circuit-ID (as defined in IETF RFC 3046 [18]). The Logical Access ID may explicitly contain the identity of the Virtual Path and Virtual Channel carrying the traffic. Applicable only for Fixed Broadband Access network convergence as defined in annex A.<br>This AVP shall have the 'M' bit cleared. |
|
| 601 |
+
| OC-OLR | IETF 7683 [20] | Contains the necessary information to convey an overload report. |
|
| 602 |
+
| OC-Supported-Features | IETF 7683 [20] | Defines the support for the Diameter overload indication conveyance by the sending node. |
|
| 603 |
+
| Physical-Access-ID | ETSI TS 283 034 [17] | Identifies the physical access to which the user equipment is connected. Includes a port identifier and the identity of the access node where the port resides. Applicable only for Fixed Broadband Access network convergence as defined in annex A.<br>This AVP shall have the 'M' bit cleared. |
|
| 604 |
+
| Supported-Features | 3GPP TS 29.229 [15] | If present in a request, this AVP informs the destination host about the features that the origin host supports. If present in an answer, this AVP informs the destination host about common features with the origin host. |
|
| 605 |
+
|
| 606 |
+
## 5.5 Sy specific Experimental-Result-Code AVP values
|
| 607 |
+
|
| 608 |
+
### 5.5.1 General
|
| 609 |
+
|
| 610 |
+
IETF RFC 6733 [23] specifies the Experimental-Result AVP containing Vendor-ID AVP and Experimental-Result-Code AVP. The Experimental-Result-Code AVP (AVP Code 298) is of type Unsigned32 and contains a vendor-assigned value representing the result of processing a request. The Vendor-ID AVP shall be set to 3GPP (10415).
|
| 611 |
+
|
| 612 |
+
### 5.5.2 Permanent Failures
|
| 613 |
+
|
| 614 |
+
Errors that fall within the Permanent Failures category shall be used to inform the peer that the request failed, and the request should not be attempted again.
|
| 615 |
+
|
| 616 |
+
The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [23] are applicable. Also, the following Result-Code AVP value defined in IETF RFC 4006 [5] is applicable:
|
| 617 |
+
|
| 618 |
+
DIAMETER\_USER\_UNKNOWN (5030)
|
| 619 |
+
|
| 620 |
+
This error shall be used by the OCS to indicate to the PCRF that the end user specified in the request is unknown to the OCS and that the Sy session cannot be created.
|
| 621 |
+
|
| 622 |
+
The following specific Sy Experimental-Result-Code value is defined for permanent failures:
|
| 623 |
+
|
| 624 |
+
DIAMETER\_ERROR\_UNKNOWN\_POLICY\_COUNTERS (5570)
|
| 625 |
+
|
| 626 |
+
This error shall be used by the OCS to indicate to the PCRF that the OCS does not recognize one or more Policy Counters specified in the request, when the OCS is configured to reject the request provided with unknown policy counter identifier(s).
|
| 627 |
+
|
| 628 |
+
### 5.5.3 Transient Failures
|
| 629 |
+
|
| 630 |
+
Errors that fall within the transient failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future.
|
| 631 |
+
|
| 632 |
+
The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [23] are applicable. Also the following specific Sy Experimental-Result-Code value is defined for transient failures:
|
| 633 |
+
|
| 634 |
+
DIAMETER\_ERROR\_NO\_AVAILABLE\_POLICY\_COUNTERS (4241)
|
| 635 |
+
|
| 636 |
+
This error shall be used by the OCS to indicate to the PCRF that the OCS has no available policy counters for the subscriber.
|
| 637 |
+
|
| 638 |
+
The PCRF may retry the request based on local configuration or operator policy on receipt of a transient failure.
|
| 639 |
+
|
| 640 |
+
## 5.6 Sy Messages
|
| 641 |
+
|
| 642 |
+
### 5.6.1 Command-Code Values
|
| 643 |
+
|
| 644 |
+
This clause defines the Command-Code values for the Sy interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [6]. Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the rules in IETF RFC 6733 [23].
|
| 645 |
+
|
| 646 |
+
The following Command Codes are defined in this specification:
|
| 647 |
+
|
| 648 |
+
**Table 5.6.1: Command-Code values for Sy**
|
| 649 |
+
|
| 650 |
+
| Command-Name | Abbreviation | Code | Section |
|
| 651 |
+
|--------------------------------------|--------------|---------|---------|
|
| 652 |
+
| Spending-Limit-Request | SLR | 8388635 | 5.6.2 |
|
| 653 |
+
| Spending-Limit-Answer | SLA | 8388635 | 5.6.3 |
|
| 654 |
+
| Spending-Status-Notification-Request | SNR | 8388636 | 5.6.4 |
|
| 655 |
+
| Spending-Status-Notification-Answer | SNA | 8388636 | 5.6.5 |
|
| 656 |
+
|
| 657 |
+
In addition, the Session-Termination-Request and Session-Termination-Answer commands are reused from IETF RFC 6733 [23].
|
| 658 |
+
|
| 659 |
+
For the commands defined in this specification and reused commands, the Application-ID field shall be set to 16777302.
|
| 660 |
+
|
| 661 |
+
### 5.6.2 Spending-Limit-Request (SLR) command
|
| 662 |
+
|
| 663 |
+
The SLR command, indicated by the Command-Code field set to 8388635 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the OCS as part of the Initial or Intermediate Spending Limit Report Request procedure.
|
| 664 |
+
|
| 665 |
+
Message Format:
|
| 666 |
+
|
| 667 |
+
```
|
| 668 |
+
<SL-Request> ::= <Diameter Header: 8388635, REQ, PXY >
|
| 669 |
+
< Session-Id >
|
| 670 |
+
[ DRMP ]
|
| 671 |
+
{ Auth-Application-Id }
|
| 672 |
+
{ Origin-Host }
|
| 673 |
+
{ Origin-Realm }
|
| 674 |
+
{ Destination-Realm }
|
| 675 |
+
[ Destination-Host ]
|
| 676 |
+
[ Origin-State-Id ]
|
| 677 |
+
[ OC-Supported-Features ]
|
| 678 |
+
* [ Supported-Features ]
|
| 679 |
+
{ SL-Request-Type }
|
| 680 |
+
* [ Subscription-Id ]
|
| 681 |
+
* [ Policy-Counter-Identifier ]
|
| 682 |
+
[ Logical-Access-ID ]
|
| 683 |
+
[ Physical-Access-ID ]
|
| 684 |
+
* [ Proxy-Info ]
|
| 685 |
+
* [ Route-Record ]
|
| 686 |
+
* [ AVP ]
|
| 687 |
+
```
|
| 688 |
+
|
| 689 |
+
NOTE: Multiple instances of the Subscription-Id AVP in the SLR command correspond to multiple types of identifier for the same subscriber, for example IMSI and MSISDN.
|
| 690 |
+
|
| 691 |
+
### 5.6.3 Spending-Limit-Answer (SLA) command
|
| 692 |
+
|
| 693 |
+
The SLA command, indicated by the Command-Code field set to 8388635 and the 'R' bit cleared in the Command Flags field, is sent by the OCS to the PCRF as part of the Initial or Intermediate Spending Limit Report Request procedure.
|
| 694 |
+
|
| 695 |
+
Message Format:
|
| 696 |
+
|
| 697 |
+
```
|
| 698 |
+
<SL-Answer> ::= < Diameter Header: 8388635, PXY >
|
| 699 |
+
< Session-Id >
|
| 700 |
+
[ DRMP ]
|
| 701 |
+
{ Auth-Application-Id }
|
| 702 |
+
{ Origin-Host }
|
| 703 |
+
{ Origin-Realm }
|
| 704 |
+
[ Result-Code ]
|
| 705 |
+
[ Experimental-Result ]
|
| 706 |
+
[ OC-Supported-Features ]
|
| 707 |
+
[ OC-OLR ]
|
| 708 |
+
* [ Supported-Features ]
|
| 709 |
+
* [ Policy-Counter-Status-Report ]
|
| 710 |
+
[ Error-Message ]
|
| 711 |
+
[ Error-Reporting-Host ]
|
| 712 |
+
[ Failed-AVP ]
|
| 713 |
+
[ Origin-State-Id ]
|
| 714 |
+
* [ Redirect-Host ]
|
| 715 |
+
[ Redirect-Host-Usage ]
|
| 716 |
+
[ Redirect-Max-Cache-Time ]
|
| 717 |
+
* [ Proxy-Info ]
|
| 718 |
+
* [ Load ]
|
| 719 |
+
* [ AVP ]
|
| 720 |
+
```
|
| 721 |
+
|
| 722 |
+
### 5.6.4 Spending-Status-Notification-Request (SNR) command
|
| 723 |
+
|
| 724 |
+
The SNR command, indicated by the Command-Code field set to 8388636 and the 'R' bit set in the Command Flags field, is sent by the OCS to the PCRF as part of the Spending Limit Report procedure.
|
| 725 |
+
|
| 726 |
+
Message Format:
|
| 727 |
+
|
| 728 |
+
```
|
| 729 |
+
<SN-Request> ::= < Diameter Header: 8388636, REQ, PXY >
|
| 730 |
+
< Session-Id >
|
| 731 |
+
[ DRMP ]
|
| 732 |
+
{ Origin-Host }
|
| 733 |
+
{ Origin-Realm }
|
| 734 |
+
{ Destination-Realm }
|
| 735 |
+
{ Destination-Host }
|
| 736 |
+
{ Auth-Application-Id }
|
| 737 |
+
[ Origin-State-Id ]
|
| 738 |
+
[ OC-Supported-Features ]
|
| 739 |
+
* [ Policy-Counter-Status-Report ]
|
| 740 |
+
[ SN-Request-Type ]
|
| 741 |
+
* [ Proxy-Info ]
|
| 742 |
+
* [ Route-Record ]
|
| 743 |
+
* [ AVP ]
|
| 744 |
+
```
|
| 745 |
+
|
| 746 |
+
### 5.6.5 Spending-Status-Notification-Answer (SNA) command
|
| 747 |
+
|
| 748 |
+
The SNA command, indicated by the Command-Code field set to 8388636 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the OCS as part of the Spending Limit Report procedure.
|
| 749 |
+
|
| 750 |
+
Message Format:
|
| 751 |
+
|
| 752 |
+
```
|
| 753 |
+
<SN-Answer> ::= < Diameter Header: 8388636, PXY >
|
| 754 |
+
< Session-Id >
|
| 755 |
+
[ DRMP ]
|
| 756 |
+
{ Origin-Host }
|
| 757 |
+
{ Origin-Realm }
|
| 758 |
+
[ Result-Code ]
|
| 759 |
+
[ Experimental-Result ]
|
| 760 |
+
```
|
| 761 |
+
|
| 762 |
+
```
|
| 763 |
+
[ Origin-State-Id ]
|
| 764 |
+
[ OC-Supported-Features ]
|
| 765 |
+
[ OC-OLR ]
|
| 766 |
+
[ Error-Message ]
|
| 767 |
+
[ Error-Reporting-Host ]
|
| 768 |
+
*[ Redirect-Host ]
|
| 769 |
+
[ Redirect-Host-Usage ]
|
| 770 |
+
[ Redirect-Max-Cache-Time ]
|
| 771 |
+
[ Failed-AVP ]
|
| 772 |
+
*[ Proxy-Info ]
|
| 773 |
+
*[ AVP ]
|
| 774 |
+
```
|
| 775 |
+
|
| 776 |
+
### 5.6.6 Session-Termination-Request (STR) command
|
| 777 |
+
|
| 778 |
+
The STR command, indicated by the Command-Code field set to 275 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the OCS as part of the Final Spending Limit Report Request procedure.
|
| 779 |
+
|
| 780 |
+
Message Format:
|
| 781 |
+
|
| 782 |
+
```
|
| 783 |
+
<ST-Request> ::= < Diameter Header: 275, REQ, PXY >
|
| 784 |
+
< Session-Id >
|
| 785 |
+
[ DRMP ]
|
| 786 |
+
{ Origin-Host }
|
| 787 |
+
{ Origin-Realm }
|
| 788 |
+
{ Destination-Realm }
|
| 789 |
+
{ Auth-Application-Id }
|
| 790 |
+
{ Termination-Cause }
|
| 791 |
+
[ Destination-Host ]
|
| 792 |
+
[ OC-Supported-Features ]
|
| 793 |
+
[ Origin-State-Id ]
|
| 794 |
+
*[ Proxy-Info ]
|
| 795 |
+
*[ Route-Record ]
|
| 796 |
+
*[ AVP ]
|
| 797 |
+
```
|
| 798 |
+
|
| 799 |
+
### 5.6.7 Session-Termination-Answer (STA) command
|
| 800 |
+
|
| 801 |
+
The STA command, indicated by the Command-Code field set to 275 and the 'R' bit cleared in the Command Flags field, is sent by the OCS to the PCRF as part of the Final Spending Limit Report Request procedure.
|
| 802 |
+
|
| 803 |
+
Message Format:
|
| 804 |
+
|
| 805 |
+
```
|
| 806 |
+
<ST-Answer> ::= < Diameter Header: 275, PXY >
|
| 807 |
+
< Session-Id >
|
| 808 |
+
[ DRMP ]
|
| 809 |
+
{ Origin-Host }
|
| 810 |
+
{ Origin-Realm }
|
| 811 |
+
[ Result-Code ]
|
| 812 |
+
[ Error-Message ]
|
| 813 |
+
[ Error-Reporting-Host ]
|
| 814 |
+
[ Failed-AVP ]
|
| 815 |
+
[ Origin-State-Id ]
|
| 816 |
+
[ OC-Supported-Features ]
|
| 817 |
+
[ OC-OLR ]
|
| 818 |
+
*[ Redirect-Host ]
|
| 819 |
+
[ Redirect-Host-Usage ]
|
| 820 |
+
[ Redirect-Max-Cache-Time ]
|
| 821 |
+
*[ Proxy-Info ]
|
| 822 |
+
*[ Load ]
|
| 823 |
+
*[ AVP ]
|
| 824 |
+
```
|
| 825 |
+
|
| 826 |
+
# --- Annex A (normative): User Identity for Fixed Broadband Access network convergence
|
| 827 |
+
|
| 828 |
+
In the Fixed Broadband Access network convergence scenario, the User Identity refers to the Subscriber Identifier as defined in TS 29.212 [19] Annex G.5.1.6.
|
| 829 |
+
|
| 830 |
+
If the User Identity is the Access Line Identifier, the Logical-Access-ID AVP and Physical-Access-ID AVP are included in the SLR command instead of the Subscription-Id AVP.
|
| 831 |
+
|
| 832 |
+
# Annex B (informative): Change history
|
| 833 |
+
|
| 834 |
+
| Change history | | | | | | | |
|
| 835 |
+
|----------------|--------|-----------|------|-----|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------|
|
| 836 |
+
| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
|
| 837 |
+
| 2014-12 | TSG#66 | CP-140922 | 020 | 2 | Update PCC architecture diagrams to include Np reference point | 12.2.0 | 13.0.0 |
|
| 838 |
+
| 2015-06 | TSG#68 | CP-150342 | 0023 | 1 | Notify a pending policy counter status change | 13.0.0 | 13.1.0 |
|
| 839 |
+
| 2015-06 | TSG#68 | CP-150342 | 0026 | 1 | Correction to pending policy counters status report | 13.0.0 | 13.1.0 |
|
| 840 |
+
| 2015-06 | TSG#68 | CP-150342 | 0029 | 5 | Including the Supported-Features AVP | 13.0.0 | 13.1.0 |
|
| 841 |
+
| 2015-06 | TSG#68 | CP-150348 | 0031 | 1 | Usage of AVPs related to user identity for convergence scenario | 13.0.0 | 13.1.0 |
|
| 842 |
+
| 2015-06 | TSG#68 | CP-150360 | 0032 | 1 | Diameter overload control over Sy | 13.0.0 | 13.1.0 |
|
| 843 |
+
| 2015-06 | TSG#68 | CP-150363 | 0034 | 1 | Correcting Hanging Paragraphs | 13.0.0 | 13.1.0 |
|
| 844 |
+
| 2015-12 | TSG#70 | CP-150797 | 0040 | 1 | Update the PCC architecture figures in 29.219 | 13.1.0 | 13.2.0 |
|
| 845 |
+
| 2015-12 | TSG#70 | CP-150630 | 0041 | 1 | Update draft-ietf-dime-ovli reference to RFC 7683 | 13.1.0 | 13.2.0 |
|
| 846 |
+
| 2015-12 | TSG#70 | CP-150788 | 0042 | 3 | Sy interface impacts for Race condition handling | 13.1.0 | 13.2.0 |
|
| 847 |
+
| 2015-12 | TSG#70 | CP-150788 | 0046 | 2 | Correction text for the use of the Spending-Status-Notification-Request (SNR) command on the Sy reference point | 13.1.0 | 13.2.0 |
|
| 848 |
+
| Change history | | | | | | | |
|
| 849 |
+
| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New |
|
| 850 |
+
| 2016-03 | TSG#71 | CP-160093 | 0047 | 2 | B | Diameter Message Priority over Sy interface | 13.3.0 |
|
| 851 |
+
| 2016-12 | TSG#74 | CP-160614 | 0052 | - | F | Change IETF drmp draft version to official RFC 7944 | 13.4.0 |
|
| 852 |
+
| 2016-12 | TSG#74 | CP-160615 | 0051 | 2 | B | Diameter Load Control Mechanism | 14.0.0 |
|
| 853 |
+
| 2016-12 | TSG#74 | CP-160616 | 0053 | 1 | F | Diameter base protocol specification update | 14.0.0 |
|
| 854 |
+
| 2017-03 | TSG#75 | CP-170076 | 0055 | 1 | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 |
|
| 855 |
+
| 2017-06 | TSG#76 | CP-171119 | 0057 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 |
|
| 856 |
+
| 2017-09 | TSG#77 | CP-172054 | 0062 | 2 | B | Enhancement on Sy reference point | 15.0.0 |
|
| 857 |
+
| 2018-03 | TSG#79 | CP-180049 | 0063 | 2 | F | Supported-Features AVP missing in SLR/SLA's ABNF | 15.1.0 |
|
| 858 |
+
| 2019-06 | TSG#84 | CP-191093 | 0073 | 1 | A | Correction of OCS behaviour for unknown and unavailable Policy Counters | 15.2.0 |
|
| 859 |
+
| 2019-09 | TSG#85 | CP-192154 | 0075 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.3.0 |
|
| 860 |
+
| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 |
|
| 861 |
+
| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 |
|
| 862 |
+
| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 |
|
marked/Rel-18/29_series/29228/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29250/raw.md
ADDED
|
@@ -0,0 +1,1157 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.250 V18.0.0 (2024-03) ---
|
| 4 |
+
|
| 5 |
+
*Technical Specification*
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Nu reference point between SCEF and PFDF for sponsored data connectivity (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right.
|
| 14 |
+
|
| 15 |
+
5G Advanced logo
|
| 16 |
+
|
| 17 |
+

|
| 18 |
+
|
| 19 |
+
The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' in smaller letters below the logo.
|
| 20 |
+
|
| 21 |
+
3GPP logo
|
| 22 |
+
|
| 23 |
+
## --- **Keywords**
|
| 24 |
+
|
| 25 |
+
<keyword[, keyword, ...]>
|
| 26 |
+
|
| 27 |
+
## **3GPP**
|
| 28 |
+
|
| 29 |
+
## --- **Postal address**
|
| 30 |
+
|
| 31 |
+
## --- **3GPP support office address**
|
| 32 |
+
|
| 33 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 34 |
+
Valbonne - FRANCE
|
| 35 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 36 |
+
|
| 37 |
+
## --- **Internet**
|
| 38 |
+
|
| 39 |
+
<http://www.3gpp.org>
|
| 40 |
+
|
| 41 |
+
## --- **Copyright Notification**
|
| 42 |
+
|
| 43 |
+
No part may be reproduced except as authorized by written permission.
|
| 44 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 45 |
+
|
| 46 |
+
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 47 |
+
All rights reserved.
|
| 48 |
+
|
| 49 |
+
UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
|
| 50 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 51 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 52 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 53 |
+
|
| 54 |
+
# Contents
|
| 55 |
+
|
| 56 |
+
| | |
|
| 57 |
+
|----------------------------------------------------------|----|
|
| 58 |
+
| Foreword ..... | 5 |
|
| 59 |
+
| 1 Scope..... | 6 |
|
| 60 |
+
| 2 References..... | 6 |
|
| 61 |
+
| 3 Definitions and abbreviations ..... | 7 |
|
| 62 |
+
| 3.1 Definitions..... | 7 |
|
| 63 |
+
| 3.2 Abbreviations ..... | 7 |
|
| 64 |
+
| 4 Nu reference point..... | 7 |
|
| 65 |
+
| 4.1 Overview ..... | 7 |
|
| 66 |
+
| 4.2 Nu reference model ..... | 7 |
|
| 67 |
+
| 4.3 Functional elements..... | 8 |
|
| 68 |
+
| 4.3.1 PFDF..... | 8 |
|
| 69 |
+
| 4.3.2 SCEF..... | 8 |
|
| 70 |
+
| 4.4 Procedures over Nu reference point..... | 8 |
|
| 71 |
+
| 4.4.1 Management of PFD..... | 8 |
|
| 72 |
+
| 4.4.2 PFD management notification ..... | 9 |
|
| 73 |
+
| 5 Nu protocol ..... | 9 |
|
| 74 |
+
| 5.1 Introduction ..... | 9 |
|
| 75 |
+
| 5.2 Transport layer ..... | 10 |
|
| 76 |
+
| 5.3 Application delivery layer..... | 10 |
|
| 77 |
+
| 5.3.1 General ..... | 10 |
|
| 78 |
+
| 5.3.2 HTTP status codes..... | 10 |
|
| 79 |
+
| 5.3.3 Methods ..... | 10 |
|
| 80 |
+
| 5.3.4 Resources and URI design..... | 11 |
|
| 81 |
+
| 5.3.5 HTTP request/response formats ..... | 11 |
|
| 82 |
+
| 5.3.5.1 General..... | 11 |
|
| 83 |
+
| 5.3.5.2 POST /nuapplication/provisioning ..... | 12 |
|
| 84 |
+
| 5.3.5.3 POST /nuapplication/notification ..... | 14 |
|
| 85 |
+
| 5.3.6 Feature negotiation ..... | 15 |
|
| 86 |
+
| 5.3.6.1 General..... | 15 |
|
| 87 |
+
| 5.3.6.2 HTTP custom headers..... | 16 |
|
| 88 |
+
| 5.3.6.2.1 3gpp-Optional-Features..... | 16 |
|
| 89 |
+
| 5.3.6.2.2 3gpp-Required-Features ..... | 16 |
|
| 90 |
+
| 5.3.6.2.3 3gpp-Accepted-Features..... | 16 |
|
| 91 |
+
| 5.4 Specific application communication ..... | 17 |
|
| 92 |
+
| 5.4.1 General ..... | 17 |
|
| 93 |
+
| 5.4.2 Content type..... | 17 |
|
| 94 |
+
| 5.4.3 JSON provisioning fields ..... | 17 |
|
| 95 |
+
| 5.4.3.1 General..... | 17 |
|
| 96 |
+
| 5.4.3.2 scef-notification-uri ..... | 17 |
|
| 97 |
+
| 5.4.4 Void..... | 18 |
|
| 98 |
+
| 5.4.5 JSON errors and informational response fields..... | 18 |
|
| 99 |
+
| 5.4.5.1 General..... | 18 |
|
| 100 |
+
| 5.4.6 JSON report fields ..... | 18 |
|
| 101 |
+
| 5.4.6.1 General..... | 18 |
|
| 102 |
+
| 5.4.6.2 pfd-reports..... | 18 |
|
| 103 |
+
| 5.4.6.3 application-ids..... | 19 |
|
| 104 |
+
| 5.4.7 JSON notification fields ..... | 19 |
|
| 105 |
+
| 5.4.7.1 General..... | 19 |
|
| 106 |
+
| 5.4.7.2 notification-pfd-reports..... | 19 |
|
| 107 |
+
| 5.4.7.3 user-plane-location-area..... | 20 |
|
| 108 |
+
| 5.4.7.4 cell-ids..... | 20 |
|
| 109 |
+
| 5.4.7.5 enodeb-ids..... | 20 |
|
| 110 |
+
| 5.4.7.6 extended-enodeb-ids ..... | 20 |
|
| 111 |
+
| 5.4.7.7 routing-area-ids ..... | 20 |
|
| 112 |
+
|
| 113 |
+
| | | |
|
| 114 |
+
|-------------------------------|-----------------------------------------------|-----------|
|
| 115 |
+
| 5.4.7.8 | tracking-area-ids ..... | 21 |
|
| 116 |
+
| 5.5 | PFDF discovery ..... | 21 |
|
| 117 |
+
| 5.6 | SCEF discovery ..... | 21 |
|
| 118 |
+
| 6 | Secure communication ..... | 21 |
|
| 119 |
+
| <b>Annex A (informative):</b> | <b>JSON Schema .....</b> | <b>21</b> |
|
| 120 |
+
| A.1 | Provisioning schema ..... | 21 |
|
| 121 |
+
| A.2 | Error and Informational response schema ..... | 23 |
|
| 122 |
+
| A.3 | PFD management notification schema ..... | 25 |
|
| 123 |
+
| <b>Annex B (informative):</b> | <b>Call Flows .....</b> | <b>28</b> |
|
| 124 |
+
| B.1 | General ..... | 28 |
|
| 125 |
+
| B.2 | Provisioning of PFDs ..... | 28 |
|
| 126 |
+
| <b>Annex C (informative):</b> | <b>Change history .....</b> | <b>29</b> |
|
| 127 |
+
|
| 128 |
+
# --- Foreword
|
| 129 |
+
|
| 130 |
+
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
|
| 131 |
+
|
| 132 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 133 |
+
|
| 134 |
+
Version x.y.z
|
| 135 |
+
|
| 136 |
+
where:
|
| 137 |
+
|
| 138 |
+
- x the first digit:
|
| 139 |
+
- 1 presented to TSG for information;
|
| 140 |
+
- 2 presented to TSG for approval;
|
| 141 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 142 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 143 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 144 |
+
|
| 145 |
+
# 1 Scope
|
| 146 |
+
|
| 147 |
+
The present document provides the stage 3 specification of the Nu reference point. The functional requirements and the stage 2 specifications of the Nu reference point are specified in 3GPP TS 23.682 [2]. The Nu reference point lies between the Packet Flow Description Function (PFDF) and the Service Capability Exposure Function (SCEF).
|
| 148 |
+
|
| 149 |
+
# 2 References
|
| 150 |
+
|
| 151 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 152 |
+
|
| 153 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 154 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 155 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 156 |
+
|
| 157 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 158 |
+
- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications".
|
| 159 |
+
- [3] 3GPP TS 23.203: "Policy and charging control architecture".
|
| 160 |
+
- [4] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping".
|
| 161 |
+
- [5] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security".
|
| 162 |
+
- [6] IETF RFC 2818: "HTTP Over TLS".
|
| 163 |
+
- [7] IETF RFC 793: "Transmission Control Protocol".
|
| 164 |
+
- [8] Void.
|
| 165 |
+
- [9] 3GPP TS 29.251: "Gw and Gwn reference points for sponsored data connectivity".
|
| 166 |
+
- [10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
|
| 167 |
+
- [11] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format".
|
| 168 |
+
- [12] IETF draft-newton-json-content-rules-09: "A Language for Rules Describing JSON Content".
|
| 169 |
+
|
| 170 |
+
NOTE: This individual draft will not further progress in IETF. It is available from the following link:
|
| 171 |
+
<https://www.ietf.org/archive/id/draft-newton-json-content-rules-09.txt>.
|
| 172 |
+
|
| 173 |
+
- [13] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing".
|
| 174 |
+
- [14] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content".
|
| 175 |
+
- [15] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests".
|
| 176 |
+
- [16] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests".
|
| 177 |
+
- [17] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching".
|
| 178 |
+
- [18] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication".
|
| 179 |
+
- [19] 3GPP TS 29.274: "Evolved GPRS Tunnelling Protocol for EPS (GTPv2)".
|
| 180 |
+
|
| 181 |
+
# 3 Definitions and abbreviations
|
| 182 |
+
|
| 183 |
+
## 3.1 Definitions
|
| 184 |
+
|
| 185 |
+
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
|
| 186 |
+
|
| 187 |
+
**Packet Flow Description (PFD):** A set of information enabling the detection of application traffic provided by a 3<sup>rd</sup> party service provider (from 3GPP TS 23.203 [3]).
|
| 188 |
+
|
| 189 |
+
## 3.2 Abbreviations
|
| 190 |
+
|
| 191 |
+
For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
|
| 192 |
+
|
| 193 |
+
| | |
|
| 194 |
+
|------|------------------------------------------|
|
| 195 |
+
| JSON | JavaScript Object Notation |
|
| 196 |
+
| PCEF | Policy and Charging Enforcement Function |
|
| 197 |
+
| PFD | Packet Flow Description |
|
| 198 |
+
| PFDF | Packet Flow Description Function |
|
| 199 |
+
| SCEF | Service Capability Exposure Function |
|
| 200 |
+
| TDF | Traffic Detection Function |
|
| 201 |
+
|
| 202 |
+
# 4 Nu reference point
|
| 203 |
+
|
| 204 |
+
## 4.1 Overview
|
| 205 |
+
|
| 206 |
+
The Nu reference point is located between the Packet Flow Description Function (PFDF) and the Service Capability Exposure Function (SCEF). The Nu reference point is used for provisioning of PFDs from the SCEF to the PFDF and reporting the result of the PFD Management from the PFDF to the SCEF.
|
| 207 |
+
|
| 208 |
+
The stage 2 level requirements for the Nu reference point are defined in 3GPP TS 23.682 [2].
|
| 209 |
+
|
| 210 |
+
## 4.2 Nu reference model
|
| 211 |
+
|
| 212 |
+
The Nu reference point is defined between the SCEF and the PFDF. The relationships between the different functional entities involved are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [4].
|
| 213 |
+
|
| 214 |
+

|
| 215 |
+
|
| 216 |
+
The diagram illustrates the Nu reference model. It consists of two light green rectangular boxes, labeled 'PFDF' on the left and 'SCEF' on the right. A horizontal line connects the two boxes. Above this line, centered between the boxes, is the label 'Nu'. A small vertical tick mark is positioned on the horizontal line directly below the 'Nu' label.
|
| 217 |
+
|
| 218 |
+
Diagram of the Nu reference model showing the PFDF and SCEF connected via the Nu reference point.
|
| 219 |
+
|
| 220 |
+
Figure 4.2.1: Nu reference model
|
| 221 |
+
|
| 222 |
+
## 4.3 Functional elements
|
| 223 |
+
|
| 224 |
+
### 4.3.1 PFDF
|
| 225 |
+
|
| 226 |
+
The PFDF (Packet Flow Description Function) is a functional element which receives and manages the PFDs associated to application identifier (s) from the SCEF via the Nu reference point.
|
| 227 |
+
|
| 228 |
+
The PFDF provisions PFDs for the corresponding application identifier (s) to the PCEF/TDF as defined in 3GPP TS 23.203 [3] and 3GPP TS 29.251 [9].
|
| 229 |
+
|
| 230 |
+
### 4.3.2 SCEF
|
| 231 |
+
|
| 232 |
+
The SCEF (Service Capability Exposure Function) is a functional element which provides means to securely expose the services and capabilities provided by the 3GPP network interfaces.
|
| 233 |
+
|
| 234 |
+
The SCEF shall support the management of PFDs provided by the 3<sup>rd</sup> party SCS/AS. The SCEF may provision the PFDs to the PFDF via the Nu reference point.
|
| 235 |
+
|
| 236 |
+
## 4.4 Procedures over Nu reference point
|
| 237 |
+
|
| 238 |
+
### 4.4.1 Management of PFD
|
| 239 |
+
|
| 240 |
+
The PFDs associated with application identifier (s) may be created, updated or removed in the PFDF by the third party SCS/AS via the SCEF as defined in 3GPP TS 23.682 [2].
|
| 241 |
+
|
| 242 |
+
If the SCEF receives one or more sets of PFDs for external application identifier (s) provisioned by the third party SCS/AS, which is authorized to perform the management of PFDs based on operator policies, the SCEF shall:
|
| 243 |
+
|
| 244 |
+
- If the external application identifier(s) is different from the application identifier(s) known at the PFDF, translate the external application identifier(s) to the application identifier(s) known at the PFDF; and
|
| 245 |
+
- may check if the allowed delay satisfies the required SLA against the minimum allowed delay as defined in 3GPP TS 23.682 [2]; and
|
| 246 |
+
- send an HTTP POST message to the PFDF including the provisioned PFD changes for the the application identifier (s) within the body of the HTTP POST as described in clause 5.3.5.2.
|
| 247 |
+
|
| 248 |
+
NOTE 1: It is up to operator configuration whether to use different external application identifiers that require a mapping to application identifiers known at the PFDF. The external application identifier can be the same as the application identifier known at the PFDF.
|
| 249 |
+
|
| 250 |
+
Upon receipt of the HTTP request for the provisioning operation from the SCEF, the PFDF shall perform the following steps:
|
| 251 |
+
|
| 252 |
+
- If an allowed delay is received for an application identifier, for Pull mode as defined in 3GPP TS 29.251 [9], the PFDF shall compare the allowed delay with the configured caching time which is:
|
| 253 |
+
- a caching time value configured for that application identifier; or
|
| 254 |
+
- the default caching time value if no caching time value is configured for that application identifier.
|
| 255 |
+
- Then if the PFDF cannot ensure the PCEF/TDF will pull the PFDs in time (i.e. allowed delay is shorter than the caching time), the PFDF shall within the HTTP response send a failure reason and that caching time value used in the comparison and may still store (create/update/remove) the PFDs for this application identifier.
|
| 256 |
+
|
| 257 |
+
NOTE 2: In the Combination mode as defined in 3GPP TS 29.251 [9], the PFDF can check the received allowed delay against the caching time but will always store (create/update/remove) the PFDs.
|
| 258 |
+
|
| 259 |
+
- In the Pull mode as defined in 3GPP TS 29.251 [9], for the application identifier(s) without the need to send failure reason; or in the Push or Combination mode as defined in 3GPP TS 29.251 [9], for received application identifier(s), the PFDF shall:
|
| 260 |
+
|
| 261 |
+
- delete all the PFD(s) for the application identifier(s) where the removal-flag is also provided and set to true;
|
| 262 |
+
- update the existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received , add new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received, and/or delete an existing PFD(s) if the same PFD identifier(s) without any content is received, where the partial-flag is also provided and set to true;
|
| 263 |
+
- remove existing PFD(s) (if available) and install the new PFD(s) for the corresponding PFD identifier(s) where no flag is provided;
|
| 264 |
+
- acknowledge the HTTP POST message by sending a corresponding HTTP response with the appropriate status code as defined in clause 5.3.2. If the POST operation was successful for at least one application identifier, the PFDF shall respond with an HTTP 200 OK status code.
|
| 265 |
+
|
| 266 |
+
### 4.4.2 PFD management notification
|
| 267 |
+
|
| 268 |
+
In the Push mode or Combination mode as defined in 3GPP TS 29.251 [9], if the PFDs are provisioned to at least one of the known PCEFs/TDFs (but not all) within the allowed delay (i.e. the provisioned PFDs can not be enforced successfully in some PCEF/TDFs known on the PFDF), the PFDF may notify the SCEF about the failed PFD provisioning with the HTTP POST message using the failure reason "PARTIAL\_FAILURE" as defined in Table 5.4.7.1-1. In this case, the PFDF may include location area(s) of the PCEF/TDF(s) which can not enforce the provisioned PFD(s) within the field "user-plane-location-area" of the corresponding instance of the PFD report(s). If the PFDs are provisioned to none of the known PCEFs/TDFs within the allowed delay, the PFDF shall notify the SCEF about the failed PFD provisioning with the HTTP POST message using appropriate failure reason as defined in clause 6.4.6.3 of 3GPP TS 29.251 [9].
|
| 269 |
+
|
| 270 |
+
When receiving the HTTP POST message, the SCEF shall respond with an HTTP response message.
|
| 271 |
+
|
| 272 |
+
# --- 5 Nu protocol
|
| 273 |
+
|
| 274 |
+
## 5.1 Introduction
|
| 275 |
+
|
| 276 |
+
The following layers of the protocol stack for the Nu reference point between the SCEF and the PFDF are described in clauses:
|
| 277 |
+
|
| 278 |
+
- IETF RFC 793 [7] provides the communication service at the transport layer.
|
| 279 |
+
- An optional communication security layer can be added between the transport and the application delivery layer (see clause 6).
|
| 280 |
+
- The application delivery layer provides the transport of the specific application communication data using IETF RFC 7230 [13], IETF RFC 7231 [14], IETF RFC 7232 [15], IETF RFC 7233 [16], IETF RFC 7234 [17] and IETF RFC 7235 [18].
|
| 281 |
+
- The specific application communication layer constitutes the transport of the JSON content type.
|
| 282 |
+
|
| 283 |
+
Figure 5.1.1 illustrates the protocol stack of the RESTful Nu reference point.
|
| 284 |
+
|
| 285 |
+

|
| 286 |
+
|
| 287 |
+
| | | | |
|
| 288 |
+
|------------------------------------|------|---------|------|
|
| 289 |
+
| Specific application communication | JSON | | JSON |
|
| 290 |
+
| Application delivery | HTTP | | HTTP |
|
| 291 |
+
| Transport layer | TCP | | TCP |
|
| 292 |
+
| Network layer | IP | | IP |
|
| 293 |
+
| Data link layer | L2 | | L2 |
|
| 294 |
+
| Physical layer | L1 | | L1 |
|
| 295 |
+
| | SCEF | REST-Nu | PFDF |
|
| 296 |
+
|
| 297 |
+
Figure 5.1.1: Protocol stack of the RESTful Nu reference point. The diagram shows two protocol stacks, SCEF and PFDF, connected by a REST-Nu interface. The SCEF stack has layers: JSON (Specific application communication), HTTP (Application delivery), TCP (Transport layer), IP (Network layer), L2 (Data link layer), and L1 (Physical layer). The PFDF stack has the same layers: JSON, HTTP, TCP, IP, L2, and L1. The REST-Nu interface is shown as a vertical line between the two stacks.
|
| 298 |
+
|
| 299 |
+
**Figure 5.1.1: Protocol stack of the RESTful Nu reference point**
|
| 300 |
+
|
| 301 |
+
## 5.2 Transport layer
|
| 302 |
+
|
| 303 |
+
HTTP is layered over TCP, which provides a reliable transport.
|
| 304 |
+
|
| 305 |
+
For provisioning of PFDs from the SCEF to the PFDF, the SCEF acts as an HTTP client and the PFDF acts as an HTTP server. As a result, the SCEF shall initiate a TCP connection with the PFDF.
|
| 306 |
+
|
| 307 |
+
## 5.3 Application delivery layer
|
| 308 |
+
|
| 309 |
+
### 5.3.1 General
|
| 310 |
+
|
| 311 |
+
The application delivery layer shall use RESTful HTTP.
|
| 312 |
+
|
| 313 |
+
The application delivery layer provides provisioning of the PFDs by the SCEF.
|
| 314 |
+
|
| 315 |
+
If the SCEF needs to provision PFDs for a set of application identifier(s) (creation/update/deletion) to the PFDF, the SCEF shall send an HTTP POST message.
|
| 316 |
+
|
| 317 |
+
### 5.3.2 HTTP status codes
|
| 318 |
+
|
| 319 |
+
The HTTP status codes for the REST-based Nu interface are specified in the IETF RFC 7231 [14].
|
| 320 |
+
|
| 321 |
+
### 5.3.3 Methods
|
| 322 |
+
|
| 323 |
+
Methods indicate to the server what action has to be performed. Every HTTP request message has a method.
|
| 324 |
+
|
| 325 |
+
The HTTP POST method is used by the SCEF to provision PFDs for a set of application identifiers. The request URI defines the address responsible for the management of the PFDs provisioning as a controller resource.
|
| 326 |
+
|
| 327 |
+
The HTTP POST method is also used by the PFDF to inform the SCEF for PFD management notification.
|
| 328 |
+
|
| 329 |
+
Every HTTP request results in a response message that comes back with a status code and further information in its body, if required. The HTTP request initiator waits for this response before initiating a further request.
|
| 330 |
+
|
| 331 |
+
### 5.3.4 Resources and URI design
|
| 332 |
+
|
| 333 |
+
The URI design shall be based on the structure defined in IETF RFC 3986 [10]:
|
| 334 |
+
|
| 335 |
+
```
|
| 336 |
+
scheme ":" hier-part [ "?" query ] [ "#" fragment ]
|
| 337 |
+
hier-part = "//" authority path-abempty
|
| 338 |
+
/ path-absolute
|
| 339 |
+
/ path-rootless
|
| 340 |
+
/ path-empty
|
| 341 |
+
```
|
| 342 |
+
|
| 343 |
+
The scheme may be HTTP or HTTPS for the Nu interface. Within a scheme the definition of names shall follow the rules of HTTP URIs. Host and port are the main parts of the authority. The path element identifies the resources.
|
| 344 |
+
|
| 345 |
+
For the Nu interface, the following required parts of the URI shall be used as follows:
|
| 346 |
+
|
| 347 |
+
scheme: The application delivery layer protocol "http" or "https".
|
| 348 |
+
|
| 349 |
+
authority: It includes the server address and optionally a port as follows: host [":" port]
|
| 350 |
+
|
| 351 |
+
path-absolute: The path-absolute should have the following ABNF: "/" mainapp "/" mainresource. In this release:
|
| 352 |
+
|
| 353 |
+
"mainapp" is "nuapplication".
|
| 354 |
+
|
| 355 |
+
"mainresource" is "provisioning".
|
| 356 |
+
|
| 357 |
+
The PFDs management (associating/disassociating PFDs with application identifiers) in PFDF is a controller resource that is responsible for processing requests that provisioning a set of changes for more than one set of PFDs for corresponding application identifiers atomically.
|
| 358 |
+
|
| 359 |
+
An example of the URI to identify the controller resource is <http://pfdserver.example.com/nuapplication/provisioning>.
|
| 360 |
+
|
| 361 |
+
NOTE: A different path can be used when the Resource URI is preconfigured in the SCEF.
|
| 362 |
+
|
| 363 |
+
### 5.3.5 HTTP request/response formats
|
| 364 |
+
|
| 365 |
+
#### 5.3.5.1 General
|
| 366 |
+
|
| 367 |
+
The PFDs provisioning procedure is performed through HTTP transactions consisting of a request initiated by the SCEF and answered by the PFDF.
|
| 368 |
+
|
| 369 |
+
Table 5.3.5.1-1 summarizes the content of the requests and responses. More detailed information is specified in the corresponding clauses as indicated in the table.
|
| 370 |
+
|
| 371 |
+
**Table 5.3.5.1-1: Nu requests/response summary table**
|
| 372 |
+
|
| 373 |
+
| Method | Resource URI's path | Clause Defined | Request body | Initiator | Response body |
|
| 374 |
+
|--------|-----------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------------------------|
|
| 375 |
+
| POST | /nuapplication/provisioning (NOTE 1) | 5.3.5.2 | Content-Type: application/json<br>The SCEF shall include PFDs content associated with application identifier(s) using the schema defined in Annex A. | SCEF | Successful response: The PFDF may include informational data in the body of the response in Annex A. |
|
| 376 |
+
| POST | {sceF-notification-uri}<br>or<br>/nuapplication/notification (NOTE 2) | 5.3.5.3 | Content-Type: application/json<br>The PFDF shall include notification result and application identifier(s) using the schema defined in Annex A. | PFDF | |
|
| 377 |
+
|
| 378 |
+
NOTE 1: A different path from /nuapplication/provisioning may be used when it is configured in the SCEF. In that case the "path" part set in the different methods should use the configured one.
|
| 379 |
+
|
| 380 |
+
NOTE 2: A different path from /nuapplication/notification may be used when it is configured in the PFDF and no sceF-notification-uri is received in the provisioning POST. In that case the "path" part set in the different methods should use the configured one.
|
| 381 |
+
|
| 382 |
+
#### 5.3.5.2 POST /nuapplication/provisioning
|
| 383 |
+
|
| 384 |
+
The provisioning of the PFDs shall be performed by the SCEF by using the POST method as follows:
|
| 385 |
+
|
| 386 |
+
- The request URI formatted as defined in clause 5.3.4 with the "path" part set to: /nuapplication/provisioning.
|
| 387 |
+
- The Content-Type header field set to "application/json"
|
| 388 |
+
- The body of the message encoded in JSON format as defined in Annex A. The body shall include
|
| 389 |
+
- for the PFD(s) creation for a new application identifier, a new application identifier and its full list of PFD(s) to be created;
|
| 390 |
+
- for the PFD(s) full update for an existing application identifier, the existing application identifier and its new full list of PFD(s)
|
| 391 |
+
- for the PFD(s) partial update for an existing application identifier, the existing application identifier, partial update indication and
|
| 392 |
+
- new PFD(s) with new PFD identifier(s) to add new PFD(s),
|
| 393 |
+
- new PFD(s) with existing PFD identifier(s) to update existing PFD(s), and/or
|
| 394 |
+
- the existing PFD identifier(s) without any content to remove the existing PFD(s);
|
| 395 |
+
- for the PFD(s) removal for an existing application identifier, the existing application identifier and the removal indication.
|
| 396 |
+
|
| 397 |
+
Upon receipt of the HTTP POST request, the PFDF shall respond to the SCEF indicating whether the provisioning was successful or not using one of the HTTP status codes as defined in clause 5.3.2. If the provisioning was accepted, the PFDF shall respond with an HTTP 200 OK status code if no resource is created, or an HTTP 201 Created status code if one or more resources are created. If the allowed delay is too short according to the criteria in clause 4.4.1, the PFDF shall respond with an HTTP 200 OK status code and additional information in the body of the response indicating failure reason "too short allowed delay" and the value of caching time as defined in Annex A. If the provisioning was rejected, the PFDF shall indicate the reason using an appropriate HTTP status code as defined in clause 5.3.2 and optionally additional information in the body of the response as defined in Annex A.
|
| 398 |
+
|
| 399 |
+
Below is an example of an HTTP POST and a corresponding successful response:
|
| 400 |
+
|
| 401 |
+
POST /nuapplication/provisioning HTTP/1.1
|
| 402 |
+
Host: pfdserver.example.com
|
| 403 |
+
Content-Type: application/json
|
| 404 |
+
Content-Length: ...
|
| 405 |
+
|
| 406 |
+
```
|
| 407 |
+
[
|
| 408 |
+
{
|
| 409 |
+
"application-identifier":"test-application-1",
|
| 410 |
+
"removal-flag":true
|
| 411 |
+
},
|
| 412 |
+
{
|
| 413 |
+
"application-identifier":"test-application-2",
|
| 414 |
+
"allowed-delay":600,
|
| 415 |
+
"pfds":[
|
| 416 |
+
{
|
| 417 |
+
"pfd-identifier":"pfd1",
|
| 418 |
+
"flow-descriptions":[
|
| 419 |
+
"permit in ip from 10.68.28.39 80 to any"
|
| 420 |
+
]
|
| 421 |
+
},
|
| 422 |
+
{
|
| 423 |
+
"pfd-identifier":"pfd2",
|
| 424 |
+
"urls":[
|
| 425 |
+
"^http://test.example.com(/\\S*)?$"
|
| 426 |
+
]
|
| 427 |
+
}
|
| 428 |
+
]
|
| 429 |
+
},
|
| 430 |
+
{
|
| 431 |
+
"application-identifier":"test-application-3",
|
| 432 |
+
"partial-flag":true,
|
| 433 |
+
"pfds":[
|
| 434 |
+
{
|
| 435 |
+
"pfd-identifier":"pfd3",
|
| 436 |
+
"urls":[
|
| 437 |
+
"^http://test.example2.net(/\\S*)?$"
|
| 438 |
+
]
|
| 439 |
+
}
|
| 440 |
+
]
|
| 441 |
+
}
|
| 442 |
+
]
|
| 443 |
+
```
|
| 444 |
+
|
| 445 |
+
```
|
| 446 |
+
]
|
| 447 |
+
},
|
| 448 |
+
{
|
| 449 |
+
"pfd-identifier":"pfd4"
|
| 450 |
+
}
|
| 451 |
+
]
|
| 452 |
+
}
|
| 453 |
+
]
|
| 454 |
+
```
|
| 455 |
+
|
| 456 |
+
Here is an example of a successful response:
|
| 457 |
+
|
| 458 |
+
HTTP/1.1 200 OK
|
| 459 |
+
|
| 460 |
+
Date: Mon, 7 May 2012 16:00:00 GMT
|
| 461 |
+
|
| 462 |
+
Server: pfdserver.example.com
|
| 463 |
+
|
| 464 |
+
Content-Type: application/json
|
| 465 |
+
|
| 466 |
+
```
|
| 467 |
+
{
|
| 468 |
+
"success-message": "Notification was processed successfully.",
|
| 469 |
+
}
|
| 470 |
+
```
|
| 471 |
+
|
| 472 |
+
#### 5.3.5.3 POST /nuapplication/notification
|
| 473 |
+
|
| 474 |
+
The notification of the PFD management shall be performed by the PFDF by using the POST method as follows:
|
| 475 |
+
|
| 476 |
+
- The request URI formatted as defined in clause 5.3.4 with the "path" part set to: /nuapplication/notification.
|
| 477 |
+
- The Content-Type header field set to "application/json".
|
| 478 |
+
- The body of the message encoded in JSON format as defined in Annex A. The body shall include the pfd-report.
|
| 479 |
+
|
| 480 |
+
Upon receipt of the HTTP POST request, the SCEF shall respond to the PFDF with HTTP 200 OK status code.
|
| 481 |
+
|
| 482 |
+
Below is an example of an HTTP POST and a corresponding response:
|
| 483 |
+
|
| 484 |
+
POST /nuapplication/notification HTTP/1.1
|
| 485 |
+
|
| 486 |
+
Host: scefservers.example.com
|
| 487 |
+
|
| 488 |
+
Content-Type: application/json
|
| 489 |
+
|
| 490 |
+
Content-Length: ...
|
| 491 |
+
|
| 492 |
+
```
|
| 493 |
+
{
|
| 494 |
+
"notification-pfd-reports": [
|
| 495 |
+
{
|
| 496 |
+
"application-ids": ["test-application-1", "test-application-2", "test-application-3"],
|
| 497 |
+
"pfd-failure-code": "PARTIAL_FAILURE",
|
| 498 |
+
"user-plane-location-area": {
|
| 499 |
+
"cell-ids" : ["46000045BD6007", "46000045BD6008"],
|
| 500 |
+
}
|
| 501 |
+
}
|
| 502 |
+
]
|
| 503 |
+
}
|
| 504 |
+
```
|
| 505 |
+
|
| 506 |
+
```
|
| 507 |
+
"tracking-area-ids" : ["46000063F8", "46000063F9"]
|
| 508 |
+
}
|
| 509 |
+
}
|
| 510 |
+
]
|
| 511 |
+
}
|
| 512 |
+
```
|
| 513 |
+
|
| 514 |
+
Here is an example of a response:
|
| 515 |
+
|
| 516 |
+
HTTP/1.1 200 OK
|
| 517 |
+
|
| 518 |
+
Date: Mon, 7 May 2018 16:00:00 GMT
|
| 519 |
+
|
| 520 |
+
Server: scefservers.example.com
|
| 521 |
+
|
| 522 |
+
Content-Type: application/json
|
| 523 |
+
|
| 524 |
+
### 5.3.6 Feature negotiation
|
| 525 |
+
|
| 526 |
+
#### 5.3.6.1 General
|
| 527 |
+
|
| 528 |
+
The REST based Nu interface needs to provide a mechanism to advertise required and optional features supported by both the SCEF and PFDF for interoperability reasons as the functionality of the REST Nu based interface is augmented.
|
| 529 |
+
|
| 530 |
+
Feature negotiation shall take place during the first interaction (i.e. HTTP POST in provisioning) between the PFDF and the SCEF. The client shall include in the HTTP request the set of supported features as follows:
|
| 531 |
+
|
| 532 |
+
- if a feature is required for the proper operation of the application, it shall be included within the 3gpp-Required-Features header;
|
| 533 |
+
- if a feature is optional for the proper operation of the application, it shall be included within the 3gpp-Optional-Features header.
|
| 534 |
+
|
| 535 |
+
The server shall include, within the 3gpp-Accepted-Features header in the HTTP response, the set of features it supports in common with the client.
|
| 536 |
+
|
| 537 |
+
If the server does not support any of the required features advertised by the client within the 3gpp-Required-Features header, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features.
|
| 538 |
+
|
| 539 |
+
If the server requires certain features to be supported that are not advertised by the client, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features.
|
| 540 |
+
|
| 541 |
+
If the SCEF and the PFDF successfully negotiate supported features, the list of commonly supported features shall be applicable for the lifetime of the application. Features that are not advertised as supported shall not be used.
|
| 542 |
+
|
| 543 |
+
The sender may send information that is related to the supported features. Any unrecognized information shall be ignored by the receiver.
|
| 544 |
+
|
| 545 |
+
The table below defines the features applicable to the Nu interface.
|
| 546 |
+
|
| 547 |
+
**Table 5.3.6.1-1: Features used in Nu Interface**
|
| 548 |
+
|
| 549 |
+
| Feature | M/O | Description |
|
| 550 |
+
|-------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------|
|
| 551 |
+
| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. |
|
| 552 |
+
| PfdMgmtNotification | O | This feature supports the PFD management notification. |
|
| 553 |
+
| Feature: A short name for the feature to which the M/O and description pertain. | | |
|
| 554 |
+
| M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | |
|
| 555 |
+
| Description: Textual description of the feature. | | |
|
| 556 |
+
|
| 557 |
+
NOTE: The base functionality for the Nu interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the Nu interface whereby each entity may support all, some, or none of the features that the Nu application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification.
|
| 558 |
+
|
| 559 |
+
Since a post Release-16 version of SCEF does not send any supported feature information, the interworking PFDF supporting Release-16 version does not need to send any information related to supported feature and both sides shall behave as specified in the Release-14 version of this specification.
|
| 560 |
+
|
| 561 |
+
A post Release-16 version of PFDF may receive supported feature information from a Release-16 version of SCEF, those information will be ignored by the PFDF and both sides shall behave as specified in the Release-14 version of this specification.
|
| 562 |
+
|
| 563 |
+
#### 5.3.6.2 HTTP custom headers
|
| 564 |
+
|
| 565 |
+
This clause defines any new HTTP custom headers introduced by this specification.
|
| 566 |
+
|
| 567 |
+
##### 5.3.6.2.1 3gpp-Optional-Features
|
| 568 |
+
|
| 569 |
+
This header is used by the client to advertise the optional features that are supported by the client.
|
| 570 |
+
|
| 571 |
+
The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13].
|
| 572 |
+
|
| 573 |
+
`3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token`
|
| 574 |
+
|
| 575 |
+
An example is: `3gpp-Optional-Features: feature1, feature2`
|
| 576 |
+
|
| 577 |
+
##### 5.3.6.2.2 3gpp-Required-Features
|
| 578 |
+
|
| 579 |
+
This header is used by the client to announce the mandatory features that must be supported in the server.
|
| 580 |
+
|
| 581 |
+
This header is also used by the server to indicate the missing features that must be supported in the client.
|
| 582 |
+
|
| 583 |
+
The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13].
|
| 584 |
+
|
| 585 |
+
`3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token`
|
| 586 |
+
|
| 587 |
+
An example is: `3gpp-Required-Features: feature1, feature2`
|
| 588 |
+
|
| 589 |
+
##### 5.3.6.2.3 3gpp-Accepted-Features
|
| 590 |
+
|
| 591 |
+
The header is used by the server to confirm the commonly supported set of features with the client.
|
| 592 |
+
|
| 593 |
+
The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13].
|
| 594 |
+
|
| 595 |
+
`3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token`
|
| 596 |
+
|
| 597 |
+
An example is: `3gpp-Accepted-Features: feature1, feature2`
|
| 598 |
+
|
| 599 |
+
## 5.4 Specific application communication
|
| 600 |
+
|
| 601 |
+
### 5.4.1 General
|
| 602 |
+
|
| 603 |
+
Specific application communication represents the presentation of application data structures by transforming data into the form that the application accepts. It establishes the context between application-layer entities.
|
| 604 |
+
|
| 605 |
+
NOTE: This release only supports the content type JSON.
|
| 606 |
+
|
| 607 |
+
### 5.4.2 Content type
|
| 608 |
+
|
| 609 |
+
The body of HTTP messages shall be in JSON format. The content of the JSON text is defined in clause 5.4.3 and Annex A.
|
| 610 |
+
|
| 611 |
+
The MIME media type that shall be used within the Content-Type header field is "application/json" as defined in IETF RFC 7159 [11].
|
| 612 |
+
|
| 613 |
+
### 5.4.3 JSON provisioning fields
|
| 614 |
+
|
| 615 |
+
#### 5.4.3.1 General
|
| 616 |
+
|
| 617 |
+
Table 5.4.3.1-1 describes the JSON provisioning fields used within the body of the HTTP messages representing the PFDs information associated with an application identifier. The table includes the information about the name of the field and the type of the fields.
|
| 618 |
+
|
| 619 |
+
**Table 5.4.3.1-1: Nu Provisioning JSON fields**
|
| 620 |
+
|
| 621 |
+
| Field Name | Clause defined | JSON Value Type<br>(NOTE 1) | JCR Type<br>(NOTE 2) | Applicability<br>(NOTE 4) |
|
| 622 |
+
|------------------------|--------------------|-----------------------------|----------------------|---------------------------|
|
| 623 |
+
| application-identifier | 3GPP TS 29.251 [9] | string | string | |
|
| 624 |
+
| allowed-delay | 3GPP TS 29.251 [9] | number | uint64 | |
|
| 625 |
+
| pfdids | 3GPP TS 29.251 [9] | array | array | |
|
| 626 |
+
| pfd-identifier | 3GPP TS 29.251 [9] | string | string | |
|
| 627 |
+
| flow-descriptions | 3GPP TS 29.251 [9] | array | array | |
|
| 628 |
+
| urls | 3GPP TS 29.251 [9] | array | array | |
|
| 629 |
+
| domain-names | 3GPP TS 29.251 [9] | array | array | |
|
| 630 |
+
| removal-flag (NOTE 3) | 3GPP TS 29.251 [9] | boolean | boolean | |
|
| 631 |
+
| partial-flag (NOTE 3) | 3GPP TS 29.251 [9] | boolean | boolean | |
|
| 632 |
+
| dn-protocol | 3GPP TS 29.251 [9] | string | string | DomainNameProtocol |
|
| 633 |
+
| scef-notification-uri | 5.4.3.2 | string | string | PfdMgmtNotification |
|
| 634 |
+
|
| 635 |
+
NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11].
|
| 636 |
+
NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12].
|
| 637 |
+
NOTE 3: Only one of the removal-flag and the partial-flag for the application identifier shall be set to true.
|
| 638 |
+
NOTE 4: Fields marked with a supported feature are applicable as described in clause 5.3.6.
|
| 639 |
+
|
| 640 |
+
#### 5.4.3.2 scef-notification-uri
|
| 641 |
+
|
| 642 |
+
The scef-notification-uri is of type string indicating the SCEF sent URI for receiving notifications.
|
| 643 |
+
|
| 644 |
+
### 5.4.4 Void
|
| 645 |
+
|
| 646 |
+
### 5.4.5 JSON errors and informational response fields
|
| 647 |
+
|
| 648 |
+
#### 5.4.5.1 General
|
| 649 |
+
|
| 650 |
+
Table 5.4.4.1-1 describes the JSON fields defined for the errors and informational responses including their types and the field names.
|
| 651 |
+
|
| 652 |
+
**Table 5.4.5.1-1: JSON fields for errors and informational response**
|
| 653 |
+
|
| 654 |
+
| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 5) |
|
| 655 |
+
|---------------------------------------------------------------------------------------------|-----------------------------|--------------------------|-----------------------------------------------------------------|------------------------|
|
| 656 |
+
| errors | 3GPP TS 29.251 [9] (NOTE 4) | array | array | |
|
| 657 |
+
| error-type | 3GPP TS 29.251 [9] (NOTE 4) | string | "application"<br>"interface"<br>"server"<br>"other"<br>(NOTE 3) | |
|
| 658 |
+
| error-message | 3GPP TS 29.251 [9] | string | string | |
|
| 659 |
+
| error-tag | 3GPP TS 29.251 [9] | string | string | |
|
| 660 |
+
| error-path | 3GPP TS 29.251 [9] | string | string | |
|
| 661 |
+
| error-info | 3GPP TS 29.251 [9] | object | object | |
|
| 662 |
+
| success-message | 3GPP TS 29.251 [9] | string | string | |
|
| 663 |
+
| success-path | 3GPP TS 29.251 [9] | string | string | |
|
| 664 |
+
| success-info | 3GPP TS 29.251 [9] | object | object | |
|
| 665 |
+
| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | |
|
| 666 |
+
| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | |
|
| 667 |
+
| NOTE 3: The quoted strings for a string type. | | | | |
|
| 668 |
+
| NOTE 4: The error is sent from the PFDF to the SCEF. | | | | |
|
| 669 |
+
| NOTE 5: Fields marked with a supported feature are applicable as described in clause 5.3.6. | | | | |
|
| 670 |
+
|
| 671 |
+
### 5.4.6 JSON report fields
|
| 672 |
+
|
| 673 |
+
#### 5.4.6.1 General
|
| 674 |
+
|
| 675 |
+
Table 5.4.6.1-1 describes the JSON fields defined for the report information objects which are included in the error-info field.
|
| 676 |
+
|
| 677 |
+
**Table 5.4.6.1-1: JSON fields for Report from the PFDF**
|
| 678 |
+
|
| 679 |
+
| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 4) |
|
| 680 |
+
|---------------------------------------------------------------------------------------------|-----------------------------|--------------------------|-------------------|------------------------|
|
| 681 |
+
| pfd-reports | 5.4.6.2 | array | array | |
|
| 682 |
+
| application-ids | 5.4.6.3 | array | array | |
|
| 683 |
+
| pfd-failure-code | 3GPP TS 29.251 [9] (NOTE 3) | string | string | |
|
| 684 |
+
| caching-time | 3GPP TS 29.251 [9] | number | uint64 | |
|
| 685 |
+
| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | |
|
| 686 |
+
| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | |
|
| 687 |
+
| NOTE 3: The additional failure reasons for Nu are "TOO_SHORT_ALLOWED_DELAY". | | | | |
|
| 688 |
+
| NOTE 4: Fields marked with a supported feature are applicable as described in clause 5.3.6. | | | | |
|
| 689 |
+
|
| 690 |
+
#### 5.4.6.2 pfd-reports
|
| 691 |
+
|
| 692 |
+
The pfd-reports field is of type array and it contains a list of pfd reports.
|
| 693 |
+
|
| 694 |
+
The pfd-reports field can be used in an HTTP response to report failures in the installation/modification of PFDs. In this case, it shall be provided as a sub field of the error-info field.
|
| 695 |
+
|
| 696 |
+
Multiple pfd report instances shall be provided within the pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response.
|
| 697 |
+
|
| 698 |
+
caching-time field is included if the pfd-failure-code is set to the value "TOO\_SHORT\_ALLOWED\_DELAY".
|
| 699 |
+
|
| 700 |
+
A report instance shall contain application-ids and pfd-failure-code fields.
|
| 701 |
+
|
| 702 |
+
The JCR format for the pfd-reports is:
|
| 703 |
+
|
| 704 |
+
```
|
| 705 |
+
$pfd-reports = "pfd-reports" : [
|
| 706 |
+
{ $application-ids,
|
| 707 |
+
$pfd-failure-code,
|
| 708 |
+
$caching-time,
|
| 709 |
+
} +
|
| 710 |
+
]
|
| 711 |
+
```
|
| 712 |
+
|
| 713 |
+
#### 5.4.6.3 application-ids
|
| 714 |
+
|
| 715 |
+
The application-ids field is of type array of string, and contains one or more application identifiers to which the PFDs belong.
|
| 716 |
+
|
| 717 |
+
### 5.4.7 JSON notification fields
|
| 718 |
+
|
| 719 |
+
#### 5.4.7.1 General
|
| 720 |
+
|
| 721 |
+
Table 5.4.7.1-1 describes the JSON notification fields used within the body of the HTTP messages. The table includes the information about the name of the field and the type of the fields.
|
| 722 |
+
|
| 723 |
+
**Table 5.4.7.1-1: Nu Notification JSON fields**
|
| 724 |
+
|
| 725 |
+
| Field Name | Clause defined | JSON Value Type<br>(NOTE 1) | JCR Type<br>(NOTE 2) | Applicability<br>(NOTE 3) |
|
| 726 |
+
|--------------------------|---------------------------------|-----------------------------|----------------------|---------------------------|
|
| 727 |
+
| notification-pfd-reports | 5.4.7.2 | array | array | PfdMgmtNotification |
|
| 728 |
+
| application-ids | 5.4.6.3 | array | array | PfdMgmtNotification |
|
| 729 |
+
| pfd-failure-code | 3GPP TS 29.251 [9] (<br>NOTE 4) | string | string | PfdMgmtNotification |
|
| 730 |
+
| user-plane-location-area | 5.4.7.3 | object | object | PfdMgmtNotification |
|
| 731 |
+
| cell-ids | 5.4.7.4 | array | array | PfdMgmtNotification |
|
| 732 |
+
| enodeb-ids | 5.4.7.5 | array | array | PfdMgmtNotification |
|
| 733 |
+
| extended-enodeb-ids | 5.4.7.6 | array | array | PfdMgmtNotification |
|
| 734 |
+
| routing-area-ids | 5.4.7.7 | array | array | PfdMgmtNotification |
|
| 735 |
+
| tracking-area-ids | 5.4.7.8 | array | array | PfdMgmtNotification |
|
| 736 |
+
|
| 737 |
+
NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11].
|
| 738 |
+
NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12].
|
| 739 |
+
NOTE 3: Fields marked with a supported feature are applicable as described in clause 5.3.6.
|
| 740 |
+
NOTE 4: The additional failure reasons for Nu are "PARTIAL\_FAILURE".
|
| 741 |
+
|
| 742 |
+
#### 5.4.7.2 notification-pfd-reports
|
| 743 |
+
|
| 744 |
+
The notification-pfd-reports field is of type array and it contains a list of pfd reports.
|
| 745 |
+
|
| 746 |
+
The notification-pfd-reports field can be used in an HTTP POST to notify the failures in the installation/modification of PFDs. In this case, it shall be included in the body of the message.
|
| 747 |
+
|
| 748 |
+
Multiple pfd report instances shall be provided within the notification-pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response.
|
| 749 |
+
|
| 750 |
+
user-plane-location-area field is included if the pfd-failure-code is set to the value "PARTIAL\_FAILURE".
|
| 751 |
+
|
| 752 |
+
A report instance shall contain application-ids and pfd-failure-code fields.
|
| 753 |
+
|
| 754 |
+
The JCR format for the notification-pfd-reports is:
|
| 755 |
+
|
| 756 |
+
```
|
| 757 |
+
$notification-pfd-reports = "notification-pfd-reports" : [
|
| 758 |
+
{ $application-ids,
|
| 759 |
+
$pfd-failure-code,
|
| 760 |
+
$user-plane-location-area ?
|
| 761 |
+
} +
|
| 762 |
+
]
|
| 763 |
+
```
|
| 764 |
+
|
| 765 |
+
#### 5.4.7.3 user-plane-location-area
|
| 766 |
+
|
| 767 |
+
The user-plane-location-areas field is of type object and it contains location areas of the user plane(s) which can not enforce the PFD(s) successfully.
|
| 768 |
+
|
| 769 |
+
The JCR format for the user-plane-location-area is:
|
| 770 |
+
|
| 771 |
+
```
|
| 772 |
+
$user-plane-location-area = // : {
|
| 773 |
+
$cell-ids ?,
|
| 774 |
+
$enodeb-ids ?,
|
| 775 |
+
$extended-enodeb-ids ?,
|
| 776 |
+
$routing-area-ids ?,
|
| 777 |
+
$tracking-area-id ?
|
| 778 |
+
}
|
| 779 |
+
```
|
| 780 |
+
|
| 781 |
+
#### 5.4.7.4 cell-ids
|
| 782 |
+
|
| 783 |
+
The cell-ids is of type string array and it contains a list of Cell Global Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.1 of 3GPP TS 29.274 [19].
|
| 784 |
+
|
| 785 |
+
#### 5.4.7.5 enodeb-ids
|
| 786 |
+
|
| 787 |
+
The enodeb-ids is of type string array and it contains a list of eNodeB identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.7 of 3GPP TS 29.274 [19].
|
| 788 |
+
|
| 789 |
+
#### 5.4.7.6 extended-enodeb-ids
|
| 790 |
+
|
| 791 |
+
The enodeb-ids is of type string array and it contains a list of eNodeB identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.8 of 3GPP TS 29.274 [19].
|
| 792 |
+
|
| 793 |
+
#### 5.4.7.7 routing-area-ids
|
| 794 |
+
|
| 795 |
+
The routing-area-ids is of type string array and it contains a list of Routing Area Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.3 of 3GPP TS 29.274 [19].
|
| 796 |
+
|
| 797 |
+
#### 5.4.7.8 tracking-area-ids
|
| 798 |
+
|
| 799 |
+
The tracking-area-ids is of type string array and it contains a list of Tracking Area Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.4 of 3GPP TS 29.274 [19].
|
| 800 |
+
|
| 801 |
+
## 5.5 PFDF discovery
|
| 802 |
+
|
| 803 |
+
The PFDF URI may be pre-configured on the SCEF.
|
| 804 |
+
|
| 805 |
+
The SCEF may select the PFDF by this configuration.
|
| 806 |
+
|
| 807 |
+
## 5.6 SCEF discovery
|
| 808 |
+
|
| 809 |
+
The SCEF notification URI may be pre-configured on the PFDF.
|
| 810 |
+
|
| 811 |
+
The SCEF notification URI may also be sent to the PFDF in the PFD provisioning.
|
| 812 |
+
|
| 813 |
+
The PFDF may select the SCEF by the pre-configuration or use the notification URI received in the PFD provisioning.
|
| 814 |
+
|
| 815 |
+
# --- 6 Secure communication
|
| 816 |
+
|
| 817 |
+
Either the NDS/IP network layer security defined in 3GPP TS 33.210 [5] or HTTP over TLS as defined in IETF RFC 2818 [6] should be used to secure communication over the REST based Nu interface.
|
| 818 |
+
|
| 819 |
+
# --- Annex A (informative): JSON Schema
|
| 820 |
+
|
| 821 |
+
## A.1 Provisioning schema
|
| 822 |
+
|
| 823 |
+
This clause defines the JSON schema for the body of HTTP request providing the provisioned PFDs. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below:
|
| 824 |
+
|
| 825 |
+
```
|
| 826 |
+
# jcr-version 0.7
|
| 827 |
+
```
|
| 828 |
+
|
| 829 |
+
```
|
| 830 |
+
# ruleset-id 3gpp.nuapplication.provisioning
|
| 831 |
+
```
|
| 832 |
+
|
| 833 |
+
```
|
| 834 |
+
# import 3gpp.gwapplication.pfds as pfds
|
| 835 |
+
```
|
| 836 |
+
|
| 837 |
+
```
|
| 838 |
+
; JCR representing the PFDs provisioning data
|
| 839 |
+
```
|
| 840 |
+
|
| 841 |
+
```
|
| 842 |
+
$provisioning-root = @{root} {
|
| 843 |
+
```
|
| 844 |
+
|
| 845 |
+
```
|
| 846 |
+
$application-identifier,
|
| 847 |
+
```
|
| 848 |
+
|
| 849 |
+
```
|
| 850 |
+
$removal-flag ?,
|
| 851 |
+
```
|
| 852 |
+
|
| 853 |
+
```
|
| 854 |
+
$partial-flag ?,
|
| 855 |
+
```
|
| 856 |
+
|
| 857 |
+
```
|
| 858 |
+
$allowed-delay ?,
|
| 859 |
+
```
|
| 860 |
+
|
| 861 |
+
```
|
| 862 |
+
$pfds ?,
|
| 863 |
+
```
|
| 864 |
+
|
| 865 |
+
```
|
| 866 |
+
$scefn-notification-uri ?
|
| 867 |
+
```
|
| 868 |
+
|
| 869 |
+
```
|
| 870 |
+
}
|
| 871 |
+
|
| 872 |
+
; An array list of the PFDs for multiple application identifiers
|
| 873 |
+
$pfd-array-root = @{root} [ $provisioning-root * ]
|
| 874 |
+
|
| 875 |
+
; The detected application traffic identifier for the PFDs
|
| 876 |
+
$application-identifier = "application-identifier" : string
|
| 877 |
+
|
| 878 |
+
; The allowed delay time for the PFDs deployment
|
| 879 |
+
$allowed-delay = "allowed-delay" : uint64
|
| 880 |
+
|
| 881 |
+
; The PFDs associated with the same application identifier
|
| 882 |
+
$pfd = "pfd" : [ $pfd * ]
|
| 883 |
+
; The PFD content
|
| 884 |
+
$pfd = {
|
| 885 |
+
$pfd-identifier,
|
| 886 |
+
( $flow-descriptions | $urls | $domain-names | // : any ) ?,
|
| 887 |
+
$pfd.dn-protocol ?
|
| 888 |
+
}
|
| 889 |
+
|
| 890 |
+
; The PFD identifier
|
| 891 |
+
$pfd-identifier = "pfd-identifier" : string
|
| 892 |
+
|
| 893 |
+
; The flow descriptions
|
| 894 |
+
$flow-descriptions = "flow-descriptions" : [ string + ]
|
| 895 |
+
|
| 896 |
+
; The url matching expressions
|
| 897 |
+
$urls = "urls" : [ string + ]
|
| 898 |
+
|
| 899 |
+
; The domain name match criteria
|
| 900 |
+
$domain-names = "domain-names" : [ string + ]
|
| 901 |
+
|
| 902 |
+
; A flag indicates whether this is a removal or not
|
| 903 |
+
$removal-flag = "removal-flag" : boolean
|
| 904 |
+
```
|
| 905 |
+
|
| 906 |
+
; A flag indicates whether this is a partial update or not
|
| 907 |
+
\$partial-flag = "partial-flag" : boolean
|
| 908 |
+
|
| 909 |
+
; The URI in the SCEF for receiving notifications from the PFDF
|
| 910 |
+
\$sceff-notification-uri = "sceff-notification-uri" : string
|
| 911 |
+
|
| 912 |
+
## --- A.2 Error and Informational response schema
|
| 913 |
+
|
| 914 |
+
This clause defines the JSON schema for the body of HTTP responses in case of errors or success. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below:
|
| 915 |
+
|
| 916 |
+
# jcr-version 0.7
|
| 917 |
+
|
| 918 |
+
# ruleset-id 3gpp.nuapplication.info
|
| 919 |
+
|
| 920 |
+
; A JCR for the error/successful response body
|
| 921 |
+
|
| 922 |
+
; Errors information
|
| 923 |
+
|
| 924 |
+
\$errors-root = @{root} { \$errors }
|
| 925 |
+
|
| 926 |
+
; Success information
|
| 927 |
+
|
| 928 |
+
```
|
| 929 |
+
$success-root = @{root} {
|
| 930 |
+
$success-message,
|
| 931 |
+
$success-path ?,
|
| 932 |
+
$success-info ?
|
| 933 |
+
}
|
| 934 |
+
```
|
| 935 |
+
|
| 936 |
+
; Resource fields definitions
|
| 937 |
+
|
| 938 |
+
; The list of errors returned in responses sent by the PCEF/TDF
|
| 939 |
+
|
| 940 |
+
```
|
| 941 |
+
$errors = "errors" : [
|
| 942 |
+
{
|
| 943 |
+
$error-type,
|
| 944 |
+
$error-message,
|
| 945 |
+
$error-tag ?,
|
| 946 |
+
$error-path ?,
|
| 947 |
+
$error-info ?
|
| 948 |
+
} +
|
| 949 |
+
]
|
| 950 |
+
```
|
| 951 |
+
|
| 952 |
+
; The error type for an error. It can be one of 'application', 'interface', 'server' and 'other'.
|
| 953 |
+
|
| 954 |
+
\$error-type = "error-type" : ( "application" | "interface" | "server" | "other" )
|
| 955 |
+
|
| 956 |
+
; The error text message
|
| 957 |
+
|
| 958 |
+
\$error-message = "error-message" : string
|
| 959 |
+
|
| 960 |
+
; The error tag for a specific error
|
| 961 |
+
|
| 962 |
+
\$error-tag = "error-tag" : string
|
| 963 |
+
|
| 964 |
+
; A JSON pointer path to the error resource
|
| 965 |
+
|
| 966 |
+
\$error-path = "error-path" : string
|
| 967 |
+
|
| 968 |
+
; Any additional information for the error
|
| 969 |
+
|
| 970 |
+
\$error-info = "error-info" : {
|
| 971 |
+
|
| 972 |
+
\$pfd-reports ?,
|
| 973 |
+
|
| 974 |
+
// : any \*
|
| 975 |
+
|
| 976 |
+
}
|
| 977 |
+
|
| 978 |
+
; Report fields definitions
|
| 979 |
+
|
| 980 |
+
; The list of pfd reports sent to the SCEF
|
| 981 |
+
|
| 982 |
+
\$pfd-reports = "pfd-reports" : [
|
| 983 |
+
|
| 984 |
+
{
|
| 985 |
+
|
| 986 |
+
\$application-ids,
|
| 987 |
+
|
| 988 |
+
\$pfd-failure-code,
|
| 989 |
+
|
| 990 |
+
\$caching-time
|
| 991 |
+
|
| 992 |
+
} +
|
| 993 |
+
|
| 994 |
+
]
|
| 995 |
+
|
| 996 |
+
; The application identifiers for the PFDs
|
| 997 |
+
|
| 998 |
+
\$application-ids = "application-ids" : [string+]
|
| 999 |
+
|
| 1000 |
+
; The string format for the pfd failure code
|
| 1001 |
+
|
| 1002 |
+
\$pfd-failure-code =: (
|
| 1003 |
+
|
| 1004 |
+
"MALFUNCTION" |
|
| 1005 |
+
|
| 1006 |
+
"RESOURCES\_LIMITATION" |
|
| 1007 |
+
|
| 1008 |
+
"TOO\_SHORT\_ALLOWED\_DELAY" |
|
| 1009 |
+
|
| 1010 |
+
```
|
| 1011 |
+
"PARTIAL_FAILURE" |
|
| 1012 |
+
"OTHER_REASON"
|
| 1013 |
+
)
|
| 1014 |
+
|
| 1015 |
+
; The caching time for the PFDs
|
| 1016 |
+
$caching-time = "caching-time" : uint64
|
| 1017 |
+
|
| 1018 |
+
; The successful text message
|
| 1019 |
+
$success-message = "success-message" : string
|
| 1020 |
+
|
| 1021 |
+
; A JSON pointer path to the success resource
|
| 1022 |
+
$success-path = "success-path" : string
|
| 1023 |
+
|
| 1024 |
+
; Any additional information for the success.
|
| 1025 |
+
$success-info = "success-info" : { // : any * }
|
| 1026 |
+
```
|
| 1027 |
+
|
| 1028 |
+
## --- A.3 PFD management notification schema
|
| 1029 |
+
|
| 1030 |
+
This clause defines the JSON schema for the body of HTTP request providing the notification of PFD management. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below:
|
| 1031 |
+
|
| 1032 |
+
```
|
| 1033 |
+
# jcr-version 0.7
|
| 1034 |
+
|
| 1035 |
+
# ruleset-id 3gpp.nuapplication.notification
|
| 1036 |
+
|
| 1037 |
+
; A JCR for the notification body
|
| 1038 |
+
$notification-root = @{root} {
|
| 1039 |
+
$notification-pfd-reports
|
| 1040 |
+
}
|
| 1041 |
+
|
| 1042 |
+
; Report fields definitions
|
| 1043 |
+
|
| 1044 |
+
; The list of pfd reports sent to the SCEF
|
| 1045 |
+
$notification-pfd-reports = "notification- pfd-reports" : [
|
| 1046 |
+
{
|
| 1047 |
+
$application-ids,
|
| 1048 |
+
$pfd-failure-code,
|
| 1049 |
+
$user-plane-location-area ?
|
| 1050 |
+
} +
|
| 1051 |
+
]
|
| 1052 |
+
```
|
| 1053 |
+
|
| 1054 |
+
; The application identifiers for the PFDs
|
| 1055 |
+
|
| 1056 |
+
\$application-ids = "application-ids" : [string+]
|
| 1057 |
+
|
| 1058 |
+
; The string format for the pfd failure code
|
| 1059 |
+
|
| 1060 |
+
\$pfd-failure-code =: (
|
| 1061 |
+
"MALFUNCTION" |
|
| 1062 |
+
"RESOURCES\_LIMITATION" |
|
| 1063 |
+
"PARTIAL\_FAILURE" |
|
| 1064 |
+
"OTHER\_REASON"
|
| 1065 |
+
)
|
| 1066 |
+
|
| 1067 |
+
; The location area of user planes which can not enforce the PFDs successfully
|
| 1068 |
+
|
| 1069 |
+
\$user-plane-location-area = {
|
| 1070 |
+
\$cell-ids ?,
|
| 1071 |
+
\$enodeb-ids ?,
|
| 1072 |
+
\$extended-enodeb-ids ?,
|
| 1073 |
+
\$routing-area-ids ?,
|
| 1074 |
+
\$tracking-area-ids ?
|
| 1075 |
+
}
|
| 1076 |
+
|
| 1077 |
+
; The cell IDs served by the user planes which can not enforce the PFDs successfully
|
| 1078 |
+
|
| 1079 |
+
\$cell-ids = "cell-ids" : [ string + ]
|
| 1080 |
+
|
| 1081 |
+
; The eNodeB IDs served by the user planes which can not enforce the PFDs successfully
|
| 1082 |
+
|
| 1083 |
+
\$enodeb-ids = "enodeb-ids" : [ string + ]
|
| 1084 |
+
|
| 1085 |
+
; The extended eNodeB IDs served by the user planes which can not enforce the PFDs successfully
|
| 1086 |
+
|
| 1087 |
+
\$extended-enodeb-ids = "extended-enodeb-ids" : [ string + ]
|
| 1088 |
+
|
| 1089 |
+
; The Routing Area IDs served by the user planes which can not enforce the PFDs successfully
|
| 1090 |
+
|
| 1091 |
+
\$routing-area-ids = "routing-area-ids" : [ string + ]
|
| 1092 |
+
|
| 1093 |
+
; The Tracking Area IDs served by the user planes which can not enforce the PFDs successfully
|
| 1094 |
+
|
| 1095 |
+
\$tracking-area-ids = "tracking-area-ids" : [ string + ]
|
| 1096 |
+
|
| 1097 |
+
|
| 1098 |
+
|
| 1099 |
+
# --- Annex B (informative): Call Flows
|
| 1100 |
+
|
| 1101 |
+
## B.1 General
|
| 1102 |
+
|
| 1103 |
+
This annex describes the procedures for the interactions between the PFDF and the SCEF.
|
| 1104 |
+
|
| 1105 |
+
## --- B.2 Provisioning of PFDs
|
| 1106 |
+
|
| 1107 |
+
This clause describes the signalling flow for the Provisioning of PFDs.
|
| 1108 |
+
|
| 1109 |
+

|
| 1110 |
+
|
| 1111 |
+
```
|
| 1112 |
+
sequenceDiagram
|
| 1113 |
+
participant SCEF
|
| 1114 |
+
participant PFDF
|
| 1115 |
+
Note right of SCEF: 1. HTTP POST
|
| 1116 |
+
SCEF->>PFDF: 1. HTTP POST
|
| 1117 |
+
Note left of PFDF: 2. HTTP 200 OK
|
| 1118 |
+
PFDF-->>SCEF: 2. HTTP 200 OK
|
| 1119 |
+
```
|
| 1120 |
+
|
| 1121 |
+
The diagram is a sequence diagram illustrating the interaction between the SCEF (Service Capability Exposure Function) and the PFDF (PDN Gateway Selection Function) for provisioning PFDs. It consists of two vertical lifelines. The first message is an arrow from the SCEF lifeline to the PFDF lifeline, labeled '1. HTTP POST'. The second message is an arrow from the PFDF lifeline back to the SCEF lifeline, labeled '2. HTTP 200 OK'.
|
| 1122 |
+
|
| 1123 |
+
Sequence diagram showing the provisioning of PFDs between SCEF and PFDF.
|
| 1124 |
+
|
| 1125 |
+
**Figure B.2.1: Provisioning of PFDs**
|
| 1126 |
+
|
| 1127 |
+
1. The SCEF sends the HTTP POST to the PFDF to indicate the creation, modification or deletion of PFDs for one or more application identifier(s) including the parameters defined in clause 5.3.5.2.
|
| 1128 |
+
2. The PFDF sends the HTTP 200 OK response to the SCEF including the parameters defined in clause 5.3.5.2.
|
| 1129 |
+
|
| 1130 |
+
# Annex C (informative): Change history
|
| 1131 |
+
|
| 1132 |
+
| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New |
|
| 1133 |
+
|---------|--------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------|--------|
|
| 1134 |
+
| 2016-10 | | | | | | TS skeleton of Nu reference point stage 3. | 0.0.0 |
|
| 1135 |
+
| 2016-10 | | | | | | Inclusion of C3-163247, C3-163248, C3-163322 and editorial change from Rapporteur. | 0.1.0 |
|
| 1136 |
+
| 2016-12 | | | | | | Inclusion of C3-164069, C3-164227 and editorial change from Rapporteur. | 0.2.0 |
|
| 1137 |
+
| 2017-01 | | | | | | Inclusion of C3-170053, C3-17 0054, C3-170056 and editorial change from Rapporteur. | 0.3.0 |
|
| 1138 |
+
| 2017-02 | | | | | | Inclusion of C3-171187, C3-171324, and editorial change from Rapporteur. | 0.4.0 |
|
| 1139 |
+
| 2017-04 | | | | | | Inclusion of C3-172121, C3-172193, C3-172278, and editorial change from Rapporteur. | 0.5.0 |
|
| 1140 |
+
| 2017-05 | | | | | | Inclusion of C3-173200, C3-173202, C3-173332, C3-173333 and editorial change from Rapporteur. | 0.6.0 |
|
| 1141 |
+
| 2017-06 | CT#76 | CP-171145 | | | | TS sent to plenary for information and approval | 1.0.0 |
|
| 1142 |
+
| 2017-06 | CT#76 | CP-171145 | | | | TS approved at plenary | 14.0.0 |
|
| 1143 |
+
| 2017-09 | CT#77 | CP-172047 | 0001 | 2 | F | Caching time over the Nu interface | 14.1.0 |
|
| 1144 |
+
| 2017-09 | CT#77 | CP-172047 | 0002 | 2 | F | Clarification of partial update | 14.1.0 |
|
| 1145 |
+
| 2017-09 | CT#77 | CP-172047 | 0003 | 1 | F | Correct the example of the PFD provisioning | 14.1.0 |
|
| 1146 |
+
| 2017-09 | CT#77 | CP-172047 | 0004 | 1 | F | Update the reference of HTTP 1.1 | 14.1.0 |
|
| 1147 |
+
| 2017-09 | CT#77 | CP-172047 | 0007 | - | F | PFD handling for Push or Combination mode in PFDF | 14.1.0 |
|
| 1148 |
+
| 2017-12 | CT#78 | CP-173100 | 0008 | - | F | JSON example correction | 14.2.0 |
|
| 1149 |
+
| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 |
|
| 1150 |
+
| 2019-03 | CT#83 | CP-190131 | 0010 | 2 | B | Supported feature negotiation | 16.0.0 |
|
| 1151 |
+
| 2019-03 | CT#83 | CP-190133 | 0012 | 2 | B | PFD extension | 16.0.0 |
|
| 1152 |
+
| 2019-06 | CT#84 | CP-191097 | 0015 | - | A | Reference update: draft-newton-json-content-rules | 16.1.0 |
|
| 1153 |
+
| 2019-06 | CT#84 | CP-191100 | 0016 | - | F | Encoding of custom header fields | 16.1.0 |
|
| 1154 |
+
| 2019-06 | CT#84 | CP-191102 | 0018 | 1 | B | PFD management notification | 16.1.0 |
|
| 1155 |
+
| 2019-12 | CT#86 | CP-193220 | 0019 | 3 | B | PFD partial failure notification | 16.2.0 |
|
| 1156 |
+
| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 |
|
| 1157 |
+
| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 |
|
marked/Rel-18/29_series/29251/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29256/raw.md
ADDED
|
@@ -0,0 +1,1155 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.256 V18.3.0 (2023-12)
|
| 4 |
+
|
| 5 |
+
*Technical Specification*
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Uncrewed Aerial Systems Network Function (UAS-NF); Aerial Management Services; Stage 3 (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in small capital letters to the right.
|
| 12 |
+
|
| 13 |
+
5G Advanced logo
|
| 14 |
+
|
| 15 |
+

|
| 16 |
+
|
| 17 |
+
The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters.
|
| 18 |
+
|
| 19 |
+
3GPP logo
|
| 20 |
+
|
| 21 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 22 |
+
|
| 23 |
+
## **3GPP**
|
| 24 |
+
|
| 25 |
+
---
|
| 26 |
+
|
| 27 |
+
Postal address
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
3GPP support office address
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 36 |
+
|
| 37 |
+
Valbonne - FRANCE
|
| 38 |
+
|
| 39 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 40 |
+
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
Internet
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
<http://www.3gpp.org>
|
| 48 |
+
|
| 49 |
+
## --- **Copyright Notification** ---
|
| 50 |
+
|
| 51 |
+
No part may be reproduced except as authorized by written permission.
|
| 52 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 53 |
+
|
| 54 |
+
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 55 |
+
All rights reserved.
|
| 56 |
+
|
| 57 |
+
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
|
| 58 |
+
|
| 59 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 60 |
+
|
| 61 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 62 |
+
|
| 63 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 64 |
+
|
| 65 |
+
# Contents
|
| 66 |
+
|
| 67 |
+
| | |
|
| 68 |
+
|--------------------------------------------------------|----|
|
| 69 |
+
| Foreword ..... | 5 |
|
| 70 |
+
| 1 Scope..... | 7 |
|
| 71 |
+
| 2 References..... | 7 |
|
| 72 |
+
| 3 Definitions of terms, symbols and abbreviations..... | 8 |
|
| 73 |
+
| 3.1 Terms..... | 8 |
|
| 74 |
+
| 3.2 Symbols..... | 8 |
|
| 75 |
+
| 3.3 Abbreviations ..... | 8 |
|
| 76 |
+
| 4 Overview..... | 8 |
|
| 77 |
+
| 4.1 Introduction ..... | 8 |
|
| 78 |
+
| 5 Services offered by the NEF (UAS-NF)..... | 9 |
|
| 79 |
+
| 5.1 Introduction ..... | 9 |
|
| 80 |
+
| 5.2 Nnef_Authentication Service ..... | 9 |
|
| 81 |
+
| 5.2.1 Service Description ..... | 9 |
|
| 82 |
+
| 5.2.2 Service Operations..... | 9 |
|
| 83 |
+
| 5.2.2.1 Introduction..... | 9 |
|
| 84 |
+
| 5.2.2.2 AuthenticateAuthorize Service Operation ..... | 10 |
|
| 85 |
+
| 5.2.2.2.1 General ..... | 10 |
|
| 86 |
+
| 5.2.2.3 AuthNotify Service Operation ..... | 11 |
|
| 87 |
+
| 5.2.2.3.1 General ..... | 11 |
|
| 88 |
+
| 6 API Definitions ..... | 12 |
|
| 89 |
+
| 6.1 Nnef_Authentication Service API..... | 12 |
|
| 90 |
+
| 6.1.1 Introduction ..... | 12 |
|
| 91 |
+
| 6.1.2 Usage of HTTP..... | 13 |
|
| 92 |
+
| 6.1.2.1 General..... | 13 |
|
| 93 |
+
| 6.1.2.2 HTTP standard headers..... | 13 |
|
| 94 |
+
| 6.1.2.2.1 General ..... | 13 |
|
| 95 |
+
| 6.1.2.2.2 Content type ..... | 13 |
|
| 96 |
+
| 6.1.2.3 HTTP custom headers..... | 13 |
|
| 97 |
+
| 6.1.3 Resources..... | 13 |
|
| 98 |
+
| 6.1.3.1 Overview..... | 13 |
|
| 99 |
+
| 6.1.3.2 Resource: uav-authentications ..... | 14 |
|
| 100 |
+
| 6.1.3.2.1 Description ..... | 14 |
|
| 101 |
+
| 6.1.3.2.2 Resource Definition..... | 14 |
|
| 102 |
+
| 6.1.3.2.3 Resource Standard Methods..... | 14 |
|
| 103 |
+
| 6.1.3.2.4 Resource Custom Operations..... | 15 |
|
| 104 |
+
| 6.1.5 Notifications ..... | 15 |
|
| 105 |
+
| 6.1.5.1 General..... | 15 |
|
| 106 |
+
| 6.1.5.2 Authentication Notification ..... | 16 |
|
| 107 |
+
| 6.1.5.2.1 Description ..... | 16 |
|
| 108 |
+
| 6.1.5.2.2 Target URI..... | 16 |
|
| 109 |
+
| 6.1.5.2.3 Standard Methods..... | 16 |
|
| 110 |
+
| 6.1.6 Data Model ..... | 17 |
|
| 111 |
+
| 6.1.6.1 General..... | 17 |
|
| 112 |
+
| 6.1.6.2 Structured data types..... | 17 |
|
| 113 |
+
| 6.1.6.2.1 Introduction ..... | 17 |
|
| 114 |
+
| 6.1.6.2.2 Type: UAVAuthInfo ..... | 18 |
|
| 115 |
+
| 6.1.6.2.3 Type: AuthNotification ..... | 19 |
|
| 116 |
+
| 6.1.6.2.4 Type: UAVAuthResponse..... | 20 |
|
| 117 |
+
| 6.1.6.2.5 Type: UAVAuthFailure..... | 21 |
|
| 118 |
+
| 6.1.6.2.6 Type: AuthContainer..... | 21 |
|
| 119 |
+
| 6.1.6.3 Simple data types and enumerations..... | 21 |
|
| 120 |
+
| 6.1.6.3.1 Introduction ..... | 21 |
|
| 121 |
+
| 6.1.6.3.2 Simple data types ..... | 22 |
|
| 122 |
+
|
| 123 |
+
- 6.1.6.3.3 Enumeration: AuthResult..... 22
|
| 124 |
+
- 6.1.6.3.4 Enumeration: NotifType ..... 22
|
| 125 |
+
- 6.1.7 Error Handling..... 22
|
| 126 |
+
- 6.1.7.1 General..... 22
|
| 127 |
+
- 6.1.7.2 Protocol Errors ..... 22
|
| 128 |
+
- 6.1.7.3 Application Errors..... 22
|
| 129 |
+
- 6.1.8 Feature negotiation ..... 23
|
| 130 |
+
- 6.1.9 Security ..... 23
|
| 131 |
+
- 6.1.10 HTTP redirection..... 23
|
| 132 |
+
|
| 133 |
+
A.1 General..... 23
|
| 134 |
+
A.2 Nnef\_Authentication API ..... 24
|
| 135 |
+
|
| 136 |
+
# --- Foreword
|
| 137 |
+
|
| 138 |
+
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
|
| 139 |
+
|
| 140 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 141 |
+
|
| 142 |
+
Version x.y.z
|
| 143 |
+
|
| 144 |
+
where:
|
| 145 |
+
|
| 146 |
+
- x the first digit:
|
| 147 |
+
- 1 presented to TSG for information;
|
| 148 |
+
- 2 presented to TSG for approval;
|
| 149 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 150 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 151 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 152 |
+
|
| 153 |
+
In the present document, modal verbs have the following meanings:
|
| 154 |
+
|
| 155 |
+
**shall** indicates a mandatory requirement to do something
|
| 156 |
+
|
| 157 |
+
**shall not** indicates an interdiction (prohibition) to do something
|
| 158 |
+
|
| 159 |
+
The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
|
| 160 |
+
|
| 161 |
+
The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
|
| 162 |
+
|
| 163 |
+
**should** indicates a recommendation to do something
|
| 164 |
+
|
| 165 |
+
**should not** indicates a recommendation not to do something
|
| 166 |
+
|
| 167 |
+
**may** indicates permission to do something
|
| 168 |
+
|
| 169 |
+
**need not** indicates permission not to do something
|
| 170 |
+
|
| 171 |
+
The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
|
| 172 |
+
|
| 173 |
+
**can** indicates that something is possible
|
| 174 |
+
|
| 175 |
+
**cannot** indicates that something is impossible
|
| 176 |
+
|
| 177 |
+
The constructions "can" and "cannot" are not substitutes for "may" and "need not".
|
| 178 |
+
|
| 179 |
+
**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
|
| 180 |
+
|
| 181 |
+
**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
|
| 182 |
+
|
| 183 |
+
**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
|
| 184 |
+
|
| 185 |
+
**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
|
| 186 |
+
|
| 187 |
+
In addition:
|
| 188 |
+
|
| 189 |
+
**is** (or any other verb in the indicative mood) indicates a statement of fact
|
| 190 |
+
|
| 191 |
+
**is not** (or any other negative verb in the indicative mood) indicates a statement of fact
|
| 192 |
+
|
| 193 |
+
The constructions "is" and "is not" do not indicate requirements.
|
| 194 |
+
|
| 195 |
+
# --- 1 Scope
|
| 196 |
+
|
| 197 |
+
The present document specifies the stage 3 protocol and data model for the UAS-NF functionality of the Nnef Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NEF (UAS-NF).
|
| 198 |
+
|
| 199 |
+
The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
|
| 200 |
+
|
| 201 |
+
The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
|
| 202 |
+
|
| 203 |
+
The Uncrewed Aerial System Network Function (UAS-NF) provides the UAS-specific NEF services to NF service consumers (e.g. AMF, SMF). The UAS-NF is functionality within the NEF.
|
| 204 |
+
|
| 205 |
+
# --- 2 References
|
| 206 |
+
|
| 207 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 208 |
+
|
| 209 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 210 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 211 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 212 |
+
|
| 213 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 214 |
+
- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
|
| 215 |
+
- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
|
| 216 |
+
- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
|
| 217 |
+
- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
|
| 218 |
+
- [6] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2".
|
| 219 |
+
- [7] 3GPP TR 21.900: "Technical Specification Group working methods".
|
| 220 |
+
- [8] IETF RFC 9113: "HTTP/2".
|
| 221 |
+
- [9] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md>.
|
| 222 |
+
- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
|
| 223 |
+
- [11] IETF RFC 9457: "Problem Details for HTTP APIs".
|
| 224 |
+
- [12] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
|
| 225 |
+
- [13] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
|
| 226 |
+
- [14] 3GPP TS 29.510: "Network Function Repository Services; Stage 3".
|
| 227 |
+
- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
|
| 228 |
+
- [16] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3".
|
| 229 |
+
|
| 230 |
+
# --- 3 Definitions of terms, symbols and abbreviations
|
| 231 |
+
|
| 232 |
+
## 3.1 Terms
|
| 233 |
+
|
| 234 |
+
For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
|
| 235 |
+
|
| 236 |
+
For the purposes of the present document, the terms and definitions given in 3GPP TS 23.256 [6] shall apply.
|
| 237 |
+
|
| 238 |
+
## 3.2 Symbols
|
| 239 |
+
|
| 240 |
+
For the purposes of the present document, the following symbols apply:
|
| 241 |
+
|
| 242 |
+
## 3.3 Abbreviations
|
| 243 |
+
|
| 244 |
+
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
|
| 245 |
+
|
| 246 |
+
| | |
|
| 247 |
+
|-------|-------------------------------------------|
|
| 248 |
+
| AA | Authorization/Authentication |
|
| 249 |
+
| BRID | Broadcast Remote Identification |
|
| 250 |
+
| BVLOS | Beyond Visual Line of Sight |
|
| 251 |
+
| C2 | Command and Control |
|
| 252 |
+
| NRID | Networked Remote Identification |
|
| 253 |
+
| PEI | Permanent Equipment Identifier |
|
| 254 |
+
| RID | Remote Identification |
|
| 255 |
+
| TPAE | Third Party Authorized Entity |
|
| 256 |
+
| UAS | Uncrewed Aerial System |
|
| 257 |
+
| UAV | Uncrewed Aerial Vehicle |
|
| 258 |
+
| USS | UAS Service Supplier |
|
| 259 |
+
| UTM | Uncrewed Aerial System Traffic Management |
|
| 260 |
+
| UUAA | USS UAV AA |
|
| 261 |
+
| UUID | Universal Unique Identifier |
|
| 262 |
+
|
| 263 |
+
# --- 4 Overview
|
| 264 |
+
|
| 265 |
+
## 4.1 Introduction
|
| 266 |
+
|
| 267 |
+
Within the 5GC, the NEF (UAS-NF) offers services to the AMF, SMF, and PCF via the Nnef service based interface, and the NEF (UAS-NF) offers services to the SMF+PGW-C via the Nnef service based interface for UUAA-SM and C2 procedure supported in EPS (see 3GPP TS 23.256 [6]).
|
| 268 |
+
|
| 269 |
+
Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the NEF (UAS-NF) and the scope of the present specification.
|
| 270 |
+
|
| 271 |
+

|
| 272 |
+
|
| 273 |
+
Figure 4.1-1: Reference model – NEF (UAS-NF). The diagram shows four network functions (AMF, SMF, PCF, and AF) on the left connected to a central NEF (UAS-NF) on the right. The connections are labeled N51 (AMF to NEF), N29 (SMF to NEF), N30 (PCF to NEF), and N33 (AF to NEF). The NEF (UAS-NF) is represented by a large green rectangle containing a smaller green rectangle labeled UAS-NF. The label 'Nnef' is placed between the central connection point and the NEF (UAS-NF) block.
|
| 274 |
+
|
| 275 |
+
Figure 4.1-1: Reference model – NEF (UAS-NF)
|
| 276 |
+
|
| 277 |
+
The functionalities supported by the NEF (UAS-NF) are listed in clause 4.3.2 of 3GPP TS 23.256 [6].
|
| 278 |
+
|
| 279 |
+
# 5 Services offered by the NEF (UAS-NF)
|
| 280 |
+
|
| 281 |
+
## 5.1 Introduction
|
| 282 |
+
|
| 283 |
+
The table 5.1-1 shows the NEF (UAS-NF) Services and Service Operations:
|
| 284 |
+
|
| 285 |
+
Table 5.1-1 List of NEF (UAS-NF) Services
|
| 286 |
+
|
| 287 |
+
| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | Mapped Service Operation |
|
| 288 |
+
|---------------------|-----------------------|---------------------|---------------------|-------------------------------------------|
|
| 289 |
+
| Nnef_Authentication | AuthenticateAuthorize | Request/Response | AMF, SMF, SMF+PGW-C | Nnef_Authentication_AuthenticateAuthorize |
|
| 290 |
+
| | Notification | Subscribe/Notify | AMF, SMF, SMF+PGW-C | Nnef_Authentication_Notification |
|
| 291 |
+
|
| 292 |
+
## 5.2 Nnef\_Authentication Service
|
| 293 |
+
|
| 294 |
+
### 5.2.1 Service Description
|
| 295 |
+
|
| 296 |
+
The service allows communication of authentication and authorization messages between AMF/SMF and external AF (USS). An NF as service consumer (e.g. AMF, SMF, SMF+PGW-C) can authenticate or subscribe to receive notifications from NEF (UAS-NF) related to reauthentication, update authorization data or revoke authorization of the UAV.
|
| 297 |
+
|
| 298 |
+
### 5.2.2 Service Operations
|
| 299 |
+
|
| 300 |
+
#### 5.2.2.1 Introduction
|
| 301 |
+
|
| 302 |
+
The Nnef\_Authentication service supports following service operations:
|
| 303 |
+
|
| 304 |
+
- AuthenticateAuthorize
|
| 305 |
+
- Notification
|
| 306 |
+
|
| 307 |
+
#### 5.2.2.2 AuthenticateAuthorize Service Operation
|
| 308 |
+
|
| 309 |
+
##### 5.2.2.2.1 General
|
| 310 |
+
|
| 311 |
+
The AuthenticateAuthorize service operation is used during the following procedure:
|
| 312 |
+
|
| 313 |
+
- UUAA-MM and UUAA-SM procedures (see 3GPP TS 23.256 [6], clause 5.2.2 and clause 5.2.3, respectively)
|
| 314 |
+
- C2 authorization (see 3GPP TS 23.256 [6], clause 5.2.5 and clause 5.4)
|
| 315 |
+
|
| 316 |
+
The AuthenticateAuthorize service operation is invoked by an NF Service Consumer (e.g. an AMF, SMF, SMF+PGW-C) towards the NEF (UAS-NF), when UUAA-MM is done at 5GS registration, UUAA-SM is done at PDU session establishment, or for Authorization for C2 in 5GS or EPS.
|
| 317 |
+
|
| 318 |
+
The NF Service Consumer (e.g. the AMF or the SMF or the SMF+PGW-C) shall send the authentication message to NEF (UAS-NF) by sending the HTTP POST request towards the UAV Authentications resource as shown in Figure 5.2.2.2.1-1.
|
| 319 |
+
|
| 320 |
+

|
| 321 |
+
|
| 322 |
+
```
|
| 323 |
+
|
| 324 |
+
sequenceDiagram
|
| 325 |
+
participant NF Service Consumer
|
| 326 |
+
participant NEF (UAS-NF)
|
| 327 |
+
Note left of NF Service Consumer: 1. POST .../uav-authentications (UAVAuthInfo)
|
| 328 |
+
NF Service Consumer->>NEF (UAS-NF): Request
|
| 329 |
+
Note right of NEF (UAS-NF): 2a. 200 OK (UAVAuthResponse)
|
| 330 |
+
NEF (UAS-NF)-->>NF Service Consumer: Response
|
| 331 |
+
Note right of NEF (UAS-NF): 2b. 4xx/5xx (ProblemDetails) or 3xx
|
| 332 |
+
NEF (UAS-NF)-->>NF Service Consumer: Error/Redirect
|
| 333 |
+
|
| 334 |
+
```
|
| 335 |
+
|
| 336 |
+
Sequence diagram showing the AuthenticateAuthorize Service Operation. An NF Service Consumer sends a POST request to the NEF (UAS-NF). The NEF responds with either a 200 OK (UAVAuthResponse) or a 4xx/5xx (ProblemDetails) or 3xx status.
|
| 337 |
+
|
| 338 |
+
**Figure 5.2.2.2.1-1: AuthenticateAuthorize Service Operation**
|
| 339 |
+
|
| 340 |
+
- The NF Service Consumer shall send a POST request to the resource representing the UAV Authentications resource of the NEF (UAS-NF) with a "UAVAuthInfo" object in the request body, including:
|
| 341 |
+
- gsi IE set to GPSI (in the format of External Identifier) of the UAV;
|
| 342 |
+
- serviceLevelId IE set to Service Level Device Identity;
|
| 343 |
+
- authMsg IE contains the service-level AA message
|
| 344 |
+
- . This IE is deprecated; the "authContainer" IE should be used instead.
|
| 345 |
+
- "authContainer" IE that contains one or more authentication message(s) in the AA container provided by the UE (see 3GPP TS 23.256 [6]). This IE deprecates the "authMsg" IE.
|
| 346 |
+
- authNotificationURI IE provides the notification URI to receive notifications related to authentication;
|
| 347 |
+
- authServerAddress IE provides the Authorization Server Address, e.g. Authorization Server FQDN. This IE is not included for intermediate round-trip authentication messages;
|
| 348 |
+
- nfType IE carries the NF type of the NF service consumer (e.g. AMF or SMF or SMF+PGW-C); and
|
| 349 |
+
- userLocInfo IE provides the user location information (e.g. cell Id).
|
| 350 |
+
|
| 351 |
+
If the NF Service Consumer is SMF or SMF+PGW-C, the "UAVAuthInfo" also may include:
|
| 352 |
+
|
| 353 |
+
- ipAddr IE carries the IP Address associated with the PDU session;
|
| 354 |
+
- pei IE carries the PEI;
|
| 355 |
+
|
| 356 |
+
If the NF Service Consumer is SMF or SMF+PGW-C, for UUAA-MM and UUAA-SM procedures the "UAVAuthInfo" also may include:
|
| 357 |
+
|
| 358 |
+
- dnn IE carries the DNN which can be used by NEF (UAS-NF) later on to create a subscription at SMF; and
|
| 359 |
+
- sNssai IE carries the S-NSSAI which can be used by NEF (UAS-NF) later on to create a subscription at SMF.
|
| 360 |
+
|
| 361 |
+
2a. On success, the NEF (UAS-NF) shall store the result and return "200 OK".
|
| 362 |
+
|
| 363 |
+
For intermediate round-trip messages, the content (i.e. UAVAuthResponse) shall contain the GPSI of the UAV and Service Level Device Identity. The content optionally includes "authContainer", see 3GPP TS 23.256 [6] for further details.
|
| 364 |
+
|
| 365 |
+
For the final NEF (UAS-NF) to NF service consumer message, the content (i.e. UAVAuthResponse) shall contain the GPSI of the UAV, notifyCorrId attribute and "authResult" attribute. If the UAV is authenticated successfully, the NEF (UAS-NF) shall set the "authResult" attribute to "AUTH\_SUCCESS". "authMsg" and "authResult" attributes are deprecated; the attribute "authContainer" should be used instead. The content shall contain the authorized Service Level Device Identity and "authContainer" content delivering the AA result, configuration information to the UAV. The AMF forwards the message transparently to UE over NAS MM.
|
| 366 |
+
|
| 367 |
+
2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.7.3-1.
|
| 368 |
+
|
| 369 |
+
If the NEF (UAS-NF) cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NEF (UAS-NF) shall send the HTTP error response as specified in clause 6.1.7.
|
| 370 |
+
|
| 371 |
+
If the UAV authentication is failed, the NEF (UAS-NF) shall reject the request with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION\_FAILURE". NEF (UAS-NF) shall also include an indication of uasResourceRelease received from the USS to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure, when the service operation is used during Re-authentication procedure.
|
| 372 |
+
|
| 373 |
+
In above steps, while there is no expected response from the USS in the case of time out, the NEF(UAS-NF) shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "PEER\_NOT\_RESPONDING".
|
| 374 |
+
|
| 375 |
+
#### 5.2.2.3 AuthNotify Service Operation
|
| 376 |
+
|
| 377 |
+
##### 5.2.2.3.1 General
|
| 378 |
+
|
| 379 |
+
The AuthNotify service operation is used during the following procedure:
|
| 380 |
+
|
| 381 |
+
- USS Initiated reauthentication (see 3GPP TS 23.256 [6], clause 5.2.4)
|
| 382 |
+
- USS Initiated update authorization data or revoke authorization of the UAV
|
| 383 |
+
|
| 384 |
+
The AuthNotify service operation is invoked by the NEF (UAS-NF) to inform a NF Service Consumer (e.g. AMF, SMF, SMF+PGW-C), when USS triggers reauthentication, update authorization data or revoke authorization of the UAV. NEF (UAS-NF) shall determine the NF service consumer based on the previously stored UUAA context during the successful UUAA procedure as defined in clause 5.2.2.2.
|
| 385 |
+
|
| 386 |
+
The NEF (UAS-NF) shall send the AuthNotify request by sending the HTTP POST method towards the Notification URI as shown in Figure 5.2.2.3.1-1.
|
| 387 |
+
|
| 388 |
+

|
| 389 |
+
|
| 390 |
+
```
|
| 391 |
+
|
| 392 |
+
sequenceDiagram
|
| 393 |
+
participant NEF as NEF(UAS-NF)
|
| 394 |
+
participant Consumer as NF Service Consumer
|
| 395 |
+
Note left of Consumer:
|
| 396 |
+
Note right of NEF:
|
| 397 |
+
NEF->>Consumer: 1. POST {notificationUri} (AuthNotification)
|
| 398 |
+
Consumer-->>NEF: 2a. 204 No content
|
| 399 |
+
Consumer-->>NEF: 2b. 4xx/5xx (ProblemDetails) or 3xx
|
| 400 |
+
|
| 401 |
+
```
|
| 402 |
+
|
| 403 |
+
Sequence diagram for AuthNotify Service Operation. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NEF(UAS-NF)' on the right. The sequence of messages is: 1. A solid arrow points from NEF(UAS-NF) to NF Service Consumer with the text '1. POST {notificationUri} (AuthNotification)'. 2a. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2a. 204 No content'. 2b. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2b. 4xx/5xx (ProblemDetails) or 3xx'.
|
| 404 |
+
|
| 405 |
+
Figure 5.2.2.3.1-1: AuthNotify Service Operation
|
| 406 |
+
|
| 407 |
+
1. The NEF (UAS-NF) shall send a POST request towards the Notification URI received in the Authenticate service operation request (See clause 5.2.2.2.1). If the AMF for UUAA-MM has changed, the NEF (UAS-NF)
|
| 408 |
+
|
| 409 |
+
should discover the Notification URI of the new AMF via NRF (in the default notification subscription with the "UUAA\_MM\_AUTH\_NOTIFICATION" notification type). The NEF (UAS-NF) shall be able to determine the NF type of the NF service consumer by nfType IE received in the Authenticate service operation request. The request body shall contain an "AuthNotification" object containing the reauthentication information or update authorization information or revoke authorization indication.
|
| 410 |
+
|
| 411 |
+
When the procedure is used for reauthentication or reauthorization/update authorization information, the AuthNotification object includes:
|
| 412 |
+
|
| 413 |
+
- the gpsi IE set to the GPSI (in the format of External Identifier) of the given UAV required to be reauthenticated;
|
| 414 |
+
- serviceLevelId IE set to the Service Level Device Identity of the UAV;
|
| 415 |
+
- authMsg IE contains the service-level AA message. This IE is deprecated; the "authContainer" IE should be used instead.
|
| 416 |
+
- "authContainer" IE that contains AA related data provided by the UE (see 3GPP TS 23.256 [6]). This IE deprecates the "authMsg" IE.
|
| 417 |
+
- notifyType IE set to REAUTH used for reauthentication and/or notifyType IE set to UPDATEAUTH used for update authorization data; and
|
| 418 |
+
- notifyCorrId IE set to the notification correlation ID;
|
| 419 |
+
|
| 420 |
+
When the procedure is used for authorization revocation, the AuthNotification object includes:
|
| 421 |
+
|
| 422 |
+
- the gpsi IE set to the GPSI (in the format of External Identifier) of the given UAV;
|
| 423 |
+
- serviceLevelId IE set to the Service Level Device Identity of the UAV;
|
| 424 |
+
- notifyType IE set to REVOKE; and
|
| 425 |
+
- notifyCorrId IE set to the notification correlation ID;
|
| 426 |
+
|
| 427 |
+
2a. On success, "204 No content" shall be returned without response body. If the NF Service consumer remove the successful UUAA result during UUAA Revocation procedure, the NEF (UAS-NF) shall remove the UUAA context (see clause 5.2.7 of 3GPP TS 23.256 [6]).
|
| 428 |
+
|
| 429 |
+
2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the response body should contain a "ProblemDetails" object.
|
| 430 |
+
|
| 431 |
+
If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 6.1.7.
|
| 432 |
+
|
| 433 |
+
# --- 6 API Definitions
|
| 434 |
+
|
| 435 |
+
## 6.1 Nnef\_Authentication Service API
|
| 436 |
+
|
| 437 |
+
### 6.1.1 Introduction
|
| 438 |
+
|
| 439 |
+
The Nnef\_Authentication shall use the Nnef\_Authentication API.
|
| 440 |
+
|
| 441 |
+
The API URI of the Nnef\_Authentication API shall be:
|
| 442 |
+
|
| 443 |
+
**{apiRoot}</apiName></apiVersion>**
|
| 444 |
+
|
| 445 |
+
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
|
| 446 |
+
|
| 447 |
+
**{apiRoot}</apiName></apiVersion></apiSpecificResourceUriPart>**
|
| 448 |
+
|
| 449 |
+
with the following components:
|
| 450 |
+
|
| 451 |
+
- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
|
| 452 |
+
- The <apiName> shall be "nnef-authentication".
|
| 453 |
+
- The <apiVersion> shall be "v1".
|
| 454 |
+
- The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
|
| 455 |
+
|
| 456 |
+
### 6.1.2 Usage of HTTP
|
| 457 |
+
|
| 458 |
+
#### 6.1.2.1 General
|
| 459 |
+
|
| 460 |
+
HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
|
| 461 |
+
|
| 462 |
+
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
|
| 463 |
+
|
| 464 |
+
The OpenAPI [9] specification of HTTP messages and content bodies for the Nnef\_Authentication API is contained in Annex A.
|
| 465 |
+
|
| 466 |
+
#### 6.1.2.2 HTTP standard headers
|
| 467 |
+
|
| 468 |
+
##### 6.1.2.2.1 General
|
| 469 |
+
|
| 470 |
+
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
|
| 471 |
+
|
| 472 |
+
##### 6.1.2.2.2 Content type
|
| 473 |
+
|
| 474 |
+
JSON, IETF RFC 8259 [10], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
|
| 475 |
+
|
| 476 |
+
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [11].
|
| 477 |
+
|
| 478 |
+
#### 6.1.2.3 HTTP custom headers
|
| 479 |
+
|
| 480 |
+
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable.
|
| 481 |
+
|
| 482 |
+
### 6.1.3 Resources
|
| 483 |
+
|
| 484 |
+
#### 6.1.3.1 Overview
|
| 485 |
+
|
| 486 |
+
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
|
| 487 |
+
|
| 488 |
+
Figure 6.1.3.1-1 depicts the resource URIs structure for the Nnef\_Authentication API.
|
| 489 |
+
|
| 490 |
+

|
| 491 |
+
|
| 492 |
+
```
|
| 493 |
+
graph TD; Root["{apiRoot}/nnef-authentication/<apiVersion>"] --> Box["/uav-authentications"];
|
| 494 |
+
```
|
| 495 |
+
|
| 496 |
+
Diagram showing the resource URI structure for the Nnef\_Authentication API. The root path is {apiRoot}/nnef-authentication/. A line branches from this root to a box containing the resource URI part /uav-authentications.
|
| 497 |
+
|
| 498 |
+
**Figure 6.1.3.1-1: Resource URI structure of the Nnef\_Authentication API**
|
| 499 |
+
|
| 500 |
+
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
|
| 501 |
+
|
| 502 |
+
**Table 6.1.3.1-1: Resources and methods overview**
|
| 503 |
+
|
| 504 |
+
| Resource name | Resource URI | HTTP method or custom operation | Description |
|
| 505 |
+
|---------------------|----------------------|---------------------------------|----------------------|
|
| 506 |
+
| uav-authentications | /uav-authentications | POST | A UAV authentication |
|
| 507 |
+
|
| 508 |
+
#### 6.1.3.2 Resource: uav-authentications
|
| 509 |
+
|
| 510 |
+
The resource represents UAV Authentications to be done with the NEF (UAS-NF).
|
| 511 |
+
|
| 512 |
+
##### 6.1.3.2.1 Description
|
| 513 |
+
|
| 514 |
+
##### 6.1.3.2.2 Resource Definition
|
| 515 |
+
|
| 516 |
+
Resource URI: {apiRoot}/nnef-authentication/<apiVersion>/uav-authentications
|
| 517 |
+
|
| 518 |
+
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
|
| 519 |
+
|
| 520 |
+
**Table 6.1.3.2.2-1: Resource URI variables for this resource**
|
| 521 |
+
|
| 522 |
+
| Name | Data type | Definition |
|
| 523 |
+
|---------|-----------|------------------|
|
| 524 |
+
| apiRoot | string | See clause 6.1.1 |
|
| 525 |
+
|
| 526 |
+
##### 6.1.3.2.3 Resource Standard Methods
|
| 527 |
+
|
| 528 |
+
###### 6.1.3.2.3.1 POST
|
| 529 |
+
|
| 530 |
+
This method performs UAV authentication.
|
| 531 |
+
|
| 532 |
+
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
|
| 533 |
+
|
| 534 |
+
**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource**
|
| 535 |
+
|
| 536 |
+
| Name | Data type | P | Cardinality | Description | Applicability |
|
| 537 |
+
|------|-----------|---|-------------|-------------|---------------|
|
| 538 |
+
| n/a | | | | | |
|
| 539 |
+
|
| 540 |
+
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
|
| 541 |
+
|
| 542 |
+
**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource**
|
| 543 |
+
|
| 544 |
+
| Data type | P | Cardinality | Description |
|
| 545 |
+
|-------------|---|-------------|-------------------------------------------------------|
|
| 546 |
+
| UAVAuthInfo | M | 1 | Represents the data to be used for UAV authentication |
|
| 547 |
+
|
| 548 |
+
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
| 549 |
+
|
| 550 |
+
| Data type | P | Cardinality | Response codes | Description |
|
| 551 |
+
|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 552 |
+
| UAVAuthResponse | M | 1 | 200 OK | Successful request of UAV authentication and authorization. If C2 authorization request is sent during UUAA-SM, the final response indicates that at least UUAA has succeeded. |
|
| 553 |
+
| RedirectResponse | O | 0..1 | 307<br>Temporary Redirect | Temporary redirection.<br>(NOTE 2) |
|
| 554 |
+
| RedirectResponse | O | 0..1 | 308<br>Permanent Redirect | Permanent redirection.<br>(NOTE 2) |
|
| 555 |
+
| UAVAuthFailure | O | 0..1 | 403<br>Forbidden | This represents that the UAV authentication is failed, the "cause" attribute of the ProblemDetails data structure set to one of the following application errors:<br>- AUTHENTICATION_FAILURE<br>- SERVICE_NOT_ALLOWED<br>See table 6.1.7.3-1 for the description of these errors. |
|
| 556 |
+
| ProblemDetails | O | 0..1 | 504<br>Gateway Timeout | The "cause" attribute may be used to indicate the following application error:<br>- PEER_NOT_RESPONDING<br>See table 6.1.7.3-1 for the description of the error. |
|
| 557 |
+
|
| 558 |
+
NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.
|
| 559 |
+
|
| 560 |
+
NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
| 561 |
+
|
| 562 |
+
Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource
|
| 563 |
+
|
| 564 |
+
| Name | Data type | P | Cardinality | Description |
|
| 565 |
+
|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 566 |
+
| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or NEF (UAS-NF) (service) set.<br>For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
|
| 567 |
+
| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected |
|
| 568 |
+
|
| 569 |
+
Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource
|
| 570 |
+
|
| 571 |
+
| Name | Data type | P | Cardinality | Description |
|
| 572 |
+
|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 573 |
+
| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or UAS-NF/NEF (service) set.<br>For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
|
| 574 |
+
| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected |
|
| 575 |
+
|
| 576 |
+
##### 6.1.3.2.4 Resource Custom Operations
|
| 577 |
+
|
| 578 |
+
None
|
| 579 |
+
|
| 580 |
+
### 6.1.5 Notifications
|
| 581 |
+
|
| 582 |
+
#### 6.1.5.1 General
|
| 583 |
+
|
| 584 |
+
This clause specifies the notifications provided by the Nnef\_Authentication service.
|
| 585 |
+
|
| 586 |
+
Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
|
| 587 |
+
|
| 588 |
+
#### 6.1.5.2 Authentication Notification
|
| 589 |
+
|
| 590 |
+
##### 6.1.5.2.1 Description
|
| 591 |
+
|
| 592 |
+
The NF Service Consumer (e.g. the AMF or SMF or SMF+PGW-C) provides the Notification URI for getting notified about reauthentication requested by the USS. The NEF (UAS-NF) shall notify the NF Service Consumer when reauthentication is requested by the USS.
|
| 593 |
+
|
| 594 |
+
##### 6.1.5.2.2 Target URI
|
| 595 |
+
|
| 596 |
+
The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1.
|
| 597 |
+
|
| 598 |
+
**Table 6.1.5.2.2-1: Callback URI variables**
|
| 599 |
+
|
| 600 |
+
| Name | Definition |
|
| 601 |
+
|-----------------|-----------------------------------------------|
|
| 602 |
+
| notificationUri | String formatted as URI with the Callback Uri |
|
| 603 |
+
|
| 604 |
+
##### 6.1.5.2.3 Standard Methods
|
| 605 |
+
|
| 606 |
+
###### 6.1.5.2.3.1 POST
|
| 607 |
+
|
| 608 |
+
This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2.
|
| 609 |
+
|
| 610 |
+
**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body**
|
| 611 |
+
|
| 612 |
+
| Data type | P | Cardinality | Description |
|
| 613 |
+
|------------------|---|-------------|--------------------------------------------|
|
| 614 |
+
| AuthNotification | M | 1 | Contains the reauthentication information. |
|
| 615 |
+
|
| 616 |
+
**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body**
|
| 617 |
+
|
| 618 |
+
| Data type | P | Cardinality | Response codes | Description |
|
| 619 |
+
|------------------|---|-------------|------------------------|---------------------------------------------|
|
| 620 |
+
| n/a | | | 204 No Content | Successful notification of reauthentication |
|
| 621 |
+
| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.<br>(NOTE 2) |
|
| 622 |
+
| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.<br>(NOTE 2) |
|
| 623 |
+
|
| 624 |
+
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).
|
| 625 |
+
|
| 626 |
+
NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
| 627 |
+
|
| 628 |
+
**Table 6.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource**
|
| 629 |
+
|
| 630 |
+
| Name | Data type | P | Cardinality | Description |
|
| 631 |
+
|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 632 |
+
| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
|
| 633 |
+
| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected. |
|
| 634 |
+
|
| 635 |
+
**Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource**
|
| 636 |
+
|
| 637 |
+
| Name | Data type | P | Cardinality | Description |
|
| 638 |
+
|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 639 |
+
| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
|
| 640 |
+
| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected. |
|
| 641 |
+
|
| 642 |
+
### 6.1.6 Data Model
|
| 643 |
+
|
| 644 |
+
#### 6.1.6.1 General
|
| 645 |
+
|
| 646 |
+
This clause specifies the application data model supported by the API.
|
| 647 |
+
|
| 648 |
+
Table 6.1.6.1-1 specifies the data types defined for the Nnef\_Authentication service based interface protocol.
|
| 649 |
+
|
| 650 |
+
**Table 6.1.6.1-1: Nnef\_Authentication specific Data Types**
|
| 651 |
+
|
| 652 |
+
| Data type | Clause defined | Description | Applicability |
|
| 653 |
+
|------------------|----------------|----------------------------------------------|---------------|
|
| 654 |
+
| UAVAuthInfo | 6.1.6.2.2 | Information within Authenticate Request | |
|
| 655 |
+
| AuthNotification | 6.1.6.2.3 | Information within notification | |
|
| 656 |
+
| UAVAuthResponse | 6.1.6.2.4 | Information within Authenticate Response | |
|
| 657 |
+
| UAVAuthFailure | 6.1.6.2.5 | Information within Authenticate Response | |
|
| 658 |
+
| AuthResult | 6.1.6.3.3 | Enumeration indicating authentication result | |
|
| 659 |
+
| NotifyType | 6.1.6.3.4 | Enumeration Notification type | |
|
| 660 |
+
| AuthContainer | 6.1.6.2.6 | Carries the AA related data | |
|
| 661 |
+
|
| 662 |
+
Table 6.1.6.1-2 specifies data types re-used by the Nnef\_Authentication service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_Authentication service based interface.
|
| 663 |
+
|
| 664 |
+
**Table 6.1.6.1-2: Nnef\_Authentication re-used Data Types**
|
| 665 |
+
|
| 666 |
+
| Data type | Reference | Comments | Applicability |
|
| 667 |
+
|------------------|---------------------|--------------------------------------------------|---------------|
|
| 668 |
+
| IpAddr | 3GPP TS 29.571 [15] | IP address | |
|
| 669 |
+
| Pei | 3GPP TS 29.571 [15] | Permanent Equipment Identifier | |
|
| 670 |
+
| Uri | 3GPP TS 29.571 [15] | Uri | |
|
| 671 |
+
| Gpsi | 3GPP TS 29.571 [15] | GPSI | |
|
| 672 |
+
| ExtSnssai | 3GPP TS 29.571 [15] | Ext Snssai | |
|
| 673 |
+
| Dnn | 3GPP TS 29.571 [15] | DNN information | |
|
| 674 |
+
| UserLocation | 3GPP TS 29.571 [15] | User location | |
|
| 675 |
+
| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information | |
|
| 676 |
+
| NFType | 3GPP TS 29.510 [14] | NF Type | |
|
| 677 |
+
| ReftoBinaryData | 3GPP TS 29.571 [15] | authMsg data, AA message payload data | |
|
| 678 |
+
| Bytes | 3GPP TS 29.571 [15] | Binary data encoded as a base64 character string | |
|
| 679 |
+
|
| 680 |
+
#### 6.1.6.2 Structured data types
|
| 681 |
+
|
| 682 |
+
##### 6.1.6.2.1 Introduction
|
| 683 |
+
|
| 684 |
+
This clause defines the structures to be used in resource representations.
|
| 685 |
+
|
| 686 |
+
##### 6.1.6.2.2 Type: UAVAuthInfo
|
| 687 |
+
|
| 688 |
+
Table 6.1.6.2.2-1: Definition of type UAVAuthInfo
|
| 689 |
+
|
| 690 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 691 |
+
|---------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 692 |
+
| gpsi | Gpsi | M | 1 | GPSI of the UAV | |
|
| 693 |
+
| serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | |
|
| 694 |
+
| ipAddr | IpAddr | O | 0..1 | This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.<br><br>When present, this IE indicates the IP address associated with the PDU session. | |
|
| 695 |
+
| authMsg | RefToBinaryData | O | 0..1 | Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
|
| 696 |
+
| authContainer | array(AuthContainer) | O | 1..N | Contains the AA related data without the "authResult" attribute. This attribute deprecates "authMsg" attribute. | |
|
| 697 |
+
| pei | Pei | O | 0..1 | This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.<br><br>When present, PEI associated with the UAV. | |
|
| 698 |
+
| authServerAddress | string | O | 0..1 | Provides the Authorization Server Address, e.g. Authorization Server FQDN. | |
|
| 699 |
+
| authNotificationURI | Uri | C | 0..1 | This IE shall be present in the initial authentication message.<br><br>It carries the notification URI to receive authentication related notifications | |
|
| 700 |
+
| dnn | Dnn | C | 0..1 | This IE shall be present if the NF Service Consumer is the SMF or SMF+PGW-C.<br><br>When present, this IE indicates DNN associated with the PDU session. | |
|
| 701 |
+
| sNssai | ExtSnsai | C | 0..1 | This IE shall be present if the NF Service Consumer is the SMF.<br><br>When present, this IE indicates the S-NSSAI associated with the PDU session. | |
|
| 702 |
+
| ueLocInfo | UserLocation | O | 0..1 | This IE shall contain the UE location information if it is available. | |
|
| 703 |
+
| nfType | NFType | M | 1 | NFType of the NF service consumer.<br>Possible NFType values supported in this release of the specification are <ul style="list-style-type: none"> <li>- AMF</li> <li>- SMF</li> </ul> | |
|
| 704 |
+
|
| 705 |
+
##### 6.1.6.2.3 Type: AuthNotification
|
| 706 |
+
|
| 707 |
+
Table 6.1.6.2.3-1: Definition of type AuthNotification
|
| 708 |
+
|
| 709 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 710 |
+
|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 711 |
+
| gpsi | Gpsi | M | 1 | GPSI of the UAV | |
|
| 712 |
+
| serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | |
|
| 713 |
+
| authMsg | RefToBinaryData | C | 0..1 | Contains the service-level AA message.<br>This IE may be present if the notifType is set to "UPDATEAUTH". This attribute is deprecated; the attribute "authContainer" should be used instead. | |
|
| 714 |
+
| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data, including optionally the "authResult" attribute. This IE shall be present if the notifType is set to "UPDATEAUTH". This attribute deprecates "authMsg" attribute. | |
|
| 715 |
+
| notifType | NotifType | M | 1 | This IE shall contain the notification type. | |
|
| 716 |
+
| notifyCorrId | string | M | 1 | This IE shall contain the Notification Correlation Id. | |
|
| 717 |
+
|
| 718 |
+
##### 6.1.6.2.4 Type: UAVAuthResponse
|
| 719 |
+
|
| 720 |
+
Table 6.1.6.2.4-1: Definition of type UAVAuthResponse
|
| 721 |
+
|
| 722 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 723 |
+
|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 724 |
+
| gpsi | Gpsi | M | 1 | GPSI of the UAV | |
|
| 725 |
+
| authResult | AuthResult | C | 0..1 | This IE shall be present for the final NEF (UAS-NF) to NF service consumer message.<br><br>Conveys the UAV authentication result. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
|
| 726 |
+
| authMsg | RefToBinaryData | O | 0..1 | Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead. | |
|
| 727 |
+
| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data, including the "authResult" attribute in the final AA response. This attribute shall be present for the final AA response message. This attribute deprecates "authMsg" attribute. | |
|
| 728 |
+
| serviceLevelId | string | O | 0..1 | This IE contains the authorized Service Level Device Identity | |
|
| 729 |
+
| notifyCorrId | string | O | 0..1 | When present, this IE shall contain the Notification Correlation Id. | |
|
| 730 |
+
|
| 731 |
+
##### 6.1.6.2.5 Type: UAVAuthFailure
|
| 732 |
+
|
| 733 |
+
Table 6.1.6.2.5-1: Definition of type UAVAuthFailure
|
| 734 |
+
|
| 735 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 736 |
+
|--------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 737 |
+
| error | ProblemDetails | M | 1 | Represents the application error information. The application level error cause shall be encoded in the "cause" attribute. | |
|
| 738 |
+
| uasResourceRelease | boolean | C | 0..1 | <p>This IE shall be present and used to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure.</p> <p>It shall be included if the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION_FAILURE".</p> <p>When present, it shall be set as follows:<br/> - true: the PDU sessions associated with the "DNN(s) subject to aerial services" release is requested;<br/> - false (default): the PDU sessions associated with the "DNN(s) subject to aerial services" release is not requested.</p> | |
|
| 739 |
+
|
| 740 |
+
##### 6.1.6.2.6 Type: AuthContainer
|
| 741 |
+
|
| 742 |
+
Table 6.1.6.2.6-1: Definition of type AuthContainer
|
| 743 |
+
|
| 744 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 745 |
+
|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 746 |
+
| authMsgType | Bytes | O | 0..1 | This IE, when present, carries the Service-level-AA payload type specified in clause 9.11.2.15 of 3GPP TS 24.501 [16]. | |
|
| 747 |
+
| authMsgPayload | RefToBinaryData | O | 0..1 | AA message payload data. | |
|
| 748 |
+
| authResult | AuthResult | C | 0..1 | Shall be present for the final AA response conveying the AA result. | |
|
| 749 |
+
|
| 750 |
+
#### 6.1.6.3 Simple data types and enumerations
|
| 751 |
+
|
| 752 |
+
##### 6.1.6.3.1 Introduction
|
| 753 |
+
|
| 754 |
+
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
|
| 755 |
+
|
| 756 |
+
##### 6.1.6.3.2 Simple data types
|
| 757 |
+
|
| 758 |
+
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
|
| 759 |
+
|
| 760 |
+
**Table 6.1.6.3.2-1: Simple data types**
|
| 761 |
+
|
| 762 |
+
| Type Name | Type Definition | Description | Applicability |
|
| 763 |
+
|-----------|-----------------|-------------|---------------|
|
| 764 |
+
| | | | |
|
| 765 |
+
|
| 766 |
+
##### 6.1.6.3.3 Enumeration: AuthResult
|
| 767 |
+
|
| 768 |
+
The enumeration AuthResult represents the result of authentication and/or authorization. It shall comply with the provisions defined in table 6.1.5.3.3-1.
|
| 769 |
+
|
| 770 |
+
**Table 6.1.6.3.3-1: Enumeration AuthResult**
|
| 771 |
+
|
| 772 |
+
| Enumeration value | Description | Applicability |
|
| 773 |
+
|-------------------|-----------------------------------------------------------|---------------|
|
| 774 |
+
| "AUTH_SUCCESS" | The UAV authentication or C2 Authorization has succeeded. | |
|
| 775 |
+
| "AUTH_FAIL" | The UAV authentication or C2 Authorization has failed. | |
|
| 776 |
+
|
| 777 |
+
##### 6.1.6.3.4 Enumeration: NotifType
|
| 778 |
+
|
| 779 |
+
The enumeration NotifType represents the type of notification. It shall comply with the provisions defined in table 6.1.6.3.4-1.
|
| 780 |
+
|
| 781 |
+
**Table 6.1.6.3.4-1: Enumeration NotifType**
|
| 782 |
+
|
| 783 |
+
| Enumeration value | Description | Applicability |
|
| 784 |
+
|-------------------|------------------------------------------------|---------------|
|
| 785 |
+
| "REAUTH" | The UAV needs to be reauthenticated. | |
|
| 786 |
+
| "UPDATEAUTH" | Authorization data needs to be updated to UAV. | |
|
| 787 |
+
| "REVOKE" | Revoke UAV authentication and authorization | |
|
| 788 |
+
|
| 789 |
+
### 6.1.7 Error Handling
|
| 790 |
+
|
| 791 |
+
#### 6.1.7.1 General
|
| 792 |
+
|
| 793 |
+
For the Nnef\_Authentication API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
|
| 794 |
+
|
| 795 |
+
In addition, the requirements in the following clauses are applicable for the Nnef\_Authentication API.
|
| 796 |
+
|
| 797 |
+
#### 6.1.7.2 Protocol Errors
|
| 798 |
+
|
| 799 |
+
No specific procedures for the Nnef\_Authentication service are specified.
|
| 800 |
+
|
| 801 |
+
#### 6.1.7.3 Application Errors
|
| 802 |
+
|
| 803 |
+
The application errors defined for the Nnef\_Authentication service are listed in Table 6.1.7.3-1.
|
| 804 |
+
|
| 805 |
+
**Table 6.1.7.3-1: Application errors**
|
| 806 |
+
|
| 807 |
+
| Application Error | HTTP status code | Description |
|
| 808 |
+
|------------------------|---------------------|------------------------------------------------------------------------|
|
| 809 |
+
| AUTHENTICATION_FAILURE | 403 Forbidden | The UAV authentication is failed |
|
| 810 |
+
| SERVICE_NOT_ALLOWED | 403 Forbidden | UAS services not allowed |
|
| 811 |
+
| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from the remote peer (i.e. USS) when time out. |
|
| 812 |
+
|
| 813 |
+
### 6.1.8 Feature negotiation
|
| 814 |
+
|
| 815 |
+
The optional features in table 6.1.8-1 are defined for the Nnef\_Authentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
|
| 816 |
+
|
| 817 |
+
**Table 6.1.8-1: Supported Features**
|
| 818 |
+
|
| 819 |
+
| Feature number | Feature Name | Description |
|
| 820 |
+
|----------------|--------------|-------------|
|
| 821 |
+
| | | |
|
| 822 |
+
|
| 823 |
+
### 6.1.9 Security
|
| 824 |
+
|
| 825 |
+
As indicated in 3GPP TS 33.501 [12] and 3GPP TS 29.500 [4], the access to the Nnef\_Authentication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [13]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server.
|
| 826 |
+
|
| 827 |
+
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_Authentication API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2.
|
| 828 |
+
|
| 829 |
+
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_Authentication service.
|
| 830 |
+
|
| 831 |
+
The Nnef\_Authentication API defines a single scope "nnef-authentication" for the entire service, and it does not define any additional scopes at resource or operation level.
|
| 832 |
+
|
| 833 |
+
### 6.1.10 HTTP redirection
|
| 834 |
+
|
| 835 |
+
An HTTP request may be redirected to a different Nnef\_Authentication service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]).
|
| 836 |
+
|
| 837 |
+
An SCP that reselects a different NEF (UAS-NF) producer instance will return the NF Instance ID of the new NEF (UAS-NF) producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
|
| 838 |
+
|
| 839 |
+
If an NEF (UAS-NF) redirects a service request to a different NEF (UAS-NF) using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NEF (UAS-NF) towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
| 840 |
+
|
| 841 |
+
# --- Annex A (normative): OpenAPI specification
|
| 842 |
+
|
| 843 |
+
## A.1 General
|
| 844 |
+
|
| 845 |
+
This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format, following guidelines in 3GPP TS 29.501 [5].
|
| 846 |
+
|
| 847 |
+
This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
|
| 848 |
+
|
| 849 |
+
NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
|
| 850 |
+
|
| 851 |
+
Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]).
|
| 852 |
+
|
| 853 |
+
## --- A.2 Nnef\_Authentication API
|
| 854 |
+
|
| 855 |
+
```
|
| 856 |
+
openapi: 3.0.0
|
| 857 |
+
|
| 858 |
+
info:
|
| 859 |
+
title: Nnef_Authentication
|
| 860 |
+
version: '1.0.2'
|
| 861 |
+
description: |
|
| 862 |
+
NEF Auth Service.
|
| 863 |
+
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 864 |
+
All rights reserved.
|
| 865 |
+
|
| 866 |
+
externalDocs:
|
| 867 |
+
description: >
|
| 868 |
+
3GPP TS 29.256 V17.3.0; 5G System;Uncrewed Aerial Systems Network Function (UAS-NF);
|
| 869 |
+
Aerial Management Services; Stage 3
|
| 870 |
+
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.256/
|
| 871 |
+
|
| 872 |
+
servers:
|
| 873 |
+
- url: '{apiRoot}/nnef-authentication/v1'
|
| 874 |
+
variables:
|
| 875 |
+
apiRoot:
|
| 876 |
+
default: https://example.com
|
| 877 |
+
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
|
| 878 |
+
|
| 879 |
+
security:
|
| 880 |
+
- {}
|
| 881 |
+
- oAuth2ClientCredentials:
|
| 882 |
+
- nnef-authentication
|
| 883 |
+
|
| 884 |
+
paths:
|
| 885 |
+
/uav-authentications:
|
| 886 |
+
post:
|
| 887 |
+
summary: UAV authentication
|
| 888 |
+
tags:
|
| 889 |
+
- UAV authentication
|
| 890 |
+
requestBody:
|
| 891 |
+
description: UAV authentication
|
| 892 |
+
required: true
|
| 893 |
+
content:
|
| 894 |
+
application/json:
|
| 895 |
+
schema:
|
| 896 |
+
$ref: '#/components/schemas/UAVAuthInfo'
|
| 897 |
+
responses:
|
| 898 |
+
'200':
|
| 899 |
+
description: UAV Auth response or message exchange
|
| 900 |
+
content:
|
| 901 |
+
application/json:
|
| 902 |
+
schema:
|
| 903 |
+
$ref: '#/components/schemas/UAVAuthResponse'
|
| 904 |
+
'307':
|
| 905 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
|
| 906 |
+
'308':
|
| 907 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
|
| 908 |
+
'400':
|
| 909 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
|
| 910 |
+
'403':
|
| 911 |
+
description: UAV authentication failure
|
| 912 |
+
content:
|
| 913 |
+
application/json:
|
| 914 |
+
schema:
|
| 915 |
+
$ref: '#/components/schemas/UAVAuthFailure'
|
| 916 |
+
```
|
| 917 |
+
|
| 918 |
+
```
|
| 919 |
+
'504':
|
| 920 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/504'
|
| 921 |
+
default:
|
| 922 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
|
| 923 |
+
callbacks:
|
| 924 |
+
authNotification:
|
| 925 |
+
'{request.body#/authNotification }':
|
| 926 |
+
post:
|
| 927 |
+
requestBody:
|
| 928 |
+
required: true
|
| 929 |
+
content:
|
| 930 |
+
application/json:
|
| 931 |
+
schema:
|
| 932 |
+
$ref: '#/components/schemas/AuthNotification'
|
| 933 |
+
responses:
|
| 934 |
+
'204':
|
| 935 |
+
description: Successful Notification response
|
| 936 |
+
'307':
|
| 937 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
|
| 938 |
+
'308':
|
| 939 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
|
| 940 |
+
'400':
|
| 941 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
|
| 942 |
+
default:
|
| 943 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
|
| 944 |
+
|
| 945 |
+
components:
|
| 946 |
+
securitySchemes:
|
| 947 |
+
oAuth2ClientCredentials:
|
| 948 |
+
type: oauth2
|
| 949 |
+
flows:
|
| 950 |
+
clientCredentials:
|
| 951 |
+
tokenUrl: '{nrfApiRoot}/oauth2/token'
|
| 952 |
+
scopes:
|
| 953 |
+
nnef-authentication: Access to the Nnef_authentication API
|
| 954 |
+
|
| 955 |
+
schemas:
|
| 956 |
+
#
|
| 957 |
+
# STRUCTURED DATA TYPES
|
| 958 |
+
#
|
| 959 |
+
UAVAuthInfo:
|
| 960 |
+
description: UAV auth data
|
| 961 |
+
type: object
|
| 962 |
+
required:
|
| 963 |
+
- gps
|
| 964 |
+
- serviceLevelId
|
| 965 |
+
- nfType
|
| 966 |
+
properties:
|
| 967 |
+
gps:
|
| 968 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gps'
|
| 969 |
+
serviceLevelId:
|
| 970 |
+
type: string
|
| 971 |
+
authNotificationURI:
|
| 972 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
|
| 973 |
+
ipAddr:
|
| 974 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
|
| 975 |
+
pei:
|
| 976 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
|
| 977 |
+
authServerAddress:
|
| 978 |
+
type: string
|
| 979 |
+
authMsg:
|
| 980 |
+
allOf:
|
| 981 |
+
- $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
|
| 982 |
+
deprecated: true
|
| 983 |
+
authContainer:
|
| 984 |
+
type: array
|
| 985 |
+
items:
|
| 986 |
+
$ref: '#/components/schemas/AuthContainer'
|
| 987 |
+
minItems: 1
|
| 988 |
+
ueLocInfo:
|
| 989 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
|
| 990 |
+
dnn:
|
| 991 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
|
| 992 |
+
sNssai:
|
| 993 |
+
```
|
| 994 |
+
|
| 995 |
+
```
|
| 996 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
|
| 997 |
+
nfType:
|
| 998 |
+
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
|
| 999 |
+
|
| 1000 |
+
UAVAuthResponse:
|
| 1001 |
+
description: UAV auth response data
|
| 1002 |
+
type: object
|
| 1003 |
+
required:
|
| 1004 |
+
- gpsi
|
| 1005 |
+
properties:
|
| 1006 |
+
gpsi:
|
| 1007 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
|
| 1008 |
+
serviceLevelId:
|
| 1009 |
+
type: string
|
| 1010 |
+
authMsg:
|
| 1011 |
+
allOf:
|
| 1012 |
+
- $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
|
| 1013 |
+
deprecated: true
|
| 1014 |
+
authContainer:
|
| 1015 |
+
type: array
|
| 1016 |
+
items:
|
| 1017 |
+
$ref: '#/components/schemas/AuthContainer'
|
| 1018 |
+
minItems: 1
|
| 1019 |
+
authResult:
|
| 1020 |
+
allOf:
|
| 1021 |
+
- $ref: '#/components/schemas/AuthResult'
|
| 1022 |
+
deprecated: true
|
| 1023 |
+
notifyCorrId:
|
| 1024 |
+
type: string
|
| 1025 |
+
|
| 1026 |
+
AuthNotification:
|
| 1027 |
+
description: UAV related notification
|
| 1028 |
+
type: object
|
| 1029 |
+
required:
|
| 1030 |
+
- gpsi
|
| 1031 |
+
- serviceLevelId
|
| 1032 |
+
- notifyType
|
| 1033 |
+
- notifyCorrId
|
| 1034 |
+
properties:
|
| 1035 |
+
gpsi:
|
| 1036 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
|
| 1037 |
+
serviceLevelId:
|
| 1038 |
+
type: string
|
| 1039 |
+
notifyCorrId:
|
| 1040 |
+
type: string
|
| 1041 |
+
authMsg:
|
| 1042 |
+
allOf:
|
| 1043 |
+
- $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
|
| 1044 |
+
deprecated: true
|
| 1045 |
+
authContainer:
|
| 1046 |
+
type: array
|
| 1047 |
+
items:
|
| 1048 |
+
$ref: '#/components/schemas/AuthContainer'
|
| 1049 |
+
minItems: 1
|
| 1050 |
+
notifyType:
|
| 1051 |
+
$ref: '#/components/schemas/NotifyType'
|
| 1052 |
+
|
| 1053 |
+
UAVAuthFailure:
|
| 1054 |
+
description: UAV auth failure
|
| 1055 |
+
type: object
|
| 1056 |
+
required:
|
| 1057 |
+
- error
|
| 1058 |
+
properties:
|
| 1059 |
+
error:
|
| 1060 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
|
| 1061 |
+
uasResourceRelease:
|
| 1062 |
+
type: boolean
|
| 1063 |
+
default: false
|
| 1064 |
+
|
| 1065 |
+
AuthContainer:
|
| 1066 |
+
description: Authentication/Authorization data
|
| 1067 |
+
type: object
|
| 1068 |
+
properties:
|
| 1069 |
+
authMsgType:
|
| 1070 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
|
| 1071 |
+
authMsgPayload:
|
| 1072 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
|
| 1073 |
+
authResult:
|
| 1074 |
+
```
|
| 1075 |
+
|
| 1076 |
+
```
|
| 1077 |
+
$ref: '#/components/schemas/AuthResult'
|
| 1078 |
+
```
|
| 1079 |
+
|
| 1080 |
+
```
|
| 1081 |
+
#
|
| 1082 |
+
```
|
| 1083 |
+
|
| 1084 |
+
```
|
| 1085 |
+
# SIMPLE DATA TYPES
|
| 1086 |
+
```
|
| 1087 |
+
|
| 1088 |
+
```
|
| 1089 |
+
#
|
| 1090 |
+
```
|
| 1091 |
+
|
| 1092 |
+
```
|
| 1093 |
+
#
|
| 1094 |
+
```
|
| 1095 |
+
|
| 1096 |
+
```
|
| 1097 |
+
# ENUMERATIONS
|
| 1098 |
+
```
|
| 1099 |
+
|
| 1100 |
+
```
|
| 1101 |
+
#
|
| 1102 |
+
```
|
| 1103 |
+
|
| 1104 |
+
```
|
| 1105 |
+
AuthResult:
|
| 1106 |
+
description: Enumeration representing the result of authentication and/or authorization.
|
| 1107 |
+
anyOf:
|
| 1108 |
+
- type: string
|
| 1109 |
+
enum:
|
| 1110 |
+
- AUTH_SUCCESS
|
| 1111 |
+
- AUTH_FAIL
|
| 1112 |
+
- type: string
|
| 1113 |
+
NotifyType:
|
| 1114 |
+
description: Enumeration representing the type of notification.
|
| 1115 |
+
anyOf:
|
| 1116 |
+
- type: string
|
| 1117 |
+
enum:
|
| 1118 |
+
- REAUTH
|
| 1119 |
+
- UPDATEAUTH
|
| 1120 |
+
- REVOKE
|
| 1121 |
+
- type: string
|
| 1122 |
+
```
|
| 1123 |
+
|
| 1124 |
+
# Annex B (informative): Change history
|
| 1125 |
+
|
| 1126 |
+
| Change history | | | | | | | |
|
| 1127 |
+
|----------------|--------------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------|-------------|
|
| 1128 |
+
| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version |
|
| 1129 |
+
| 2021-04 | CT4#103-e | C4-212292 | | | | Initial TS skeleton. | 0.0.0 |
|
| 1130 |
+
| 2021-04 | CT4#103-e | C4-212598 | | | | Added scope, introduction, references, and abbreviations. | 0.1.0 |
|
| 1131 |
+
| 2021-05 | CT4#104-e | C4-213529 | | | | Aligned introduction terminology. Added, updated references. | 0.2.0 |
|
| 1132 |
+
| 2021-08 | CT4#105-e | C4-214758 | | | | Aligned interfaces, added Nnef_Auth service. | 0.3.0 |
|
| 1133 |
+
| 2021-10 | CT4#106-e | C4-215522 | | | | Several alignments with stage-2, clean-up, added OpenAPI for Nnef_Auth. | 0.4.0 |
|
| 1134 |
+
| 2021-11 | CT4#107-e | C4-216474 | | | | Several further alignments with stage-2: aligned API and operation names, terminology. Further clean-up done. | 0.5.0 |
|
| 1135 |
+
| 2021-12 | CT#94 | CP-213160 | | | | V1.0.0 presented for information | 1.0.0 |
|
| 1136 |
+
| 2022-01 | CT4#107bis-e | C4-220456 | | | | Several consistency issues addressed. Implemented pCRs C4-220121, C4-220122, C4-220285, C4-220291, C4-220292, C4-220293, and C4-220387 | 1.1.0 |
|
| 1137 |
+
| 2022-02 | CT4#108-e | C4-221594 | | | | Further consistency issues addressed. Implemented pCRs C4-221324, C4-221494, C4-221519, and C4-221340. | 1.2.0 |
|
| 1138 |
+
| 2022-03 | CT#95e | CP-220109 | | | | TS presented for approval | 2.0.0 |
|
| 1139 |
+
| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 |
|
| 1140 |
+
| 2022-06 | CT#96e | CP-221044 | 0001 | 1 | | Add Notification Correlation id | 17.1.0 |
|
| 1141 |
+
| 2022-06 | CT#96e | CP-221044 | 0002 | 1 | | Indication of UAS service release | 17.1.0 |
|
| 1142 |
+
| 2022-06 | CT#96e | CP-221044 | 0004 | | | Removal of revoke cause | 17.1.0 |
|
| 1143 |
+
| 2022-06 | CT#96e | CP-221028 | 0005 | | | Remove the apiVersion placeholder from the resource URI variables table | 17.1.0 |
|
| 1144 |
+
| 2022-06 | CT#96e | CP-221282 | 0007 | 1 | | 29.256 Rel-17 API version and External doc update | 17.1.0 |
|
| 1145 |
+
| 2022-09 | CT#97e | CP-222036 | 0009 | | | Fix for formatting of OpenAPI description field | 17.2.0 |
|
| 1146 |
+
| 2022-09 | CT#97e | CP-222058 | 0010 | | | 29.256 Rel-17 API version and External doc update | 17.2.0 |
|
| 1147 |
+
| 2022-12 | CT#98e | CP-223056 | 0008 | 2 | | Corrections for Auth message type | 17.3.0 |
|
| 1148 |
+
| 2022-12 | CT#98e | CP-223066 | 0011 | | | 29.256 Rel-17 API version and External doc update | 17.3.0 |
|
| 1149 |
+
| 2023-03 | CT#99 | CP-230082 | 0012 | 1 | | Rejecting PDN connection for C2 communication when UAS service is not allowed | 17.4.0 |
|
| 1150 |
+
| 2023-03 | CT#99 | CP-230068 | 0014 | | | Miscellaneous corrections | 18.0.0 |
|
| 1151 |
+
| 2023-06 | CT#100 | CP-231027 | 0013 | 5 | F | Location header and missing Redirection clause | 18.1.0 |
|
| 1152 |
+
| 2023-09 | CT#101 | CP-232047 | 0018 | 1 | A | Authorization Notification Callbackfor UUAA-MM after AMF Change | 18.2.0 |
|
| 1153 |
+
| 2023-09 | CT#101 | CP-232046 | 0017 | - | B | Clarification on Direct C2 authorization procedure | 18.2.0 |
|
| 1154 |
+
| 2023-12 | CT#102 | CP-233027 | 0020 | - | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 |
|
| 1155 |
+
| 2023-12 | CT#102 | CP-233030 | 0021 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 |
|
marked/Rel-18/29_series/29257/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29272/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29275/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29281/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29292/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29379/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29510/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29517/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29519/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29520/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29521/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29526/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29542/raw.md
ADDED
|
@@ -0,0 +1,849 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.542 V18.3.0 (2023-12)
|
| 4 |
+
|
| 5 |
+
*Technical Specification*
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Services for Non-IP Data Delivery (NIDD); Stage 3 (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right.
|
| 12 |
+
|
| 13 |
+
5G Advanced logo
|
| 14 |
+
|
| 15 |
+

|
| 16 |
+
|
| 17 |
+
The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the letters is a red signal wave icon, and below that, the text 'A GLOBAL INITIATIVE' in a smaller, all-caps font.
|
| 18 |
+
|
| 19 |
+
3GPP logo
|
| 20 |
+
|
| 21 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 22 |
+
|
| 23 |
+
## **3GPP**
|
| 24 |
+
|
| 25 |
+
Postal address
|
| 26 |
+
|
| 27 |
+
---
|
| 28 |
+
|
| 29 |
+
3GPP support office address
|
| 30 |
+
|
| 31 |
+
---
|
| 32 |
+
|
| 33 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 34 |
+
Valbonne - FRANCE
|
| 35 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 36 |
+
|
| 37 |
+
Internet
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
<http://www.3gpp.org>
|
| 42 |
+
|
| 43 |
+
# --- ***Copyright Notification*** ---
|
| 44 |
+
|
| 45 |
+
No part may be reproduced except as authorized by written permission.
|
| 46 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 47 |
+
|
| 48 |
+
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 49 |
+
All rights reserved.
|
| 50 |
+
|
| 51 |
+
UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
|
| 52 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 53 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 54 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 55 |
+
|
| 56 |
+
# Contents
|
| 57 |
+
|
| 58 |
+
| | |
|
| 59 |
+
|------------------------------------------------------------------------------------------|----|
|
| 60 |
+
| Foreword ..... | 5 |
|
| 61 |
+
| 1 Scope..... | 6 |
|
| 62 |
+
| 2 References..... | 6 |
|
| 63 |
+
| 3 Definitions, symbols and abbreviations ..... | 7 |
|
| 64 |
+
| 3.1 Terms..... | 7 |
|
| 65 |
+
| 3.2 Symbols..... | 7 |
|
| 66 |
+
| 3.3 Abbreviations ..... | 7 |
|
| 67 |
+
| 4 Overview..... | 7 |
|
| 68 |
+
| 4.1 Introduction ..... | 7 |
|
| 69 |
+
| 5 Services offered by the SMF for NIDD ..... | 8 |
|
| 70 |
+
| 5.1 Introduction ..... | 8 |
|
| 71 |
+
| 5.2 Nsmf_NIDD Service ..... | 8 |
|
| 72 |
+
| 5.2.1 Service Description ..... | 8 |
|
| 73 |
+
| 5.2.2 Service Operations..... | 8 |
|
| 74 |
+
| 5.2.2.1 Introduction..... | 8 |
|
| 75 |
+
| 5.2.2.2 Delivery ..... | 8 |
|
| 76 |
+
| 5.2.2.2.1 General ..... | 8 |
|
| 77 |
+
| 6 API Definitions ..... | 9 |
|
| 78 |
+
| 6.1 Nsmf_NIDD Service API..... | 9 |
|
| 79 |
+
| 6.1.1 Introduction ..... | 9 |
|
| 80 |
+
| 6.1.2 Usage of HTTP..... | 9 |
|
| 81 |
+
| 6.1.2.1 General..... | 9 |
|
| 82 |
+
| 6.1.2.2 HTTP standard headers..... | 10 |
|
| 83 |
+
| 6.1.2.2.1 General ..... | 10 |
|
| 84 |
+
| 6.1.2.2.2 Content type ..... | 10 |
|
| 85 |
+
| 6.1.2.3 HTTP custom headers..... | 10 |
|
| 86 |
+
| 6.1.3 Resources..... | 10 |
|
| 87 |
+
| 6.1.3.1 Overview..... | 10 |
|
| 88 |
+
| 6.1.3.2 Resource: Individual PDU session ..... | 11 |
|
| 89 |
+
| 6.1.3.2.1 Description ..... | 11 |
|
| 90 |
+
| 6.1.3.2.2 Resource Definition..... | 11 |
|
| 91 |
+
| 6.1.3.2.3 Resource Standard Methods..... | 11 |
|
| 92 |
+
| 6.1.3.2.4 Resource Custom Operations..... | 12 |
|
| 93 |
+
| 6.1.3.2.4.2.1 Description..... | 12 |
|
| 94 |
+
| 6.1.3.2.4.2.2 Operation Definition ..... | 12 |
|
| 95 |
+
| 6.1.4 Custom Operations without associated resources ..... | 13 |
|
| 96 |
+
| 6.1.5 Notifications ..... | 13 |
|
| 97 |
+
| 6.1.6 Data Model ..... | 13 |
|
| 98 |
+
| 6.1.6.1 General..... | 13 |
|
| 99 |
+
| 6.1.6.2 Structured data types..... | 14 |
|
| 100 |
+
| 6.1.6.2.1 Introduction ..... | 14 |
|
| 101 |
+
| 6.1.6.2.2 Type: DeliverReqData..... | 14 |
|
| 102 |
+
| 6.1.6.2.3 Type: DeliverAddInfo..... | 14 |
|
| 103 |
+
| 6.1.6.3 Simple data types and enumerations..... | 14 |
|
| 104 |
+
| 6.1.6.3.1 Introduction ..... | 14 |
|
| 105 |
+
| 6.1.6.3.2 Simple data types ..... | 14 |
|
| 106 |
+
| 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 14 |
|
| 107 |
+
| 6.1.6.4.1 Type: DeliverError ..... | 14 |
|
| 108 |
+
| 6.1.6.5 Binary data..... | 15 |
|
| 109 |
+
| 6.1.6.5.1 Mobile Terminated Data ..... | 15 |
|
| 110 |
+
| 6.1.7 Error Handling ..... | 15 |
|
| 111 |
+
| 6.1.7.1 General..... | 15 |
|
| 112 |
+
| 6.1.7.2 Protocol Errors ..... | 15 |
|
| 113 |
+
|
| 114 |
+
| | | |
|
| 115 |
+
|-------------------------------|------------------------------------|-----------|
|
| 116 |
+
| 6.1.7.3 | Application Errors..... | 15 |
|
| 117 |
+
| 6.1.8 | Feature negotiation ..... | 15 |
|
| 118 |
+
| 6.1.9 | Security ..... | 15 |
|
| 119 |
+
| 6.1.10 | HTTP redirection..... | 16 |
|
| 120 |
+
| <b>Annex A (normative):</b> | <b>OpenAPI specification .....</b> | <b>17</b> |
|
| 121 |
+
| A.1 | General..... | 17 |
|
| 122 |
+
| A.2 | Nsmf_NIDD API ..... | 17 |
|
| 123 |
+
| <b>Annex B (informative):</b> | <b>Change history .....</b> | <b>20</b> |
|
| 124 |
+
|
| 125 |
+
# Foreword
|
| 126 |
+
|
| 127 |
+
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
|
| 128 |
+
|
| 129 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 130 |
+
|
| 131 |
+
Version x.y.z
|
| 132 |
+
|
| 133 |
+
where:
|
| 134 |
+
|
| 135 |
+
- x the first digit:
|
| 136 |
+
- 1 presented to TSG for information;
|
| 137 |
+
- 2 presented to TSG for approval;
|
| 138 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 139 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 140 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 141 |
+
|
| 142 |
+
In the present document, modal verbs have the following meanings:
|
| 143 |
+
|
| 144 |
+
- shall** indicates a mandatory requirement to do something
|
| 145 |
+
- shall not** indicates an interdiction (prohibition) to do something
|
| 146 |
+
|
| 147 |
+
The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
|
| 148 |
+
|
| 149 |
+
The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
|
| 150 |
+
|
| 151 |
+
- should** indicates a recommendation to do something
|
| 152 |
+
- should not** indicates a recommendation not to do something
|
| 153 |
+
- may** indicates permission to do something
|
| 154 |
+
- need not** indicates permission not to do something
|
| 155 |
+
|
| 156 |
+
The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
|
| 157 |
+
|
| 158 |
+
- can** indicates that something is possible
|
| 159 |
+
- cannot** indicates that something is impossible
|
| 160 |
+
|
| 161 |
+
The constructions "can" and "cannot" are not substitutes for "may" and "need not".
|
| 162 |
+
|
| 163 |
+
- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
|
| 164 |
+
- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
|
| 165 |
+
- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
|
| 166 |
+
|
| 167 |
+
**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
|
| 168 |
+
|
| 169 |
+
In addition:
|
| 170 |
+
|
| 171 |
+
**is** (or any other verb in the indicative mood) indicates a statement of fact
|
| 172 |
+
|
| 173 |
+
**is not** (or any other negative verb in the indicative mood) indicates a statement of fact
|
| 174 |
+
|
| 175 |
+
The constructions "is" and "is not" do not indicate requirements.
|
| 176 |
+
|
| 177 |
+
# --- 1 Scope
|
| 178 |
+
|
| 179 |
+
The present document specifies the stage 3 protocol and data model for the Nsmf Service Based Interfaces for Non-IP Data Delivery (NIDD). It provides stage 3 protocol definitions and message flows, and specifies the API for the service offered by the SMF.
|
| 180 |
+
|
| 181 |
+
The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
|
| 182 |
+
|
| 183 |
+
The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
|
| 184 |
+
|
| 185 |
+
# --- 2 References
|
| 186 |
+
|
| 187 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 188 |
+
|
| 189 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 190 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 191 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 192 |
+
|
| 193 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 194 |
+
- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
|
| 195 |
+
- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
|
| 196 |
+
- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
|
| 197 |
+
- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
|
| 198 |
+
- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", <https://spec.openapis.org/oas/v3.0.0>.
|
| 199 |
+
- [7] 3GPP TR 21.900: "Technical Specification Group working methods".
|
| 200 |
+
- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
|
| 201 |
+
- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
|
| 202 |
+
- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
|
| 203 |
+
- [11] IETF RFC 9113: "Hypertext Transfer Protocol Version 2 (HTTP/2)".
|
| 204 |
+
- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
|
| 205 |
+
- [13] IETF RFC 9457: "Problem Details for HTTP APIs".
|
| 206 |
+
|
| 207 |
+
- [14] 3GPP TS 29.541: "5G System (5GS); Network Exposure (NE) function services for Non-IP Data Delivery (NIDD) and Short Message Services (SMS); Stage 3".
|
| 208 |
+
- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
|
| 209 |
+
|
| 210 |
+
# 3 Definitions, symbols and abbreviations
|
| 211 |
+
|
| 212 |
+
## 3.1 Terms
|
| 213 |
+
|
| 214 |
+
Void.
|
| 215 |
+
|
| 216 |
+
## 3.2 Symbols
|
| 217 |
+
|
| 218 |
+
Void.
|
| 219 |
+
|
| 220 |
+
## 3.3 Abbreviations
|
| 221 |
+
|
| 222 |
+
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
|
| 223 |
+
|
| 224 |
+
| | |
|
| 225 |
+
|-------|-----------------------------------------|
|
| 226 |
+
| 5GC | 5G Core Network |
|
| 227 |
+
| AMF | Access and Mobility Management Function |
|
| 228 |
+
| H-SMF | Home SMF |
|
| 229 |
+
| I-SMF | Intermediate SMF |
|
| 230 |
+
| NEF | Network Exposure Function |
|
| 231 |
+
| NIDD | Non-IP Data Delivery |
|
| 232 |
+
| MT | Mobile Terminated |
|
| 233 |
+
| SMF | Session Management Function |
|
| 234 |
+
| V-SMF | Visited SMF |
|
| 235 |
+
|
| 236 |
+
# 4 Overview
|
| 237 |
+
|
| 238 |
+
## 4.1 Introduction
|
| 239 |
+
|
| 240 |
+
Within the 5GC, the SMF offers services to the NF service consumers via the Nsmf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]).
|
| 241 |
+
|
| 242 |
+
Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the services specified within the present specification.
|
| 243 |
+
|
| 244 |
+

|
| 245 |
+
|
| 246 |
+
The diagram illustrates the reference model for the SMF. It features two main components: a Network Exposure Function (NEF) on the left and a Session Management Function (SMF) on the right. The NEF is represented by a light green rectangle. The SMF is represented by a larger light green rectangle with a semi-circular interface on its left side. A horizontal line connects the NEF to the SMF's interface. This line is labeled with 'N29' near the NEF and 'Nsmf' near the SMF's interface, indicating the reference point and service based interface respectively.
|
| 247 |
+
|
| 248 |
+
Reference model diagram showing the NEF connected to the SMF via the N29 reference point.
|
| 249 |
+
|
| 250 |
+
Figure 4.1-1: Reference model – SMF
|
| 251 |
+
|
| 252 |
+
N29 is the reference point between the (H-)SMF and the NEF.
|
| 253 |
+
|
| 254 |
+
The functionalities supported by the SMF are listed in clause 6.2.2 of 3GPP TS 23.501 [2].
|
| 255 |
+
|
| 256 |
+
# 5 Services offered by the SMF for NIDD
|
| 257 |
+
|
| 258 |
+
## 5.1 Introduction
|
| 259 |
+
|
| 260 |
+
The SMF supports the following service(s) for NIDD.
|
| 261 |
+
|
| 262 |
+
**Table 5.1-1: NF Service(s) provided by SMF for NIDD**
|
| 263 |
+
|
| 264 |
+
| Service Name | Description | Example Consumer |
|
| 265 |
+
|--------------|---------------------------------------------------------------------------------|------------------|
|
| 266 |
+
| Nsmf_NIDD | This service allows the NF consumer NF to deliver NIDD MT data to PDU sessions. | NEF |
|
| 267 |
+
|
| 268 |
+
## 5.2 Nsmf\_NIDD Service
|
| 269 |
+
|
| 270 |
+
### 5.2.1 Service Description
|
| 271 |
+
|
| 272 |
+
The Nsmf\_NIDD service operates on the PDU Sessions. The service operations exposed by this service allow an NF consumer (i.e. NEF) to deliver NEF anchored Mobile Terminated (MT) data for a given PDU session of a UE towards the SMF.
|
| 273 |
+
|
| 274 |
+
The Nsmf\_NIDD service supports the following service operations:
|
| 275 |
+
|
| 276 |
+
**Table 5.2.1-1: Service operations supported by the Nsmf\_NIDD service**
|
| 277 |
+
|
| 278 |
+
| Service Operations | Description | Operation Semantics | Example Consumer(s) |
|
| 279 |
+
|--------------------|---------------------------------------------------------|---------------------|---------------------|
|
| 280 |
+
| Delivery | Deliver MT NIDD user data to the PDU session of the UE. | Request/Response | NEF |
|
| 281 |
+
|
| 282 |
+
### 5.2.2 Service Operations
|
| 283 |
+
|
| 284 |
+
#### 5.2.2.1 Introduction
|
| 285 |
+
|
| 286 |
+
See Table 5.2.1-1 for an overview of the service operations supported by the Nsmf\_NIDD service.
|
| 287 |
+
|
| 288 |
+
#### 5.2.2.2 Delivery
|
| 289 |
+
|
| 290 |
+
##### 5.2.2.2.1 General
|
| 291 |
+
|
| 292 |
+
The Delivery service operation shall be used to transfer NEF anchored MT data for a given PDU session.
|
| 293 |
+
|
| 294 |
+
It is used in the following procedures:
|
| 295 |
+
|
| 296 |
+
- NEF anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]).
|
| 297 |
+
|
| 298 |
+
The NF Service Consumer (i.e. NEF) shall deliver MT data to the SMF by using the HTTP POST method ("deliver" custom operation) as shown in Figure 5.2.2.2.1-1.
|
| 299 |
+
|
| 300 |
+

|
| 301 |
+
|
| 302 |
+
```
|
| 303 |
+
|
| 304 |
+
sequenceDiagram
|
| 305 |
+
participant NF Service Consumer
|
| 306 |
+
participant SMF
|
| 307 |
+
Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/deliver (DeliverReqData)
|
| 308 |
+
NF Service Consumer->>SMF: Request
|
| 309 |
+
Note left of SMF: 2a. 204 No Content
|
| 310 |
+
SMF-->>NF Service Consumer: Response 2a
|
| 311 |
+
Note left of SMF: 2b. 4xx/5xx (DeliverError/ProblemDetails) or 3xx
|
| 312 |
+
SMF-->>NF Service Consumer: Response 2b
|
| 313 |
+
|
| 314 |
+
```
|
| 315 |
+
|
| 316 |
+
Sequence diagram showing the transfer of MT data from an NF Service Consumer to an SMF. The consumer sends a POST request to the URI '.../pdu-sessions/{pduSessionRef}/deliver' with 'DeliverReqData'. The SMF responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (DeliverError/ProblemDetails) or 3xx.
|
| 317 |
+
|
| 318 |
+
**Figure 5.2.2.2.1-1: Transfer MT Data**
|
| 319 |
+
|
| 320 |
+
1. The NF Service Consumer shall send a POST request to the URI of "deliver" custom operation on an Individual PDU session resource in the SMF. The content of the POST request shall contain the MT data to be delivered.
|
| 321 |
+
|
| 322 |
+
NOTE: The URI of the individual PDU session resource is provided by SMF to the NEF during SMF-NEF connection creation (see clause 5.2.2.2.1 of 3GPP TS 29.541 [14]).
|
| 323 |
+
|
| 324 |
+
- 2a. On success, "204 No Content" shall be returned.
|
| 325 |
+
|
| 326 |
+
- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a DeliverError or ProblemDetails object, with the "cause" attribute indicating the cause of the failure. If Estimated Maximum Waiting Time is received from AMF, the SMF shall include it in the message body.
|
| 327 |
+
|
| 328 |
+
# 6 API Definitions
|
| 329 |
+
|
| 330 |
+
## 6.1 Nsmf\_NIDD Service API
|
| 331 |
+
|
| 332 |
+
### 6.1.1 Introduction
|
| 333 |
+
|
| 334 |
+
The Nsmf\_NIDD service shall use the Nsmf\_NIDD API.
|
| 335 |
+
|
| 336 |
+
The API URI of the Nsmf\_NIDD API shall be:
|
| 337 |
+
|
| 338 |
+
**{apiRoot}/<apiName>/<apiVersion>/**
|
| 339 |
+
|
| 340 |
+
The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
|
| 341 |
+
|
| 342 |
+
**{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>**
|
| 343 |
+
|
| 344 |
+
with the following components:
|
| 345 |
+
|
| 346 |
+
- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
|
| 347 |
+
- The <apiName> shall be "nsmf-nidd".
|
| 348 |
+
- The <apiVersion> shall be "v1".
|
| 349 |
+
- The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
|
| 350 |
+
|
| 351 |
+
### 6.1.2 Usage of HTTP
|
| 352 |
+
|
| 353 |
+
#### 6.1.2.1 General
|
| 354 |
+
|
| 355 |
+
HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
|
| 356 |
+
|
| 357 |
+
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
|
| 358 |
+
|
| 359 |
+
The OpenAPI [6] specification of HTTP messages and content bodies for the Nsmf\_NIDD API is contained in Annex A.
|
| 360 |
+
|
| 361 |
+
#### 6.1.2.2 HTTP standard headers
|
| 362 |
+
|
| 363 |
+
##### 6.1.2.2.1 General
|
| 364 |
+
|
| 365 |
+
The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4].
|
| 366 |
+
|
| 367 |
+
##### 6.1.2.2.2 Content type
|
| 368 |
+
|
| 369 |
+
The following content types shall be supported:
|
| 370 |
+
|
| 371 |
+
- the JSON format (IETF RFC 8259 [12]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4].
|
| 372 |
+
- the Problem Details JSON Object (IETF RFC 9457 [13]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json".
|
| 373 |
+
|
| 374 |
+
NOTE: "application/json" is used in a response that includes a payload body containing an application-specific data structure, see clause 4.8 of 3GPP TS 29.501 [5].
|
| 375 |
+
|
| 376 |
+
Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising:
|
| 377 |
+
|
| 378 |
+
- one JSON body part with the "application/json" content type; and
|
| 379 |
+
- one or two binary body parts with 3gpp vendor specific content subtypes.
|
| 380 |
+
|
| 381 |
+
The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported.
|
| 382 |
+
|
| 383 |
+
**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes**
|
| 384 |
+
|
| 385 |
+
| content subtype | Description |
|
| 386 |
+
|-----------------|-------------------------------------------------------------------------------------------------------|
|
| 387 |
+
| vnd.3gpp.5gnas | Binary encoded payload, encoding a 5GS NAS message or 5G NAS IEs, as specified in 3GPP TS 24.501 [7]. |
|
| 388 |
+
|
| 389 |
+
See clause 6.1.6.5 for the binary payloads supported in the binary body part of multipart messages.
|
| 390 |
+
|
| 391 |
+
#### 6.1.2.3 HTTP custom headers
|
| 392 |
+
|
| 393 |
+
In this release of the specification, no specific custom headers are defined for the Nsmf\_NIDD service.
|
| 394 |
+
|
| 395 |
+
For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4].
|
| 396 |
+
|
| 397 |
+
### 6.1.3 Resources
|
| 398 |
+
|
| 399 |
+
#### 6.1.3.1 Overview
|
| 400 |
+
|
| 401 |
+
Figure 6.1.3.1-1 describes the resource URI structure of the Nsmf\_NIDD API.
|
| 402 |
+
|
| 403 |
+

|
| 404 |
+
|
| 405 |
+
```
|
| 406 |
+
|
| 407 |
+
{apiRoot}/nsmf-nidd/<apiVersion>
|
| 408 |
+
|
|
| 409 |
+
+-- /pdu-sessions
|
| 410 |
+
|
|
| 411 |
+
+-- /{pduSessionRef}
|
| 412 |
+
|
|
| 413 |
+
+-- /deliver
|
| 414 |
+
|
| 415 |
+
```
|
| 416 |
+
|
| 417 |
+
Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which finally branches to /deliver. The /deliver path is enclosed in a dashed box.
|
| 418 |
+
|
| 419 |
+
**Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API**
|
| 420 |
+
|
| 421 |
+
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
|
| 422 |
+
|
| 423 |
+
**Table 6.1.3.1-1: Resources and methods overview**
|
| 424 |
+
|
| 425 |
+
| Resource name | Resource URI | HTTP method or custom operation | Description |
|
| 426 |
+
|------------------------|---------------------------------------|---------------------------------|----------------------------|
|
| 427 |
+
| Individual PDU session | /pdu-sessions/{pduSessionRef}/deliver | deliver (POST) | Delivery Service Operation |
|
| 428 |
+
|
| 429 |
+
#### 6.1.3.2 Resource: Individual PDU session
|
| 430 |
+
|
| 431 |
+
##### 6.1.3.2.1 Description
|
| 432 |
+
|
| 433 |
+
This resource represents an individual PDU session created in SMF for NIDD.
|
| 434 |
+
|
| 435 |
+
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
|
| 436 |
+
|
| 437 |
+
##### 6.1.3.2.2 Resource Definition
|
| 438 |
+
|
| 439 |
+
Resource URI: {apiRoot}/nsmf-nidd/<apiVersion>/pdu-sessions/{pduSessionRef}
|
| 440 |
+
|
| 441 |
+
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
|
| 442 |
+
|
| 443 |
+
**Table 6.1.3.2.2-1: Resource URI variables for this resource**
|
| 444 |
+
|
| 445 |
+
| Name | Definition |
|
| 446 |
+
|---------------|-------------------------------------------------------------------------------|
|
| 447 |
+
| apiRoot | See clause 6.1.1 |
|
| 448 |
+
| apiVersion | See clause 6.1.1 |
|
| 449 |
+
| pduSessionRef | PDU session reference assigned by the SMF during SMF-NEF Connection creation. |
|
| 450 |
+
|
| 451 |
+
##### 6.1.3.2.3 Resource Standard Methods
|
| 452 |
+
|
| 453 |
+
None.
|
| 454 |
+
|
| 455 |
+
##### 6.1.3.2.4 Resource Custom Operations
|
| 456 |
+
|
| 457 |
+
###### 6.1.3.2.4.1 Overview
|
| 458 |
+
|
| 459 |
+
**Table 6.1.3.2.4.1-1: Custom operations**
|
| 460 |
+
|
| 461 |
+
| Custom operation URI | Mapped HTTP method | Description |
|
| 462 |
+
|-----------------------|--------------------|-----------------------------|
|
| 463 |
+
| {resourceUri}/deliver | POST | Delivery service operation. |
|
| 464 |
+
|
| 465 |
+
###### 6.1.3.2.4.2 Operation: deliver
|
| 466 |
+
|
| 467 |
+
###### 6.1.3.2.4.2.1 Description
|
| 468 |
+
|
| 469 |
+
This custom operation enables to deliver NEF anchored MT data for a given PDU session towards the SMF.
|
| 470 |
+
|
| 471 |
+
###### 6.1.3.2.4.2.2 Operation Definition
|
| 472 |
+
|
| 473 |
+
This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2.
|
| 474 |
+
|
| 475 |
+
**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource**
|
| 476 |
+
|
| 477 |
+
| Data type | P | Cardinality | Description |
|
| 478 |
+
|----------------|---|-------------|----------------------------------------------------|
|
| 479 |
+
| DeliverReqData | M | 1 | Representation of the payload of a Deliver Request |
|
| 480 |
+
|
| 481 |
+
**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource**
|
| 482 |
+
|
| 483 |
+
| Data type | P | Cardinality | Response codes | Description |
|
| 484 |
+
|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 485 |
+
| n/a | | | 204 No Content | Successful delivery of MT data. |
|
| 486 |
+
| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.<br>(NOTE 2) |
|
| 487 |
+
| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.<br>(NOTE 2) |
|
| 488 |
+
| DeliverError | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application errors:<br>- UE_NOT_REACHABLE, if the UE is not reachable to deliver the mobile terminated data; if Estimated Maximum Waiting Time shall be included if available;<br><br>See table 6.1.7.3-1 for the description of these errors. |
|
| 489 |
+
|
| 490 |
+
NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [4]).
|
| 491 |
+
|
| 492 |
+
NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
| 493 |
+
|
| 494 |
+
**Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource**
|
| 495 |
+
|
| 496 |
+
| Name | Data type | P | Cardinality | Description |
|
| 497 |
+
|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 498 |
+
| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
|
| 499 |
+
| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected |
|
| 500 |
+
|
| 501 |
+
**Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource**
|
| 502 |
+
|
| 503 |
+
| Name | Data type | P | Cardinality | Description |
|
| 504 |
+
|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 505 |
+
| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. |
|
| 506 |
+
| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected |
|
| 507 |
+
|
| 508 |
+
### 6.1.4 Custom Operations without associated resources
|
| 509 |
+
|
| 510 |
+
None
|
| 511 |
+
|
| 512 |
+
### 6.1.5 Notifications
|
| 513 |
+
|
| 514 |
+
None.
|
| 515 |
+
|
| 516 |
+
### 6.1.6 Data Model
|
| 517 |
+
|
| 518 |
+
#### 6.1.6.1 General
|
| 519 |
+
|
| 520 |
+
This clause specifies the application data model supported by the API.
|
| 521 |
+
|
| 522 |
+
Table 6.1.6.1-1 specifies the data types defined for the Nsmf\_NIDD service based interface protocol.
|
| 523 |
+
|
| 524 |
+
**Table 6.1.6.1-1: Nsmf\_NIDD specific Data Types**
|
| 525 |
+
|
| 526 |
+
| Data type | Clause defined | Description | Applicability |
|
| 527 |
+
|----------------|----------------|-----------------------------------------------|---------------|
|
| 528 |
+
| DeliverReqData | 6.1.6.2.2 | Information within Deliver Request | |
|
| 529 |
+
| DeliverAddInfo | 6.1.6.2.3 | Deliver Error Response Additional Information | |
|
| 530 |
+
| DeliverError | 6.1.6.4.1 | Deliver Error Response | |
|
| 531 |
+
|
| 532 |
+
Table 6.1.6.1-2 specifies data types re-used by the N<sub><NF></sub> service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the N<sub><NF></sub> service based interface.
|
| 533 |
+
|
| 534 |
+
**Table 6.1.6.1-2: Nsmf\_NIDD re-used Data Types**
|
| 535 |
+
|
| 536 |
+
| Data type | Reference | Comments | Applicability |
|
| 537 |
+
|------------------|---------------------|------------------------------------------------------------------------------------------------|---------------|
|
| 538 |
+
| RefToBinaryData | 3GPP TS 29.571 [15] | Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message. | |
|
| 539 |
+
| ProblemDetails | 3GPP TS 29.571 [15] | Error description | |
|
| 540 |
+
| DurationSec | 3GPP TS 29.571 [15] | Duration in units of seconds | |
|
| 541 |
+
| RedirectResponse | 3GPP TS 29.571 [15] | Redirect Response | |
|
| 542 |
+
|
| 543 |
+
#### 6.1.6.2 Structured data types
|
| 544 |
+
|
| 545 |
+
##### 6.1.6.2.1 Introduction
|
| 546 |
+
|
| 547 |
+
This clause defines the structures to be used in resource representations.
|
| 548 |
+
|
| 549 |
+
##### 6.1.6.2.2 Type: DeliverReqData
|
| 550 |
+
|
| 551 |
+
**Table 6.1.6.2.2-1: Definition of type DeliverReqData**
|
| 552 |
+
|
| 553 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 554 |
+
|----------------|-----------------|---|-------------|----------------------------------------------------------------------------|---------------|
|
| 555 |
+
| mtData | RefToBinaryData | M | 1 | This IE shall reference the Mobile Terminated Data (see clause 6.1.6.5.1). | |
|
| 556 |
+
|
| 557 |
+
##### 6.1.6.2.3 Type: DeliverAddInfo
|
| 558 |
+
|
| 559 |
+
**Table 6.1.6.2.3-1: Definition of type DeliverAddInfo**
|
| 560 |
+
|
| 561 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 562 |
+
|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------|
|
| 563 |
+
| maxWaitingTime | DurationSec | C | 0..1 | This IE shall contain the estimated maximum wait time (see clause 4.25.5 of 3GPP 23.502 [3]). | |
|
| 564 |
+
|
| 565 |
+
#### 6.1.6.3 Simple data types and enumerations
|
| 566 |
+
|
| 567 |
+
##### 6.1.6.3.1 Introduction
|
| 568 |
+
|
| 569 |
+
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
|
| 570 |
+
|
| 571 |
+
##### 6.1.6.3.2 Simple data types
|
| 572 |
+
|
| 573 |
+
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
|
| 574 |
+
|
| 575 |
+
**Table 6.1.6.3.2-1: Simple data types**
|
| 576 |
+
|
| 577 |
+
| Type Name | Type Definition | Description | Applicability |
|
| 578 |
+
|-----------|-----------------|-------------|---------------|
|
| 579 |
+
| | | | |
|
| 580 |
+
|
| 581 |
+
#### 6.1.6.4 Data types describing alternative data types or combinations of data types
|
| 582 |
+
|
| 583 |
+
##### 6.1.6.4.1 Type: DeliverError
|
| 584 |
+
|
| 585 |
+
**Table 6.1.6.4.1-1: Definition of type DeliverError as a list of "to be combined data types"**
|
| 586 |
+
|
| 587 |
+
| Data type | Cardinality | Description | Applicability |
|
| 588 |
+
|----------------|-------------|----------------------------------------------------------|---------------|
|
| 589 |
+
| ProblemDetails | 1 | Detail information of the problem | |
|
| 590 |
+
| DeliverAddInfo | 1 | Additional information to be returned in error response. | |
|
| 591 |
+
|
| 592 |
+
#### 6.1.6.5 Binary data
|
| 593 |
+
|
| 594 |
+
##### 6.1.6.5.1 Mobile Terminated Data
|
| 595 |
+
|
| 596 |
+
Mobile Terminated Data shall encode the Data Contents of the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.5.1-1.
|
| 597 |
+
|
| 598 |
+
**Table 6.1.6.5.1-1: Mobile Terminated Data**
|
| 599 |
+
|
| 600 |
+
| Mobile Terminated Data | Reference<br>(3GPP TS 24.501 [7]) | Related NAS SM message |
|
| 601 |
+
|---------------------------------------------|-----------------------------------|------------------------|
|
| 602 |
+
| Payload container contents in octets 4 to n | 9.11.3.39 | DL NAS Transport |
|
| 603 |
+
|
| 604 |
+
### 6.1.7 Error Handling
|
| 605 |
+
|
| 606 |
+
#### 6.1.7.1 General
|
| 607 |
+
|
| 608 |
+
For the Nsmf\_NIDD API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
|
| 609 |
+
|
| 610 |
+
In addition, the requirements in the following clauses are applicable for the Nsmf\_NIDD API.
|
| 611 |
+
|
| 612 |
+
#### 6.1.7.2 Protocol Errors
|
| 613 |
+
|
| 614 |
+
No specific procedures for the Nsmf\_NIDD service are specified.
|
| 615 |
+
|
| 616 |
+
#### 6.1.7.3 Application Errors
|
| 617 |
+
|
| 618 |
+
The common application errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] may be used for the Nsmf\_NIDD service.
|
| 619 |
+
|
| 620 |
+
The application errors defined for the Nsmf\_NIDD service are listed in Table 6.1.7.3-1.
|
| 621 |
+
|
| 622 |
+
**Table 6.1.7.3-1: Application errors**
|
| 623 |
+
|
| 624 |
+
| Application Error | HTTP status code | Description |
|
| 625 |
+
|-------------------|---------------------|------------------------------------------|
|
| 626 |
+
| UE_NOT_REACHABLE | 504 Gateway Timeout | The UE is not reachable for the service. |
|
| 627 |
+
|
| 628 |
+
### 6.1.8 Feature negotiation
|
| 629 |
+
|
| 630 |
+
The optional features in table 6.1.8-1 are defined for the Nsmf\_NIDD API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
|
| 631 |
+
|
| 632 |
+
**Table 6.1.8-1: Supported Features**
|
| 633 |
+
|
| 634 |
+
| Feature number | Feature Name | Description |
|
| 635 |
+
|----------------|--------------|-------------|
|
| 636 |
+
| | | |
|
| 637 |
+
|
| 638 |
+
### 6.1.9 Security
|
| 639 |
+
|
| 640 |
+
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nsmf\_NIDD API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
|
| 641 |
+
|
| 642 |
+
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nsmf\_NIDD API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
|
| 643 |
+
|
| 644 |
+
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nsmf\_NIDD service.
|
| 645 |
+
|
| 646 |
+
The Nsmf\_NIDD API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [15]; it defines a single scope consisting on the name of the service (i.e., "nsmf-nidd"), and it does not define any additional scopes at resource or operation level.
|
| 647 |
+
|
| 648 |
+
### 6.1.10 HTTP redirection
|
| 649 |
+
|
| 650 |
+
An HTTP request may be redirected to a different SMF service instance, within the same SMF or a different SMF of an SMF set, e.g. when an SMF service instance is part of an SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]).
|
| 651 |
+
|
| 652 |
+
An SCP that reselects a different SMF producer instance will return the NF Instance ID of the new SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
|
| 653 |
+
|
| 654 |
+
If an SMF within an SMF set redirects a service request to a different SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].
|
| 655 |
+
|
| 656 |
+
# --- Annex A (normative): OpenAPI specification
|
| 657 |
+
|
| 658 |
+
## A.1 General
|
| 659 |
+
|
| 660 |
+
This Annex specifies the formal definition of the Nsmf\_NIDD Service API. It consists of OpenAPI 3.0.0 specifications, in YAML format.
|
| 661 |
+
|
| 662 |
+
This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
|
| 663 |
+
|
| 664 |
+
NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
|
| 665 |
+
|
| 666 |
+
Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B).
|
| 667 |
+
|
| 668 |
+
## --- A.2 Nsmf\_NIDD API
|
| 669 |
+
|
| 670 |
+
```
|
| 671 |
+
openapi: 3.0.0
|
| 672 |
+
|
| 673 |
+
info:
|
| 674 |
+
version: '1.2.0-alpha.1'
|
| 675 |
+
title: 'Nsmf_NIDD'
|
| 676 |
+
description: |
|
| 677 |
+
SMF NIDD Service.
|
| 678 |
+
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 679 |
+
All rights reserved.
|
| 680 |
+
|
| 681 |
+
externalDocs:
|
| 682 |
+
description: 3GPP TS 29.542 V18.0.0; 5G System; Session Management Services for Non-IP Data
|
| 683 |
+
Delivery (NIDD); Stage 3
|
| 684 |
+
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.542/
|
| 685 |
+
|
| 686 |
+
servers:
|
| 687 |
+
- url: '{apiRoot}/nsmf-nidd/v1'
|
| 688 |
+
variables:
|
| 689 |
+
apiRoot:
|
| 690 |
+
default: https://example.com
|
| 691 |
+
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
|
| 692 |
+
|
| 693 |
+
security:
|
| 694 |
+
- {}
|
| 695 |
+
- oAuth2ClientCredentials:
|
| 696 |
+
- nsmf-nidd
|
| 697 |
+
|
| 698 |
+
paths:
|
| 699 |
+
'/pdu-sessions/{pduSessionRef}/deliver':
|
| 700 |
+
post:
|
| 701 |
+
summary: Delivery Service Operation
|
| 702 |
+
tags:
|
| 703 |
+
- Individual PDU session
|
| 704 |
+
operationId: Deliver
|
| 705 |
+
parameters:
|
| 706 |
+
- name: pduSessionRef
|
| 707 |
+
in: path
|
| 708 |
+
description: PDU session reference
|
| 709 |
+
required: true
|
| 710 |
+
schema:
|
| 711 |
+
type: string
|
| 712 |
+
requestBody:
|
| 713 |
+
description: representation of the payload of Deliver Request
|
| 714 |
+
required: true
|
| 715 |
+
content:
|
| 716 |
+
```
|
| 717 |
+
|
| 718 |
+
```
|
| 719 |
+
|
| 720 |
+
multipart/related: # message with a binary body part
|
| 721 |
+
schema:
|
| 722 |
+
type: object
|
| 723 |
+
properties:
|
| 724 |
+
jsonData:
|
| 725 |
+
$ref: '#/components/schemas/DeliverReqData'
|
| 726 |
+
binaryMtData:
|
| 727 |
+
type: string
|
| 728 |
+
format: binary
|
| 729 |
+
encoding:
|
| 730 |
+
jsonData:
|
| 731 |
+
contentType: application/json
|
| 732 |
+
binaryMtData:
|
| 733 |
+
contentType: application/vnd.3gpp.5gnas
|
| 734 |
+
headers:
|
| 735 |
+
Content-Id:
|
| 736 |
+
schema:
|
| 737 |
+
type: string
|
| 738 |
+
responses:
|
| 739 |
+
'204':
|
| 740 |
+
description: successful transfering of Delivery
|
| 741 |
+
'307':
|
| 742 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
|
| 743 |
+
'308':
|
| 744 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
|
| 745 |
+
'400':
|
| 746 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
|
| 747 |
+
'401':
|
| 748 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
|
| 749 |
+
'403':
|
| 750 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
|
| 751 |
+
'404':
|
| 752 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
|
| 753 |
+
'411':
|
| 754 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
|
| 755 |
+
'413':
|
| 756 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
|
| 757 |
+
'415':
|
| 758 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
|
| 759 |
+
'429':
|
| 760 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
|
| 761 |
+
'500':
|
| 762 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
|
| 763 |
+
'502':
|
| 764 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
|
| 765 |
+
'503':
|
| 766 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
|
| 767 |
+
'504':
|
| 768 |
+
description: unsuccessful delivery of mobile terminated data - gateway timeout
|
| 769 |
+
content:
|
| 770 |
+
application/json:
|
| 771 |
+
schema:
|
| 772 |
+
$ref: '#/components/schemas/DeliverError'
|
| 773 |
+
default:
|
| 774 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
|
| 775 |
+
|
| 776 |
+
components:
|
| 777 |
+
securitySchemes:
|
| 778 |
+
oAuth2ClientCredentials:
|
| 779 |
+
type: oauth2
|
| 780 |
+
flows:
|
| 781 |
+
clientCredentials:
|
| 782 |
+
tokenUrl: '{nrfApiRoot}/oauth2/token'
|
| 783 |
+
scopes:
|
| 784 |
+
nsmf-nidd: Access to the nsmf-nidd API
|
| 785 |
+
|
| 786 |
+
schemas:
|
| 787 |
+
#
|
| 788 |
+
# STRUCTURED DATA TYPES
|
| 789 |
+
#
|
| 790 |
+
|
| 791 |
+
DeliverReqData:
|
| 792 |
+
description: Representation of the payload of a Deliver Request.
|
| 793 |
+
type: object
|
| 794 |
+
properties:
|
| 795 |
+
mtData:
|
| 796 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
|
| 797 |
+
required:
|
| 798 |
+
|
| 799 |
+
```
|
| 800 |
+
|
| 801 |
+
- mtData
|
| 802 |
+
|
| 803 |
+
DeliverAddInfo:
|
| 804 |
+
description: Additional information in an error response to a Deliver Request.
|
| 805 |
+
type: object
|
| 806 |
+
properties:
|
| 807 |
+
maxWaitingTime:
|
| 808 |
+
\$ref: 'TS29571\_CommonData.yaml#/components/schemas/DurationSec'
|
| 809 |
+
|
| 810 |
+
#
|
| 811 |
+
|
| 812 |
+
# DATA TYPES DESCRIBING ALTERNATIVE OR COMBINATION OF DATA TYPES
|
| 813 |
+
|
| 814 |
+
#
|
| 815 |
+
|
| 816 |
+
DeliverError:
|
| 817 |
+
description: Representation of the payload in an error response to a Deliver Request.
|
| 818 |
+
allOf:
|
| 819 |
+
- \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ProblemDetails'
|
| 820 |
+
- \$ref: '#/components/schemas/DeliverAddInfo'
|
| 821 |
+
|
| 822 |
+
# Annex B (informative): Change history
|
| 823 |
+
|
| 824 |
+
| Change history | | | | | | | | |
|
| 825 |
+
|----------------|----------|-----------|------|-----|-----|-----------------------------------------------------|--|-------------|
|
| 826 |
+
| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version |
|
| 827 |
+
| 2020-03 | CT4#96-e | C4-201267 | | | | Initial Draft. | | 0.1.0 |
|
| 828 |
+
| 2020-03 | CT#87e | CP-200093 | | | | Presented for information and approval | | 1.0.0 |
|
| 829 |
+
| 2020-03 | CT#87e | | | | | Approved at CT#87e | | 16.0.0 |
|
| 830 |
+
| 2020-06 | CT#88e | CP-201071 | 0001 | 2 | F | Storage of YAML files in ETSI Forge | | 16.1.0 |
|
| 831 |
+
| 2020-06 | CT#88e | CP-201046 | 0003 | | F | Miscellaneous Corrections | | 16.1.0 |
|
| 832 |
+
| 2020-06 | CT#88e | CP-201073 | 0004 | | F | 29.542 Rel-16 API version and External doc update | | 16.1.0 |
|
| 833 |
+
| 2020-09 | CT#89e | CP-202105 | 0005 | | F | Optionality of DeliverError | | 16.2.0 |
|
| 834 |
+
| 2020-12 | CT#90e | CP-203032 | 0007 | | F | YAML files in 3GPP Forge | | 16.3.0 |
|
| 835 |
+
| 2021-03 | CT#91e | CP-210037 | 0010 | 1 | F | HTTP 3xx redirection | | 17.0.0 |
|
| 836 |
+
| 2021-03 | CT#91e | CP-210034 | 0011 | 1 | F | OpenAPI Reference | | 17.0.0 |
|
| 837 |
+
| 2021-03 | CT#91e | CP-210054 | 0013 | - | F | 29.542 Rel-16 API version and External doc update | | 17.0.0 |
|
| 838 |
+
| 2021-06 | CT#92e | CP-210050 | 0014 | 1 | F | Resolving Warning in Nsmf_NIDD API | | 17.1.0 |
|
| 839 |
+
| 2021-06 | CT#92e | CP-210050 | 0017 | 1 | A | Redirect Response | | 17.1.0 |
|
| 840 |
+
| 2021-06 | CT#92e | CP-210050 | 0018 | | F | 29.542 Rel-17 API version and External doc update | | 17.1.0 |
|
| 841 |
+
| 2021-09 | CT#93e | CP-212060 | 0021 | - | A | 3xx description correction for SCP | | 17.2.0 |
|
| 842 |
+
| 2022-03 | CT#95e | CP-220025 | 0025 | 1 | F | SMF reference model update | | 17.3.0 |
|
| 843 |
+
| 2022-06 | CT#96 | CP-221051 | 0027 | | F | 29.542 Rel-17 API version and External doc update | | 17.4.0 |
|
| 844 |
+
| 2022-12 | CT#98 | CP-223028 | 0029 | 1 | F | Missing Mandatory Status Codes in OpenAPI | | 18.0.0 |
|
| 845 |
+
| 2022-12 | CT#98 | CP-223033 | 0030 | | F | 29.542 Rel-18 API version and External doc update | | 18.0.0 |
|
| 846 |
+
| 2023-06 | CT#100 | CP-231028 | 0031 | 3 | F | Location header description | | 18.1.0 |
|
| 847 |
+
| 2023-09 | CT#101 | CP-232063 | 0035 | 1 | F | Update on the references | | 18.2.0 |
|
| 848 |
+
| 2023-12 | CT#102 | CP-233029 | 0036 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | | 18.3.0 |
|
| 849 |
+
| 2023-12 | CT#102 | CP-233030 | 0037 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | | 18.3.0 |
|
marked/Rel-18/29_series/29543/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29544/raw.md
ADDED
|
@@ -0,0 +1,767 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
# 3GPP TS 29.544 V18.1.0 (2023-12)
|
| 4 |
+
|
| 5 |
+
*Technical Specification*
|
| 6 |
+
|
| 7 |
+
## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Secured Packet Application Function (SP-AF) Services; Stage 3 (Release 18)**
|
| 8 |
+
|
| 9 |
+

|
| 10 |
+
|
| 11 |
+
The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right.
|
| 12 |
+
|
| 13 |
+
5G Advanced logo
|
| 14 |
+
|
| 15 |
+

|
| 16 |
+
|
| 17 |
+
The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font.
|
| 18 |
+
|
| 19 |
+
3GPP logo
|
| 20 |
+
|
| 21 |
+
The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
|
| 22 |
+
|
| 23 |
+
## **3GPP**
|
| 24 |
+
|
| 25 |
+
---
|
| 26 |
+
|
| 27 |
+
Postal address
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
3GPP support office address
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
650 Route des Lucioles - Sophia Antipolis
|
| 36 |
+
Valbonne - FRANCE
|
| 37 |
+
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
Internet
|
| 42 |
+
|
| 43 |
+
---
|
| 44 |
+
|
| 45 |
+
<http://www.3gpp.org>
|
| 46 |
+
|
| 47 |
+
# --- **Copyright Notification** ---
|
| 48 |
+
|
| 49 |
+
No part may be reproduced except as authorized by written permission.
|
| 50 |
+
The copyright and the foregoing restriction extend to reproduction in all media.
|
| 51 |
+
|
| 52 |
+
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 53 |
+
All rights reserved.
|
| 54 |
+
|
| 55 |
+
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
|
| 56 |
+
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 57 |
+
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
|
| 58 |
+
GSM® and the GSM logo are registered and owned by the GSM Association
|
| 59 |
+
|
| 60 |
+
# Contents
|
| 61 |
+
|
| 62 |
+
| | |
|
| 63 |
+
|------------------------------------------------------------|----|
|
| 64 |
+
| Foreword ..... | 5 |
|
| 65 |
+
| 1 Scope..... | 7 |
|
| 66 |
+
| 2 References..... | 7 |
|
| 67 |
+
| 3 Definitions, symbols and abbreviations ..... | 8 |
|
| 68 |
+
| 3.1 Terms..... | 8 |
|
| 69 |
+
| 3.2 Symbols..... | 8 |
|
| 70 |
+
| 3.3 Abbreviations ..... | 8 |
|
| 71 |
+
| 4 Overview..... | 8 |
|
| 72 |
+
| 4.1 Introduction ..... | 8 |
|
| 73 |
+
| 5 Services offered by the SP-AF..... | 9 |
|
| 74 |
+
| 5.1 Introduction ..... | 9 |
|
| 75 |
+
| 5.2 Nspaf_SecuredPacket Service..... | 9 |
|
| 76 |
+
| 5.2.1 Service Description ..... | 9 |
|
| 77 |
+
| 5.2.2 Service Operations..... | 9 |
|
| 78 |
+
| 5.2.2.1 Introduction..... | 9 |
|
| 79 |
+
| 5.2.2.2 Provide ..... | 9 |
|
| 80 |
+
| 5.2.2.2.1 General ..... | 9 |
|
| 81 |
+
| 5.2.2.2.2 Secured Packet Retrieval..... | 9 |
|
| 82 |
+
| 6 API Definitions ..... | 10 |
|
| 83 |
+
| 6.1 Nspaf_SecuredPacket Service API ..... | 10 |
|
| 84 |
+
| 6.1.1 Introduction ..... | 10 |
|
| 85 |
+
| 6.1.2 Usage of HTTP..... | 10 |
|
| 86 |
+
| 6.1.2.1 General..... | 10 |
|
| 87 |
+
| 6.1.2.2 HTTP standard headers..... | 11 |
|
| 88 |
+
| 6.1.2.2.1 General ..... | 11 |
|
| 89 |
+
| 6.1.2.2.2 Content type ..... | 11 |
|
| 90 |
+
| 6.1.2.3 HTTP custom headers..... | 11 |
|
| 91 |
+
| 6.1.3 Resources..... | 11 |
|
| 92 |
+
| 6.1.3.1 Overview..... | 11 |
|
| 93 |
+
| 6.1.3.2 Resource: SecuredPacket..... | 12 |
|
| 94 |
+
| 6.1.3.2.1 Description ..... | 12 |
|
| 95 |
+
| 6.1.3.2.2 Resource Definition..... | 12 |
|
| 96 |
+
| 6.1.3.2.3 Resource Standard Methods..... | 12 |
|
| 97 |
+
| 6.1.3.2.4 Resource Custom Operations..... | 12 |
|
| 98 |
+
| 6.1.3.2.4.2.1 Description..... | 12 |
|
| 99 |
+
| 6.1.3.2.4.2.2 Operation Definition ..... | 12 |
|
| 100 |
+
| 6.1.4 Custom Operations without associated resources ..... | 13 |
|
| 101 |
+
| 6.1.5 Notifications ..... | 13 |
|
| 102 |
+
| 6.1.6 Data Model ..... | 13 |
|
| 103 |
+
| 6.1.6.1 General..... | 13 |
|
| 104 |
+
| 6.1.6.2 Structured data types..... | 13 |
|
| 105 |
+
| 6.1.6.2.1 Introduction ..... | 13 |
|
| 106 |
+
| 6.1.6.2.2 Type: UiccConfigurationParameter ..... | 14 |
|
| 107 |
+
| 6.1.6.2.3 Type: ExtendedSteeringContainer ..... | 14 |
|
| 108 |
+
| 6.1.6.3 Simple data types and enumerations..... | 14 |
|
| 109 |
+
| 6.1.6.3.1 Introduction ..... | 14 |
|
| 110 |
+
| 6.1.6.3.2 Simple data types ..... | 14 |
|
| 111 |
+
| 6.1.7 Error Handling..... | 15 |
|
| 112 |
+
| 6.1.7.1 General..... | 15 |
|
| 113 |
+
| 6.1.7.2 Protocol Errors ..... | 15 |
|
| 114 |
+
| 6.1.7.3 Application Errors..... | 15 |
|
| 115 |
+
| 6.1.8 Feature negotiation ..... | 15 |
|
| 116 |
+
| 6.1.9 Security..... | 15 |
|
| 117 |
+
|
| 118 |
+
**Annex A (normative): OpenAPI specification ..... 16**
|
| 119 |
+
A.1 General..... 16
|
| 120 |
+
A.2 Nspaf\_SecuredPacket API..... 16
|
| 121 |
+
**Annex B (informative): Change history..... 19**
|
| 122 |
+
|
| 123 |
+
# --- Foreword
|
| 124 |
+
|
| 125 |
+
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
|
| 126 |
+
|
| 127 |
+
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
|
| 128 |
+
|
| 129 |
+
Version x.y.z
|
| 130 |
+
|
| 131 |
+
where:
|
| 132 |
+
|
| 133 |
+
- x the first digit:
|
| 134 |
+
- 1 presented to TSG for information;
|
| 135 |
+
- 2 presented to TSG for approval;
|
| 136 |
+
- 3 or greater indicates TSG approved document under change control.
|
| 137 |
+
- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
|
| 138 |
+
- z the third digit is incremented when editorial only changes have been incorporated in the document.
|
| 139 |
+
|
| 140 |
+
In the present document, modal verbs have the following meanings:
|
| 141 |
+
|
| 142 |
+
- shall** indicates a mandatory requirement to do something
|
| 143 |
+
- shall not** indicates an interdiction (prohibition) to do something
|
| 144 |
+
|
| 145 |
+
The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports.
|
| 146 |
+
|
| 147 |
+
The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document.
|
| 148 |
+
|
| 149 |
+
- should** indicates a recommendation to do something
|
| 150 |
+
- should not** indicates a recommendation not to do something
|
| 151 |
+
- may** indicates permission to do something
|
| 152 |
+
- need not** indicates permission not to do something
|
| 153 |
+
|
| 154 |
+
The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended.
|
| 155 |
+
|
| 156 |
+
- can** indicates that something is possible
|
| 157 |
+
- cannot** indicates that something is impossible
|
| 158 |
+
|
| 159 |
+
The constructions "can" and "cannot" are not substitutes for "may" and "need not".
|
| 160 |
+
|
| 161 |
+
- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
|
| 162 |
+
- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document
|
| 163 |
+
- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
|
| 164 |
+
|
| 165 |
+
**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document
|
| 166 |
+
|
| 167 |
+
In addition:
|
| 168 |
+
|
| 169 |
+
**is** (or any other verb in the indicative mood) indicates a statement of fact
|
| 170 |
+
|
| 171 |
+
**is not** (or any other negative verb in the indicative mood) indicates a statement of fact
|
| 172 |
+
|
| 173 |
+
The constructions "is" and "is not" do not indicate requirements.
|
| 174 |
+
|
| 175 |
+
# --- 1 Scope
|
| 176 |
+
|
| 177 |
+
The present document specifies the stage 3 protocol and data model for the Nspaf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SP-AF.
|
| 178 |
+
|
| 179 |
+
The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
|
| 180 |
+
|
| 181 |
+
The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
|
| 182 |
+
|
| 183 |
+
# --- 2 References
|
| 184 |
+
|
| 185 |
+
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
|
| 186 |
+
|
| 187 |
+
- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
|
| 188 |
+
- For a specific reference, subsequent revisions do not apply.
|
| 189 |
+
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
|
| 190 |
+
|
| 191 |
+
- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
|
| 192 |
+
- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
|
| 193 |
+
- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
|
| 194 |
+
- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
|
| 195 |
+
- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
|
| 196 |
+
- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", <https://spec.openapis.org/oas/v3.0.0..>
|
| 197 |
+
- [7] 3GPP TR 21.900: "Technical Specification Group working methods".
|
| 198 |
+
- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
|
| 199 |
+
- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
|
| 200 |
+
- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
|
| 201 |
+
- [11] IETF RFC 9113: "HTTP/2".
|
| 202 |
+
- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
|
| 203 |
+
- [13] IETF RFC 9457: "Problem Details for HTTP APIs".
|
| 204 |
+
- [14] 3GPP TS 29.503: "Unified Data Management Services"; Stage 3.
|
| 205 |
+
- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3".
|
| 206 |
+
- [16] 3GPP TS 31.115: "Secured packet structure for (Universal) Subscriber Identity Module (U)SIM Toolkit applications".
|
| 207 |
+
- [17] 3GPP TS 29.509: "Authentication Server Services; Stage 3".
|
| 208 |
+
- [18] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)"
|
| 209 |
+
- [19] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3".
|
| 210 |
+
|
| 211 |
+
# 3 Definitions, symbols and abbreviations
|
| 212 |
+
|
| 213 |
+
## 3.1 Terms
|
| 214 |
+
|
| 215 |
+
Void.
|
| 216 |
+
|
| 217 |
+
## 3.2 Symbols
|
| 218 |
+
|
| 219 |
+
Void.
|
| 220 |
+
|
| 221 |
+
## 3.3 Abbreviations
|
| 222 |
+
|
| 223 |
+
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1].
|
| 224 |
+
|
| 225 |
+
| | |
|
| 226 |
+
|--------|------------------------------------------|
|
| 227 |
+
| OTA | Over The Air |
|
| 228 |
+
| SOR-AF | Steering Of Roaming Application Function |
|
| 229 |
+
| SP-AF | Secured Packet Application Function |
|
| 230 |
+
| UDM | Unified Data Management |
|
| 231 |
+
|
| 232 |
+
# 4 Overview
|
| 233 |
+
|
| 234 |
+
## 4.1 Introduction
|
| 235 |
+
|
| 236 |
+
Within the 5GC, the SP-AF offers services to the UDM and to the SOR-AF via the Nspaf service based interface.
|
| 237 |
+
|
| 238 |
+
The UDM or SOR-AF shall make use of the SP-AF services when it needs to protect UE parameters for which the final consumer is the USIM (see 3GPP TS 33.501 [8] clause 6.15.2.1).
|
| 239 |
+
|
| 240 |
+
Figure 4.1-1 provides the reference model with focus on the SP-AF.
|
| 241 |
+
|
| 242 |
+
NOTE: The generation of the secured packet and the definition of the storage and handling of OTA keys or other sensitive data are out of scope of this document. For more details, refer to 3GPP TS 23.040 [18] and 3GPP TS 31.115 [16].
|
| 243 |
+
|
| 244 |
+

|
| 245 |
+
|
| 246 |
+
The diagram illustrates the reference model for the SP-AF. On the left, there are two rectangular boxes labeled 'UDM' and 'SOR-AF'. Lines from both boxes converge to a single point labeled 'Nspaf'. From this point, a line connects to a large green rectangular box on the right labeled 'SP-AF'.
|
| 247 |
+
|
| 248 |
+
Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface.
|
| 249 |
+
|
| 250 |
+
Figure 4.1-1: Reference model – SP-AF
|
| 251 |
+
|
| 252 |
+
# 5 Services offered by the SP-AF
|
| 253 |
+
|
| 254 |
+
## 5.1 Introduction
|
| 255 |
+
|
| 256 |
+
The SP-AF offers the following services via the Nspaf interface:
|
| 257 |
+
|
| 258 |
+
- Nspaf\_SecuredPacket Service
|
| 259 |
+
|
| 260 |
+
Table 5.1-1 summarizes the corresponding APIs defined for this specification.
|
| 261 |
+
|
| 262 |
+
**Table 5.1-1: API Descriptions**
|
| 263 |
+
|
| 264 |
+
| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex |
|
| 265 |
+
|---------------------|--------|------------------------------|-----------------------------------|----------------------|-------|
|
| 266 |
+
| Nspaf_SecuredPacket | 6.1 | Nspaf Secured Packet Service | TS29544_Nspaf_SecuredPacket .yaml | nspaf-secured-packet | A.2 |
|
| 267 |
+
|
| 268 |
+
## 5.2 Nspaf\_SecuredPacket Service
|
| 269 |
+
|
| 270 |
+
### 5.2.1 Service Description
|
| 271 |
+
|
| 272 |
+
The Nspaf\_SecuredPacket Service may be consumed by the NF consumer (e.g. UDM or SOR-AF) when it has detected that a UICC configuration parameter (e.g. Routing ID data or Steering of Roaming information) needs to be updated, and the new value is not available in secured packet format.
|
| 273 |
+
|
| 274 |
+
For the list of service operations see clause 5.2.2.1
|
| 275 |
+
|
| 276 |
+
### 5.2.2 Service Operations
|
| 277 |
+
|
| 278 |
+
#### 5.2.2.1 Introduction
|
| 279 |
+
|
| 280 |
+
For the Nspaf\_SecuredPacket service the following service operations are defined:
|
| 281 |
+
|
| 282 |
+
- Provide
|
| 283 |
+
|
| 284 |
+
The Nspaf\_SecuredPacket Service is used by Consumer NFs (e.g. UDM or SOR-AF) to request the SP-AF to provide a secured packet that contains an UICC configuration parameter as sent in the request by means of the Provide service operation
|
| 285 |
+
|
| 286 |
+
#### 5.2.2.2 Provide
|
| 287 |
+
|
| 288 |
+
##### 5.2.2.2.1 General
|
| 289 |
+
|
| 290 |
+
This service operation is used by the NF Service Consumer (e.g. UDM or SOR-AF) to request construction of a secured packet that contains the provided UICC configuration information (e.g. Routing Indicator or Steering of Roaming information).
|
| 291 |
+
|
| 292 |
+
The following procedures using the Provide service operation are supported:
|
| 293 |
+
|
| 294 |
+
- Secured Packet Retrieval
|
| 295 |
+
|
| 296 |
+
##### 5.2.2.2.2 Secured Packet Retrieval
|
| 297 |
+
|
| 298 |
+
Figure 5.2.2.2.2-1 shows a scenario where the NF consumer (e.g. UDM or SOR-AF) sends a request to the SP-AF to provide a secured packet.
|
| 299 |
+
|
| 300 |
+
The request contains the UE's identity (/{supi}) and the UICC configuration parameter.
|
| 301 |
+
|
| 302 |
+

|
| 303 |
+
|
| 304 |
+
```
|
| 305 |
+
|
| 306 |
+
sequenceDiagram
|
| 307 |
+
participant NF-consumer
|
| 308 |
+
participant SP-AF
|
| 309 |
+
Note right of NF-consumer: 1. POST.../{supi}/provide-secured-packet (UiccConfigurationParameter)
|
| 310 |
+
NF-consumer->>SP-AF: Request
|
| 311 |
+
Note left of SP-AF: 2a. 200 OK (SecuredPacket)
|
| 312 |
+
SP-AF-->>NF-consumer: Response 2a
|
| 313 |
+
Note left of SP-AF: 2b. 404 Not Found
|
| 314 |
+
SP-AF-->>NF-consumer: Response 2b
|
| 315 |
+
|
| 316 |
+
```
|
| 317 |
+
|
| 318 |
+
Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found.
|
| 319 |
+
|
| 320 |
+
**Figure 5.2.2.2.2-1: NF consumer requests the SP-AF to provide a secured packet**
|
| 321 |
+
|
| 322 |
+
1. The NF consumer sends a POST request (custom method: provide-secured-packet) to the resource representing the SUPI.
|
| 323 |
+
- 2a. On success, the SP-AF responds with "200 OK", containing the requested SecuredPacket.
|
| 324 |
+
- 2b. If the resource does not exist (the supi is unknown in the SP-AF), the SP-AF returns the HTTP status code "404 Not Found", and additional error information should be included in the response body (in "ProblemDetails" element).
|
| 325 |
+
|
| 326 |
+
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.
|
| 327 |
+
|
| 328 |
+
# 6 API Definitions
|
| 329 |
+
|
| 330 |
+
## 6.1 Nspaf\_SecuredPacket Service API
|
| 331 |
+
|
| 332 |
+
### 6.1.1 Introduction
|
| 333 |
+
|
| 334 |
+
The Nspaf\_SecuredPacket service shall use the Nspaf\_SecuredPacket API.
|
| 335 |
+
|
| 336 |
+
The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
|
| 337 |
+
|
| 338 |
+
**{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>**
|
| 339 |
+
|
| 340 |
+
with the following components:
|
| 341 |
+
|
| 342 |
+
- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
|
| 343 |
+
- The <apiName> shall be "nspaf-secured-packet".
|
| 344 |
+
- The <apiVersion> shall be "v1".
|
| 345 |
+
- The <apiSpecificResourceUriPart> shall be set as described in clause 6.1.3.
|
| 346 |
+
|
| 347 |
+
### 6.1.2 Usage of HTTP
|
| 348 |
+
|
| 349 |
+
#### 6.1.2.1 General
|
| 350 |
+
|
| 351 |
+
HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
|
| 352 |
+
|
| 353 |
+
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
|
| 354 |
+
|
| 355 |
+
The OpenAPI [6] specification of HTTP messages and content bodies for the Nspaf\_SecuredPacket API is contained in Annex A.
|
| 356 |
+
|
| 357 |
+
#### 6.1.2.2 HTTP standard headers
|
| 358 |
+
|
| 359 |
+
##### 6.1.2.2.1 General
|
| 360 |
+
|
| 361 |
+
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
|
| 362 |
+
|
| 363 |
+
##### 6.1.2.2.2 Content type
|
| 364 |
+
|
| 365 |
+
JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
|
| 366 |
+
|
| 367 |
+
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13].
|
| 368 |
+
|
| 369 |
+
#### 6.1.2.3 HTTP custom headers
|
| 370 |
+
|
| 371 |
+
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable.
|
| 372 |
+
|
| 373 |
+
### 6.1.3 Resources
|
| 374 |
+
|
| 375 |
+
#### 6.1.3.1 Overview
|
| 376 |
+
|
| 377 |
+

|
| 378 |
+
|
| 379 |
+
```
|
| 380 |
+
|
| 381 |
+
graph TD
|
| 382 |
+
Root["{apiRoot}/nspaf-secured-packet/<apiVersion>"] --> Supi["/{supi}"]
|
| 383 |
+
Supi --> Packet["/provide-secured-packet"]
|
| 384 |
+
style Packet stroke-dasharray: 5 5
|
| 385 |
+
|
| 386 |
+
```
|
| 387 |
+
|
| 388 |
+
Diagram showing the hierarchical structure of the nspaf-secured-packet API URI. The root is {apiRoot}/nspaf-secured-packet/. It branches to /{supi}, which in turn branches to /provide-secured-packet (indicated by a dashed box).
|
| 389 |
+
|
| 390 |
+
**Figure 6.1.3.1-1: Resource URI structure of the nspaf-secured-packet API**
|
| 391 |
+
|
| 392 |
+
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
|
| 393 |
+
|
| 394 |
+
**Table 6.1.3.1-1: Resources and methods overview**
|
| 395 |
+
|
| 396 |
+
| Resource name | Resource URI | HTTP method or custom operation | Description |
|
| 397 |
+
|----------------------------------|--------------------------------|---------------------------------|--------------------------------------------------------------------------------------------|
|
| 398 |
+
| SecuredPacket (Custom operation) | /{supi}/provide-secured-packet | Provide-secured-packet (POST) | The SP-AF generates a secured packet containing the presented UICC configuration parameter |
|
| 399 |
+
|
| 400 |
+
#### 6.1.3.2 Resource: SecuredPacket
|
| 401 |
+
|
| 402 |
+
##### 6.1.3.2.1 Description
|
| 403 |
+
|
| 404 |
+
This resource represents the information that is needed to construct secured packets for the SUPI.
|
| 405 |
+
|
| 406 |
+
##### 6.1.3.2.2 Resource Definition
|
| 407 |
+
|
| 408 |
+
Resource URI: {apiRoot}/nspaf-secured-packet/v1/{supi}/provide-secured-packet
|
| 409 |
+
|
| 410 |
+
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
|
| 411 |
+
|
| 412 |
+
**Table 6.1.3.2.2-1: Resource URI variables for this resource**
|
| 413 |
+
|
| 414 |
+
| Name | Definition |
|
| 415 |
+
|---------|--------------------------------------------------------------------------------------------------------------------------------------|
|
| 416 |
+
| apiRoot | See clause 6.1.1 |
|
| 417 |
+
| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)<br>pattern: "^(imsi-[0-9]{5,15} nai-.[+.]\$)" |
|
| 418 |
+
|
| 419 |
+
##### 6.1.3.2.3 Resource Standard Methods
|
| 420 |
+
|
| 421 |
+
No Standard Methods are supported for this resource.
|
| 422 |
+
|
| 423 |
+
##### 6.1.3.2.4 Resource Custom Operations
|
| 424 |
+
|
| 425 |
+
###### 6.1.3.2.4.1 Overview
|
| 426 |
+
|
| 427 |
+
**Table 6.1.3.2.4.1-1: Custom operations**
|
| 428 |
+
|
| 429 |
+
| Custom operation URI | Mapped HTTP method | Description |
|
| 430 |
+
|-------------------------|--------------------|-------------------------------------------------------------------------------------------------------------|
|
| 431 |
+
| /provide-secured-packet | POST | The SP-AF generates a secured packet for the SUPI that contains the presented UICC configuration parameter. |
|
| 432 |
+
|
| 433 |
+
###### 6.1.3.2.4.2 Operation: provide-secured-packet
|
| 434 |
+
|
| 435 |
+
###### 6.1.3.2.4.2.1 Description
|
| 436 |
+
|
| 437 |
+
This custom operation is used by the NF service consumer (e.g. UDM) to request a secured packet for the SUPI containing the presented UICC configuration parameter. The returned secured packet shall be constructed as an SMS-Deliver as specified in 3GPP TS 23.040 [18] and protected as specified in 3GPP TS 31.115 [16].
|
| 438 |
+
|
| 439 |
+
###### 6.1.3.2.4.2.2 Operation Definition
|
| 440 |
+
|
| 441 |
+
This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2.
|
| 442 |
+
|
| 443 |
+
**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource**
|
| 444 |
+
|
| 445 |
+
| Data type | P | Cardinality | Description |
|
| 446 |
+
|-----------------------------|---|-------------|----------------------------------------------------------|
|
| 447 |
+
| UiccConfiguration Parameter | M | 1 | Contains the parameter that is to be updated in the UICC |
|
| 448 |
+
|
| 449 |
+
**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource**
|
| 450 |
+
|
| 451 |
+
| Data type | P | Cardinality | Response codes | Description |
|
| 452 |
+
|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------|
|
| 453 |
+
| SecuredPacket | M | 1 | 200 OK | Upon success, a response body containing the generated secured packet shall be returned. |
|
| 454 |
+
| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to convey the following application error:<br>- USER NOT FOUND |
|
| 455 |
+
| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | |
|
| 456 |
+
|
| 457 |
+
### 6.1.4 Custom Operations without associated resources
|
| 458 |
+
|
| 459 |
+
In this release of this specification, no custom operations without associated resources are defined for the Nspaf\_SecuredPacket Service.
|
| 460 |
+
|
| 461 |
+
### 6.1.5 Notifications
|
| 462 |
+
|
| 463 |
+
In this release of this specification, no notifications are defined for the Nspaf\_SecuredPacket Service.
|
| 464 |
+
|
| 465 |
+
### 6.1.6 Data Model
|
| 466 |
+
|
| 467 |
+
#### 6.1.6.1 General
|
| 468 |
+
|
| 469 |
+
This clause specifies the application data model supported by the API.
|
| 470 |
+
|
| 471 |
+
Table 6.1.6.1-1 specifies the data types defined for the Nspaf service based interface protocol.
|
| 472 |
+
|
| 473 |
+
**Table 6.1.6.1-1: Nspaf specific Data Types**
|
| 474 |
+
|
| 475 |
+
| Data type | Clause defined | Description | Applicability |
|
| 476 |
+
|----------------------------|----------------|-----------------------------------------------------------------------------------------|---------------|
|
| 477 |
+
| UiccConfigurationParameter | 6.1.6.2.2 | UICC Configuration Parameters | |
|
| 478 |
+
| RoutingId | 6.1.6.3.2 | Routing ID | |
|
| 479 |
+
| ExtendedSteeringContainer | 6.1.6.2.3 | Extended Steering Container (including the contents of Steering Container and SOR-CMCI) | |
|
| 480 |
+
|
| 481 |
+
Table 6.1.6.1-2 specifies data types re-used by the Nspaf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nspaf service based interface.
|
| 482 |
+
|
| 483 |
+
**Table 6.1.6.1-2: Nspaf re-used Data Types**
|
| 484 |
+
|
| 485 |
+
| Data type | Reference | Comments | Applicability |
|
| 486 |
+
|----------------|---------------------|-----------------------------------------------------|---------------|
|
| 487 |
+
| SecuredPacket | 3GPP TS 29.503 [14] | Secured Packet | |
|
| 488 |
+
| ProblemDetails | 3GPP TS 29.571 [15] | | |
|
| 489 |
+
| SteeringInfo | 3GPP TS 29.509 [17] | Steering Information | |
|
| 490 |
+
| SorCmci | 3GPP TS 29.503 [14] | Contains SOR-CMCI as defined in 3GPP TS 24.501 [19] | |
|
| 491 |
+
|
| 492 |
+
#### 6.1.6.2 Structured data types
|
| 493 |
+
|
| 494 |
+
##### 6.1.6.2.1 Introduction
|
| 495 |
+
|
| 496 |
+
This clause defines the structures to be used in resource representations.
|
| 497 |
+
|
| 498 |
+
##### 6.1.6.2.2 Type: UiccConfigurationParameter
|
| 499 |
+
|
| 500 |
+
Table 6.1.6.2.2-1: Definition of type UiccConfigurationParameter
|
| 501 |
+
|
| 502 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 503 |
+
|---------------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 504 |
+
| routingId | RoutingId | C | 0..1 | The Routing Id that needs to be updated in the USIM. | |
|
| 505 |
+
| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | |
|
| 506 |
+
| extendedSteeringContainer | ExtendedSteeringContainer | C | 0..1 | Extended Steering Container that includes list of PLMN/AccessTechnologies combinations with the SOR-CMCI that need to be updated in the USIM | |
|
| 507 |
+
|
| 508 |
+
Note: Exactly one attribute shall be present
|
| 509 |
+
|
| 510 |
+
##### 6.1.6.2.3 Type: ExtendedSteeringContainer
|
| 511 |
+
|
| 512 |
+
Table 6.1.6.2.3-1: Definition of type ExtendedSteeringContainer
|
| 513 |
+
|
| 514 |
+
| Attribute name | Data type | P | Cardinality | Description | Applicability |
|
| 515 |
+
|-------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
| 516 |
+
| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | |
|
| 517 |
+
| sorCmci | SorCmci | C | 0..1 | When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [19] | |
|
| 518 |
+
| storeSorCmciInMe | boolean | C | 0..1 | When present, indicates "Store the SOR-CMCI in the ME", i.e. whether to instruct UE to store SOR-CMCI in the ME as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].<br><br>- True: Indicates to store the SOR-CMCI in the ME<br>- False or absent: Indicates storing the SOR-CMCI in the ME is not required | |
|
| 519 |
+
|
| 520 |
+
NOTE: At least one attribute shall be present. If no additional attributes than steeringContainer is included, then use of steeringContainer can be considered instead of using ExtendedSteeringContainer.
|
| 521 |
+
|
| 522 |
+
#### 6.1.6.3 Simple data types and enumerations
|
| 523 |
+
|
| 524 |
+
##### 6.1.6.3.1 Introduction
|
| 525 |
+
|
| 526 |
+
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
|
| 527 |
+
|
| 528 |
+
##### 6.1.6.3.2 Simple data types
|
| 529 |
+
|
| 530 |
+
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
|
| 531 |
+
|
| 532 |
+
**Table 6.1.6.3.2-1: Simple data types**
|
| 533 |
+
|
| 534 |
+
| Type Name | Type Definition | Description | Applicability |
|
| 535 |
+
|-----------|-----------------|-------------------------|---------------|
|
| 536 |
+
| RoutingId | string | Pattern: "[0-9]{1,4}\$" | |
|
| 537 |
+
|
| 538 |
+
### 6.1.7 Error Handling
|
| 539 |
+
|
| 540 |
+
#### 6.1.7.1 General
|
| 541 |
+
|
| 542 |
+
For the Nspaf\_SecuredPacket API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
|
| 543 |
+
|
| 544 |
+
In addition, the requirements in the following clauses are applicable for the Nspaf\_SecuredPacket API.
|
| 545 |
+
|
| 546 |
+
#### 6.1.7.2 Protocol Errors
|
| 547 |
+
|
| 548 |
+
No specific procedures for the Nspaf\_SecuredPacket service are specified.
|
| 549 |
+
|
| 550 |
+
#### 6.1.7.3 Application Errors
|
| 551 |
+
|
| 552 |
+
The application errors defined for the Nspaf\_SecuredPacket service are listed in Table 6.1.7.3-1.
|
| 553 |
+
|
| 554 |
+
**Table 6.1.7.3-1: Application errors**
|
| 555 |
+
|
| 556 |
+
| Application Error | HTTP status code | Description |
|
| 557 |
+
|-------------------|------------------|-------------------------|
|
| 558 |
+
| USER_NOT_FOUND | 404 Not Found | The user does not exist |
|
| 559 |
+
|
| 560 |
+
### 6.1.8 Feature negotiation
|
| 561 |
+
|
| 562 |
+
The optional features in table 6.1.8-1 are defined for the Nspaf\_SecuredPacket API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
|
| 563 |
+
|
| 564 |
+
**Table 6.1.8-1: Supported Features**
|
| 565 |
+
|
| 566 |
+
| Feature number | Feature Name | Description |
|
| 567 |
+
|----------------|--------------|-------------|
|
| 568 |
+
| | | |
|
| 569 |
+
|
| 570 |
+
### 6.1.9 Security
|
| 571 |
+
|
| 572 |
+
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nspaf\_SecuredPacket API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
|
| 573 |
+
|
| 574 |
+
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nspaf\_SecuredPacket API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
|
| 575 |
+
|
| 576 |
+
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nspaf\_SecuredPacket service.
|
| 577 |
+
|
| 578 |
+
The Nspaf\_SecuredPacket API defines a single scope "nspaf-secured-packet" for the entire service, and it does not define any additional scopes at resource or operation level.
|
| 579 |
+
|
| 580 |
+
# Annex A (normative): OpenAPI specification
|
| 581 |
+
|
| 582 |
+
## A.1 General
|
| 583 |
+
|
| 584 |
+
This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format.
|
| 585 |
+
|
| 586 |
+
This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s).
|
| 587 |
+
|
| 588 |
+
NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply.
|
| 589 |
+
|
| 590 |
+
Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B).
|
| 591 |
+
|
| 592 |
+
## A.2 Nspaf\_SecuredPacket API
|
| 593 |
+
|
| 594 |
+
```
|
| 595 |
+
openapi: 3.0.0
|
| 596 |
+
info:
|
| 597 |
+
title: 'Nspaf_SecuredPacket'
|
| 598 |
+
version: '1.2.0-alpha.1'
|
| 599 |
+
description: |
|
| 600 |
+
Nspaf Secured Packet Service.
|
| 601 |
+
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
|
| 602 |
+
All rights reserved.
|
| 603 |
+
externalDocs:
|
| 604 |
+
description: 3GPP TS 29.544, SP-AF Services, version V18.0.0
|
| 605 |
+
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.544/
|
| 606 |
+
servers:
|
| 607 |
+
- url: '{apiRoot}/nspaf-secured-packet/v1'
|
| 608 |
+
variables:
|
| 609 |
+
apiRoot:
|
| 610 |
+
default: https://example.com
|
| 611 |
+
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
|
| 612 |
+
security:
|
| 613 |
+
- {}
|
| 614 |
+
- oAuth2ClientCredentials:
|
| 615 |
+
- nspaf-secured-packet
|
| 616 |
+
paths:
|
| 617 |
+
/{supi}/provide-secured-packet:
|
| 618 |
+
post:
|
| 619 |
+
summary: request generation of a secured packet
|
| 620 |
+
operationId: ProvideSecuredPacket
|
| 621 |
+
tags:
|
| 622 |
+
- SecuredPacket Generation (Custom Operation)
|
| 623 |
+
parameters:
|
| 624 |
+
- name: supi
|
| 625 |
+
in: path
|
| 626 |
+
description: SUPI of the user
|
| 627 |
+
required: true
|
| 628 |
+
schema:
|
| 629 |
+
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
|
| 630 |
+
requestBody:
|
| 631 |
+
required: true
|
| 632 |
+
content:
|
| 633 |
+
application/json:
|
| 634 |
+
schema:
|
| 635 |
+
$ref: '#/components/schemas/UiccConfigurationParameter'
|
| 636 |
+
responses:
|
| 637 |
+
'200':
|
| 638 |
+
description: Success
|
| 639 |
+
content:
|
| 640 |
+
```
|
| 641 |
+
|
| 642 |
+
```
|
| 643 |
+
|
| 644 |
+
application/json:
|
| 645 |
+
schema:
|
| 646 |
+
$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SecuredPacket'
|
| 647 |
+
'400':
|
| 648 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
|
| 649 |
+
'401':
|
| 650 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
|
| 651 |
+
'403':
|
| 652 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
|
| 653 |
+
'404':
|
| 654 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
|
| 655 |
+
'411':
|
| 656 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
|
| 657 |
+
'413':
|
| 658 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
|
| 659 |
+
'415':
|
| 660 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
|
| 661 |
+
'429':
|
| 662 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
|
| 663 |
+
'500':
|
| 664 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
|
| 665 |
+
'502':
|
| 666 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
|
| 667 |
+
'503':
|
| 668 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
|
| 669 |
+
default:
|
| 670 |
+
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
|
| 671 |
+
|
| 672 |
+
components:
|
| 673 |
+
securitySchemes:
|
| 674 |
+
oAuth2ClientCredentials:
|
| 675 |
+
type: oauth2
|
| 676 |
+
flows:
|
| 677 |
+
clientCredentials:
|
| 678 |
+
tokenUrl: '{nrfApiRoot}/oauth2/token'
|
| 679 |
+
scopes:
|
| 680 |
+
nspaf-secured-packet: Access to the nspaf-secured-packet API
|
| 681 |
+
schemas:
|
| 682 |
+
|
| 683 |
+
# COMPLEX TYPES:
|
| 684 |
+
|
| 685 |
+
UiccConfigurationParameter:
|
| 686 |
+
description: Represents UICC Configuration Parameters.
|
| 687 |
+
type: object
|
| 688 |
+
oneOf:
|
| 689 |
+
- required: [routingId ]
|
| 690 |
+
- required: [steeringContainer ]
|
| 691 |
+
- required: [extendedSteeringContainer ]
|
| 692 |
+
properties:
|
| 693 |
+
routingId:
|
| 694 |
+
$ref: '#/components/schemas/RoutingId'
|
| 695 |
+
steeringContainer:
|
| 696 |
+
type: array
|
| 697 |
+
items:
|
| 698 |
+
$ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo'
|
| 699 |
+
minItems: 1
|
| 700 |
+
extendedSteeringContainer:
|
| 701 |
+
$ref: '#/components/schemas/ExtendedSteeringContainer'
|
| 702 |
+
|
| 703 |
+
ExtendedSteeringContainer:
|
| 704 |
+
description: Represents Extended Steering Containers.
|
| 705 |
+
type: object
|
| 706 |
+
properties:
|
| 707 |
+
steeringContainer:
|
| 708 |
+
type: array
|
| 709 |
+
items:
|
| 710 |
+
$ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo'
|
| 711 |
+
minItems: 1
|
| 712 |
+
sorCmci:
|
| 713 |
+
$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SorCmci'
|
| 714 |
+
storeSorCmciInMe:
|
| 715 |
+
type: boolean
|
| 716 |
+
|
| 717 |
+
# SIMPLE TYPES:
|
| 718 |
+
|
| 719 |
+
RoutingId:
|
| 720 |
+
description: Represents a routing indicator.
|
| 721 |
+
type: string
|
| 722 |
+
|
| 723 |
+
```
|
| 724 |
+
|
| 725 |
+
pattern: '^[0-9]{1,4}\$'
|
| 726 |
+
|
| 727 |
+
# ENUMS:
|
| 728 |
+
|
| 729 |
+
# Annex B (informative): Change history
|
| 730 |
+
|
| 731 |
+
| Change history | | | | | | | |
|
| 732 |
+
|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------|-------------|
|
| 733 |
+
| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version |
|
| 734 |
+
| 2019-10 | CT4#94 | C4-194013 | | | | Initial Draft. | 0.1.0 |
|
| 735 |
+
| 2019-10 | CT4#94 | C4-194367 | | | | Notaf Overview | 0.2.0 |
|
| 736 |
+
| 2019-10 | CT4#94 | C4-194488 | | | | Notaf_SecuredPacket-Provide service operation | 0.2.0 |
|
| 737 |
+
| 2019-10 | CT4#94 | C4-194492 | | | | Resources | 0.2.0 |
|
| 738 |
+
| 2019-10 | CT4#94 | C4-194516 | | | | Data Model | 0.2.0 |
|
| 739 |
+
| 2019-10 | CT4#94 | C4-194490 | | | | OpenAPI Specification | 0.2.0 |
|
| 740 |
+
| 2019-11 | CT4#95 | C4-195481 | | | | Clean Up | 0.3.0 |
|
| 741 |
+
| 2019-12 | CT#86 | CP-193071 | | | | TS presented for information | 1.0.0 |
|
| 742 |
+
| 2019-12 | CT#86 | CP-193285 | | | | A title updated | 1.0.1 |
|
| 743 |
+
| 2020-03 | CT4#96e | C4-201119 | | | | Pseudo-CR on SOR | 1.1.0 |
|
| 744 |
+
| 2020-03 | CT4#96e | C4-201123 | | | | Pseudo-CR on Clean Up | 1.1.0 |
|
| 745 |
+
| 2020-03 | CT4#96e | C4-201217 | | | | Pseudo-CR on the necessary modifications to change OTAF NF name to SP-AF | 1.1.0 |
|
| 746 |
+
| 2020-03 | CT4#96e | C4-201314 | | | | Pseudo-CR on API descriptions table in clause 5.1 | 1.1.0 |
|
| 747 |
+
| 2020-03 | CT#87e | CP-200062 | | | | TS presented for approval | 2.0.0 |
|
| 748 |
+
| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 |
|
| 749 |
+
| 2020-07 | CT#88e | CP-201040 | 0001 | 1 | C | Clarification on Secured Packet format provided by SP-AF | 16.1.0 |
|
| 750 |
+
| 2020-07 | CT#88e | CP-201040 | 0002 | | F | Storage of YAML files in ETSI Forge | 16.1.0 |
|
| 751 |
+
| 2020-07 | CT#88e | CP-201040 | 0003 | 1 | F | Miscellaneous Corrections | 16.1.0 |
|
| 752 |
+
| 2020-07 | CT#88e | CP-201073 | 0005 | | F | 3GPP TS 29.544 API Version and External doc Update | 16.1.0 |
|
| 753 |
+
| 2020-09 | CT#89e | CP-202110 | 0006 | 1 | F | Miscellaneous corrections | 16.2.0 |
|
| 754 |
+
| 2020-09 | CT#89e | CP-202096 | 0007 | | F | API version and External doc update | 16.2.0 |
|
| 755 |
+
| 2020-12 | CT#90e | CP-203048 | 0008 | | F | Storage of yaml files | 16.3.0 |
|
| 756 |
+
| 2021-06 | CT#92e | CP-211051 | 0011 | | F | OpenAPI Reference | 17.0.0 |
|
| 757 |
+
| 2021-06 | CT#92e | CP-211028 | 0012 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the Nspaf_SecuredPacket API | 17.0.0 |
|
| 758 |
+
| 2021-06 | CT#92e | CP-211050 | 0013 | | F | 29.544 Rel-17 API version and External doc update | 17.0.0 |
|
| 759 |
+
| 2021-12 | CT#94e | CP-213197 | 0014 | 2 | B | SOR-CMCI support | 17.1.0 |
|
| 760 |
+
| 2021-12 | CT#94e | CP-213121 | 0015 | | F | 29.544 Rel-17 API version and External doc update | 17.1.0 |
|
| 761 |
+
| 2022-03 | CT#95e | CP-220041 | 0016 | | B | Addition of SOR-CMCI related attribute as input to SP-AF | 17.2.0 |
|
| 762 |
+
| 2022-03 | CT#95e | CP-220066 | 0017 | | F | API version and External doc update | 17.2.0 |
|
| 763 |
+
| 2022-06 | CT#96 | CP-221300 | 0018 | 1 | F | API version and External doc update | 17.3.0 |
|
| 764 |
+
| 2022-12 | CT#98e | CP-223027 | 0020 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 |
|
| 765 |
+
| 2022-12 | CT#98e | CP-223033 | 0021 | | F | 29.544 Rel-18 API version and External doc update | 18.0.0 |
|
| 766 |
+
| 2023-12 | CT#102 | CP-233028 | 0022 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.1.0 |
|
| 767 |
+
| 2023-12 | CT#102 | CP-233029 | 0023 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.1.0 |
|
marked/Rel-18/29_series/29572/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29573/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29574/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29575/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29580/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29581/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29586/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29673/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29674/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/29_series/29893/raw.md
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
marked/Rel-18/37_series/37104/10d81b2cc455e3563e3e562a7f451124_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/455c842681aadb4969bd61d71f556744_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/5fb340ad68b0c71df0b56698b137e35b_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/64662465bba247703fdec49c8f3309f9_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/673e9e5873f9a4b71bbe7bac2cf6b758_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/a26e142d3df5bef41a84a9dd099d7825_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/c67407c82ad10179bcb338347ded4245_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37104/cab0834804fb031b43865554cc8d06ab_img.jpg
ADDED
|
Git LFS Details
|
marked/Rel-18/37_series/37113/27b06ec9f42b5d727a2630f61a5f1861_img.jpg
ADDED
|
Git LFS Details
|